drivers/media/video/saa7164/saa7164.h

   1 /*
   2  *  Driver for the NXP SAA7164 PCIe bridge
   3  *
   4  *  Copyright (c) 2010 Steven Toth <stoth@kernellabs.com>
   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  *
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; if not, write to the Free Software
  19  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 /*
  23         Driver architecture
  24         *******************
  25
  26         saa7164_core.c/buffer.c/cards.c/i2c.c/dvb.c
  27                 |       : Standard Linux driver framework for creating
  28                 |       : exposing and managing interfaces to the rest
  29                 |       : of the kernel or userland. Also uses _fw.c to load
  30                 |       : firmware direct into the PCIe bus, bypassing layers.
  31                 V
  32         saa7164_api..() : Translate kernel specific functions/features
  33                 |       : into command buffers.
  34                 V
  35         saa7164_cmd..() : Manages the flow of command packets on/off,
  36                 |       : the bus. Deal with bus errors, timeouts etc.
  37                 V
  38         saa7164_bus..() : Manage a read/write memory ring buffer in the
  39                 |       : PCIe Address space.
  40                 |
  41                 |               saa7164_fw...() : Load any frimware
  42                 |                       |       : direct into the device
  43                 V                       V
  44         <- ----------------- PCIe address space -------------------- ->
  45 */
  46
  47 #include <linux/pci.h>
  48 #include <linux/i2c.h>
  49 #include <linux/i2c-algo-bit.h>
  50 #include <linux/kdev_t.h>
  51 #include <linux/version.h>
  52 #include <linux/mutex.h>
  53 #include <linux/crc32.h>
  54
  55 #include <media/tuner.h>
  56 #include <media/tveeprom.h>
  57 #include <media/videobuf-dma-sg.h>
  58 #include <media/videobuf-dvb.h>
  59 #include <linux/smp_lock.h>
  60 #include <dvb_demux.h>
  61 #include <dvb_frontend.h>
  62 #include <dvb_net.h>
  63 #include <dvbdev.h>
  64 #include <dmxdev.h>
  65 #include <media/v4l2-common.h>
  66 #include <media/v4l2-ioctl.h>
  67 #include <media/v4l2-chip-ident.h>
  68
  69 #include "saa7164-reg.h"
  70 #include "saa7164-types.h"
  71
  72 #define SAA7164_MAXBOARDS 8
  73
  74 #define UNSET (-1U)
  75 #define SAA7164_BOARD_NOAUTO                    UNSET
  76 #define SAA7164_BOARD_UNKNOWN                   0
  77 #define SAA7164_BOARD_UNKNOWN_REV2              1
  78 #define SAA7164_BOARD_UNKNOWN_REV3              2
  79 #define SAA7164_BOARD_HAUPPAUGE_HVR2250         3
  80 #define SAA7164_BOARD_HAUPPAUGE_HVR2200         4
  81 #define SAA7164_BOARD_HAUPPAUGE_HVR2200_2       5
  82 #define SAA7164_BOARD_HAUPPAUGE_HVR2200_3       6
  83 #define SAA7164_BOARD_HAUPPAUGE_HVR2250_2       7
  84 #define SAA7164_BOARD_HAUPPAUGE_HVR2250_3       8
  85
  86 #define SAA7164_MAX_UNITS               8
  87 #define SAA7164_TS_NUMBER_OF_LINES      312
  88 #define SAA7164_PS_NUMBER_OF_LINES      256
  89 #define SAA7164_PT_ENTRIES              16 /* (312 * 188) / 4096 */
  90 #define SAA7164_MAX_ENCODER_BUFFERS     64 /* max 5secs of latency at 6Mbps */
  91
  92 /* Port related defines */
  93 #define SAA7164_PORT_TS1        (0)
  94 #define SAA7164_PORT_TS2        (SAA7164_PORT_TS1 + 1)
  95 #define SAA7164_PORT_ENC1       (SAA7164_PORT_TS2 + 1)
  96 #define SAA7164_PORT_ENC2       (SAA7164_PORT_ENC1 + 1)
  97 #define SAA7164_MAX_PORTS       (SAA7164_PORT_ENC2 + 1)
  98
  99 #define DBGLVL_FW    4
 100 #define DBGLVL_DVB   8
 101 #define DBGLVL_I2C  16
 102 #define DBGLVL_API  32
 103 #define DBGLVL_CMD  64
 104 #define DBGLVL_BUS 128
 105 #define DBGLVL_IRQ 256
 106 #define DBGLVL_BUF 512
 107 #define DBGLVL_ENC 1024
 108
 109 #define SAA7164_NORMS ( V4L2_STD_NTSC_M |  V4L2_STD_NTSC_M_JP |  V4L2_STD_NTSC_443 )
 110
 111 enum port_t {
 112         SAA7164_MPEG_UNDEFINED = 0,
 113         SAA7164_MPEG_DVB,
 114         SAA7164_MPEG_ENCODER,
 115 };
 116
 117 enum saa7164_i2c_bus_nr {
 118         SAA7164_I2C_BUS_0 = 0,
 119         SAA7164_I2C_BUS_1,
 120         SAA7164_I2C_BUS_2,
 121 };
 122
 123 enum saa7164_buffer_flags {
 124         SAA7164_BUFFER_UNDEFINED = 0,
 125         SAA7164_BUFFER_FREE,
 126         SAA7164_BUFFER_BUSY,
 127         SAA7164_BUFFER_FULL
 128 };
 129
 130 enum saa7164_unit_type {
 131         SAA7164_UNIT_UNDEFINED = 0,
 132         SAA7164_UNIT_DIGITAL_DEMODULATOR,
 133         SAA7164_UNIT_ANALOG_DEMODULATOR,
 134         SAA7164_UNIT_TUNER,
 135         SAA7164_UNIT_EEPROM,
 136         SAA7164_UNIT_ZILOG_IRBLASTER,
 137         SAA7164_UNIT_ENCODER,
 138 };
 139
 140 /* The PCIe bridge doesn't grant direct access to i2c.
 141  * Instead, you address i2c devices using a uniqely
 142  * allocated 'unitid' value via a messaging API. This
 143  * is a problem. The kernel and existing demod/tuner
 144  * drivers expect to talk 'i2c', so we have to maintain
 145  * a translation layer, and a series of functions to
 146  * convert i2c bus + device address into a unit id.
 147  */
 148 struct saa7164_unit {
 149         enum saa7164_unit_type type;
 150         u8      id;
 151         char    *name;
 152         enum saa7164_i2c_bus_nr i2c_bus_nr;
 153         u8      i2c_bus_addr;
 154         u8      i2c_reg_len;
 155 };
 156
 157 struct saa7164_board {
 158         char    *name;
 159         enum port_t porta, portb, portc, portd;
 160         enum {
 161                 SAA7164_CHIP_UNDEFINED = 0,
 162                 SAA7164_CHIP_REV2,
 163                 SAA7164_CHIP_REV3,
 164         } chiprev;
 165         struct  saa7164_unit unit[SAA7164_MAX_UNITS];
 166 };
 167
 168 struct saa7164_subid {
 169         u16     subvendor;
 170         u16     subdevice;
 171         u32     card;
 172 };
 173
 174 struct saa7164_fh {
 175         struct saa7164_port *port;
 176         u32 freq;
 177         u32 tuner_type;
 178         atomic_t v4l_reading;
 179 };
 180
 181 struct saa7164_histogram_bucket {
 182         u32 val;
 183         u32 count;
 184         u64 update_time;
 185 };
 186
 187 struct saa7164_histogram {
 188         char name[32];
 189         struct saa7164_histogram_bucket counter1[64];
 190 };
 191
 192 struct saa7164_user_buffer {
 193         struct list_head list;
 194
 195         /* Attributes */
 196         u8  *data;
 197         u32 pos;
 198         u32 actual_size;
 199
 200         u32 crc;
 201 };
 202
 203 struct saa7164_fw_status {
 204
 205         /* RISC Core details */
 206         u32     status;
 207         u32     mode;
 208         u32     spec;
 209         u32     inst;
 210         u32     cpuload;
 211         u32     remainheap;
 212
 213         /* Firmware version */
 214         u32     version;
 215         u32     major;
 216         u32     sub;
 217         u32     rel;
 218         u32     buildnr;
 219 };
 220
 221 struct saa7164_dvb {
 222         struct mutex lock;
 223         struct dvb_adapter adapter;
 224         struct dvb_frontend *frontend;
 225         struct dvb_demux demux;
 226         struct dmxdev dmxdev;
 227         struct dmx_frontend fe_hw;
 228         struct dmx_frontend fe_mem;
 229         struct dvb_net net;
 230         int feeding;
 231 };
 232
 233 struct saa7164_i2c {
 234         struct saa7164_dev              *dev;
 235
 236         enum saa7164_i2c_bus_nr         nr;
 237
 238         /* I2C I/O */
 239         struct i2c_adapter              i2c_adap;
 240         struct i2c_algo_bit_data        i2c_algo;
 241         struct i2c_client               i2c_client;
 242         u32                             i2c_rc;
 243 };
 244
 245 struct saa7164_ctrl {
 246         struct v4l2_queryctrl v;
 247 };
 248
 249 struct saa7164_tvnorm {
 250         char            *name;
 251         v4l2_std_id     id;
 252 //      u32             cxiformat;
 253 //      u32             cxoformat;
 254 };
 255
 256 struct saa7164_encoder_params {
 257         struct saa7164_tvnorm encodernorm;
 258         u32 height;
 259         u32 width;
 260         u32 is_50hz;
 261         u32 bitrate; /* bps */
 262         u32 bitrate_peak; /* bps */
 263         u32 bitrate_mode;
 264         u32 stream_type; /* V4L2_MPEG_STREAM_TYPE_MPEG2_TS */
 265
 266         u32 audio_sampling_freq;
 267         u32 ctl_mute;
 268         u32 ctl_aspect;
 269         u32 refdist;
 270         u32 gop_size;
 271 };
 272
 273 struct saa7164_port;
 274
 275 struct saa7164_buffer {
 276         struct list_head list;
 277
 278         /* Note of which h/w buffer list index position we occupy */
 279         int idx;
 280
 281         struct saa7164_port *port;
 282
 283         /* Hardware Specific */
 284         /* PCI Memory allocations */
 285         enum saa7164_buffer_flags flags; /* Free, Busy, Full */
 286
 287         /* A block of page align PCI memory */
 288         u32 pci_size;   /* PCI allocation size in bytes */
 289         u64 __iomem *cpu;       /* Virtual address */
 290         dma_addr_t dma; /* Physical address */
 291         u32 crc;        /* Checksum for the entire buffer data */
 292
 293         /* A page table that splits the block into a number of entries */
 294         u32 pt_size;            /* PCI allocation size in bytes */
 295         u64 __iomem *pt_cpu;            /* Virtual address */
 296         dma_addr_t pt_dma;      /* Physical address */
 297
 298         /* Encoder fops */
 299         u32 pos;
 300         u32 actual_size;
 301 };
 302
 303 struct saa7164_port {
 304
 305         struct saa7164_dev *dev;
 306         enum port_t type;
 307         int nr;
 308
 309         /* --- Generic port attributes --- */
 310
 311         /* HW stream parameters */
 312         tmHWStreamParameters_t hw_streamingparams;
 313
 314         /* DMA configuration values, is seeded during initialization */
 315         tmComResDMATermDescrHeader_t hwcfg;
 316
 317         /* hardware specific registers */
 318         u32 bufcounter;
 319         u32 pitch;
 320         u32 bufsize;
 321         u32 bufoffset;
 322         u32 bufptr32l;
 323         u32 bufptr32h;
 324         u64 bufptr64;
 325
 326         u32 numpte;     /* Number of entries in array, only valid in head */
 327
 328         struct mutex dmaqueue_lock;
 329         struct saa7164_buffer dmaqueue;
 330
 331         u64 last_irq_msecs, last_svc_msecs;
 332         u64 last_irq_msecs_diff, last_svc_msecs_diff;
 333         u32 last_svc_wp;
 334         u32 last_svc_rp;
 335         u64 last_irq_svc_msecs_diff;
 336         u64 last_read_msecs, last_read_msecs_diff;
 337         u64 last_poll_msecs, last_poll_msecs_diff;
 338
 339         struct saa7164_histogram irq_interval;
 340         struct saa7164_histogram svc_interval;
 341         struct saa7164_histogram irq_svc_interval;
 342         struct saa7164_histogram read_interval;
 343         struct saa7164_histogram poll_interval;
 344
 345         /* --- DVB Transport Specific --- */
 346         struct saa7164_dvb dvb;
 347
 348         /* --- Encoder/V4L related attributes --- */
 349         /* Encoder */
 350         /* Defaults established in saa7164-encoder.c */
 351         struct saa7164_tvnorm encodernorm;
 352         u32 height;
 353         u32 width;
 354         u32 freq;
 355         u32 ts_packet_size;
 356         u32 ts_packet_count;
 357         u8 mux_input;
 358         u8 encoder_profile;
 359         u8 video_format;
 360         u8 audio_format;
 361         u8 video_resolution;
 362         u16 ctl_brightness;
 363         u16 ctl_contrast;
 364         u16 ctl_hue;
 365         u16 ctl_saturation;
 366         u16 ctl_sharpness;
 367         s8 ctl_volume;
 368
 369         tmComResAFeatureDescrHeader_t audfeat;
 370         tmComResEncoderDescrHeader_t encunit;
 371         tmComResProcDescrHeader_t vidproc;
 372         tmComResExtDevDescrHeader_t ifunit;
 373         tmComResTunerDescrHeader_t tunerunit;
 374
 375         struct work_struct workenc;
 376
 377         /* V4L */
 378         struct saa7164_encoder_params encoder_params;
 379         struct video_device *v4l_device;
 380         atomic_t v4l_reader_count;
 381
 382         struct saa7164_buffer list_buf_used;
 383         struct saa7164_buffer list_buf_free;
 384         wait_queue_head_t wait_read;
 385
 386         /* Debug */
 387         u32 sync_errors;
 388         u32 v_cc_errors;
 389         u32 a_cc_errors;
 390         u8 last_v_cc;
 391         u8 last_a_cc;
 392         u32 done_first_interrupt;
 393 };
 394
 395 struct saa7164_dev {
 396         struct list_head        devlist;
 397         atomic_t                refcount;
 398
 399         /* pci stuff */
 400         struct pci_dev  *pci;
 401         unsigned char   pci_rev, pci_lat;
 402         int             pci_bus, pci_slot;
 403         u32             __iomem *lmmio;
 404         u8              __iomem *bmmio;
 405         u32             __iomem *lmmio2;
 406         u8              __iomem *bmmio2;
 407         int             pci_irqmask;
 408
 409         /* board details */
 410         int     nr;
 411         int     hwrevision;
 412         u32     board;
 413         char    name[32];
 414
 415         /* firmware status */
 416         struct saa7164_fw_status        fw_status;
 417
 418         tmComResHWDescr_t               hwdesc;
 419         tmComResInterfaceDescr_t        intfdesc;
 420         tmComResBusDescr_t              busdesc;
 421
 422         tmComResBusInfo_t               bus;
 423
 424         /* Interrupt status and ack registers */
 425         u32 int_status;
 426         u32 int_ack;
 427
 428         struct cmd                      cmds[SAA_CMD_MAX_MSG_UNITS];
 429         struct mutex                    lock;
 430
 431         /* I2c related */
 432         struct saa7164_i2c i2c_bus[3];
 433
 434         /* Transport related */
 435         struct saa7164_port ports[ SAA7164_MAX_PORTS ];
 436
 437         /* Deferred command/api interrupts handling */
 438         struct work_struct workcmd;
 439
 440 };
 441
 442 extern struct list_head saa7164_devlist;
 443 extern unsigned int waitsecs;
 444 extern unsigned int encoder_buffers;
 445
 446 /* ----------------------------------------------------------- */
 447 /* saa7164-core.c                                              */
 448 void saa7164_dumpregs(struct saa7164_dev *dev, u32 addr);
 449 void saa7164_dumphex16(struct saa7164_dev *dev, u8 *buf, int len);
 450 void saa7164_getfirmwarestatus(struct saa7164_dev *dev);
 451 u32 saa7164_getcurrentfirmwareversion(struct saa7164_dev *dev);
 452 void saa7164_histogram_update(struct saa7164_histogram *hg, u32 val);
 453
 454 /* ----------------------------------------------------------- */
 455 /* saa7164-fw.c                                                */
 456 int saa7164_downloadfirmware(struct saa7164_dev *dev);
 457
 458 /* ----------------------------------------------------------- */
 459 /* saa7164-i2c.c                                               */
 460 extern int saa7164_i2c_register(struct saa7164_i2c *bus);
 461 extern int saa7164_i2c_unregister(struct saa7164_i2c *bus);
 462 extern void saa7164_call_i2c_clients(struct saa7164_i2c *bus,
 463         unsigned int cmd, void *arg);
 464
 465 /* ----------------------------------------------------------- */
 466 /* saa7164-bus.c                                               */
 467 int saa7164_bus_setup(struct saa7164_dev *dev);
 468 void saa7164_bus_dump(struct saa7164_dev *dev);
 469 int saa7164_bus_set(struct saa7164_dev *dev, tmComResInfo_t* msg, void *buf);
 470 int saa7164_bus_get(struct saa7164_dev *dev, tmComResInfo_t* msg,
 471         void *buf, int peekonly);
 472
 473 /* ----------------------------------------------------------- */
 474 /* saa7164-cmd.c                                               */
 475 int saa7164_cmd_send(struct saa7164_dev *dev,
 476         u8 id, tmComResCmd_t command, u16 controlselector,
 477         u16 size, void *buf);
 478 void saa7164_cmd_signal(struct saa7164_dev *dev, u8 seqno);
 479 int saa7164_irq_dequeue(struct saa7164_dev *dev);
 480
 481 /* ----------------------------------------------------------- */
 482 /* saa7164-api.c                                               */
 483 int saa7164_api_get_fw_version(struct saa7164_dev *dev, u32 *version);
 484 int saa7164_api_enum_subdevs(struct saa7164_dev *dev);
 485 int saa7164_api_i2c_read(struct saa7164_i2c *bus, u8 addr, u32 reglen, u8 *reg,
 486         u32 datalen, u8 *data);
 487 int saa7164_api_i2c_write(struct saa7164_i2c *bus, u8 addr,
 488         u32 datalen, u8 *data);
 489 int saa7164_api_dif_write(struct saa7164_i2c *bus, u8 addr,
 490         u32 datalen, u8 *data);
 491 int saa7164_api_read_eeprom(struct saa7164_dev *dev, u8 *buf, int buflen);
 492 int saa7164_api_set_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
 493 int saa7164_api_clear_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
 494 int saa7164_api_transition_port(struct saa7164_port *port, u8 mode);
 495 int saa7164_api_initialize_dif(struct saa7164_port *port);
 496 int saa7164_api_configure_dif(struct saa7164_port *port, u32 std);
 497 int saa7164_api_set_encoder(struct saa7164_port *port);
 498 int saa7164_api_get_encoder(struct saa7164_port *port);
 499 int saa7164_api_set_aspect_ratio(struct saa7164_port *port);
 500 int saa7164_api_set_usercontrol(struct saa7164_port *port, u8 ctl);
 501 int saa7164_api_get_usercontrol(struct saa7164_port *port, u8 ctl);
 502 int saa7164_api_set_videomux(struct saa7164_port *port);
 503 int saa7164_api_audio_mute(struct saa7164_port *port, int mute);
 504 int saa7164_api_set_audio_volume(struct saa7164_port *port, s8 level);
 505 int saa7164_api_set_audio_std(struct saa7164_port *port);
 506 int saa7164_api_set_audio_detection(struct saa7164_port *port, int autodetect);
 507 int saa7164_api_get_videomux(struct saa7164_port *port);
 508
 509 /* ----------------------------------------------------------- */
 510 /* saa7164-cards.c                                             */
 511 extern struct saa7164_board saa7164_boards[];
 512 extern const unsigned int saa7164_bcount;
 513
 514 extern struct saa7164_subid saa7164_subids[];
 515 extern const unsigned int saa7164_idcount;
 516
 517 extern void saa7164_card_list(struct saa7164_dev *dev);
 518 extern void saa7164_gpio_setup(struct saa7164_dev *dev);
 519 extern void saa7164_card_setup(struct saa7164_dev *dev);
 520
 521 extern int saa7164_i2caddr_to_reglen(struct saa7164_i2c *bus, int addr);
 522 extern int saa7164_i2caddr_to_unitid(struct saa7164_i2c *bus, int addr);
 523 extern char *saa7164_unitid_name(struct saa7164_dev *dev, u8 unitid);
 524
 525 /* ----------------------------------------------------------- */
 526 /* saa7164-dvb.c                                               */
 527 extern int saa7164_dvb_register(struct saa7164_port *port);
 528 extern int saa7164_dvb_unregister(struct saa7164_port *port);
 529
 530 /* ----------------------------------------------------------- */
 531 /* saa7164-buffer.c                                            */
 532 extern struct saa7164_buffer *saa7164_buffer_alloc(
 533         struct saa7164_port *port, u32 len);
 534 extern int saa7164_buffer_dealloc(struct saa7164_buffer *buf);
 535 extern void saa7164_buffer_display(struct saa7164_buffer *buf);
 536 extern int saa7164_buffer_activate(struct saa7164_buffer *buf, int i);
 537 extern int saa7164_buffer_cfg_port(struct saa7164_port *port);
 538 extern struct saa7164_user_buffer *saa7164_buffer_alloc_user(
 539         struct saa7164_dev *dev, u32 len);
 540 extern void saa7164_buffer_dealloc_user(struct saa7164_user_buffer *buf);
 541 extern int saa7164_buffer_zero_offsets(struct saa7164_port *port, int i);
 542
 543 /* ----------------------------------------------------------- */
 544 /* saa7164-encoder.c                                            */
 545 int saa7164_encoder_register(struct saa7164_port *port);
 546 void saa7164_encoder_unregister(struct saa7164_port *port);
 547
 548 /* ----------------------------------------------------------- */
 549
 550 extern unsigned int crc_checking;
 551
 552 extern unsigned int saa_debug;
 553 #define dprintk(level, fmt, arg...)\
 554         do { if (saa_debug & level)\
 555                 printk(KERN_DEBUG "%s: " fmt, dev->name, ## arg);\
 556         } while (0)
 557
 558 #define log_warn(fmt, arg...)\
 559         do { \
 560                 printk(KERN_WARNING "%s: " fmt, dev->name, ## arg);\
 561         } while (0)
 562
 563 #define log_err(fmt, arg...)\
 564         do { \
 565                 printk(KERN_ERROR "%s: " fmt, dev->name, ## arg);\
 566         } while (0)
 567
 568 #define saa7164_readl(reg) readl(dev->lmmio + ((reg) >> 2))
 569 #define saa7164_writel(reg, value) writel((value), dev->lmmio + ((reg) >> 2))
 570
 571
 572 #define saa7164_readb(reg)             readl(dev->bmmio + (reg))
 573 #define saa7164_writeb(reg, value)     writel((value), dev->bmmio + (reg))
 574