2 * USB Driver for ALi m5602 based webcams
4 * Copyright (C) 2008 Erik Andrén
5 * Copyright (C) 2007 Ilyes Gouta. Based on the m5603x Linux Driver Project.
6 * Copyright (C) 2005 m5603x Linux Driver Project <m5602@x3ng.com.br>
8 * Portions of code to USB interface and ALi driver software,
9 * Copyright (c) 2006 Willem Duinker
10 * v4l2 interface modeled after the V4L2 driver
11 * for SN9C10x PC Camera Controllers
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License as
15 * published by the Free Software Foundation, version 2.
19 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21 #include "m5602_ov9650.h"
22 #include "m5602_ov7660.h"
23 #include "m5602_mt9m111.h"
24 #include "m5602_po1030.h"
25 #include "m5602_s5k83a.h"
26 #include "m5602_s5k4aa.h"
28 /* Kernel module parameters */
30 static bool dump_bridge;
33 static const struct usb_device_id m5602_table[] = {
34 {USB_DEVICE(0x0402, 0x5602)},
38 MODULE_DEVICE_TABLE(usb, m5602_table);
40 /* Reads a byte from the m5602 */
41 int m5602_read_bridge(struct sd *sd, const u8 address, u8 *i2c_data)
44 struct usb_device *udev = sd->gspca_dev.dev;
45 __u8 *buf = sd->gspca_dev.usb_buf;
47 err = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
49 0x8100 + address, buf,
50 1, M5602_URB_MSG_TIMEOUT);
53 PDEBUG(D_CONF, "Reading bridge register 0x%x containing 0x%x",
56 /* usb_control_msg(...) returns the number of bytes sent upon success,
57 mask that and return zero instead*/
58 return (err < 0) ? err : 0;
61 /* Writes a byte to the m5602 */
62 int m5602_write_bridge(struct sd *sd, const u8 address, const u8 i2c_data)
65 struct usb_device *udev = sd->gspca_dev.dev;
66 __u8 *buf = sd->gspca_dev.usb_buf;
68 PDEBUG(D_CONF, "Writing bridge register 0x%x with 0x%x",
71 memcpy(buf, bridge_urb_skeleton,
72 sizeof(bridge_urb_skeleton));
76 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
79 4, M5602_URB_MSG_TIMEOUT);
81 /* usb_control_msg(...) returns the number of bytes sent upon success,
82 mask that and return zero instead */
83 return (err < 0) ? err : 0;
86 static int m5602_wait_for_i2c(struct sd *sd)
92 err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, &data);
93 } while ((data & I2C_BUSY) && !err);
97 int m5602_read_sensor(struct sd *sd, const u8 address,
98 u8 *i2c_data, const u8 len)
102 if (!len || len > sd->sensor->i2c_regW)
105 err = m5602_wait_for_i2c(sd);
109 err = m5602_write_bridge(sd, M5602_XB_I2C_DEV_ADDR,
110 sd->sensor->i2c_slave_id);
114 err = m5602_write_bridge(sd, M5602_XB_I2C_REG_ADDR, address);
118 /* Sensors with registers that are of only
119 one byte width are differently read */
121 /* FIXME: This works with the ov9650, but has issues with the po1030 */
122 if (sd->sensor->i2c_regW == 1) {
123 err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 1);
127 err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 0x08);
129 err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 0x18 + len);
132 for (i = 0; (i < len) && !err; i++) {
133 err = m5602_wait_for_i2c(sd);
137 err = m5602_read_bridge(sd, M5602_XB_I2C_DATA, &(i2c_data[i]));
139 PDEBUG(D_CONF, "Reading sensor register "
140 "0x%x containing 0x%x ", address, *i2c_data);
145 int m5602_write_sensor(struct sd *sd, const u8 address,
146 u8 *i2c_data, const u8 len)
150 struct usb_device *udev = sd->gspca_dev.dev;
151 __u8 *buf = sd->gspca_dev.usb_buf;
153 /* No sensor with a data width larger than 16 bits has yet been seen */
154 if (len > sd->sensor->i2c_regW || !len)
157 memcpy(buf, sensor_urb_skeleton,
158 sizeof(sensor_urb_skeleton));
160 buf[11] = sd->sensor->i2c_slave_id;
163 /* Special case larger sensor writes */
166 /* Copy a four byte write sequence for each byte to be written to */
167 for (i = 0; i < len; i++) {
168 memcpy(p, sensor_urb_skeleton + 16, 4);
171 PDEBUG(D_CONF, "Writing sensor register 0x%x with 0x%x",
172 address, i2c_data[i]);
175 /* Copy the tailer */
176 memcpy(p, sensor_urb_skeleton + 20, 4);
178 /* Set the total length */
181 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
184 20 + len * 4, M5602_URB_MSG_TIMEOUT);
186 return (err < 0) ? err : 0;
189 /* Dump all the registers of the m5602 bridge,
190 unfortunately this breaks the camera until it's power cycled */
191 static void m5602_dump_bridge(struct sd *sd)
194 for (i = 0; i < 0x80; i++) {
195 unsigned char val = 0;
196 m5602_read_bridge(sd, i, &val);
197 pr_info("ALi m5602 address 0x%x contains 0x%x\n", i, val);
199 pr_info("Warning: The ALi m5602 webcam probably won't work until it's power cycled\n");
202 static int m5602_probe_sensor(struct sd *sd)
205 sd->sensor = &po1030;
206 if (!sd->sensor->probe(sd))
209 /* Try the mt9m111 sensor */
210 sd->sensor = &mt9m111;
211 if (!sd->sensor->probe(sd))
215 sd->sensor = &s5k4aa;
216 if (!sd->sensor->probe(sd))
220 sd->sensor = &ov9650;
221 if (!sd->sensor->probe(sd))
225 sd->sensor = &ov7660;
226 if (!sd->sensor->probe(sd))
230 sd->sensor = &s5k83a;
231 if (!sd->sensor->probe(sd))
234 /* More sensor probe function goes here */
235 pr_info("Failed to find a sensor\n");
240 static int m5602_configure(struct gspca_dev *gspca_dev,
241 const struct usb_device_id *id);
243 static int m5602_init(struct gspca_dev *gspca_dev)
245 struct sd *sd = (struct sd *) gspca_dev;
248 PDEBUG(D_CONF, "Initializing ALi m5602 webcam");
249 /* Run the init sequence */
250 err = sd->sensor->init(sd);
255 static int m5602_start_transfer(struct gspca_dev *gspca_dev)
257 struct sd *sd = (struct sd *) gspca_dev;
258 __u8 *buf = sd->gspca_dev.usb_buf;
261 /* Send start command to the camera */
262 const u8 buffer[4] = {0x13, 0xf9, 0x0f, 0x01};
264 if (sd->sensor->start)
265 sd->sensor->start(sd);
267 memcpy(buf, buffer, sizeof(buffer));
268 err = usb_control_msg(gspca_dev->dev,
269 usb_sndctrlpipe(gspca_dev->dev, 0),
270 0x04, 0x40, 0x19, 0x0000, buf,
271 sizeof(buffer), M5602_URB_MSG_TIMEOUT);
273 PDEBUG(D_STREAM, "Transfer started");
274 return (err < 0) ? err : 0;
277 static void m5602_urb_complete(struct gspca_dev *gspca_dev,
280 struct sd *sd = (struct sd *) gspca_dev;
283 PDEBUG(D_PACK, "Packet is less than 6 bytes");
287 /* Frame delimiter: ff xx xx xx ff ff */
288 if (data[0] == 0xff && data[4] == 0xff && data[5] == 0xff &&
289 data[2] != sd->frame_id) {
290 PDEBUG(D_FRAM, "Frame delimiter detected");
291 sd->frame_id = data[2];
293 /* Remove the extra fluff appended on each header */
297 /* Complete the last frame (if any) */
298 gspca_frame_add(gspca_dev, LAST_PACKET,
302 /* Create a new frame */
303 gspca_frame_add(gspca_dev, FIRST_PACKET, data, len);
305 PDEBUG(D_FRAM, "Starting new frame %d",
311 cur_frame_len = gspca_dev->image_len;
312 /* Remove urb header */
316 if (cur_frame_len + len <= gspca_dev->frsz) {
317 PDEBUG(D_FRAM, "Continuing frame %d copying %d bytes",
318 sd->frame_count, len);
320 gspca_frame_add(gspca_dev, INTER_PACKET,
323 /* Add the remaining data up to frame size */
324 gspca_frame_add(gspca_dev, INTER_PACKET, data,
325 gspca_dev->frsz - cur_frame_len);
330 static void m5602_stop_transfer(struct gspca_dev *gspca_dev)
332 struct sd *sd = (struct sd *) gspca_dev;
334 /* Run the sensor specific end transfer sequence */
335 if (sd->sensor->stop)
336 sd->sensor->stop(sd);
339 /* sub-driver description, the ctrl and nctrl is filled at probe time */
340 static struct sd_desc sd_desc = {
342 .config = m5602_configure,
344 .start = m5602_start_transfer,
345 .stopN = m5602_stop_transfer,
346 .pkt_scan = m5602_urb_complete
349 /* this function is called at probe time */
350 static int m5602_configure(struct gspca_dev *gspca_dev,
351 const struct usb_device_id *id)
353 struct sd *sd = (struct sd *) gspca_dev;
357 cam = &gspca_dev->cam;
361 m5602_dump_bridge(sd);
364 err = m5602_probe_sensor(sd);
371 PDEBUG(D_ERR, "ALi m5602 webcam failed");
372 cam->cam_mode = NULL;
378 static int m5602_probe(struct usb_interface *intf,
379 const struct usb_device_id *id)
381 return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
385 static void m5602_disconnect(struct usb_interface *intf)
387 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
388 struct sd *sd = (struct sd *) gspca_dev;
390 if (sd->sensor->disconnect)
391 sd->sensor->disconnect(sd);
393 gspca_disconnect(intf);
396 static struct usb_driver sd_driver = {
398 .id_table = m5602_table,
399 .probe = m5602_probe,
401 .suspend = gspca_suspend,
402 .resume = gspca_resume,
403 .reset_resume = gspca_resume,
405 .disconnect = m5602_disconnect
408 module_usb_driver(sd_driver);
410 MODULE_AUTHOR(DRIVER_AUTHOR);
411 MODULE_DESCRIPTION(DRIVER_DESC);
412 MODULE_LICENSE("GPL");
413 module_param(force_sensor, int, S_IRUGO | S_IWUSR);
414 MODULE_PARM_DESC(force_sensor,
415 "forces detection of a sensor, "
416 "1 = OV9650, 2 = S5K83A, 3 = S5K4AA, "
417 "4 = MT9M111, 5 = PO1030, 6 = OV7660");
419 module_param(dump_bridge, bool, S_IRUGO | S_IWUSR);
420 MODULE_PARM_DESC(dump_bridge, "Dumps all usb bridge registers at startup");
422 module_param(dump_sensor, bool, S_IRUGO | S_IWUSR);
423 MODULE_PARM_DESC(dump_sensor, "Dumps all usb sensor registers "
424 "at startup providing a sensor is found");