xref: /openbmc/linux/drivers/media/i2c/cs5345.c (revision 31b90347)
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-ctrls.h>
28 
29 MODULE_DESCRIPTION("i2c device driver for cs5345 Audio ADC");
30 MODULE_AUTHOR("Hans Verkuil");
31 MODULE_LICENSE("GPL");
32 
33 static bool debug;
34 
35 module_param(debug, bool, 0644);
36 
37 MODULE_PARM_DESC(debug, "Debugging messages, 0=Off (default), 1=On");
38 
39 struct cs5345_state {
40 	struct v4l2_subdev sd;
41 	struct v4l2_ctrl_handler hdl;
42 };
43 
44 static inline struct cs5345_state *to_state(struct v4l2_subdev *sd)
45 {
46 	return container_of(sd, struct cs5345_state, sd);
47 }
48 
49 static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
50 {
51 	return &container_of(ctrl->handler, struct cs5345_state, hdl)->sd;
52 }
53 
54 /* ----------------------------------------------------------------------- */
55 
56 static inline int cs5345_write(struct v4l2_subdev *sd, u8 reg, u8 value)
57 {
58 	struct i2c_client *client = v4l2_get_subdevdata(sd);
59 
60 	return i2c_smbus_write_byte_data(client, reg, value);
61 }
62 
63 static inline int cs5345_read(struct v4l2_subdev *sd, u8 reg)
64 {
65 	struct i2c_client *client = v4l2_get_subdevdata(sd);
66 
67 	return i2c_smbus_read_byte_data(client, reg);
68 }
69 
70 static int cs5345_s_routing(struct v4l2_subdev *sd,
71 			    u32 input, u32 output, u32 config)
72 {
73 	if ((input & 0xf) > 6) {
74 		v4l2_err(sd, "Invalid input %d.\n", input);
75 		return -EINVAL;
76 	}
77 	cs5345_write(sd, 0x09, input & 0xf);
78 	cs5345_write(sd, 0x05, input & 0xf0);
79 	return 0;
80 }
81 
82 static int cs5345_s_ctrl(struct v4l2_ctrl *ctrl)
83 {
84 	struct v4l2_subdev *sd = to_sd(ctrl);
85 
86 	switch (ctrl->id) {
87 	case V4L2_CID_AUDIO_MUTE:
88 		cs5345_write(sd, 0x04, ctrl->val ? 0x80 : 0);
89 		return 0;
90 	case V4L2_CID_AUDIO_VOLUME:
91 		cs5345_write(sd, 0x07, ((u8)ctrl->val) & 0x3f);
92 		cs5345_write(sd, 0x08, ((u8)ctrl->val) & 0x3f);
93 		return 0;
94 	}
95 	return -EINVAL;
96 }
97 
98 #ifdef CONFIG_VIDEO_ADV_DEBUG
99 static int cs5345_g_register(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg)
100 {
101 	reg->size = 1;
102 	reg->val = cs5345_read(sd, reg->reg & 0x1f);
103 	return 0;
104 }
105 
106 static int cs5345_s_register(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg)
107 {
108 	cs5345_write(sd, reg->reg & 0x1f, reg->val & 0xff);
109 	return 0;
110 }
111 #endif
112 
113 static int cs5345_log_status(struct v4l2_subdev *sd)
114 {
115 	u8 v = cs5345_read(sd, 0x09) & 7;
116 	u8 m = cs5345_read(sd, 0x04);
117 	int vol = cs5345_read(sd, 0x08) & 0x3f;
118 
119 	v4l2_info(sd, "Input:  %d%s\n", v,
120 			(m & 0x80) ? " (muted)" : "");
121 	if (vol >= 32)
122 		vol = vol - 64;
123 	v4l2_info(sd, "Volume: %d dB\n", vol);
124 	return 0;
125 }
126 
127 /* ----------------------------------------------------------------------- */
128 
129 static const struct v4l2_ctrl_ops cs5345_ctrl_ops = {
130 	.s_ctrl = cs5345_s_ctrl,
131 };
132 
133 static const struct v4l2_subdev_core_ops cs5345_core_ops = {
134 	.log_status = cs5345_log_status,
135 	.g_ext_ctrls = v4l2_subdev_g_ext_ctrls,
136 	.try_ext_ctrls = v4l2_subdev_try_ext_ctrls,
137 	.s_ext_ctrls = v4l2_subdev_s_ext_ctrls,
138 	.g_ctrl = v4l2_subdev_g_ctrl,
139 	.s_ctrl = v4l2_subdev_s_ctrl,
140 	.queryctrl = v4l2_subdev_queryctrl,
141 	.querymenu = v4l2_subdev_querymenu,
142 #ifdef CONFIG_VIDEO_ADV_DEBUG
143 	.g_register = cs5345_g_register,
144 	.s_register = cs5345_s_register,
145 #endif
146 };
147 
148 static const struct v4l2_subdev_audio_ops cs5345_audio_ops = {
149 	.s_routing = cs5345_s_routing,
150 };
151 
152 static const struct v4l2_subdev_ops cs5345_ops = {
153 	.core = &cs5345_core_ops,
154 	.audio = &cs5345_audio_ops,
155 };
156 
157 /* ----------------------------------------------------------------------- */
158 
159 static int cs5345_probe(struct i2c_client *client,
160 			const struct i2c_device_id *id)
161 {
162 	struct cs5345_state *state;
163 	struct v4l2_subdev *sd;
164 
165 	/* Check if the adapter supports the needed features */
166 	if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
167 		return -EIO;
168 
169 	v4l_info(client, "chip found @ 0x%x (%s)\n",
170 			client->addr << 1, client->adapter->name);
171 
172 	state = devm_kzalloc(&client->dev, sizeof(*state), GFP_KERNEL);
173 	if (state == NULL)
174 		return -ENOMEM;
175 	sd = &state->sd;
176 	v4l2_i2c_subdev_init(sd, client, &cs5345_ops);
177 
178 	v4l2_ctrl_handler_init(&state->hdl, 2);
179 	v4l2_ctrl_new_std(&state->hdl, &cs5345_ctrl_ops,
180 			V4L2_CID_AUDIO_MUTE, 0, 1, 1, 0);
181 	v4l2_ctrl_new_std(&state->hdl, &cs5345_ctrl_ops,
182 			V4L2_CID_AUDIO_VOLUME, -24, 24, 1, 0);
183 	sd->ctrl_handler = &state->hdl;
184 	if (state->hdl.error) {
185 		int err = state->hdl.error;
186 
187 		v4l2_ctrl_handler_free(&state->hdl);
188 		return err;
189 	}
190 	/* set volume/mute */
191 	v4l2_ctrl_handler_setup(&state->hdl);
192 
193 	cs5345_write(sd, 0x02, 0x00);
194 	cs5345_write(sd, 0x04, 0x01);
195 	cs5345_write(sd, 0x09, 0x01);
196 	return 0;
197 }
198 
199 /* ----------------------------------------------------------------------- */
200 
201 static int cs5345_remove(struct i2c_client *client)
202 {
203 	struct v4l2_subdev *sd = i2c_get_clientdata(client);
204 	struct cs5345_state *state = to_state(sd);
205 
206 	v4l2_device_unregister_subdev(sd);
207 	v4l2_ctrl_handler_free(&state->hdl);
208 	return 0;
209 }
210 
211 /* ----------------------------------------------------------------------- */
212 
213 static const struct i2c_device_id cs5345_id[] = {
214 	{ "cs5345", 0 },
215 	{ }
216 };
217 MODULE_DEVICE_TABLE(i2c, cs5345_id);
218 
219 static struct i2c_driver cs5345_driver = {
220 	.driver = {
221 		.owner	= THIS_MODULE,
222 		.name	= "cs5345",
223 	},
224 	.probe		= cs5345_probe,
225 	.remove		= cs5345_remove,
226 	.id_table	= cs5345_id,
227 };
228 
229 module_i2c_driver(cs5345_driver);
230