d58eca25010f1c4f6e62bd9b46f280c9a267b194
[gspca_kinect.git] / kinect.c
1 /*
2  * kinect sensor device camera, gspca driver
3  *
4  * Copyright (C) 2011  Antonio Ospite <ospite@studenti.unina.it>
5  *
6  * Based on the OpenKinect project and libfreenect
7  * http://openkinect.org/wiki/Init_Analysis
8  * 
9  * Special thanks to Steven Toth and kernellabs.com for sponsoring a Kinect
10  * sensor device which I tested the driver on.
11  * 
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  */
26
27 #define MODULE_NAME "kinect"
28
29 #include "gspca.h"
30
31 #define CTRL_TIMEOUT 500
32
33 MODULE_AUTHOR("Antonio Ospite <ospite@studenti.unina.it>");
34 MODULE_DESCRIPTION("GSPCA/Kinect Sensor Device USB Camera Driver");
35 MODULE_LICENSE("GPL");
36
37 #ifdef DEBUG
38 int gspca_debug = D_ERR | D_PROBE | D_CONF | D_STREAM | D_FRAM | D_PACK |
39         D_USBI | D_USBO | D_V4L2;
40 #endif
41
42 struct pkt_hdr {
43         uint8_t magic[2];
44         uint8_t pad;
45         uint8_t flag;
46         uint8_t unk1;
47         uint8_t seq;
48         uint8_t unk2;
49         uint8_t unk3;
50         uint32_t timestamp;
51 };
52
53 typedef struct {
54         uint8_t magic[2];
55         uint16_t len;
56         uint16_t cmd;
57         uint16_t tag;
58 } cam_hdr;
59
60 /* specific webcam descriptor */
61 struct sd {
62         struct gspca_dev gspca_dev; /* !! must be the first item */
63         uint16_t cam_tag;           /* a sequence number for packets */
64         uint8_t stream_flag;        /* to identify different steram types */
65 };
66
67 /* V4L2 controls supported by the driver */
68 /* controls prototypes here */
69
70 static const struct ctrl sd_ctrls[] = {
71 };
72
73 #define MODE_640x480   0x0001
74 #define MODE_640x488   0x0002
75 #define MODE_1280x1024 0x0004
76
77 #define FORMAT_BAYER   0x0010
78 #define FORMAT_UYVY    0x0020
79 #define FORMAT_Y10B    0x0040
80
81 #define FPS_HIGH       0x0100
82
83 static const struct v4l2_pix_format video_camera_mode[] = {
84         {640, 480, V4L2_PIX_FMT_SGRBG8, V4L2_FIELD_NONE,
85          .bytesperline = 640,
86          .sizeimage = 640 * 480,
87          .colorspace = V4L2_COLORSPACE_SRGB,
88          .priv = MODE_640x480 | FORMAT_BAYER | FPS_HIGH},
89         {640, 480, V4L2_PIX_FMT_UYVY, V4L2_FIELD_NONE,
90          .bytesperline = 640 * 2,
91          .sizeimage = 640 * 480 * 2,
92          .colorspace = V4L2_COLORSPACE_SRGB,
93          .priv = MODE_640x480 | FORMAT_UYVY},
94         {1280, 1024, V4L2_PIX_FMT_SGRBG8, V4L2_FIELD_NONE,
95          .bytesperline = 1280,
96          .sizeimage = 1280 * 1024,
97          .colorspace = V4L2_COLORSPACE_SRGB,
98          .priv = MODE_1280x1024 | FORMAT_BAYER},
99         {640, 488, V4L2_PIX_FMT_Y10BPACK, V4L2_FIELD_NONE,
100          .bytesperline = 640 * 10 / 8,
101          .sizeimage =  640 * 488 * 10 / 8,
102          .colorspace = V4L2_COLORSPACE_SRGB,
103          .priv = MODE_640x488 | FORMAT_Y10B | FPS_HIGH},
104         {1280, 1024, V4L2_PIX_FMT_Y10BPACK, V4L2_FIELD_NONE,
105          .bytesperline = 1280 * 10 / 8,
106          .sizeimage =  1280 * 1024 * 10 / 8,
107          .colorspace = V4L2_COLORSPACE_SRGB,
108          .priv = MODE_1280x1024 | FORMAT_Y10B},
109 };
110
111 static int kinect_write(struct usb_device *udev, uint8_t *data, uint16_t wLength)
112 {
113         return usb_control_msg(udev,
114                               usb_sndctrlpipe(udev, 0),
115                               0x00,
116                               USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
117                               0, 0, data, wLength, CTRL_TIMEOUT);
118 }
119
120 static int kinect_read(struct usb_device *udev, uint8_t *data, uint16_t wLength)
121 {
122         return usb_control_msg(udev,
123                               usb_rcvctrlpipe(udev, 0),
124                               0x00,
125                               USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
126                               0, 0, data, wLength, CTRL_TIMEOUT);
127 }
128
129 static int send_cmd(struct gspca_dev *gspca_dev, uint16_t cmd, void *cmdbuf,
130                 unsigned int cmd_len, void *replybuf, unsigned int reply_len)
131 {
132         struct sd *sd = (struct sd *) gspca_dev;
133         struct usb_device *udev = gspca_dev->dev;
134         int res, actual_len;
135         uint8_t obuf[0x400];
136         uint8_t ibuf[0x200];
137         cam_hdr *chdr = (void*)obuf;
138         cam_hdr *rhdr = (void*)ibuf;
139
140         if (cmd_len & 1 || cmd_len > (0x400 - sizeof(*chdr))) {
141                 err("send_cmd: Invalid command length (0x%x)", cmd_len);
142                 return -1;
143         }
144
145         chdr->magic[0] = 0x47;
146         chdr->magic[1] = 0x4d;
147         chdr->cmd = cpu_to_le16(cmd);
148         chdr->tag = cpu_to_le16(sd->cam_tag);
149         chdr->len = cpu_to_le16(cmd_len / 2);
150
151         memcpy(obuf+sizeof(*chdr), cmdbuf, cmd_len);
152
153         res = kinect_write(udev, obuf, cmd_len + sizeof(*chdr));
154         PDEBUG(D_USBO, "Control cmd=%04x tag=%04x len=%04x: %d", cmd, sd->cam_tag, cmd_len, res);
155         if (res < 0) {
156                 err("send_cmd: Output control transfer failed (%d)", res);
157                 return res;
158         }
159
160         do {
161                 actual_len = kinect_read(udev, ibuf, 0x200);
162         } while (actual_len == 0);
163         PDEBUG(D_USBO, "Control reply: %d", res);
164         if (actual_len < sizeof(*rhdr)) {
165                 err("send_cmd: Input control transfer failed (%d)", res);
166                 return res;
167         }
168         actual_len -= sizeof(*rhdr);
169
170         if (rhdr->magic[0] != 0x52 || rhdr->magic[1] != 0x42) {
171                 err("send_cmd: Bad magic %02x %02x", rhdr->magic[0], rhdr->magic[1]);
172                 return -1;
173         }
174         if (rhdr->cmd != chdr->cmd) {
175                 err("send_cmd: Bad cmd %02x != %02x", rhdr->cmd, chdr->cmd);
176                 return -1;
177         }
178         if (rhdr->tag != chdr->tag) {
179                 err("send_cmd: Bad tag %04x != %04x", rhdr->tag, chdr->tag);
180                 return -1;
181         }
182         if (cpu_to_le16(rhdr->len) != (actual_len/2)) {
183                 err("send_cmd: Bad len %04x != %04x",
184                                 cpu_to_le16(rhdr->len), (int)(actual_len/2));
185                 return -1;
186         }
187
188         if (actual_len > reply_len) {
189                 warn("send_cmd: Data buffer is %d bytes long, but got %d bytes",
190                                 reply_len, actual_len);
191                 memcpy(replybuf, ibuf+sizeof(*rhdr), reply_len);
192         } else {
193                 memcpy(replybuf, ibuf+sizeof(*rhdr), actual_len);
194         }
195
196         sd->cam_tag++;
197
198         return actual_len;
199 }
200
201 static int write_register(struct gspca_dev *gspca_dev, uint16_t reg, uint16_t data)
202 {
203         uint16_t reply[2];
204         uint16_t cmd[2];
205         int res;
206
207         cmd[0] = cpu_to_le16(reg);
208         cmd[1] = cpu_to_le16(data);
209
210         PDEBUG(D_USBO, "Write Reg 0x%04x <= 0x%02x", reg, data);
211         res = send_cmd(gspca_dev, 0x03, cmd, 4, reply, 4);
212         if (res < 0)
213                 return res;
214         if (res != 2) {
215                 warn("send_cmd returned %d [%04x %04x], 0000 expected",
216                                 res, reply[0], reply[1]);
217         }
218         return 0;
219 }
220
221 /* this function is called at probe time */
222 static int sd_config(struct gspca_dev *gspca_dev,
223                      const struct usb_device_id *id)
224 {
225         struct sd *sd = (struct sd *) gspca_dev;
226         struct cam *cam;
227
228         sd->cam_tag = 0;
229
230         /* Only color camera is supported for now,
231          * which has stream flag = 0x80 */
232         sd->stream_flag = 0x80;
233
234         cam = &gspca_dev->cam;
235
236         cam->cam_mode = video_camera_mode;
237         cam->nmodes = ARRAY_SIZE(video_camera_mode);
238
239 #if 0
240         /* Setting those values is not needed for color camera */
241         cam->npkt = 15;
242         gspca_dev->pkt_size = 960 * 2;
243 #endif
244
245         return 0;
246 }
247
248 /* this function is called at probe and resume time */
249 static int sd_init(struct gspca_dev *gspca_dev)
250 {
251         PDEBUG(D_PROBE, "Kinect Camera device.");
252
253         return 0;
254 }
255
256 static int sd_start(struct gspca_dev *gspca_dev)
257 {
258         int mode;
259         uint8_t fmt_reg, fmt_val;
260         uint8_t res_reg, res_val;
261         uint8_t fps_reg, fps_val;
262         uint8_t mode_val;
263
264         mode = gspca_dev->cam.cam_mode[gspca_dev->curr_mode].priv;
265
266         if (mode & FORMAT_Y10B) {
267                 fmt_reg = 0x19;
268                 res_reg = 0x1a;
269                 fps_reg = 0x1b;
270                 mode_val = 0x03;
271         } else {
272                 fmt_reg = 0x0c;
273                 res_reg = 0x0d;
274                 fps_reg = 0x0e;
275                 mode_val = 0x01;
276         }
277
278         /* format */
279         if (mode & FORMAT_UYVY)
280                 fmt_val = 0x05;
281         else
282                 fmt_val = 0x00;
283
284         if (mode & MODE_1280x1024)
285                 res_val = 0x02;
286         else
287                 res_val = 0x01;
288
289         if (mode & FPS_HIGH)
290                 fps_val = 0x1e;
291         else
292                 fps_val = 0x0f;
293
294
295         /* turn off IR-reset function */
296         write_register(gspca_dev, 0x105, 0x00);
297
298         /* Reset video stream */
299         write_register(gspca_dev, 0x05, 0x00);
300
301         /* Due to some ridiculous condition in the firmware, we have to start
302          * and stop the depth stream before the camera will hand us 1280x1024
303          * IR.  This is a stupid workaround, but we've yet to find a better
304          * solution.
305          *
306          * Thanks to Drew Fisher for figuring this out.
307          */
308         if (mode & (FORMAT_Y10B | MODE_1280x1024)) {
309                 write_register(gspca_dev, 0x13, 0x01);
310                 write_register(gspca_dev, 0x14, 0x1e);
311                 write_register(gspca_dev, 0x06, 0x02);
312                 write_register(gspca_dev, 0x06, 0x00);
313         }
314
315         write_register(gspca_dev, fmt_reg, fmt_val);
316         write_register(gspca_dev, res_reg, res_val);
317         write_register(gspca_dev, fps_reg, fps_val);
318
319         /* Start video stream */
320         write_register(gspca_dev, 0x05, mode_val);
321
322         /* disable Hflip */
323         write_register(gspca_dev, 0x47, 0x00);
324
325         return 0;
326 }
327
328 static void sd_stopN(struct gspca_dev *gspca_dev)
329 {
330         /* reset video stream */
331         write_register(gspca_dev, 0x05, 0x00);
332 }
333
334 static void sd_pkt_scan(struct gspca_dev *gspca_dev, u8 *__data, int len)
335 {
336         struct sd *sd = (struct sd *) gspca_dev;
337         
338         struct pkt_hdr *hdr = (void*)__data;
339         uint8_t *data = __data + sizeof(*hdr);
340         int datalen = len - sizeof(*hdr);
341
342         uint8_t sof = sd->stream_flag | 1;
343         uint8_t mof = sd->stream_flag | 2;
344         uint8_t eof = sd->stream_flag | 5;
345
346         if (len < 12)
347                 return;
348
349         if (hdr->magic[0] != 'R' || hdr->magic[1] != 'B') {
350                 warn("[Stream %02x] Invalid magic %02x%02x", sd->stream_flag,
351                                 hdr->magic[0], hdr->magic[1]);
352                 return;
353         }
354
355         if (hdr->flag == sof)
356                 gspca_frame_add(gspca_dev, FIRST_PACKET, data, datalen);
357
358         else if (hdr->flag == mof)
359                 gspca_frame_add(gspca_dev, INTER_PACKET, data, datalen);
360
361         else if(hdr->flag == eof)
362                 gspca_frame_add(gspca_dev, LAST_PACKET, data, datalen);
363
364         else
365                 warn("Packet type not recognized...");
366 }
367
368 /* sub-driver description */
369 static const struct sd_desc sd_desc = {
370         .name      = MODULE_NAME,
371         .ctrls     = sd_ctrls,
372         .nctrls    = ARRAY_SIZE(sd_ctrls),
373         .config    = sd_config,
374         .init      = sd_init,
375         .start     = sd_start,
376         .stopN     = sd_stopN,
377         .pkt_scan  = sd_pkt_scan,
378         /*
379         .querymenu = sd_querymenu,
380         .get_streamparm = sd_get_streamparm,
381         .set_streamparm = sd_set_streamparm,
382         */
383 };
384
385 /* -- module initialisation -- */
386 static const __devinitdata struct usb_device_id device_table[] = {
387         {USB_DEVICE(0x045e, 0x02ae)},
388         {}
389 };
390
391 MODULE_DEVICE_TABLE(usb, device_table);
392
393 /* -- device connect -- */
394 static int sd_probe(struct usb_interface *intf, const struct usb_device_id *id)
395 {
396         return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
397                                 THIS_MODULE);
398 }
399
400 static struct usb_driver sd_driver = {
401         .name       = MODULE_NAME,
402         .id_table   = device_table,
403         .probe      = sd_probe,
404         .disconnect = gspca_disconnect,
405 #ifdef CONFIG_PM
406         .suspend    = gspca_suspend,
407         .resume     = gspca_resume,
408 #endif
409 };
410
411 /* -- module insert / remove -- */
412 static int __init sd_mod_init(void)
413 {
414         return usb_register(&sd_driver);
415 }
416
417 static void __exit sd_mod_exit(void)
418 {
419         usb_deregister(&sd_driver);
420 }
421
422 module_init(sd_mod_init);
423 module_exit(sd_mod_exit);