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