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