Merge branch 'origin'
[pandora-kernel.git] / include / media / saa7146.h
1 #ifndef __SAA7146__
2 #define __SAA7146__
3
4 #include <linux/module.h>       /* for module-version */
5 #include <linux/delay.h>        /* for delay-stuff */
6 #include <linux/slab.h>         /* for kmalloc/kfree */
7 #include <linux/pci.h>          /* for pci-config-stuff, vendor ids etc. */
8 #include <linux/init.h>         /* for "__init" */
9 #include <linux/interrupt.h>    /* for IMMEDIATE_BH */
10 #include <linux/kmod.h>         /* for kernel module loader */
11 #include <linux/i2c.h>          /* for i2c subsystem */
12 #include <asm/io.h>             /* for accessing devices */
13 #include <linux/stringify.h>
14 #include <linux/mutex.h>
15
16 #include <linux/vmalloc.h>      /* for vmalloc() */
17 #include <linux/mm.h>           /* for vmalloc_to_page() */
18
19 #define SAA7146_VERSION_CODE 0x000500   /* 0.5.0 */
20
21 #define saa7146_write(sxy,adr,dat)    writel((dat),(sxy->mem+(adr)))
22 #define saa7146_read(sxy,adr)         readl(sxy->mem+(adr))
23
24 extern unsigned int saa7146_debug;
25
26 //#define DEBUG_PROLOG printk("(0x%08x)(0x%08x) %s: %s(): ",(dev==0?-1:(dev->mem==0?-1:saa7146_read(dev,RPS_ADDR0))),(dev==0?-1:(dev->mem==0?-1:saa7146_read(dev,IER))),KBUILD_MODNAME,__FUNCTION__)
27
28 #ifndef DEBUG_VARIABLE
29         #define DEBUG_VARIABLE saa7146_debug
30 #endif
31
32 #define DEBUG_PROLOG printk("%s: %s(): ",KBUILD_MODNAME,__FUNCTION__)
33 #define INFO(x) { printk("%s: ",KBUILD_MODNAME); printk x; }
34
35 #define ERR(x) { DEBUG_PROLOG; printk x; }
36
37 #define DEB_S(x)    if (0!=(DEBUG_VARIABLE&0x01)) { DEBUG_PROLOG; printk x; } /* simple debug messages */
38 #define DEB_D(x)    if (0!=(DEBUG_VARIABLE&0x02)) { DEBUG_PROLOG; printk x; } /* more detailed debug messages */
39 #define DEB_EE(x)   if (0!=(DEBUG_VARIABLE&0x04)) { DEBUG_PROLOG; printk x; } /* print enter and exit of functions */
40 #define DEB_I2C(x)  if (0!=(DEBUG_VARIABLE&0x08)) { DEBUG_PROLOG; printk x; } /* i2c debug messages */
41 #define DEB_VBI(x)  if (0!=(DEBUG_VARIABLE&0x10)) { DEBUG_PROLOG; printk x; } /* vbi debug messages */
42 #define DEB_INT(x)  if (0!=(DEBUG_VARIABLE&0x20)) { DEBUG_PROLOG; printk x; } /* interrupt debug messages */
43 #define DEB_CAP(x)  if (0!=(DEBUG_VARIABLE&0x40)) { DEBUG_PROLOG; printk x; } /* capture debug messages */
44
45 #define SAA7146_IER_DISABLE(x,y) \
46         saa7146_write(x, IER, saa7146_read(x, IER) & ~(y));
47 #define SAA7146_IER_ENABLE(x,y) \
48         saa7146_write(x, IER, saa7146_read(x, IER) | (y));
49 #define SAA7146_ISR_CLEAR(x,y) \
50         saa7146_write(x, ISR, (y));
51
52 struct saa7146_dev;
53 struct saa7146_extension;
54 struct saa7146_vv;
55
56 /* saa7146 page table */
57 struct saa7146_pgtable {
58         unsigned int    size;
59         u32             *cpu;
60         dma_addr_t      dma;
61         /* used for offsets for u,v planes for planar capture modes */
62         unsigned long   offset;
63         /* used for custom pagetables (used for example by budget dvb cards) */
64         struct scatterlist *slist;
65 };
66
67 struct saa7146_pci_extension_data {
68         struct saa7146_extension *ext;
69         void *ext_priv;                 /* most likely a name string */
70 };
71
72 #define MAKE_EXTENSION_PCI(x_var, x_vendor, x_device)           \
73         {                                                       \
74                 .vendor    = PCI_VENDOR_ID_PHILIPS,             \
75                 .device    = PCI_DEVICE_ID_PHILIPS_SAA7146,     \
76                 .subvendor = x_vendor,                          \
77                 .subdevice = x_device,                          \
78                 .driver_data = (unsigned long)& x_var,          \
79         }
80
81 struct saa7146_extension
82 {
83         char    name[32];               /* name of the device */
84 #define SAA7146_USE_I2C_IRQ     0x1
85 #define SAA7146_I2C_SHORT_DELAY 0x2
86         int     flags;
87
88         /* pairs of subvendor and subdevice ids for
89            supported devices, last entry 0xffff, 0xfff */
90         struct module *module;
91         struct pci_driver driver;
92         struct pci_device_id *pci_tbl;
93
94         /* extension functions */
95         int (*probe)(struct saa7146_dev *);
96         int (*attach)(struct saa7146_dev *, struct saa7146_pci_extension_data *);
97         int (*detach)(struct saa7146_dev*);
98
99         u32     irq_mask;       /* mask to indicate, which irq-events are handled by the extension */
100         void    (*irq_func)(struct saa7146_dev*, u32* irq_mask);
101 };
102
103 struct saa7146_dma
104 {
105         dma_addr_t      dma_handle;
106         u32             *cpu_addr;
107 };
108
109 struct saa7146_dev
110 {
111         struct module                   *module;
112
113         struct list_head                item;
114
115         /* different device locks */
116         spinlock_t                      slock;
117         struct mutex                    lock;
118
119         unsigned char                   __iomem *mem;           /* pointer to mapped IO memory */
120         int                             revision;       /* chip revision; needed for bug-workarounds*/
121
122         /* pci-device & irq stuff*/
123         char                            name[32];
124         struct pci_dev                  *pci;
125         u32                             int_todo;
126         spinlock_t                      int_slock;
127
128         /* extension handling */
129         struct saa7146_extension        *ext;           /* indicates if handled by extension */
130         void                            *ext_priv;      /* pointer for extension private use (most likely some private data) */
131         struct saa7146_ext_vv           *ext_vv_data;
132
133         /* per device video/vbi informations (if available) */
134         struct saa7146_vv       *vv_data;
135         void (*vv_callback)(struct saa7146_dev *dev, unsigned long status);
136
137         /* i2c-stuff */
138         struct mutex                    i2c_lock;
139
140         u32                             i2c_bitrate;
141         struct saa7146_dma              d_i2c;  /* pointer to i2c memory */
142         wait_queue_head_t               i2c_wq;
143         int                             i2c_op;
144
145         /* memories */
146         struct saa7146_dma              d_rps0;
147         struct saa7146_dma              d_rps1;
148 };
149
150 /* from saa7146_i2c.c */
151 int saa7146_i2c_adapter_prepare(struct saa7146_dev *dev, struct i2c_adapter *i2c_adapter, u32 bitrate);
152 int saa7146_i2c_transfer(struct saa7146_dev *saa, const struct i2c_msg *msgs, int num, int retries);
153
154 /* from saa7146_core.c */
155 extern struct list_head saa7146_devices;
156 extern struct mutex saa7146_devices_lock;
157 int saa7146_register_extension(struct saa7146_extension*);
158 int saa7146_unregister_extension(struct saa7146_extension*);
159 struct saa7146_format* format_by_fourcc(struct saa7146_dev *dev, int fourcc);
160 int saa7146_pgtable_alloc(struct pci_dev *pci, struct saa7146_pgtable *pt);
161 void saa7146_pgtable_free(struct pci_dev *pci, struct saa7146_pgtable *pt);
162 int saa7146_pgtable_build_single(struct pci_dev *pci, struct saa7146_pgtable *pt, struct scatterlist *list, int length );
163 char *saa7146_vmalloc_build_pgtable(struct pci_dev *pci, long length, struct saa7146_pgtable *pt);
164 void saa7146_setgpio(struct saa7146_dev *dev, int port, u32 data);
165 int saa7146_wait_for_debi_done(struct saa7146_dev *dev, int nobusyloop);
166
167 /* some memory sizes */
168 #define SAA7146_I2C_MEM         ( 1*PAGE_SIZE)
169 #define SAA7146_RPS_MEM         ( 1*PAGE_SIZE)
170
171 /* some i2c constants */
172 #define SAA7146_I2C_TIMEOUT     100     /* i2c-timeout-value in ms */
173 #define SAA7146_I2C_RETRIES     3       /* how many times shall we retry an i2c-operation? */
174 #define SAA7146_I2C_DELAY       5       /* time we wait after certain i2c-operations */
175
176 /* unsorted defines */
177 #define ME1    0x0000000800
178 #define PV1    0x0000000008
179
180 /* gpio defines */
181 #define SAA7146_GPIO_INPUT 0x00
182 #define SAA7146_GPIO_IRQHI 0x10
183 #define SAA7146_GPIO_IRQLO 0x20
184 #define SAA7146_GPIO_IRQHL 0x30
185 #define SAA7146_GPIO_OUTLO 0x40
186 #define SAA7146_GPIO_OUTHI 0x50
187
188 /* debi defines */
189 #define DEBINOSWAP 0x000e0000
190
191 /* define for the register programming sequencer (rps) */
192 #define CMD_NOP         0x00000000  /* No operation */
193 #define CMD_CLR_EVENT   0x00000000  /* Clear event */
194 #define CMD_SET_EVENT   0x10000000  /* Set signal event */
195 #define CMD_PAUSE       0x20000000  /* Pause */
196 #define CMD_CHECK_LATE  0x30000000  /* Check late */
197 #define CMD_UPLOAD      0x40000000  /* Upload */
198 #define CMD_STOP        0x50000000  /* Stop */
199 #define CMD_INTERRUPT   0x60000000  /* Interrupt */
200 #define CMD_JUMP        0x80000000  /* Jump */
201 #define CMD_WR_REG      0x90000000  /* Write (load) register */
202 #define CMD_RD_REG      0xa0000000  /* Read (store) register */
203 #define CMD_WR_REG_MASK 0xc0000000  /* Write register with mask */
204
205 #define CMD_OAN         MASK_27
206 #define CMD_INV         MASK_26
207 #define CMD_SIG4        MASK_25
208 #define CMD_SIG3        MASK_24
209 #define CMD_SIG2        MASK_23
210 #define CMD_SIG1        MASK_22
211 #define CMD_SIG0        MASK_21
212 #define CMD_O_FID_B     MASK_14
213 #define CMD_E_FID_B     MASK_13
214 #define CMD_O_FID_A     MASK_12
215 #define CMD_E_FID_A     MASK_11
216
217 /* some events and command modifiers for rps1 squarewave generator */
218 #define EVT_HS          (1<<15)     // Source Line Threshold reached
219 #define EVT_VBI_B       (1<<9)      // VSYNC Event
220 #define RPS_OAN         (1<<27)     // 1: OR events, 0: AND events
221 #define RPS_INV         (1<<26)     // Invert (compound) event
222 #define GPIO3_MSK       0xFF000000  // GPIO #3 control bits
223
224 /* Bit mask constants */
225 #define MASK_00   0x00000001    /* Mask value for bit 0 */
226 #define MASK_01   0x00000002    /* Mask value for bit 1 */
227 #define MASK_02   0x00000004    /* Mask value for bit 2 */
228 #define MASK_03   0x00000008    /* Mask value for bit 3 */
229 #define MASK_04   0x00000010    /* Mask value for bit 4 */
230 #define MASK_05   0x00000020    /* Mask value for bit 5 */
231 #define MASK_06   0x00000040    /* Mask value for bit 6 */
232 #define MASK_07   0x00000080    /* Mask value for bit 7 */
233 #define MASK_08   0x00000100    /* Mask value for bit 8 */
234 #define MASK_09   0x00000200    /* Mask value for bit 9 */
235 #define MASK_10   0x00000400    /* Mask value for bit 10 */
236 #define MASK_11   0x00000800    /* Mask value for bit 11 */
237 #define MASK_12   0x00001000    /* Mask value for bit 12 */
238 #define MASK_13   0x00002000    /* Mask value for bit 13 */
239 #define MASK_14   0x00004000    /* Mask value for bit 14 */
240 #define MASK_15   0x00008000    /* Mask value for bit 15 */
241 #define MASK_16   0x00010000    /* Mask value for bit 16 */
242 #define MASK_17   0x00020000    /* Mask value for bit 17 */
243 #define MASK_18   0x00040000    /* Mask value for bit 18 */
244 #define MASK_19   0x00080000    /* Mask value for bit 19 */
245 #define MASK_20   0x00100000    /* Mask value for bit 20 */
246 #define MASK_21   0x00200000    /* Mask value for bit 21 */
247 #define MASK_22   0x00400000    /* Mask value for bit 22 */
248 #define MASK_23   0x00800000    /* Mask value for bit 23 */
249 #define MASK_24   0x01000000    /* Mask value for bit 24 */
250 #define MASK_25   0x02000000    /* Mask value for bit 25 */
251 #define MASK_26   0x04000000    /* Mask value for bit 26 */
252 #define MASK_27   0x08000000    /* Mask value for bit 27 */
253 #define MASK_28   0x10000000    /* Mask value for bit 28 */
254 #define MASK_29   0x20000000    /* Mask value for bit 29 */
255 #define MASK_30   0x40000000    /* Mask value for bit 30 */
256 #define MASK_31   0x80000000    /* Mask value for bit 31 */
257
258 #define MASK_B0   0x000000ff    /* Mask value for byte 0 */
259 #define MASK_B1   0x0000ff00    /* Mask value for byte 1 */
260 #define MASK_B2   0x00ff0000    /* Mask value for byte 2 */
261 #define MASK_B3   0xff000000    /* Mask value for byte 3 */
262
263 #define MASK_W0   0x0000ffff    /* Mask value for word 0 */
264 #define MASK_W1   0xffff0000    /* Mask value for word 1 */
265
266 #define MASK_PA   0xfffffffc    /* Mask value for physical address */
267 #define MASK_PR   0xfffffffe    /* Mask value for protection register */
268 #define MASK_ER   0xffffffff    /* Mask value for the entire register */
269
270 #define MASK_NONE 0x00000000    /* No mask */
271
272 /* register aliases */
273 #define BASE_ODD1         0x00  /* Video DMA 1 registers  */
274 #define BASE_EVEN1        0x04
275 #define PROT_ADDR1        0x08
276 #define PITCH1            0x0C
277 #define BASE_PAGE1        0x10  /* Video DMA 1 base page */
278 #define NUM_LINE_BYTE1    0x14
279
280 #define BASE_ODD2         0x18  /* Video DMA 2 registers */
281 #define BASE_EVEN2        0x1C
282 #define PROT_ADDR2        0x20
283 #define PITCH2            0x24
284 #define BASE_PAGE2        0x28  /* Video DMA 2 base page */
285 #define NUM_LINE_BYTE2    0x2C
286
287 #define BASE_ODD3         0x30  /* Video DMA 3 registers */
288 #define BASE_EVEN3        0x34
289 #define PROT_ADDR3        0x38
290 #define PITCH3            0x3C
291 #define BASE_PAGE3        0x40  /* Video DMA 3 base page */
292 #define NUM_LINE_BYTE3    0x44
293
294 #define PCI_BT_V1         0x48  /* Video/FIFO 1 */
295 #define PCI_BT_V2         0x49  /* Video/FIFO 2 */
296 #define PCI_BT_V3         0x4A  /* Video/FIFO 3 */
297 #define PCI_BT_DEBI       0x4B  /* DEBI */
298 #define PCI_BT_A          0x4C  /* Audio */
299
300 #define DD1_INIT          0x50  /* Init setting of DD1 interface */
301
302 #define DD1_STREAM_B      0x54  /* DD1 B video data stream handling */
303 #define DD1_STREAM_A      0x56  /* DD1 A video data stream handling */
304
305 #define BRS_CTRL          0x58  /* BRS control register */
306 #define HPS_CTRL          0x5C  /* HPS control register */
307 #define HPS_V_SCALE       0x60  /* HPS vertical scale */
308 #define HPS_V_GAIN        0x64  /* HPS vertical ACL and gain */
309 #define HPS_H_PRESCALE    0x68  /* HPS horizontal prescale   */
310 #define HPS_H_SCALE       0x6C  /* HPS horizontal scale */
311 #define BCS_CTRL          0x70  /* BCS control */
312 #define CHROMA_KEY_RANGE  0x74
313 #define CLIP_FORMAT_CTRL  0x78  /* HPS outputs formats & clipping */
314
315 #define DEBI_CONFIG       0x7C
316 #define DEBI_COMMAND      0x80
317 #define DEBI_PAGE         0x84
318 #define DEBI_AD           0x88
319
320 #define I2C_TRANSFER      0x8C
321 #define I2C_STATUS        0x90
322
323 #define BASE_A1_IN        0x94  /* Audio 1 input DMA */
324 #define PROT_A1_IN        0x98
325 #define PAGE_A1_IN        0x9C
326
327 #define BASE_A1_OUT       0xA0  /* Audio 1 output DMA */
328 #define PROT_A1_OUT       0xA4
329 #define PAGE_A1_OUT       0xA8
330
331 #define BASE_A2_IN        0xAC  /* Audio 2 input DMA */
332 #define PROT_A2_IN        0xB0
333 #define PAGE_A2_IN        0xB4
334
335 #define BASE_A2_OUT       0xB8  /* Audio 2 output DMA */
336 #define PROT_A2_OUT       0xBC
337 #define PAGE_A2_OUT       0xC0
338
339 #define RPS_PAGE0         0xC4  /* RPS task 0 page register */
340 #define RPS_PAGE1         0xC8  /* RPS task 1 page register */
341
342 #define RPS_THRESH0       0xCC  /* HBI threshold for task 0 */
343 #define RPS_THRESH1       0xD0  /* HBI threshold for task 1 */
344
345 #define RPS_TOV0          0xD4  /* RPS timeout for task 0 */
346 #define RPS_TOV1          0xD8  /* RPS timeout for task 1 */
347
348 #define IER               0xDC  /* Interrupt enable register */
349
350 #define GPIO_CTRL         0xE0  /* GPIO 0-3 register */
351
352 #define EC1SSR            0xE4  /* Event cnt set 1 source select */
353 #define EC2SSR            0xE8  /* Event cnt set 2 source select */
354 #define ECT1R             0xEC  /* Event cnt set 1 thresholds */
355 #define ECT2R             0xF0  /* Event cnt set 2 thresholds */
356
357 #define ACON1             0xF4
358 #define ACON2             0xF8
359
360 #define MC1               0xFC   /* Main control register 1 */
361 #define MC2               0x100  /* Main control register 2  */
362
363 #define RPS_ADDR0         0x104  /* RPS task 0 address register */
364 #define RPS_ADDR1         0x108  /* RPS task 1 address register */
365
366 #define ISR               0x10C  /* Interrupt status register */
367 #define PSR               0x110  /* Primary status register */
368 #define SSR               0x114  /* Secondary status register */
369
370 #define EC1R              0x118  /* Event counter set 1 register */
371 #define EC2R              0x11C  /* Event counter set 2 register */
372
373 #define PCI_VDP1          0x120  /* Video DMA pointer of FIFO 1 */
374 #define PCI_VDP2          0x124  /* Video DMA pointer of FIFO 2 */
375 #define PCI_VDP3          0x128  /* Video DMA pointer of FIFO 3 */
376 #define PCI_ADP1          0x12C  /* Audio DMA pointer of audio out 1 */
377 #define PCI_ADP2          0x130  /* Audio DMA pointer of audio in 1 */
378 #define PCI_ADP3          0x134  /* Audio DMA pointer of audio out 2 */
379 #define PCI_ADP4          0x138  /* Audio DMA pointer of audio in 2 */
380 #define PCI_DMA_DDP       0x13C  /* DEBI DMA pointer */
381
382 #define LEVEL_REP         0x140,
383 #define A_TIME_SLOT1      0x180,  /* from 180 - 1BC */
384 #define A_TIME_SLOT2      0x1C0,  /* from 1C0 - 1FC */
385
386 /* isr masks */
387 #define SPCI_PPEF       0x80000000  /* PCI parity error */
388 #define SPCI_PABO       0x40000000  /* PCI access error (target or master abort) */
389 #define SPCI_PPED       0x20000000  /* PCI parity error on 'real time data' */
390 #define SPCI_RPS_I1     0x10000000  /* Interrupt issued by RPS1 */
391 #define SPCI_RPS_I0     0x08000000  /* Interrupt issued by RPS0 */
392 #define SPCI_RPS_LATE1  0x04000000  /* RPS task 1 is late */
393 #define SPCI_RPS_LATE0  0x02000000  /* RPS task 0 is late */
394 #define SPCI_RPS_E1     0x01000000  /* RPS error from task 1 */
395 #define SPCI_RPS_E0     0x00800000  /* RPS error from task 0 */
396 #define SPCI_RPS_TO1    0x00400000  /* RPS timeout task 1 */
397 #define SPCI_RPS_TO0    0x00200000  /* RPS timeout task 0 */
398 #define SPCI_UPLD       0x00100000  /* RPS in upload */
399 #define SPCI_DEBI_S     0x00080000  /* DEBI status */
400 #define SPCI_DEBI_E     0x00040000  /* DEBI error */
401 #define SPCI_IIC_S      0x00020000  /* I2C status */
402 #define SPCI_IIC_E      0x00010000  /* I2C error */
403 #define SPCI_A2_IN      0x00008000  /* Audio 2 input DMA protection / limit */
404 #define SPCI_A2_OUT     0x00004000  /* Audio 2 output DMA protection / limit */
405 #define SPCI_A1_IN      0x00002000  /* Audio 1 input DMA protection / limit */
406 #define SPCI_A1_OUT     0x00001000  /* Audio 1 output DMA protection / limit */
407 #define SPCI_AFOU       0x00000800  /* Audio FIFO over- / underflow */
408 #define SPCI_V_PE       0x00000400  /* Video protection address */
409 #define SPCI_VFOU       0x00000200  /* Video FIFO over- / underflow */
410 #define SPCI_FIDA       0x00000100  /* Field ID video port A */
411 #define SPCI_FIDB       0x00000080  /* Field ID video port B */
412 #define SPCI_PIN3       0x00000040  /* GPIO pin 3 */
413 #define SPCI_PIN2       0x00000020  /* GPIO pin 2 */
414 #define SPCI_PIN1       0x00000010  /* GPIO pin 1 */
415 #define SPCI_PIN0       0x00000008  /* GPIO pin 0 */
416 #define SPCI_ECS        0x00000004  /* Event counter 1, 2, 4, 5 */
417 #define SPCI_EC3S       0x00000002  /* Event counter 3 */
418 #define SPCI_EC0S       0x00000001  /* Event counter 0 */
419
420 /* i2c */
421 #define SAA7146_I2C_ABORT       (1<<7)
422 #define SAA7146_I2C_SPERR       (1<<6)
423 #define SAA7146_I2C_APERR       (1<<5)
424 #define SAA7146_I2C_DTERR       (1<<4)
425 #define SAA7146_I2C_DRERR       (1<<3)
426 #define SAA7146_I2C_AL          (1<<2)
427 #define SAA7146_I2C_ERR         (1<<1)
428 #define SAA7146_I2C_BUSY        (1<<0)
429
430 #define SAA7146_I2C_START       (0x3)
431 #define SAA7146_I2C_CONT        (0x2)
432 #define SAA7146_I2C_STOP        (0x1)
433 #define SAA7146_I2C_NOP         (0x0)
434
435 #define SAA7146_I2C_BUS_BIT_RATE_6400   (0x500)
436 #define SAA7146_I2C_BUS_BIT_RATE_3200   (0x100)
437 #define SAA7146_I2C_BUS_BIT_RATE_480    (0x400)
438 #define SAA7146_I2C_BUS_BIT_RATE_320    (0x600)
439 #define SAA7146_I2C_BUS_BIT_RATE_240    (0x700)
440 #define SAA7146_I2C_BUS_BIT_RATE_120    (0x000)
441 #define SAA7146_I2C_BUS_BIT_RATE_80     (0x200)
442 #define SAA7146_I2C_BUS_BIT_RATE_60     (0x300)
443
444 #endif