Commit | Line | Data |
---|---|---|
a10e763b | 1 | // SPDX-License-Identifier: GPL-2.0-only |
17ea88ae | 2 | /* |
c109f816 EA |
3 | * USB Driver for ALi m5602 based webcams |
4 | * | |
0c505e68 | 5 | * Copyright (C) 2008 Erik Andrén |
c109f816 EA |
6 | * Copyright (C) 2007 Ilyes Gouta. Based on the m5603x Linux Driver Project. |
7 | * Copyright (C) 2005 m5603x Linux Driver Project <m5602@x3ng.com.br> | |
8 | * | |
9 | * Portions of code to USB interface and ALi driver software, | |
10 | * Copyright (c) 2006 Willem Duinker | |
11 | * v4l2 interface modeled after the V4L2 driver | |
12 | * for SN9C10x PC Camera Controllers | |
c109f816 EA |
13 | */ |
14 | ||
bdfe91f4 JP |
15 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt |
16 | ||
c109f816 | 17 | #include "m5602_ov9650.h" |
7b826503 | 18 | #include "m5602_ov7660.h" |
c109f816 EA |
19 | #include "m5602_mt9m111.h" |
20 | #include "m5602_po1030.h" | |
21 | #include "m5602_s5k83a.h" | |
22 | #include "m5602_s5k4aa.h" | |
23 | ||
24 | /* Kernel module parameters */ | |
25 | int force_sensor; | |
90ab5ee9 RR |
26 | static bool dump_bridge; |
27 | bool dump_sensor; | |
c109f816 | 28 | |
95c967c1 | 29 | static const struct usb_device_id m5602_table[] = { |
c109f816 EA |
30 | {USB_DEVICE(0x0402, 0x5602)}, |
31 | {} | |
32 | }; | |
33 | ||
34 | MODULE_DEVICE_TABLE(usb, m5602_table); | |
35 | ||
511ebc09 MCC |
36 | /* A skeleton used for sending messages to the sensor */ |
37 | static const unsigned char sensor_urb_skeleton[] = { | |
38 | 0x23, M5602_XB_GPIO_EN_H, 0x81, 0x06, | |
39 | 0x23, M5602_XB_MISC_CTRL, 0x81, 0x80, | |
40 | 0x13, M5602_XB_I2C_DEV_ADDR, 0x81, 0x00, | |
41 | 0x13, M5602_XB_I2C_REG_ADDR, 0x81, 0x00, | |
42 | 0x13, M5602_XB_I2C_DATA, 0x81, 0x00, | |
43 | 0x13, M5602_XB_I2C_CTRL, 0x81, 0x11 | |
44 | }; | |
45 | ||
46 | /* A skeleton used for sending messages to the m5602 bridge */ | |
47 | static const unsigned char bridge_urb_skeleton[] = { | |
48 | 0x13, 0x00, 0x81, 0x00 | |
49 | }; | |
50 | ||
c109f816 | 51 | /* Reads a byte from the m5602 */ |
ff1e6a21 | 52 | int m5602_read_bridge(struct sd *sd, const u8 address, u8 *i2c_data) |
c109f816 EA |
53 | { |
54 | int err; | |
c93396e1 | 55 | struct gspca_dev *gspca_dev = (struct gspca_dev *) sd; |
c109f816 EA |
56 | struct usb_device *udev = sd->gspca_dev.dev; |
57 | __u8 *buf = sd->gspca_dev.usb_buf; | |
58 | ||
59 | err = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0), | |
60 | 0x04, 0xc0, 0x14, | |
61 | 0x8100 + address, buf, | |
62 | 1, M5602_URB_MSG_TIMEOUT); | |
63 | *i2c_data = buf[0]; | |
64 | ||
37d5efb0 JP |
65 | gspca_dbg(gspca_dev, D_CONF, "Reading bridge register 0x%x containing 0x%x\n", |
66 | address, *i2c_data); | |
c109f816 EA |
67 | |
68 | /* usb_control_msg(...) returns the number of bytes sent upon success, | |
bd99ffbd | 69 | mask that and return zero instead*/ |
c109f816 EA |
70 | return (err < 0) ? err : 0; |
71 | } | |
72 | ||
fd589a8f | 73 | /* Writes a byte to the m5602 */ |
ff1e6a21 | 74 | int m5602_write_bridge(struct sd *sd, const u8 address, const u8 i2c_data) |
c109f816 EA |
75 | { |
76 | int err; | |
c93396e1 | 77 | struct gspca_dev *gspca_dev = (struct gspca_dev *) sd; |
c109f816 EA |
78 | struct usb_device *udev = sd->gspca_dev.dev; |
79 | __u8 *buf = sd->gspca_dev.usb_buf; | |
80 | ||
37d5efb0 JP |
81 | gspca_dbg(gspca_dev, D_CONF, "Writing bridge register 0x%x with 0x%x\n", |
82 | address, i2c_data); | |
c109f816 EA |
83 | |
84 | memcpy(buf, bridge_urb_skeleton, | |
85 | sizeof(bridge_urb_skeleton)); | |
86 | buf[1] = address; | |
87 | buf[3] = i2c_data; | |
88 | ||
89 | err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), | |
90 | 0x04, 0x40, 0x19, | |
91 | 0x0000, buf, | |
92 | 4, M5602_URB_MSG_TIMEOUT); | |
93 | ||
94 | /* usb_control_msg(...) returns the number of bytes sent upon success, | |
bd99ffbd | 95 | mask that and return zero instead */ |
c109f816 EA |
96 | return (err < 0) ? err : 0; |
97 | } | |
98 | ||
83955556 | 99 | static int m5602_wait_for_i2c(struct sd *sd) |
ac3d5bfe LK |
100 | { |
101 | int err; | |
102 | u8 data; | |
4c3414ee | 103 | |
ac3d5bfe LK |
104 | do { |
105 | err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, &data); | |
106 | } while ((data & I2C_BUSY) && !err); | |
4c3414ee | 107 | return err; |
ac3d5bfe LK |
108 | } |
109 | ||
e7a7f510 EA |
110 | int m5602_read_sensor(struct sd *sd, const u8 address, |
111 | u8 *i2c_data, const u8 len) | |
112 | { | |
113 | int err, i; | |
c93396e1 | 114 | struct gspca_dev *gspca_dev = (struct gspca_dev *) sd; |
e7a7f510 | 115 | |
edbfbdb3 EA |
116 | if (!len || len > sd->sensor->i2c_regW) |
117 | return -EINVAL; | |
118 | ||
ac3d5bfe | 119 | err = m5602_wait_for_i2c(sd); |
edbfbdb3 | 120 | if (err < 0) |
051781b3 | 121 | return err; |
e7a7f510 EA |
122 | |
123 | err = m5602_write_bridge(sd, M5602_XB_I2C_DEV_ADDR, | |
124 | sd->sensor->i2c_slave_id); | |
125 | if (err < 0) | |
051781b3 | 126 | return err; |
e7a7f510 EA |
127 | |
128 | err = m5602_write_bridge(sd, M5602_XB_I2C_REG_ADDR, address); | |
129 | if (err < 0) | |
051781b3 | 130 | return err; |
e7a7f510 | 131 | |
1b844b53 EA |
132 | /* Sensors with registers that are of only |
133 | one byte width are differently read */ | |
134 | ||
52fa70b7 | 135 | /* FIXME: This works with the ov9650, but has issues with the po1030 */ |
edbfbdb3 | 136 | if (sd->sensor->i2c_regW == 1) { |
52fa70b7 | 137 | err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 1); |
edbfbdb3 | 138 | if (err < 0) |
051781b3 | 139 | return err; |
edbfbdb3 EA |
140 | |
141 | err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 0x08); | |
edbfbdb3 EA |
142 | } else { |
143 | err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 0x18 + len); | |
edbfbdb3 | 144 | } |
e7a7f510 EA |
145 | |
146 | for (i = 0; (i < len) && !err; i++) { | |
ac3d5bfe LK |
147 | err = m5602_wait_for_i2c(sd); |
148 | if (err < 0) | |
149 | return err; | |
150 | ||
e7a7f510 EA |
151 | err = m5602_read_bridge(sd, M5602_XB_I2C_DATA, &(i2c_data[i])); |
152 | ||
37d5efb0 JP |
153 | gspca_dbg(gspca_dev, D_CONF, "Reading sensor register 0x%x containing 0x%x\n", |
154 | address, *i2c_data); | |
e7a7f510 | 155 | } |
e7a7f510 EA |
156 | return err; |
157 | } | |
158 | ||
4b8f3933 EA |
159 | int m5602_write_sensor(struct sd *sd, const u8 address, |
160 | u8 *i2c_data, const u8 len) | |
161 | { | |
162 | int err, i; | |
163 | u8 *p; | |
c93396e1 | 164 | struct gspca_dev *gspca_dev = (struct gspca_dev *) sd; |
4b8f3933 EA |
165 | struct usb_device *udev = sd->gspca_dev.dev; |
166 | __u8 *buf = sd->gspca_dev.usb_buf; | |
167 | ||
168 | /* No sensor with a data width larger than 16 bits has yet been seen */ | |
169 | if (len > sd->sensor->i2c_regW || !len) | |
170 | return -EINVAL; | |
171 | ||
172 | memcpy(buf, sensor_urb_skeleton, | |
173 | sizeof(sensor_urb_skeleton)); | |
174 | ||
175 | buf[11] = sd->sensor->i2c_slave_id; | |
176 | buf[15] = address; | |
177 | ||
178 | /* Special case larger sensor writes */ | |
179 | p = buf + 16; | |
180 | ||
181 | /* Copy a four byte write sequence for each byte to be written to */ | |
182 | for (i = 0; i < len; i++) { | |
183 | memcpy(p, sensor_urb_skeleton + 16, 4); | |
184 | p[3] = i2c_data[i]; | |
185 | p += 4; | |
37d5efb0 JP |
186 | gspca_dbg(gspca_dev, D_CONF, "Writing sensor register 0x%x with 0x%x\n", |
187 | address, i2c_data[i]); | |
4b8f3933 EA |
188 | } |
189 | ||
190 | /* Copy the tailer */ | |
191 | memcpy(p, sensor_urb_skeleton + 20, 4); | |
192 | ||
193 | /* Set the total length */ | |
194 | p[3] = 0x10 + len; | |
195 | ||
196 | err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), | |
197 | 0x04, 0x40, 0x19, | |
198 | 0x0000, buf, | |
199 | 20 + len * 4, M5602_URB_MSG_TIMEOUT); | |
200 | ||
201 | return (err < 0) ? err : 0; | |
202 | } | |
203 | ||
c109f816 EA |
204 | /* Dump all the registers of the m5602 bridge, |
205 | unfortunately this breaks the camera until it's power cycled */ | |
206 | static void m5602_dump_bridge(struct sd *sd) | |
207 | { | |
208 | int i; | |
209 | for (i = 0; i < 0x80; i++) { | |
210 | unsigned char val = 0; | |
211 | m5602_read_bridge(sd, i, &val); | |
bdfe91f4 | 212 | pr_info("ALi m5602 address 0x%x contains 0x%x\n", i, val); |
c109f816 | 213 | } |
bdfe91f4 | 214 | pr_info("Warning: The ALi m5602 webcam probably won't work until it's power cycled\n"); |
c109f816 EA |
215 | } |
216 | ||
e66c6419 | 217 | static int m5602_probe_sensor(struct sd *sd) |
c109f816 EA |
218 | { |
219 | /* Try the po1030 */ | |
220 | sd->sensor = &po1030; | |
d2d7e9ae | 221 | if (!sd->sensor->probe(sd)) |
c109f816 | 222 | return 0; |
c109f816 EA |
223 | |
224 | /* Try the mt9m111 sensor */ | |
225 | sd->sensor = &mt9m111; | |
d2d7e9ae | 226 | if (!sd->sensor->probe(sd)) |
c109f816 | 227 | return 0; |
c109f816 EA |
228 | |
229 | /* Try the s5k4aa */ | |
230 | sd->sensor = &s5k4aa; | |
d2d7e9ae | 231 | if (!sd->sensor->probe(sd)) |
c109f816 | 232 | return 0; |
c109f816 EA |
233 | |
234 | /* Try the ov9650 */ | |
235 | sd->sensor = &ov9650; | |
d2d7e9ae | 236 | if (!sd->sensor->probe(sd)) |
c109f816 | 237 | return 0; |
c109f816 | 238 | |
7b826503 EA |
239 | /* Try the ov7660 */ |
240 | sd->sensor = &ov7660; | |
241 | if (!sd->sensor->probe(sd)) | |
242 | return 0; | |
243 | ||
c109f816 EA |
244 | /* Try the s5k83a */ |
245 | sd->sensor = &s5k83a; | |
d2d7e9ae | 246 | if (!sd->sensor->probe(sd)) |
c109f816 | 247 | return 0; |
1b334599 | 248 | |
c109f816 | 249 | /* More sensor probe function goes here */ |
bdfe91f4 | 250 | pr_info("Failed to find a sensor\n"); |
c109f816 EA |
251 | sd->sensor = NULL; |
252 | return -ENODEV; | |
253 | } | |
254 | ||
e66c6419 JFM |
255 | static int m5602_configure(struct gspca_dev *gspca_dev, |
256 | const struct usb_device_id *id); | |
257 | ||
258 | static int m5602_init(struct gspca_dev *gspca_dev) | |
c109f816 EA |
259 | { |
260 | struct sd *sd = (struct sd *) gspca_dev; | |
261 | int err; | |
262 | ||
37d5efb0 | 263 | gspca_dbg(gspca_dev, D_CONF, "Initializing ALi m5602 webcam\n"); |
c109f816 EA |
264 | /* Run the init sequence */ |
265 | err = sd->sensor->init(sd); | |
266 | ||
267 | return err; | |
268 | } | |
269 | ||
c84e412f HG |
270 | static int m5602_init_controls(struct gspca_dev *gspca_dev) |
271 | { | |
272 | struct sd *sd = (struct sd *) gspca_dev; | |
273 | ||
274 | if (!sd->sensor->init_controls) | |
275 | return 0; | |
276 | ||
277 | return sd->sensor->init_controls(sd); | |
278 | } | |
279 | ||
e66c6419 | 280 | static int m5602_start_transfer(struct gspca_dev *gspca_dev) |
c109f816 EA |
281 | { |
282 | struct sd *sd = (struct sd *) gspca_dev; | |
283 | __u8 *buf = sd->gspca_dev.usb_buf; | |
588dbbb5 | 284 | int err; |
c109f816 EA |
285 | |
286 | /* Send start command to the camera */ | |
287 | const u8 buffer[4] = {0x13, 0xf9, 0x0f, 0x01}; | |
619a4d5c | 288 | |
3da3dce5 EA |
289 | if (sd->sensor->start) |
290 | sd->sensor->start(sd); | |
291 | ||
c109f816 | 292 | memcpy(buf, buffer, sizeof(buffer)); |
588dbbb5 EA |
293 | err = usb_control_msg(gspca_dev->dev, |
294 | usb_sndctrlpipe(gspca_dev->dev, 0), | |
295 | 0x04, 0x40, 0x19, 0x0000, buf, | |
619a4d5c | 296 | sizeof(buffer), M5602_URB_MSG_TIMEOUT); |
c109f816 | 297 | |
37d5efb0 | 298 | gspca_dbg(gspca_dev, D_STREAM, "Transfer started\n"); |
588dbbb5 | 299 | return (err < 0) ? err : 0; |
c109f816 EA |
300 | } |
301 | ||
e66c6419 | 302 | static void m5602_urb_complete(struct gspca_dev *gspca_dev, |
76dd272b | 303 | u8 *data, int len) |
c109f816 EA |
304 | { |
305 | struct sd *sd = (struct sd *) gspca_dev; | |
306 | ||
307 | if (len < 6) { | |
37d5efb0 | 308 | gspca_dbg(gspca_dev, D_PACK, "Packet is less than 6 bytes\n"); |
c109f816 EA |
309 | return; |
310 | } | |
311 | ||
312 | /* Frame delimiter: ff xx xx xx ff ff */ | |
313 | if (data[0] == 0xff && data[4] == 0xff && data[5] == 0xff && | |
314 | data[2] != sd->frame_id) { | |
37d5efb0 | 315 | gspca_dbg(gspca_dev, D_FRAM, "Frame delimiter detected\n"); |
c109f816 EA |
316 | sd->frame_id = data[2]; |
317 | ||
318 | /* Remove the extra fluff appended on each header */ | |
319 | data += 6; | |
320 | len -= 6; | |
321 | ||
322 | /* Complete the last frame (if any) */ | |
76dd272b JFM |
323 | gspca_frame_add(gspca_dev, LAST_PACKET, |
324 | NULL, 0); | |
1b334599 | 325 | sd->frame_count++; |
c109f816 EA |
326 | |
327 | /* Create a new frame */ | |
76dd272b | 328 | gspca_frame_add(gspca_dev, FIRST_PACKET, data, len); |
c109f816 | 329 | |
37d5efb0 JP |
330 | gspca_dbg(gspca_dev, D_FRAM, "Starting new frame %d\n", |
331 | sd->frame_count); | |
c109f816 EA |
332 | |
333 | } else { | |
76dd272b | 334 | int cur_frame_len; |
c109f816 | 335 | |
b192ca98 | 336 | cur_frame_len = gspca_dev->image_len; |
c109f816 EA |
337 | /* Remove urb header */ |
338 | data += 4; | |
339 | len -= 4; | |
340 | ||
1f5965c4 | 341 | if (cur_frame_len + len <= gspca_dev->pixfmt.sizeimage) { |
37d5efb0 JP |
342 | gspca_dbg(gspca_dev, D_FRAM, "Continuing frame %d copying %d bytes\n", |
343 | sd->frame_count, len); | |
c109f816 | 344 | |
76dd272b | 345 | gspca_frame_add(gspca_dev, INTER_PACKET, |
c109f816 | 346 | data, len); |
b192ca98 | 347 | } else { |
c109f816 | 348 | /* Add the remaining data up to frame size */ |
76dd272b | 349 | gspca_frame_add(gspca_dev, INTER_PACKET, data, |
1f5965c4 | 350 | gspca_dev->pixfmt.sizeimage - cur_frame_len); |
c109f816 EA |
351 | } |
352 | } | |
353 | } | |
354 | ||
e66c6419 | 355 | static void m5602_stop_transfer(struct gspca_dev *gspca_dev) |
c109f816 | 356 | { |
4a7581f0 LK |
357 | struct sd *sd = (struct sd *) gspca_dev; |
358 | ||
359 | /* Run the sensor specific end transfer sequence */ | |
360 | if (sd->sensor->stop) | |
361 | sd->sensor->stop(sd); | |
c109f816 EA |
362 | } |
363 | ||
c84e412f HG |
364 | /* sub-driver description */ |
365 | static const struct sd_desc sd_desc = { | |
e66c6419 JFM |
366 | .name = MODULE_NAME, |
367 | .config = m5602_configure, | |
368 | .init = m5602_init, | |
c84e412f | 369 | .init_controls = m5602_init_controls, |
e66c6419 JFM |
370 | .start = m5602_start_transfer, |
371 | .stopN = m5602_stop_transfer, | |
372 | .pkt_scan = m5602_urb_complete | |
373 | }; | |
374 | ||
c109f816 | 375 | /* this function is called at probe time */ |
e66c6419 | 376 | static int m5602_configure(struct gspca_dev *gspca_dev, |
c109f816 EA |
377 | const struct usb_device_id *id) |
378 | { | |
379 | struct sd *sd = (struct sd *) gspca_dev; | |
380 | struct cam *cam; | |
381 | int err; | |
382 | ||
c109f816 | 383 | cam = &gspca_dev->cam; |
c109f816 EA |
384 | |
385 | if (dump_bridge) | |
386 | m5602_dump_bridge(sd); | |
387 | ||
388 | /* Probe sensor */ | |
389 | err = m5602_probe_sensor(sd); | |
390 | if (err) | |
391 | goto fail; | |
392 | ||
c109f816 EA |
393 | return 0; |
394 | ||
395 | fail: | |
52173c5f | 396 | gspca_err(gspca_dev, "ALi m5602 webcam failed\n"); |
c109f816 EA |
397 | cam->cam_mode = NULL; |
398 | cam->nmodes = 0; | |
399 | ||
400 | return err; | |
401 | } | |
402 | ||
403 | static int m5602_probe(struct usb_interface *intf, | |
404 | const struct usb_device_id *id) | |
405 | { | |
406 | return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd), | |
407 | THIS_MODULE); | |
408 | } | |
409 | ||
83955556 | 410 | static void m5602_disconnect(struct usb_interface *intf) |
d9c700d4 EA |
411 | { |
412 | struct gspca_dev *gspca_dev = usb_get_intfdata(intf); | |
413 | struct sd *sd = (struct sd *) gspca_dev; | |
414 | ||
415 | if (sd->sensor->disconnect) | |
416 | sd->sensor->disconnect(sd); | |
417 | ||
418 | gspca_disconnect(intf); | |
419 | } | |
420 | ||
c109f816 EA |
421 | static struct usb_driver sd_driver = { |
422 | .name = MODULE_NAME, | |
423 | .id_table = m5602_table, | |
424 | .probe = m5602_probe, | |
425 | #ifdef CONFIG_PM | |
426 | .suspend = gspca_suspend, | |
427 | .resume = gspca_resume, | |
8bb58964 | 428 | .reset_resume = gspca_resume, |
c109f816 | 429 | #endif |
d9c700d4 | 430 | .disconnect = m5602_disconnect |
c109f816 EA |
431 | }; |
432 | ||
ecb3b2b3 | 433 | module_usb_driver(sd_driver); |
c109f816 EA |
434 | |
435 | MODULE_AUTHOR(DRIVER_AUTHOR); | |
436 | MODULE_DESCRIPTION(DRIVER_DESC); | |
437 | MODULE_LICENSE("GPL"); | |
c109f816 EA |
438 | module_param(force_sensor, int, S_IRUGO | S_IWUSR); |
439 | MODULE_PARM_DESC(force_sensor, | |
1ddc9f75 | 440 | "forces detection of a sensor, 1 = OV9650, 2 = S5K83A, 3 = S5K4AA, 4 = MT9M111, 5 = PO1030, 6 = OV7660"); |
c109f816 EA |
441 | |
442 | module_param(dump_bridge, bool, S_IRUGO | S_IWUSR); | |
443 | MODULE_PARM_DESC(dump_bridge, "Dumps all usb bridge registers at startup"); | |
444 | ||
445 | module_param(dump_sensor, bool, S_IRUGO | S_IWUSR); | |
1ddc9f75 | 446 | MODULE_PARM_DESC(dump_sensor, "Dumps all usb sensor registers at startup providing a sensor is found"); |