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