regulator: fix header file missing kernel-doc
[linux-2.6.git] / drivers / media / video / wm8739.c
blobb572ce288e14857d2e6f3f9fffe2675a5f111d89
1 /*
2 * wm8739
4 * Copyright (C) 2005 T. Adachi <tadachi@tadachi-net.com>
6 * Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
7 * - Cleanup
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <linux/module.h>
25 #include <linux/types.h>
26 #include <linux/ioctl.h>
27 #include <asm/uaccess.h>
28 #include <linux/i2c.h>
29 #include <linux/i2c-id.h>
30 #include <linux/videodev2.h>
31 #include <media/v4l2-device.h>
32 #include <media/v4l2-chip-ident.h>
33 #include <media/v4l2-i2c-drv.h>
35 MODULE_DESCRIPTION("wm8739 driver");
36 MODULE_AUTHOR("T. Adachi, Hans Verkuil");
37 MODULE_LICENSE("GPL");
39 static int debug;
41 module_param(debug, int, 0644);
43 MODULE_PARM_DESC(debug, "Debug level (0-1)");
46 /* ------------------------------------------------------------------------ */
48 enum {
49 R0 = 0, R1,
50 R5 = 5, R6, R7, R8, R9, R15 = 15,
51 TOT_REGS
54 struct wm8739_state {
55 struct v4l2_subdev sd;
56 u32 clock_freq;
57 u8 muted;
58 u16 volume;
59 u16 balance;
60 u8 vol_l; /* +12dB to -34.5dB 1.5dB step (5bit) def:0dB */
61 u8 vol_r; /* +12dB to -34.5dB 1.5dB step (5bit) def:0dB */
64 static inline struct wm8739_state *to_state(struct v4l2_subdev *sd)
66 return container_of(sd, struct wm8739_state, sd);
69 /* ------------------------------------------------------------------------ */
71 static int wm8739_write(struct v4l2_subdev *sd, int reg, u16 val)
73 struct i2c_client *client = v4l2_get_subdevdata(sd);
74 int i;
76 if (reg < 0 || reg >= TOT_REGS) {
77 v4l2_err(sd, "Invalid register R%d\n", reg);
78 return -1;
81 v4l2_dbg(1, debug, sd, "write: %02x %02x\n", reg, val);
83 for (i = 0; i < 3; i++)
84 if (i2c_smbus_write_byte_data(client,
85 (reg << 1) | (val >> 8), val & 0xff) == 0)
86 return 0;
87 v4l2_err(sd, "I2C: cannot write %03x to register R%d\n", val, reg);
88 return -1;
91 /* write regs to set audio volume etc */
92 static void wm8739_set_audio(struct v4l2_subdev *sd)
94 struct wm8739_state *state = to_state(sd);
95 u16 mute = state->muted ? 0x80 : 0;
97 /* Volume setting: bits 0-4, 0x1f = 12 dB, 0x00 = -34.5 dB
98 * Default setting: 0x17 = 0 dB
100 wm8739_write(sd, R0, (state->vol_l & 0x1f) | mute);
101 wm8739_write(sd, R1, (state->vol_r & 0x1f) | mute);
104 static int wm8739_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl)
106 struct wm8739_state *state = to_state(sd);
108 switch (ctrl->id) {
109 case V4L2_CID_AUDIO_MUTE:
110 ctrl->value = state->muted;
111 break;
113 case V4L2_CID_AUDIO_VOLUME:
114 ctrl->value = state->volume;
115 break;
117 case V4L2_CID_AUDIO_BALANCE:
118 ctrl->value = state->balance;
119 break;
121 default:
122 return -EINVAL;
124 return 0;
127 static int wm8739_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl)
129 struct wm8739_state *state = to_state(sd);
130 unsigned int work_l, work_r;
132 switch (ctrl->id) {
133 case V4L2_CID_AUDIO_MUTE:
134 state->muted = ctrl->value;
135 break;
137 case V4L2_CID_AUDIO_VOLUME:
138 state->volume = ctrl->value;
139 break;
141 case V4L2_CID_AUDIO_BALANCE:
142 state->balance = ctrl->value;
143 break;
145 default:
146 return -EINVAL;
149 /* normalize ( 65535 to 0 -> 31 to 0 (12dB to -34.5dB) ) */
150 work_l = (min(65536 - state->balance, 32768) * state->volume) / 32768;
151 work_r = (min(state->balance, (u16)32768) * state->volume) / 32768;
153 state->vol_l = (long)work_l * 31 / 65535;
154 state->vol_r = (long)work_r * 31 / 65535;
156 /* set audio volume etc. */
157 wm8739_set_audio(sd);
158 return 0;
161 /* ------------------------------------------------------------------------ */
163 static struct v4l2_queryctrl wm8739_qctrl[] = {
165 .id = V4L2_CID_AUDIO_VOLUME,
166 .name = "Volume",
167 .minimum = 0,
168 .maximum = 65535,
169 .step = 65535/100,
170 .default_value = 58880,
171 .flags = 0,
172 .type = V4L2_CTRL_TYPE_INTEGER,
173 }, {
174 .id = V4L2_CID_AUDIO_MUTE,
175 .name = "Mute",
176 .minimum = 0,
177 .maximum = 1,
178 .step = 1,
179 .default_value = 1,
180 .flags = 0,
181 .type = V4L2_CTRL_TYPE_BOOLEAN,
182 }, {
183 .id = V4L2_CID_AUDIO_BALANCE,
184 .name = "Balance",
185 .minimum = 0,
186 .maximum = 65535,
187 .step = 65535/100,
188 .default_value = 32768,
189 .flags = 0,
190 .type = V4L2_CTRL_TYPE_INTEGER,
194 /* ------------------------------------------------------------------------ */
196 static int wm8739_s_clock_freq(struct v4l2_subdev *sd, u32 audiofreq)
198 struct wm8739_state *state = to_state(sd);
200 state->clock_freq = audiofreq;
201 /* de-activate */
202 wm8739_write(sd, R9, 0x000);
203 switch (audiofreq) {
204 case 44100:
205 /* 256fps, fs=44.1k */
206 wm8739_write(sd, R8, 0x020);
207 break;
208 case 48000:
209 /* 256fps, fs=48k */
210 wm8739_write(sd, R8, 0x000);
211 break;
212 case 32000:
213 /* 256fps, fs=32k */
214 wm8739_write(sd, R8, 0x018);
215 break;
216 default:
217 break;
219 /* activate */
220 wm8739_write(sd, R9, 0x001);
221 return 0;
224 static int wm8739_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
226 int i;
228 for (i = 0; i < ARRAY_SIZE(wm8739_qctrl); i++)
229 if (qc->id && qc->id == wm8739_qctrl[i].id) {
230 memcpy(qc, &wm8739_qctrl[i], sizeof(*qc));
231 return 0;
233 return -EINVAL;
236 static int wm8739_g_chip_ident(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip)
238 struct i2c_client *client = v4l2_get_subdevdata(sd);
240 return v4l2_chip_ident_i2c_client(client, chip, V4L2_IDENT_WM8739, 0);
243 static int wm8739_log_status(struct v4l2_subdev *sd)
245 struct wm8739_state *state = to_state(sd);
247 v4l2_info(sd, "Frequency: %u Hz\n", state->clock_freq);
248 v4l2_info(sd, "Volume L: %02x%s\n", state->vol_l & 0x1f,
249 state->muted ? " (muted)" : "");
250 v4l2_info(sd, "Volume R: %02x%s\n", state->vol_r & 0x1f,
251 state->muted ? " (muted)" : "");
252 return 0;
255 /* ----------------------------------------------------------------------- */
257 static const struct v4l2_subdev_core_ops wm8739_core_ops = {
258 .log_status = wm8739_log_status,
259 .g_chip_ident = wm8739_g_chip_ident,
260 .queryctrl = wm8739_queryctrl,
261 .g_ctrl = wm8739_g_ctrl,
262 .s_ctrl = wm8739_s_ctrl,
265 static const struct v4l2_subdev_audio_ops wm8739_audio_ops = {
266 .s_clock_freq = wm8739_s_clock_freq,
269 static const struct v4l2_subdev_ops wm8739_ops = {
270 .core = &wm8739_core_ops,
271 .audio = &wm8739_audio_ops,
274 /* ------------------------------------------------------------------------ */
276 /* i2c implementation */
278 static int wm8739_probe(struct i2c_client *client,
279 const struct i2c_device_id *id)
281 struct wm8739_state *state;
282 struct v4l2_subdev *sd;
284 /* Check if the adapter supports the needed features */
285 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
286 return -EIO;
288 v4l_info(client, "chip found @ 0x%x (%s)\n",
289 client->addr << 1, client->adapter->name);
291 state = kmalloc(sizeof(struct wm8739_state), GFP_KERNEL);
292 if (state == NULL)
293 return -ENOMEM;
294 sd = &state->sd;
295 v4l2_i2c_subdev_init(sd, client, &wm8739_ops);
296 state->vol_l = 0x17; /* 0dB */
297 state->vol_r = 0x17; /* 0dB */
298 state->muted = 0;
299 state->balance = 32768;
300 /* normalize (12dB(31) to -34.5dB(0) [0dB(23)] -> 65535 to 0) */
301 state->volume = ((long)state->vol_l + 1) * 65535 / 31;
302 state->clock_freq = 48000;
304 /* Initialize wm8739 */
306 /* reset */
307 wm8739_write(sd, R15, 0x00);
308 /* filter setting, high path, offet clear */
309 wm8739_write(sd, R5, 0x000);
310 /* ADC, OSC, Power Off mode Disable */
311 wm8739_write(sd, R6, 0x000);
312 /* Digital Audio interface format:
313 Enable Master mode, 24 bit, MSB first/left justified */
314 wm8739_write(sd, R7, 0x049);
315 /* sampling control: normal, 256fs, 48KHz sampling rate */
316 wm8739_write(sd, R8, 0x000);
317 /* activate */
318 wm8739_write(sd, R9, 0x001);
319 /* set volume/mute */
320 wm8739_set_audio(sd);
321 return 0;
324 static int wm8739_remove(struct i2c_client *client)
326 struct v4l2_subdev *sd = i2c_get_clientdata(client);
328 v4l2_device_unregister_subdev(sd);
329 kfree(to_state(sd));
330 return 0;
333 static const struct i2c_device_id wm8739_id[] = {
334 { "wm8739", 0 },
337 MODULE_DEVICE_TABLE(i2c, wm8739_id);
339 static struct v4l2_i2c_driver_data v4l2_i2c_data = {
340 .name = "wm8739",
341 .probe = wm8739_probe,
342 .remove = wm8739_remove,
343 .id_table = wm8739_id,