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