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 */
  16 extern 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 #define ISO_MAX_PKT 32          /* max number of packets in an ISOC transfer */
  48 #define ISO_MAX_SIZE 0x8000     /* max size of one URB buffer (32 Kb) */
  49
  50 /* device information - set at probe time */
  51 struct cam {
  52         int bulk_size;          /* buffer size when image transfer by bulk */
  53         const struct v4l2_pix_format *cam_mode; /* size nmodes */
  54         char nmodes;
  55         __u8 bulk_nurbs;        /* number of URBs in bulk mode
  56                                  * - cannot be > MAX_NURBS
  57                                  * - when 0 and bulk_size != 0 means
  58                                  *   1 URB and submit done by subdriver */
  59         u32 input_flags;        /* value for ENUM_INPUT status flags */
  60 };
  61
  62 struct gspca_dev;
  63 struct gspca_frame;
  64
  65 /* subdriver operations */
  66 typedef int (*cam_op) (struct gspca_dev *);
  67 typedef void (*cam_v_op) (struct gspca_dev *);
  68 typedef int (*cam_cf_op) (struct gspca_dev *, const struct usb_device_id *);
  69 typedef int (*cam_jpg_op) (struct gspca_dev *,
  70                                 struct v4l2_jpegcompression *);
  71 typedef int (*cam_streamparm_op) (struct gspca_dev *,
  72                                   struct v4l2_streamparm *);
  73 typedef int (*cam_qmnu_op) (struct gspca_dev *,
  74                         struct v4l2_querymenu *);
  75 typedef void (*cam_pkt_op) (struct gspca_dev *gspca_dev,
  76                                 struct gspca_frame *frame,
  77                                 __u8 *data,
  78                                 int len);
  79
  80 struct ctrl {
  81         struct v4l2_queryctrl qctrl;
  82         int (*set)(struct gspca_dev *, __s32);
  83         int (*get)(struct gspca_dev *, __s32 *);
  84 };
  85
  86 /* subdriver description */
  87 struct sd_desc {
  88 /* information */
  89         const char *name;       /* sub-driver name */
  90 /* controls */
  91         const struct ctrl *ctrls;
  92         int nctrls;
  93 /* mandatory operations */
  94         cam_cf_op config;       /* called on probe */
  95         cam_op init;            /* called on probe and resume */
  96         cam_op start;           /* called on stream on */
  97         cam_pkt_op pkt_scan;
  98 /* optional operations */
  99         cam_v_op stopN;         /* called on stream off - main alt */
 100         cam_v_op stop0;         /* called on stream off & disconnect - alt 0 */
 101         cam_v_op dq_callback;   /* called when a frame has been dequeued */
 102         cam_jpg_op get_jcomp;
 103         cam_jpg_op set_jcomp;
 104         cam_qmnu_op querymenu;
 105         cam_streamparm_op get_streamparm;
 106         cam_streamparm_op set_streamparm;
 107 };
 108
 109 /* packet types when moving from iso buf to frame buf */
 110 enum gspca_packet_type {
 111         DISCARD_PACKET,
 112         FIRST_PACKET,
 113         INTER_PACKET,
 114         LAST_PACKET
 115 };
 116
 117 struct gspca_frame {
 118         __u8 *data;                     /* frame buffer */
 119         __u8 *data_end;                 /* end of frame while filling */
 120         int vma_use_count;
 121         struct v4l2_buffer v4l2_buf;
 122 };
 123
 124 struct gspca_dev {
 125         struct video_device vdev;       /* !! must be the first item */
 126         struct module *module;          /* subdriver handling the device */
 127         struct usb_device *dev;
 128         struct file *capt_file;         /* file doing video capture */
 129
 130         struct cam cam;                         /* device information */
 131         const struct sd_desc *sd_desc;          /* subdriver description */
 132         unsigned ctrl_dis;              /* disabled controls (bit map) */
 133
 134 #define USB_BUF_SZ 64
 135         __u8 *usb_buf;                          /* buffer for USB exchanges */
 136         struct urb *urb[MAX_NURBS];
 137
 138         __u8 *frbuf;                            /* buffer for nframes */
 139         struct gspca_frame frame[GSPCA_MAX_FRAMES];
 140         __u32 frsz;                             /* frame size */
 141         char nframes;                           /* number of frames */
 142         char fr_i;                              /* frame being filled */
 143         char fr_q;                              /* next frame to queue */
 144         char fr_o;                              /* next frame to dequeue */
 145         signed char fr_queue[GSPCA_MAX_FRAMES]; /* frame queue */
 146         __u8 last_packet_type;
 147         __s8 empty_packet;              /* if (-1) don't check empty packets */
 148         __u8 streaming;
 149
 150         __u8 curr_mode;                 /* current camera mode */
 151         __u32 pixfmt;                   /* current mode parameters */
 152         __u16 width;
 153         __u16 height;
 154         __u32 sequence;                 /* frame sequence number */
 155
 156         wait_queue_head_t wq;           /* wait queue */
 157         struct mutex usb_lock;          /* usb exchange protection */
 158         struct mutex read_lock;         /* read protection */
 159         struct mutex queue_lock;        /* ISOC queue protection */
 160 #ifdef CONFIG_PM
 161         char frozen;                    /* suspend - resume */
 162 #endif
 163         char users;                     /* number of opens */
 164         char present;                   /* device connected */
 165         char nbufread;                  /* number of buffers for read() */
 166         char nurbs;                     /* number of allocated URBs */
 167         char memory;                    /* memory type (V4L2_MEMORY_xxx) */
 168         __u8 iface;                     /* USB interface number */
 169         __u8 alt;                       /* USB alternate setting */
 170         __u8 nbalt;                     /* number of USB alternate settings */
 171         u8 bulk;                        /* image transfer by 0:isoc / 1:bulk */
 172 };
 173
 174 int gspca_dev_probe(struct usb_interface *intf,
 175                 const struct usb_device_id *id,
 176                 const struct sd_desc *sd_desc,
 177                 int dev_size,
 178                 struct module *module);
 179 void gspca_disconnect(struct usb_interface *intf);
 180 struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
 181                                     enum gspca_packet_type packet_type,
 182                                     struct gspca_frame *frame,
 183                                     const __u8 *data,
 184                                     int len);
 185 struct gspca_frame *gspca_get_i_frame(struct gspca_dev *gspca_dev);
 186 #ifdef CONFIG_PM
 187 int gspca_suspend(struct usb_interface *intf, pm_message_t message);
 188 int gspca_resume(struct usb_interface *intf);
 189 #endif
 190 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
 191         int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee);
 192 #endif /* GSPCAV2_H */