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