gspca - kinect: fix comments referring to color camera

[gspca_kinect.git] / kinect.c

diff --git a/kinect.c b/kinect.c
index 883db90..2028c64 100644 (file)
--- a/kinect.c
+++ b/kinect.c
@@ -1,11 +1,14 @@
 /*
  * kinect sensor device camera, gspca driver
  *
 /*
  * kinect sensor device camera, gspca driver
  *

- * Copyright (C) 2010  Antonio Ospite <ospite@studenti.unina.it>
+ * Copyright (C) 2011  Antonio Ospite <ospite@studenti.unina.it>

  *
  *

- * Based on the OpenKinect project and libfreenect by Ector Martin
+ * Based on the OpenKinect project and libfreenect

  * http://openkinect.org/wiki/Init_Analysis
  * http://openkinect.org/wiki/Init_Analysis

- * 
+ *
+ * Special thanks to Steven Toth and kernellabs.com for sponsoring a Kinect
+ * sensor device which I tested the driver on.
+ *

  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or


@@ -31,6 +34,11 @@ MODULE_AUTHOR("Antonio Ospite <ospite@studenti.unina.it>");
 MODULE_DESCRIPTION("GSPCA/Kinect Sensor Device USB Camera Driver");
 MODULE_LICENSE("GPL");
 
 MODULE_DESCRIPTION("GSPCA/Kinect Sensor Device USB Camera Driver");
 MODULE_LICENSE("GPL");
 

+#ifdef DEBUG
+int gspca_debug = D_ERR | D_PROBE | D_CONF | D_STREAM | D_FRAM | D_PACK |
+       D_USBI | D_USBO | D_V4L2;
+#endif
+

 struct pkt_hdr {
        uint8_t magic[2];
        uint8_t pad;
 struct pkt_hdr {
        uint8_t magic[2];
        uint8_t pad;


@@ -42,20 +50,20 @@ struct pkt_hdr {
        uint32_t timestamp;
 };
 
        uint32_t timestamp;
 };
 

-typedef struct {
+struct cam_hdr {

        uint8_t magic[2];
        uint16_t len;
        uint16_t cmd;
        uint16_t tag;
        uint8_t magic[2];
        uint16_t len;
        uint16_t cmd;
        uint16_t tag;

-} cam_hdr;
-
-int gspca_debug = D_ERR | D_PROBE | D_CONF | D_STREAM | D_FRAM | D_PACK |
-       D_USBI | D_USBO | D_V4L2;
+};

 
 /* specific webcam descriptor */
 struct sd {
 
 /* specific webcam descriptor */
 struct sd {

-       struct gspca_dev gspca_dev;     /* !! must be the first item */
-       uint16_t cam_tag;
+       struct gspca_dev gspca_dev; /* !! must be the first item */
+       uint16_t cam_tag;           /* a sequence number for packets */
+       uint8_t stream_flag;        /* to identify different stream types */
+       uint8_t obuf[0x400];        /* output buffer for control commands */
+       uint8_t ibuf[0x200];        /* input buffer for control commands */

 };
 
 /* V4L2 controls supported by the driver */
 };
 
 /* V4L2 controls supported by the driver */


@@ -102,7 +110,8 @@ static const struct v4l2_pix_format video_camera_mode[] = {
         .priv = MODE_1280x1024 | FORMAT_Y10B},
 };
 
         .priv = MODE_1280x1024 | FORMAT_Y10B},
 };
 

-static int kinect_write(struct usb_device *udev, uint8_t *data, uint16_t wLength)
+static int kinect_write(struct usb_device *udev, uint8_t *data,
+                       uint16_t wLength)

 {
        return usb_control_msg(udev,
                              usb_sndctrlpipe(udev, 0),
 {
        return usb_control_msg(udev,
                              usb_sndctrlpipe(udev, 0),


@@ -126,10 +135,10 @@ static int send_cmd(struct gspca_dev *gspca_dev, uint16_t cmd, void *cmdbuf,
        struct sd *sd = (struct sd *) gspca_dev;
        struct usb_device *udev = gspca_dev->dev;
        int res, actual_len;
        struct sd *sd = (struct sd *) gspca_dev;
        struct usb_device *udev = gspca_dev->dev;
        int res, actual_len;

-       uint8_t obuf[0x400];
-       uint8_t ibuf[0x200];
-       cam_hdr *chdr = (void*)obuf;
-       cam_hdr *rhdr = (void*)ibuf;
+       uint8_t *obuf = sd->obuf;
+       uint8_t *ibuf = sd->ibuf;
+       struct cam_hdr *chdr = (void *)obuf;
+       struct cam_hdr *rhdr = (void *)ibuf;

 
        if (cmd_len & 1 || cmd_len > (0x400 - sizeof(*chdr))) {
                err("send_cmd: Invalid command length (0x%x)", cmd_len);
 
        if (cmd_len & 1 || cmd_len > (0x400 - sizeof(*chdr))) {
                err("send_cmd: Invalid command length (0x%x)", cmd_len);


@@ -145,7 +154,8 @@ static int send_cmd(struct gspca_dev *gspca_dev, uint16_t cmd, void *cmdbuf,
        memcpy(obuf+sizeof(*chdr), cmdbuf, cmd_len);
 
        res = kinect_write(udev, obuf, cmd_len + sizeof(*chdr));
        memcpy(obuf+sizeof(*chdr), cmdbuf, cmd_len);
 
        res = kinect_write(udev, obuf, cmd_len + sizeof(*chdr));

-       info("Control cmd=%04x tag=%04x len=%04x: %d", cmd, sd->cam_tag, cmd_len, res);
+       PDEBUG(D_USBO, "Control cmd=%04x tag=%04x len=%04x: %d", cmd,
+               sd->cam_tag, cmd_len, res);

        if (res < 0) {
                err("send_cmd: Output control transfer failed (%d)", res);
                return res;
        if (res < 0) {
                err("send_cmd: Output control transfer failed (%d)", res);
                return res;


@@ -154,7 +164,7 @@ static int send_cmd(struct gspca_dev *gspca_dev, uint16_t cmd, void *cmdbuf,
        do {
                actual_len = kinect_read(udev, ibuf, 0x200);
        } while (actual_len == 0);
        do {
                actual_len = kinect_read(udev, ibuf, 0x200);
        } while (actual_len == 0);

-       info("Control reply: %d", res);
+       PDEBUG(D_USBO, "Control reply: %d", res);

        if (actual_len < sizeof(*rhdr)) {
                err("send_cmd: Input control transfer failed (%d)", res);
                return res;
        if (actual_len < sizeof(*rhdr)) {
                err("send_cmd: Input control transfer failed (%d)", res);
                return res;


@@ -162,7 +172,8 @@ static int send_cmd(struct gspca_dev *gspca_dev, uint16_t cmd, void *cmdbuf,
        actual_len -= sizeof(*rhdr);
 
        if (rhdr->magic[0] != 0x52 || rhdr->magic[1] != 0x42) {
        actual_len -= sizeof(*rhdr);
 
        if (rhdr->magic[0] != 0x52 || rhdr->magic[1] != 0x42) {

-               err("send_cmd: Bad magic %02x %02x", rhdr->magic[0], rhdr->magic[1]);
+               err("send_cmd: Bad magic %02x %02x", rhdr->magic[0],
+                       rhdr->magic[1]);

                return -1;
        }
        if (rhdr->cmd != chdr->cmd) {
                return -1;
        }
        if (rhdr->cmd != chdr->cmd) {


@@ -192,7 +203,8 @@ static int send_cmd(struct gspca_dev *gspca_dev, uint16_t cmd, void *cmdbuf,
        return actual_len;
 }
 
        return actual_len;
 }
 

-static int write_register(struct gspca_dev *gspca_dev, uint16_t reg, uint16_t data)
+static int write_register(struct gspca_dev *gspca_dev, uint16_t reg,
+                       uint16_t data)

 {
        uint16_t reply[2];
        uint16_t cmd[2];
 {
        uint16_t reply[2];
        uint16_t cmd[2];


@@ -221,13 +233,20 @@ static int sd_config(struct gspca_dev *gspca_dev,
 
        sd->cam_tag = 0;
 
 
        sd->cam_tag = 0;
 

+       /* Only video stream is supported for now,
+        * which has stream flag = 0x80 */
+       sd->stream_flag = 0x80;
+

        cam = &gspca_dev->cam;
 
        cam->cam_mode = video_camera_mode;
        cam->nmodes = ARRAY_SIZE(video_camera_mode);
 
        cam = &gspca_dev->cam;
 
        cam->cam_mode = video_camera_mode;
        cam->nmodes = ARRAY_SIZE(video_camera_mode);
 

-       //cam->npkt = 15;
-       //gspca_dev->pkt_size = 960 * 2;
+#if 0
+       /* Setting those values is not needed for video stream */
+       cam->npkt = 15;
+       gspca_dev->pkt_size = 960 * 2;
+#endif

 
        return 0;
 }
 
        return 0;
 }


@@ -314,27 +333,27 @@ static int sd_start(struct gspca_dev *gspca_dev)
 
 static void sd_stopN(struct gspca_dev *gspca_dev)
 {
 
 static void sd_stopN(struct gspca_dev *gspca_dev)
 {

-       write_register(gspca_dev, 0x05, 0x00); // reset video stream
+       /* reset video stream */
+       write_register(gspca_dev, 0x05, 0x00);

 }
 
 static void sd_pkt_scan(struct gspca_dev *gspca_dev, u8 *__data, int len)
 {
 }
 
 static void sd_pkt_scan(struct gspca_dev *gspca_dev, u8 *__data, int len)
 {

-       //struct sd *sd = (struct sd *) gspca_dev;
-       
-       struct pkt_hdr *hdr = (void*)__data;
+       struct sd *sd = (struct sd *) gspca_dev;
+
+       struct pkt_hdr *hdr = (void *)__data;

        uint8_t *data = __data + sizeof(*hdr);
        int datalen = len - sizeof(*hdr);
 
        uint8_t *data = __data + sizeof(*hdr);
        int datalen = len - sizeof(*hdr);
 

-       /* strm->flag == 0x80 for the color camera stream */
-       uint8_t sof = 0x80 | 1;
-       uint8_t mof = 0x80 | 2;
-       uint8_t eof = 0x80 | 5;
+       uint8_t sof = sd->stream_flag | 1;
+       uint8_t mof = sd->stream_flag | 2;
+       uint8_t eof = sd->stream_flag | 5;

 
        if (len < 12)
                return;
 
        if (hdr->magic[0] != 'R' || hdr->magic[1] != 'B') {
 
        if (len < 12)
                return;
 
        if (hdr->magic[0] != 'R' || hdr->magic[1] != 'B') {

-               warn("[Stream %02x] Invalid magic %02x%02x", 0x80, //strm->flag
+               warn("[Stream %02x] Invalid magic %02x%02x", sd->stream_flag,

                                hdr->magic[0], hdr->magic[1]);
                return;
        }
                                hdr->magic[0], hdr->magic[1]);
                return;
        }


@@ -345,11 +364,11 @@ static void sd_pkt_scan(struct gspca_dev *gspca_dev, u8 *__data, int len)
        else if (hdr->flag == mof)
                gspca_frame_add(gspca_dev, INTER_PACKET, data, datalen);
 
        else if (hdr->flag == mof)
                gspca_frame_add(gspca_dev, INTER_PACKET, data, datalen);
 

-       else if(hdr->flag == eof)
+       else if (hdr->flag == eof)

                gspca_frame_add(gspca_dev, LAST_PACKET, data, datalen);
 
        else
                gspca_frame_add(gspca_dev, LAST_PACKET, data, datalen);
 
        else

-               warn("Not recognized...");
+               warn("Packet type not recognized...");

 }
 
 /* sub-driver description */
 }
 
 /* sub-driver description */