usb/gspca/stv0680.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  * STV0680 USB Camera Driver
0004  *
0005  * Copyright (C) 2009 Hans de Goede <hdegoede@redhat.com>
0006  *
0007  * This module is adapted from the in kernel v4l1 stv680 driver:
0008  *
0009  *  STV0680 USB Camera Driver, by Kevin Sisson (kjsisson@bellsouth.net)
0010  *
0011  * Thanks to STMicroelectronics for information on the usb commands, and
0012  * to Steve Miller at STM for his help and encouragement while I was
0013  * writing this driver.
0014  */
0015
0016 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
0017
0018 #define MODULE_NAME "stv0680"
0019
0020 #include "gspca.h"
0021
0022 MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
0023 MODULE_DESCRIPTION("STV0680 USB Camera Driver");
0024 MODULE_LICENSE("GPL");
0025
0026 /* specific webcam descriptor */
0027 struct sd {
0028     struct gspca_dev gspca_dev;     /* !! must be the first item */
0029     struct v4l2_pix_format mode;
0030     u8 orig_mode;
0031     u8 video_mode;
0032     u8 current_mode;
0033 };
0034
0035 static int stv_sndctrl(struct gspca_dev *gspca_dev, int set, u8 req, u16 val,
0036                int size)
0037 {
0038     int ret;
0039     u8 req_type = 0;
0040     unsigned int pipe = 0;
0041
0042     switch (set) {
0043     case 0: /*  0xc1  */
0044         req_type = USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT;
0045         pipe = usb_rcvctrlpipe(gspca_dev->dev, 0);
0046         break;
0047     case 1: /*  0x41  */
0048         req_type = USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT;
0049         pipe = usb_sndctrlpipe(gspca_dev->dev, 0);
0050         break;
0051     case 2: /*  0x80  */
0052         req_type = USB_DIR_IN | USB_RECIP_DEVICE;
0053         pipe = usb_rcvctrlpipe(gspca_dev->dev, 0);
0054         break;
0055     case 3: /*  0x40  */
0056         req_type = USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE;
0057         pipe = usb_sndctrlpipe(gspca_dev->dev, 0);
0058         break;
0059     }
0060
0061     ret = usb_control_msg(gspca_dev->dev, pipe,
0062                   req, req_type,
0063                   val, 0, gspca_dev->usb_buf, size, 500);
0064
0065     if ((ret < 0) && (req != 0x0a))
0066         pr_err("usb_control_msg error %i, request = 0x%x, error = %i\n",
0067                set, req, ret);
0068
0069     return ret;
0070 }
0071
0072 static int stv0680_handle_error(struct gspca_dev *gspca_dev, int ret)
0073 {
0074     stv_sndctrl(gspca_dev, 0, 0x80, 0, 0x02); /* Get Last Error */
0075     gspca_err(gspca_dev, "last error: %i,  command = 0x%x\n",
0076           gspca_dev->usb_buf[0], gspca_dev->usb_buf[1]);
0077     return ret;
0078 }
0079
0080 static int stv0680_get_video_mode(struct gspca_dev *gspca_dev)
0081 {
0082     /* Note not sure if this init of usb_buf is really necessary */
0083     memset(gspca_dev->usb_buf, 0, 8);
0084     gspca_dev->usb_buf[0] = 0x0f;
0085
0086     if (stv_sndctrl(gspca_dev, 0, 0x87, 0, 0x08) != 0x08) {
0087         gspca_err(gspca_dev, "Get_Camera_Mode failed\n");
0088         return stv0680_handle_error(gspca_dev, -EIO);
0089     }
0090
0091     return gspca_dev->usb_buf[0]; /* 01 = VGA, 03 = QVGA, 00 = CIF */
0092 }
0093
0094 static int stv0680_set_video_mode(struct gspca_dev *gspca_dev, u8 mode)
0095 {
0096     struct sd *sd = (struct sd *) gspca_dev;
0097
0098     if (sd->current_mode == mode)
0099         return 0;
0100
0101     memset(gspca_dev->usb_buf, 0, 8);
0102     gspca_dev->usb_buf[0] = mode;
0103
0104     if (stv_sndctrl(gspca_dev, 3, 0x07, 0x0100, 0x08) != 0x08) {
0105         gspca_err(gspca_dev, "Set_Camera_Mode failed\n");
0106         return stv0680_handle_error(gspca_dev, -EIO);
0107     }
0108
0109     /* Verify we got what we've asked for */
0110     if (stv0680_get_video_mode(gspca_dev) != mode) {
0111         gspca_err(gspca_dev, "Error setting camera video mode!\n");
0112         return -EIO;
0113     }
0114
0115     sd->current_mode = mode;
0116
0117     return 0;
0118 }
0119
0120 /* this function is called at probe time */
0121 static int sd_config(struct gspca_dev *gspca_dev,
0122             const struct usb_device_id *id)
0123 {
0124     int ret;
0125     struct sd *sd = (struct sd *) gspca_dev;
0126     struct cam *cam = &gspca_dev->cam;
0127
0128     /* Give the camera some time to settle, otherwise initialization will
0129        fail on hotplug, and yes it really needs a full second. */
0130     msleep(1000);
0131
0132     /* ping camera to be sure STV0680 is present */
0133     if (stv_sndctrl(gspca_dev, 0, 0x88, 0x5678, 0x02) != 0x02 ||
0134         gspca_dev->usb_buf[0] != 0x56 || gspca_dev->usb_buf[1] != 0x78) {
0135         gspca_err(gspca_dev, "STV(e): camera ping failed!!\n");
0136         return stv0680_handle_error(gspca_dev, -ENODEV);
0137     }
0138
0139     /* get camera descriptor */
0140     if (stv_sndctrl(gspca_dev, 2, 0x06, 0x0200, 0x09) != 0x09)
0141         return stv0680_handle_error(gspca_dev, -ENODEV);
0142
0143     if (stv_sndctrl(gspca_dev, 2, 0x06, 0x0200, 0x22) != 0x22 ||
0144         gspca_dev->usb_buf[7] != 0xa0 || gspca_dev->usb_buf[8] != 0x23) {
0145         gspca_err(gspca_dev, "Could not get descriptor 0200\n");
0146         return stv0680_handle_error(gspca_dev, -ENODEV);
0147     }
0148     if (stv_sndctrl(gspca_dev, 0, 0x8a, 0, 0x02) != 0x02)
0149         return stv0680_handle_error(gspca_dev, -ENODEV);
0150     if (stv_sndctrl(gspca_dev, 0, 0x8b, 0, 0x24) != 0x24)
0151         return stv0680_handle_error(gspca_dev, -ENODEV);
0152     if (stv_sndctrl(gspca_dev, 0, 0x85, 0, 0x10) != 0x10)
0153         return stv0680_handle_error(gspca_dev, -ENODEV);
0154
0155     if (!(gspca_dev->usb_buf[7] & 0x09)) {
0156         gspca_err(gspca_dev, "Camera supports neither CIF nor QVGA mode\n");
0157         return -ENODEV;
0158     }
0159     if (gspca_dev->usb_buf[7] & 0x01)
0160         gspca_dbg(gspca_dev, D_PROBE, "Camera supports CIF mode\n");
0161     if (gspca_dev->usb_buf[7] & 0x02)
0162         gspca_dbg(gspca_dev, D_PROBE, "Camera supports VGA mode\n");
0163     if (gspca_dev->usb_buf[7] & 0x04)
0164         gspca_dbg(gspca_dev, D_PROBE, "Camera supports QCIF mode\n");
0165     if (gspca_dev->usb_buf[7] & 0x08)
0166         gspca_dbg(gspca_dev, D_PROBE, "Camera supports QVGA mode\n");
0167
0168     if (gspca_dev->usb_buf[7] & 0x01)
0169         sd->video_mode = 0x00; /* CIF */
0170     else
0171         sd->video_mode = 0x03; /* QVGA */
0172
0173     /* FW rev, ASIC rev, sensor ID  */
0174     gspca_dbg(gspca_dev, D_PROBE, "Firmware rev is %i.%i\n",
0175           gspca_dev->usb_buf[0], gspca_dev->usb_buf[1]);
0176     gspca_dbg(gspca_dev, D_PROBE, "ASIC rev is %i.%i",
0177           gspca_dev->usb_buf[2], gspca_dev->usb_buf[3]);
0178     gspca_dbg(gspca_dev, D_PROBE, "Sensor ID is %i",
0179           (gspca_dev->usb_buf[4]*16) + (gspca_dev->usb_buf[5]>>4));
0180
0181
0182     ret = stv0680_get_video_mode(gspca_dev);
0183     if (ret < 0)
0184         return ret;
0185     sd->current_mode = sd->orig_mode = ret;
0186
0187     ret = stv0680_set_video_mode(gspca_dev, sd->video_mode);
0188     if (ret < 0)
0189         return ret;
0190
0191     /* Get mode details */
0192     if (stv_sndctrl(gspca_dev, 0, 0x8f, 0, 0x10) != 0x10)
0193         return stv0680_handle_error(gspca_dev, -EIO);
0194
0195     cam->bulk = 1;
0196     cam->bulk_nurbs = 1; /* The cam cannot handle more */
0197     cam->bulk_size = (gspca_dev->usb_buf[0] << 24) |
0198              (gspca_dev->usb_buf[1] << 16) |
0199              (gspca_dev->usb_buf[2] << 8) |
0200              (gspca_dev->usb_buf[3]);
0201     sd->mode.width = (gspca_dev->usb_buf[4] << 8) |
0202              (gspca_dev->usb_buf[5]);  /* 322, 356, 644 */
0203     sd->mode.height = (gspca_dev->usb_buf[6] << 8) |
0204               (gspca_dev->usb_buf[7]); /* 242, 292, 484 */
0205     sd->mode.pixelformat = V4L2_PIX_FMT_STV0680;
0206     sd->mode.field = V4L2_FIELD_NONE;
0207     sd->mode.bytesperline = sd->mode.width;
0208     sd->mode.sizeimage = cam->bulk_size;
0209     sd->mode.colorspace = V4L2_COLORSPACE_SRGB;
0210
0211     /* origGain = gspca_dev->usb_buf[12]; */
0212
0213     cam->cam_mode = &sd->mode;
0214     cam->nmodes = 1;
0215
0216
0217     ret = stv0680_set_video_mode(gspca_dev, sd->orig_mode);
0218     if (ret < 0)
0219         return ret;
0220
0221     if (stv_sndctrl(gspca_dev, 2, 0x06, 0x0100, 0x12) != 0x12 ||
0222         gspca_dev->usb_buf[8] != 0x53 || gspca_dev->usb_buf[9] != 0x05) {
0223         pr_err("Could not get descriptor 0100\n");
0224         return stv0680_handle_error(gspca_dev, -EIO);
0225     }
0226
0227     return 0;
0228 }
0229
0230 /* this function is called at probe and resume time */
0231 static int sd_init(struct gspca_dev *gspca_dev)
0232 {
0233     return 0;
0234 }
0235
0236 /* -- start the camera -- */
0237 static int sd_start(struct gspca_dev *gspca_dev)
0238 {
0239     int ret;
0240     struct sd *sd = (struct sd *) gspca_dev;
0241
0242     ret = stv0680_set_video_mode(gspca_dev, sd->video_mode);
0243     if (ret < 0)
0244         return ret;
0245
0246     if (stv_sndctrl(gspca_dev, 0, 0x85, 0, 0x10) != 0x10)
0247         return stv0680_handle_error(gspca_dev, -EIO);
0248
0249     /* Start stream at:
0250        0x0000 = CIF (352x288)
0251        0x0100 = VGA (640x480)
0252        0x0300 = QVGA (320x240) */
0253     if (stv_sndctrl(gspca_dev, 1, 0x09, sd->video_mode << 8, 0x0) != 0x0)
0254         return stv0680_handle_error(gspca_dev, -EIO);
0255
0256     return 0;
0257 }
0258
0259 static void sd_stopN(struct gspca_dev *gspca_dev)
0260 {
0261     /* This is a high priority command; it stops all lower order cmds */
0262     if (stv_sndctrl(gspca_dev, 1, 0x04, 0x0000, 0x0) != 0x0)
0263         stv0680_handle_error(gspca_dev, -EIO);
0264 }
0265
0266 static void sd_stop0(struct gspca_dev *gspca_dev)
0267 {
0268     struct sd *sd = (struct sd *) gspca_dev;
0269
0270     if (!sd->gspca_dev.present)
0271         return;
0272
0273     stv0680_set_video_mode(gspca_dev, sd->orig_mode);
0274 }
0275
0276 static void sd_pkt_scan(struct gspca_dev *gspca_dev,
0277             u8 *data,
0278             int len)
0279 {
0280     struct sd *sd = (struct sd *) gspca_dev;
0281
0282     /* Every now and then the camera sends a 16 byte packet, no idea
0283        what it contains, but it is not image data, when this
0284        happens the frame received before this packet is corrupt,
0285        so discard it. */
0286     if (len != sd->mode.sizeimage) {
0287         gspca_dev->last_packet_type = DISCARD_PACKET;
0288         return;
0289     }
0290
0291     /* Finish the previous frame, we do this upon reception of the next
0292        packet, even though it is already complete so that the strange 16
0293        byte packets send after a corrupt frame can discard it. */
0294     gspca_frame_add(gspca_dev, LAST_PACKET, NULL, 0);
0295
0296     /* Store the just received frame */
0297     gspca_frame_add(gspca_dev, FIRST_PACKET, data, len);
0298 }
0299
0300 /* sub-driver description */
0301 static const struct sd_desc sd_desc = {
0302     .name = MODULE_NAME,
0303     .config = sd_config,
0304     .init = sd_init,
0305     .start = sd_start,
0306     .stopN = sd_stopN,
0307     .stop0 = sd_stop0,
0308     .pkt_scan = sd_pkt_scan,
0309 };
0310
0311 /* -- module initialisation -- */
0312 static const struct usb_device_id device_table[] = {
0313     {USB_DEVICE(0x0553, 0x0202)},
0314     {USB_DEVICE(0x041e, 0x4007)},
0315     {}
0316 };
0317 MODULE_DEVICE_TABLE(usb, device_table);
0318
0319 /* -- device connect -- */
0320 static int sd_probe(struct usb_interface *intf,
0321             const struct usb_device_id *id)
0322 {
0323     return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
0324                 THIS_MODULE);
0325 }
0326
0327 static struct usb_driver sd_driver = {
0328     .name = MODULE_NAME,
0329     .id_table = device_table,
0330     .probe = sd_probe,
0331     .disconnect = gspca_disconnect,
0332 #ifdef CONFIG_PM
0333     .suspend = gspca_suspend,
0334     .resume = gspca_resume,
0335     .reset_resume = gspca_resume,
0336 #endif
0337 };
0338
0339 module_usb_driver(sd_driver);