2 * Fujifilm Finepix subdriver
4 * Copyright (C) 2008 Frank Zago
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 "finepix"
25 MODULE_AUTHOR("Frank Zago <frank@zago.net>");
26 MODULE_DESCRIPTION("Fujifilm FinePix USB V4L2 driver");
27 MODULE_LICENSE("GPL");
29 /* Default timeout, in ms */
30 #define FPIX_TIMEOUT (HZ / 10)
32 /* Maximum transfer size to use. The windows driver reads by chunks of
33 * 0x2000 bytes, so do the same. Note: reading more seems to work
35 #define FPIX_MAX_TRANSFER 0x2000
37 /* Structure to hold all of our device specific stuff */
39 struct gspca_dev gspca_dev
; /* !! must be the first item */
44 struct usb_ctrlrequest ctrlreq
;
45 struct urb
*control_urb
;
46 struct timer_list bulk_timer
;
49 FPIX_NOP
, /* inactive, else streaming */
50 FPIX_RESET
, /* must reset */
51 FPIX_REQ_FRAME
, /* requesting a frame */
52 FPIX_READ_FRAME
, /* reading frame */
58 struct delayed_work wqe
;
59 struct completion can_close
;
63 /* Delay after which claim the next frame. If the delay is too small,
64 * the camera will return old frames. On the 4800Z, 20ms is bad, 25ms
65 * will fail every 4 or 5 frames, but 30ms is perfect. */
66 #define NEXT_FRAME_DELAY (((HZ * 30) + 999) / 1000)
68 #define dev_new_state(new_state) { \
69 PDEBUG(D_STREAM, "new state from %d to %d at %s:%d", \
70 dev->state, new_state, __func__, __LINE__); \
71 dev->state = new_state; \
74 /* These cameras only support 320x200. */
75 static const struct v4l2_pix_format fpix_mode
[1] = {
76 { 320, 240, V4L2_PIX_FMT_JPEG
, V4L2_FIELD_NONE
,
78 .sizeimage
= 320 * 240 * 3 / 8 + 590,
79 .colorspace
= V4L2_COLORSPACE_SRGB
,
83 /* Reads part of a frame */
84 static void read_frame_part(struct usb_fpix
*dev
)
88 PDEBUG(D_STREAM
, "read_frame_part");
90 /* Reads part of a frame */
91 ret
= usb_submit_urb(dev
->gspca_dev
.urb
[0], GFP_ATOMIC
);
93 dev_new_state(FPIX_RESET
);
94 schedule_delayed_work(&dev
->wqe
, 1);
95 PDEBUG(D_STREAM
, "usb_submit_urb failed with %d",
98 /* Sometimes we never get a callback, so use a timer.
99 * Is this masking a bug somewhere else? */
100 dev
->bulk_timer
.expires
= jiffies
+ msecs_to_jiffies(150);
101 add_timer(&dev
->bulk_timer
);
105 /* Callback for URBs. */
106 static void urb_callback(struct urb
*urb
)
108 struct gspca_dev
*gspca_dev
= urb
->context
;
109 struct usb_fpix
*dev
= (struct usb_fpix
*) gspca_dev
;
112 "enter urb_callback - status=%d, length=%d",
113 urb
->status
, urb
->actual_length
);
115 if (dev
->state
== FPIX_READ_FRAME
)
116 del_timer(&dev
->bulk_timer
);
118 if (urb
->status
!= 0) {
119 /* We kill a stuck urb every 50 frames on average, so don't
120 * display a log message for that. */
121 if (urb
->status
!= -ECONNRESET
)
122 PDEBUG(D_STREAM
, "bad URB status %d", urb
->status
);
123 dev_new_state(FPIX_RESET
);
124 schedule_delayed_work(&dev
->wqe
, 1);
127 switch (dev
->state
) {
129 dev_new_state(FPIX_READ_FRAME
);
130 read_frame_part(dev
);
133 case FPIX_READ_FRAME
: {
134 unsigned char *data
= urb
->transfer_buffer
;
135 struct gspca_frame
*frame
;
137 frame
= gspca_get_i_frame(&dev
->gspca_dev
);
139 gspca_dev
->last_packet_type
= DISCARD_PACKET
;
140 if (urb
->actual_length
< FPIX_MAX_TRANSFER
||
141 (data
[urb
->actual_length
-2] == 0xff &&
142 data
[urb
->actual_length
-1] == 0xd9)) {
144 /* If the result is less than what was asked
145 * for, then it's the end of the
146 * frame. Sometime the jpeg is not complete,
147 * but there's nothing we can do. We also end
148 * here if the the jpeg ends right at the end
151 gspca_frame_add(gspca_dev
, LAST_PACKET
,
153 data
, urb
->actual_length
);
154 dev_new_state(FPIX_REQ_FRAME
);
155 schedule_delayed_work(&dev
->wqe
, NEXT_FRAME_DELAY
);
158 /* got a partial image */
160 gspca_frame_add(gspca_dev
,
161 gspca_dev
->last_packet_type
163 ? FIRST_PACKET
: INTER_PACKET
,
165 data
, urb
->actual_length
);
166 read_frame_part(dev
);
173 PDEBUG(D_STREAM
, "invalid state %d", dev
->state
);
178 /* Request a new frame */
179 static void request_frame(struct usb_fpix
*dev
)
182 struct gspca_dev
*gspca_dev
= &dev
->gspca_dev
;
184 /* Setup command packet */
185 memset(gspca_dev
->usb_buf
, 0, 12);
186 gspca_dev
->usb_buf
[0] = 0xd3;
187 gspca_dev
->usb_buf
[7] = 0x01;
189 /* Request a frame */
190 dev
->ctrlreq
.bRequestType
=
191 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
;
192 dev
->ctrlreq
.bRequest
= USB_REQ_GET_STATUS
;
193 dev
->ctrlreq
.wValue
= 0;
194 dev
->ctrlreq
.wIndex
= 0;
195 dev
->ctrlreq
.wLength
= cpu_to_le16(12);
197 usb_fill_control_urb(dev
->control_urb
,
199 usb_sndctrlpipe(gspca_dev
->dev
, 0),
200 (unsigned char *) &dev
->ctrlreq
,
202 12, urb_callback
, gspca_dev
);
204 ret
= usb_submit_urb(dev
->control_urb
, GFP_ATOMIC
);
206 dev_new_state(FPIX_RESET
);
207 schedule_delayed_work(&dev
->wqe
, 1);
208 PDEBUG(D_STREAM
, "usb_submit_urb failed with %d", ret
);
212 /*--------------------------------------------------------------------------*/
215 static void fpix_sm(struct work_struct
*work
)
217 struct usb_fpix
*dev
= container_of(work
, struct usb_fpix
, wqe
.work
);
219 PDEBUG(D_STREAM
, "fpix_sm state %d", dev
->state
);
221 /* verify that the device wasn't unplugged */
222 if (!dev
->gspca_dev
.present
) {
223 PDEBUG(D_STREAM
, "device is gone");
224 dev_new_state(FPIX_NOP
);
225 complete(&dev
->can_close
);
229 if (!dev
->streaming
) {
230 PDEBUG(D_STREAM
, "stopping state machine");
231 dev_new_state(FPIX_NOP
);
232 complete(&dev
->can_close
);
236 switch (dev
->state
) {
238 dev_new_state(FPIX_REQ_FRAME
);
239 schedule_delayed_work(&dev
->wqe
, HZ
/ 10);
248 case FPIX_READ_FRAME
:
249 PDEBUG(D_STREAM
, "invalid state %d", dev
->state
);
254 /* this function is called at probe time */
255 static int sd_config(struct gspca_dev
*gspca_dev
,
256 const struct usb_device_id
*id
)
258 struct cam
*cam
= &gspca_dev
->cam
;
260 cam
->cam_mode
= fpix_mode
;
262 cam
->epaddr
= 0x01; /* todo: correct for all cams? */
263 cam
->bulk_size
= FPIX_MAX_TRANSFER
;
265 /* gspca_dev->nbalt = 1; * use bulk transfer */
269 /* Stop streaming and free the ressources allocated by sd_start. */
270 static void sd_stopN(struct gspca_dev
*gspca_dev
)
272 struct usb_fpix
*dev
= (struct usb_fpix
*) gspca_dev
;
276 /* Stop the state machine */
277 if (dev
->state
!= FPIX_NOP
)
278 wait_for_completion(&dev
->can_close
);
281 /* called on streamoff with alt 0 and disconnect */
282 static void sd_stop0(struct gspca_dev
*gspca_dev
)
284 struct usb_fpix
*dev
= (struct usb_fpix
*) gspca_dev
;
286 usb_free_urb(dev
->control_urb
);
287 dev
->control_urb
= NULL
;
290 /* Kill an URB that hasn't completed. */
291 static void timeout_kill(unsigned long data
)
293 struct urb
*urb
= (struct urb
*) data
;
298 /* this function is called at probe and resume time */
299 static int sd_init(struct gspca_dev
*gspca_dev
)
301 struct usb_fpix
*dev
= (struct usb_fpix
*) gspca_dev
;
303 INIT_DELAYED_WORK(&dev
->wqe
, fpix_sm
);
305 init_timer(&dev
->bulk_timer
);
306 dev
->bulk_timer
.function
= timeout_kill
;
311 static int sd_start(struct gspca_dev
*gspca_dev
)
313 struct usb_fpix
*dev
= (struct usb_fpix
*) gspca_dev
;
317 /* Init the device */
318 memset(gspca_dev
->usb_buf
, 0, 12);
319 gspca_dev
->usb_buf
[0] = 0xc6;
320 gspca_dev
->usb_buf
[8] = 0x20;
322 ret
= usb_control_msg(gspca_dev
->dev
,
323 usb_sndctrlpipe(gspca_dev
->dev
, 0),
325 USB_DIR_OUT
| USB_TYPE_CLASS
|
326 USB_RECIP_INTERFACE
, 0, 0, gspca_dev
->usb_buf
,
330 PDEBUG(D_STREAM
, "usb_control_msg failed (%d)", ret
);
335 /* Read the result of the command. Ignore the result, for it
336 * varies with the device. */
337 ret
= usb_bulk_msg(gspca_dev
->dev
,
338 usb_rcvbulkpipe(gspca_dev
->dev
,
339 gspca_dev
->cam
.epaddr
),
340 gspca_dev
->usb_buf
, FPIX_MAX_TRANSFER
, &size_ret
,
343 PDEBUG(D_STREAM
, "usb_bulk_msg failed (%d)", ret
);
348 /* Request a frame, but don't read it */
349 memset(gspca_dev
->usb_buf
, 0, 12);
350 gspca_dev
->usb_buf
[0] = 0xd3;
351 gspca_dev
->usb_buf
[7] = 0x01;
353 ret
= usb_control_msg(gspca_dev
->dev
,
354 usb_sndctrlpipe(gspca_dev
->dev
, 0),
356 USB_DIR_OUT
| USB_TYPE_CLASS
|
357 USB_RECIP_INTERFACE
, 0, 0, gspca_dev
->usb_buf
,
360 PDEBUG(D_STREAM
, "usb_control_msg failed (%d)", ret
);
365 /* Again, reset bulk in endpoint */
366 usb_clear_halt(gspca_dev
->dev
, gspca_dev
->cam
.epaddr
);
368 /* Allocate a control URB */
369 dev
->control_urb
= usb_alloc_urb(0, GFP_KERNEL
);
370 if (!dev
->control_urb
) {
371 PDEBUG(D_STREAM
, "No free urbs available");
376 /* Various initializations. */
377 init_completion(&dev
->can_close
);
378 dev
->bulk_timer
.data
= (unsigned long)dev
->gspca_dev
.urb
[0];
379 dev
->gspca_dev
.urb
[0]->complete
= urb_callback
;
382 /* Schedule a frame request. */
383 dev_new_state(FPIX_REQ_FRAME
);
384 schedule_delayed_work(&dev
->wqe
, 1);
389 /* Free the ressources */
395 /* Table of supported USB devices */
396 static const __devinitdata
struct usb_device_id device_table
[] = {
397 {USB_DEVICE(0x04cb, 0x0104)},
398 {USB_DEVICE(0x04cb, 0x0109)},
399 {USB_DEVICE(0x04cb, 0x010b)},
400 {USB_DEVICE(0x04cb, 0x010f)},
401 {USB_DEVICE(0x04cb, 0x0111)},
402 {USB_DEVICE(0x04cb, 0x0113)},
403 {USB_DEVICE(0x04cb, 0x0115)},
404 {USB_DEVICE(0x04cb, 0x0117)},
405 {USB_DEVICE(0x04cb, 0x0119)},
406 {USB_DEVICE(0x04cb, 0x011b)},
407 {USB_DEVICE(0x04cb, 0x011d)},
408 {USB_DEVICE(0x04cb, 0x0121)},
409 {USB_DEVICE(0x04cb, 0x0123)},
410 {USB_DEVICE(0x04cb, 0x0125)},
411 {USB_DEVICE(0x04cb, 0x0127)},
412 {USB_DEVICE(0x04cb, 0x0129)},
413 {USB_DEVICE(0x04cb, 0x012b)},
414 {USB_DEVICE(0x04cb, 0x012d)},
415 {USB_DEVICE(0x04cb, 0x012f)},
416 {USB_DEVICE(0x04cb, 0x0131)},
417 {USB_DEVICE(0x04cb, 0x013b)},
418 {USB_DEVICE(0x04cb, 0x013d)},
419 {USB_DEVICE(0x04cb, 0x013f)},
423 MODULE_DEVICE_TABLE(usb
, device_table
);
425 /* sub-driver description */
426 static const struct sd_desc sd_desc
= {
435 /* -- device connect -- */
436 static int sd_probe(struct usb_interface
*intf
,
437 const struct usb_device_id
*id
)
439 return gspca_dev_probe(intf
, id
,
441 sizeof(struct usb_fpix
),
445 static struct usb_driver sd_driver
= {
447 .id_table
= device_table
,
449 .disconnect
= gspca_disconnect
,
451 .suspend
= gspca_suspend
,
452 .resume
= gspca_resume
,
456 /* -- module insert / remove -- */
457 static int __init
sd_mod_init(void)
459 if (usb_register(&sd_driver
) < 0)
461 PDEBUG(D_PROBE
, "registered");
464 static void __exit
sd_mod_exit(void)
466 usb_deregister(&sd_driver
);
467 PDEBUG(D_PROBE
, "deregistered");
470 module_init(sd_mod_init
);
471 module_exit(sd_mod_exit
);