media/radio/saa7706h.c

0001 // SPDX-License-Identifier: GPL-2.0-only
0002 /*
0003  * saa7706.c Philips SAA7706H Car Radio DSP driver
0004  * Copyright (c) 2009 Intel Corporation
0005  */
0006
0007 #include <linux/module.h>
0008 #include <linux/init.h>
0009 #include <linux/delay.h>
0010 #include <linux/errno.h>
0011 #include <linux/kernel.h>
0012 #include <linux/interrupt.h>
0013 #include <linux/i2c.h>
0014 #include <linux/slab.h>
0015 #include <media/v4l2-device.h>
0016 #include <media/v4l2-ctrls.h>
0017
0018 #define DRIVER_NAME "saa7706h"
0019
0020 /* the I2C memory map looks like this
0021
0022     $1C00 - $FFFF Not Used
0023     $2200 - $3FFF Reserved YRAM (DSP2) space
0024     $2000 - $21FF YRAM (DSP2)
0025     $1FF0 - $1FFF Hardware Registers
0026     $1280 - $1FEF Reserved XRAM (DSP2) space
0027     $1000 - $127F XRAM (DSP2)
0028     $0FFF        DSP CONTROL
0029     $0A00 - $0FFE Reserved
0030     $0980 - $09FF Reserved YRAM (DSP1) space
0031     $0800 - $097F YRAM (DSP1)
0032     $0200 - $07FF Not Used
0033     $0180 - $01FF Reserved XRAM (DSP1) space
0034     $0000 - $017F XRAM (DSP1)
0035 */
0036
0037 #define SAA7706H_REG_CTRL       0x0fff
0038 #define SAA7706H_CTRL_BYP_PLL       0x0001
0039 #define SAA7706H_CTRL_PLL_DIV_MASK  0x003e
0040 #define SAA7706H_CTRL_PLL3_62975MHZ 0x003e
0041 #define SAA7706H_CTRL_DSP_TURBO     0x0040
0042 #define SAA7706H_CTRL_PC_RESET_DSP1 0x0080
0043 #define SAA7706H_CTRL_PC_RESET_DSP2 0x0100
0044 #define SAA7706H_CTRL_DSP1_ROM_EN_MASK  0x0600
0045 #define SAA7706H_CTRL_DSP1_FUNC_PROM    0x0000
0046 #define SAA7706H_CTRL_DSP2_ROM_EN_MASK  0x1800
0047 #define SAA7706H_CTRL_DSP2_FUNC_PROM    0x0000
0048 #define SAA7706H_CTRL_DIG_SIL_INTERPOL  0x8000
0049
0050 #define SAA7706H_REG_EVALUATION         0x1ff0
0051 #define SAA7706H_EVAL_DISABLE_CHARGE_PUMP   0x000001
0052 #define SAA7706H_EVAL_DCS_CLOCK         0x000002
0053 #define SAA7706H_EVAL_GNDRC1_ENABLE     0x000004
0054 #define SAA7706H_EVAL_GNDRC2_ENABLE     0x000008
0055
0056 #define SAA7706H_REG_CL_GEN1            0x1ff3
0057 #define SAA7706H_CL_GEN1_MIN_LOOPGAIN_MASK  0x00000f
0058 #define SAA7706H_CL_GEN1_LOOPGAIN_MASK      0x0000f0
0059 #define SAA7706H_CL_GEN1_COARSE_RATION      0xffff00
0060
0061 #define SAA7706H_REG_CL_GEN2            0x1ff4
0062 #define SAA7706H_CL_GEN2_WSEDGE_FALLING     0x000001
0063 #define SAA7706H_CL_GEN2_STOP_VCO       0x000002
0064 #define SAA7706H_CL_GEN2_FRERUN         0x000004
0065 #define SAA7706H_CL_GEN2_ADAPTIVE       0x000008
0066 #define SAA7706H_CL_GEN2_FINE_RATIO_MASK    0x0ffff0
0067
0068 #define SAA7706H_REG_CL_GEN4        0x1ff6
0069 #define SAA7706H_CL_GEN4_BYPASS_PLL1    0x001000
0070 #define SAA7706H_CL_GEN4_PLL1_DIV_MASK  0x03e000
0071 #define SAA7706H_CL_GEN4_DSP1_TURBO 0x040000
0072
0073 #define SAA7706H_REG_SEL    0x1ff7
0074 #define SAA7706H_SEL_DSP2_SRCA_MASK 0x000007
0075 #define SAA7706H_SEL_DSP2_FMTA_MASK 0x000031
0076 #define SAA7706H_SEL_DSP2_SRCB_MASK 0x0001c0
0077 #define SAA7706H_SEL_DSP2_FMTB_MASK 0x000e00
0078 #define SAA7706H_SEL_DSP1_SRC_MASK  0x003000
0079 #define SAA7706H_SEL_DSP1_FMT_MASK  0x01c003
0080 #define SAA7706H_SEL_SPDIF2     0x020000
0081 #define SAA7706H_SEL_HOST_IO_FMT_MASK   0x1c0000
0082 #define SAA7706H_SEL_EN_HOST_IO     0x200000
0083
0084 #define SAA7706H_REG_IAC        0x1ff8
0085 #define SAA7706H_REG_CLK_SET        0x1ff9
0086 #define SAA7706H_REG_CLK_COEFF      0x1ffa
0087 #define SAA7706H_REG_INPUT_SENS     0x1ffb
0088 #define SAA7706H_INPUT_SENS_RDS_VOL_MASK    0x0003f
0089 #define SAA7706H_INPUT_SENS_FM_VOL_MASK     0x00fc0
0090 #define SAA7706H_INPUT_SENS_FM_MPX      0x01000
0091 #define SAA7706H_INPUT_SENS_OFF_FILTER_A_EN 0x02000
0092 #define SAA7706H_INPUT_SENS_OFF_FILTER_B_EN 0x04000
0093 #define SAA7706H_REG_PHONE_NAV_AUDIO    0x1ffc
0094 #define SAA7706H_REG_IO_CONF_DSP2   0x1ffd
0095 #define SAA7706H_REG_STATUS_DSP2    0x1ffe
0096 #define SAA7706H_REG_PC_DSP2        0x1fff
0097
0098 #define SAA7706H_DSP1_MOD0  0x0800
0099 #define SAA7706H_DSP1_ROM_VER   0x097f
0100 #define SAA7706H_DSP2_MPTR0 0x1000
0101
0102 #define SAA7706H_DSP1_MODPNTR   0x0000
0103
0104 #define SAA7706H_DSP2_XMEM_CONTLLCW 0x113e
0105 #define SAA7706H_DSP2_XMEM_BUSAMP   0x114a
0106 #define SAA7706H_DSP2_XMEM_FDACPNTR 0x11f9
0107 #define SAA7706H_DSP2_XMEM_IIS1PNTR 0x11fb
0108
0109 #define SAA7706H_DSP2_YMEM_PVGA     0x212a
0110 #define SAA7706H_DSP2_YMEM_PVAT1    0x212b
0111 #define SAA7706H_DSP2_YMEM_PVAT     0x212c
0112 #define SAA7706H_DSP2_YMEM_ROM_VER  0x21ff
0113
0114 #define SUPPORTED_DSP1_ROM_VER      0x667
0115
0116 struct saa7706h_state {
0117     struct v4l2_subdev sd;
0118     struct v4l2_ctrl_handler hdl;
0119     unsigned muted;
0120 };
0121
0122 static inline struct saa7706h_state *to_state(struct v4l2_subdev *sd)
0123 {
0124     return container_of(sd, struct saa7706h_state, sd);
0125 }
0126
0127 static int saa7706h_i2c_send(struct i2c_client *client, const u8 *data, int len)
0128 {
0129     int err = i2c_master_send(client, data, len);
0130     if (err == len)
0131         return 0;
0132     return err > 0 ? -EIO : err;
0133 }
0134
0135 static int saa7706h_i2c_transfer(struct i2c_client *client,
0136     struct i2c_msg *msgs, int num)
0137 {
0138     int err = i2c_transfer(client->adapter, msgs, num);
0139     if (err == num)
0140         return 0;
0141     return err > 0 ? -EIO : err;
0142 }
0143
0144 static int saa7706h_set_reg24(struct v4l2_subdev *sd, u16 reg, u32 val)
0145 {
0146     struct i2c_client *client = v4l2_get_subdevdata(sd);
0147     u8 buf[5];
0148     int pos = 0;
0149
0150     buf[pos++] = reg >> 8;
0151     buf[pos++] = reg;
0152     buf[pos++] = val >> 16;
0153     buf[pos++] = val >> 8;
0154     buf[pos++] = val;
0155
0156     return saa7706h_i2c_send(client, buf, pos);
0157 }
0158
0159 static int saa7706h_set_reg24_err(struct v4l2_subdev *sd, u16 reg, u32 val,
0160     int *err)
0161 {
0162     return *err ? *err : saa7706h_set_reg24(sd, reg, val);
0163 }
0164
0165 static int saa7706h_set_reg16(struct v4l2_subdev *sd, u16 reg, u16 val)
0166 {
0167     struct i2c_client *client = v4l2_get_subdevdata(sd);
0168     u8 buf[4];
0169     int pos = 0;
0170
0171     buf[pos++] = reg >> 8;
0172     buf[pos++] = reg;
0173     buf[pos++] = val >> 8;
0174     buf[pos++] = val;
0175
0176     return saa7706h_i2c_send(client, buf, pos);
0177 }
0178
0179 static int saa7706h_set_reg16_err(struct v4l2_subdev *sd, u16 reg, u16 val,
0180     int *err)
0181 {
0182     return *err ? *err : saa7706h_set_reg16(sd, reg, val);
0183 }
0184
0185 static int saa7706h_get_reg16(struct v4l2_subdev *sd, u16 reg)
0186 {
0187     struct i2c_client *client = v4l2_get_subdevdata(sd);
0188     u8 buf[2];
0189     int err;
0190     u8 regaddr[] = {reg >> 8, reg};
0191     struct i2c_msg msg[] = {
0192                     {
0193                         .addr = client->addr,
0194                         .len = sizeof(regaddr),
0195                         .buf = regaddr
0196                     },
0197                     {
0198                         .addr = client->addr,
0199                         .flags = I2C_M_RD,
0200                         .len = sizeof(buf),
0201                         .buf = buf
0202                     }
0203                 };
0204
0205     err = saa7706h_i2c_transfer(client, msg, ARRAY_SIZE(msg));
0206     if (err)
0207         return err;
0208
0209     return buf[0] << 8 | buf[1];
0210 }
0211
0212 static int saa7706h_unmute(struct v4l2_subdev *sd)
0213 {
0214     struct saa7706h_state *state = to_state(sd);
0215     int err = 0;
0216
0217     err = saa7706h_set_reg16_err(sd, SAA7706H_REG_CTRL,
0218         SAA7706H_CTRL_PLL3_62975MHZ | SAA7706H_CTRL_PC_RESET_DSP1 |
0219         SAA7706H_CTRL_PC_RESET_DSP2, &err);
0220
0221     /* newer versions of the chip requires a small sleep after reset */
0222     msleep(1);
0223
0224     err = saa7706h_set_reg16_err(sd, SAA7706H_REG_CTRL,
0225         SAA7706H_CTRL_PLL3_62975MHZ, &err);
0226
0227     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_EVALUATION, 0, &err);
0228
0229     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_CL_GEN1, 0x040022, &err);
0230
0231     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_CL_GEN2,
0232         SAA7706H_CL_GEN2_WSEDGE_FALLING, &err);
0233
0234     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_CL_GEN4, 0x024080, &err);
0235
0236     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_SEL, 0x200080, &err);
0237
0238     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_IAC, 0xf4caed, &err);
0239
0240     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_CLK_SET, 0x124334, &err);
0241
0242     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_CLK_COEFF, 0x004a1a,
0243         &err);
0244
0245     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_INPUT_SENS, 0x0071c7,
0246         &err);
0247
0248     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_PHONE_NAV_AUDIO,
0249         0x0e22ff, &err);
0250
0251     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_IO_CONF_DSP2, 0x001ff8,
0252         &err);
0253
0254     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_STATUS_DSP2, 0x080003,
0255         &err);
0256
0257     err = saa7706h_set_reg24_err(sd, SAA7706H_REG_PC_DSP2, 0x000004, &err);
0258
0259     err = saa7706h_set_reg16_err(sd, SAA7706H_DSP1_MOD0, 0x0c6c, &err);
0260
0261     err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_MPTR0, 0x000b4b, &err);
0262
0263     err = saa7706h_set_reg24_err(sd, SAA7706H_DSP1_MODPNTR, 0x000600, &err);
0264
0265     err = saa7706h_set_reg24_err(sd, SAA7706H_DSP1_MODPNTR, 0x0000c0, &err);
0266
0267     err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_CONTLLCW, 0x000819,
0268         &err);
0269
0270     err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_CONTLLCW, 0x00085a,
0271         &err);
0272
0273     err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_BUSAMP, 0x7fffff,
0274         &err);
0275
0276     err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_FDACPNTR, 0x2000cb,
0277         &err);
0278
0279     err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_IIS1PNTR, 0x2000cb,
0280         &err);
0281
0282     err = saa7706h_set_reg16_err(sd, SAA7706H_DSP2_YMEM_PVGA, 0x0f80, &err);
0283
0284     err = saa7706h_set_reg16_err(sd, SAA7706H_DSP2_YMEM_PVAT1, 0x0800,
0285         &err);
0286
0287     err = saa7706h_set_reg16_err(sd, SAA7706H_DSP2_YMEM_PVAT, 0x0800, &err);
0288
0289     err = saa7706h_set_reg24_err(sd, SAA7706H_DSP2_XMEM_CONTLLCW, 0x000905,
0290         &err);
0291     if (!err)
0292         state->muted = 0;
0293     return err;
0294 }
0295
0296 static int saa7706h_mute(struct v4l2_subdev *sd)
0297 {
0298     struct saa7706h_state *state = to_state(sd);
0299     int err;
0300
0301     err = saa7706h_set_reg16(sd, SAA7706H_REG_CTRL,
0302         SAA7706H_CTRL_PLL3_62975MHZ | SAA7706H_CTRL_PC_RESET_DSP1 |
0303         SAA7706H_CTRL_PC_RESET_DSP2);
0304     if (!err)
0305         state->muted = 1;
0306     return err;
0307 }
0308
0309 static int saa7706h_s_ctrl(struct v4l2_ctrl *ctrl)
0310 {
0311     struct saa7706h_state *state =
0312         container_of(ctrl->handler, struct saa7706h_state, hdl);
0313
0314     switch (ctrl->id) {
0315     case V4L2_CID_AUDIO_MUTE:
0316         if (ctrl->val)
0317             return saa7706h_mute(&state->sd);
0318         return saa7706h_unmute(&state->sd);
0319     }
0320     return -EINVAL;
0321 }
0322
0323 static const struct v4l2_ctrl_ops saa7706h_ctrl_ops = {
0324     .s_ctrl = saa7706h_s_ctrl,
0325 };
0326
0327 static const struct v4l2_subdev_ops empty_ops = {};
0328
0329 /*
0330  * Generic i2c probe
0331  * concerning the addresses: i2c wants 7 bit (without the r/w bit), so '>>1'
0332  */
0333
0334 static int saa7706h_probe(struct i2c_client *client,
0335               const struct i2c_device_id *id)
0336 {
0337     struct saa7706h_state *state;
0338     struct v4l2_subdev *sd;
0339     int err;
0340
0341     /* Check if the adapter supports the needed features */
0342     if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
0343         return -EIO;
0344
0345     v4l_info(client, "chip found @ 0x%02x (%s)\n",
0346             client->addr << 1, client->adapter->name);
0347
0348     state = kzalloc(sizeof(struct saa7706h_state), GFP_KERNEL);
0349     if (state == NULL)
0350         return -ENOMEM;
0351     sd = &state->sd;
0352     v4l2_i2c_subdev_init(sd, client, &empty_ops);
0353
0354     v4l2_ctrl_handler_init(&state->hdl, 4);
0355     v4l2_ctrl_new_std(&state->hdl, &saa7706h_ctrl_ops,
0356             V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
0357     sd->ctrl_handler = &state->hdl;
0358     err = state->hdl.error;
0359     if (err)
0360         goto err;
0361
0362     /* check the rom versions */
0363     err = saa7706h_get_reg16(sd, SAA7706H_DSP1_ROM_VER);
0364     if (err < 0)
0365         goto err;
0366     if (err != SUPPORTED_DSP1_ROM_VER)
0367         v4l2_warn(sd, "Unknown DSP1 ROM code version: 0x%x\n", err);
0368     state->muted = 1;
0369
0370     /* startup in a muted state */
0371     err = saa7706h_mute(sd);
0372     if (err)
0373         goto err;
0374
0375     return 0;
0376
0377 err:
0378     v4l2_device_unregister_subdev(sd);
0379     v4l2_ctrl_handler_free(&state->hdl);
0380     kfree(to_state(sd));
0381
0382     printk(KERN_ERR DRIVER_NAME ": Failed to probe: %d\n", err);
0383
0384     return err;
0385 }
0386
0387 static int saa7706h_remove(struct i2c_client *client)
0388 {
0389     struct v4l2_subdev *sd = i2c_get_clientdata(client);
0390     struct saa7706h_state *state = to_state(sd);
0391
0392     saa7706h_mute(sd);
0393     v4l2_device_unregister_subdev(sd);
0394     v4l2_ctrl_handler_free(&state->hdl);
0395     kfree(to_state(sd));
0396     return 0;
0397 }
0398
0399 static const struct i2c_device_id saa7706h_id[] = {
0400     {DRIVER_NAME, 0},
0401     {},
0402 };
0403
0404 MODULE_DEVICE_TABLE(i2c, saa7706h_id);
0405
0406 static struct i2c_driver saa7706h_driver = {
0407     .driver = {
0408         .name   = DRIVER_NAME,
0409     },
0410     .probe      = saa7706h_probe,
0411     .remove     = saa7706h_remove,
0412     .id_table   = saa7706h_id,
0413 };
0414
0415 module_i2c_driver(saa7706h_driver);
0416
0417 MODULE_DESCRIPTION("SAA7706H Car Radio DSP driver");
0418 MODULE_AUTHOR("Mocean Laboratories");
0419 MODULE_LICENSE("GPL v2");