2 * Driver for USB webcams based on Konica chipset. This
3 * chipset is used in Intel YC76 camera.
5 * Copyright (C) 2010 Hans de Goede <hdegoede@redhat.com>
7 * Based on the usbvideo v4l1 konicawc driver which is:
9 * Copyright (C) 2002 Simon Evans <spse@secret.org.uk>
11 * The code for making gspca work with a webcam with 2 isoc endpoints was
12 * taken from the benq gspca subdriver which is:
14 * Copyright (C) 2009 Jean-Francois Moine (http://moinejf.free.fr)
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
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.
27 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
29 #define MODULE_NAME "konica"
31 #include <linux/input.h>
34 MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
35 MODULE_DESCRIPTION("Konica chipset USB Camera Driver");
36 MODULE_LICENSE("GPL");
38 #define WHITEBAL_REG 0x01
39 #define BRIGHTNESS_REG 0x02
40 #define SHARPNESS_REG 0x03
41 #define CONTRAST_REG 0x04
42 #define SATURATION_REG 0x05
44 /* specific webcam descriptor */
46 struct gspca_dev gspca_dev; /* !! must be the first item */
47 struct urb *last_data_urb;
52 /* .priv is what goes to register 8 for this mode, known working values:
53 0x00 -> 176x144, cropped
54 0x01 -> 176x144, cropped
55 0x02 -> 176x144, cropped
56 0x03 -> 176x144, cropped
57 0x04 -> 176x144, binned
60 0x07 -> 160x120, cropped
61 0x08 -> 160x120, cropped
62 0x09 -> 160x120, binned (note has 136 lines)
63 0x0a -> 160x120, binned (note has 136 lines)
64 0x0b -> 160x120, cropped
66 static const struct v4l2_pix_format vga_mode[] = {
67 {160, 120, V4L2_PIX_FMT_KONICA420, V4L2_FIELD_NONE,
69 .sizeimage = 160 * 136 * 3 / 2 + 960,
70 .colorspace = V4L2_COLORSPACE_SRGB,
72 {176, 144, V4L2_PIX_FMT_KONICA420, V4L2_FIELD_NONE,
74 .sizeimage = 176 * 144 * 3 / 2 + 960,
75 .colorspace = V4L2_COLORSPACE_SRGB,
77 {320, 240, V4L2_PIX_FMT_KONICA420, V4L2_FIELD_NONE,
79 .sizeimage = 320 * 240 * 3 / 2 + 960,
80 .colorspace = V4L2_COLORSPACE_SRGB,
84 static void sd_isoc_irq(struct urb *urb);
86 static void reg_w(struct gspca_dev *gspca_dev, u16 value, u16 index)
88 struct usb_device *dev = gspca_dev->dev;
91 if (gspca_dev->usb_err < 0)
93 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
95 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
102 pr_err("reg_w err writing %02x to %02x: %d\n",
104 gspca_dev->usb_err = ret;
108 static void reg_r(struct gspca_dev *gspca_dev, u16 value, u16 index)
110 struct usb_device *dev = gspca_dev->dev;
113 if (gspca_dev->usb_err < 0)
115 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
117 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
124 pr_err("reg_r err %d\n", ret);
125 gspca_dev->usb_err = ret;
129 static void konica_stream_on(struct gspca_dev *gspca_dev)
131 reg_w(gspca_dev, 1, 0x0b);
134 static void konica_stream_off(struct gspca_dev *gspca_dev)
136 reg_w(gspca_dev, 0, 0x0b);
139 /* this function is called at probe time */
140 static int sd_config(struct gspca_dev *gspca_dev,
141 const struct usb_device_id *id)
143 gspca_dev->cam.cam_mode = vga_mode;
144 gspca_dev->cam.nmodes = ARRAY_SIZE(vga_mode);
145 gspca_dev->cam.no_urb_create = 1;
150 /* this function is called at probe and resume time */
151 static int sd_init(struct gspca_dev *gspca_dev)
156 * The konica needs a freaking large time to "boot" (approx 6.5 sec.),
157 * and does not want to be bothered while doing so :|
158 * Register 0x10 counts from 1 - 3, with 3 being "ready"
161 for (i = 0; i < 20; i++) {
162 reg_r(gspca_dev, 0, 0x10);
163 if (gspca_dev->usb_buf[0] == 3)
167 reg_w(gspca_dev, 0, 0x0d);
169 return gspca_dev->usb_err;
172 static int sd_start(struct gspca_dev *gspca_dev)
174 struct sd *sd = (struct sd *) gspca_dev;
176 int i, n, packet_size;
177 struct usb_host_interface *alt;
178 struct usb_interface *intf;
180 intf = usb_ifnum_to_if(sd->gspca_dev.dev, sd->gspca_dev.iface);
181 alt = usb_altnum_to_altsetting(intf, sd->gspca_dev.alt);
183 pr_err("Couldn't get altsetting\n");
187 if (alt->desc.bNumEndpoints < 2)
190 packet_size = le16_to_cpu(alt->endpoint[0].desc.wMaxPacketSize);
192 n = gspca_dev->cam.cam_mode[gspca_dev->curr_mode].priv;
193 reg_w(gspca_dev, n, 0x08);
195 konica_stream_on(gspca_dev);
197 if (gspca_dev->usb_err)
198 return gspca_dev->usb_err;
200 /* create 4 URBs - 2 on endpoint 0x83 and 2 on 0x082 */
202 #error "Not enough URBs in the gspca table"
205 for (n = 0; n < 4; n++) {
208 le16_to_cpu(alt->endpoint[i].desc.wMaxPacketSize);
209 urb = usb_alloc_urb(SD_NPKT, GFP_KERNEL);
212 gspca_dev->urb[n] = urb;
213 urb->transfer_buffer = usb_alloc_coherent(gspca_dev->dev,
214 packet_size * SD_NPKT,
217 if (urb->transfer_buffer == NULL) {
218 pr_err("usb_buffer_alloc failed\n");
222 urb->dev = gspca_dev->dev;
223 urb->context = gspca_dev;
224 urb->transfer_buffer_length = packet_size * SD_NPKT;
225 urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
226 n & 1 ? 0x81 : 0x82);
227 urb->transfer_flags = URB_ISO_ASAP
228 | URB_NO_TRANSFER_DMA_MAP;
230 urb->complete = sd_isoc_irq;
231 urb->number_of_packets = SD_NPKT;
232 for (i = 0; i < SD_NPKT; i++) {
233 urb->iso_frame_desc[i].length = packet_size;
234 urb->iso_frame_desc[i].offset = packet_size * i;
241 static void sd_stopN(struct gspca_dev *gspca_dev)
243 struct sd *sd __maybe_unused = (struct sd *) gspca_dev;
245 konica_stream_off(gspca_dev);
246 #if IS_ENABLED(CONFIG_INPUT)
247 /* Don't keep the button in the pressed state "forever" if it was
248 pressed when streaming is stopped */
249 if (sd->snapshot_pressed) {
250 input_report_key(gspca_dev->input_dev, KEY_CAMERA, 0);
251 input_sync(gspca_dev->input_dev);
252 sd->snapshot_pressed = 0;
257 /* reception of an URB */
258 static void sd_isoc_irq(struct urb *urb)
260 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
261 struct sd *sd = (struct sd *) gspca_dev;
262 struct urb *data_urb, *status_urb;
266 PDEBUG(D_PACK, "sd isoc irq");
267 if (!gspca_dev->streaming)
270 if (urb->status != 0) {
271 if (urb->status == -ESHUTDOWN)
272 return; /* disconnection */
274 if (gspca_dev->frozen)
277 PERR("urb status: %d", urb->status);
278 st = usb_submit_urb(urb, GFP_ATOMIC);
280 pr_err("resubmit urb error %d\n", st);
284 /* if this is a data URB (ep 0x82), wait */
285 if (urb->transfer_buffer_length > 32) {
286 sd->last_data_urb = urb;
291 data_urb = sd->last_data_urb;
292 sd->last_data_urb = NULL;
294 if (!data_urb || data_urb->start_frame != status_urb->start_frame) {
295 PERR("lost sync on frames");
299 if (data_urb->number_of_packets != status_urb->number_of_packets) {
300 PERR("no packets does not match, data: %d, status: %d",
301 data_urb->number_of_packets,
302 status_urb->number_of_packets);
306 for (i = 0; i < status_urb->number_of_packets; i++) {
307 if (data_urb->iso_frame_desc[i].status ||
308 status_urb->iso_frame_desc[i].status) {
309 PERR("pkt %d data-status %d, status-status %d", i,
310 data_urb->iso_frame_desc[i].status,
311 status_urb->iso_frame_desc[i].status);
312 gspca_dev->last_packet_type = DISCARD_PACKET;
316 if (status_urb->iso_frame_desc[i].actual_length != 1) {
317 PERR("bad status packet length %d",
318 status_urb->iso_frame_desc[i].actual_length);
319 gspca_dev->last_packet_type = DISCARD_PACKET;
323 st = *((u8 *)status_urb->transfer_buffer
324 + status_urb->iso_frame_desc[i].offset);
326 data = (u8 *)data_urb->transfer_buffer
327 + data_urb->iso_frame_desc[i].offset;
329 /* st: 0x80-0xff: frame start with frame number (ie 0-7f)
331 * bit 0 0: keep packet
332 * 1: drop packet (padding data)
334 * bit 4 0 button not clicked
336 * button is used to `take a picture' (in software)
339 gspca_frame_add(gspca_dev, LAST_PACKET, NULL, 0);
340 gspca_frame_add(gspca_dev, FIRST_PACKET, NULL, 0);
342 #if IS_ENABLED(CONFIG_INPUT)
343 u8 button_state = st & 0x40 ? 1 : 0;
344 if (sd->snapshot_pressed != button_state) {
345 input_report_key(gspca_dev->input_dev,
348 input_sync(gspca_dev->input_dev);
349 sd->snapshot_pressed = button_state;
355 gspca_frame_add(gspca_dev, INTER_PACKET, data,
356 data_urb->iso_frame_desc[i].actual_length);
361 st = usb_submit_urb(data_urb, GFP_ATOMIC);
363 PERR("usb_submit_urb(data_urb) ret %d", st);
365 st = usb_submit_urb(status_urb, GFP_ATOMIC);
367 PERR("usb_submit_urb(status_urb) ret %d\n", st);
370 static int sd_s_ctrl(struct v4l2_ctrl *ctrl)
372 struct gspca_dev *gspca_dev =
373 container_of(ctrl->handler, struct gspca_dev, ctrl_handler);
375 gspca_dev->usb_err = 0;
377 if (!gspca_dev->streaming)
381 case V4L2_CID_BRIGHTNESS:
382 konica_stream_off(gspca_dev);
383 reg_w(gspca_dev, ctrl->val, BRIGHTNESS_REG);
384 konica_stream_on(gspca_dev);
386 case V4L2_CID_CONTRAST:
387 konica_stream_off(gspca_dev);
388 reg_w(gspca_dev, ctrl->val, CONTRAST_REG);
389 konica_stream_on(gspca_dev);
391 case V4L2_CID_SATURATION:
392 konica_stream_off(gspca_dev);
393 reg_w(gspca_dev, ctrl->val, SATURATION_REG);
394 konica_stream_on(gspca_dev);
396 case V4L2_CID_WHITE_BALANCE_TEMPERATURE:
397 konica_stream_off(gspca_dev);
398 reg_w(gspca_dev, ctrl->val, WHITEBAL_REG);
399 konica_stream_on(gspca_dev);
401 case V4L2_CID_SHARPNESS:
402 konica_stream_off(gspca_dev);
403 reg_w(gspca_dev, ctrl->val, SHARPNESS_REG);
404 konica_stream_on(gspca_dev);
407 return gspca_dev->usb_err;
410 static const struct v4l2_ctrl_ops sd_ctrl_ops = {
414 static int sd_init_controls(struct gspca_dev *gspca_dev)
416 struct v4l2_ctrl_handler *hdl = &gspca_dev->ctrl_handler;
418 gspca_dev->vdev.ctrl_handler = hdl;
419 v4l2_ctrl_handler_init(hdl, 5);
420 v4l2_ctrl_new_std(hdl, &sd_ctrl_ops,
421 V4L2_CID_BRIGHTNESS, 0, 9, 1, 4);
422 /* Needs to be verified */
423 v4l2_ctrl_new_std(hdl, &sd_ctrl_ops,
424 V4L2_CID_CONTRAST, 0, 9, 1, 4);
425 v4l2_ctrl_new_std(hdl, &sd_ctrl_ops,
426 V4L2_CID_SATURATION, 0, 9, 1, 4);
427 v4l2_ctrl_new_std(hdl, &sd_ctrl_ops,
428 V4L2_CID_WHITE_BALANCE_TEMPERATURE,
430 v4l2_ctrl_new_std(hdl, &sd_ctrl_ops,
431 V4L2_CID_SHARPNESS, 0, 9, 1, 4);
434 pr_err("Could not initialize controls\n");
440 /* sub-driver description */
441 static const struct sd_desc sd_desc = {
445 .init_controls = sd_init_controls,
448 #if IS_ENABLED(CONFIG_INPUT)
453 /* -- module initialisation -- */
454 static const struct usb_device_id device_table[] = {
455 {USB_DEVICE(0x04c8, 0x0720)}, /* Intel YC 76 */
458 MODULE_DEVICE_TABLE(usb, device_table);
460 /* -- device connect -- */
461 static int sd_probe(struct usb_interface *intf,
462 const struct usb_device_id *id)
464 return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
468 static struct usb_driver sd_driver = {
470 .id_table = device_table,
472 .disconnect = gspca_disconnect,
474 .suspend = gspca_suspend,
475 .resume = gspca_resume,
476 .reset_resume = gspca_resume,
480 module_usb_driver(sd_driver);