V4L/DVB (8870): gspca: Fix dark room problem with sonixb.
[linux-2.6] / drivers / media / video / sn9c102 / sn9c102.h
1 /***************************************************************************
2  * V4L2 driver for SN9C1xx PC Camera Controllers                           *
3  *                                                                         *
4  * Copyright (C) 2004-2006 by Luca Risolia <luca.risolia@studio.unibo.it>  *
5  *                                                                         *
6  * This program is free software; you can redistribute it and/or modify    *
7  * it under the terms of the GNU General Public License as published by    *
8  * the Free Software Foundation; either version 2 of the License, or       *
9  * (at your option) any later version.                                     *
10  *                                                                         *
11  * This program is distributed in the hope that it will be useful,         *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of          *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           *
14  * GNU General Public License for more details.                            *
15  *                                                                         *
16  * You should have received a copy of the GNU General Public License       *
17  * along with this program; if not, write to the Free Software             *
18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.               *
19  ***************************************************************************/
20
21 #ifndef _SN9C102_H_
22 #define _SN9C102_H_
23
24 #include <linux/version.h>
25 #include <linux/usb.h>
26 #include <linux/videodev2.h>
27 #include <media/v4l2-common.h>
28 #include <media/v4l2-ioctl.h>
29 #include <linux/device.h>
30 #include <linux/list.h>
31 #include <linux/spinlock.h>
32 #include <linux/time.h>
33 #include <linux/wait.h>
34 #include <linux/types.h>
35 #include <linux/param.h>
36 #include <linux/rwsem.h>
37 #include <linux/mutex.h>
38 #include <linux/string.h>
39 #include <linux/stddef.h>
40 #include <linux/kref.h>
41
42 #include "sn9c102_config.h"
43 #include "sn9c102_sensor.h"
44 #include "sn9c102_devtable.h"
45
46
47 enum sn9c102_frame_state {
48         F_UNUSED,
49         F_QUEUED,
50         F_GRABBING,
51         F_DONE,
52         F_ERROR,
53 };
54
55 struct sn9c102_frame_t {
56         void* bufmem;
57         struct v4l2_buffer buf;
58         enum sn9c102_frame_state state;
59         struct list_head frame;
60         unsigned long vma_use_count;
61 };
62
63 enum sn9c102_dev_state {
64         DEV_INITIALIZED = 0x01,
65         DEV_DISCONNECTED = 0x02,
66         DEV_MISCONFIGURED = 0x04,
67 };
68
69 enum sn9c102_io_method {
70         IO_NONE,
71         IO_READ,
72         IO_MMAP,
73 };
74
75 enum sn9c102_stream_state {
76         STREAM_OFF,
77         STREAM_INTERRUPT,
78         STREAM_ON,
79 };
80
81 typedef char sn9c102_sof_header_t[62];
82
83 struct sn9c102_sof_t {
84         sn9c102_sof_header_t header;
85         u16 bytesread;
86 };
87
88 struct sn9c102_sysfs_attr {
89         u16 reg, i2c_reg;
90         sn9c102_sof_header_t frame_header;
91 };
92
93 struct sn9c102_module_param {
94         u8 force_munmap;
95         u16 frame_timeout;
96 };
97
98 static DEFINE_MUTEX(sn9c102_sysfs_lock);
99 static DECLARE_RWSEM(sn9c102_dev_lock);
100
101 struct sn9c102_device {
102         struct video_device* v4ldev;
103
104         enum sn9c102_bridge bridge;
105         struct sn9c102_sensor sensor;
106
107         struct usb_device* usbdev;
108         struct urb* urb[SN9C102_URBS];
109         void* transfer_buffer[SN9C102_URBS];
110         u8* control_buffer;
111
112         struct sn9c102_frame_t *frame_current, frame[SN9C102_MAX_FRAMES];
113         struct list_head inqueue, outqueue;
114         u32 frame_count, nbuffers, nreadbuffers;
115
116         enum sn9c102_io_method io;
117         enum sn9c102_stream_state stream;
118
119         struct v4l2_jpegcompression compression;
120
121         struct sn9c102_sysfs_attr sysfs;
122         struct sn9c102_sof_t sof;
123         u16 reg[384];
124
125         struct sn9c102_module_param module_param;
126
127         struct kref kref;
128         enum sn9c102_dev_state state;
129         u8 users;
130
131         struct completion probe;
132         struct mutex open_mutex, fileop_mutex;
133         spinlock_t queue_lock;
134         wait_queue_head_t wait_open, wait_frame, wait_stream;
135 };
136
137 /*****************************************************************************/
138
139 struct sn9c102_device*
140 sn9c102_match_id(struct sn9c102_device* cam, const struct usb_device_id *id)
141 {
142         return usb_match_id(usb_ifnum_to_if(cam->usbdev, 0), id) ? cam : NULL;
143 }
144
145
146 void
147 sn9c102_attach_sensor(struct sn9c102_device* cam,
148                       const struct sn9c102_sensor* sensor)
149 {
150         memcpy(&cam->sensor, sensor, sizeof(struct sn9c102_sensor));
151 }
152
153
154 enum sn9c102_bridge
155 sn9c102_get_bridge(struct sn9c102_device* cam)
156 {
157         return cam->bridge;
158 }
159
160
161 struct sn9c102_sensor* sn9c102_get_sensor(struct sn9c102_device* cam)
162 {
163         return &cam->sensor;
164 }
165
166 /*****************************************************************************/
167
168 #undef DBG
169 #undef KDBG
170 #ifdef SN9C102_DEBUG
171 #       define DBG(level, fmt, args...)                                       \
172 do {                                                                          \
173         if (debug >= (level)) {                                               \
174                 if ((level) == 1)                                             \
175                         dev_err(&cam->usbdev->dev, fmt "\n", ## args);        \
176                 else if ((level) == 2)                                        \
177                         dev_info(&cam->usbdev->dev, fmt "\n", ## args);       \
178                 else if ((level) >= 3)                                        \
179                         dev_info(&cam->usbdev->dev, "[%s:%d] " fmt "\n",      \
180                                  __func__, __LINE__ , ## args);           \
181         }                                                                     \
182 } while (0)
183 #       define V4LDBG(level, name, cmd)                                       \
184 do {                                                                          \
185         if (debug >= (level))                                                 \
186                 v4l_print_ioctl(name, cmd);                                   \
187 } while (0)
188 #       define KDBG(level, fmt, args...)                                      \
189 do {                                                                          \
190         if (debug >= (level)) {                                               \
191                 if ((level) == 1 || (level) == 2)                             \
192                         pr_info("sn9c102: " fmt "\n", ## args);               \
193                 else if ((level) == 3)                                        \
194                         pr_debug("sn9c102: [%s:%d] " fmt "\n",                \
195                                  __func__, __LINE__ , ## args);           \
196         }                                                                     \
197 } while (0)
198 #else
199 #       define DBG(level, fmt, args...) do {;} while(0)
200 #       define V4LDBG(level, name, cmd) do {;} while(0)
201 #       define KDBG(level, fmt, args...) do {;} while(0)
202 #endif
203
204 #undef PDBG
205 #define PDBG(fmt, args...)                                                    \
206 dev_info(&cam->usbdev->dev, "[%s:%s:%d] " fmt "\n", __FILE__, __func__,   \
207          __LINE__ , ## args)
208
209 #undef PDBGG
210 #define PDBGG(fmt, args...) do {;} while(0) /* placeholder */
211
212 #endif /* _SN9C102_H_ */