kinect.c

   1 /*
   2  * kinect sensor device camera, gspca driver
   3  *
   4  * Copyright (C) 2010  Antonio Ospite <ospite@studenti.unina.it>
   5  *
   6  * Based on the OpenKinect project and libfreenect by Ector Martin
   7  * http://openkinect.org/wiki/Init_Analysis
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  22  */
  23
  24 #define MODULE_NAME "kinect"
  25
  26 #include "gspca.h"
  27
  28 #define CTRL_TIMEOUT 500
  29
  30 MODULE_AUTHOR("Antonio Ospite <ospite@studenti.unina.it>");
  31 MODULE_DESCRIPTION("GSPCA/Kinect Sensor Device USB Camera Driver");
  32 MODULE_LICENSE("GPL");
  33
  34 struct pkt_hdr {
  35         uint8_t magic[2];
  36         uint8_t pad;
  37         uint8_t flag;
  38         uint8_t unk1;
  39         uint8_t seq;
  40         uint8_t unk2;
  41         uint8_t unk3;
  42         uint32_t timestamp;
  43 };
  44
  45 typedef struct {
  46         uint8_t magic[2];
  47         uint16_t len;
  48         uint16_t cmd;
  49         uint16_t tag;
  50 } cam_hdr;
  51
  52 int gspca_debug = D_ERR | D_PROBE | D_CONF | D_STREAM | D_FRAM | D_PACK |
  53         D_USBI | D_USBO | D_V4L2;
  54
  55 /* specific webcam descriptor */
  56 struct sd {
  57         struct gspca_dev gspca_dev;     /* !! must be the first item */
  58         uint16_t cam_tag;
  59 };
  60
  61 /* V4L2 controls supported by the driver */
  62 /* controls prototypes here */
  63
  64 static const struct ctrl sd_ctrls[] = {
  65 };
  66
  67 static const struct v4l2_pix_format color_camera_mode[] = {
  68         {640, 480, V4L2_PIX_FMT_SGRBG8, V4L2_FIELD_NONE,
  69          .bytesperline = 640,
  70          .sizeimage = 640 * 480,
  71          .colorspace = V4L2_COLORSPACE_SRGB,
  72          .priv = 0},
  73 };
  74
  75 static int kinect_write(struct usb_device *udev, uint8_t *data, uint16_t wLength)
  76 {
  77         return usb_control_msg(udev,
  78                               usb_sndctrlpipe(udev, 0),
  79                               0x00,
  80                               USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  81                               0, 0, data, wLength, CTRL_TIMEOUT);
  82 }
  83
  84 static int kinect_read(struct usb_device *udev, uint8_t *data, uint16_t wLength)
  85 {
  86         return usb_control_msg(udev,
  87                               usb_rcvctrlpipe(udev, 0),
  88                               0x00,
  89                               USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  90                               0, 0, data, wLength, CTRL_TIMEOUT);
  91 }
  92
  93 static int send_cmd(struct gspca_dev *gspca_dev, uint16_t cmd, void *cmdbuf,
  94                 unsigned int cmd_len, void *replybuf, unsigned int reply_len)
  95 {
  96         struct sd *sd = (struct sd *) gspca_dev;
  97         struct usb_device *udev = gspca_dev->dev;
  98         int res, actual_len;
  99         uint8_t obuf[0x400];
 100         uint8_t ibuf[0x200];
 101         cam_hdr *chdr = (void*)obuf;
 102         cam_hdr *rhdr = (void*)ibuf;
 103
 104         if (cmd_len & 1 || cmd_len > (0x400 - sizeof(*chdr))) {
 105                 err("send_cmd: Invalid command length (0x%x)", cmd_len);
 106                 return -1;
 107         }
 108
 109         chdr->magic[0] = 0x47;
 110         chdr->magic[1] = 0x4d;
 111         chdr->cmd = cpu_to_le16(cmd);
 112         chdr->tag = cpu_to_le16(sd->cam_tag);
 113         chdr->len = cpu_to_le16(cmd_len / 2);
 114
 115         memcpy(obuf+sizeof(*chdr), cmdbuf, cmd_len);
 116
 117         res = kinect_write(udev, obuf, cmd_len + sizeof(*chdr));
 118         info("Control cmd=%04x tag=%04x len=%04x: %d", cmd, sd->cam_tag, cmd_len, res);
 119         if (res < 0) {
 120                 err("send_cmd: Output control transfer failed (%d)", res);
 121                 return res;
 122         }
 123
 124         do {
 125                 actual_len = kinect_read(udev, ibuf, 0x200);
 126         } while (actual_len == 0);
 127         info("Control reply: %d", res);
 128         if (actual_len < sizeof(*rhdr)) {
 129                 err("send_cmd: Input control transfer failed (%d)", res);
 130                 return res;
 131         }
 132         actual_len -= sizeof(*rhdr);
 133
 134         if (rhdr->magic[0] != 0x52 || rhdr->magic[1] != 0x42) {
 135                 err("send_cmd: Bad magic %02x %02x", rhdr->magic[0], rhdr->magic[1]);
 136                 return -1;
 137         }
 138         if (rhdr->cmd != chdr->cmd) {
 139                 err("send_cmd: Bad cmd %02x != %02x", rhdr->cmd, chdr->cmd);
 140                 return -1;
 141         }
 142         if (rhdr->tag != chdr->tag) {
 143                 err("send_cmd: Bad tag %04x != %04x", rhdr->tag, chdr->tag);
 144                 return -1;
 145         }
 146         if (cpu_to_le16(rhdr->len) != (actual_len/2)) {
 147                 err("send_cmd: Bad len %04x != %04x",
 148                                 cpu_to_le16(rhdr->len), (int)(actual_len/2));
 149                 return -1;
 150         }
 151
 152         if (actual_len > reply_len) {
 153                 warn("send_cmd: Data buffer is %d bytes long, but got %d bytes",
 154                                 reply_len, actual_len);
 155                 memcpy(replybuf, ibuf+sizeof(*rhdr), reply_len);
 156         } else {
 157                 memcpy(replybuf, ibuf+sizeof(*rhdr), actual_len);
 158         }
 159
 160         sd->cam_tag++;
 161
 162         return actual_len;
 163 }
 164
 165 static int write_register(struct gspca_dev *gspca_dev, uint16_t reg, uint16_t data)
 166 {
 167         uint16_t reply[2];
 168         uint16_t cmd[2];
 169         int res;
 170
 171         cmd[0] = cpu_to_le16(reg);
 172         cmd[1] = cpu_to_le16(data);
 173
 174         PDEBUG(D_USBO, "Write Reg 0x%04x <= 0x%02x", reg, data);
 175         res = send_cmd(gspca_dev, 0x03, cmd, 4, reply, 4);
 176         if (res < 0)
 177                 return res;
 178         if (res != 2) {
 179                 warn("send_cmd returned %d [%04x %04x], 0000 expected",
 180                                 res, reply[0], reply[1]);
 181         }
 182         return 0;
 183 }
 184
 185 /* this function is called at probe time */
 186 static int sd_config(struct gspca_dev *gspca_dev,
 187                      const struct usb_device_id *id)
 188 {
 189         struct sd *sd = (struct sd *) gspca_dev;
 190         struct cam *cam;
 191
 192         sd->cam_tag = 0;
 193
 194         cam = &gspca_dev->cam;
 195
 196         cam->cam_mode = color_camera_mode;
 197         cam->nmodes = ARRAY_SIZE(color_camera_mode);
 198
 199         //cam->npkt = 15;
 200         //gspca_dev->pkt_size = 960 * 2;
 201
 202         return 0;
 203 }
 204
 205 /* this function is called at probe and resume time */
 206 static int sd_init(struct gspca_dev *gspca_dev)
 207 {
 208         PDEBUG(D_PROBE, "Kinect Camera device.");
 209
 210         return 0;
 211 }
 212
 213 static int sd_start(struct gspca_dev *gspca_dev)
 214 {
 215         write_register(gspca_dev, 0x05, 0x00); // reset video stream
 216         write_register(gspca_dev, 0x0c, 0x00);
 217         write_register(gspca_dev, 0x0d, 0x01);
 218         write_register(gspca_dev, 0x0e, 0x1e); // 30Hz bayer
 219
 220         /* Video Format: Raw bayer data */
 221         write_register(gspca_dev, 0x05, 0x01); // start video stream
 222
 223         write_register(gspca_dev, 0x47, 0x00); // disable Hflip
 224
 225         return 0;
 226 }
 227
 228 static void sd_stopN(struct gspca_dev *gspca_dev)
 229 {
 230         write_register(gspca_dev, 0x05, 0x00); // reset video stream
 231 }
 232
 233 static void sd_pkt_scan(struct gspca_dev *gspca_dev, u8 *__data, int len)
 234 {
 235         //struct sd *sd = (struct sd *) gspca_dev;
 236
 237         struct pkt_hdr *hdr = (void*)__data;
 238         uint8_t *data = __data + sizeof(*hdr);
 239         int datalen = len - sizeof(*hdr);
 240
 241         /* strm->flag == 0x80 for the color camera stream */
 242         uint8_t sof = 0x80 | 1;
 243         uint8_t mof = 0x80 | 2;
 244         uint8_t eof = 0x80 | 5;
 245
 246         if (len < 12)
 247                 return;
 248
 249         if (hdr->magic[0] != 'R' || hdr->magic[1] != 'B') {
 250                 warn("[Stream %02x] Invalid magic %02x%02x", 0x80, //strm->flag
 251                                 hdr->magic[0], hdr->magic[1]);
 252                 return;
 253         }
 254
 255         if (hdr->flag == sof)
 256                 gspca_frame_add(gspca_dev, FIRST_PACKET, data, datalen);
 257
 258         else if (hdr->flag == mof)
 259                 gspca_frame_add(gspca_dev, INTER_PACKET, data, datalen);
 260
 261         else if(hdr->flag == eof)
 262                 gspca_frame_add(gspca_dev, LAST_PACKET, data, datalen);
 263
 264         else
 265                 warn("Not recognized...");
 266 }
 267
 268 /* sub-driver description */
 269 static const struct sd_desc sd_desc = {
 270         .name      = MODULE_NAME,
 271         .ctrls     = sd_ctrls,
 272         .nctrls    = ARRAY_SIZE(sd_ctrls),
 273         .config    = sd_config,
 274         .init      = sd_init,
 275         .start     = sd_start,
 276         .stopN     = sd_stopN,
 277         .pkt_scan  = sd_pkt_scan,
 278         /*
 279         .querymenu = sd_querymenu,
 280         .get_streamparm = sd_get_streamparm,
 281         .set_streamparm = sd_set_streamparm,
 282         */
 283 };
 284
 285 /* -- module initialisation -- */
 286 static const __devinitdata struct usb_device_id device_table[] = {
 287         {USB_DEVICE(0x045e, 0x02ae)},
 288         {}
 289 };
 290
 291 MODULE_DEVICE_TABLE(usb, device_table);
 292
 293 /* -- device connect -- */
 294 static int sd_probe(struct usb_interface *intf, const struct usb_device_id *id)
 295 {
 296         return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
 297                                 THIS_MODULE);
 298 }
 299
 300 static struct usb_driver sd_driver = {
 301         .name       = MODULE_NAME,
 302         .id_table   = device_table,
 303         .probe      = sd_probe,
 304         .disconnect = gspca_disconnect,
 305 #ifdef CONFIG_PM
 306         .suspend    = gspca_suspend,
 307         .resume     = gspca_resume,
 308 #endif
 309 };
 310
 311 /* -- module insert / remove -- */
 312 static int __init sd_mod_init(void)
 313 {
 314         return usb_register(&sd_driver);
 315 }
 316
 317 static void __exit sd_mod_exit(void)
 318 {
 319         usb_deregister(&sd_driver);
 320 }
 321
 322 module_init(sd_mod_init);
 323 module_exit(sd_mod_exit);