1/*
2 * Driver for USB webcams based on Konica chipset. This
3 * chipset is used in Intel YC76 camera.
4 *
5 * Copyright (C) 2010 Hans de Goede <hdegoede@redhat.com>
6 *
7 * Based on the usbvideo v4l1 konicawc driver which is:
8 *
9 * Copyright (C) 2002 Simon Evans <spse@secret.org.uk>
10 *
11 * The code for making gspca work with a webcam with 2 isoc endpoints was
12 * taken from the benq gspca subdriver which is:
13 *
14 * Copyright (C) 2009 Jean-Francois Moine (http://moinejf.free.fr)
15 *
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 */
30
31#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32
33#define MODULE_NAME "konica"
34
35#include <linux/input.h>
36#include "gspca.h"
37
38MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
39MODULE_DESCRIPTION("Konica chipset USB Camera Driver");
40MODULE_LICENSE("GPL");
41
42#define WHITEBAL_REG   0x01
43#define BRIGHTNESS_REG 0x02
44#define SHARPNESS_REG  0x03
45#define CONTRAST_REG   0x04
46#define SATURATION_REG 0x05
47
48/* specific webcam descriptor */
49struct sd {
50	struct gspca_dev gspca_dev;	/* !! must be the first item */
51	struct urb *last_data_urb;
52	u8 snapshot_pressed;
53};
54
55
56/* .priv is what goes to register 8 for this mode, known working values:
57   0x00 -> 176x144, cropped
58   0x01 -> 176x144, cropped
59   0x02 -> 176x144, cropped
60   0x03 -> 176x144, cropped
61   0x04 -> 176x144, binned
62   0x05 -> 320x240
63   0x06 -> 320x240
64   0x07 -> 160x120, cropped
65   0x08 -> 160x120, cropped
66   0x09 -> 160x120, binned (note has 136 lines)
67   0x0a -> 160x120, binned (note has 136 lines)
68   0x0b -> 160x120, cropped
69*/
70static const struct v4l2_pix_format vga_mode[] = {
71	{160, 120, V4L2_PIX_FMT_KONICA420, V4L2_FIELD_NONE,
72		.bytesperline = 160,
73		.sizeimage = 160 * 136 * 3 / 2 + 960,
74		.colorspace = V4L2_COLORSPACE_SRGB,
75		.priv = 0x0a},
76	{176, 144, V4L2_PIX_FMT_KONICA420, V4L2_FIELD_NONE,
77		.bytesperline = 176,
78		.sizeimage = 176 * 144 * 3 / 2 + 960,
79		.colorspace = V4L2_COLORSPACE_SRGB,
80		.priv = 0x04},
81	{320, 240, V4L2_PIX_FMT_KONICA420, V4L2_FIELD_NONE,
82		.bytesperline = 320,
83		.sizeimage = 320 * 240 * 3 / 2 + 960,
84		.colorspace = V4L2_COLORSPACE_SRGB,
85		.priv = 0x05},
86};
87
88static void sd_isoc_irq(struct urb *urb);
89
90static void reg_w(struct gspca_dev *gspca_dev, u16 value, u16 index)
91{
92	struct usb_device *dev = gspca_dev->dev;
93	int ret;
94
95	if (gspca_dev->usb_err < 0)
96		return;
97	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
98			0x02,
99			USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
100			value,
101			index,
102			NULL,
103			0,
104			1000);
105	if (ret < 0) {
106		pr_err("reg_w err writing %02x to %02x: %d\n",
107		       value, index, ret);
108		gspca_dev->usb_err = ret;
109	}
110}
111
112static void reg_r(struct gspca_dev *gspca_dev, u16 value, u16 index)
113{
114	struct usb_device *dev = gspca_dev->dev;
115	int ret;
116
117	if (gspca_dev->usb_err < 0)
118		return;
119	ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
120			0x03,
121			USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
122			value,
123			index,
124			gspca_dev->usb_buf,
125			2,
126			1000);
127	if (ret < 0) {
128		pr_err("reg_r err %d\n", ret);
129		gspca_dev->usb_err = ret;
130	}
131}
132
133static void konica_stream_on(struct gspca_dev *gspca_dev)
134{
135	reg_w(gspca_dev, 1, 0x0b);
136}
137
138static void konica_stream_off(struct gspca_dev *gspca_dev)
139{
140	reg_w(gspca_dev, 0, 0x0b);
141}
142
143/* this function is called at probe time */
144static int sd_config(struct gspca_dev *gspca_dev,
145			const struct usb_device_id *id)
146{
147	gspca_dev->cam.cam_mode = vga_mode;
148	gspca_dev->cam.nmodes = ARRAY_SIZE(vga_mode);
149	gspca_dev->cam.no_urb_create = 1;
150
151	return 0;
152}
153
154/* this function is called at probe and resume time */
155static int sd_init(struct gspca_dev *gspca_dev)
156{
157	int i;
158
159	/*
160	 * The konica needs a freaking large time to "boot" (approx 6.5 sec.),
161	 * and does not want to be bothered while doing so :|
162	 * Register 0x10 counts from 1 - 3, with 3 being "ready"
163	 */
164	msleep(6000);
165	for (i = 0; i < 20; i++) {
166		reg_r(gspca_dev, 0, 0x10);
167		if (gspca_dev->usb_buf[0] == 3)
168			break;
169		msleep(100);
170	}
171	reg_w(gspca_dev, 0, 0x0d);
172
173	return gspca_dev->usb_err;
174}
175
176static int sd_start(struct gspca_dev *gspca_dev)
177{
178	struct sd *sd = (struct sd *) gspca_dev;
179	struct urb *urb;
180	int i, n, packet_size;
181	struct usb_host_interface *alt;
182	struct usb_interface *intf;
183
184	intf = usb_ifnum_to_if(sd->gspca_dev.dev, sd->gspca_dev.iface);
185	alt = usb_altnum_to_altsetting(intf, sd->gspca_dev.alt);
186	if (!alt) {
187		pr_err("Couldn't get altsetting\n");
188		return -EIO;
189	}
190
191	packet_size = le16_to_cpu(alt->endpoint[0].desc.wMaxPacketSize);
192
193	n = gspca_dev->cam.cam_mode[gspca_dev->curr_mode].priv;
194	reg_w(gspca_dev, n, 0x08);
195
196	konica_stream_on(gspca_dev);
197
198	if (gspca_dev->usb_err)
199		return gspca_dev->usb_err;
200
201	/* create 4 URBs - 2 on endpoint 0x83 and 2 on 0x082 */
202#if MAX_NURBS < 4
203#error "Not enough URBs in the gspca table"
204#endif
205#define SD_NPKT 32
206	for (n = 0; n < 4; n++) {
207		i = n & 1 ? 0 : 1;
208		packet_size =
209			le16_to_cpu(alt->endpoint[i].desc.wMaxPacketSize);
210		urb = usb_alloc_urb(SD_NPKT, GFP_KERNEL);
211		if (!urb) {
212			pr_err("usb_alloc_urb failed\n");
213			return -ENOMEM;
214		}
215		gspca_dev->urb[n] = urb;
216		urb->transfer_buffer = usb_alloc_coherent(gspca_dev->dev,
217						packet_size * SD_NPKT,
218						GFP_KERNEL,
219						&urb->transfer_dma);
220		if (urb->transfer_buffer == NULL) {
221			pr_err("usb_buffer_alloc failed\n");
222			return -ENOMEM;
223		}
224
225		urb->dev = gspca_dev->dev;
226		urb->context = gspca_dev;
227		urb->transfer_buffer_length = packet_size * SD_NPKT;
228		urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
229					n & 1 ? 0x81 : 0x82);
230		urb->transfer_flags = URB_ISO_ASAP
231					| URB_NO_TRANSFER_DMA_MAP;
232		urb->interval = 1;
233		urb->complete = sd_isoc_irq;
234		urb->number_of_packets = SD_NPKT;
235		for (i = 0; i < SD_NPKT; i++) {
236			urb->iso_frame_desc[i].length = packet_size;
237			urb->iso_frame_desc[i].offset = packet_size * i;
238		}
239	}
240
241	return 0;
242}
243
244static void sd_stopN(struct gspca_dev *gspca_dev)
245{
246	struct sd *sd = (struct sd *) gspca_dev;
247
248	konica_stream_off(gspca_dev);
249#if IS_ENABLED(CONFIG_INPUT)
250	/* Don't keep the button in the pressed state "forever" if it was
251	   pressed when streaming is stopped */
252	if (sd->snapshot_pressed) {
253		input_report_key(gspca_dev->input_dev, KEY_CAMERA, 0);
254		input_sync(gspca_dev->input_dev);
255		sd->snapshot_pressed = 0;
256	}
257#endif
258}
259
260/* reception of an URB */
261static void sd_isoc_irq(struct urb *urb)
262{
263	struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
264	struct sd *sd = (struct sd *) gspca_dev;
265	struct urb *data_urb, *status_urb;
266	u8 *data;
267	int i, st;
268
269	PDEBUG(D_PACK, "sd isoc irq");
270	if (!gspca_dev->streaming)
271		return;
272
273	if (urb->status != 0) {
274		if (urb->status == -ESHUTDOWN)
275			return;		/* disconnection */
276#ifdef CONFIG_PM
277		if (gspca_dev->frozen)
278			return;
279#endif
280		PERR("urb status: %d", urb->status);
281		st = usb_submit_urb(urb, GFP_ATOMIC);
282		if (st < 0)
283			pr_err("resubmit urb error %d\n", st);
284		return;
285	}
286
287	/* if this is a data URB (ep 0x82), wait */
288	if (urb->transfer_buffer_length > 32) {
289		sd->last_data_urb = urb;
290		return;
291	}
292
293	status_urb = urb;
294	data_urb   = sd->last_data_urb;
295	sd->last_data_urb = NULL;
296
297	if (!data_urb || data_urb->start_frame != status_urb->start_frame) {
298		PERR("lost sync on frames");
299		goto resubmit;
300	}
301
302	if (data_urb->number_of_packets != status_urb->number_of_packets) {
303		PERR("no packets does not match, data: %d, status: %d",
304		     data_urb->number_of_packets,
305		     status_urb->number_of_packets);
306		goto resubmit;
307	}
308
309	for (i = 0; i < status_urb->number_of_packets; i++) {
310		if (data_urb->iso_frame_desc[i].status ||
311		    status_urb->iso_frame_desc[i].status) {
312			PERR("pkt %d data-status %d, status-status %d", i,
313			     data_urb->iso_frame_desc[i].status,
314			     status_urb->iso_frame_desc[i].status);
315			gspca_dev->last_packet_type = DISCARD_PACKET;
316			continue;
317		}
318
319		if (status_urb->iso_frame_desc[i].actual_length != 1) {
320			PERR("bad status packet length %d",
321			     status_urb->iso_frame_desc[i].actual_length);
322			gspca_dev->last_packet_type = DISCARD_PACKET;
323			continue;
324		}
325
326		st = *((u8 *)status_urb->transfer_buffer
327				+ status_urb->iso_frame_desc[i].offset);
328
329		data = (u8 *)data_urb->transfer_buffer
330				+ data_urb->iso_frame_desc[i].offset;
331
332		/* st: 0x80-0xff: frame start with frame number (ie 0-7f)
333		 * otherwise:
334		 * bit 0 0: keep packet
335		 *	 1: drop packet (padding data)
336		 *
337		 * bit 4 0 button not clicked
338		 *       1 button clicked
339		 * button is used to `take a picture' (in software)
340		 */
341		if (st & 0x80) {
342			gspca_frame_add(gspca_dev, LAST_PACKET, NULL, 0);
343			gspca_frame_add(gspca_dev, FIRST_PACKET, NULL, 0);
344		} else {
345#if IS_ENABLED(CONFIG_INPUT)
346			u8 button_state = st & 0x40 ? 1 : 0;
347			if (sd->snapshot_pressed != button_state) {
348				input_report_key(gspca_dev->input_dev,
349						 KEY_CAMERA,
350						 button_state);
351				input_sync(gspca_dev->input_dev);
352				sd->snapshot_pressed = button_state;
353			}
354#endif
355			if (st & 0x01)
356				continue;
357		}
358		gspca_frame_add(gspca_dev, INTER_PACKET, data,
359				data_urb->iso_frame_desc[i].actual_length);
360	}
361
362resubmit:
363	if (data_urb) {
364		st = usb_submit_urb(data_urb, GFP_ATOMIC);
365		if (st < 0)
366			PERR("usb_submit_urb(data_urb) ret %d", st);
367	}
368	st = usb_submit_urb(status_urb, GFP_ATOMIC);
369	if (st < 0)
370		PERR("usb_submit_urb(status_urb) ret %d\n", st);
371}
372
373static int sd_s_ctrl(struct v4l2_ctrl *ctrl)
374{
375	struct gspca_dev *gspca_dev =
376		container_of(ctrl->handler, struct gspca_dev, ctrl_handler);
377
378	gspca_dev->usb_err = 0;
379
380	if (!gspca_dev->streaming)
381		return 0;
382
383	switch (ctrl->id) {
384	case V4L2_CID_BRIGHTNESS:
385		konica_stream_off(gspca_dev);
386		reg_w(gspca_dev, ctrl->val, BRIGHTNESS_REG);
387		konica_stream_on(gspca_dev);
388		break;
389	case V4L2_CID_CONTRAST:
390		konica_stream_off(gspca_dev);
391		reg_w(gspca_dev, ctrl->val, CONTRAST_REG);
392		konica_stream_on(gspca_dev);
393		break;
394	case V4L2_CID_SATURATION:
395		konica_stream_off(gspca_dev);
396		reg_w(gspca_dev, ctrl->val, SATURATION_REG);
397		konica_stream_on(gspca_dev);
398		break;
399	case V4L2_CID_WHITE_BALANCE_TEMPERATURE:
400		konica_stream_off(gspca_dev);
401		reg_w(gspca_dev, ctrl->val, WHITEBAL_REG);
402		konica_stream_on(gspca_dev);
403		break;
404	case V4L2_CID_SHARPNESS:
405		konica_stream_off(gspca_dev);
406		reg_w(gspca_dev, ctrl->val, SHARPNESS_REG);
407		konica_stream_on(gspca_dev);
408		break;
409	}
410	return gspca_dev->usb_err;
411}
412
413static const struct v4l2_ctrl_ops sd_ctrl_ops = {
414	.s_ctrl = sd_s_ctrl,
415};
416
417static int sd_init_controls(struct gspca_dev *gspca_dev)
418{
419	struct v4l2_ctrl_handler *hdl = &gspca_dev->ctrl_handler;
420
421	gspca_dev->vdev.ctrl_handler = hdl;
422	v4l2_ctrl_handler_init(hdl, 5);
423	v4l2_ctrl_new_std(hdl, &sd_ctrl_ops,
424			V4L2_CID_BRIGHTNESS, 0, 9, 1, 4);
425	/* Needs to be verified */
426	v4l2_ctrl_new_std(hdl, &sd_ctrl_ops,
427			V4L2_CID_CONTRAST, 0, 9, 1, 4);
428	v4l2_ctrl_new_std(hdl, &sd_ctrl_ops,
429			V4L2_CID_SATURATION, 0, 9, 1, 4);
430	v4l2_ctrl_new_std(hdl, &sd_ctrl_ops,
431			V4L2_CID_WHITE_BALANCE_TEMPERATURE,
432			0, 33, 1, 25);
433	v4l2_ctrl_new_std(hdl, &sd_ctrl_ops,
434			V4L2_CID_SHARPNESS, 0, 9, 1, 4);
435
436	if (hdl->error) {
437		pr_err("Could not initialize controls\n");
438		return hdl->error;
439	}
440	return 0;
441}
442
443/* sub-driver description */
444static const struct sd_desc sd_desc = {
445	.name = MODULE_NAME,
446	.config = sd_config,
447	.init = sd_init,
448	.init_controls = sd_init_controls,
449	.start = sd_start,
450	.stopN = sd_stopN,
451#if IS_ENABLED(CONFIG_INPUT)
452	.other_input = 1,
453#endif
454};
455
456/* -- module initialisation -- */
457static const struct usb_device_id device_table[] = {
458	{USB_DEVICE(0x04c8, 0x0720)}, /* Intel YC 76 */
459	{}
460};
461MODULE_DEVICE_TABLE(usb, device_table);
462
463/* -- device connect -- */
464static int sd_probe(struct usb_interface *intf,
465			const struct usb_device_id *id)
466{
467	return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
468				THIS_MODULE);
469}
470
471static struct usb_driver sd_driver = {
472	.name = MODULE_NAME,
473	.id_table = device_table,
474	.probe = sd_probe,
475	.disconnect = gspca_disconnect,
476#ifdef CONFIG_PM
477	.suspend = gspca_suspend,
478	.resume = gspca_resume,
479	.reset_resume = gspca_resume,
480#endif
481};
482
483module_usb_driver(sd_driver);
484