2 * Jeilin JL2005B/C/D library
4 * Copyright (C) 2011 Theodore Kilgore <kilgota@auburn.edu>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #define MODULE_NAME "jl2005bcd"
23 #include <linux/workqueue.h>
24 #include <linux/slab.h>
28 MODULE_AUTHOR("Theodore Kilgore <kilgota@auburn.edu>");
29 MODULE_DESCRIPTION("JL2005B/C/D USB Camera Driver");
30 MODULE_LICENSE("GPL");
32 /* Default timeouts, in ms */
33 #define JL2005C_CMD_TIMEOUT 500
34 #define JL2005C_DATA_TIMEOUT 1000
36 /* Maximum transfer size to use. */
37 #define JL2005C_MAX_TRANSFER 0x200
38 #define FRAME_HEADER_LEN 16
41 /* specific webcam descriptor */
43 struct gspca_dev gspca_dev; /* !! must be the first item */
44 unsigned char firmware_id[6];
45 const struct v4l2_pix_format *cap_mode;
47 struct work_struct work_struct;
48 struct workqueue_struct *work_thread;
50 int block_size; /* block size of camera */
51 int vga; /* 1 if vga cam, 0 if cif cam */
55 /* Camera has two resolution settings. What they are depends on model. */
56 static const struct v4l2_pix_format cif_mode[] = {
57 {176, 144, V4L2_PIX_FMT_JL2005BCD, V4L2_FIELD_NONE,
59 .sizeimage = 176 * 144,
60 .colorspace = V4L2_COLORSPACE_SRGB,
62 {352, 288, V4L2_PIX_FMT_JL2005BCD, V4L2_FIELD_NONE,
64 .sizeimage = 352 * 288,
65 .colorspace = V4L2_COLORSPACE_SRGB,
69 static const struct v4l2_pix_format vga_mode[] = {
70 {320, 240, V4L2_PIX_FMT_JL2005BCD, V4L2_FIELD_NONE,
72 .sizeimage = 320 * 240,
73 .colorspace = V4L2_COLORSPACE_SRGB,
75 {640, 480, V4L2_PIX_FMT_JL2005BCD, V4L2_FIELD_NONE,
77 .sizeimage = 640 * 480,
78 .colorspace = V4L2_COLORSPACE_SRGB,
83 * cam uses endpoint 0x03 to send commands, 0x84 for read commands,
84 * and 0x82 for bulk data transfer.
87 /* All commands are two bytes only */
88 static int jl2005c_write2(struct gspca_dev *gspca_dev, unsigned char *command)
92 memcpy(gspca_dev->usb_buf, command, 2);
93 retval = usb_bulk_msg(gspca_dev->dev,
94 usb_sndbulkpipe(gspca_dev->dev, 3),
95 gspca_dev->usb_buf, 2, NULL, 500);
97 pr_err("command write [%02x] error %d\n",
98 gspca_dev->usb_buf[0], retval);
102 /* Response to a command is one byte in usb_buf[0], only if requested. */
103 static int jl2005c_read1(struct gspca_dev *gspca_dev)
107 retval = usb_bulk_msg(gspca_dev->dev,
108 usb_rcvbulkpipe(gspca_dev->dev, 0x84),
109 gspca_dev->usb_buf, 1, NULL, 500);
111 pr_err("read command [0x%02x] error %d\n",
112 gspca_dev->usb_buf[0], retval);
116 /* Response appears in gspca_dev->usb_buf[0] */
117 static int jl2005c_read_reg(struct gspca_dev *gspca_dev, unsigned char reg)
121 static u8 instruction[2] = {0x95, 0x00};
122 /* put register to read in byte 1 */
123 instruction[1] = reg;
124 /* Send the read request */
125 retval = jl2005c_write2(gspca_dev, instruction);
128 retval = jl2005c_read1(gspca_dev);
133 static int jl2005c_start_new_frame(struct gspca_dev *gspca_dev)
137 int frame_brightness = 0;
139 static u8 instruction[2] = {0x7f, 0x01};
141 retval = jl2005c_write2(gspca_dev, instruction);
146 while (i < 20 && !frame_brightness) {
147 /* If we tried 20 times, give up. */
148 retval = jl2005c_read_reg(gspca_dev, 0x7e);
151 frame_brightness = gspca_dev->usb_buf[0];
152 retval = jl2005c_read_reg(gspca_dev, 0x7d);
157 PDEBUG(D_FRAM, "frame_brightness is 0x%02x", gspca_dev->usb_buf[0]);
161 static int jl2005c_write_reg(struct gspca_dev *gspca_dev, unsigned char reg,
167 instruction[0] = reg;
168 instruction[1] = value;
170 retval = jl2005c_write2(gspca_dev, instruction);
177 static int jl2005c_get_firmware_id(struct gspca_dev *gspca_dev)
179 struct sd *sd = (struct sd *)gspca_dev;
182 unsigned char regs_to_read[] = {0x57, 0x02, 0x03, 0x5d, 0x5e, 0x5f};
184 PDEBUG(D_PROBE, "Running jl2005c_get_firmware_id");
185 /* Read the first ID byte once for warmup */
186 retval = jl2005c_read_reg(gspca_dev, regs_to_read[0]);
187 PDEBUG(D_PROBE, "response is %02x", gspca_dev->usb_buf[0]);
190 /* Now actually get the ID string */
191 for (i = 0; i < 6; i++) {
192 retval = jl2005c_read_reg(gspca_dev, regs_to_read[i]);
195 sd->firmware_id[i] = gspca_dev->usb_buf[0];
197 PDEBUG(D_PROBE, "firmware ID is %02x%02x%02x%02x%02x%02x",
207 static int jl2005c_stream_start_vga_lg
208 (struct gspca_dev *gspca_dev)
212 static u8 instruction[][2] = {
221 for (i = 0; i < ARRAY_SIZE(instruction); i++) {
223 retval = jl2005c_write2(gspca_dev, instruction[i]);
231 static int jl2005c_stream_start_vga_small(struct gspca_dev *gspca_dev)
235 static u8 instruction[][2] = {
244 for (i = 0; i < ARRAY_SIZE(instruction); i++) {
246 retval = jl2005c_write2(gspca_dev, instruction[i]);
254 static int jl2005c_stream_start_cif_lg(struct gspca_dev *gspca_dev)
258 static u8 instruction[][2] = {
267 for (i = 0; i < ARRAY_SIZE(instruction); i++) {
269 retval = jl2005c_write2(gspca_dev, instruction[i]);
277 static int jl2005c_stream_start_cif_small(struct gspca_dev *gspca_dev)
281 static u8 instruction[][2] = {
290 for (i = 0; i < ARRAY_SIZE(instruction); i++) {
292 retval = jl2005c_write2(gspca_dev, instruction[i]);
301 static int jl2005c_stop(struct gspca_dev *gspca_dev)
305 retval = jl2005c_write_reg(gspca_dev, 0x07, 0x00);
309 /* This function is called as a workqueue function and runs whenever the camera
310 * is streaming data. Because it is a workqueue function it is allowed to sleep
311 * so we can use synchronous USB calls. To avoid possible collisions with other
312 * threads attempting to use the camera's USB interface the gspca usb_lock is
313 * used when performing the one USB control operation inside the workqueue,
314 * which tells the camera to close the stream. In practice the only thing
315 * which needs to be protected against is the usb_set_interface call that
316 * gspca makes during stream_off. Otherwise the camera doesn't provide any
317 * controls that the user could try to change.
319 static void jl2005c_dostream(struct work_struct *work)
321 struct sd *dev = container_of(work, struct sd, work_struct);
322 struct gspca_dev *gspca_dev = &dev->gspca_dev;
323 int bytes_left = 0; /* bytes remaining in current frame. */
324 int data_len; /* size to use for the next read. */
326 unsigned char header_sig[2] = {0x4a, 0x4c};
332 buffer = kmalloc(JL2005C_MAX_TRANSFER, GFP_KERNEL | GFP_DMA);
334 pr_err("Couldn't allocate USB buffer\n");
338 while (gspca_dev->dev && gspca_dev->streaming) {
340 if (gspca_dev->frozen)
343 /* Check if this is a new frame. If so, start the frame first */
345 mutex_lock(&gspca_dev->usb_lock);
346 ret = jl2005c_start_new_frame(gspca_dev);
347 mutex_unlock(&gspca_dev->usb_lock);
350 ret = usb_bulk_msg(gspca_dev->dev,
351 usb_rcvbulkpipe(gspca_dev->dev, 0x82),
352 buffer, JL2005C_MAX_TRANSFER, &act_len,
353 JL2005C_DATA_TIMEOUT);
355 "Got %d bytes out of %d for header",
356 act_len, JL2005C_MAX_TRANSFER);
357 if (ret < 0 || act_len < JL2005C_MAX_TRANSFER)
359 /* Check whether we actually got the first blodk */
360 if (memcmp(header_sig, buffer, 2) != 0) {
361 pr_err("First block is not the first block\n");
364 /* total size to fetch is byte 7, times blocksize
365 * of which we already got act_len */
366 bytes_left = buffer[0x07] * dev->block_size - act_len;
367 PDEBUG(D_PACK, "bytes_left = 0x%x", bytes_left);
368 /* We keep the header. It has other information, too.*/
369 packet_type = FIRST_PACKET;
370 gspca_frame_add(gspca_dev, packet_type,
374 while (bytes_left > 0 && gspca_dev->dev) {
375 data_len = bytes_left > JL2005C_MAX_TRANSFER ?
376 JL2005C_MAX_TRANSFER : bytes_left;
377 ret = usb_bulk_msg(gspca_dev->dev,
378 usb_rcvbulkpipe(gspca_dev->dev, 0x82),
379 buffer, data_len, &act_len,
380 JL2005C_DATA_TIMEOUT);
381 if (ret < 0 || act_len < data_len)
384 "Got %d bytes out of %d for frame",
385 data_len, bytes_left);
386 bytes_left -= data_len;
387 if (bytes_left == 0) {
388 packet_type = LAST_PACKET;
391 packet_type = INTER_PACKET;
392 gspca_frame_add(gspca_dev, packet_type,
397 if (gspca_dev->dev) {
398 mutex_lock(&gspca_dev->usb_lock);
399 jl2005c_stop(gspca_dev);
400 mutex_unlock(&gspca_dev->usb_lock);
408 /* This function is called at probe time */
409 static int sd_config(struct gspca_dev *gspca_dev,
410 const struct usb_device_id *id)
413 struct sd *sd = (struct sd *) gspca_dev;
415 cam = &gspca_dev->cam;
416 /* We don't use the buffer gspca allocates so make it small. */
419 /* For the rest, the camera needs to be detected */
420 jl2005c_get_firmware_id(gspca_dev);
421 /* Here are some known firmware IDs
422 * First some JL2005B cameras
423 * {0x41, 0x07, 0x04, 0x2c, 0xe8, 0xf2} Sakar KidzCam
424 * {0x45, 0x02, 0x08, 0xb9, 0x00, 0xd2} No-name JL2005B
426 * {0x01, 0x0c, 0x16, 0x10, 0xf8, 0xc8} Argus DC-1512
427 * {0x12, 0x04, 0x03, 0xc0, 0x00, 0xd8} ICarly
428 * {0x86, 0x08, 0x05, 0x02, 0x00, 0xd4} Jazz
430 * Based upon this scanty evidence, we can detect a CIF camera by
431 * testing byte 0 for 0x4x.
433 if ((sd->firmware_id[0] & 0xf0) == 0x40) {
434 cam->cam_mode = cif_mode;
435 cam->nmodes = ARRAY_SIZE(cif_mode);
436 sd->block_size = 0x80;
438 cam->cam_mode = vga_mode;
439 cam->nmodes = ARRAY_SIZE(vga_mode);
440 sd->block_size = 0x200;
443 INIT_WORK(&sd->work_struct, jl2005c_dostream);
448 /* this function is called at probe and resume time */
449 static int sd_init(struct gspca_dev *gspca_dev)
454 static int sd_start(struct gspca_dev *gspca_dev)
457 struct sd *sd = (struct sd *) gspca_dev;
458 sd->cap_mode = gspca_dev->cam.cam_mode;
460 switch (gspca_dev->width) {
462 PDEBUG(D_STREAM, "Start streaming at vga resolution");
463 jl2005c_stream_start_vga_lg(gspca_dev);
466 PDEBUG(D_STREAM, "Start streaming at qvga resolution");
467 jl2005c_stream_start_vga_small(gspca_dev);
470 PDEBUG(D_STREAM, "Start streaming at cif resolution");
471 jl2005c_stream_start_cif_lg(gspca_dev);
474 PDEBUG(D_STREAM, "Start streaming at qcif resolution");
475 jl2005c_stream_start_cif_small(gspca_dev);
478 pr_err("Unknown resolution specified\n");
482 /* Start the workqueue function to do the streaming */
483 sd->work_thread = create_singlethread_workqueue(MODULE_NAME);
484 queue_work(sd->work_thread, &sd->work_struct);
489 /* called on streamoff with alt==0 and on disconnect */
490 /* the usb_lock is held at entry - restore on exit */
491 static void sd_stop0(struct gspca_dev *gspca_dev)
493 struct sd *dev = (struct sd *) gspca_dev;
495 /* wait for the work queue to terminate */
496 mutex_unlock(&gspca_dev->usb_lock);
497 /* This waits for sq905c_dostream to finish */
498 destroy_workqueue(dev->work_thread);
499 dev->work_thread = NULL;
500 mutex_lock(&gspca_dev->usb_lock);
505 /* sub-driver description */
506 static const struct sd_desc sd_desc = {
514 /* -- module initialisation -- */
515 static const struct usb_device_id device_table[] = {
516 {USB_DEVICE(0x0979, 0x0227)},
519 MODULE_DEVICE_TABLE(usb, device_table);
521 /* -- device connect -- */
522 static int sd_probe(struct usb_interface *intf,
523 const struct usb_device_id *id)
525 return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
529 static struct usb_driver sd_driver = {
531 .id_table = device_table,
533 .disconnect = gspca_disconnect,
535 .suspend = gspca_suspend,
536 .resume = gspca_resume,
537 .reset_resume = gspca_resume,
541 /* -- module insert / remove -- */
542 static int __init sd_mod_init(void)
546 ret = usb_register(&sd_driver);
551 static void __exit sd_mod_exit(void)
553 usb_deregister(&sd_driver);
556 module_init(sd_mod_init);
557 module_exit(sd_mod_exit);