xref: /openbmc/linux/drivers/media/i2c/cs5345.c (revision 8fdff1dc)
1 /*
2  * cs5345 Cirrus Logic 24-bit, 192 kHz Stereo Audio ADC
3  * Copyright (C) 2007 Hans Verkuil
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  */
19 
20 
21 #include <linux/module.h>
22 #include <linux/kernel.h>
23 #include <linux/i2c.h>
24 #include <linux/videodev2.h>
25 #include <linux/slab.h>
26 #include <media/v4l2-device.h>
27 #include <media/v4l2-chip-ident.h>
28 #include <media/v4l2-ctrls.h>
29 
30 MODULE_DESCRIPTION("i2c device driver for cs5345 Audio ADC");
31 MODULE_AUTHOR("Hans Verkuil");
32 MODULE_LICENSE("GPL");
33 
34 static bool debug;
35 
36 module_param(debug, bool, 0644);
37 
38 MODULE_PARM_DESC(debug, "Debugging messages, 0=Off (default), 1=On");
39 
40 struct cs5345_state {
41 	struct v4l2_subdev sd;
42 	struct v4l2_ctrl_handler hdl;
43 };
44 
45 static inline struct cs5345_state *to_state(struct v4l2_subdev *sd)
46 {
47 	return container_of(sd, struct cs5345_state, sd);
48 }
49 
50 static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
51 {
52 	return &container_of(ctrl->handler, struct cs5345_state, hdl)->sd;
53 }
54 
55 /* ----------------------------------------------------------------------- */
56 
57 static inline int cs5345_write(struct v4l2_subdev *sd, u8 reg, u8 value)
58 {
59 	struct i2c_client *client = v4l2_get_subdevdata(sd);
60 
61 	return i2c_smbus_write_byte_data(client, reg, value);
62 }
63 
64 static inline int cs5345_read(struct v4l2_subdev *sd, u8 reg)
65 {
66 	struct i2c_client *client = v4l2_get_subdevdata(sd);
67 
68 	return i2c_smbus_read_byte_data(client, reg);
69 }
70 
71 static int cs5345_s_routing(struct v4l2_subdev *sd,
72 			    u32 input, u32 output, u32 config)
73 {
74 	if ((input & 0xf) > 6) {
75 		v4l2_err(sd, "Invalid input %d.\n", input);
76 		return -EINVAL;
77 	}
78 	cs5345_write(sd, 0x09, input & 0xf);
79 	cs5345_write(sd, 0x05, input & 0xf0);
80 	return 0;
81 }
82 
83 static int cs5345_s_ctrl(struct v4l2_ctrl *ctrl)
84 {
85 	struct v4l2_subdev *sd = to_sd(ctrl);
86 
87 	switch (ctrl->id) {
88 	case V4L2_CID_AUDIO_MUTE:
89 		cs5345_write(sd, 0x04, ctrl->val ? 0x80 : 0);
90 		return 0;
91 	case V4L2_CID_AUDIO_VOLUME:
92 		cs5345_write(sd, 0x07, ((u8)ctrl->val) & 0x3f);
93 		cs5345_write(sd, 0x08, ((u8)ctrl->val) & 0x3f);
94 		return 0;
95 	}
96 	return -EINVAL;
97 }
98 
99 #ifdef CONFIG_VIDEO_ADV_DEBUG
100 static int cs5345_g_register(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg)
101 {
102 	struct i2c_client *client = v4l2_get_subdevdata(sd);
103 
104 	if (!v4l2_chip_match_i2c_client(client, &reg->match))
105 		return -EINVAL;
106 	if (!capable(CAP_SYS_ADMIN))
107 		return -EPERM;
108 	reg->size = 1;
109 	reg->val = cs5345_read(sd, reg->reg & 0x1f);
110 	return 0;
111 }
112 
113 static int cs5345_s_register(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg)
114 {
115 	struct i2c_client *client = v4l2_get_subdevdata(sd);
116 
117 	if (!v4l2_chip_match_i2c_client(client, &reg->match))
118 		return -EINVAL;
119 	if (!capable(CAP_SYS_ADMIN))
120 		return -EPERM;
121 	cs5345_write(sd, reg->reg & 0x1f, reg->val & 0xff);
122 	return 0;
123 }
124 #endif
125 
126 static int cs5345_g_chip_ident(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip)
127 {
128 	struct i2c_client *client = v4l2_get_subdevdata(sd);
129 
130 	return v4l2_chip_ident_i2c_client(client, chip, V4L2_IDENT_CS5345, 0);
131 }
132 
133 static int cs5345_log_status(struct v4l2_subdev *sd)
134 {
135 	u8 v = cs5345_read(sd, 0x09) & 7;
136 	u8 m = cs5345_read(sd, 0x04);
137 	int vol = cs5345_read(sd, 0x08) & 0x3f;
138 
139 	v4l2_info(sd, "Input:  %d%s\n", v,
140 			(m & 0x80) ? " (muted)" : "");
141 	if (vol >= 32)
142 		vol = vol - 64;
143 	v4l2_info(sd, "Volume: %d dB\n", vol);
144 	return 0;
145 }
146 
147 /* ----------------------------------------------------------------------- */
148 
149 static const struct v4l2_ctrl_ops cs5345_ctrl_ops = {
150 	.s_ctrl = cs5345_s_ctrl,
151 };
152 
153 static const struct v4l2_subdev_core_ops cs5345_core_ops = {
154 	.log_status = cs5345_log_status,
155 	.g_chip_ident = cs5345_g_chip_ident,
156 	.g_ext_ctrls = v4l2_subdev_g_ext_ctrls,
157 	.try_ext_ctrls = v4l2_subdev_try_ext_ctrls,
158 	.s_ext_ctrls = v4l2_subdev_s_ext_ctrls,
159 	.g_ctrl = v4l2_subdev_g_ctrl,
160 	.s_ctrl = v4l2_subdev_s_ctrl,
161 	.queryctrl = v4l2_subdev_queryctrl,
162 	.querymenu = v4l2_subdev_querymenu,
163 #ifdef CONFIG_VIDEO_ADV_DEBUG
164 	.g_register = cs5345_g_register,
165 	.s_register = cs5345_s_register,
166 #endif
167 };
168 
169 static const struct v4l2_subdev_audio_ops cs5345_audio_ops = {
170 	.s_routing = cs5345_s_routing,
171 };
172 
173 static const struct v4l2_subdev_ops cs5345_ops = {
174 	.core = &cs5345_core_ops,
175 	.audio = &cs5345_audio_ops,
176 };
177 
178 /* ----------------------------------------------------------------------- */
179 
180 static int cs5345_probe(struct i2c_client *client,
181 			const struct i2c_device_id *id)
182 {
183 	struct cs5345_state *state;
184 	struct v4l2_subdev *sd;
185 
186 	/* Check if the adapter supports the needed features */
187 	if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
188 		return -EIO;
189 
190 	v4l_info(client, "chip found @ 0x%x (%s)\n",
191 			client->addr << 1, client->adapter->name);
192 
193 	state = kzalloc(sizeof(struct cs5345_state), GFP_KERNEL);
194 	if (state == NULL)
195 		return -ENOMEM;
196 	sd = &state->sd;
197 	v4l2_i2c_subdev_init(sd, client, &cs5345_ops);
198 
199 	v4l2_ctrl_handler_init(&state->hdl, 2);
200 	v4l2_ctrl_new_std(&state->hdl, &cs5345_ctrl_ops,
201 			V4L2_CID_AUDIO_MUTE, 0, 1, 1, 0);
202 	v4l2_ctrl_new_std(&state->hdl, &cs5345_ctrl_ops,
203 			V4L2_CID_AUDIO_VOLUME, -24, 24, 1, 0);
204 	sd->ctrl_handler = &state->hdl;
205 	if (state->hdl.error) {
206 		int err = state->hdl.error;
207 
208 		v4l2_ctrl_handler_free(&state->hdl);
209 		kfree(state);
210 		return err;
211 	}
212 	/* set volume/mute */
213 	v4l2_ctrl_handler_setup(&state->hdl);
214 
215 	cs5345_write(sd, 0x02, 0x00);
216 	cs5345_write(sd, 0x04, 0x01);
217 	cs5345_write(sd, 0x09, 0x01);
218 	return 0;
219 }
220 
221 /* ----------------------------------------------------------------------- */
222 
223 static int cs5345_remove(struct i2c_client *client)
224 {
225 	struct v4l2_subdev *sd = i2c_get_clientdata(client);
226 	struct cs5345_state *state = to_state(sd);
227 
228 	v4l2_device_unregister_subdev(sd);
229 	v4l2_ctrl_handler_free(&state->hdl);
230 	kfree(state);
231 	return 0;
232 }
233 
234 /* ----------------------------------------------------------------------- */
235 
236 static const struct i2c_device_id cs5345_id[] = {
237 	{ "cs5345", 0 },
238 	{ }
239 };
240 MODULE_DEVICE_TABLE(i2c, cs5345_id);
241 
242 static struct i2c_driver cs5345_driver = {
243 	.driver = {
244 		.owner	= THIS_MODULE,
245 		.name	= "cs5345",
246 	},
247 	.probe		= cs5345_probe,
248 	.remove		= cs5345_remove,
249 	.id_table	= cs5345_id,
250 };
251 
252 module_i2c_driver(cs5345_driver);
253