2 * ov534/ov772x gspca driver
3 * Copyright (C) 2008 Antonio Ospite <ospite@studenti.unina.it>
4 * Copyright (C) 2008 Jim Paris <jim@jtan.com>
6 * Based on a prototype written by Mark Ferrell <majortrips@gmail.com>
7 * USB protocol reverse engineered by Jim Paris <jim@jtan.com>
8 * https://jim.sh/svn/jim/devl/playstation/ps3/eye/test/
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #define MODULE_NAME "ov534"
29 #define OV534_REG_ADDRESS 0xf1 /* ? */
30 #define OV534_REG_SUBADDR 0xf2
31 #define OV534_REG_WRITE 0xf3
32 #define OV534_REG_READ 0xf4
33 #define OV534_REG_OPERATION 0xf5
34 #define OV534_REG_STATUS 0xf6
36 #define OV534_OP_WRITE_3 0x37
37 #define OV534_OP_WRITE_2 0x33
38 #define OV534_OP_READ_2 0xf9
40 #define CTRL_TIMEOUT 500
42 MODULE_AUTHOR("Antonio Ospite <ospite@studenti.unina.it>");
43 MODULE_DESCRIPTION("GSPCA/OV534 USB Camera Driver");
44 MODULE_LICENSE("GPL");
46 /* specific webcam descriptor */
48 struct gspca_dev gspca_dev; /* !! must be the first item */
54 /* V4L2 controls supported by the driver */
55 static struct ctrl sd_ctrls[] = {
58 static struct v4l2_pix_format vga_mode[] = {
59 {640, 480, V4L2_PIX_FMT_YUYV, V4L2_FIELD_NONE,
60 .bytesperline = 640 * 2,
61 .sizeimage = 640 * 480 * 2,
62 .colorspace = V4L2_COLORSPACE_JPEG,
66 static void ov534_reg_write(struct usb_device *udev, u16 reg, u8 val)
71 PDEBUG(D_USBO, "reg=0x%04x, val=0%02x", reg, val);
72 ret = usb_control_msg(udev,
73 usb_sndctrlpipe(udev, 0),
75 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
76 0x0, reg, &data, 1, CTRL_TIMEOUT);
78 PDEBUG(D_ERR, "write failed");
81 static u8 ov534_reg_read(struct usb_device *udev, u16 reg)
86 ret = usb_control_msg(udev,
87 usb_rcvctrlpipe(udev, 0),
89 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
90 0x0, reg, &data, 1, CTRL_TIMEOUT);
91 PDEBUG(D_USBI, "reg=0x%04x, data=0x%02x", reg, data);
93 PDEBUG(D_ERR, "read failed");
97 /* Two bits control LED: 0x21 bit 7 and 0x23 bit 7.
98 * (direction and output)? */
99 static void ov534_set_led(struct usb_device *udev, int status)
103 PDEBUG(D_CONF, "led status: %d", status);
105 data = ov534_reg_read(udev, 0x21);
107 ov534_reg_write(udev, 0x21, data);
109 data = ov534_reg_read(udev, 0x23);
115 ov534_reg_write(udev, 0x23, data);
118 static int sccb_check_status(struct usb_device *udev)
123 for (i = 0; i < 5; i++) {
124 data = ov534_reg_read(udev, OV534_REG_STATUS);
134 PDEBUG(D_ERR, "sccb status 0x%02x, attempt %d/5\n",
141 static void sccb_reg_write(struct usb_device *udev, u16 reg, u8 val)
143 PDEBUG(D_USBO, "reg: 0x%04x, val: 0x%02x", reg, val);
144 ov534_reg_write(udev, OV534_REG_SUBADDR, reg);
145 ov534_reg_write(udev, OV534_REG_WRITE, val);
146 ov534_reg_write(udev, OV534_REG_OPERATION, OV534_OP_WRITE_3);
148 if (!sccb_check_status(udev))
149 PDEBUG(D_ERR, "sccb_reg_write failed");
152 static const __u8 ov534_reg_initdata[][2] = {
155 { OV534_REG_ADDRESS, 0x42 }, /* select OV772x sensor */
195 { 0x1d, 0x02 }, /* payload size 0x0200 * 4 = 2048 bytes */
196 { 0x1d, 0x00 }, /* payload size */
197 { 0x1d, 0x02 }, /* frame size 0x025800 * 4 = 614400 */
198 { 0x1d, 0x58 }, /* frame size */
199 { 0x1d, 0x00 }, /* frame size */
202 { 0x1d, 0x08 }, /* turn on UVC header */
203 { 0x1d, 0x0e }, /* .. */
214 static const __u8 ov772x_reg_initdata[][2] = {
298 static void ov534_set_frame_rate(struct gspca_dev *gspca_dev)
300 struct sd *sd = (struct sd *) gspca_dev;
301 int fr = sd->frame_rate;
305 sccb_reg_write(gspca_dev->dev, 0x11, 0x01);
306 sccb_reg_write(gspca_dev->dev, 0x0d, 0x41);
307 ov534_reg_write(gspca_dev->dev, 0xe5, 0x02);
310 sccb_reg_write(gspca_dev->dev, 0x11, 0x02);
311 sccb_reg_write(gspca_dev->dev, 0x0d, 0xc1);
312 ov534_reg_write(gspca_dev->dev, 0xe5, 0x04);
317 sccb_reg_write(gspca_dev->dev, 0x11, 0x04);
318 sccb_reg_write(gspca_dev->dev, 0x0d, 0x81);
319 ov534_reg_write(gspca_dev->dev, 0xe5, 0x02);
322 sccb_reg_write(gspca_dev->dev, 0x11, 0x03);
323 sccb_reg_write(gspca_dev->dev, 0x0d, 0x41);
324 ov534_reg_write(gspca_dev->dev, 0xe5, 0x04);
329 PDEBUG(D_PROBE, "frame_rate: %d", fr);
333 static void ov534_setup(struct usb_device *udev)
337 /* Initialize bridge chip */
338 for (i = 0; i < ARRAY_SIZE(ov534_reg_initdata); i++)
339 ov534_reg_write(udev, ov534_reg_initdata[i][0],
340 ov534_reg_initdata[i][1]);
342 ov534_set_led(udev, 1);
344 /* Initialize sensor */
345 for (i = 0; i < ARRAY_SIZE(ov772x_reg_initdata); i++)
346 sccb_reg_write(udev, ov772x_reg_initdata[i][0],
347 ov772x_reg_initdata[i][1]);
349 ov534_reg_write(udev, 0xe0, 0x09);
350 ov534_set_led(udev, 0);
353 /* this function is called at probe time */
354 static int sd_config(struct gspca_dev *gspca_dev,
355 const struct usb_device_id *id)
359 cam = &gspca_dev->cam;
362 cam->cam_mode = vga_mode;
363 cam->nmodes = ARRAY_SIZE(vga_mode);
365 cam->bulk_size = 16384;
371 /* this function is called at probe and resume time */
372 static int sd_init(struct gspca_dev *gspca_dev)
374 ov534_setup(gspca_dev->dev);
375 ov534_set_frame_rate(gspca_dev);
380 static int sd_start(struct gspca_dev *gspca_dev)
382 /* start streaming data */
383 ov534_set_led(gspca_dev->dev, 1);
384 ov534_reg_write(gspca_dev->dev, 0xe0, 0x00);
389 static void sd_stopN(struct gspca_dev *gspca_dev)
391 /* stop streaming data */
392 ov534_reg_write(gspca_dev->dev, 0xe0, 0x09);
393 ov534_set_led(gspca_dev->dev, 0);
396 /* Values for bmHeaderInfo (Video and Still Image Payload Headers, 2.4.3.3) */
397 #define UVC_STREAM_EOH (1 << 7)
398 #define UVC_STREAM_ERR (1 << 6)
399 #define UVC_STREAM_STI (1 << 5)
400 #define UVC_STREAM_RES (1 << 4)
401 #define UVC_STREAM_SCR (1 << 3)
402 #define UVC_STREAM_PTS (1 << 2)
403 #define UVC_STREAM_EOF (1 << 1)
404 #define UVC_STREAM_FID (1 << 0)
406 static void sd_pkt_scan(struct gspca_dev *gspca_dev, struct gspca_frame *frame,
409 struct sd *sd = (struct sd *) gspca_dev;
412 int remaining_len = len;
413 __u8 *next_data = data;
416 if (remaining_len <= 0)
420 len = min(remaining_len, 2048);
421 remaining_len -= len;
424 /* Payloads are prefixed with a the UVC-style header. We
425 consider a frame to start when the FID toggles, or the PTS
426 changes. A frame ends when EOF is set, and we've received
427 the correct number of bytes. */
429 /* Verify UVC header. Header length is always 12 */
430 if (data[0] != 12 || len < 12) {
431 PDEBUG(D_PACK, "bad header");
436 if (data[1] & UVC_STREAM_ERR) {
437 PDEBUG(D_PACK, "payload error");
441 /* Extract PTS and FID */
442 if (!(data[1] & UVC_STREAM_PTS)) {
443 PDEBUG(D_PACK, "PTS not present");
446 this_pts = (data[5] << 24) | (data[4] << 16) | (data[3] << 8) | data[2];
447 this_fid = (data[1] & UVC_STREAM_FID) ? 1 : 0;
449 /* If PTS or FID has changed, start a new frame. */
450 if (this_pts != sd->last_pts || this_fid != sd->last_fid) {
451 gspca_frame_add(gspca_dev, FIRST_PACKET, frame, NULL, 0);
452 sd->last_pts = this_pts;
453 sd->last_fid = this_fid;
456 /* Add the data from this payload */
457 gspca_frame_add(gspca_dev, INTER_PACKET, frame,
458 data + 12, len - 12);
460 /* If this packet is marked as EOF, end the frame */
461 if (data[1] & UVC_STREAM_EOF) {
464 if ((frame->data_end - frame->data) !=
465 (gspca_dev->width * gspca_dev->height * 2)) {
466 PDEBUG(D_PACK, "short frame");
470 gspca_frame_add(gspca_dev, LAST_PACKET, frame, NULL, 0);
473 /* Done this payload */
477 /* Discard data until a new frame starts. */
478 gspca_frame_add(gspca_dev, DISCARD_PACKET, frame, NULL, 0);
482 /* get stream parameters (framerate) */
483 int sd_get_streamparm(struct gspca_dev *gspca_dev,
484 struct v4l2_streamparm *parm)
486 struct v4l2_captureparm *cp = &parm->parm.capture;
487 struct v4l2_fract *tpf = &cp->timeperframe;
488 struct sd *sd = (struct sd *) gspca_dev;
490 if (parm->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
493 cp->capability |= V4L2_CAP_TIMEPERFRAME;
495 tpf->denominator = sd->frame_rate;
500 /* set stream parameters (framerate) */
501 int sd_set_streamparm(struct gspca_dev *gspca_dev,
502 struct v4l2_streamparm *parm)
504 struct v4l2_captureparm *cp = &parm->parm.capture;
505 struct v4l2_fract *tpf = &cp->timeperframe;
506 struct sd *sd = (struct sd *) gspca_dev;
508 if (parm->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
511 /* Set requested framerate */
512 sd->frame_rate = tpf->denominator / tpf->numerator;
513 ov534_set_frame_rate(gspca_dev);
515 /* Return the actual framerate */
517 tpf->denominator = sd->frame_rate;
522 /* sub-driver description */
523 static const struct sd_desc sd_desc = {
526 .nctrls = ARRAY_SIZE(sd_ctrls),
531 .pkt_scan = sd_pkt_scan,
532 .get_streamparm = sd_get_streamparm,
533 .set_streamparm = sd_set_streamparm,
536 /* -- module initialisation -- */
537 static const __devinitdata struct usb_device_id device_table[] = {
538 {USB_DEVICE(0x06f8, 0x3002)}, /* Hercules Blog Webcam */
539 {USB_DEVICE(0x06f8, 0x3003)}, /* Hercules Dualpix HD Weblog */
540 {USB_DEVICE(0x1415, 0x2000)}, /* Sony HD Eye for PS3 (SLEH 00201) */
544 MODULE_DEVICE_TABLE(usb, device_table);
546 /* -- device connect -- */
547 static int sd_probe(struct usb_interface *intf, const struct usb_device_id *id)
549 return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
553 static struct usb_driver sd_driver = {
555 .id_table = device_table,
557 .disconnect = gspca_disconnect,
559 .suspend = gspca_suspend,
560 .resume = gspca_resume,
564 /* -- module insert / remove -- */
565 static int __init sd_mod_init(void)
567 if (usb_register(&sd_driver) < 0)
569 PDEBUG(D_PROBE, "registered");
573 static void __exit sd_mod_exit(void)
575 usb_deregister(&sd_driver);
576 PDEBUG(D_PROBE, "deregistered");
579 module_init(sd_mod_init);
580 module_exit(sd_mod_exit);