drivers/media/usb/gspca/konica.c

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