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