drivers/media/video/wm8775.c

   1 /*
   2  * wm8775 - driver version 0.0.1
   3  *
   4  * Copyright (C) 2004 Ulf Eklund <ivtv at eklund.to>
   5  *
   6  * Based on saa7115 driver
   7  *
   8  * Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
   9  * - Cleanup
  10  * - V4L2 API update
  11  * - sound fixes
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  26  */
  27
  28 #include <linux/module.h>
  29 #include <linux/types.h>
  30 #include <linux/slab.h>
  31 #include <linux/ioctl.h>
  32 #include <asm/uaccess.h>
  33 #include <linux/i2c.h>
  34 #include <linux/videodev2.h>
  35 #include <media/v4l2-device.h>
  36 #include <media/v4l2-chip-ident.h>
  37 #include <media/v4l2-ctrls.h>
  38
  39 MODULE_DESCRIPTION("wm8775 driver");
  40 MODULE_AUTHOR("Ulf Eklund, Hans Verkuil");
  41 MODULE_LICENSE("GPL");
  42
  43
  44
  45 /* ----------------------------------------------------------------------- */
  46
  47 enum {
  48         R7 = 7, R11 = 11,
  49         R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R23 = 23,
  50         TOT_REGS
  51 };
  52
  53 struct wm8775_state {
  54         struct v4l2_subdev sd;
  55         struct v4l2_ctrl_handler hdl;
  56         struct v4l2_ctrl *mute;
  57         u8 input;               /* Last selected input (0-0xf) */
  58 };
  59
  60 static inline struct wm8775_state *to_state(struct v4l2_subdev *sd)
  61 {
  62         return container_of(sd, struct wm8775_state, sd);
  63 }
  64
  65 static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
  66 {
  67         return &container_of(ctrl->handler, struct wm8775_state, hdl)->sd;
  68 }
  69
  70 static int wm8775_write(struct v4l2_subdev *sd, int reg, u16 val)
  71 {
  72         struct i2c_client *client = v4l2_get_subdevdata(sd);
  73         int i;
  74
  75         if (reg < 0 || reg >= TOT_REGS) {
  76                 v4l2_err(sd, "Invalid register R%d\n", reg);
  77                 return -1;
  78         }
  79
  80         for (i = 0; i < 3; i++)
  81                 if (i2c_smbus_write_byte_data(client,
  82                                 (reg << 1) | (val >> 8), val & 0xff) == 0)
  83                         return 0;
  84         v4l2_err(sd, "I2C: cannot write %03x to register R%d\n", val, reg);
  85         return -1;
  86 }
  87
  88 static int wm8775_s_routing(struct v4l2_subdev *sd,
  89                             u32 input, u32 output, u32 config)
  90 {
  91         struct wm8775_state *state = to_state(sd);
  92
  93         /* There are 4 inputs and one output. Zero or more inputs
  94            are multiplexed together to the output. Hence there are
  95            16 combinations.
  96            If only one input is active (the normal case) then the
  97            input values 1, 2, 4 or 8 should be used. */
  98         if (input > 15) {
  99                 v4l2_err(sd, "Invalid input %d.\n", input);
 100                 return -EINVAL;
 101         }
 102         state->input = input;
 103         if (!v4l2_ctrl_g_ctrl(state->mute))
 104                 return 0;
 105         wm8775_write(sd, R21, 0x0c0);
 106         wm8775_write(sd, R14, 0x1d4);
 107         wm8775_write(sd, R15, 0x1d4);
 108         wm8775_write(sd, R21, 0x100 + state->input);
 109         return 0;
 110 }
 111
 112 static int wm8775_s_ctrl(struct v4l2_ctrl *ctrl)
 113 {
 114         struct v4l2_subdev *sd = to_sd(ctrl);
 115         struct wm8775_state *state = to_state(sd);
 116
 117         switch (ctrl->id) {
 118         case V4L2_CID_AUDIO_MUTE:
 119                 wm8775_write(sd, R21, 0x0c0);
 120                 wm8775_write(sd, R14, 0x1d4);
 121                 wm8775_write(sd, R15, 0x1d4);
 122                 if (!ctrl->val)
 123                         wm8775_write(sd, R21, 0x100 + state->input);
 124                 return 0;
 125         }
 126         return -EINVAL;
 127 }
 128
 129 static int wm8775_g_chip_ident(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip)
 130 {
 131         struct i2c_client *client = v4l2_get_subdevdata(sd);
 132
 133         return v4l2_chip_ident_i2c_client(client, chip, V4L2_IDENT_WM8775, 0);
 134 }
 135
 136 static int wm8775_log_status(struct v4l2_subdev *sd)
 137 {
 138         struct wm8775_state *state = to_state(sd);
 139
 140         v4l2_info(sd, "Input: %d\n", state->input);
 141         v4l2_ctrl_handler_log_status(&state->hdl, sd->name);
 142         return 0;
 143 }
 144
 145 static int wm8775_s_frequency(struct v4l2_subdev *sd, struct v4l2_frequency *freq)
 146 {
 147         struct wm8775_state *state = to_state(sd);
 148
 149         /* If I remove this, then it can happen that I have no
 150            sound the first time I tune from static to a valid channel.
 151            It's difficult to reproduce and is almost certainly related
 152            to the zero cross detect circuit. */
 153         wm8775_write(sd, R21, 0x0c0);
 154         wm8775_write(sd, R14, 0x1d4);
 155         wm8775_write(sd, R15, 0x1d4);
 156         wm8775_write(sd, R21, 0x100 + state->input);
 157         return 0;
 158 }
 159
 160 /* ----------------------------------------------------------------------- */
 161
 162 static const struct v4l2_ctrl_ops wm8775_ctrl_ops = {
 163         .s_ctrl = wm8775_s_ctrl,
 164 };
 165
 166 static const struct v4l2_subdev_core_ops wm8775_core_ops = {
 167         .log_status = wm8775_log_status,
 168         .g_chip_ident = wm8775_g_chip_ident,
 169         .g_ext_ctrls = v4l2_subdev_g_ext_ctrls,
 170         .try_ext_ctrls = v4l2_subdev_try_ext_ctrls,
 171         .s_ext_ctrls = v4l2_subdev_s_ext_ctrls,
 172         .g_ctrl = v4l2_subdev_g_ctrl,
 173         .s_ctrl = v4l2_subdev_s_ctrl,
 174         .queryctrl = v4l2_subdev_queryctrl,
 175         .querymenu = v4l2_subdev_querymenu,
 176 };
 177
 178 static const struct v4l2_subdev_tuner_ops wm8775_tuner_ops = {
 179         .s_frequency = wm8775_s_frequency,
 180 };
 181
 182 static const struct v4l2_subdev_audio_ops wm8775_audio_ops = {
 183         .s_routing = wm8775_s_routing,
 184 };
 185
 186 static const struct v4l2_subdev_ops wm8775_ops = {
 187         .core = &wm8775_core_ops,
 188         .tuner = &wm8775_tuner_ops,
 189         .audio = &wm8775_audio_ops,
 190 };
 191
 192 /* ----------------------------------------------------------------------- */
 193
 194 /* i2c implementation */
 195
 196 /*
 197  * Generic i2c probe
 198  * concerning the addresses: i2c wants 7 bit (without the r/w bit), so '>>1'
 199  */
 200
 201 static int wm8775_probe(struct i2c_client *client,
 202                         const struct i2c_device_id *id)
 203 {
 204         struct wm8775_state *state;
 205         struct v4l2_subdev *sd;
 206
 207         /* Check if the adapter supports the needed features */
 208         if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 209                 return -EIO;
 210
 211         v4l_info(client, "chip found @ 0x%02x (%s)\n",
 212                         client->addr << 1, client->adapter->name);
 213
 214         state = kzalloc(sizeof(struct wm8775_state), GFP_KERNEL);
 215         if (state == NULL)
 216                 return -ENOMEM;
 217         sd = &state->sd;
 218         v4l2_i2c_subdev_init(sd, client, &wm8775_ops);
 219         state->input = 2;
 220
 221         v4l2_ctrl_handler_init(&state->hdl, 1);
 222         state->mute = v4l2_ctrl_new_std(&state->hdl, &wm8775_ctrl_ops,
 223                         V4L2_CID_AUDIO_MUTE, 0, 1, 1, 0);
 224         sd->ctrl_handler = &state->hdl;
 225         if (state->hdl.error) {
 226                 int err = state->hdl.error;
 227
 228                 v4l2_ctrl_handler_free(&state->hdl);
 229                 kfree(state);
 230                 return err;
 231         }
 232
 233         /* Initialize wm8775 */
 234
 235         /* RESET */
 236         wm8775_write(sd, R23, 0x000);
 237         /* Disable zero cross detect timeout */
 238         wm8775_write(sd, R7, 0x000);
 239         /* Left justified, 24-bit mode */
 240         wm8775_write(sd, R11, 0x021);
 241         /* Master mode, clock ratio 256fs */
 242         wm8775_write(sd, R12, 0x102);
 243         /* Powered up */
 244         wm8775_write(sd, R13, 0x000);
 245         /* ADC gain +2.5dB, enable zero cross */
 246         wm8775_write(sd, R14, 0x1d4);
 247         /* ADC gain +2.5dB, enable zero cross */
 248         wm8775_write(sd, R15, 0x1d4);
 249         /* ALC Stereo, ALC target level -1dB FS max gain +8dB */
 250         wm8775_write(sd, R16, 0x1bf);
 251         /* Enable gain control, use zero cross detection,
 252            ALC hold time 42.6 ms */
 253         wm8775_write(sd, R17, 0x185);
 254         /* ALC gain ramp up delay 34 s, ALC gain ramp down delay 33 ms */
 255         wm8775_write(sd, R18, 0x0a2);
 256         /* Enable noise gate, threshold -72dBfs */
 257         wm8775_write(sd, R19, 0x005);
 258         /* Transient window 4ms, lower PGA gain limit -1dB */
 259         wm8775_write(sd, R20, 0x07a);
 260         /* LRBOTH = 1, use input 2. */
 261         wm8775_write(sd, R21, 0x102);
 262         return 0;
 263 }
 264
 265 static int wm8775_remove(struct i2c_client *client)
 266 {
 267         struct v4l2_subdev *sd = i2c_get_clientdata(client);
 268         struct wm8775_state *state = to_state(sd);
 269
 270         v4l2_device_unregister_subdev(sd);
 271         v4l2_ctrl_handler_free(&state->hdl);
 272         kfree(state);
 273         return 0;
 274 }
 275
 276 static const struct i2c_device_id wm8775_id[] = {
 277         { "wm8775", 0 },
 278         { }
 279 };
 280 MODULE_DEVICE_TABLE(i2c, wm8775_id);
 281
 282 static struct i2c_driver wm8775_driver = {
 283         .driver = {
 284                 .owner  = THIS_MODULE,
 285                 .name   = "wm8775",
 286         },
 287         .probe          = wm8775_probe,
 288         .remove         = wm8775_remove,
 289         .id_table       = wm8775_id,
 290 };
 291
 292 static __init int init_wm8775(void)
 293 {
 294         return i2c_add_driver(&wm8775_driver);
 295 }
 296
 297 static __exit void exit_wm8775(void)
 298 {
 299         i2c_del_driver(&wm8775_driver);
 300 }
 301
 302 module_init(init_wm8775);
 303 module_exit(exit_wm8775);