// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  s2255drv.c - a driver for the Sensoray 2255 USB video capture device
 *
 *   Copyright (C) 2007-2014 by Sensoray Company Inc.
 *                              Dean Anderson
 *
 * Some video buffer code based on vivi driver:
 *
 * Sensoray 2255 device supports 4 simultaneous channels.
 * The channels are not "crossbar" inputs, they are physically
 * attached to separate video decoders.
 *
 * Because of USB2.0 bandwidth limitations. There is only a
 * certain amount of data which may be transferred at one time.
 *
 * Example maximum bandwidth utilization:
 *
 * -full size, color mode YUYV or YUV422P: 2 channels at once
 * -full or half size Grey scale: all 4 channels at once
 * -half size, color mode YUYV or YUV422P: all 4 channels at once
 * -full size, color mode YUYV or YUV422P 1/2 frame rate: all 4 channels
 *  at once.
 */

#include <linux/module.h>
#include <linux/firmware.h>
#include <linux/kernel.h>
#include <linux/mutex.h>
#include <linux/slab.h>
#include <linux/videodev2.h>
#include <linux/mm.h>
#include <linux/vmalloc.h>
#include <linux/usb.h>
#include <media/videobuf2-v4l2.h>
#include <media/videobuf2-vmalloc.h>
#include <media/v4l2-common.h>
#include <media/v4l2-device.h>
#include <media/v4l2-ioctl.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-event.h>

#define S2255_VERSION           "1.25.1"
#define FIRMWARE_FILE_NAME "f2255usb.bin"

/* default JPEG quality */
#define S2255_DEF_JPEG_QUAL     50
/* vendor request in */
#define S2255_VR_IN             0
/* vendor request out */
#define S2255_VR_OUT            1
/* firmware query */
#define S2255_VR_FW             0x30
/* USB endpoint number for configuring the device */
#define S2255_CONFIG_EP         2
/* maximum time for DSP to start responding after last FW word loaded(ms) */
#define S2255_DSP_BOOTTIME      800
/* maximum time to wait for firmware to load (ms) */
#define S2255_LOAD_TIMEOUT      (5000 + S2255_DSP_BOOTTIME)
#define S2255_MIN_BUFS          2
#define S2255_SETMODE_TIMEOUT   500
#define S2255_VIDSTATUS_TIMEOUT 350
#define S2255_MARKER_FRAME      cpu_to_le32(0x2255DA4AL)
#define S2255_MARKER_RESPONSE   cpu_to_le32(0x2255ACACL)
#define S2255_RESPONSE_SETMODE  cpu_to_le32(0x01)
#define S2255_RESPONSE_FW       cpu_to_le32(0x10)
#define S2255_RESPONSE_STATUS   cpu_to_le32(0x20)
#define S2255_USB_XFER_SIZE     (16 * 1024)
#define MAX_CHANNELS            4
#define SYS_FRAMES              4
/* maximum size is PAL full size plus room for the marker header(s) */
#define SYS_FRAMES_MAXSIZE      (720*288*2*2 + 4096)
#define DEF_USB_BLOCK           S2255_USB_XFER_SIZE
#define LINE_SZ_4CIFS_NTSC      640
#define LINE_SZ_2CIFS_NTSC      640
#define LINE_SZ_1CIFS_NTSC      320
#define LINE_SZ_4CIFS_PAL       704
#define LINE_SZ_2CIFS_PAL       704
#define LINE_SZ_1CIFS_PAL       352
#define NUM_LINES_4CIFS_NTSC    240
#define NUM_LINES_2CIFS_NTSC    240
#define NUM_LINES_1CIFS_NTSC    240
#define NUM_LINES_4CIFS_PAL     288
#define NUM_LINES_2CIFS_PAL     288
#define NUM_LINES_1CIFS_PAL     288
#define LINE_SZ_DEF             640
#define NUM_LINES_DEF           240


/* predefined settings */
#define FORMAT_NTSC     1
#define FORMAT_PAL      2

#define SCALE_4CIFS     1       /* 640x480(NTSC) or 704x576(PAL) */
#define SCALE_2CIFS     2       /* 640x240(NTSC) or 704x288(PAL) */
#define SCALE_1CIFS     3       /* 320x240(NTSC) or 352x288(PAL) */
/* SCALE_4CIFSI is the 2 fields interpolated into one */
#define SCALE_4CIFSI    4       /* 640x480(NTSC) or 704x576(PAL) high quality */

#define COLOR_YUVPL     1       /* YUV planar */
#define COLOR_YUVPK     2       /* YUV packed */
#define COLOR_Y8        4       /* monochrome */
#define COLOR_JPG       5       /* JPEG */

#define MASK_COLOR       0x000000ff
#define MASK_JPG_QUALITY 0x0000ff00
#define MASK_INPUT_TYPE  0x000f0000
/* frame decimation. */
#define FDEC_1          1       /* capture every frame. default */
#define FDEC_2          2       /* capture every 2nd frame */
#define FDEC_3          3       /* capture every 3rd frame */
#define FDEC_5          5       /* capture every 5th frame */

/*-------------------------------------------------------
 * Default mode parameters.
 *-------------------------------------------------------*/
#define DEF_SCALE       SCALE_4CIFS
#define DEF_COLOR       COLOR_YUVPL
#define DEF_FDEC        FDEC_1
#define DEF_BRIGHT      0
#define DEF_CONTRAST    0x5c
#define DEF_SATURATION  0x80
#define DEF_HUE         0

/* usb config commands */
#define IN_DATA_TOKEN   cpu_to_le32(0x2255c0de)
#define CMD_2255        0xc2255000
#define CMD_SET_MODE    cpu_to_le32((CMD_2255 | 0x10))
#define CMD_START       cpu_to_le32((CMD_2255 | 0x20))
#define CMD_STOP        cpu_to_le32((CMD_2255 | 0x30))
#define CMD_STATUS      cpu_to_le32((CMD_2255 | 0x40))

struct s2255_mode {
        u32 format;     /* input video format (NTSC, PAL) */
        u32 scale;      /* output video scale */
        u32 color;      /* output video color format */
        u32 fdec;       /* frame decimation */
        u32 bright;     /* brightness */
        u32 contrast;   /* contrast */
        u32 saturation; /* saturation */
        u32 hue;        /* hue (NTSC only)*/
        u32 single;     /* capture 1 frame at a time (!=0), continuously (==0)*/
        u32 usb_block;  /* block size. should be 4096 of DEF_USB_BLOCK */
        u32 restart;    /* if DSP requires restart */
};


#define S2255_READ_IDLE         0
#define S2255_READ_FRAME        1

/* frame structure */
struct s2255_framei {
        unsigned long size;
        unsigned long ulState;  /* ulState:S2255_READ_IDLE, S2255_READ_FRAME*/
        void *lpvbits;          /* image data */
        unsigned long cur_size; /* current data copied to it */
};

/* image buffer structure */
struct s2255_bufferi {
        unsigned long dwFrames;                 /* number of frames in buffer */
        struct s2255_framei frame[SYS_FRAMES];  /* array of FRAME structures */
};

#define DEF_MODEI_NTSC_CONT     {FORMAT_NTSC, DEF_SCALE, DEF_COLOR,     \
                        DEF_FDEC, DEF_BRIGHT, DEF_CONTRAST, DEF_SATURATION, \
                        DEF_HUE, 0, DEF_USB_BLOCK, 0}

/* for firmware loading, fw_state */
#define S2255_FW_NOTLOADED      0
#define S2255_FW_LOADED_DSPWAIT 1
#define S2255_FW_SUCCESS        2
#define S2255_FW_FAILED         3
#define S2255_FW_DISCONNECTING  4
#define S2255_FW_MARKER         cpu_to_le32(0x22552f2f)
/* 2255 read states */
#define S2255_READ_IDLE         0
#define S2255_READ_FRAME        1
struct s2255_fw {
        int                   fw_loaded;
        int                   fw_size;
        struct urb            *fw_urb;
        atomic_t              fw_state;
        void                  *pfw_data;
        wait_queue_head_t     wait_fw;
        const struct firmware *fw;
};

struct s2255_pipeinfo {
        u32 max_transfer_size;
        u32 cur_transfer_size;
        u8 *transfer_buffer;
        u32 state;
        void *stream_urb;
        void *dev;      /* back pointer to s2255_dev struct*/
        u32 err_count;
        u32 idx;
};

struct s2255_fmt; /*forward declaration */
struct s2255_dev;

/* 2255 video channel */
struct s2255_vc {
        struct s2255_dev        *dev;
        struct video_device     vdev;
        struct v4l2_ctrl_handler hdl;
        struct v4l2_ctrl        *jpegqual_ctrl;
        int                     resources;
        struct list_head        buf_list;
        struct s2255_bufferi    buffer;
        struct s2255_mode       mode;
        v4l2_std_id             std;
        /* jpeg compression */
        unsigned                jpegqual;
        /* capture parameters (for high quality mode full size) */
        struct v4l2_captureparm cap_parm;
        int                     cur_frame;
        int                     last_frame;
        /* allocated image size */
        unsigned long           req_image_size;
        /* received packet size */
        unsigned long           pkt_size;
        int                     bad_payload;
        unsigned long           frame_count;
        /* if JPEG image */
        int                     jpg_size;
        /* if channel configured to default state */
        int                     configured;
        wait_queue_head_t       wait_setmode;
        int                     setmode_ready;
        /* video status items */
        int                     vidstatus;
        wait_queue_head_t       wait_vidstatus;
        int                     vidstatus_ready;
        unsigned int            width;
        unsigned int            height;
        enum v4l2_field         field;
        const struct s2255_fmt  *fmt;
        int idx; /* channel number on device, 0-3 */
        struct vb2_queue vb_vidq;
        struct mutex vb_lock; /* streaming lock */
        spinlock_t qlock;
};


struct s2255_dev {
        struct s2255_vc         vc[MAX_CHANNELS];
        struct v4l2_device      v4l2_dev;
        atomic_t                num_channels;
        int                     frames;
        struct mutex            lock;   /* channels[].vdev.lock */
        struct mutex            cmdlock; /* protects cmdbuf */
        struct usb_device       *udev;
        struct usb_interface    *interface;
        u8                      read_endpoint;
        struct timer_list       timer;
        struct s2255_fw *fw_data;
        struct s2255_pipeinfo   pipe;
        u32                     cc;     /* current channel */
        int                     frame_ready;
        int                     chn_ready;
        /* dsp firmware version (f2255usb.bin) */
        int                     dsp_fw_ver;
        u16                     pid; /* product id */
#define S2255_CMDBUF_SIZE 512
        __le32                  *cmdbuf;
};

static inline struct s2255_dev *to_s2255_dev(struct v4l2_device *v4l2_dev)
{
        return container_of(v4l2_dev, struct s2255_dev, v4l2_dev);
}

struct s2255_fmt {
        char *name;
        u32 fourcc;
        int depth;
};

/* buffer for one video frame */
struct s2255_buffer {
        /* common v4l buffer stuff -- must be first */
        struct vb2_v4l2_buffer vb;
        struct list_head list;
};


/* current cypress EEPROM firmware version */
#define S2255_CUR_USB_FWVER     ((3 << 8) | 12)
/* current DSP FW version */
#define S2255_CUR_DSP_FWVER     10104
/* Need DSP version 5+ for video status feature */
#define S2255_MIN_DSP_STATUS      5
#define S2255_MIN_DSP_COLORFILTER 8
#define S2255_NORMS             (V4L2_STD_ALL)

/* private V4L2 controls */

/*
 * The following chart displays how COLORFILTER should be set
 *  =========================================================
 *  =     fourcc              =     COLORFILTER             =
 *  =                         ===============================
 *  =                         =   0             =    1      =
 *  =========================================================
 *  =  V4L2_PIX_FMT_GREY(Y8)  = monochrome from = monochrome=
 *  =                         = s-video or      = composite =
 *  =                         = B/W camera      = input     =
 *  =========================================================
 *  =    other                = color, svideo   = color,    =
 *  =                         =                 = composite =
 *  =========================================================
 *
 * Notes:
 *   channels 0-3 on 2255 are composite
 *   channels 0-1 on 2257 are composite, 2-3 are s-video
 * If COLORFILTER is 0 with a composite color camera connected,
 * the output will appear monochrome but hatching
 * will occur.
 * COLORFILTER is different from "color killer" and "color effects"
 * for reasons above.
 */
#define S2255_V4L2_YC_ON  1
#define S2255_V4L2_YC_OFF 0
#define V4L2_CID_S2255_COLORFILTER (V4L2_CID_USER_S2255_BASE + 0)

/* frame prefix size (sent once every frame) */
#define PREFIX_SIZE             512

/* Channels on box are in reverse order */
static unsigned long G_chnmap[MAX_CHANNELS] = {3, 2, 1, 0};

static int debug;

static int s2255_start_readpipe(struct s2255_dev *dev);
static void s2255_stop_readpipe(struct s2255_dev *dev);
static int s2255_start_acquire(struct s2255_vc *vc);
static int s2255_stop_acquire(struct s2255_vc *vc);
static void s2255_fillbuff(struct s2255_vc *vc, struct s2255_buffer *buf,
                           int jpgsize);
static int s2255_set_mode(struct s2255_vc *vc, struct s2255_mode *mode);
static int s2255_board_shutdown(struct s2255_dev *dev);
static void s2255_fwload_start(struct s2255_dev *dev);
static void s2255_destroy(struct s2255_dev *dev);
static long s2255_vendor_req(struct s2255_dev *dev, unsigned char req,
                             u16 index, u16 value, void *buf,
                             s32 buf_len, int bOut);

/* dev_err macro with driver name */
#define S2255_DRIVER_NAME "s2255"
#define s2255_dev_err(dev, fmt, arg...)                                 \
                dev_err(dev, S2255_DRIVER_NAME " - " fmt, ##arg)

#define dprintk(dev, level, fmt, arg...) \
        v4l2_dbg(level, debug, &dev->v4l2_dev, fmt, ## arg)

static struct usb_driver s2255_driver;

/* start video number */
static int video_nr = -1;       /* /dev/videoN, -1 for autodetect */

/* Enable jpeg capture. */
static int jpeg_enable = 1;

module_param(debug, int, 0644);
MODULE_PARM_DESC(debug, "Debug level(0-100) default 0");
module_param(video_nr, int, 0644);
MODULE_PARM_DESC(video_nr, "start video minor(-1 default autodetect)");
module_param(jpeg_enable, int, 0644);
MODULE_PARM_DESC(jpeg_enable, "Jpeg enable(1-on 0-off) default 1");

/* USB device table */
#define USB_SENSORAY_VID        0x1943
static const struct usb_device_id s2255_table[] = {
        {USB_DEVICE(USB_SENSORAY_VID, 0x2255)},
        {USB_DEVICE(USB_SENSORAY_VID, 0x2257)}, /*same family as 2255*/
        { }                     /* Terminating entry */
};
MODULE_DEVICE_TABLE(usb, s2255_table);

#define BUFFER_TIMEOUT msecs_to_jiffies(400)

/* image formats.  */
/* JPEG formats must be defined last to support jpeg_enable parameter */
static const struct s2255_fmt formats[] = {
        {
                .name = "4:2:2, packed, YUYV",
                .fourcc = V4L2_PIX_FMT_YUYV,
                .depth = 16

        }, {
                .name = "4:2:2, packed, UYVY",
                .fourcc = V4L2_PIX_FMT_UYVY,
                .depth = 16
        }, {
                .name = "4:2:2, planar, YUV422P",
                .fourcc = V4L2_PIX_FMT_YUV422P,
                .depth = 16

        }, {
                .name = "8bpp GREY",
                .fourcc = V4L2_PIX_FMT_GREY,
                .depth = 8
        }, {
                .name = "JPG",
                .fourcc = V4L2_PIX_FMT_JPEG,
                .depth = 24
        }, {
                .name = "MJPG",
                .fourcc = V4L2_PIX_FMT_MJPEG,
                .depth = 24
        }
};

static int norm_maxw(struct s2255_vc *vc)
{
        return (vc->std & V4L2_STD_525_60) ?
            LINE_SZ_4CIFS_NTSC : LINE_SZ_4CIFS_PAL;
}

static int norm_maxh(struct s2255_vc *vc)
{
        return (vc->std & V4L2_STD_525_60) ?
            (NUM_LINES_1CIFS_NTSC * 2) : (NUM_LINES_1CIFS_PAL * 2);
}

static int norm_minw(struct s2255_vc *vc)
{
        return (vc->std & V4L2_STD_525_60) ?
            LINE_SZ_1CIFS_NTSC : LINE_SZ_1CIFS_PAL;
}

static int norm_minh(struct s2255_vc *vc)
{
        return (vc->std & V4L2_STD_525_60) ?
            (NUM_LINES_1CIFS_NTSC) : (NUM_LINES_1CIFS_PAL);
}


/*
 * TODO: fixme: move YUV reordering to hardware
 * converts 2255 planar format to yuyv or uyvy
 */
static void planar422p_to_yuv_packed(const unsigned char *in,
                                     unsigned char *out,
                                     int width, int height,
                                     int fmt)
{
        unsigned char *pY;
        unsigned char *pCb;
        unsigned char *pCr;
        unsigned long size = height * width;
        unsigned int i;
        pY = (unsigned char *)in;
        pCr = (unsigned char *)in + height * width;
        pCb = (unsigned char *)in + height * width + (height * width / 2);
        for (i = 0; i < size * 2; i += 4) {
                out[i] = (fmt == V4L2_PIX_FMT_YUYV) ? *pY++ : *pCr++;
                out[i + 1] = (fmt == V4L2_PIX_FMT_YUYV) ? *pCr++ : *pY++;
                out[i + 2] = (fmt == V4L2_PIX_FMT_YUYV) ? *pY++ : *pCb++;
                out[i + 3] = (fmt == V4L2_PIX_FMT_YUYV) ? *pCb++ : *pY++;
        }
        return;
}

static void s2255_reset_dsppower(struct s2255_dev *dev)
{
        s2255_vendor_req(dev, 0x40, 0x0000, 0x0001, NULL, 0, 1);
        msleep(50);
        s2255_vendor_req(dev, 0x50, 0x0000, 0x0000, NULL, 0, 1);
        msleep(600);
        s2255_vendor_req(dev, 0x10, 0x0000, 0x0000, NULL, 0, 1);
        return;
}

/* kickstarts the firmware loading. from probe
 */
static void s2255_timer(struct timer_list *t)
{
        struct s2255_dev *dev = from_timer(dev, t, timer);
        struct s2255_fw *data = dev->fw_data;
        if (usb_submit_urb(data->fw_urb, GFP_ATOMIC) < 0) {
                pr_err("s2255: can't submit urb\n");
                atomic_set(&data->fw_state, S2255_FW_FAILED);
                /* wake up anything waiting for the firmware */
                wake_up(&data->wait_fw);
                return;
        }
}


/* this loads the firmware asynchronously.
   Originally this was done synchronously in probe.
   But it is better to load it asynchronously here than block
   inside the probe function. Blocking inside probe affects boot time.
   FW loading is triggered by the timer in the probe function
*/
static void s2255_fwchunk_complete(struct urb *urb)
{
        struct s2255_fw *data = urb->context;
        struct usb_device *udev = urb->dev;
        int len;
        if (urb->status) {
                dev_err(&udev->dev, "URB failed with status %d\n", urb->status);
                atomic_set(&data->fw_state, S2255_FW_FAILED);
                /* wake up anything waiting for the firmware */
                wake_up(&data->wait_fw);
                return;
        }
        if (data->fw_urb == NULL) {
                s2255_dev_err(&udev->dev, "disconnected\n");
                atomic_set(&data->fw_state, S2255_FW_FAILED);
                /* wake up anything waiting for the firmware */
                wake_up(&data->wait_fw);
                return;
        }
#define CHUNK_SIZE 512
        /* all USB transfers must be done with continuous kernel memory.
           can't allocate more than 128k in current linux kernel, so
           upload the firmware in chunks
         */
        if (data->fw_loaded < data->fw_size) {
                len = (data->fw_loaded + CHUNK_SIZE) > data->fw_size ?
                    data->fw_size % CHUNK_SIZE : CHUNK_SIZE;

                if (len < CHUNK_SIZE)
                        memset(data->pfw_data, 0, CHUNK_SIZE);

                memcpy(data->pfw_data,
                       (char *) data->fw->data + data->fw_loaded, len);

                usb_fill_bulk_urb(data->fw_urb, udev, usb_sndbulkpipe(udev, 2),
                                  data->pfw_data, CHUNK_SIZE,
                                  s2255_fwchunk_complete, data);
                if (usb_submit_urb(data->fw_urb, GFP_ATOMIC) < 0) {
                        dev_err(&udev->dev, "failed submit URB\n");
                        atomic_set(&data->fw_state, S2255_FW_FAILED);
                        /* wake up anything waiting for the firmware */
                        wake_up(&data->wait_fw);
                        return;
                }
                data->fw_loaded += len;
        } else
                atomic_set(&data->fw_state, S2255_FW_LOADED_DSPWAIT);
        return;

}

static void s2255_got_frame(struct s2255_vc *vc, int jpgsize)
{
        struct s2255_buffer *buf;
        struct s2255_dev *dev = to_s2255_dev(vc->vdev.v4l2_dev);
        unsigned long flags = 0;

        spin_lock_irqsave(&vc->qlock, flags);
        if (list_empty(&vc->buf_list)) {
                dprintk(dev, 1, "No active queue to serve\n");
                spin_unlock_irqrestore(&vc->qlock, flags);
                return;
        }
        buf = list_entry(vc->buf_list.next,
                         struct s2255_buffer, list);
        list_del(&buf->list);
        buf->vb.vb2_buf.timestamp = ktime_get_ns();
        buf->vb.field = vc->field;
        buf->vb.sequence = vc->frame_count;
        spin_unlock_irqrestore(&vc->qlock, flags);

        s2255_fillbuff(vc, buf, jpgsize);
        /* tell v4l buffer was filled */
        vb2_buffer_done(&buf->vb.vb2_buf, VB2_BUF_STATE_DONE);
        dprintk(dev, 2, "%s: [buf] [%p]\n", __func__, buf);
}

static const struct s2255_fmt *format_by_fourcc(int fourcc)
{
        unsigned int i;
        for (i = 0; i < ARRAY_SIZE(formats); i++) {
                if (-1 == formats[i].fourcc)
                        continue;
                if (!jpeg_enable && ((formats[i].fourcc == V4L2_PIX_FMT_JPEG) ||
                                     (formats[i].fourcc == V4L2_PIX_FMT_MJPEG)))
                        continue;
                if (formats[i].fourcc == fourcc)
                        return formats + i;
        }
        return NULL;
}

/* video buffer vmalloc implementation based partly on VIVI driver which is
 *          Copyright (c) 2006 by
 *                  Mauro Carvalho Chehab <mchehab--a.t--infradead.org>
 *                  Ted Walther <ted--a.t--enumera.com>
 *                  John Sokol <sokol--a.t--videotechnology.com>
 *                  http://v4l.videotechnology.com/
 *
 */
static void s2255_fillbuff(struct s2255_vc *vc,
                           struct s2255_buffer *buf, int jpgsize)
{
        int pos = 0;
        const char *tmpbuf;
        char *vbuf = vb2_plane_vaddr(&buf->vb.vb2_buf, 0);
        unsigned long last_frame;
        struct s2255_dev *dev = vc->dev;

        if (!vbuf)
                return;
        last_frame = vc->last_frame;
        if (last_frame != -1) {
                tmpbuf =
                    (const char *)vc->buffer.frame[last_frame].lpvbits;
                switch (vc->fmt->fourcc) {
                case V4L2_PIX_FMT_YUYV:
                case V4L2_PIX_FMT_UYVY:
                        planar422p_to_yuv_packed((const unsigned char *)tmpbuf,
                                                 vbuf, vc->width,
                                                 vc->height,
                                                 vc->fmt->fourcc);
                        break;
                case V4L2_PIX_FMT_GREY:
                        memcpy(vbuf, tmpbuf, vc->width * vc->height);
                        break;
                case V4L2_PIX_FMT_JPEG:
                case V4L2_PIX_FMT_MJPEG:
                        vb2_set_plane_payload(&buf->vb.vb2_buf, 0, jpgsize);
                        memcpy(vbuf, tmpbuf, jpgsize);
                        break;
                case V4L2_PIX_FMT_YUV422P:
                        memcpy(vbuf, tmpbuf,
                               vc->width * vc->height * 2);
                        break;
                default:
                        pr_info("s2255: unknown format?\n");
                }
                vc->last_frame = -1;
        } else {
                pr_err("s2255: =======no frame\n");
                return;
        }
        dprintk(dev, 2, "s2255fill at : Buffer %p size= %d\n",
                vbuf, pos);
}


/* ------------------------------------------------------------------
   Videobuf operations
   ------------------------------------------------------------------*/

static int queue_setup(struct vb2_queue *vq,
                       unsigned int *nbuffers, unsigned int *nplanes,
                       unsigned int sizes[], struct device *alloc_devs[])
{
        struct s2255_vc *vc = vb2_get_drv_priv(vq);
        if (*nbuffers < S2255_MIN_BUFS)
                *nbuffers = S2255_MIN_BUFS;
        *nplanes = 1;
        sizes[0] = vc->width * vc->height * (vc->fmt->depth >> 3);
        return 0;
}

static int buffer_prepare(struct vb2_buffer *vb)
{
        struct s2255_vc *vc = vb2_get_drv_priv(vb->vb2_queue);
        struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
        struct s2255_buffer *buf = container_of(vbuf, struct s2255_buffer, vb);
        int w = vc->width;
        int h = vc->height;
        unsigned long size;

        dprintk(vc->dev, 4, "%s\n", __func__);
        if (vc->fmt == NULL)
                return -EINVAL;

        if ((w < norm_minw(vc)) ||
            (w > norm_maxw(vc)) ||
            (h < norm_minh(vc)) ||
            (h > norm_maxh(vc))) {
                dprintk(vc->dev, 4, "invalid buffer prepare\n");
                return -EINVAL;
        }
        size = w * h * (vc->fmt->depth >> 3);
        if (vb2_plane_size(vb, 0) < size) {
                dprintk(vc->dev, 4, "invalid buffer prepare\n");
                return -EINVAL;
        }

        vb2_set_plane_payload(&buf->vb.vb2_buf, 0, size);
        return 0;
}

static void buffer_queue(struct vb2_buffer *vb)
{
        struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
        struct s2255_buffer *buf = container_of(vbuf, struct s2255_buffer, vb);
        struct s2255_vc *vc = vb2_get_drv_priv(vb->vb2_queue);
        unsigned long flags = 0;
        dprintk(vc->dev, 1, "%s\n", __func__);
        spin_lock_irqsave(&vc->qlock, flags);
        list_add_tail(&buf->list, &vc->buf_list);
        spin_unlock_irqrestore(&vc->qlock, flags);
}

static int start_streaming(struct vb2_queue *vq, unsigned int count);
static void stop_streaming(struct vb2_queue *vq);

static const struct vb2_ops s2255_video_qops = {
        .queue_setup = queue_setup,
        .buf_prepare = buffer_prepare,
        .buf_queue = buffer_queue,
        .start_streaming = start_streaming,
        .stop_streaming = stop_streaming,
        .wait_prepare = vb2_ops_wait_prepare,
        .wait_finish = vb2_ops_wait_finish,
};

static int vidioc_querycap(struct file *file, void *priv,
                           struct v4l2_capability *cap)
{
        struct s2255_vc *vc = video_drvdata(file);
        struct s2255_dev *dev = vc->dev;

        strscpy(cap->driver, "s2255", sizeof(cap->driver));
        strscpy(cap->card, "s2255", sizeof(cap->card));
        usb_make_path(dev->udev, cap->bus_info, sizeof(cap->bus_info));
        return 0;
}

static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
                               struct v4l2_fmtdesc *f)
{
        int index = f->index;

        if (index >= ARRAY_SIZE(formats))
                return -EINVAL;
        if (!jpeg_enable && ((formats[index].fourcc == V4L2_PIX_FMT_JPEG) ||
                        (formats[index].fourcc == V4L2_PIX_FMT_MJPEG)))
                return -EINVAL;
        strscpy(f->description, formats[index].name, sizeof(f->description));
        f->pixelformat = formats[index].fourcc;
        return 0;
}

static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
                            struct v4l2_format *f)
{
        struct s2255_vc *vc = video_drvdata(file);
        int is_ntsc = vc->std & V4L2_STD_525_60;

        f->fmt.pix.width = vc->width;
        f->fmt.pix.height = vc->height;
        if (f->fmt.pix.height >=
            (is_ntsc ? NUM_LINES_1CIFS_NTSC : NUM_LINES_1CIFS_PAL) * 2)
                f->fmt.pix.field = V4L2_FIELD_INTERLACED;
        else
                f->fmt.pix.field = V4L2_FIELD_TOP;
        f->fmt.pix.pixelformat = vc->fmt->fourcc;
        f->fmt.pix.bytesperline = f->fmt.pix.width * (vc->fmt->depth >> 3);
        f->fmt.pix.sizeimage = f->fmt.pix.height * f->fmt.pix.bytesperline;
        f->fmt.pix.colorspace = V4L2_COLORSPACE_SMPTE170M;
        f->fmt.pix.priv = 0;
        return 0;
}

static int vidioc_try_fmt_vid_cap(struct file *file, void *priv,
                              struct v4l2_format *f)
{
        const struct s2255_fmt *fmt;
        enum v4l2_field field;
        struct s2255_vc *vc = video_drvdata(file);
        int is_ntsc = vc->std & V4L2_STD_525_60;

        fmt = format_by_fourcc(f->fmt.pix.pixelformat);

        if (fmt == NULL)
                return -EINVAL;

        field = f->fmt.pix.field;

        dprintk(vc->dev, 50, "%s NTSC: %d suggested width: %d, height: %d\n",
                __func__, is_ntsc, f->fmt.pix.width, f->fmt.pix.height);
        if (is_ntsc) {
                /* NTSC */
                if (f->fmt.pix.height >= NUM_LINES_1CIFS_NTSC * 2) {
                        f->fmt.pix.height = NUM_LINES_1CIFS_NTSC * 2;
                        field = V4L2_FIELD_INTERLACED;
                } else {
                        f->fmt.pix.height = NUM_LINES_1CIFS_NTSC;
                        field = V4L2_FIELD_TOP;
                }
                if (f->fmt.pix.width >= LINE_SZ_4CIFS_NTSC)
                        f->fmt.pix.width = LINE_SZ_4CIFS_NTSC;
                else
                        f->fmt.pix.width = LINE_SZ_1CIFS_NTSC;
        } else {
                /* PAL */
                if (f->fmt.pix.height >= NUM_LINES_1CIFS_PAL * 2) {
                        f->fmt.pix.height = NUM_LINES_1CIFS_PAL * 2;
                        field = V4L2_FIELD_INTERLACED;
                } else {
                        f->fmt.pix.height = NUM_LINES_1CIFS_PAL;
                        field = V4L2_FIELD_TOP;
                }
                if (f->fmt.pix.width >= LINE_SZ_4CIFS_PAL)
                        f->fmt.pix.width = LINE_SZ_4CIFS_PAL;
                else
                        f->fmt.pix.width = LINE_SZ_1CIFS_PAL;
        }
        f->fmt.pix.field = field;
        f->fmt.pix.bytesperline = (f->fmt.pix.width * fmt->depth) >> 3;
        f->fmt.pix.sizeimage = f->fmt.pix.height * f->fmt.pix.bytesperline;
        f->fmt.pix.colorspace = V4L2_COLORSPACE_SMPTE170M;
        f->fmt.pix.priv = 0;
        dprintk(vc->dev, 50, "%s: set width %d height %d field %d\n", __func__,
                f->fmt.pix.width, f->fmt.pix.height, f->fmt.pix.field);
        return 0;
}

static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
                            struct v4l2_format *f)
{
        struct s2255_vc *vc = video_drvdata(file);
        const struct s2255_fmt *fmt;
        struct vb2_queue *q = &vc->vb_vidq;
        struct s2255_mode mode;
        int ret;

        ret = vidioc_try_fmt_vid_cap(file, vc, f);

        if (ret < 0)
                return ret;

        fmt = format_by_fourcc(f->fmt.pix.pixelformat);

        if (fmt == NULL)
                return -EINVAL;

        if (vb2_is_busy(q)) {
                dprintk(vc->dev, 1, "queue busy\n");
                return -EBUSY;
        }

        mode = vc->mode;
        vc->fmt = fmt;
        vc->width = f->fmt.pix.width;
        vc->height = f->fmt.pix.height;
        vc->field = f->fmt.pix.field;
        if (vc->width > norm_minw(vc)) {
                if (vc->height > norm_minh(vc)) {
                        if (vc->cap_parm.capturemode &
                            V4L2_MODE_HIGHQUALITY)
                                mode.scale = SCALE_4CIFSI;
                        else
                                mode.scale = SCALE_4CIFS;
                } else
                        mode.scale = SCALE_2CIFS;

        } else {
                mode.scale = SCALE_1CIFS;
        }
        /* color mode */
        switch (vc->fmt->fourcc) {
        case V4L2_PIX_FMT_GREY:
                mode.color &= ~MASK_COLOR;
                mode.color |= COLOR_Y8;
                break;
        case V4L2_PIX_FMT_JPEG:
        case V4L2_PIX_FMT_MJPEG:
                mode.color &= ~MASK_COLOR;
                mode.color |= COLOR_JPG;
                mode.color |= (vc->jpegqual << 8);
                break;
        case V4L2_PIX_FMT_YUV422P:
                mode.color &= ~MASK_COLOR;
                mode.color |= COLOR_YUVPL;
                break;
        case V4L2_PIX_FMT_YUYV:
        case V4L2_PIX_FMT_UYVY:
        default:
                mode.color &= ~MASK_COLOR;
                mode.color |= COLOR_YUVPK;
                break;
        }
        if ((mode.color & MASK_COLOR) != (vc->mode.color & MASK_COLOR))
                mode.restart = 1;
        else if (mode.scale != vc->mode.scale)
                mode.restart = 1;
        else if (mode.format != vc->mode.format)
                mode.restart = 1;
        vc->mode = mode;
        (void) s2255_set_mode(vc, &mode);
        return 0;
}


/* write to the configuration pipe, synchronously */
static int s2255_write_config(struct usb_device *udev, unsigned char *pbuf,
                              int size)
{
        int pipe;
        int done;
        long retval = -1;
        if (udev) {
                pipe = usb_sndbulkpipe(udev, S2255_CONFIG_EP);
                retval = usb_bulk_msg(udev, pipe, pbuf, size, &done, 500);
        }
        return retval;
}

static u32 get_transfer_size(struct s2255_mode *mode)
{
        int linesPerFrame = LINE_SZ_DEF;
        int pixelsPerLine = NUM_LINES_DEF;
        u32 outImageSize;
        u32 usbInSize;
        unsigned int mask_mult;

        if (mode == NULL)
                return 0;

        if (mode->format == FORMAT_NTSC) {
                switch (mode->scale) {
                case SCALE_4CIFS:
                case SCALE_4CIFSI:
                        linesPerFrame = NUM_LINES_4CIFS_NTSC * 2;
                        pixelsPerLine = LINE_SZ_4CIFS_NTSC;
                        break;
                case SCALE_2CIFS:
                        linesPerFrame = NUM_LINES_2CIFS_NTSC;
                        pixelsPerLine = LINE_SZ_2CIFS_NTSC;
                        break;
                case SCALE_1CIFS:
                        linesPerFrame = NUM_LINES_1CIFS_NTSC;
                        pixelsPerLine = LINE_SZ_1CIFS_NTSC;
                        break;
                default:
                        break;
                }
        } else if (mode->format == FORMAT_PAL) {
                switch (mode->scale) {
                case SCALE_4CIFS:
                case SCALE_4CIFSI:
                        linesPerFrame = NUM_LINES_4CIFS_PAL * 2;
                        pixelsPerLine = LINE_SZ_4CIFS_PAL;
                        break;
                case SCALE_2CIFS:
                        linesPerFrame = NUM_LINES_2CIFS_PAL;
                        pixelsPerLine = LINE_SZ_2CIFS_PAL;
                        break;
                case SCALE_1CIFS:
                        linesPerFrame = NUM_LINES_1CIFS_PAL;
                        pixelsPerLine = LINE_SZ_1CIFS_PAL;
                        break;
                default:
                        break;
                }
        }
        outImageSize = linesPerFrame * pixelsPerLine;
        if ((mode->color & MASK_COLOR) != COLOR_Y8) {
                /* 2 bytes/pixel if not monochrome */
                outImageSize *= 2;
        }

        /* total bytes to send including prefix and 4K padding;
           must be a multiple of USB_READ_SIZE */
        usbInSize = outImageSize + PREFIX_SIZE; /* always send prefix */
        mask_mult = 0xffffffffUL - DEF_USB_BLOCK + 1;
        /* if size not a multiple of USB_READ_SIZE */
        if (usbInSize & ~mask_mult)
                usbInSize = (usbInSize & mask_mult) + (DEF_USB_BLOCK);
        return usbInSize;
}

static void s2255_print_cfg(struct s2255_dev *sdev, struct s2255_mode *mode)
{
        struct device *dev = &sdev->udev->dev;
        dev_info(dev, "------------------------------------------------\n");
        dev_info(dev, "format: %d\nscale %d\n", mode->format, mode->scale);
        dev_info(dev, "fdec: %d\ncolor %d\n", mode->fdec, mode->color);
        dev_info(dev, "bright: 0x%x\n", mode->bright);
        dev_info(dev, "------------------------------------------------\n");
}

/*
 * set mode is the function which controls the DSP.
 * the restart parameter in struct s2255_mode should be set whenever
 * the image size could change via color format, video system or image
 * size.
 * When the restart parameter is set, we sleep for ONE frame to allow the
 * DSP time to get the new frame
 */
static int s2255_set_mode(struct s2255_vc *vc,
                          struct s2255_mode *mode)
{
        int res;
        unsigned long chn_rev;
        struct s2255_dev *dev = to_s2255_dev(vc->vdev.v4l2_dev);
        int i;
        __le32 *buffer = dev->cmdbuf;

        mutex_lock(&dev->cmdlock);
        chn_rev = G_chnmap[vc->idx];
        dprintk(dev, 3, "%s channel: %d\n", __func__, vc->idx);
        /* if JPEG, set the quality */
        if ((mode->color & MASK_COLOR) == COLOR_JPG) {
                mode->color &= ~MASK_COLOR;
                mode->color |= COLOR_JPG;
                mode->color &= ~MASK_JPG_QUALITY;
                mode->color |= (vc->jpegqual << 8);
        }
        /* save the mode */
        vc->mode = *mode;
        vc->req_image_size = get_transfer_size(mode);
        dprintk(dev, 1, "%s: reqsize %ld\n", __func__, vc->req_image_size);
        /* set the mode */
        buffer[0] = IN_DATA_TOKEN;
        buffer[1] = (__le32) cpu_to_le32(chn_rev);
        buffer[2] = CMD_SET_MODE;
        for (i = 0; i < sizeof(struct s2255_mode) / sizeof(u32); i++)
                buffer[3 + i] = cpu_to_le32(((u32 *)&vc->mode)[i]);
        vc->setmode_ready = 0;
        res = s2255_write_config(dev->udev, (unsigned char *)buffer, 512);
        if (debug)
                s2255_print_cfg(dev, mode);
        /* wait at least 3 frames before continuing */
        if (mode->restart) {
                wait_event_timeout(vc->wait_setmode,
                                   (vc->setmode_ready != 0),
                                   msecs_to_jiffies(S2255_SETMODE_TIMEOUT));
                if (vc->setmode_ready != 1) {
                        dprintk(dev, 0, "s2255: no set mode response\n");
                        res = -EFAULT;
                }
        }
        /* clear the restart flag */
        vc->mode.restart = 0;
        dprintk(dev, 1, "%s chn %d, result: %d\n", __func__, vc->idx, res);
        mutex_unlock(&dev->cmdlock);
        return res;
}

static int s2255_cmd_status(struct s2255_vc *vc, u32 *pstatus)
{
        int res;
        u32 chn_rev;
        struct s2255_dev *dev = to_s2255_dev(vc->vdev.v4l2_dev);
        __le32 *buffer = dev->cmdbuf;

        mutex_lock(&dev->cmdlock);
        chn_rev = G_chnmap[vc->idx];
        dprintk(dev, 4, "%s chan %d\n", __func__, vc->idx);
        /* form the get vid status command */
        buffer[0] = IN_DATA_TOKEN;
        buffer[1] = (__le32) cpu_to_le32(chn_rev);
        buffer[2] = CMD_STATUS;
        *pstatus = 0;
        vc->vidstatus_ready = 0;
        res = s2255_write_config(dev->udev, (unsigned char *)buffer, 512);
        wait_event_timeout(vc->wait_vidstatus,
                           (vc->vidstatus_ready != 0),
                           msecs_to_jiffies(S2255_VIDSTATUS_TIMEOUT));
        if (vc->vidstatus_ready != 1) {
                dprintk(dev, 0, "s2255: no vidstatus response\n");
                res = -EFAULT;
        }
        *pstatus = vc->vidstatus;
        dprintk(dev, 4, "%s, vid status %d\n", __func__, *pstatus);
        mutex_unlock(&dev->cmdlock);
        return res;
}

static int start_streaming(struct vb2_queue *vq, unsigned int count)
{
        struct s2255_vc *vc = vb2_get_drv_priv(vq);
        int j;

        vc->last_frame = -1;
        vc->bad_payload = 0;
        vc->cur_frame = 0;
        vc->frame_count = 0;
        for (j = 0; j < SYS_FRAMES; j++) {
                vc->buffer.frame[j].ulState = S2255_READ_IDLE;
                vc->buffer.frame[j].cur_size = 0;
        }
        return s2255_start_acquire(vc);
}

/* abort streaming and wait for last buffer */
static void stop_streaming(struct vb2_queue *vq)
{
        struct s2255_vc *vc = vb2_get_drv_priv(vq);
        struct s2255_buffer *buf, *node;
        unsigned long flags;
        (void) s2255_stop_acquire(vc);
        spin_lock_irqsave(&vc->qlock, flags);
        list_for_each_entry_safe(buf, node, &vc->buf_list, list) {
                list_del(&buf->list);
                vb2_buffer_done(&buf->vb.vb2_buf, VB2_BUF_STATE_ERROR);
                dprintk(vc->dev, 2, "[%p/%d] done\n",
                        buf, buf->vb.vb2_buf.index);
        }
        spin_unlock_irqrestore(&vc->qlock, flags);
}

static int vidioc_s_std(struct file *file, void *priv, v4l2_std_id i)
{
        struct s2255_vc *vc = video_drvdata(file);
        struct s2255_mode mode;
        struct vb2_queue *q = &vc->vb_vidq;

        /*
         * Changing the standard implies a format change, which is not allowed
         * while buffers for use with streaming have already been allocated.
         */
        if (vb2_is_busy(q))
                return -EBUSY;

        mode = vc->mode;
        if (i & V4L2_STD_525_60) {
                dprintk(vc->dev, 4, "%s 60 Hz\n", __func__);
                /* if changing format, reset frame decimation/intervals */
                if (mode.format != FORMAT_NTSC) {
                        mode.restart = 1;
                        mode.format = FORMAT_NTSC;
                        mode.fdec = FDEC_1;
                        vc->width = LINE_SZ_4CIFS_NTSC;
                        vc->height = NUM_LINES_4CIFS_NTSC * 2;
                }
        } else if (i & V4L2_STD_625_50) {
                dprintk(vc->dev, 4, "%s 50 Hz\n", __func__);
                if (mode.format != FORMAT_PAL) {
                        mode.restart = 1;
                        mode.format = FORMAT_PAL;
                        mode.fdec = FDEC_1;
                        vc->width = LINE_SZ_4CIFS_PAL;
                        vc->height = NUM_LINES_4CIFS_PAL * 2;
                }
        } else
                return -EINVAL;
        vc->std = i;
        if (mode.restart)
                s2255_set_mode(vc, &mode);
        return 0;
}

static int vidioc_g_std(struct file *file, void *priv, v4l2_std_id *i)
{
        struct s2255_vc *vc = video_drvdata(file);

        *i = vc->std;
        return 0;
}

/* Sensoray 2255 is a multiple channel capture device.
   It does not have a "crossbar" of inputs.
   We use one V4L device per channel. The user must
   be aware that certain combinations are not allowed.
   For instance, you cannot do full FPS on more than 2 channels(2 videodevs)
   at once in color(you can do full fps on 4 channels with greyscale.
*/
static int vidioc_enum_input(struct file *file, void *priv,
                             struct v4l2_input *inp)
{
        struct s2255_vc *vc = video_drvdata(file);
        struct s2255_dev *dev = vc->dev;
        u32 status = 0;

        if (inp->index != 0)
                return -EINVAL;
        inp->type = V4L2_INPUT_TYPE_CAMERA;
        inp->std = S2255_NORMS;
        inp->status = 0;
        if (dev->dsp_fw_ver >= S2255_MIN_DSP_STATUS) {
                int rc;
                rc = s2255_cmd_status(vc, &status);
                dprintk(dev, 4, "s2255_cmd_status rc: %d status %x\n",
                        rc, status);
                if (rc == 0)
                        inp->status =  (status & 0x01) ? 0
                                : V4L2_IN_ST_NO_SIGNAL;
        }
        switch (dev->pid) {
        case 0x2255:
        default:
                strscpy(inp->name, "Composite", sizeof(inp->name));
                break;
        case 0x2257:
                strscpy(inp->name, (vc->idx < 2) ? "Composite" : "S-Video",
                        sizeof(inp->name));
                break;
        }
        return 0;
}

static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
{
        *i = 0;
        return 0;
}
static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
{
        if (i > 0)
                return -EINVAL;
        return 0;
}

static int s2255_s_ctrl(struct v4l2_ctrl *ctrl)
{
        struct s2255_vc *vc =
                container_of(ctrl->handler, struct s2255_vc, hdl);
        struct s2255_mode mode;
        mode = vc->mode;
        /* update the mode to the corresponding value */
        switch (ctrl->id) {
        case V4L2_CID_BRIGHTNESS:
                mode.bright = ctrl->val;
                break;
        case V4L2_CID_CONTRAST:
                mode.contrast = ctrl->val;
                break;
        case V4L2_CID_HUE:
                mode.hue = ctrl->val;
                break;
        case V4L2_CID_SATURATION:
                mode.saturation = ctrl->val;
                break;
        case V4L2_CID_S2255_COLORFILTER:
                mode.color &= ~MASK_INPUT_TYPE;
                mode.color |= !ctrl->val << 16;
                break;
        case V4L2_CID_JPEG_COMPRESSION_QUALITY:
                vc->jpegqual = ctrl->val;
                return 0;
        default:
                return -EINVAL;
        }
        mode.restart = 0;
        /* set mode here.  Note: stream does not need restarted.
           some V4L programs restart stream unnecessarily
           after a s_crtl.
        */
        s2255_set_mode(vc, &mode);
        return 0;
}

static int vidioc_g_jpegcomp(struct file *file, void *priv,
                         struct v4l2_jpegcompression *jc)
{
        struct s2255_vc *vc = video_drvdata(file);

        memset(jc, 0, sizeof(*jc));
        jc->quality = vc->jpegqual;
        dprintk(vc->dev, 2, "%s: quality %d\n", __func__, jc->quality);
        return 0;
}

static int vidioc_s_jpegcomp(struct file *file, void *priv,
                         const struct v4l2_jpegcompression *jc)
{
        struct s2255_vc *vc = video_drvdata(file);

        if (jc->quality < 0 || jc->quality > 100)
                return -EINVAL;
        v4l2_ctrl_s_ctrl(vc->jpegqual_ctrl, jc->quality);
        dprintk(vc->dev, 2, "%s: quality %d\n", __func__, jc->quality);
        return 0;
}

static int vidioc_g_parm(struct file *file, void *priv,
                         struct v4l2_streamparm *sp)
{
        __u32 def_num, def_dem;
        struct s2255_vc *vc = video_drvdata(file);

        if (sp->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
                return -EINVAL;
        sp->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
        sp->parm.capture.capturemode = vc->cap_parm.capturemode;
        sp->parm.capture.readbuffers = S2255_MIN_BUFS;
        def_num = (vc->mode.format == FORMAT_NTSC) ? 1001 : 1000;
        def_dem = (vc->mode.format == FORMAT_NTSC) ? 30000 : 25000;
        sp->parm.capture.timeperframe.denominator = def_dem;
        switch (vc->mode.fdec) {
        default:
        case FDEC_1:
                sp->parm.capture.timeperframe.numerator = def_num;
                break;
        case FDEC_2:
                sp->parm.capture.timeperframe.numerator = def_num * 2;
                break;
        case FDEC_3:
                sp->parm.capture.timeperframe.numerator = def_num * 3;
                break;
        case FDEC_5:
                sp->parm.capture.timeperframe.numerator = def_num * 5;
                break;
        }
        dprintk(vc->dev, 4, "%s capture mode, %d timeperframe %d/%d\n",
                __func__,
                sp->parm.capture.capturemode,
                sp->parm.capture.timeperframe.numerator,
                sp->parm.capture.timeperframe.denominator);
        return 0;
}

static int vidioc_s_parm(struct file *file, void *priv,
                         struct v4l2_streamparm *sp)
{
        struct s2255_vc *vc = video_drvdata(file);
        struct s2255_mode mode;
        int fdec = FDEC_1;
        __u32 def_num, def_dem;
        if (sp->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
                return -EINVAL;
        mode = vc->mode;
        /* high quality capture mode requires a stream restart */
        if ((vc->cap_parm.capturemode != sp->parm.capture.capturemode)
            && vb2_is_streaming(&vc->vb_vidq))
                return -EBUSY;
        def_num = (mode.format == FORMAT_NTSC) ? 1001 : 1000;
        def_dem = (mode.format == FORMAT_NTSC) ? 30000 : 25000;
        if (def_dem != sp->parm.capture.timeperframe.denominator)
                sp->parm.capture.timeperframe.numerator = def_num;
        else if (sp->parm.capture.timeperframe.numerator <= def_num)
                sp->parm.capture.timeperframe.numerator = def_num;
        else if (sp->parm.capture.timeperframe.numerator <= (def_num * 2)) {
                sp->parm.capture.timeperframe.numerator = def_num * 2;
                fdec = FDEC_2;
        } else if (sp->parm.capture.timeperframe.numerator <= (def_num * 3)) {
                sp->parm.capture.timeperframe.numerator = def_num * 3;
                fdec = FDEC_3;
        } else {
                sp->parm.capture.timeperframe.numerator = def_num * 5;
                fdec = FDEC_5;
        }
        mode.fdec = fdec;
        sp->parm.capture.timeperframe.denominator = def_dem;
        sp->parm.capture.readbuffers = S2255_MIN_BUFS;
        s2255_set_mode(vc, &mode);
        dprintk(vc->dev, 4, "%s capture mode, %d timeperframe %d/%d, fdec %d\n",
                __func__,
                sp->parm.capture.capturemode,
                sp->parm.capture.timeperframe.numerator,
                sp->parm.capture.timeperframe.denominator, fdec);
        return 0;
}

#define NUM_SIZE_ENUMS 3
static const struct v4l2_frmsize_discrete ntsc_sizes[] = {
        { 640, 480 },
        { 640, 240 },
        { 320, 240 },
};
static const struct v4l2_frmsize_discrete pal_sizes[] = {
        { 704, 576 },
        { 704, 288 },
        { 352, 288 },
};

static int vidioc_enum_framesizes(struct file *file, void *priv,
                            struct v4l2_frmsizeenum *fe)
{
        struct s2255_vc *vc = video_drvdata(file);
        int is_ntsc = vc->std & V4L2_STD_525_60;
        const struct s2255_fmt *fmt;

        if (fe->index >= NUM_SIZE_ENUMS)
                return -EINVAL;

        fmt = format_by_fourcc(fe->pixel_format);
        if (fmt == NULL)
                return -EINVAL;
        fe->type = V4L2_FRMSIZE_TYPE_DISCRETE;
        fe->discrete = is_ntsc ?  ntsc_sizes[fe->index] : pal_sizes[fe->index];
        return 0;
}

static int vidioc_enum_frameintervals(struct file *file, void *priv,
                            struct v4l2_frmivalenum *fe)
{
        struct s2255_vc *vc = video_drvdata(file);
        const struct s2255_fmt *fmt;
        const struct v4l2_frmsize_discrete *sizes;
        int is_ntsc = vc->std & V4L2_STD_525_60;
#define NUM_FRAME_ENUMS 4
        int frm_dec[NUM_FRAME_ENUMS] = {1, 2, 3, 5};
        int i;

        if (fe->index >= NUM_FRAME_ENUMS)
                return -EINVAL;

        fmt = format_by_fourcc(fe->pixel_format);
        if (fmt == NULL)
                return -EINVAL;

        sizes = is_ntsc ? ntsc_sizes : pal_sizes;
        for (i = 0; i < NUM_SIZE_ENUMS; i++, sizes++)
                if (fe->width == sizes->width &&
                    fe->height == sizes->height)
                        break;
        if (i == NUM_SIZE_ENUMS)
                return -EINVAL;

        fe->type = V4L2_FRMIVAL_TYPE_DISCRETE;
        fe->discrete.denominator = is_ntsc ? 30000 : 25000;
        fe->discrete.numerator = (is_ntsc ? 1001 : 1000) * frm_dec[fe->index];
        dprintk(vc->dev, 4, "%s discrete %d/%d\n", __func__,
                fe->discrete.numerator,
                fe->discrete.denominator);
        return 0;
}

static int s2255_open(struct file *file)
{
        struct s2255_vc *vc = video_drvdata(file);
        struct s2255_dev *dev = vc->dev;
        int state;
        int rc = 0;

        rc = v4l2_fh_open(file);
        if (rc != 0)
                return rc;

        dprintk(dev, 1, "s2255: %s\n", __func__);
        state = atomic_read(&dev->fw_data->fw_state);
        switch (state) {
        case S2255_FW_DISCONNECTING:
                return -ENODEV;
        case S2255_FW_FAILED:
                s2255_dev_err(&dev->udev->dev,
                        "firmware load failed. retrying.\n");
                s2255_fwload_start(dev);
                wait_event_timeout(dev->fw_data->wait_fw,
                                   ((atomic_read(&dev->fw_data->fw_state)
                                     == S2255_FW_SUCCESS) ||
                                    (atomic_read(&dev->fw_data->fw_state)
                                     == S2255_FW_DISCONNECTING)),
                                   msecs_to_jiffies(S2255_LOAD_TIMEOUT));
                /* state may have changed, re-read */
                state = atomic_read(&dev->fw_data->fw_state);
                break;
        case S2255_FW_NOTLOADED:
        case S2255_FW_LOADED_DSPWAIT:
                /* give S2255_LOAD_TIMEOUT time for firmware to load in case
                   driver loaded and then device immediately opened */
                pr_info("%s waiting for firmware load\n", __func__);
                wait_event_timeout(dev->fw_data->wait_fw,
                                   ((atomic_read(&dev->fw_data->fw_state)
                                     == S2255_FW_SUCCESS) ||
                                    (atomic_read(&dev->fw_data->fw_state)
                                     == S2255_FW_DISCONNECTING)),
                                   msecs_to_jiffies(S2255_LOAD_TIMEOUT));
                /* state may have changed, re-read */
                state = atomic_read(&dev->fw_data->fw_state);
                break;
        case S2255_FW_SUCCESS:
        default:
                break;
        }
        /* state may have changed in above switch statement */
        switch (state) {
        case S2255_FW_SUCCESS:
                break;
        case S2255_FW_FAILED:
                pr_info("2255 firmware load failed.\n");
                return -ENODEV;
        case S2255_FW_DISCONNECTING:
                pr_info("%s: disconnecting\n", __func__);
                return -ENODEV;
        case S2255_FW_LOADED_DSPWAIT:
        case S2255_FW_NOTLOADED:
                pr_info("%s: firmware not loaded, please retry\n",
                        __func__);
                /*
                 * Timeout on firmware load means device unusable.
                 * Set firmware failure state.
                 * On next s2255_open the firmware will be reloaded.
                 */
                atomic_set(&dev->fw_data->fw_state,
                           S2255_FW_FAILED);
                return -EAGAIN;
        default:
                pr_info("%s: unknown state\n", __func__);
                return -EFAULT;
        }
        if (!vc->configured) {
                /* configure channel to default state */
                vc->fmt = &formats[0];
                s2255_set_mode(vc, &vc->mode);
                vc->configured = 1;
        }
        return 0;
}

static void s2255_destroy(struct s2255_dev *dev)
{
        dprintk(dev, 1, "%s", __func__);
        /* board shutdown stops the read pipe if it is running */
        s2255_board_shutdown(dev);
        /* make sure firmware still not trying to load */
        del_timer_sync(&dev->timer);  /* only started in .probe and .open */
        if (dev->fw_data->fw_urb) {
                usb_kill_urb(dev->fw_data->fw_urb);
                usb_free_urb(dev->fw_data->fw_urb);
                dev->fw_data->fw_urb = NULL;
        }
        release_firmware(dev->fw_data->fw);
        kfree(dev->fw_data->pfw_data);
        kfree(dev->fw_data);
        /* reset the DSP so firmware can be reloaded next time */
        s2255_reset_dsppower(dev);
        mutex_destroy(&dev->lock);
        usb_put_dev(dev->udev);
        v4l2_device_unregister(&dev->v4l2_dev);
        kfree(dev->cmdbuf);
        kfree(dev);
}

static const struct v4l2_file_operations s2255_fops_v4l = {
        .owner = THIS_MODULE,
        .open = s2255_open,
        .release = vb2_fop_release,
        .poll = vb2_fop_poll,
        .unlocked_ioctl = video_ioctl2, /* V4L2 ioctl handler */
        .mmap = vb2_fop_mmap,
        .read = vb2_fop_read,
};

static const struct v4l2_ioctl_ops s2255_ioctl_ops = {
        .vidioc_querycap = vidioc_querycap,
        .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
        .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
        .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
        .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
        .vidioc_reqbufs = vb2_ioctl_reqbufs,
        .vidioc_querybuf = vb2_ioctl_querybuf,
        .vidioc_qbuf = vb2_ioctl_qbuf,
        .vidioc_dqbuf = vb2_ioctl_dqbuf,
        .vidioc_s_std = vidioc_s_std,
        .vidioc_g_std = vidioc_g_std,
        .vidioc_enum_input = vidioc_enum_input,
        .vidioc_g_input = vidioc_g_input,
        .vidioc_s_input = vidioc_s_input,
        .vidioc_streamon = vb2_ioctl_streamon,
        .vidioc_streamoff = vb2_ioctl_streamoff,
        .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
        .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
        .vidioc_s_parm = vidioc_s_parm,
        .vidioc_g_parm = vidioc_g_parm,
        .vidioc_enum_framesizes = vidioc_enum_framesizes,
        .vidioc_enum_frameintervals = vidioc_enum_frameintervals,
        .vidioc_log_status  = v4l2_ctrl_log_status,
        .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
        .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
};

static void s2255_video_device_release(struct video_device *vdev)
{
        struct s2255_dev *dev = to_s2255_dev(vdev->v4l2_dev);
        struct s2255_vc *vc =
                container_of(vdev, struct s2255_vc, vdev);

        dprintk(dev, 4, "%s, chnls: %d\n", __func__,
                atomic_read(&dev->num_channels));

        v4l2_ctrl_handler_free(&vc->hdl);

        if (atomic_dec_and_test(&dev->num_channels))
                s2255_destroy(dev);
        return;
}

static const struct video_device template = {
        .name = "s2255v",
        .fops = &s2255_fops_v4l,
        .ioctl_ops = &s2255_ioctl_ops,
        .release = s2255_video_device_release,
        .tvnorms = S2255_NORMS,
};

static const struct v4l2_ctrl_ops s2255_ctrl_ops = {
        .s_ctrl = s2255_s_ctrl,
};

static const struct v4l2_ctrl_config color_filter_ctrl = {
        .ops = &s2255_ctrl_ops,
        .name = "Color Filter",
        .id = V4L2_CID_S2255_COLORFILTER,
        .type = V4L2_CTRL_TYPE_BOOLEAN,
        .max = 1,
        .step = 1,
        .def = 1,
};

static int s2255_probe_v4l(struct s2255_dev *dev)
{
        int ret;
        int i;
        int cur_nr = video_nr;
        struct s2255_vc *vc;
        struct vb2_queue *q;

        ret = v4l2_device_register(&dev->interface->dev, &dev->v4l2_dev);
        if (ret)
                return ret;
        /* initialize all video 4 linux */
        /* register 4 video devices */
        for (i = 0; i < MAX_CHANNELS; i++) {
                vc = &dev->vc[i];
                INIT_LIST_HEAD(&vc->buf_list);

                v4l2_ctrl_handler_init(&vc->hdl, 6);
                v4l2_ctrl_new_std(&vc->hdl, &s2255_ctrl_ops,
                                V4L2_CID_BRIGHTNESS, -127, 127, 1, DEF_BRIGHT);
                v4l2_ctrl_new_std(&vc->hdl, &s2255_ctrl_ops,
                                V4L2_CID_CONTRAST, 0, 255, 1, DEF_CONTRAST);
                v4l2_ctrl_new_std(&vc->hdl, &s2255_ctrl_ops,
                                V4L2_CID_SATURATION, 0, 255, 1, DEF_SATURATION);
                v4l2_ctrl_new_std(&vc->hdl, &s2255_ctrl_ops,
                                V4L2_CID_HUE, 0, 255, 1, DEF_HUE);
                vc->jpegqual_ctrl = v4l2_ctrl_new_std(&vc->hdl,
                                &s2255_ctrl_ops,
                                V4L2_CID_JPEG_COMPRESSION_QUALITY,
                                0, 100, 1, S2255_DEF_JPEG_QUAL);
                if (dev->dsp_fw_ver >= S2255_MIN_DSP_COLORFILTER &&
                    (dev->pid != 0x2257 || vc->idx <= 1))
                        v4l2_ctrl_new_custom(&vc->hdl, &color_filter_ctrl,
                                             NULL);
                if (vc->hdl.error) {
                        ret = vc->hdl.error;
                        v4l2_ctrl_handler_free(&vc->hdl);
                        dev_err(&dev->udev->dev, "couldn't register control\n");
                        break;
                }
                q = &vc->vb_vidq;
                q->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
                q->io_modes = VB2_MMAP | VB2_READ | VB2_USERPTR;
                q->drv_priv = vc;
                q->lock = &vc->vb_lock;
                q->buf_struct_size = sizeof(struct s2255_buffer);
                q->mem_ops = &vb2_vmalloc_memops;
                q->ops = &s2255_video_qops;
                q->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
                ret = vb2_queue_init(q);
                if (ret != 0) {
                        dev_err(&dev->udev->dev,
                                "%s vb2_queue_init 0x%x\n", __func__, ret);
                        break;
                }
                /* register video devices */
                vc->vdev = template;
                vc->vdev.queue = q;
                vc->vdev.ctrl_handler = &vc->hdl;
                vc->vdev.lock = &dev->lock;
                vc->vdev.v4l2_dev = &dev->v4l2_dev;
                vc->vdev.device_caps = V4L2_CAP_VIDEO_CAPTURE |
                                       V4L2_CAP_STREAMING | V4L2_CAP_READWRITE;
                video_set_drvdata(&vc->vdev, vc);
                if (video_nr == -1)
                        ret = video_register_device(&vc->vdev,
                                                    VFL_TYPE_GRABBER,
                                                    video_nr);
                else
                        ret = video_register_device(&vc->vdev,
                                                    VFL_TYPE_GRABBER,
                                                    cur_nr + i);

                if (ret) {
                        dev_err(&dev->udev->dev,
                                "failed to register video device!\n");
                        break;
                }
                atomic_inc(&dev->num_channels);
                v4l2_info(&dev->v4l2_dev, "V4L2 device registered as %s\n",
                          video_device_node_name(&vc->vdev));

        }
        pr_info("Sensoray 2255 V4L driver Revision: %s\n",
                S2255_VERSION);
        /* if no channels registered, return error and probe will fail*/
        if (atomic_read(&dev->num_channels) == 0) {
                v4l2_device_unregister(&dev->v4l2_dev);
                return ret;
        }
        if (atomic_read(&dev->num_channels) != MAX_CHANNELS)
                pr_warn("s2255: Not all channels available.\n");
        return 0;
}

/* this function moves the usb stream read pipe data
 * into the system buffers.
 * returns 0 on success, EAGAIN if more data to process( call this
 * function again).
 *
 * Received frame structure:
 * bytes 0-3:  marker : 0x2255DA4AL (S2255_MARKER_FRAME)
 * bytes 4-7:  channel: 0-3
 * bytes 8-11: payload size:  size of the frame
 * bytes 12-payloadsize+12:  frame data
 */
static int save_frame(struct s2255_dev *dev, struct s2255_pipeinfo *pipe_info)
{
        char *pdest;
        u32 offset = 0;
        int bframe = 0;
        char *psrc;
        unsigned long copy_size;
        unsigned long size;
        s32 idx = -1;
        struct s2255_framei *frm;
        unsigned char *pdata;
        struct s2255_vc *vc;
        dprintk(dev, 100, "buffer to user\n");
        vc = &dev->vc[dev->cc];
        idx = vc->cur_frame;
        frm = &vc->buffer.frame[idx];
        if (frm->ulState == S2255_READ_IDLE) {
                int jj;
                unsigned int cc;
                __le32 *pdword; /*data from dsp is little endian */
                int payload;
                /* search for marker codes */
                pdata = (unsigned char *)pipe_info->transfer_buffer;
                pdword = (__le32 *)pdata;
                for (jj = 0; jj < (pipe_info->cur_transfer_size - 12); jj++) {
                        switch (*pdword) {
                        case S2255_MARKER_FRAME:
                                dprintk(dev, 4, "marker @ offset: %d [%x %x]\n",
                                        jj, pdata[0], pdata[1]);
                                offset = jj + PREFIX_SIZE;
                                bframe = 1;
                                cc = le32_to_cpu(pdword[1]);
                                if (cc >= MAX_CHANNELS) {
                                        dprintk(dev, 0,
                                                "bad channel\n");
                                        return -EINVAL;
                                }
                                /* reverse it */
                                dev->cc = G_chnmap[cc];
                                vc = &dev->vc[dev->cc];
                                payload =  le32_to_cpu(pdword[3]);
                                if (payload > vc->req_image_size) {
                                        vc->bad_payload++;
                                        /* discard the bad frame */
                                        return -EINVAL;
                                }
                                vc->pkt_size = payload;
                                vc->jpg_size = le32_to_cpu(pdword[4]);
                                break;
                        case S2255_MARKER_RESPONSE:

                                pdata += DEF_USB_BLOCK;
                                jj += DEF_USB_BLOCK;
                                if (le32_to_cpu(pdword[1]) >= MAX_CHANNELS)
                                        break;
                                cc = G_chnmap[le32_to_cpu(pdword[1])];
                                if (cc >= MAX_CHANNELS)
                                        break;
                                vc = &dev->vc[cc];
                                switch (pdword[2]) {
                                case S2255_RESPONSE_SETMODE:
                                        /* check if channel valid */
                                        /* set mode ready */
                                        vc->setmode_ready = 1;
                                        wake_up(&vc->wait_setmode);
                                        dprintk(dev, 5, "setmode rdy %d\n", cc);
                                        break;
                                case S2255_RESPONSE_FW:
                                        dev->chn_ready |= (1 << cc);
                                        if ((dev->chn_ready & 0x0f) != 0x0f)
                                                break;
                                        /* all channels ready */
                                        pr_info("s2255: fw loaded\n");
                                        atomic_set(&dev->fw_data->fw_state,
                                                   S2255_FW_SUCCESS);
                                        wake_up(&dev->fw_data->wait_fw);
                                        break;
                                case S2255_RESPONSE_STATUS:
                                        vc->vidstatus = le32_to_cpu(pdword[3]);
                                        vc->vidstatus_ready = 1;
                                        wake_up(&vc->wait_vidstatus);
                                        dprintk(dev, 5, "vstat %x chan %d\n",
                                                le32_to_cpu(pdword[3]), cc);
                                        break;
                                default:
                                        pr_info("s2255 unknown resp\n");
                                }
                                pdata++;
                                break;
                        default:
                                pdata++;
                                break;
                        }
                        if (bframe)
                                break;
                } /* for */
                if (!bframe)
                        return -EINVAL;
        }
        vc = &dev->vc[dev->cc];
        idx = vc->cur_frame;
        frm = &vc->buffer.frame[idx];
        /* search done.  now find out if should be acquiring on this channel */
        if (!vb2_is_streaming(&vc->vb_vidq)) {
                /* we found a frame, but this channel is turned off */
                frm->ulState = S2255_READ_IDLE;
                return -EINVAL;
        }

        if (frm->ulState == S2255_READ_IDLE) {
                frm->ulState = S2255_READ_FRAME;
                frm->cur_size = 0;
        }

        /* skip the marker 512 bytes (and offset if out of sync) */
        psrc = (u8 *)pipe_info->transfer_buffer + offset;


        if (frm->lpvbits == NULL) {
                dprintk(dev, 1, "s2255 frame buffer == NULL.%p %p %d %d",
                        frm, dev, dev->cc, idx);
                return -ENOMEM;
        }

        pdest = frm->lpvbits + frm->cur_size;

        copy_size = (pipe_info->cur_transfer_size - offset);

        size = vc->pkt_size - PREFIX_SIZE;

        /* sanity check on pdest */
        if ((copy_size + frm->cur_size) < vc->req_image_size)
                memcpy(pdest, psrc, copy_size);

        frm->cur_size += copy_size;
        dprintk(dev, 4, "cur_size: %lu, size: %lu\n", frm->cur_size, size);

        if (frm->cur_size >= size) {
                dprintk(dev, 2, "******[%d]Buffer[%d]full*******\n",
                        dev->cc, idx);
                vc->last_frame = vc->cur_frame;
                vc->cur_frame++;
                /* end of system frame ring buffer, start at zero */
                if ((vc->cur_frame == SYS_FRAMES) ||
                    (vc->cur_frame == vc->buffer.dwFrames))
                        vc->cur_frame = 0;
                /* frame ready */
                if (vb2_is_streaming(&vc->vb_vidq))
                        s2255_got_frame(vc, vc->jpg_size);
                vc->frame_count++;
                frm->ulState = S2255_READ_IDLE;
                frm->cur_size = 0;

        }
        /* done successfully */
        return 0;
}

static void s2255_read_video_callback(struct s2255_dev *dev,
                                      struct s2255_pipeinfo *pipe_info)
{
        int res;
        dprintk(dev, 50, "callback read video\n");

        if (dev->cc >= MAX_CHANNELS) {
                dev->cc = 0;
                dev_err(&dev->udev->dev, "invalid channel\n");
                return;
        }
        /* otherwise copy to the system buffers */
        res = save_frame(dev, pipe_info);
        if (res != 0)
                dprintk(dev, 4, "s2255: read callback failed\n");

        dprintk(dev, 50, "callback read video done\n");
        return;
}

static long s2255_vendor_req(struct s2255_dev *dev, unsigned char Request,
                             u16 Index, u16 Value, void *TransferBuffer,
                             s32 TransferBufferLength, int bOut)
{
        int r;
        unsigned char *buf;

        buf = kmalloc(TransferBufferLength, GFP_KERNEL);
        if (!buf)
                return -ENOMEM;

        if (!bOut) {
                r = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
                                    Request,
                                    USB_TYPE_VENDOR | USB_RECIP_DEVICE |
                                    USB_DIR_IN,
                                    Value, Index, buf,
                                    TransferBufferLength, HZ * 5);

                if (r >= 0)
                        memcpy(TransferBuffer, buf, TransferBufferLength);
        } else {
                memcpy(buf, TransferBuffer, TransferBufferLength);
                r = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
                                    Request, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
                                    Value, Index, buf,
                                    TransferBufferLength, HZ * 5);
        }
        kfree(buf);
        return r;
}

/*
 * retrieve FX2 firmware version. future use.
 * @param dev pointer to device extension
 * @return -1 for fail, else returns firmware version as an int(16 bits)
 */
static int s2255_get_fx2fw(struct s2255_dev *dev)
{
        int fw;
        int ret;
        unsigned char transBuffer[64];
        ret = s2255_vendor_req(dev, S2255_VR_FW, 0, 0, transBuffer, 2,
                               S2255_VR_IN);
        if (ret < 0)
                dprintk(dev, 2, "get fw error: %x\n", ret);
        fw = transBuffer[0] + (transBuffer[1] << 8);
        dprintk(dev, 2, "Get FW %x %x\n", transBuffer[0], transBuffer[1]);
        return fw;
}

/*
 * Create the system ring buffer to copy frames into from the
 * usb read pipe.
 */
static int s2255_create_sys_buffers(struct s2255_vc *vc)
{
        unsigned long i;
        unsigned long reqsize;
        vc->buffer.dwFrames = SYS_FRAMES;
        /* always allocate maximum size(PAL) for system buffers */
        reqsize = SYS_FRAMES_MAXSIZE;

        if (reqsize > SYS_FRAMES_MAXSIZE)
                reqsize = SYS_FRAMES_MAXSIZE;

        for (i = 0; i < SYS_FRAMES; i++) {
                /* allocate the frames */
                vc->buffer.frame[i].lpvbits = vmalloc(reqsize);
                vc->buffer.frame[i].size = reqsize;
                if (vc->buffer.frame[i].lpvbits == NULL) {
                        pr_info("out of memory.  using less frames\n");
                        vc->buffer.dwFrames = i;
                        break;
                }
        }

        /* make sure internal states are set */
        for (i = 0; i < SYS_FRAMES; i++) {
                vc->buffer.frame[i].ulState = 0;
                vc->buffer.frame[i].cur_size = 0;
        }

        vc->cur_frame = 0;
        vc->last_frame = -1;
        return 0;
}

static int s2255_release_sys_buffers(struct s2255_vc *vc)
{
        unsigned long i;
        for (i = 0; i < SYS_FRAMES; i++) {
                vfree(vc->buffer.frame[i].lpvbits);
                vc->buffer.frame[i].lpvbits = NULL;
        }
        return 0;
}

static int s2255_board_init(struct s2255_dev *dev)
{
        struct s2255_mode mode_def = DEF_MODEI_NTSC_CONT;
        int fw_ver;
        int j;
        struct s2255_pipeinfo *pipe = &dev->pipe;
        dprintk(dev, 4, "board init: %p", dev);
        memset(pipe, 0, sizeof(*pipe));
        pipe->dev = dev;
        pipe->cur_transfer_size = S2255_USB_XFER_SIZE;
        pipe->max_transfer_size = S2255_USB_XFER_SIZE;

        pipe->transfer_buffer = kzalloc(pipe->max_transfer_size,
                                        GFP_KERNEL);
        if (pipe->transfer_buffer == NULL) {
                dprintk(dev, 1, "out of memory!\n");
                return -ENOMEM;
        }
        /* query the firmware */
        fw_ver = s2255_get_fx2fw(dev);

        pr_info("s2255: usb firmware version %d.%d\n",
                (fw_ver >> 8) & 0xff,

                fw_ver & 0xff);

        if (fw_ver < S2255_CUR_USB_FWVER)
                pr_info("s2255: newer USB firmware available\n");

        for (j = 0; j < MAX_CHANNELS; j++) {
                struct s2255_vc *vc = &dev->vc[j];
                vc->mode = mode_def;
                if (dev->pid == 0x2257 && j > 1)
                        vc->mode.color |= (1 << 16);
                vc->jpegqual = S2255_DEF_JPEG_QUAL;
                vc->width = LINE_SZ_4CIFS_NTSC;
                vc->height = NUM_LINES_4CIFS_NTSC * 2;
                vc->std = V4L2_STD_NTSC_M;
                vc->fmt = &formats[0];
                vc->mode.restart = 1;
                vc->req_image_size = get_transfer_size(&mode_def);
                vc->frame_count = 0;
                /* create the system buffers */
                s2255_create_sys_buffers(vc);
        }
        /* start read pipe */
        s2255_start_readpipe(dev);
        dprintk(dev, 1, "%s: success\n", __func__);
        return 0;
}

static int s2255_board_shutdown(struct s2255_dev *dev)
{
        u32 i;
        dprintk(dev, 1, "%s: dev: %p", __func__,  dev);

        for (i = 0; i < MAX_CHANNELS; i++) {
                if (vb2_is_streaming(&dev->vc[i].vb_vidq))
                        s2255_stop_acquire(&dev->vc[i]);
        }
        s2255_stop_readpipe(dev);
        for (i = 0; i < MAX_CHANNELS; i++)
                s2255_release_sys_buffers(&dev->vc[i]);
        /* release transfer buffer */
        kfree(dev->pipe.transfer_buffer);
        return 0;
}

static void read_pipe_completion(struct urb *purb)
{
        struct s2255_pipeinfo *pipe_info;
        struct s2255_dev *dev;
        int status;
        int pipe;
        pipe_info = purb->context;
        if (pipe_info == NULL) {
                dev_err(&purb->dev->dev, "no context!\n");
                return;
        }
        dev = pipe_info->dev;
        if (dev == NULL) {
                dev_err(&purb->dev->dev, "no context!\n");
                return;
        }
        status = purb->status;
        /* if shutting down, do not resubmit, exit immediately */
        if (status == -ESHUTDOWN) {
                dprintk(dev, 2, "%s: err shutdown\n", __func__);
                pipe_info->err_count++;
                return;
        }

        if (pipe_info->state == 0) {
                dprintk(dev, 2, "%s: exiting USB pipe", __func__);
                return;
        }

        if (status == 0)
                s2255_read_video_callback(dev, pipe_info);
        else {
                pipe_info->err_count++;
                dprintk(dev, 1, "%s: failed URB %d\n", __func__, status);
        }

        pipe = usb_rcvbulkpipe(dev->udev, dev->read_endpoint);
        /* reuse urb */
        usb_fill_bulk_urb(pipe_info->stream_urb, dev->udev,
                          pipe,
                          pipe_info->transfer_buffer,
                          pipe_info->cur_transfer_size,
                          read_pipe_completion, pipe_info);

        if (pipe_info->state != 0) {
                if (usb_submit_urb(pipe_info->stream_urb, GFP_ATOMIC))
                        dev_err(&dev->udev->dev, "error submitting urb\n");
        } else {
                dprintk(dev, 2, "%s :complete state 0\n", __func__);
        }
        return;
}

static int s2255_start_readpipe(struct s2255_dev *dev)
{
        int pipe;
        int retval;
        struct s2255_pipeinfo *pipe_info = &dev->pipe;
        pipe = usb_rcvbulkpipe(dev->udev, dev->read_endpoint);
        dprintk(dev, 2, "%s: IN %d\n", __func__, dev->read_endpoint);
        pipe_info->state = 1;
        pipe_info->err_count = 0;
        pipe_info->stream_urb = usb_alloc_urb(0, GFP_KERNEL);
        if (!pipe_info->stream_urb)
                return -ENOMEM;
        /* transfer buffer allocated in board_init */
        usb_fill_bulk_urb(pipe_info->stream_urb, dev->udev,
                          pipe,
                          pipe_info->transfer_buffer,
                          pipe_info->cur_transfer_size,
                          read_pipe_completion, pipe_info);
        retval = usb_submit_urb(pipe_info->stream_urb, GFP_KERNEL);
        if (retval) {
                pr_err("s2255: start read pipe failed\n");
                return retval;
        }
        return 0;
}

/* starts acquisition process */
static int s2255_start_acquire(struct s2255_vc *vc)
{
        int res;
        unsigned long chn_rev;
        int j;
        struct s2255_dev *dev = to_s2255_dev(vc->vdev.v4l2_dev);
        __le32 *buffer = dev->cmdbuf;

        mutex_lock(&dev->cmdlock);
        chn_rev = G_chnmap[vc->idx];
        vc->last_frame = -1;
        vc->bad_payload = 0;
        vc->cur_frame = 0;
        for (j = 0; j < SYS_FRAMES; j++) {
                vc->buffer.frame[j].ulState = 0;
                vc->buffer.frame[j].cur_size = 0;
        }

        /* send the start command */
        buffer[0] = IN_DATA_TOKEN;
        buffer[1] = (__le32) cpu_to_le32(chn_rev);
        buffer[2] = CMD_START;
        res = s2255_write_config(dev->udev, (unsigned char *)buffer, 512);
        if (res != 0)
                dev_err(&dev->udev->dev, "CMD_START error\n");

        dprintk(dev, 2, "start acquire exit[%d] %d\n", vc->idx, res);
        mutex_unlock(&dev->cmdlock);
        return res;
}

static int s2255_stop_acquire(struct s2255_vc *vc)
{
        int res;
        unsigned long chn_rev;
        struct s2255_dev *dev = to_s2255_dev(vc->vdev.v4l2_dev);
        __le32 *buffer = dev->cmdbuf;

        mutex_lock(&dev->cmdlock);
        chn_rev = G_chnmap[vc->idx];
        /* send the stop command */
        buffer[0] = IN_DATA_TOKEN;
        buffer[1] = (__le32) cpu_to_le32(chn_rev);
        buffer[2] = CMD_STOP;

        res = s2255_write_config(dev->udev, (unsigned char *)buffer, 512);
        if (res != 0)
                dev_err(&dev->udev->dev, "CMD_STOP error\n");

        dprintk(dev, 4, "%s: chn %d, res %d\n", __func__, vc->idx, res);
        mutex_unlock(&dev->cmdlock);
        return res;
}

static void s2255_stop_readpipe(struct s2255_dev *dev)
{
        struct s2255_pipeinfo *pipe = &dev->pipe;

        pipe->state = 0;
        if (pipe->stream_urb) {
                /* cancel urb */
                usb_kill_urb(pipe->stream_urb);
                usb_free_urb(pipe->stream_urb);
                pipe->stream_urb = NULL;
        }
        dprintk(dev, 4, "%s", __func__);
        return;
}

static void s2255_fwload_start(struct s2255_dev *dev)
{
        s2255_reset_dsppower(dev);
        dev->fw_data->fw_size = dev->fw_data->fw->size;
        atomic_set(&dev->fw_data->fw_state, S2255_FW_NOTLOADED);
        memcpy(dev->fw_data->pfw_data,
               dev->fw_data->fw->data, CHUNK_SIZE);
        dev->fw_data->fw_loaded = CHUNK_SIZE;
        usb_fill_bulk_urb(dev->fw_data->fw_urb, dev->udev,
                          usb_sndbulkpipe(dev->udev, 2),
                          dev->fw_data->pfw_data,
                          CHUNK_SIZE, s2255_fwchunk_complete,
                          dev->fw_data);
        mod_timer(&dev->timer, jiffies + HZ);
}

/* standard usb probe function */
static int s2255_probe(struct usb_interface *interface,
                       const struct usb_device_id *id)
{
        struct s2255_dev *dev = NULL;
        struct usb_host_interface *iface_desc;
        struct usb_endpoint_descriptor *endpoint;
        int i;
        int retval = -ENOMEM;
        __le32 *pdata;
        int fw_size;

        /* allocate memory for our device state and initialize it to zero */
        dev = kzalloc(sizeof(struct s2255_dev), GFP_KERNEL);
        if (dev == NULL) {
                s2255_dev_err(&interface->dev, "out of memory\n");
                return -ENOMEM;
        }

        dev->cmdbuf = kzalloc(S2255_CMDBUF_SIZE, GFP_KERNEL);
        if (dev->cmdbuf == NULL) {
                s2255_dev_err(&interface->dev, "out of memory\n");
                goto errorFWDATA1;
        }

        atomic_set(&dev->num_channels, 0);
        dev->pid = id->idProduct;
        dev->fw_data = kzalloc(sizeof(struct s2255_fw), GFP_KERNEL);
        if (!dev->fw_data)
                goto errorFWDATA1;
        mutex_init(&dev->lock);
        mutex_init(&dev->cmdlock);
        /* grab usb_device and save it */
        dev->udev = usb_get_dev(interface_to_usbdev(interface));
        if (dev->udev == NULL) {
                dev_err(&interface->dev, "null usb device\n");
                retval = -ENODEV;
                goto errorUDEV;
        }
        dev_dbg(&interface->dev, "dev: %p, udev %p interface %p\n",
                dev, dev->udev, interface);
        dev->interface = interface;
        /* set up the endpoint information  */
        iface_desc = interface->cur_altsetting;
        dev_dbg(&interface->dev, "num EP: %d\n",
                iface_desc->desc.bNumEndpoints);
        for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
                endpoint = &iface_desc->endpoint[i].desc;
                if (!dev->read_endpoint && usb_endpoint_is_bulk_in(endpoint)) {
                        /* we found the bulk in endpoint */
                        dev->read_endpoint = endpoint->bEndpointAddress;
                }
        }

        if (!dev->read_endpoint) {
                dev_err(&interface->dev, "Could not find bulk-in endpoint\n");
                goto errorEP;
        }
        timer_setup(&dev->timer, s2255_timer, 0);
        init_waitqueue_head(&dev->fw_data->wait_fw);
        for (i = 0; i < MAX_CHANNELS; i++) {
                struct s2255_vc *vc = &dev->vc[i];
                vc->idx = i;
                vc->dev = dev;
                init_waitqueue_head(&vc->wait_setmode);
                init_waitqueue_head(&vc->wait_vidstatus);
                spin_lock_init(&vc->qlock);
                mutex_init(&vc->vb_lock);
        }

        dev->fw_data->fw_urb = usb_alloc_urb(0, GFP_KERNEL);
        if (!dev->fw_data->fw_urb)
                goto errorFWURB;

        dev->fw_data->pfw_data = kzalloc(CHUNK_SIZE, GFP_KERNEL);
        if (!dev->fw_data->pfw_data) {
                dev_err(&interface->dev, "out of memory!\n");
                goto errorFWDATA2;
        }
        /* load the first chunk */
        if (request_firmware(&dev->fw_data->fw,
                             FIRMWARE_FILE_NAME, &dev->udev->dev)) {
                dev_err(&interface->dev, "sensoray 2255 failed to get firmware\n");
                goto errorREQFW;
        }
        /* check the firmware is valid */
        fw_size = dev->fw_data->fw->size;
        pdata = (__le32 *) &dev->fw_data->fw->data[fw_size - 8];

        if (*pdata != S2255_FW_MARKER) {
                dev_err(&interface->dev, "Firmware invalid.\n");
                retval = -ENODEV;
                goto errorFWMARKER;
        } else {
                /* make sure firmware is the latest */
                __le32 *pRel;
                pRel = (__le32 *) &dev->fw_data->fw->data[fw_size - 4];
                pr_info("s2255 dsp fw version %x\n", le32_to_cpu(*pRel));
                dev->dsp_fw_ver = le32_to_cpu(*pRel);
                if (dev->dsp_fw_ver < S2255_CUR_DSP_FWVER)
                        pr_info("s2255: f2255usb.bin out of date.\n");
                if (dev->pid == 0x2257 &&
                                dev->dsp_fw_ver < S2255_MIN_DSP_COLORFILTER)
                        pr_warn("2257 needs firmware %d or above.\n",
                                S2255_MIN_DSP_COLORFILTER);
        }
        usb_reset_device(dev->udev);
        /* load 2255 board specific */
        retval = s2255_board_init(dev);
        if (retval)
                goto errorBOARDINIT;
        s2255_fwload_start(dev);
        /* loads v4l specific */
        retval = s2255_probe_v4l(dev);
        if (retval)
                goto errorBOARDINIT;
        dev_info(&interface->dev, "Sensoray 2255 detected\n");
        return 0;
errorBOARDINIT:
        s2255_board_shutdown(dev);
errorFWMARKER:
        release_firmware(dev->fw_data->fw);
errorREQFW:
        kfree(dev->fw_data->pfw_data);
errorFWDATA2:
        usb_free_urb(dev->fw_data->fw_urb);
errorFWURB:
        del_timer_sync(&dev->timer);
errorEP:
        usb_put_dev(dev->udev);
errorUDEV:
        kfree(dev->fw_data);
        mutex_destroy(&dev->lock);
errorFWDATA1:
        kfree(dev->cmdbuf);
        kfree(dev);
        pr_warn("Sensoray 2255 driver load failed: 0x%x\n", retval);
        return retval;
}

/* disconnect routine. when board is removed physically or with rmmod */
static void s2255_disconnect(struct usb_interface *interface)
{
        struct s2255_dev *dev = to_s2255_dev(usb_get_intfdata(interface));
        int i;
        int channels = atomic_read(&dev->num_channels);
        mutex_lock(&dev->lock);
        v4l2_device_disconnect(&dev->v4l2_dev);
        mutex_unlock(&dev->lock);
        /*see comments in the uvc_driver.c usb disconnect function */
        atomic_inc(&dev->num_channels);
        /* unregister each video device. */
        for (i = 0; i < channels; i++)
                video_unregister_device(&dev->vc[i].vdev);
        /* wake up any of our timers */
        atomic_set(&dev->fw_data->fw_state, S2255_FW_DISCONNECTING);
        wake_up(&dev->fw_data->wait_fw);
        for (i = 0; i < MAX_CHANNELS; i++) {
                dev->vc[i].setmode_ready = 1;
                wake_up(&dev->vc[i].wait_setmode);
                dev->vc[i].vidstatus_ready = 1;
                wake_up(&dev->vc[i].wait_vidstatus);
        }
        if (atomic_dec_and_test(&dev->num_channels))
                s2255_destroy(dev);
        dev_info(&interface->dev, "%s\n", __func__);
}

static struct usb_driver s2255_driver = {
        .name = S2255_DRIVER_NAME,
        .probe = s2255_probe,
        .disconnect = s2255_disconnect,
        .id_table = s2255_table,
};

module_usb_driver(s2255_driver);

MODULE_DESCRIPTION("Sensoray 2255 Video for Linux driver");
MODULE_AUTHOR("Dean Anderson (Sensoray Company Inc.)");
MODULE_LICENSE("GPL");
MODULE_VERSION(S2255_VERSION);
MODULE_FIRMWARE(FIRMWARE_FILE_NAME);