xref: /openbmc/linux/drivers/media/usb/gspca/finepix.c (revision 8730046c)
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 };
45 
46 /* Delay after which claim the next frame. If the delay is too small,
47  * the camera will return old frames. On the 4800Z, 20ms is bad, 25ms
48  * will fail every 4 or 5 frames, but 30ms is perfect. On the A210,
49  * 30ms is bad while 35ms is perfect. */
50 #define NEXT_FRAME_DELAY 35
51 
52 /* These cameras only support 320x200. */
53 static const struct v4l2_pix_format fpix_mode[1] = {
54 	{ 320, 240, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
55 		.bytesperline = 320,
56 		.sizeimage = 320 * 240 * 3 / 8 + 590,
57 		.colorspace = V4L2_COLORSPACE_SRGB,
58 		.priv = 0}
59 };
60 
61 /* send a command to the webcam */
62 static int command(struct gspca_dev *gspca_dev,
63 		int order)	/* 0: reset, 1: frame request */
64 {
65 	static u8 order_values[2][12] = {
66 		{0xc6, 0, 0, 0, 0, 0, 0,    0, 0x20, 0, 0, 0},	/* reset */
67 		{0xd3, 0, 0, 0, 0, 0, 0, 0x01,    0, 0, 0, 0},	/* fr req */
68 	};
69 
70 	memcpy(gspca_dev->usb_buf, order_values[order], 12);
71 	return usb_control_msg(gspca_dev->dev,
72 			usb_sndctrlpipe(gspca_dev->dev, 0),
73 			USB_REQ_GET_STATUS,
74 			USB_DIR_OUT | USB_TYPE_CLASS |
75 			USB_RECIP_INTERFACE, 0, 0, gspca_dev->usb_buf,
76 			12, FPIX_TIMEOUT);
77 }
78 
79 /*
80  * This function is called as a workqueue function and runs whenever the camera
81  * is streaming data. Because it is a workqueue function it is allowed to sleep
82  * so we can use synchronous USB calls. To avoid possible collisions with other
83  * threads attempting to use gspca_dev->usb_buf we take the usb_lock when
84  * performing USB operations using it. In practice we don't really need this
85  * as the camera doesn't provide any controls.
86  */
87 static void dostream(struct work_struct *work)
88 {
89 	struct usb_fpix *dev = container_of(work, struct usb_fpix, work_struct);
90 	struct gspca_dev *gspca_dev = &dev->gspca_dev;
91 	struct urb *urb = gspca_dev->urb[0];
92 	u8 *data = urb->transfer_buffer;
93 	int ret = 0;
94 	int len;
95 
96 	PDEBUG(D_STREAM, "dostream started");
97 
98 	/* loop reading a frame */
99 again:
100 	while (gspca_dev->present && gspca_dev->streaming) {
101 #ifdef CONFIG_PM
102 		if (gspca_dev->frozen)
103 			break;
104 #endif
105 
106 		/* request a frame */
107 		mutex_lock(&gspca_dev->usb_lock);
108 		ret = command(gspca_dev, 1);
109 		mutex_unlock(&gspca_dev->usb_lock);
110 		if (ret < 0)
111 			break;
112 #ifdef CONFIG_PM
113 		if (gspca_dev->frozen)
114 			break;
115 #endif
116 		if (!gspca_dev->present || !gspca_dev->streaming)
117 			break;
118 
119 		/* the frame comes in parts */
120 		for (;;) {
121 			ret = usb_bulk_msg(gspca_dev->dev,
122 					urb->pipe,
123 					data,
124 					FPIX_MAX_TRANSFER,
125 					&len, FPIX_TIMEOUT);
126 			if (ret < 0) {
127 				/* Most of the time we get a timeout
128 				 * error. Just restart. */
129 				goto again;
130 			}
131 #ifdef CONFIG_PM
132 			if (gspca_dev->frozen)
133 				goto out;
134 #endif
135 			if (!gspca_dev->present || !gspca_dev->streaming)
136 				goto out;
137 			if (len < FPIX_MAX_TRANSFER ||
138 				(data[len - 2] == 0xff &&
139 					data[len - 1] == 0xd9)) {
140 
141 				/* If the result is less than what was asked
142 				 * for, then it's the end of the
143 				 * frame. Sometimes the jpeg is not complete,
144 				 * but there's nothing we can do. We also end
145 				 * here if the the jpeg ends right at the end
146 				 * of the frame. */
147 				gspca_frame_add(gspca_dev, LAST_PACKET,
148 						data, len);
149 				break;
150 			}
151 
152 			/* got a partial image */
153 			gspca_frame_add(gspca_dev,
154 					gspca_dev->last_packet_type
155 						== LAST_PACKET
156 					? FIRST_PACKET : INTER_PACKET,
157 					data, len);
158 		}
159 
160 		/* We must wait before trying reading the next
161 		 * frame. If we don't, or if the delay is too short,
162 		 * the camera will disconnect. */
163 		msleep(NEXT_FRAME_DELAY);
164 	}
165 
166 out:
167 	PDEBUG(D_STREAM, "dostream stopped");
168 }
169 
170 /* this function is called at probe time */
171 static int sd_config(struct gspca_dev *gspca_dev,
172 		const struct usb_device_id *id)
173 {
174 	struct usb_fpix *dev = (struct usb_fpix *) gspca_dev;
175 	struct cam *cam = &gspca_dev->cam;
176 
177 	cam->cam_mode = fpix_mode;
178 	cam->nmodes = 1;
179 	cam->bulk = 1;
180 	cam->bulk_size = FPIX_MAX_TRANSFER;
181 
182 	INIT_WORK(&dev->work_struct, dostream);
183 
184 	return 0;
185 }
186 
187 /* this function is called at probe and resume time */
188 static int sd_init(struct gspca_dev *gspca_dev)
189 {
190 	return 0;
191 }
192 
193 /* start the camera */
194 static int sd_start(struct gspca_dev *gspca_dev)
195 {
196 	struct usb_fpix *dev = (struct usb_fpix *) gspca_dev;
197 	int ret, len;
198 
199 	/* Init the device */
200 	ret = command(gspca_dev, 0);
201 	if (ret < 0) {
202 		pr_err("init failed %d\n", ret);
203 		return ret;
204 	}
205 
206 	/* Read the result of the command. Ignore the result, for it
207 	 * varies with the device. */
208 	ret = usb_bulk_msg(gspca_dev->dev,
209 			gspca_dev->urb[0]->pipe,
210 			gspca_dev->urb[0]->transfer_buffer,
211 			FPIX_MAX_TRANSFER, &len,
212 			FPIX_TIMEOUT);
213 	if (ret < 0) {
214 		pr_err("usb_bulk_msg failed %d\n", ret);
215 		return ret;
216 	}
217 
218 	/* Request a frame, but don't read it */
219 	ret = command(gspca_dev, 1);
220 	if (ret < 0) {
221 		pr_err("frame request failed %d\n", ret);
222 		return ret;
223 	}
224 
225 	/* Again, reset bulk in endpoint */
226 	usb_clear_halt(gspca_dev->dev, gspca_dev->urb[0]->pipe);
227 
228 	schedule_work(&dev->work_struct);
229 
230 	return 0;
231 }
232 
233 /* called on streamoff with alt==0 and on disconnect */
234 /* the usb_lock is held at entry - restore on exit */
235 static void sd_stop0(struct gspca_dev *gspca_dev)
236 {
237 	struct usb_fpix *dev = (struct usb_fpix *) gspca_dev;
238 
239 	/* wait for the work queue to terminate */
240 	mutex_unlock(&gspca_dev->usb_lock);
241 	flush_work(&dev->work_struct);
242 	mutex_lock(&gspca_dev->usb_lock);
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 	.reset_resume = gspca_resume,
303 #endif
304 };
305 
306 module_usb_driver(sd_driver);
307