2 * Driver for the NXP SAA7164 PCIe bridge
4 * Copyright (c) 2010 Steven Toth <stoth@kernellabs.com>
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.
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
15 * GNU General Public License for more details.
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.
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.
32 saa7164_api..() : Translate kernel specific functions/features
33 | : into command buffers.
35 saa7164_cmd..() : Manages the flow of command packets on/off,
36 | : the bus. Deal with bus errors, timeouts etc.
38 saa7164_bus..() : Manage a read/write memory ring buffer in the
39 | : PCIe Address space.
41 | saa7164_fw...() : Load any frimware
42 | | : direct into the device
44 <- ----------------- PCIe address space -------------------- ->
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 #include <linux/kthread.h>
55 #include <linux/freezer.h>
57 #include <media/tuner.h>
58 #include <media/tveeprom.h>
59 #include <media/videobuf-dma-sg.h>
60 #include <media/videobuf-dvb.h>
61 #include <linux/smp_lock.h>
62 #include <dvb_demux.h>
63 #include <dvb_frontend.h>
67 #include <media/v4l2-common.h>
68 #include <media/v4l2-ioctl.h>
69 #include <media/v4l2-chip-ident.h>
71 #include "saa7164-reg.h"
72 #include "saa7164-types.h"
74 #define SAA7164_MAXBOARDS 8
77 #define SAA7164_BOARD_NOAUTO UNSET
78 #define SAA7164_BOARD_UNKNOWN 0
79 #define SAA7164_BOARD_UNKNOWN_REV2 1
80 #define SAA7164_BOARD_UNKNOWN_REV3 2
81 #define SAA7164_BOARD_HAUPPAUGE_HVR2250 3
82 #define SAA7164_BOARD_HAUPPAUGE_HVR2200 4
83 #define SAA7164_BOARD_HAUPPAUGE_HVR2200_2 5
84 #define SAA7164_BOARD_HAUPPAUGE_HVR2200_3 6
85 #define SAA7164_BOARD_HAUPPAUGE_HVR2250_2 7
86 #define SAA7164_BOARD_HAUPPAUGE_HVR2250_3 8
88 #define SAA7164_MAX_UNITS 8
89 #define SAA7164_TS_NUMBER_OF_LINES 312
90 #define SAA7164_PS_NUMBER_OF_LINES 256
91 #define SAA7164_PT_ENTRIES 16 /* (312 * 188) / 4096 */
92 #define SAA7164_MAX_ENCODER_BUFFERS 64 /* max 5secs of latency at 6Mbps */
93 #define SAA7164_MAX_VBI_BUFFERS 64
95 /* Port related defines */
96 #define SAA7164_PORT_TS1 (0)
97 #define SAA7164_PORT_TS2 (SAA7164_PORT_TS1 + 1)
98 #define SAA7164_PORT_ENC1 (SAA7164_PORT_TS2 + 1)
99 #define SAA7164_PORT_ENC2 (SAA7164_PORT_ENC1 + 1)
100 #define SAA7164_PORT_VBI1 (SAA7164_PORT_ENC2 + 1)
101 #define SAA7164_PORT_VBI2 (SAA7164_PORT_VBI1 + 1)
102 #define SAA7164_MAX_PORTS (SAA7164_PORT_VBI2 + 1)
106 #define DBGLVL_I2C 16
107 #define DBGLVL_API 32
108 #define DBGLVL_CMD 64
109 #define DBGLVL_BUS 128
110 #define DBGLVL_IRQ 256
111 #define DBGLVL_BUF 512
112 #define DBGLVL_ENC 1024
113 #define DBGLVL_VBI 2048
114 #define DBGLVL_THR 4096
115 #define DBGLVL_CPU 8192
117 #define SAA7164_NORMS (V4L2_STD_NTSC_M | V4L2_STD_NTSC_M_JP | V4L2_STD_NTSC_443)
120 SAA7164_MPEG_UNDEFINED
= 0,
122 SAA7164_MPEG_ENCODER
,
126 enum saa7164_i2c_bus_nr
{
127 SAA7164_I2C_BUS_0
= 0,
132 enum saa7164_buffer_flags
{
133 SAA7164_BUFFER_UNDEFINED
= 0,
139 enum saa7164_unit_type
{
140 SAA7164_UNIT_UNDEFINED
= 0,
141 SAA7164_UNIT_DIGITAL_DEMODULATOR
,
142 SAA7164_UNIT_ANALOG_DEMODULATOR
,
145 SAA7164_UNIT_ZILOG_IRBLASTER
,
146 SAA7164_UNIT_ENCODER
,
149 /* The PCIe bridge doesn't grant direct access to i2c.
150 * Instead, you address i2c devices using a uniqely
151 * allocated 'unitid' value via a messaging API. This
152 * is a problem. The kernel and existing demod/tuner
153 * drivers expect to talk 'i2c', so we have to maintain
154 * a translation layer, and a series of functions to
155 * convert i2c bus + device address into a unit id.
157 struct saa7164_unit
{
158 enum saa7164_unit_type type
;
161 enum saa7164_i2c_bus_nr i2c_bus_nr
;
166 struct saa7164_board
{
168 enum port_t porta
, portb
, portc
,
171 SAA7164_CHIP_UNDEFINED
= 0,
175 struct saa7164_unit unit
[SAA7164_MAX_UNITS
];
178 struct saa7164_subid
{
184 struct saa7164_encoder_fh
{
185 struct saa7164_port
*port
;
188 atomic_t v4l_reading
;
191 struct saa7164_vbi_fh
{
192 struct saa7164_port
*port
;
195 atomic_t v4l_reading
;
198 struct saa7164_histogram_bucket
{
204 struct saa7164_histogram
{
206 struct saa7164_histogram_bucket counter1
[64];
209 struct saa7164_user_buffer
{
210 struct list_head list
;
220 struct saa7164_fw_status
{
222 /* RISC Core details */
230 /* Firmware version */
240 struct dvb_adapter adapter
;
241 struct dvb_frontend
*frontend
;
242 struct dvb_demux demux
;
243 struct dmxdev dmxdev
;
244 struct dmx_frontend fe_hw
;
245 struct dmx_frontend fe_mem
;
251 struct saa7164_dev
*dev
;
253 enum saa7164_i2c_bus_nr nr
;
256 struct i2c_adapter i2c_adap
;
257 struct i2c_algo_bit_data i2c_algo
;
258 struct i2c_client i2c_client
;
262 struct saa7164_ctrl
{
263 struct v4l2_queryctrl v
;
266 struct saa7164_tvnorm
{
273 struct saa7164_encoder_params
{
274 struct saa7164_tvnorm encodernorm
;
278 u32 bitrate
; /* bps */
279 u32 bitrate_peak
; /* bps */
281 u32 stream_type
; /* V4L2_MPEG_STREAM_TYPE_MPEG2_TS */
283 u32 audio_sampling_freq
;
290 struct saa7164_vbi_params
{
291 struct saa7164_tvnorm encodernorm
;
295 u32 bitrate
; /* bps */
296 u32 bitrate_peak
; /* bps */
298 u32 stream_type
; /* V4L2_MPEG_STREAM_TYPE_MPEG2_TS */
300 u32 audio_sampling_freq
;
309 struct saa7164_buffer
{
310 struct list_head list
;
312 /* Note of which h/w buffer list index position we occupy */
315 struct saa7164_port
*port
;
317 /* Hardware Specific */
318 /* PCI Memory allocations */
319 enum saa7164_buffer_flags flags
; /* Free, Busy, Full */
321 /* A block of page align PCI memory */
322 u32 pci_size
; /* PCI allocation size in bytes */
323 u64 __iomem
*cpu
; /* Virtual address */
324 dma_addr_t dma
; /* Physical address */
325 u32 crc
; /* Checksum for the entire buffer data */
327 /* A page table that splits the block into a number of entries */
328 u32 pt_size
; /* PCI allocation size in bytes */
329 u64 __iomem
*pt_cpu
; /* Virtual address */
330 dma_addr_t pt_dma
; /* Physical address */
337 struct saa7164_port
{
339 struct saa7164_dev
*dev
;
343 /* --- Generic port attributes --- */
345 /* HW stream parameters */
346 struct tmHWStreamParameters hw_streamingparams
;
348 /* DMA configuration values, is seeded during initialization */
349 struct tmComResDMATermDescrHeader hwcfg
;
351 /* hardware specific registers */
360 u32 numpte
; /* Number of entries in array, only valid in head */
362 struct mutex dmaqueue_lock
;
363 struct saa7164_buffer dmaqueue
;
365 u64 last_irq_msecs
, last_svc_msecs
;
366 u64 last_irq_msecs_diff
, last_svc_msecs_diff
;
369 u64 last_irq_svc_msecs_diff
;
370 u64 last_read_msecs
, last_read_msecs_diff
;
371 u64 last_poll_msecs
, last_poll_msecs_diff
;
373 struct saa7164_histogram irq_interval
;
374 struct saa7164_histogram svc_interval
;
375 struct saa7164_histogram irq_svc_interval
;
376 struct saa7164_histogram read_interval
;
377 struct saa7164_histogram poll_interval
;
379 /* --- DVB Transport Specific --- */
380 struct saa7164_dvb dvb
;
382 /* --- Encoder/V4L related attributes --- */
384 /* Defaults established in saa7164-encoder.c */
385 struct saa7164_tvnorm encodernorm
;
403 struct tmComResAFeatureDescrHeader audfeat
;
404 struct tmComResEncoderDescrHeader encunit
;
405 struct tmComResProcDescrHeader vidproc
;
406 struct tmComResExtDevDescrHeader ifunit
;
407 struct tmComResTunerDescrHeader tunerunit
;
409 struct work_struct workenc
;
411 /* V4L Encoder Video */
412 struct saa7164_encoder_params encoder_params
;
413 struct video_device
*v4l_device
;
414 atomic_t v4l_reader_count
;
416 struct saa7164_buffer list_buf_used
;
417 struct saa7164_buffer list_buf_free
;
418 wait_queue_head_t wait_read
;
421 struct tmComResVBIFormatDescrHeader vbi_fmt_ntsc
;
422 struct saa7164_vbi_params vbi_params
;
430 u32 done_first_interrupt
;
434 struct list_head devlist
;
439 unsigned char pci_rev
, pci_lat
;
440 int pci_bus
, pci_slot
;
453 /* firmware status */
454 struct saa7164_fw_status fw_status
;
457 struct tmComResHWDescr hwdesc
;
458 struct tmComResInterfaceDescr intfdesc
;
459 struct tmComResBusDescr busdesc
;
461 struct tmComResBusInfo bus
;
463 /* Interrupt status and ack registers */
467 struct cmd cmds
[SAA_CMD_MAX_MSG_UNITS
];
471 struct saa7164_i2c i2c_bus
[3];
473 /* Transport related */
474 struct saa7164_port ports
[SAA7164_MAX_PORTS
];
476 /* Deferred command/api interrupts handling */
477 struct work_struct workcmd
;
479 /* A kernel thread to monitor the firmware log, used
480 * only in debug mode.
482 struct task_struct
*kthread
;
486 extern struct list_head saa7164_devlist
;
487 extern unsigned int waitsecs
;
488 extern unsigned int encoder_buffers
;
489 extern unsigned int vbi_buffers
;
491 /* ----------------------------------------------------------- */
493 void saa7164_dumpregs(struct saa7164_dev
*dev
, u32 addr
);
494 void saa7164_dumphex16(struct saa7164_dev
*dev
, u8
*buf
, int len
);
495 void saa7164_getfirmwarestatus(struct saa7164_dev
*dev
);
496 u32
saa7164_getcurrentfirmwareversion(struct saa7164_dev
*dev
);
497 void saa7164_histogram_update(struct saa7164_histogram
*hg
, u32 val
);
499 /* ----------------------------------------------------------- */
501 int saa7164_downloadfirmware(struct saa7164_dev
*dev
);
503 /* ----------------------------------------------------------- */
505 extern int saa7164_i2c_register(struct saa7164_i2c
*bus
);
506 extern int saa7164_i2c_unregister(struct saa7164_i2c
*bus
);
507 extern void saa7164_call_i2c_clients(struct saa7164_i2c
*bus
,
508 unsigned int cmd
, void *arg
);
510 /* ----------------------------------------------------------- */
512 int saa7164_bus_setup(struct saa7164_dev
*dev
);
513 void saa7164_bus_dump(struct saa7164_dev
*dev
);
514 int saa7164_bus_set(struct saa7164_dev
*dev
, struct tmComResInfo
* msg
, void *buf
);
515 int saa7164_bus_get(struct saa7164_dev
*dev
, struct tmComResInfo
* msg
,
516 void *buf
, int peekonly
);
518 /* ----------------------------------------------------------- */
520 int saa7164_cmd_send(struct saa7164_dev
*dev
,
521 u8 id
, enum tmComResCmd command
, u16 controlselector
,
522 u16 size
, void *buf
);
523 void saa7164_cmd_signal(struct saa7164_dev
*dev
, u8 seqno
);
524 int saa7164_irq_dequeue(struct saa7164_dev
*dev
);
526 /* ----------------------------------------------------------- */
528 int saa7164_api_get_fw_version(struct saa7164_dev
*dev
, u32
*version
);
529 int saa7164_api_enum_subdevs(struct saa7164_dev
*dev
);
530 int saa7164_api_i2c_read(struct saa7164_i2c
*bus
, u8 addr
, u32 reglen
, u8
*reg
,
531 u32 datalen
, u8
*data
);
532 int saa7164_api_i2c_write(struct saa7164_i2c
*bus
, u8 addr
,
533 u32 datalen
, u8
*data
);
534 int saa7164_api_dif_write(struct saa7164_i2c
*bus
, u8 addr
,
535 u32 datalen
, u8
*data
);
536 int saa7164_api_read_eeprom(struct saa7164_dev
*dev
, u8
*buf
, int buflen
);
537 int saa7164_api_set_gpiobit(struct saa7164_dev
*dev
, u8 unitid
, u8 pin
);
538 int saa7164_api_clear_gpiobit(struct saa7164_dev
*dev
, u8 unitid
, u8 pin
);
539 int saa7164_api_transition_port(struct saa7164_port
*port
, u8 mode
);
540 int saa7164_api_initialize_dif(struct saa7164_port
*port
);
541 int saa7164_api_configure_dif(struct saa7164_port
*port
, u32 std
);
542 int saa7164_api_set_encoder(struct saa7164_port
*port
);
543 int saa7164_api_get_encoder(struct saa7164_port
*port
);
544 int saa7164_api_set_aspect_ratio(struct saa7164_port
*port
);
545 int saa7164_api_set_usercontrol(struct saa7164_port
*port
, u8 ctl
);
546 int saa7164_api_get_usercontrol(struct saa7164_port
*port
, u8 ctl
);
547 int saa7164_api_set_videomux(struct saa7164_port
*port
);
548 int saa7164_api_audio_mute(struct saa7164_port
*port
, int mute
);
549 int saa7164_api_set_audio_volume(struct saa7164_port
*port
, s8 level
);
550 int saa7164_api_set_audio_std(struct saa7164_port
*port
);
551 int saa7164_api_set_audio_detection(struct saa7164_port
*port
, int autodetect
);
552 int saa7164_api_get_videomux(struct saa7164_port
*port
);
553 int saa7164_api_set_vbi_format(struct saa7164_port
*port
);
554 int saa7164_api_set_debug(struct saa7164_dev
*dev
, u8 level
);
555 int saa7164_api_collect_debug(struct saa7164_dev
*dev
);
556 int saa7164_api_get_load_info(struct saa7164_dev
*dev
, struct tmFwInfoStruct
*i
);
558 /* ----------------------------------------------------------- */
559 /* saa7164-cards.c */
560 extern struct saa7164_board saa7164_boards
[];
561 extern const unsigned int saa7164_bcount
;
563 extern struct saa7164_subid saa7164_subids
[];
564 extern const unsigned int saa7164_idcount
;
566 extern void saa7164_card_list(struct saa7164_dev
*dev
);
567 extern void saa7164_gpio_setup(struct saa7164_dev
*dev
);
568 extern void saa7164_card_setup(struct saa7164_dev
*dev
);
570 extern int saa7164_i2caddr_to_reglen(struct saa7164_i2c
*bus
, int addr
);
571 extern int saa7164_i2caddr_to_unitid(struct saa7164_i2c
*bus
, int addr
);
572 extern char *saa7164_unitid_name(struct saa7164_dev
*dev
, u8 unitid
);
574 /* ----------------------------------------------------------- */
576 extern int saa7164_dvb_register(struct saa7164_port
*port
);
577 extern int saa7164_dvb_unregister(struct saa7164_port
*port
);
579 /* ----------------------------------------------------------- */
580 /* saa7164-buffer.c */
581 extern struct saa7164_buffer
*saa7164_buffer_alloc(
582 struct saa7164_port
*port
, u32 len
);
583 extern int saa7164_buffer_dealloc(struct saa7164_buffer
*buf
);
584 extern void saa7164_buffer_display(struct saa7164_buffer
*buf
);
585 extern int saa7164_buffer_activate(struct saa7164_buffer
*buf
, int i
);
586 extern int saa7164_buffer_cfg_port(struct saa7164_port
*port
);
587 extern struct saa7164_user_buffer
*saa7164_buffer_alloc_user(
588 struct saa7164_dev
*dev
, u32 len
);
589 extern void saa7164_buffer_dealloc_user(struct saa7164_user_buffer
*buf
);
590 extern int saa7164_buffer_zero_offsets(struct saa7164_port
*port
, int i
);
592 /* ----------------------------------------------------------- */
593 /* saa7164-encoder.c */
594 int saa7164_encoder_register(struct saa7164_port
*port
);
595 void saa7164_encoder_unregister(struct saa7164_port
*port
);
597 /* ----------------------------------------------------------- */
599 int saa7164_vbi_register(struct saa7164_port
*port
);
600 void saa7164_vbi_unregister(struct saa7164_port
*port
);
602 /* ----------------------------------------------------------- */
604 extern unsigned int crc_checking
;
606 extern unsigned int saa_debug
;
607 #define dprintk(level, fmt, arg...)\
608 do { if (saa_debug & level)\
609 printk(KERN_DEBUG "%s: " fmt, dev->name, ## arg);\
612 #define log_warn(fmt, arg...)\
614 printk(KERN_WARNING "%s: " fmt, dev->name, ## arg);\
617 #define log_err(fmt, arg...)\
619 printk(KERN_ERROR "%s: " fmt, dev->name, ## arg);\
622 #define saa7164_readl(reg) readl(dev->lmmio + ((reg) >> 2))
623 #define saa7164_writel(reg, value) writel((value), dev->lmmio + ((reg) >> 2))
625 #define saa7164_readb(reg) readl(dev->bmmio + (reg))
626 #define saa7164_writeb(reg, value) writel((value), dev->bmmio + (reg))