ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / drivers / media / video / meye.h
1 /* 
2  * Motion Eye video4linux driver for Sony Vaio PictureBook
3  *
4  * Copyright (C) 2001-2003 Stelian Pop <stelian@popies.net>
5  *
6  * Copyright (C) 2001-2002 AlcĂ´ve <www.alcove.com>
7  *
8  * Copyright (C) 2000 Andrew Tridgell <tridge@valinux.com>
9  *
10  * Earlier work by Werner Almesberger, Paul `Rusty' Russell and Paul Mackerras.
11  * 
12  * Some parts borrowed from various video4linux drivers, especially
13  * bttv-driver.c and zoran.c, see original files for credits.
14  * 
15  * This program is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation; either version 2 of the License, or
18  * (at your option) any later version.
19  * 
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  * 
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28  */
29
30 #ifndef _MEYE_PRIV_H_
31 #define _MEYE_PRIV_H_
32
33 #define MEYE_DRIVER_MAJORVERSION        1
34 #define MEYE_DRIVER_MINORVERSION        9
35
36 #include <linux/config.h>
37 #include <linux/types.h>
38 #include <linux/pci.h>
39
40 /****************************************************************************/
41 /* Motion JPEG chip registers                                               */
42 /****************************************************************************/
43
44 /* Motion JPEG chip PCI configuration registers */
45 #define MCHIP_PCI_POWER_CSR             0x54
46 #define MCHIP_PCI_MCORE_STATUS          0x60    /* see HIC_STATUS   */
47 #define MCHIP_PCI_HOSTUSEREQ_SET        0x64
48 #define MCHIP_PCI_HOSTUSEREQ_CLR        0x68
49 #define MCHIP_PCI_LOWPOWER_SET          0x6c
50 #define MCHIP_PCI_LOWPOWER_CLR          0x70
51 #define MCHIP_PCI_SOFTRESET_SET         0x74
52
53 /* Motion JPEG chip memory mapped registers */
54 #define MCHIP_MM_REGS                   0x200           /* 512 bytes        */
55 #define MCHIP_REG_TIMEOUT               1000            /* reg access, ~us  */
56 #define MCHIP_MCC_VRJ_TIMEOUT           1000            /* MCC & VRJ access */
57
58 #define MCHIP_MM_PCI_MODE               0x00            /* PCI access mode */
59 #define MCHIP_MM_PCI_MODE_RETRY         0x00000001      /* retry mode */
60 #define MCHIP_MM_PCI_MODE_MASTER        0x00000002      /* master access */
61 #define MCHIP_MM_PCI_MODE_READ_LINE     0x00000004      /* read line */
62
63 #define MCHIP_MM_INTA                   0x04            /* Int status/mask */
64 #define MCHIP_MM_INTA_MCC               0x00000001      /* MCC interrupt */
65 #define MCHIP_MM_INTA_VRJ               0x00000002      /* VRJ interrupt */
66 #define MCHIP_MM_INTA_HIC_1             0x00000004      /* one frame done */
67 #define MCHIP_MM_INTA_HIC_1_MASK        0x00000400      /* 1: enable */
68 #define MCHIP_MM_INTA_HIC_END           0x00000008      /* all frames done */
69 #define MCHIP_MM_INTA_HIC_END_MASK      0x00000800
70 #define MCHIP_MM_INTA_JPEG              0x00000010      /* decompress. error */
71 #define MCHIP_MM_INTA_JPEG_MASK         0x00001000
72 #define MCHIP_MM_INTA_CAPTURE           0x00000020      /* capture end */
73 #define MCHIP_MM_INTA_PCI_ERR           0x00000040      /* PCI error */
74 #define MCHIP_MM_INTA_PCI_ERR_MASK      0x00004000
75
76 #define MCHIP_MM_PT_ADDR                0x08            /* page table address */
77                                                         /* n*4kB */
78 #define MCHIP_NB_PAGES                  1024            /* pages for display */
79 #define MCHIP_NB_PAGES_MJPEG            256             /* pages for mjpeg */
80
81 #define MCHIP_MM_FIR(n)                 (0x0c+(n)*4)    /* Frame info 0-3 */
82 #define MCHIP_MM_FIR_RDY                0x00000001      /* frame ready */
83 #define MCHIP_MM_FIR_FAILFR_MASK        0xf8000000      /* # of failed frames */
84 #define MCHIP_MM_FIR_FAILFR_SHIFT       27
85
86         /* continuous comp/decomp mode */
87 #define MCHIP_MM_FIR_C_ENDL_MASK        0x000007fe      /* end DW [10] */
88 #define MCHIP_MM_FIR_C_ENDL_SHIFT       1
89 #define MCHIP_MM_FIR_C_ENDP_MASK        0x0007f800      /* end page [8] */
90 #define MCHIP_MM_FIR_C_ENDP_SHIFT       11
91 #define MCHIP_MM_FIR_C_STARTP_MASK      0x07f80000      /* start page [8] */
92 #define MCHIP_MM_FIR_C_STARTP_SHIFT     19
93
94         /* continuous picture output mode */
95 #define MCHIP_MM_FIR_O_STARTP_MASK      0x7ffe0000      /* start page [10] */
96 #define MCHIP_MM_FIR_O_STARTP_SHIFT     17
97
98 #define MCHIP_MM_FIFO_DATA              0x1c            /* PCI TGT FIFO data */
99 #define MCHIP_MM_FIFO_STATUS            0x20            /* PCI TGT FIFO stat */
100 #define MCHIP_MM_FIFO_MASK              0x00000003
101 #define MCHIP_MM_FIFO_WAIT_OR_READY     0x00000002      /* Bits common to WAIT & READY*/
102 #define MCHIP_MM_FIFO_IDLE              0x0             /* HIC idle */
103 #define MCHIP_MM_FIFO_IDLE1             0x1             /* idem ??? */
104 #define MCHIP_MM_FIFO_WAIT              0x2             /* wait request */
105 #define MCHIP_MM_FIFO_READY             0x3             /* data ready */
106
107 #define MCHIP_HIC_HOST_USEREQ           0x40            /* host uses MCORE */
108
109 #define MCHIP_HIC_TP_BUSY               0x44            /* taking picture */
110
111 #define MCHIP_HIC_PIC_SAVED             0x48            /* pic in SDRAM */
112
113 #define MCHIP_HIC_LOWPOWER              0x4c            /* clock stopped */
114
115 #define MCHIP_HIC_CTL                   0x50            /* HIC control */
116 #define MCHIP_HIC_CTL_SOFT_RESET        0x00000001      /* MCORE reset */
117 #define MCHIP_HIC_CTL_MCORE_RDY         0x00000002      /* MCORE ready */
118
119 #define MCHIP_HIC_CMD                   0x54            /* HIC command */
120 #define MCHIP_HIC_CMD_BITS              0x00000003      /* cmd width=[1:0]*/
121 #define MCHIP_HIC_CMD_NOOP              0x0
122 #define MCHIP_HIC_CMD_START             0x1
123 #define MCHIP_HIC_CMD_STOP              0x2
124
125 #define MCHIP_HIC_MODE                  0x58
126 #define MCHIP_HIC_MODE_NOOP             0x0
127 #define MCHIP_HIC_MODE_STILL_CAP        0x1             /* still pic capt */
128 #define MCHIP_HIC_MODE_DISPLAY          0x2             /* display */
129 #define MCHIP_HIC_MODE_STILL_COMP       0x3             /* still pic comp. */
130 #define MCHIP_HIC_MODE_STILL_DECOMP     0x4             /* still pic decomp. */
131 #define MCHIP_HIC_MODE_CONT_COMP        0x5             /* cont capt+comp */
132 #define MCHIP_HIC_MODE_CONT_DECOMP      0x6             /* cont decomp+disp */
133 #define MCHIP_HIC_MODE_STILL_OUT        0x7             /* still pic output */
134 #define MCHIP_HIC_MODE_CONT_OUT         0x8             /* cont output */
135
136 #define MCHIP_HIC_STATUS                0x5c
137 #define MCHIP_HIC_STATUS_MCC_RDY        0x00000001      /* MCC reg acc ok */
138 #define MCHIP_HIC_STATUS_VRJ_RDY        0x00000002      /* VRJ reg acc ok */
139 #define MCHIP_HIC_STATUS_IDLE           0x00000003
140 #define MCHIP_HIC_STATUS_CAPDIS         0x00000004      /* cap/disp in prog */
141 #define MCHIP_HIC_STATUS_COMPDEC        0x00000008      /* (de)comp in prog */
142 #define MCHIP_HIC_STATUS_BUSY           0x00000010      /* HIC busy */
143
144 #define MCHIP_HIC_S_RATE                0x60            /* MJPEG # frames */
145
146 #define MCHIP_HIC_PCI_VFMT              0x64            /* video format */
147 #define MCHIP_HIC_PCI_VFMT_YVYU         0x00000001      /* 0: V Y' U Y */
148                                                         /* 1: Y' V Y U */
149
150 #define MCHIP_MCC_CMD                   0x80            /* MCC commands */
151 #define MCHIP_MCC_CMD_INITIAL           0x0             /* idle ? */
152 #define MCHIP_MCC_CMD_IIC_START_SET     0x1
153 #define MCHIP_MCC_CMD_IIC_END_SET       0x2
154 #define MCHIP_MCC_CMD_FM_WRITE          0x3             /* frame memory */
155 #define MCHIP_MCC_CMD_FM_READ           0x4
156 #define MCHIP_MCC_CMD_FM_STOP           0x5
157 #define MCHIP_MCC_CMD_CAPTURE           0x6
158 #define MCHIP_MCC_CMD_DISPLAY           0x7
159 #define MCHIP_MCC_CMD_END_DISP          0x8
160 #define MCHIP_MCC_CMD_STILL_COMP        0x9
161 #define MCHIP_MCC_CMD_STILL_DECOMP      0xa
162 #define MCHIP_MCC_CMD_STILL_OUTPUT      0xb
163 #define MCHIP_MCC_CMD_CONT_OUTPUT       0xc
164 #define MCHIP_MCC_CMD_CONT_COMP         0xd
165 #define MCHIP_MCC_CMD_CONT_DECOMP       0xe
166 #define MCHIP_MCC_CMD_RESET             0xf             /* MCC reset */
167
168 #define MCHIP_MCC_IIC_WR                0x84
169
170 #define MCHIP_MCC_MCC_WR                0x88
171
172 #define MCHIP_MCC_MCC_RD                0x8c
173
174 #define MCHIP_MCC_STATUS                0x90
175 #define MCHIP_MCC_STATUS_CAPT           0x00000001      /* capturing */
176 #define MCHIP_MCC_STATUS_DISP           0x00000002      /* displaying */
177 #define MCHIP_MCC_STATUS_COMP           0x00000004      /* compressing */
178 #define MCHIP_MCC_STATUS_DECOMP         0x00000008      /* decompressing */
179 #define MCHIP_MCC_STATUS_MCC_WR         0x00000010      /* register ready */
180 #define MCHIP_MCC_STATUS_MCC_RD         0x00000020      /* register ready */
181 #define MCHIP_MCC_STATUS_IIC_WR         0x00000040      /* register ready */
182 #define MCHIP_MCC_STATUS_OUTPUT         0x00000080      /* output in prog */
183
184 #define MCHIP_MCC_SIG_POLARITY          0x94
185 #define MCHIP_MCC_SIG_POL_VS_H          0x00000001      /* VS active-high */
186 #define MCHIP_MCC_SIG_POL_HS_H          0x00000002      /* HS active-high */
187 #define MCHIP_MCC_SIG_POL_DOE_H         0x00000004      /* DOE active-high */
188
189 #define MCHIP_MCC_IRQ                   0x98
190 #define MCHIP_MCC_IRQ_CAPDIS_STRT       0x00000001      /* cap/disp started */
191 #define MCHIP_MCC_IRQ_CAPDIS_STRT_MASK  0x00000010
192 #define MCHIP_MCC_IRQ_CAPDIS_END        0x00000002      /* cap/disp ended */
193 #define MCHIP_MCC_IRQ_CAPDIS_END_MASK   0x00000020
194 #define MCHIP_MCC_IRQ_COMPDEC_STRT      0x00000004      /* (de)comp started */
195 #define MCHIP_MCC_IRQ_COMPDEC_STRT_MASK 0x00000040
196 #define MCHIP_MCC_IRQ_COMPDEC_END       0x00000008      /* (de)comp ended */
197 #define MCHIP_MCC_IRQ_COMPDEC_END_MASK  0x00000080
198
199 #define MCHIP_MCC_HSTART                0x9c            /* video in */
200 #define MCHIP_MCC_VSTART                0xa0
201 #define MCHIP_MCC_HCOUNT                0xa4
202 #define MCHIP_MCC_VCOUNT                0xa8
203 #define MCHIP_MCC_R_XBASE               0xac            /* capt/disp */
204 #define MCHIP_MCC_R_YBASE               0xb0
205 #define MCHIP_MCC_R_XRANGE              0xb4
206 #define MCHIP_MCC_R_YRANGE              0xb8
207 #define MCHIP_MCC_B_XBASE               0xbc            /* comp/decomp */
208 #define MCHIP_MCC_B_YBASE               0xc0
209 #define MCHIP_MCC_B_XRANGE              0xc4
210 #define MCHIP_MCC_B_YRANGE              0xc8
211
212 #define MCHIP_MCC_R_SAMPLING            0xcc            /* 1: 1:4 */
213
214 #define MCHIP_VRJ_CMD                   0x100           /* VRJ commands */
215
216 /* VRJ registers (see table 12.2.4) */
217 #define MCHIP_VRJ_COMPRESSED_DATA       0x1b0
218 #define MCHIP_VRJ_PIXEL_DATA            0x1b8
219
220 #define MCHIP_VRJ_BUS_MODE              0x100
221 #define MCHIP_VRJ_SIGNAL_ACTIVE_LEVEL   0x108
222 #define MCHIP_VRJ_PDAT_USE              0x110
223 #define MCHIP_VRJ_MODE_SPECIFY          0x118
224 #define MCHIP_VRJ_LIMIT_COMPRESSED_LO   0x120
225 #define MCHIP_VRJ_LIMIT_COMPRESSED_HI   0x124
226 #define MCHIP_VRJ_COMP_DATA_FORMAT      0x128
227 #define MCHIP_VRJ_TABLE_DATA            0x140
228 #define MCHIP_VRJ_RESTART_INTERVAL      0x148
229 #define MCHIP_VRJ_NUM_LINES             0x150
230 #define MCHIP_VRJ_NUM_PIXELS            0x158
231 #define MCHIP_VRJ_NUM_COMPONENTS        0x160
232 #define MCHIP_VRJ_SOF1                  0x168
233 #define MCHIP_VRJ_SOF2                  0x170
234 #define MCHIP_VRJ_SOF3                  0x178
235 #define MCHIP_VRJ_SOF4                  0x180
236 #define MCHIP_VRJ_SOS                   0x188
237 #define MCHIP_VRJ_SOFT_RESET            0x190
238
239 #define MCHIP_VRJ_STATUS                0x1c0
240 #define MCHIP_VRJ_STATUS_BUSY           0x00001
241 #define MCHIP_VRJ_STATUS_COMP_ACCESS    0x00002
242 #define MCHIP_VRJ_STATUS_PIXEL_ACCESS   0x00004
243 #define MCHIP_VRJ_STATUS_ERROR          0x00008
244
245 #define MCHIP_VRJ_IRQ_FLAG              0x1c8
246 #define MCHIP_VRJ_ERROR_REPORT          0x1d8
247
248 #define MCHIP_VRJ_START_COMMAND         0x1a0
249
250 /****************************************************************************/
251 /* Driver definitions.                                                      */
252 /****************************************************************************/
253
254 /* Sony Programmable I/O Controller for accessing the camera commands */
255 #include <linux/sonypi.h>
256
257 /* private API definitions */
258 #include <linux/meye.h>
259
260 /* Enable jpg software correction */
261 #define MEYE_JPEG_CORRECTION    1
262
263 /* Maximum size of a buffer */
264 #define MEYE_MAX_BUFSIZE        614400  /* 640 * 480 * 2 */
265
266 /* Maximum number of buffers */
267 #define MEYE_MAX_BUFNBRS        32
268
269 /* State of a buffer */
270 #define MEYE_BUF_UNUSED 0       /* not used */
271 #define MEYE_BUF_USING  1       /* currently grabbing / playing */
272 #define MEYE_BUF_DONE   2       /* done */
273
274 /* grab buffer */
275 struct meye_grab_buffer {
276         int state;                      /* state of buffer */
277         unsigned long size;             /* size of jpg frame */
278 };
279
280 /* queues containing the buffer indices */
281 #define MEYE_QUEUE_SIZE MEYE_MAX_BUFNBRS
282 struct meye_queue {
283         unsigned int head;              /* queue head */
284         unsigned int tail;              /* queue tail */
285         unsigned int len;               /* queue length */
286         spinlock_t s_lock;              /* spinlock protecting the queue */
287         wait_queue_head_t proc_list;    /* wait queue */
288         int buf[MEYE_QUEUE_SIZE];       /* queue contents */
289 };
290
291 /* Motion Eye device structure */
292 struct meye {
293
294         /* mchip related */
295         struct pci_dev *mchip_dev;      /* pci device */
296         u8 mchip_irq;                   /* irq */
297         u8 mchip_mode;                  /* actual mchip mode: HIC_MODE... */
298         u8 mchip_fnum;                  /* current mchip frame number */
299
300         unsigned char *mchip_mmregs;    /* mchip: memory mapped registers */
301         u8 *mchip_ptable[MCHIP_NB_PAGES];/* mchip: ptable */
302         dma_addr_t *mchip_ptable_toc;   /* mchip: ptable toc */
303         dma_addr_t mchip_dmahandle;     /* mchip: dma handle to ptable toc */
304
305         unsigned char *grab_fbuffer;    /* capture framebuffer */
306                                         /* list of buffers */
307         struct meye_grab_buffer grab_buffer[MEYE_MAX_BUFNBRS];
308
309         /* other */
310         struct semaphore lock;          /* semaphore for open/mmap... */
311
312         struct meye_queue grabq;        /* queue for buffers to be grabbed */
313
314         struct video_device *video_dev; /* video device parameters */
315         struct video_picture picture;   /* video picture parameters */
316         struct meye_params params;      /* additional parameters */
317 #ifdef CONFIG_PM
318         u32 pm_state[16];               /* PCI configuration space */
319         u8 pm_mchip_mode;               /* old mchip mode */
320 #endif
321 };
322
323 #endif