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