treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 157
[sfrench/cifs-2.6.git] / drivers / media / i2c / cs53l32a.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * cs53l32a (Adaptec AVC-2010 and AVC-2410) i2c ivtv driver.
4  * Copyright (C) 2005  Martin Vaughan
5  *
6  * Audio source switching for Adaptec AVC-2410 added by Trev Jackson
7  */
8
9
10 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/slab.h>
13 #include <linux/ioctl.h>
14 #include <linux/uaccess.h>
15 #include <linux/i2c.h>
16 #include <linux/videodev2.h>
17 #include <media/v4l2-device.h>
18 #include <media/v4l2-ctrls.h>
19
20 MODULE_DESCRIPTION("i2c device driver for cs53l32a Audio ADC");
21 MODULE_AUTHOR("Martin Vaughan");
22 MODULE_LICENSE("GPL");
23
24 static bool debug;
25
26 module_param(debug, bool, 0644);
27
28 MODULE_PARM_DESC(debug, "Debugging messages, 0=Off (default), 1=On");
29
30
31 struct cs53l32a_state {
32         struct v4l2_subdev sd;
33         struct v4l2_ctrl_handler hdl;
34 };
35
36 static inline struct cs53l32a_state *to_state(struct v4l2_subdev *sd)
37 {
38         return container_of(sd, struct cs53l32a_state, sd);
39 }
40
41 static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
42 {
43         return &container_of(ctrl->handler, struct cs53l32a_state, hdl)->sd;
44 }
45
46 /* ----------------------------------------------------------------------- */
47
48 static int cs53l32a_write(struct v4l2_subdev *sd, u8 reg, u8 value)
49 {
50         struct i2c_client *client = v4l2_get_subdevdata(sd);
51
52         return i2c_smbus_write_byte_data(client, reg, value);
53 }
54
55 static int cs53l32a_read(struct v4l2_subdev *sd, u8 reg)
56 {
57         struct i2c_client *client = v4l2_get_subdevdata(sd);
58
59         return i2c_smbus_read_byte_data(client, reg);
60 }
61
62 static int cs53l32a_s_routing(struct v4l2_subdev *sd,
63                               u32 input, u32 output, u32 config)
64 {
65         /* There are 2 physical inputs, but the second input can be
66            placed in two modes, the first mode bypasses the PGA (gain),
67            the second goes through the PGA. Hence there are three
68            possible inputs to choose from. */
69         if (input > 2) {
70                 v4l2_err(sd, "Invalid input %d.\n", input);
71                 return -EINVAL;
72         }
73         cs53l32a_write(sd, 0x01, 0x01 + (input << 4));
74         return 0;
75 }
76
77 static int cs53l32a_s_ctrl(struct v4l2_ctrl *ctrl)
78 {
79         struct v4l2_subdev *sd = to_sd(ctrl);
80
81         switch (ctrl->id) {
82         case V4L2_CID_AUDIO_MUTE:
83                 cs53l32a_write(sd, 0x03, ctrl->val ? 0xf0 : 0x30);
84                 return 0;
85         case V4L2_CID_AUDIO_VOLUME:
86                 cs53l32a_write(sd, 0x04, (u8)ctrl->val);
87                 cs53l32a_write(sd, 0x05, (u8)ctrl->val);
88                 return 0;
89         }
90         return -EINVAL;
91 }
92
93 static int cs53l32a_log_status(struct v4l2_subdev *sd)
94 {
95         struct cs53l32a_state *state = to_state(sd);
96         u8 v = cs53l32a_read(sd, 0x01);
97
98         v4l2_info(sd, "Input:  %d\n", (v >> 4) & 3);
99         v4l2_ctrl_handler_log_status(&state->hdl, sd->name);
100         return 0;
101 }
102
103 /* ----------------------------------------------------------------------- */
104
105 static const struct v4l2_ctrl_ops cs53l32a_ctrl_ops = {
106         .s_ctrl = cs53l32a_s_ctrl,
107 };
108
109 static const struct v4l2_subdev_core_ops cs53l32a_core_ops = {
110         .log_status = cs53l32a_log_status,
111 };
112
113 static const struct v4l2_subdev_audio_ops cs53l32a_audio_ops = {
114         .s_routing = cs53l32a_s_routing,
115 };
116
117 static const struct v4l2_subdev_ops cs53l32a_ops = {
118         .core = &cs53l32a_core_ops,
119         .audio = &cs53l32a_audio_ops,
120 };
121
122 /* ----------------------------------------------------------------------- */
123
124 /* i2c implementation */
125
126 /*
127  * Generic i2c probe
128  * concerning the addresses: i2c wants 7 bit (without the r/w bit), so '>>1'
129  */
130
131 static int cs53l32a_probe(struct i2c_client *client,
132                           const struct i2c_device_id *id)
133 {
134         struct cs53l32a_state *state;
135         struct v4l2_subdev *sd;
136         int i;
137
138         /* Check if the adapter supports the needed features */
139         if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
140                 return -EIO;
141
142         if (!id)
143                 strscpy(client->name, "cs53l32a", sizeof(client->name));
144
145         v4l_info(client, "chip found @ 0x%x (%s)\n",
146                         client->addr << 1, client->adapter->name);
147
148         state = devm_kzalloc(&client->dev, sizeof(*state), GFP_KERNEL);
149         if (state == NULL)
150                 return -ENOMEM;
151         sd = &state->sd;
152         v4l2_i2c_subdev_init(sd, client, &cs53l32a_ops);
153
154         for (i = 1; i <= 7; i++) {
155                 u8 v = cs53l32a_read(sd, i);
156
157                 v4l2_dbg(1, debug, sd, "Read Reg %d %02x\n", i, v);
158         }
159
160         v4l2_ctrl_handler_init(&state->hdl, 2);
161         v4l2_ctrl_new_std(&state->hdl, &cs53l32a_ctrl_ops,
162                         V4L2_CID_AUDIO_VOLUME, -96, 12, 1, 0);
163         v4l2_ctrl_new_std(&state->hdl, &cs53l32a_ctrl_ops,
164                         V4L2_CID_AUDIO_MUTE, 0, 1, 1, 0);
165         sd->ctrl_handler = &state->hdl;
166         if (state->hdl.error) {
167                 int err = state->hdl.error;
168
169                 v4l2_ctrl_handler_free(&state->hdl);
170                 return err;
171         }
172
173         /* Set cs53l32a internal register for Adaptec 2010/2410 setup */
174
175         cs53l32a_write(sd, 0x01, 0x21);
176         cs53l32a_write(sd, 0x02, 0x29);
177         cs53l32a_write(sd, 0x03, 0x30);
178         cs53l32a_write(sd, 0x04, 0x00);
179         cs53l32a_write(sd, 0x05, 0x00);
180         cs53l32a_write(sd, 0x06, 0x00);
181         cs53l32a_write(sd, 0x07, 0x00);
182
183         /* Display results, should be 0x21,0x29,0x30,0x00,0x00,0x00,0x00 */
184
185         for (i = 1; i <= 7; i++) {
186                 u8 v = cs53l32a_read(sd, i);
187
188                 v4l2_dbg(1, debug, sd, "Read Reg %d %02x\n", i, v);
189         }
190         return 0;
191 }
192
193 static int cs53l32a_remove(struct i2c_client *client)
194 {
195         struct v4l2_subdev *sd = i2c_get_clientdata(client);
196         struct cs53l32a_state *state = to_state(sd);
197
198         v4l2_device_unregister_subdev(sd);
199         v4l2_ctrl_handler_free(&state->hdl);
200         return 0;
201 }
202
203 static const struct i2c_device_id cs53l32a_id[] = {
204         { "cs53l32a", 0 },
205         { }
206 };
207 MODULE_DEVICE_TABLE(i2c, cs53l32a_id);
208
209 static struct i2c_driver cs53l32a_driver = {
210         .driver = {
211                 .name   = "cs53l32a",
212         },
213         .probe          = cs53l32a_probe,
214         .remove         = cs53l32a_remove,
215         .id_table       = cs53l32a_id,
216 };
217
218 module_i2c_driver(cs53l32a_driver);