LXR linux/drivers/media/video/gspca/gspca.h

   1#ifndef GSPCAV2_H
   2#define GSPCAV2_H
   3
   4#include <linux/module.h>
   5#include <linux/kernel.h>
   6#include <linux/usb.h>
   7#include <linux/videodev2.h>
   8#include <media/v4l2-common.h>
   9#include <linux/mutex.h>
  10
  11/* compilation option */
  12#define GSPCA_DEBUG 1
  13
  14#ifdef GSPCA_DEBUG
  15/* GSPCA our debug messages */
  16extern int gspca_debug;
  17#define PDEBUG(level, fmt, args...) \
  18        do {\
  19                if (gspca_debug & (level)) \
  20                        printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## args); \
  21        } while (0)
  22#define D_ERR  0x01
  23#define D_PROBE 0x02
  24#define D_CONF 0x04
  25#define D_STREAM 0x08
  26#define D_FRAM 0x10
  27#define D_PACK 0x20
  28#define D_USBI 0x40
  29#define D_USBO 0x80
  30#define D_V4L2 0x0100
  31#else
  32#define PDEBUG(level, fmt, args...)
  33#endif
  34#undef err
  35#define err(fmt, args...) \
  36        printk(KERN_ERR MODULE_NAME ": " fmt "\n", ## args)
  37#undef info
  38#define info(fmt, args...) \
  39        printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## args)
  40#undef warn
  41#define warn(fmt, args...) \
  42        printk(KERN_WARNING MODULE_NAME ": " fmt "\n", ## args)
  43
  44#define GSPCA_MAX_FRAMES 16     /* maximum number of video frame buffers */
  45/* image transfers */
  46#define MAX_NURBS 4             /* max number of URBs */
  47
  48/* device information - set at probe time */
  49struct cam {
  50        int bulk_size;          /* buffer size when image transfer by bulk */
  51        const struct v4l2_pix_format *cam_mode; /* size nmodes */
  52        char nmodes;
  53        __u8 bulk_nurbs;        /* number of URBs in bulk mode
  54                                 * - cannot be > MAX_NURBS
  55                                 * - when 0 and bulk_size != 0 means
  56                                 *   1 URB and submit done by subdriver */
  57        u8 bulk;                /* image transfer by 0:isoc / 1:bulk */
  58        u8 npkt;                /* number of packets in an ISOC message
  59                                 * 0 is the default value: 32 packets */
  60        u32 input_flags;        /* value for ENUM_INPUT status flags */
  61};
  62
  63struct gspca_dev;
  64struct gspca_frame;
  65
  66/* subdriver operations */
  67typedef int (*cam_op) (struct gspca_dev *);
  68typedef void (*cam_v_op) (struct gspca_dev *);
  69typedef int (*cam_cf_op) (struct gspca_dev *, const struct usb_device_id *);
  70typedef int (*cam_jpg_op) (struct gspca_dev *,
  71                                struct v4l2_jpegcompression *);
  72typedef int (*cam_reg_op) (struct gspca_dev *,
  73                                struct v4l2_dbg_register *);
  74typedef int (*cam_ident_op) (struct gspca_dev *,
  75                                struct v4l2_dbg_chip_ident *);
  76typedef int (*cam_streamparm_op) (struct gspca_dev *,
  77                                  struct v4l2_streamparm *);
  78typedef int (*cam_qmnu_op) (struct gspca_dev *,
  79                        struct v4l2_querymenu *);
  80typedef void (*cam_pkt_op) (struct gspca_dev *gspca_dev,
  81                                struct gspca_frame *frame,
  82                                __u8 *data,
  83                                int len);
  84
  85struct ctrl {
  86        struct v4l2_queryctrl qctrl;
  87        int (*set)(struct gspca_dev *, __s32);
  88        int (*get)(struct gspca_dev *, __s32 *);
  89};
  90
  91/* subdriver description */
  92struct sd_desc {
  93/* information */
  94        const char *name;       /* sub-driver name */
  95/* controls */
  96        const struct ctrl *ctrls;
  97        int nctrls;
  98/* mandatory operations */
  99        cam_cf_op config;       /* called on probe */
 100        cam_op init;            /* called on probe and resume */
 101        cam_op start;           /* called on stream on after URBs creation */
 102        cam_pkt_op pkt_scan;
 103/* optional operations */
 104        cam_op isoc_init;       /* called on stream on before getting the EP */
 105        cam_op isoc_nego;       /* called when URB submit failed with NOSPC */
 106        cam_v_op stopN;         /* called on stream off - main alt */
 107        cam_v_op stop0;         /* called on stream off & disconnect - alt 0 */
 108        cam_v_op dq_callback;   /* called when a frame has been dequeued */
 109        cam_jpg_op get_jcomp;
 110        cam_jpg_op set_jcomp;
 111        cam_qmnu_op querymenu;
 112        cam_streamparm_op get_streamparm;
 113        cam_streamparm_op set_streamparm;
 114#ifdef CONFIG_VIDEO_ADV_DEBUG
 115        cam_reg_op set_register;
 116        cam_reg_op get_register;
 117#endif
 118        cam_ident_op get_chip_ident;
 119};
 120
 121/* packet types when moving from iso buf to frame buf */
 122enum gspca_packet_type {
 123        DISCARD_PACKET,
 124        FIRST_PACKET,
 125        INTER_PACKET,
 126        LAST_PACKET
 127};
 128
 129struct gspca_frame {
 130        __u8 *data;                     /* frame buffer */
 131        __u8 *data_end;                 /* end of frame while filling */
 132        int vma_use_count;
 133        struct v4l2_buffer v4l2_buf;
 134};
 135
 136struct gspca_dev {
 137        struct video_device vdev;       /* !! must be the first item */
 138        struct module *module;          /* subdriver handling the device */
 139        struct usb_device *dev;
 140        struct file *capt_file;         /* file doing video capture */
 141
 142        struct cam cam;                         /* device information */
 143        const struct sd_desc *sd_desc;          /* subdriver description */
 144        unsigned ctrl_dis;              /* disabled controls (bit map) */
 145
 146#define USB_BUF_SZ 64
 147        __u8 *usb_buf;                          /* buffer for USB exchanges */
 148        struct urb *urb[MAX_NURBS];
 149
 150        __u8 *frbuf;                            /* buffer for nframes */
 151        struct gspca_frame frame[GSPCA_MAX_FRAMES];
 152        __u32 frsz;                             /* frame size */
 153        char nframes;                           /* number of frames */
 154        char fr_i;                              /* frame being filled */
 155        char fr_q;                              /* next frame to queue */
 156        char fr_o;                              /* next frame to dequeue */
 157        signed char fr_queue[GSPCA_MAX_FRAMES]; /* frame queue */
 158        __u8 last_packet_type;
 159        __s8 empty_packet;              /* if (-1) don't check empty packets */
 160        __u8 streaming;
 161
 162        __u8 curr_mode;                 /* current camera mode */
 163        __u32 pixfmt;                   /* current mode parameters */
 164        __u16 width;
 165        __u16 height;
 166        __u32 sequence;                 /* frame sequence number */
 167
 168        wait_queue_head_t wq;           /* wait queue */
 169        struct mutex usb_lock;          /* usb exchange protection */
 170        struct mutex read_lock;         /* read protection */
 171        struct mutex queue_lock;        /* ISOC queue protection */
 172#ifdef CONFIG_PM
 173        char frozen;                    /* suspend - resume */
 174#endif
 175        char users;                     /* number of opens */
 176        char present;                   /* device connected */
 177        char nbufread;                  /* number of buffers for read() */
 178        char nurbs;                     /* number of allocated URBs */
 179        char memory;                    /* memory type (V4L2_MEMORY_xxx) */
 180        __u8 iface;                     /* USB interface number */
 181        __u8 alt;                       /* USB alternate setting */
 182        __u8 nbalt;                     /* number of USB alternate settings */
 183        u16 pkt_size;                   /* ISOC packet size */
 184};
 185
 186int gspca_dev_probe(struct usb_interface *intf,
 187                const struct usb_device_id *id,
 188                const struct sd_desc *sd_desc,
 189                int dev_size,
 190                struct module *module);
 191void gspca_disconnect(struct usb_interface *intf);
 192struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
 193                                    enum gspca_packet_type packet_type,
 194                                    struct gspca_frame *frame,
 195                                    const __u8 *data,
 196                                    int len);
 197struct gspca_frame *gspca_get_i_frame(struct gspca_dev *gspca_dev);
 198#ifdef CONFIG_PM
 199int gspca_suspend(struct usb_interface *intf, pm_message_t message);
 200int gspca_resume(struct usb_interface *intf);
 201#endif
 202int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
 203        int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee);
 204#endif /* GSPCAV2_H */
 205