[mirror_ubuntu-artful-kernel.git] / drivers / media / video / saa7164 / saa7164.h

/*
 *  Driver for the NXP SAA7164 PCIe bridge
 *
 *  Copyright (c) 2010 Steven Toth <stoth@kernellabs.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
	Driver architecture
	*******************

	saa7164_core.c/buffer.c/cards.c/i2c.c/dvb.c
		|	: Standard Linux driver framework for creating
		|	: exposing and managing interfaces to the rest
		|	: of the kernel or userland. Also uses _fw.c to load
		|	: firmware direct into the PCIe bus, bypassing layers.
		V
	saa7164_api..()	: Translate kernel specific functions/features
		|	: into command buffers.
		V
	saa7164_cmd..()	: Manages the flow of command packets on/off,
		|	: the bus. Deal with bus errors, timeouts etc.
		V
	saa7164_bus..() : Manage a read/write memory ring buffer in the
		|	: PCIe Address space.
		|
		|		saa7164_fw...()	: Load any frimware
		|			|	: direct into the device
		V			V
	<- ----------------- PCIe address space -------------------- ->
*/

#include <linux/pci.h>
#include <linux/i2c.h>
#include <linux/i2c-algo-bit.h>
#include <linux/kdev_t.h>
#include <linux/version.h>
#include <linux/mutex.h>
#include <linux/crc32.h>

#include <media/tuner.h>
#include <media/tveeprom.h>
#include <media/videobuf-dma-sg.h>
#include <media/videobuf-dvb.h>
#include <linux/smp_lock.h>
#include <dvb_demux.h>
#include <dvb_frontend.h>
#include <dvb_net.h>
#include <dvbdev.h>
#include <dmxdev.h>
#include <media/v4l2-common.h>
#include <media/v4l2-ioctl.h>
#include <media/v4l2-chip-ident.h>

#include "saa7164-reg.h"
#include "saa7164-types.h"

#define SAA7164_MAXBOARDS 8

#define UNSET (-1U)
#define SAA7164_BOARD_NOAUTO			UNSET
#define SAA7164_BOARD_UNKNOWN			0
#define SAA7164_BOARD_UNKNOWN_REV2		1
#define SAA7164_BOARD_UNKNOWN_REV3		2
#define SAA7164_BOARD_HAUPPAUGE_HVR2250		3
#define SAA7164_BOARD_HAUPPAUGE_HVR2200		4
#define SAA7164_BOARD_HAUPPAUGE_HVR2200_2	5
#define SAA7164_BOARD_HAUPPAUGE_HVR2200_3	6
#define SAA7164_BOARD_HAUPPAUGE_HVR2250_2	7
#define SAA7164_BOARD_HAUPPAUGE_HVR2250_3	8

#define SAA7164_MAX_UNITS		8
#define SAA7164_TS_NUMBER_OF_LINES	312
#define SAA7164_PS_NUMBER_OF_LINES	256
#define SAA7164_PT_ENTRIES		16 /* (312 * 188) / 4096 */
#define SAA7164_MAX_ENCODER_BUFFERS	64 /* max 5secs of latency at 6Mbps */
#define SAA7164_MAX_VBI_BUFFERS		64

/* Port related defines */
#define SAA7164_PORT_TS1	(0)
#define SAA7164_PORT_TS2	(SAA7164_PORT_TS1 + 1)
#define SAA7164_PORT_ENC1	(SAA7164_PORT_TS2 + 1)
#define SAA7164_PORT_ENC2	(SAA7164_PORT_ENC1 + 1)
#define SAA7164_PORT_VBI1	(SAA7164_PORT_ENC2 + 1)
#define SAA7164_PORT_VBI2	(SAA7164_PORT_VBI1 + 1)
#define SAA7164_MAX_PORTS	(SAA7164_PORT_VBI2 + 1)

#define DBGLVL_FW    4
#define DBGLVL_DVB   8
#define DBGLVL_I2C  16
#define DBGLVL_API  32
#define DBGLVL_CMD  64
#define DBGLVL_BUS 128
#define DBGLVL_IRQ 256
#define DBGLVL_BUF 512
#define DBGLVL_ENC 1024
#define DBGLVL_VBI 2048

#define SAA7164_NORMS ( V4L2_STD_NTSC_M |  V4L2_STD_NTSC_M_JP |  V4L2_STD_NTSC_443 )

enum port_t {
	SAA7164_MPEG_UNDEFINED = 0,
	SAA7164_MPEG_DVB,
	SAA7164_MPEG_ENCODER,
	SAA7164_MPEG_VBI,
};

enum saa7164_i2c_bus_nr {
	SAA7164_I2C_BUS_0 = 0,
	SAA7164_I2C_BUS_1,
	SAA7164_I2C_BUS_2,
};

enum saa7164_buffer_flags {
	SAA7164_BUFFER_UNDEFINED = 0,
	SAA7164_BUFFER_FREE,
	SAA7164_BUFFER_BUSY,
	SAA7164_BUFFER_FULL
};

enum saa7164_unit_type {
	SAA7164_UNIT_UNDEFINED = 0,
	SAA7164_UNIT_DIGITAL_DEMODULATOR,
	SAA7164_UNIT_ANALOG_DEMODULATOR,
	SAA7164_UNIT_TUNER,
	SAA7164_UNIT_EEPROM,
	SAA7164_UNIT_ZILOG_IRBLASTER,
	SAA7164_UNIT_ENCODER,
};

/* The PCIe bridge doesn't grant direct access to i2c.
 * Instead, you address i2c devices using a uniqely
 * allocated 'unitid' value via a messaging API. This
 * is a problem. The kernel and existing demod/tuner
 * drivers expect to talk 'i2c', so we have to maintain
 * a translation layer, and a series of functions to
 * convert i2c bus + device address into a unit id.
 */
struct saa7164_unit {
	enum saa7164_unit_type type;
	u8	id;
	char	*name;
	enum saa7164_i2c_bus_nr i2c_bus_nr;
	u8	i2c_bus_addr;
	u8	i2c_reg_len;
};

struct saa7164_board {
	char	*name;
	enum port_t porta, portb, portc,
		portd, porte, portf;
	enum {
		SAA7164_CHIP_UNDEFINED = 0,
		SAA7164_CHIP_REV2,
		SAA7164_CHIP_REV3,
	} chiprev;
	struct	saa7164_unit unit[SAA7164_MAX_UNITS];
};

struct saa7164_subid {
	u16     subvendor;
	u16     subdevice;
	u32     card;
};

struct saa7164_encoder_fh {
	struct saa7164_port *port;
//	u32 freq;
//	u32 tuner_type;
	atomic_t v4l_reading;
};

struct saa7164_vbi_fh {
	struct saa7164_port *port;
//	u32 freq;
//	u32 tuner_type;
	atomic_t v4l_reading;
};

struct saa7164_histogram_bucket {
	u32 val;
	u32 count;
	u64 update_time;
};

struct saa7164_histogram {
	char name[32];
	struct saa7164_histogram_bucket counter1[64];
};

struct saa7164_user_buffer {
	struct list_head list;

	/* Attributes */
	u8  *data;
	u32 pos;
	u32 actual_size;

	u32 crc;
};

struct saa7164_fw_status {

	/* RISC Core details */
	u32	status;
	u32	mode;
	u32	spec;
	u32	inst;
	u32	cpuload;
	u32	remainheap;

	/* Firmware version */
	u32	version;
	u32	major;
	u32	sub;
	u32	rel;
	u32	buildnr;
};

struct saa7164_dvb {
	struct mutex lock;
	struct dvb_adapter adapter;
	struct dvb_frontend *frontend;
	struct dvb_demux demux;
	struct dmxdev dmxdev;
	struct dmx_frontend fe_hw;
	struct dmx_frontend fe_mem;
	struct dvb_net net;
	int feeding;
};

struct saa7164_i2c {
	struct saa7164_dev		*dev;

	enum saa7164_i2c_bus_nr		nr;

	/* I2C I/O */
	struct i2c_adapter		i2c_adap;
	struct i2c_algo_bit_data	i2c_algo;
	struct i2c_client		i2c_client;
	u32				i2c_rc;
};

struct saa7164_ctrl {
	struct v4l2_queryctrl v;
};

struct saa7164_tvnorm {
	char		*name;
	v4l2_std_id	id;
//	u32		cxiformat;
//	u32		cxoformat;
};

struct saa7164_encoder_params {
	struct saa7164_tvnorm encodernorm;
	u32 height;
	u32 width;
	u32 is_50hz;
	u32 bitrate; /* bps */
	u32 bitrate_peak; /* bps */
	u32 bitrate_mode;
	u32 stream_type; /* V4L2_MPEG_STREAM_TYPE_MPEG2_TS */

	u32 audio_sampling_freq;
	u32 ctl_mute;
	u32 ctl_aspect;
	u32 refdist;
	u32 gop_size;
};

struct saa7164_vbi_params {
	struct saa7164_tvnorm encodernorm;
	u32 height;
	u32 width;
	u32 is_50hz;
	u32 bitrate; /* bps */
	u32 bitrate_peak; /* bps */
	u32 bitrate_mode;
	u32 stream_type; /* V4L2_MPEG_STREAM_TYPE_MPEG2_TS */

	u32 audio_sampling_freq;
	u32 ctl_mute;
	u32 ctl_aspect;
	u32 refdist;
	u32 gop_size;
};

struct saa7164_port;

struct saa7164_buffer {
	struct list_head list;

	/* Note of which h/w buffer list index position we occupy */
	int idx;

	struct saa7164_port *port;

	/* Hardware Specific */
	/* PCI Memory allocations */
	enum saa7164_buffer_flags flags; /* Free, Busy, Full */

	/* A block of page align PCI memory */
	u32 pci_size;	/* PCI allocation size in bytes */
	u64 __iomem *cpu;	/* Virtual address */
	dma_addr_t dma;	/* Physical address */
	u32 crc;	/* Checksum for the entire buffer data */

	/* A page table that splits the block into a number of entries */
	u32 pt_size;		/* PCI allocation size in bytes */
	u64 __iomem *pt_cpu;		/* Virtual address */
	dma_addr_t pt_dma;	/* Physical address */

	/* Encoder fops */
	u32 pos;
	u32 actual_size;
};

struct saa7164_port {

	struct saa7164_dev *dev;
	enum port_t type;
	int nr;

	/* --- Generic port attributes --- */

	/* HW stream parameters */
	tmHWStreamParameters_t hw_streamingparams;

	/* DMA configuration values, is seeded during initialization */
	tmComResDMATermDescrHeader_t hwcfg;

	/* hardware specific registers */
	u32 bufcounter;
	u32 pitch;
	u32 bufsize;
	u32 bufoffset;
	u32 bufptr32l;
	u32 bufptr32h;
	u64 bufptr64;

	u32 numpte;	/* Number of entries in array, only valid in head */

	struct mutex dmaqueue_lock;
	struct saa7164_buffer dmaqueue;

	u64 last_irq_msecs, last_svc_msecs;
	u64 last_irq_msecs_diff, last_svc_msecs_diff;
	u32 last_svc_wp;
	u32 last_svc_rp;
	u64 last_irq_svc_msecs_diff;
	u64 last_read_msecs, last_read_msecs_diff;
	u64 last_poll_msecs, last_poll_msecs_diff;

	struct saa7164_histogram irq_interval;
	struct saa7164_histogram svc_interval;
	struct saa7164_histogram irq_svc_interval;
	struct saa7164_histogram read_interval;
	struct saa7164_histogram poll_interval;

	/* --- DVB Transport Specific --- */
	struct saa7164_dvb dvb;

	/* --- Encoder/V4L related attributes --- */
	/* Encoder */
	/* Defaults established in saa7164-encoder.c */
	struct saa7164_tvnorm encodernorm;
	u32 height;
	u32 width;
	u32 freq;
	u32 ts_packet_size;
	u32 ts_packet_count;
	u8 mux_input;
	u8 encoder_profile;
	u8 video_format;
	u8 audio_format;
	u8 video_resolution;
	u16 ctl_brightness;
	u16 ctl_contrast;
	u16 ctl_hue;
	u16 ctl_saturation;
	u16 ctl_sharpness;
	s8 ctl_volume;

	tmComResAFeatureDescrHeader_t audfeat;
	tmComResEncoderDescrHeader_t encunit;
	tmComResProcDescrHeader_t vidproc;
	tmComResExtDevDescrHeader_t ifunit;
	tmComResTunerDescrHeader_t tunerunit;

	struct work_struct workenc;

	/* V4L Encoder Video */
	struct saa7164_encoder_params encoder_params;
	struct video_device *v4l_device;
	atomic_t v4l_reader_count;

	struct saa7164_buffer list_buf_used;
	struct saa7164_buffer list_buf_free;
	wait_queue_head_t wait_read;

	/* V4L VBI */
	tmComResVBIFormatDescrHeader_t vbi_fmt_ntsc;
	struct saa7164_vbi_params vbi_params;

	/* Debug */
	u32 sync_errors;
	u32 v_cc_errors;
	u32 a_cc_errors;
	u8 last_v_cc;
	u8 last_a_cc;
	u32 done_first_interrupt;
};

struct saa7164_dev {
	struct list_head	devlist;
	atomic_t		refcount;

	/* pci stuff */
	struct pci_dev	*pci;
	unsigned char	pci_rev, pci_lat;
	int		pci_bus, pci_slot;
	u32		__iomem *lmmio;
	u8		__iomem *bmmio;
	u32		__iomem *lmmio2;
	u8		__iomem *bmmio2;
	int		pci_irqmask;

	/* board details */
	int	nr;
	int	hwrevision;
	u32	board;
	char	name[32];

	/* firmware status */
	struct saa7164_fw_status	fw_status;

	tmComResHWDescr_t		hwdesc;
	tmComResInterfaceDescr_t	intfdesc;
	tmComResBusDescr_t		busdesc;

	tmComResBusInfo_t		bus;

	/* Interrupt status and ack registers */
	u32 int_status;
	u32 int_ack;

	struct cmd			cmds[SAA_CMD_MAX_MSG_UNITS];
	struct mutex			lock;

	/* I2c related */
	struct saa7164_i2c i2c_bus[3];

	/* Transport related */
	struct saa7164_port ports[ SAA7164_MAX_PORTS ];

	/* Deferred command/api interrupts handling */
	struct work_struct workcmd;

};

extern struct list_head saa7164_devlist;
extern unsigned int waitsecs;
extern unsigned int encoder_buffers;
extern unsigned int vbi_buffers;

/* ----------------------------------------------------------- */
/* saa7164-core.c                                              */
void saa7164_dumpregs(struct saa7164_dev *dev, u32 addr);
void saa7164_dumphex16(struct saa7164_dev *dev, u8 *buf, int len);
void saa7164_getfirmwarestatus(struct saa7164_dev *dev);
u32 saa7164_getcurrentfirmwareversion(struct saa7164_dev *dev);
void saa7164_histogram_update(struct saa7164_histogram *hg, u32 val);

/* ----------------------------------------------------------- */
/* saa7164-fw.c                                                */
int saa7164_downloadfirmware(struct saa7164_dev *dev);

/* ----------------------------------------------------------- */
/* saa7164-i2c.c                                               */
extern int saa7164_i2c_register(struct saa7164_i2c *bus);
extern int saa7164_i2c_unregister(struct saa7164_i2c *bus);
extern void saa7164_call_i2c_clients(struct saa7164_i2c *bus,
	unsigned int cmd, void *arg);

/* ----------------------------------------------------------- */
/* saa7164-bus.c                                               */
int saa7164_bus_setup(struct saa7164_dev *dev);
void saa7164_bus_dump(struct saa7164_dev *dev);
int saa7164_bus_set(struct saa7164_dev *dev, tmComResInfo_t* msg, void *buf);
int saa7164_bus_get(struct saa7164_dev *dev, tmComResInfo_t* msg,
	void *buf, int peekonly);

/* ----------------------------------------------------------- */
/* saa7164-cmd.c                                               */
int saa7164_cmd_send(struct saa7164_dev *dev,
	u8 id, tmComResCmd_t command, u16 controlselector,
	u16 size, void *buf);
void saa7164_cmd_signal(struct saa7164_dev *dev, u8 seqno);
int saa7164_irq_dequeue(struct saa7164_dev *dev);

/* ----------------------------------------------------------- */
/* saa7164-api.c                                               */
int saa7164_api_get_fw_version(struct saa7164_dev *dev, u32 *version);
int saa7164_api_enum_subdevs(struct saa7164_dev *dev);
int saa7164_api_i2c_read(struct saa7164_i2c *bus, u8 addr, u32 reglen, u8 *reg,
	u32 datalen, u8 *data);
int saa7164_api_i2c_write(struct saa7164_i2c *bus, u8 addr,
	u32 datalen, u8 *data);
int saa7164_api_dif_write(struct saa7164_i2c *bus, u8 addr,
	u32 datalen, u8 *data);
int saa7164_api_read_eeprom(struct saa7164_dev *dev, u8 *buf, int buflen);
int saa7164_api_set_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
int saa7164_api_clear_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
int saa7164_api_transition_port(struct saa7164_port *port, u8 mode);
int saa7164_api_initialize_dif(struct saa7164_port *port);
int saa7164_api_configure_dif(struct saa7164_port *port, u32 std);
int saa7164_api_set_encoder(struct saa7164_port *port);
int saa7164_api_get_encoder(struct saa7164_port *port);
int saa7164_api_set_aspect_ratio(struct saa7164_port *port);
int saa7164_api_set_usercontrol(struct saa7164_port *port, u8 ctl);
int saa7164_api_get_usercontrol(struct saa7164_port *port, u8 ctl);
int saa7164_api_set_videomux(struct saa7164_port *port);
int saa7164_api_audio_mute(struct saa7164_port *port, int mute);
int saa7164_api_set_audio_volume(struct saa7164_port *port, s8 level);
int saa7164_api_set_audio_std(struct saa7164_port *port);
int saa7164_api_set_audio_detection(struct saa7164_port *port, int autodetect);
int saa7164_api_get_videomux(struct saa7164_port *port);
int saa7164_api_set_vbi_format(struct saa7164_port *port);

/* ----------------------------------------------------------- */
/* saa7164-cards.c                                             */
extern struct saa7164_board saa7164_boards[];
extern const unsigned int saa7164_bcount;

extern struct saa7164_subid saa7164_subids[];
extern const unsigned int saa7164_idcount;

extern void saa7164_card_list(struct saa7164_dev *dev);
extern void saa7164_gpio_setup(struct saa7164_dev *dev);
extern void saa7164_card_setup(struct saa7164_dev *dev);

extern int saa7164_i2caddr_to_reglen(struct saa7164_i2c *bus, int addr);
extern int saa7164_i2caddr_to_unitid(struct saa7164_i2c *bus, int addr);
extern char *saa7164_unitid_name(struct saa7164_dev *dev, u8 unitid);

/* ----------------------------------------------------------- */
/* saa7164-dvb.c                                               */
extern int saa7164_dvb_register(struct saa7164_port *port);
extern int saa7164_dvb_unregister(struct saa7164_port *port);

/* ----------------------------------------------------------- */
/* saa7164-buffer.c                                            */
extern struct saa7164_buffer *saa7164_buffer_alloc(
	struct saa7164_port *port, u32 len);
extern int saa7164_buffer_dealloc(struct saa7164_buffer *buf);
extern void saa7164_buffer_display(struct saa7164_buffer *buf);
extern int saa7164_buffer_activate(struct saa7164_buffer *buf, int i);
extern int saa7164_buffer_cfg_port(struct saa7164_port *port);
extern struct saa7164_user_buffer *saa7164_buffer_alloc_user(
	struct saa7164_dev *dev, u32 len);
extern void saa7164_buffer_dealloc_user(struct saa7164_user_buffer *buf);
extern int saa7164_buffer_zero_offsets(struct saa7164_port *port, int i);

/* ----------------------------------------------------------- */
/* saa7164-encoder.c                                            */
int saa7164_encoder_register(struct saa7164_port *port);
void saa7164_encoder_unregister(struct saa7164_port *port);

/* ----------------------------------------------------------- */
/* saa7164-vbi.c                                            */
int saa7164_vbi_register(struct saa7164_port *port);
void saa7164_vbi_unregister(struct saa7164_port *port);

/* ----------------------------------------------------------- */

extern unsigned int crc_checking;

extern unsigned int saa_debug;
#define dprintk(level, fmt, arg...)\
	do { if (saa_debug & level)\
		printk(KERN_DEBUG "%s: " fmt, dev->name, ## arg);\
	} while (0)

#define log_warn(fmt, arg...)\
	do { \
		printk(KERN_WARNING "%s: " fmt, dev->name, ## arg);\
	} while (0)

#define log_err(fmt, arg...)\
	do { \
		printk(KERN_ERROR "%s: " fmt, dev->name, ## arg);\
	} while (0)

#define saa7164_readl(reg) readl(dev->lmmio + ((reg) >> 2))
#define saa7164_writel(reg, value) writel((value), dev->lmmio + ((reg) >> 2))


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