linux/drivers/media/radio/saa7706h.c
<<
>>
Prefs
   1/*
   2 * saa7706.c Philips SAA7706H Car Radio DSP driver
   3 * Copyright (c) 2009 Intel Corporation
   4 *
   5 * This program is free software; you can redistribute it and/or modify
   6 * it under the terms of the GNU General Public License version 2 as
   7 * published by the Free Software Foundation.
   8 *
   9 * This program is distributed in the hope that it will be useful,
  10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 * GNU General Public License for more details.
  13 *
  14 * You should have received a copy of the GNU General Public License
  15 * along with this program; if not, write to the Free Software
  16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19#include <linux/module.h>
  20#include <linux/init.h>
  21#include <linux/delay.h>
  22#include <linux/errno.h>
  23#include <linux/kernel.h>
  24#include <linux/interrupt.h>
  25#include <linux/i2c.h>
  26#include <linux/slab.h>
  27#include <media/v4l2-device.h>
  28#include <media/v4l2-chip-ident.h>
  29
  30#define DRIVER_NAME "saa7706h"
  31
  32/* the I2C memory map looks like this
  33
  34        $1C00 - $FFFF Not Used
  35        $2200 - $3FFF Reserved YRAM (DSP2) space
  36        $2000 - $21FF YRAM (DSP2)
  37        $1FF0 - $1FFF Hardware Registers
  38        $1280 - $1FEF Reserved XRAM (DSP2) space
  39        $1000 - $127F XRAM (DSP2)
  40        $0FFF        DSP CONTROL
  41        $0A00 - $0FFE Reserved
  42        $0980 - $09FF Reserved YRAM (DSP1) space
  43        $0800 - $097F YRAM (DSP1)
  44        $0200 - $07FF Not Used
  45        $0180 - $01FF Reserved XRAM (DSP1) space
  46        $0000 - $017F XRAM (DSP1)
  47*/
  48
  49#define SAA7706H_REG_CTRL               0x0fff
  50#define SAA7706H_CTRL_BYP_PLL           0x0001
  51#define SAA7706H_CTRL_PLL_DIV_MASK      0x003e
  52#define SAA7706H_CTRL_PLL3_62975MHZ     0x003e
  53#define SAA7706H_CTRL_DSP_TURBO         0x0040
  54#define SAA7706H_CTRL_PC_RESET_DSP1     0x0080
  55#define SAA7706H_CTRL_PC_RESET_DSP2     0x0100
  56#define SAA7706H_CTRL_DSP1_ROM_EN_MASK  0x0600
  57#define SAA7706H_CTRL_DSP1_FUNC_PROM    0x0000
  58#define SAA7706H_CTRL_DSP2_ROM_EN_MASK  0x1800
  59#define SAA7706H_CTRL_DSP2_FUNC_PROM    0x0000
  60#define SAA7706H_CTRL_DIG_SIL_INTERPOL  0x8000
  61
  62#define SAA7706H_REG_EVALUATION                 0x1ff0
  63#define SAA7706H_EVAL_DISABLE_CHARGE_PUMP       0x000001
  64#define SAA7706H_EVAL_DCS_CLOCK                 0x000002
  65#define SAA7706H_EVAL_GNDRC1_ENABLE             0x000004
  66#define SAA7706H_EVAL_GNDRC2_ENABLE             0x000008
  67
  68#define SAA7706H_REG_CL_GEN1                    0x1ff3
  69#define SAA7706H_CL_GEN1_MIN_LOOPGAIN_MASK      0x00000f
  70#define SAA7706H_CL_GEN1_LOOPGAIN_MASK          0x0000f0
  71#define SAA7706H_CL_GEN1_COARSE_RATION          0xffff00
  72
  73#define SAA7706H_REG_CL_GEN2                    0x1ff4
  74#define SAA7706H_CL_GEN2_WSEDGE_FALLING         0x000001
  75#define SAA7706H_CL_GEN2_STOP_VCO               0x000002
  76#define SAA7706H_CL_GEN2_FRERUN                 0x000004
  77#define SAA7706H_CL_GEN2_ADAPTIVE               0x000008
  78#define SAA7706H_CL_GEN2_FINE_RATIO_MASK        0x0ffff0
  79
  80#define SAA7706H_REG_CL_GEN4            0x1ff6
  81#define SAA7706H_CL_GEN4_BYPASS_PLL1    0x001000
  82#define SAA7706H_CL_GEN4_PLL1_DIV_MASK  0x03e000
  83#define SAA7706H_CL_GEN4_DSP1_TURBO     0x040000
  84
  85#define SAA7706H_REG_SEL        0x1ff7
  86#define SAA7706H_SEL_DSP2_SRCA_MASK     0x000007
  87#define SAA7706H_SEL_DSP2_FMTA_MASK     0x000031
  88#define SAA7706H_SEL_DSP2_SRCB_MASK     0x0001c0
  89#define SAA7706H_SEL_DSP2_FMTB_MASK     0x000e00
  90#define SAA7706H_SEL_DSP1_SRC_MASK      0x003000
  91#define SAA7706H_SEL_DSP1_FMT_MASK      0x01c003
  92#define SAA7706H_SEL_SPDIF2             0x020000
  93#define SAA7706H_SEL_HOST_IO_FMT_MASK   0x1c0000
  94#define SAA7706H_SEL_EN_HOST_IO         0x200000
  95
  96#define SAA7706H_REG_IAC                0x1ff8
  97#define SAA7706H_REG_CLK_SET            0x1ff9
  98#define SAA7706H_REG_CLK_COEFF          0x1ffa
  99#define SAA7706H_REG_INPUT_SENS         0x1ffb
 100#define SAA7706H_INPUT_SENS_RDS_VOL_MASK        0x0003f
 101#define SAA7706H_INPUT_SENS_FM_VOL_MASK         0x00fc0
 102#define SAA7706H_INPUT_SENS_FM_MPX              0x01000
 103#define SAA7706H_INPUT_SENS_OFF_FILTER_A_EN     0x02000
 104#define SAA7706H_INPUT_SENS_OFF_FILTER_B_EN     0x04000
 105#define SAA7706H_REG_PHONE_NAV_AUDIO    0x1ffc
 106#define SAA7706H_REG_IO_CONF_DSP2       0x1ffd
 107#define SAA7706H_REG_STATUS_DSP2        0x1ffe
 108#define SAA7706H_REG_PC_DSP2            0x1fff
 109
 110#define SAA7706H_DSP1_MOD0      0x0800
 111#define SAA7706H_DSP1_ROM_VER   0x097f
 112#define SAA7706H_DSP2_MPTR0     0x1000
 113
 114#define SAA7706H_DSP1_MODPNTR   0x0000
 115
 116#define SAA7706H_DSP2_XMEM_CONTLLCW     0x113e
 117#define SAA7706H_DSP2_XMEM_BUSAMP       0x114a
 118#define SAA7706H_DSP2_XMEM_FDACPNTR     0x11f9
 119#define SAA7706H_DSP2_XMEM_IIS1PNTR     0x11fb
 120
 121#define SAA7706H_DSP2_YMEM_PVGA         0x212a
 122#define SAA7706H_DSP2_YMEM_PVAT1        0x212b
 123#define SAA7706H_DSP2_YMEM_PVAT         0x212c
 124#define SAA7706H_DSP2_YMEM_ROM_VER      0x21ff
 125
 126#define SUPPORTED_DSP1_ROM_VER          0x667
 127
 128struct saa7706h_state {
 129        struct v4l2_subdev sd;
 130        unsigned muted;
 131};
 132
 133static inline struct saa7706h_state *to_state(struct v4l2_subdev *sd)
 134{
 135        return container_of(sd, struct saa7706h_state, sd);
 136}
 137
 138static int saa7706h_i2c_send(struct i2c_client *client, const u8 *data, int len)
 139{
 140        int err = i2c_master_send(client, data, len);
 141        if (err == len)
 142                return 0;
 143        return err > 0 ? -EIO : err;
 144}
 145
 146static int saa7706h_i2c_transfer(struct i2c_client *client,
 147        struct i2c_msg *msgs, int num)
 148{
 149        int err = i2c_transfer(client->adapter, msgs, num);
 150        if (err == num)
 151                return 0;
 152        return err > 0 ? -EIO : err;
 153}
 154
 155static int saa7706h_set_reg24(struct v4l2_subdev *sd, u16 reg, u32 val)
 156{
 157        struct i2c_client *client = v4l2_get_subdevdata(sd);
 158        u8 buf[5];
 159        int pos = 0;
 160
 161        buf[pos++] = reg >> 8;
 162        buf[pos++] = reg;
 163        buf[pos++] = val >> 16;
 164        buf[pos++] = val >> 8;
 165        buf[pos++] = val;
 166
 167        return saa7706h_i2c_send(client, buf, pos);
 168}
 169
 170static int saa7706h_set_reg24_err(struct v4l2_subdev *sd, u16 reg, u32 val,
 171        int *err)
 172{
 173        return *err ? *err : saa7706h_set_reg24(sd, reg, val);
 174}
 175
 176static int saa7706h_set_reg16(struct v4l2_subdev *sd, u16 reg, u16 val)
 177{
 178        struct i2c_client *client = v4l2_get_subdevdata(sd);
 179        u8 buf[4];
 180        int pos = 0;
 181
 182        buf[pos++] = reg >> 8;
 183        buf[pos++] = reg;
 184        buf[pos++] = val >> 8;
 185        buf[pos++] = val;
 186
 187        return saa7706h_i2c_send(client, buf, pos);
 188}
 189
 190static int saa7706h_set_reg16_err(struct v4l2_subdev *sd, u16 reg, u16 val,
 191        int *err)
 192{
 193        return *err ? *err : saa7706h_set_reg16(sd, reg, val);
 194}
 195
 196static int saa7706h_get_reg16(struct v4l2_subdev *sd, u16 reg)
 197{
 198        struct i2c_client *client = v4l2_get_subdevdata(sd);
 199        u8 buf[2];
 200        int err;
 201        u8 regaddr[] = {reg >> 8, reg};
 202        struct i2c_msg msg[] = {
 203                                        {
 204                                                .addr = client->addr,
 205                                                .len = sizeof(regaddr),
 206                                                .buf = regaddr
 207                                        },
 208                                        {
 209                                                .addr = client->addr,
 210                                                .flags = I2C_M_RD,
 211                                                .len = sizeof(buf),
 212                                                .buf = buf
 213                                        }
 214                                };
 215
 216        err = saa7706h_i2c_transfer(client, msg, ARRAY_SIZE(msg));
 217        if (err)
 218                return err;
 219
 220        return buf[0] << 8 | buf[1];
 221}
 222
 223static int saa7706h_unmute(struct v4l2_subdev *sd)
 224{
 225        struct saa7706h_state *state = to_state(sd);
 226        int err = 0;
 227
 228        err = saa7706h_set_reg16_err(sd, SAA7706H_REG_CTRL,
 229                SAA7706H_CTRL_PLL3_62975MHZ | SAA7706H_CTRL_PC_RESET_DSP1 |
 230                SAA7706H_CTRL_PC_RESET_DSP2, &err);
 231
 232        /* newer versions of the chip requires a small sleep after reset */
 233        msleep(1);
 234
 235        err = saa7706h_set_reg16_err(sd, SAA7706H_REG_CTRL,
 236                SAA7706H_CTRL_PLL3_62975MHZ, &err);
 237
 238        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_EVALUATION, 0, &err);
 239
 240        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_CL_GEN1, 0x040022, &err);
 241
 242        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_CL_GEN2,
 243                SAA7706H_CL_GEN2_WSEDGE_FALLING, &err);
 244
 245        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_CL_GEN4, 0x024080, &err);
 246
 247        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_SEL, 0x200080, &err);
 248
 249        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_IAC, 0xf4caed, &err);
 250
 251        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_CLK_SET, 0x124334, &err);
 252
 253        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_CLK_COEFF, 0x004a1a,
 254                &err);
 255
 256        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_INPUT_SENS, 0x0071c7,
 257                &err);
 258
 259        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_PHONE_NAV_AUDIO,
 260                0x0e22ff, &err);
 261
 262        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_IO_CONF_DSP2, 0x001ff8,
 263                &err);
 264
 265        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_STATUS_DSP2, 0x080003,
 266                &err);
 267
 268        err = saa7706h_set_reg24_err(sd, SAA7706H_REG_PC_DSP2, 0x000004, &err);
 269
 270        err = saa7706h_set_reg16_err(sd, SAA7706H_DSP1_MOD0, 0x0c6c, &err);
 271
 272        err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_MPTR0, 0x000b4b, &err);
 273
 274        err = saa7706h_set_reg24_err(sd, SAA7706H_DSP1_MODPNTR, 0x000600, &err);
 275
 276        err = saa7706h_set_reg24_err(sd, SAA7706H_DSP1_MODPNTR, 0x0000c0, &err);
 277
 278        err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_CONTLLCW, 0x000819,
 279                &err);
 280
 281        err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_CONTLLCW, 0x00085a,
 282                &err);
 283
 284        err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_BUSAMP, 0x7fffff,
 285                &err);
 286
 287        err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_FDACPNTR, 0x2000cb,
 288                &err);
 289
 290        err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_IIS1PNTR, 0x2000cb,
 291                &err);
 292
 293        err = saa7706h_set_reg16_err(sd, SAA7706H_DSP2_YMEM_PVGA, 0x0f80, &err);
 294
 295        err = saa7706h_set_reg16_err(sd, SAA7706H_DSP2_YMEM_PVAT1, 0x0800,
 296                &err);
 297
 298        err = saa7706h_set_reg16_err(sd, SAA7706H_DSP2_YMEM_PVAT, 0x0800, &err);
 299
 300        err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_CONTLLCW, 0x000905,
 301                &err);
 302        if (!err)
 303                state->muted = 0;
 304        return err;
 305}
 306
 307static int saa7706h_mute(struct v4l2_subdev *sd)
 308{
 309        struct saa7706h_state *state = to_state(sd);
 310        int err;
 311
 312        err = saa7706h_set_reg16(sd, SAA7706H_REG_CTRL,
 313                SAA7706H_CTRL_PLL3_62975MHZ | SAA7706H_CTRL_PC_RESET_DSP1 |
 314                SAA7706H_CTRL_PC_RESET_DSP2);
 315        if (!err)
 316                state->muted = 1;
 317        return err;
 318}
 319
 320static int saa7706h_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
 321{
 322        switch (qc->id) {
 323        case V4L2_CID_AUDIO_MUTE:
 324                return v4l2_ctrl_query_fill(qc, 0, 1, 1, 1);
 325        }
 326        return -EINVAL;
 327}
 328
 329static int saa7706h_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl)
 330{
 331        struct saa7706h_state *state = to_state(sd);
 332
 333        switch (ctrl->id) {
 334        case V4L2_CID_AUDIO_MUTE:
 335                ctrl->value = state->muted;
 336                return 0;
 337        }
 338        return -EINVAL;
 339}
 340
 341static int saa7706h_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl)
 342{
 343        switch (ctrl->id) {
 344        case V4L2_CID_AUDIO_MUTE:
 345                if (ctrl->value)
 346                        return saa7706h_mute(sd);
 347                return saa7706h_unmute(sd);
 348        }
 349        return -EINVAL;
 350}
 351
 352static int saa7706h_g_chip_ident(struct v4l2_subdev *sd,
 353        struct v4l2_dbg_chip_ident *chip)
 354{
 355        struct i2c_client *client = v4l2_get_subdevdata(sd);
 356
 357        return v4l2_chip_ident_i2c_client(client, chip, V4L2_IDENT_SAA7706H, 0);
 358}
 359
 360static const struct v4l2_subdev_core_ops saa7706h_core_ops = {
 361        .g_chip_ident = saa7706h_g_chip_ident,
 362        .queryctrl = saa7706h_queryctrl,
 363        .g_ctrl = saa7706h_g_ctrl,
 364        .s_ctrl = saa7706h_s_ctrl,
 365};
 366
 367static const struct v4l2_subdev_ops saa7706h_ops = {
 368        .core = &saa7706h_core_ops,
 369};
 370
 371/*
 372 * Generic i2c probe
 373 * concerning the addresses: i2c wants 7 bit (without the r/w bit), so '>>1'
 374 */
 375
 376static int saa7706h_probe(struct i2c_client *client,
 377                          const struct i2c_device_id *id)
 378{
 379        struct saa7706h_state *state;
 380        struct v4l2_subdev *sd;
 381        int err;
 382
 383        /* Check if the adapter supports the needed features */
 384        if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 385                return -EIO;
 386
 387        v4l_info(client, "chip found @ 0x%02x (%s)\n",
 388                        client->addr << 1, client->adapter->name);
 389
 390        state = kzalloc(sizeof(struct saa7706h_state), GFP_KERNEL);
 391        if (state == NULL)
 392                return -ENOMEM;
 393        sd = &state->sd;
 394        v4l2_i2c_subdev_init(sd, client, &saa7706h_ops);
 395
 396        /* check the rom versions */
 397        err = saa7706h_get_reg16(sd, SAA7706H_DSP1_ROM_VER);
 398        if (err < 0)
 399                goto err;
 400        if (err != SUPPORTED_DSP1_ROM_VER)
 401                v4l2_warn(sd, "Unknown DSP1 ROM code version: 0x%x\n", err);
 402
 403        state->muted = 1;
 404
 405        /* startup in a muted state */
 406        err = saa7706h_mute(sd);
 407        if (err)
 408                goto err;
 409
 410        return 0;
 411
 412err:
 413        v4l2_device_unregister_subdev(sd);
 414        kfree(to_state(sd));
 415
 416        printk(KERN_ERR DRIVER_NAME ": Failed to probe: %d\n", err);
 417
 418        return err;
 419}
 420
 421static int saa7706h_remove(struct i2c_client *client)
 422{
 423        struct v4l2_subdev *sd = i2c_get_clientdata(client);
 424
 425        saa7706h_mute(sd);
 426        v4l2_device_unregister_subdev(sd);
 427        kfree(to_state(sd));
 428        return 0;
 429}
 430
 431static const struct i2c_device_id saa7706h_id[] = {
 432        {DRIVER_NAME, 0},
 433        {},
 434};
 435
 436MODULE_DEVICE_TABLE(i2c, saa7706h_id);
 437
 438static struct i2c_driver saa7706h_driver = {
 439        .driver = {
 440                .owner  = THIS_MODULE,
 441                .name   = DRIVER_NAME,
 442        },
 443        .probe          = saa7706h_probe,
 444        .remove         = saa7706h_remove,
 445        .id_table       = saa7706h_id,
 446};
 447
 448module_i2c_driver(saa7706h_driver);
 449
 450MODULE_DESCRIPTION("SAA7706H Car Radio DSP driver");
 451MODULE_AUTHOR("Mocean Laboratories");
 452MODULE_LICENSE("GPL v2");
 453