1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * wm8775 - driver version 0.0.1
4 *
5 * Copyright (C) 2004 Ulf Eklund <ivtv at eklund.to>
6 *
7 * Based on saa7115 driver
8 *
9 * Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
10 * - Cleanup
11 * - V4L2 API update
12 * - sound fixes
13 */
14
15 #include <linux/module.h>
16 #include <linux/types.h>
17 #include <linux/slab.h>
18 #include <linux/ioctl.h>
19 #include <linux/uaccess.h>
20 #include <linux/i2c.h>
21 #include <linux/videodev2.h>
22 #include <media/v4l2-device.h>
23 #include <media/v4l2-ctrls.h>
24 #include <media/i2c/wm8775.h>
25
26 MODULE_DESCRIPTION("wm8775 driver");
27 MODULE_AUTHOR("Ulf Eklund, Hans Verkuil");
28 MODULE_LICENSE("GPL");
29
30
31
32 /* ----------------------------------------------------------------------- */
33
34 enum {
35 R7 = 7, R11 = 11,
36 R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R23 = 23,
37 TOT_REGS
38 };
39
40 #define ALC_HOLD 0x85 /* R17: use zero cross detection, ALC hold time 42.6 ms */
41 #define ALC_EN 0x100 /* R17: ALC enable */
42
43 struct wm8775_state {
44 struct v4l2_subdev sd;
45 struct v4l2_ctrl_handler hdl;
46 struct v4l2_ctrl *mute;
47 struct v4l2_ctrl *vol;
48 struct v4l2_ctrl *bal;
49 struct v4l2_ctrl *loud;
50 u8 input; /* Last selected input (0-0xf) */
51 };
52
to_state(struct v4l2_subdev * sd)53 static inline struct wm8775_state *to_state(struct v4l2_subdev *sd)
54 {
55 return container_of(sd, struct wm8775_state, sd);
56 }
57
to_sd(struct v4l2_ctrl * ctrl)58 static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
59 {
60 return &container_of(ctrl->handler, struct wm8775_state, hdl)->sd;
61 }
62
wm8775_write(struct v4l2_subdev * sd,int reg,u16 val)63 static int wm8775_write(struct v4l2_subdev *sd, int reg, u16 val)
64 {
65 struct i2c_client *client = v4l2_get_subdevdata(sd);
66 int i;
67
68 if (reg < 0 || reg >= TOT_REGS) {
69 v4l2_err(sd, "Invalid register R%d\n", reg);
70 return -1;
71 }
72
73 for (i = 0; i < 3; i++)
74 if (i2c_smbus_write_byte_data(client,
75 (reg << 1) | (val >> 8), val & 0xff) == 0)
76 return 0;
77 v4l2_err(sd, "I2C: cannot write %03x to register R%d\n", val, reg);
78 return -1;
79 }
80
wm8775_set_audio(struct v4l2_subdev * sd,int quietly)81 static void wm8775_set_audio(struct v4l2_subdev *sd, int quietly)
82 {
83 struct wm8775_state *state = to_state(sd);
84 u8 vol_l, vol_r;
85 int muted = 0 != state->mute->val;
86 u16 volume = (u16)state->vol->val;
87 u16 balance = (u16)state->bal->val;
88
89 /* normalize ( 65535 to 0 -> 255 to 0 (+24dB to -103dB) ) */
90 vol_l = (min(65536 - balance, 32768) * volume) >> 23;
91 vol_r = (min(balance, (u16)32768) * volume) >> 23;
92
93 /* Mute */
94 if (muted || quietly)
95 wm8775_write(sd, R21, 0x0c0 | state->input);
96
97 wm8775_write(sd, R14, vol_l | 0x100); /* 0x100= Left channel ADC zero cross enable */
98 wm8775_write(sd, R15, vol_r | 0x100); /* 0x100= Right channel ADC zero cross enable */
99
100 /* Un-mute */
101 if (!muted)
102 wm8775_write(sd, R21, state->input);
103 }
104
wm8775_s_routing(struct v4l2_subdev * sd,u32 input,u32 output,u32 config)105 static int wm8775_s_routing(struct v4l2_subdev *sd,
106 u32 input, u32 output, u32 config)
107 {
108 struct wm8775_state *state = to_state(sd);
109
110 /* There are 4 inputs and one output. Zero or more inputs
111 are multiplexed together to the output. Hence there are
112 16 combinations.
113 If only one input is active (the normal case) then the
114 input values 1, 2, 4 or 8 should be used. */
115 if (input > 15) {
116 v4l2_err(sd, "Invalid input %d.\n", input);
117 return -EINVAL;
118 }
119 state->input = input;
120 if (v4l2_ctrl_g_ctrl(state->mute))
121 return 0;
122 if (!v4l2_ctrl_g_ctrl(state->vol))
123 return 0;
124 wm8775_set_audio(sd, 1);
125 return 0;
126 }
127
wm8775_s_ctrl(struct v4l2_ctrl * ctrl)128 static int wm8775_s_ctrl(struct v4l2_ctrl *ctrl)
129 {
130 struct v4l2_subdev *sd = to_sd(ctrl);
131
132 switch (ctrl->id) {
133 case V4L2_CID_AUDIO_MUTE:
134 case V4L2_CID_AUDIO_VOLUME:
135 case V4L2_CID_AUDIO_BALANCE:
136 wm8775_set_audio(sd, 0);
137 return 0;
138 case V4L2_CID_AUDIO_LOUDNESS:
139 wm8775_write(sd, R17, (ctrl->val ? ALC_EN : 0) | ALC_HOLD);
140 return 0;
141 }
142 return -EINVAL;
143 }
144
wm8775_log_status(struct v4l2_subdev * sd)145 static int wm8775_log_status(struct v4l2_subdev *sd)
146 {
147 struct wm8775_state *state = to_state(sd);
148
149 v4l2_info(sd, "Input: %d\n", state->input);
150 v4l2_ctrl_handler_log_status(&state->hdl, sd->name);
151 return 0;
152 }
153
wm8775_s_frequency(struct v4l2_subdev * sd,const struct v4l2_frequency * freq)154 static int wm8775_s_frequency(struct v4l2_subdev *sd, const struct v4l2_frequency *freq)
155 {
156 wm8775_set_audio(sd, 0);
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 };
169
170 static const struct v4l2_subdev_tuner_ops wm8775_tuner_ops = {
171 .s_frequency = wm8775_s_frequency,
172 };
173
174 static const struct v4l2_subdev_audio_ops wm8775_audio_ops = {
175 .s_routing = wm8775_s_routing,
176 };
177
178 static const struct v4l2_subdev_ops wm8775_ops = {
179 .core = &wm8775_core_ops,
180 .tuner = &wm8775_tuner_ops,
181 .audio = &wm8775_audio_ops,
182 };
183
184 /* ----------------------------------------------------------------------- */
185
186 /* i2c implementation */
187
188 /*
189 * Generic i2c probe
190 * concerning the addresses: i2c wants 7 bit (without the r/w bit), so '>>1'
191 */
192
wm8775_probe(struct i2c_client * client)193 static int wm8775_probe(struct i2c_client *client)
194 {
195 struct wm8775_state *state;
196 struct v4l2_subdev *sd;
197 int err;
198 bool is_nova_s = false;
199
200 if (client->dev.platform_data) {
201 struct wm8775_platform_data *data = client->dev.platform_data;
202 is_nova_s = data->is_nova_s;
203 }
204
205 /* Check if the adapter supports the needed features */
206 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
207 return -EIO;
208
209 v4l_info(client, "chip found @ 0x%02x (%s)\n",
210 client->addr << 1, client->adapter->name);
211
212 state = devm_kzalloc(&client->dev, sizeof(*state), GFP_KERNEL);
213 if (state == NULL)
214 return -ENOMEM;
215 sd = &state->sd;
216 v4l2_i2c_subdev_init(sd, client, &wm8775_ops);
217 state->input = 2;
218
219 v4l2_ctrl_handler_init(&state->hdl, 4);
220 state->mute = v4l2_ctrl_new_std(&state->hdl, &wm8775_ctrl_ops,
221 V4L2_CID_AUDIO_MUTE, 0, 1, 1, 0);
222 state->vol = v4l2_ctrl_new_std(&state->hdl, &wm8775_ctrl_ops,
223 V4L2_CID_AUDIO_VOLUME, 0, 65535, (65535+99)/100, 0xCF00); /* 0dB*/
224 state->bal = v4l2_ctrl_new_std(&state->hdl, &wm8775_ctrl_ops,
225 V4L2_CID_AUDIO_BALANCE, 0, 65535, (65535+99)/100, 32768);
226 state->loud = v4l2_ctrl_new_std(&state->hdl, &wm8775_ctrl_ops,
227 V4L2_CID_AUDIO_LOUDNESS, 0, 1, 1, 1);
228 sd->ctrl_handler = &state->hdl;
229 err = state->hdl.error;
230 if (err) {
231 v4l2_ctrl_handler_free(&state->hdl);
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 /* HPF enable, left justified, 24-bit (Philips) 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
248 if (!is_nova_s) {
249 /* ADC gain +2.5dB, enable zero cross */
250 wm8775_write(sd, R14, 0x1d4);
251 /* ADC gain +2.5dB, enable zero cross */
252 wm8775_write(sd, R15, 0x1d4);
253 /* ALC Stereo, ALC target level -1dB FS max gain +8dB */
254 wm8775_write(sd, R16, 0x1bf);
255 /* Enable gain control, use zero cross detection,
256 ALC hold time 42.6 ms */
257 wm8775_write(sd, R17, 0x185);
258 } else {
259 /* ALC stereo, ALC target level -5dB FS, ALC max gain +8dB */
260 wm8775_write(sd, R16, 0x1bb);
261 /* Set ALC mode and hold time */
262 wm8775_write(sd, R17, (state->loud->val ? ALC_EN : 0) | ALC_HOLD);
263 }
264 /* ALC gain ramp up delay 34 s, ALC gain ramp down delay 33 ms */
265 wm8775_write(sd, R18, 0x0a2);
266 /* Enable noise gate, threshold -72dBfs */
267 wm8775_write(sd, R19, 0x005);
268 if (!is_nova_s) {
269 /* Transient window 4ms, lower PGA gain limit -1dB */
270 wm8775_write(sd, R20, 0x07a);
271 /* LRBOTH = 1, use input 2. */
272 wm8775_write(sd, R21, 0x102);
273 } else {
274 /* Transient window 4ms, ALC min gain -5dB */
275 wm8775_write(sd, R20, 0x0fb);
276
277 wm8775_set_audio(sd, 1); /* set volume/mute/mux */
278 }
279 return 0;
280 }
281
wm8775_remove(struct i2c_client * client)282 static void wm8775_remove(struct i2c_client *client)
283 {
284 struct v4l2_subdev *sd = i2c_get_clientdata(client);
285 struct wm8775_state *state = to_state(sd);
286
287 v4l2_device_unregister_subdev(sd);
288 v4l2_ctrl_handler_free(&state->hdl);
289 }
290
291 static const struct i2c_device_id wm8775_id[] = {
292 { "wm8775", 0 },
293 { }
294 };
295 MODULE_DEVICE_TABLE(i2c, wm8775_id);
296
297 static struct i2c_driver wm8775_driver = {
298 .driver = {
299 .name = "wm8775",
300 },
301 .probe = wm8775_probe,
302 .remove = wm8775_remove,
303 .id_table = wm8775_id,
304 };
305
306 module_i2c_driver(wm8775_driver);
307