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