2 * USB Driver for ALi m5602 based webcams
4 * Copyright (C) 2008 Erik Andren
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 #include "m5602_ov9650.h"
20 #include "m5602_mt9m111.h"
21 #include "m5602_po1030.h"
22 #include "m5602_s5k83a.h"
23 #include "m5602_s5k4aa.h"
25 /* Kernel module parameters */
29 unsigned int m5602_debug;
31 static const __devinitdata struct usb_device_id m5602_table[] = {
32 {USB_DEVICE(0x0402, 0x5602)},
36 MODULE_DEVICE_TABLE(usb, m5602_table);
38 /* sub-driver description, the ctrl and nctrl is filled at probe time */
39 static struct sd_desc sd_desc = {
41 .config = m5602_configure,
43 .start = m5602_start_transfer,
44 .stopN = m5602_stop_transfer,
45 .pkt_scan = m5602_urb_complete
48 /* Reads a byte from the m5602 */
49 int m5602_read_bridge(struct sd *sd, u8 address, u8 *i2c_data)
52 struct usb_device *udev = sd->gspca_dev.dev;
53 __u8 *buf = sd->gspca_dev.usb_buf;
55 err = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
57 0x8100 + address, buf,
58 1, M5602_URB_MSG_TIMEOUT);
61 PDEBUG(DBG_TRACE, "Reading bridge register 0x%x containing 0x%x",
64 /* usb_control_msg(...) returns the number of bytes sent upon success,
65 mask that and return zero upon success instead*/
66 return (err < 0) ? err : 0;
69 /* Writes a byte to to the m5602 */
70 int m5602_write_bridge(struct sd *sd, u8 address, u8 i2c_data)
73 struct usb_device *udev = sd->gspca_dev.dev;
74 __u8 *buf = sd->gspca_dev.usb_buf;
76 PDEBUG(DBG_TRACE, "Writing bridge register 0x%x with 0x%x",
79 memcpy(buf, bridge_urb_skeleton,
80 sizeof(bridge_urb_skeleton));
84 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
87 4, M5602_URB_MSG_TIMEOUT);
89 /* usb_control_msg(...) returns the number of bytes sent upon success,
90 mask that and return zero upon success instead */
91 return (err < 0) ? err : 0;
94 /* Dump all the registers of the m5602 bridge,
95 unfortunately this breaks the camera until it's power cycled */
96 static void m5602_dump_bridge(struct sd *sd)
99 for (i = 0; i < 0x80; i++) {
100 unsigned char val = 0;
101 m5602_read_bridge(sd, i, &val);
102 info("ALi m5602 address 0x%x contains 0x%x", i, val);
104 info("Warning: The camera probably won't work until it's power cycled");
107 int m5602_probe_sensor(struct sd *sd)
110 sd->sensor = &po1030;
111 if (!sd->sensor->probe(sd)) {
112 sd_desc.ctrls = po1030.ctrls;
113 sd_desc.nctrls = po1030.nctrls;
117 /* Try the mt9m111 sensor */
118 sd->sensor = &mt9m111;
119 if (!sd->sensor->probe(sd)) {
120 sd_desc.ctrls = mt9m111.ctrls;
121 sd_desc.nctrls = mt9m111.nctrls;
126 sd->sensor = &s5k4aa;
127 if (!sd->sensor->probe(sd)) {
128 sd_desc.ctrls = s5k4aa.ctrls;
129 sd_desc.nctrls = s5k4aa.nctrls;
134 sd->sensor = &ov9650;
135 if (!sd->sensor->probe(sd)) {
136 sd_desc.ctrls = ov9650.ctrls;
137 sd_desc.nctrls = ov9650.nctrls;
142 sd->sensor = &s5k83a;
143 if (!sd->sensor->probe(sd)) {
144 sd_desc.ctrls = s5k83a.ctrls;
145 sd_desc.nctrls = s5k83a.nctrls;
150 /* More sensor probe function goes here */
151 info("Failed to find a sensor");
156 int m5602_init(struct gspca_dev *gspca_dev)
158 struct sd *sd = (struct sd *) gspca_dev;
161 PDEBUG(DBG_TRACE, "Initializing ALi m5602 webcam");
162 /* Run the init sequence */
163 err = sd->sensor->init(sd);
168 void m5602_start_transfer(struct gspca_dev *gspca_dev)
170 struct sd *sd = (struct sd *) gspca_dev;
171 __u8 *buf = sd->gspca_dev.usb_buf;
173 /* Send start command to the camera */
174 const u8 buffer[4] = {0x13, 0xf9, 0x0f, 0x01};
175 memcpy(buf, buffer, sizeof(buffer));
176 usb_control_msg(gspca_dev->dev, usb_sndctrlpipe(gspca_dev->dev, 0),
177 0x04, 0x40, 0x19, 0x0000, buf,
178 4, M5602_URB_MSG_TIMEOUT);
180 PDEBUG(DBG_V4L2, "Transfer started");
183 void m5602_urb_complete(struct gspca_dev *gspca_dev, struct gspca_frame *frame,
186 struct sd *sd = (struct sd *) gspca_dev;
189 PDEBUG(DBG_DATA, "Packet is less than 6 bytes");
193 /* Frame delimiter: ff xx xx xx ff ff */
194 if (data[0] == 0xff && data[4] == 0xff && data[5] == 0xff &&
195 data[2] != sd->frame_id) {
196 PDEBUG(DBG_DATA, "Frame delimiter detected");
197 sd->frame_id = data[2];
199 /* Remove the extra fluff appended on each header */
203 /* Complete the last frame (if any) */
204 frame = gspca_frame_add(gspca_dev, LAST_PACKET,
208 /* Create a new frame */
209 gspca_frame_add(gspca_dev, FIRST_PACKET, frame, data, len);
211 PDEBUG(DBG_V4L2, "Starting new frame %d",
215 int cur_frame_len = frame->data_end - frame->data;
217 /* Remove urb header */
221 if (cur_frame_len + len <= frame->v4l2_buf.length) {
222 PDEBUG(DBG_DATA, "Continuing frame %d copying %d bytes",
223 sd->frame_count, len);
225 gspca_frame_add(gspca_dev, INTER_PACKET, frame,
227 } else if (frame->v4l2_buf.length - cur_frame_len > 0) {
228 /* Add the remaining data up to frame size */
229 gspca_frame_add(gspca_dev, INTER_PACKET, frame, data,
230 frame->v4l2_buf.length - cur_frame_len);
235 void m5602_stop_transfer(struct gspca_dev *gspca_dev)
237 /* Is there are a command to stop a data transfer? */
240 /* this function is called at probe time */
241 int m5602_configure(struct gspca_dev *gspca_dev,
242 const struct usb_device_id *id)
244 struct sd *sd = (struct sd *) gspca_dev;
248 PDEBUG(DBG_GSPCA, "m5602_configure start");
249 cam = &gspca_dev->cam;
250 cam->epaddr = M5602_ISOC_ENDPOINT_ADDR;
253 m5602_dump_bridge(sd);
256 err = m5602_probe_sensor(sd);
260 PDEBUG(DBG_GSPCA, "m5602_configure end");
264 PDEBUG(DBG_GSPCA, "m5602_configure failed");
265 cam->cam_mode = NULL;
271 static int m5602_probe(struct usb_interface *intf,
272 const struct usb_device_id *id)
274 return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
278 static struct usb_driver sd_driver = {
280 .id_table = m5602_table,
281 .probe = m5602_probe,
283 .suspend = gspca_suspend,
284 .resume = gspca_resume,
286 .disconnect = gspca_disconnect
289 /* -- module insert / remove -- */
290 static int __init mod_m5602_init(void)
292 if (usb_register(&sd_driver) < 0)
294 PDEBUG(D_PROBE, "m5602 module registered");
297 static void __exit mod_m5602_exit(void)
299 usb_deregister(&sd_driver);
300 PDEBUG(D_PROBE, "m5602 module deregistered");
303 module_init(mod_m5602_init);
304 module_exit(mod_m5602_exit);
306 MODULE_AUTHOR(DRIVER_AUTHOR);
307 MODULE_DESCRIPTION(DRIVER_DESC);
308 MODULE_LICENSE("GPL");
309 module_param_named(debug, m5602_debug, int, S_IRUGO | S_IWUSR);
310 MODULE_PARM_DESC(debug, "toggles debug on/off");
312 module_param(force_sensor, int, S_IRUGO | S_IWUSR);
313 MODULE_PARM_DESC(force_sensor,
314 "force detection of sensor, "
315 "1 = OV9650, 2 = S5K83A, 3 = S5K4AA, 4 = MT9M111, 5 = PO1030");
317 module_param(dump_bridge, bool, S_IRUGO | S_IWUSR);
318 MODULE_PARM_DESC(dump_bridge, "Dumps all usb bridge registers at startup");
320 module_param(dump_sensor, bool, S_IRUGO | S_IWUSR);
321 MODULE_PARM_DESC(dump_sensor, "Dumps all usb sensor registers "
322 "at startup providing a sensor is found");