]> Pileus Git - ~andy/linux/blob - drivers/media/video/gspca/finepix.c
[media] gspca: the field 'frozen' is under CONFIG_PM
[~andy/linux] / drivers / media / video / gspca / finepix.c
1 /*
2  * Fujifilm Finepix subdriver
3  *
4  * Copyright (C) 2008 Frank Zago
5  *
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
9  * any later version.
10  *
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.
15  *
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
19  */
20
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22
23 #define MODULE_NAME "finepix"
24
25 #include "gspca.h"
26
27 MODULE_AUTHOR("Frank Zago <frank@zago.net>");
28 MODULE_DESCRIPTION("Fujifilm FinePix USB V4L2 driver");
29 MODULE_LICENSE("GPL");
30
31 /* Default timeout, in ms */
32 #define FPIX_TIMEOUT 250
33
34 /* Maximum transfer size to use. The windows driver reads by chunks of
35  * 0x2000 bytes, so do the same. Note: reading more seems to work
36  * too. */
37 #define FPIX_MAX_TRANSFER 0x2000
38
39 /* Structure to hold all of our device specific stuff */
40 struct usb_fpix {
41         struct gspca_dev gspca_dev;     /* !! must be the first item */
42
43         struct work_struct work_struct;
44         struct workqueue_struct *work_thread;
45 };
46
47 /* Delay after which claim the next frame. If the delay is too small,
48  * the camera will return old frames. On the 4800Z, 20ms is bad, 25ms
49  * will fail every 4 or 5 frames, but 30ms is perfect. On the A210,
50  * 30ms is bad while 35ms is perfect. */
51 #define NEXT_FRAME_DELAY 35
52
53 /* These cameras only support 320x200. */
54 static const struct v4l2_pix_format fpix_mode[1] = {
55         { 320, 240, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
56                 .bytesperline = 320,
57                 .sizeimage = 320 * 240 * 3 / 8 + 590,
58                 .colorspace = V4L2_COLORSPACE_SRGB,
59                 .priv = 0}
60 };
61
62 /* send a command to the webcam */
63 static int command(struct gspca_dev *gspca_dev,
64                 int order)      /* 0: reset, 1: frame request */
65 {
66         static u8 order_values[2][12] = {
67                 {0xc6, 0, 0, 0, 0, 0, 0,    0, 0x20, 0, 0, 0},  /* reset */
68                 {0xd3, 0, 0, 0, 0, 0, 0, 0x01,    0, 0, 0, 0},  /* fr req */
69         };
70
71         memcpy(gspca_dev->usb_buf, order_values[order], 12);
72         return usb_control_msg(gspca_dev->dev,
73                         usb_sndctrlpipe(gspca_dev->dev, 0),
74                         USB_REQ_GET_STATUS,
75                         USB_DIR_OUT | USB_TYPE_CLASS |
76                         USB_RECIP_INTERFACE, 0, 0, gspca_dev->usb_buf,
77                         12, FPIX_TIMEOUT);
78 }
79
80 /* workqueue */
81 static void dostream(struct work_struct *work)
82 {
83         struct usb_fpix *dev = container_of(work, struct usb_fpix, work_struct);
84         struct gspca_dev *gspca_dev = &dev->gspca_dev;
85         struct urb *urb = gspca_dev->urb[0];
86         u8 *data = urb->transfer_buffer;
87         int ret = 0;
88         int len;
89
90         /* synchronize with the main driver */
91         mutex_lock(&gspca_dev->usb_lock);
92         mutex_unlock(&gspca_dev->usb_lock);
93         PDEBUG(D_STREAM, "dostream started");
94
95         /* loop reading a frame */
96 again:
97         while (gspca_dev->dev && gspca_dev->streaming) {
98 #ifdef CONFIG_PM
99                 if (gspca_dev->frozen)
100                         break;
101 #endif
102
103                 /* request a frame */
104                 mutex_lock(&gspca_dev->usb_lock);
105                 ret = command(gspca_dev, 1);
106                 mutex_unlock(&gspca_dev->usb_lock);
107                 if (ret < 0)
108                         break;
109 #ifdef CONFIG_PM
110                 if (gspca_dev->frozen)
111                         break;
112 #endif
113                 if (!gspca_dev->dev || !gspca_dev->streaming)
114                         break;
115
116                 /* the frame comes in parts */
117                 for (;;) {
118                         ret = usb_bulk_msg(gspca_dev->dev,
119                                         urb->pipe,
120                                         data,
121                                         FPIX_MAX_TRANSFER,
122                                         &len, FPIX_TIMEOUT);
123                         if (ret < 0) {
124                                 /* Most of the time we get a timeout
125                                  * error. Just restart. */
126                                 goto again;
127                         }
128 #ifdef CONFIG_PM
129                         if (gspca_dev->frozen)
130                                 goto out;
131 #endif
132                         if (!gspca_dev->dev || !gspca_dev->streaming)
133                                 goto out;
134                         if (len < FPIX_MAX_TRANSFER ||
135                                 (data[len - 2] == 0xff &&
136                                         data[len - 1] == 0xd9)) {
137
138                                 /* If the result is less than what was asked
139                                  * for, then it's the end of the
140                                  * frame. Sometimes the jpeg is not complete,
141                                  * but there's nothing we can do. We also end
142                                  * here if the the jpeg ends right at the end
143                                  * of the frame. */
144                                 gspca_frame_add(gspca_dev, LAST_PACKET,
145                                                 data, len);
146                                 break;
147                         }
148
149                         /* got a partial image */
150                         gspca_frame_add(gspca_dev,
151                                         gspca_dev->last_packet_type
152                                                 == LAST_PACKET
153                                         ? FIRST_PACKET : INTER_PACKET,
154                                         data, len);
155                 }
156
157                 /* We must wait before trying reading the next
158                  * frame. If we don't, or if the delay is too short,
159                  * the camera will disconnect. */
160                 msleep(NEXT_FRAME_DELAY);
161         }
162
163 out:
164         PDEBUG(D_STREAM, "dostream stopped");
165 }
166
167 /* this function is called at probe time */
168 static int sd_config(struct gspca_dev *gspca_dev,
169                 const struct usb_device_id *id)
170 {
171         struct usb_fpix *dev = (struct usb_fpix *) gspca_dev;
172         struct cam *cam = &gspca_dev->cam;
173
174         cam->cam_mode = fpix_mode;
175         cam->nmodes = 1;
176         cam->bulk = 1;
177         cam->bulk_size = FPIX_MAX_TRANSFER;
178
179         INIT_WORK(&dev->work_struct, dostream);
180
181         return 0;
182 }
183
184 /* this function is called at probe and resume time */
185 static int sd_init(struct gspca_dev *gspca_dev)
186 {
187         return 0;
188 }
189
190 /* start the camera */
191 static int sd_start(struct gspca_dev *gspca_dev)
192 {
193         struct usb_fpix *dev = (struct usb_fpix *) gspca_dev;
194         int ret, len;
195
196         /* Init the device */
197         ret = command(gspca_dev, 0);
198         if (ret < 0) {
199                 pr_err("init failed %d\n", ret);
200                 return ret;
201         }
202
203         /* Read the result of the command. Ignore the result, for it
204          * varies with the device. */
205         ret = usb_bulk_msg(gspca_dev->dev,
206                         gspca_dev->urb[0]->pipe,
207                         gspca_dev->urb[0]->transfer_buffer,
208                         FPIX_MAX_TRANSFER, &len,
209                         FPIX_TIMEOUT);
210         if (ret < 0) {
211                 pr_err("usb_bulk_msg failed %d\n", ret);
212                 return ret;
213         }
214
215         /* Request a frame, but don't read it */
216         ret = command(gspca_dev, 1);
217         if (ret < 0) {
218                 pr_err("frame request failed %d\n", ret);
219                 return ret;
220         }
221
222         /* Again, reset bulk in endpoint */
223         usb_clear_halt(gspca_dev->dev, gspca_dev->urb[0]->pipe);
224
225         /* Start the workqueue function to do the streaming */
226         dev->work_thread = create_singlethread_workqueue(MODULE_NAME);
227         queue_work(dev->work_thread, &dev->work_struct);
228
229         return 0;
230 }
231
232 /* called on streamoff with alt==0 and on disconnect */
233 /* the usb_lock is held at entry - restore on exit */
234 static void sd_stop0(struct gspca_dev *gspca_dev)
235 {
236         struct usb_fpix *dev = (struct usb_fpix *) gspca_dev;
237
238         /* wait for the work queue to terminate */
239         mutex_unlock(&gspca_dev->usb_lock);
240         destroy_workqueue(dev->work_thread);
241         mutex_lock(&gspca_dev->usb_lock);
242         dev->work_thread = NULL;
243 }
244
245 /* Table of supported USB devices */
246 static const struct usb_device_id device_table[] = {
247         {USB_DEVICE(0x04cb, 0x0104)},
248         {USB_DEVICE(0x04cb, 0x0109)},
249         {USB_DEVICE(0x04cb, 0x010b)},
250         {USB_DEVICE(0x04cb, 0x010f)},
251         {USB_DEVICE(0x04cb, 0x0111)},
252         {USB_DEVICE(0x04cb, 0x0113)},
253         {USB_DEVICE(0x04cb, 0x0115)},
254         {USB_DEVICE(0x04cb, 0x0117)},
255         {USB_DEVICE(0x04cb, 0x0119)},
256         {USB_DEVICE(0x04cb, 0x011b)},
257         {USB_DEVICE(0x04cb, 0x011d)},
258         {USB_DEVICE(0x04cb, 0x0121)},
259         {USB_DEVICE(0x04cb, 0x0123)},
260         {USB_DEVICE(0x04cb, 0x0125)},
261         {USB_DEVICE(0x04cb, 0x0127)},
262         {USB_DEVICE(0x04cb, 0x0129)},
263         {USB_DEVICE(0x04cb, 0x012b)},
264         {USB_DEVICE(0x04cb, 0x012d)},
265         {USB_DEVICE(0x04cb, 0x012f)},
266         {USB_DEVICE(0x04cb, 0x0131)},
267         {USB_DEVICE(0x04cb, 0x013b)},
268         {USB_DEVICE(0x04cb, 0x013d)},
269         {USB_DEVICE(0x04cb, 0x013f)},
270         {}
271 };
272
273 MODULE_DEVICE_TABLE(usb, device_table);
274
275 /* sub-driver description */
276 static const struct sd_desc sd_desc = {
277         .name   = MODULE_NAME,
278         .config = sd_config,
279         .init   = sd_init,
280         .start  = sd_start,
281         .stop0  = sd_stop0,
282 };
283
284 /* -- device connect -- */
285 static int sd_probe(struct usb_interface *intf,
286                 const struct usb_device_id *id)
287 {
288         return gspca_dev_probe(intf, id,
289                         &sd_desc,
290                         sizeof(struct usb_fpix),
291                         THIS_MODULE);
292 }
293
294 static struct usb_driver sd_driver = {
295         .name       = MODULE_NAME,
296         .id_table   = device_table,
297         .probe      = sd_probe,
298         .disconnect = gspca_disconnect,
299 #ifdef CONFIG_PM
300         .suspend = gspca_suspend,
301         .resume  = gspca_resume,
302 #endif
303 };
304
305 module_usb_driver(sd_driver);