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

/*
 *  cx18 driver internal defines and structures
 *
 *  Derived from ivtv-driver.h
 *
 *  Copyright (C) 2007  Hans Verkuil <hverkuil@xs4all.nl>
 *
 *  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., 59 Temple Place, Suite 330, Boston, MA
 *  02111-1307  USA
 */

#ifndef CX18_DRIVER_H
#define CX18_DRIVER_H

#include <linux/version.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/sched.h>
#include <linux/fs.h>
#include <linux/pci.h>
#include <linux/interrupt.h>
#include <linux/spinlock.h>
#include <linux/i2c.h>
#include <linux/i2c-algo-bit.h>
#include <linux/list.h>
#include <linux/unistd.h>
#include <linux/pagemap.h>
#include <linux/workqueue.h>
#include <linux/mutex.h>
#include <asm/byteorder.h>

#include <linux/dvb/video.h>
#include <linux/dvb/audio.h>
#include <media/v4l2-common.h>
#include <media/v4l2-ioctl.h>
#include <media/tuner.h>
#include "cx18-mailbox.h"
#include "cx18-av-core.h"
#include "cx23418.h"

/* DVB */
#include "demux.h"
#include "dmxdev.h"
#include "dvb_demux.h"
#include "dvb_frontend.h"
#include "dvb_net.h"
#include "dvbdev.h"

#ifndef CONFIG_PCI
#  error "This driver requires kernel PCI support."
#endif

/* Default delay to throttle mmio access to the CX23418 */
#define CX18_DEFAULT_MMIO_NDELAY 0 /* 0 ns = 0 PCI clock(s) / 33 MHz */

#define CX18_MEM_OFFSET	0x00000000
#define CX18_MEM_SIZE	0x04000000
#define CX18_REG_OFFSET	0x02000000

/* Maximum cx18 driver instances. */
#define CX18_MAX_CARDS 32

/* Supported cards */
#define CX18_CARD_HVR_1600_ESMT	      0	/* Hauppauge HVR 1600 (ESMT memory) */
#define CX18_CARD_HVR_1600_SAMSUNG    1	/* Hauppauge HVR 1600 (Samsung memory) */
#define CX18_CARD_COMPRO_H900 	      2	/* Compro VideoMate H900 */
#define CX18_CARD_YUAN_MPC718 	      3	/* Yuan MPC718 */
#define CX18_CARD_CNXT_RAPTOR_PAL     4	/* Conexant Raptor PAL */
#define CX18_CARD_TOSHIBA_QOSMIO_DVBT 5 /* Toshiba Qosmio Interal DVB-T/Analog*/
#define CX18_CARD_LEADTEK_PVR2100     6 /* Leadtek WinFast PVR2100 */
#define CX18_CARD_LAST 		      6

#define CX18_ENC_STREAM_TYPE_MPG  0
#define CX18_ENC_STREAM_TYPE_TS   1
#define CX18_ENC_STREAM_TYPE_YUV  2
#define CX18_ENC_STREAM_TYPE_VBI  3
#define CX18_ENC_STREAM_TYPE_PCM  4
#define CX18_ENC_STREAM_TYPE_IDX  5
#define CX18_ENC_STREAM_TYPE_RAD  6
#define CX18_MAX_STREAMS	  7

/* system vendor and device IDs */
#define PCI_VENDOR_ID_CX      0x14f1
#define PCI_DEVICE_ID_CX23418 0x5b7a

/* subsystem vendor ID */
#define CX18_PCI_ID_HAUPPAUGE 		0x0070
#define CX18_PCI_ID_COMPRO 		0x185b
#define CX18_PCI_ID_YUAN 		0x12ab
#define CX18_PCI_ID_CONEXANT		0x14f1
#define CX18_PCI_ID_TOSHIBA		0x1179
#define CX18_PCI_ID_LEADTEK		0x107D

/* ======================================================================== */
/* ========================== START USER SETTABLE DMA VARIABLES =========== */
/* ======================================================================== */

/* DMA Buffers, Default size in MB allocated */
#define CX18_DEFAULT_ENC_TS_BUFFERS  1
#define CX18_DEFAULT_ENC_MPG_BUFFERS 2
#define CX18_DEFAULT_ENC_IDX_BUFFERS 1
#define CX18_DEFAULT_ENC_YUV_BUFFERS 2
#define CX18_DEFAULT_ENC_VBI_BUFFERS 1
#define CX18_DEFAULT_ENC_PCM_BUFFERS 1

/* i2c stuff */
#define I2C_CLIENTS_MAX 16

/* debugging */

/* Flag to turn on high volume debugging */
#define CX18_DBGFLG_WARN  (1 << 0)
#define CX18_DBGFLG_INFO  (1 << 1)
#define CX18_DBGFLG_API   (1 << 2)
#define CX18_DBGFLG_DMA   (1 << 3)
#define CX18_DBGFLG_IOCTL (1 << 4)
#define CX18_DBGFLG_FILE  (1 << 5)
#define CX18_DBGFLG_I2C   (1 << 6)
#define CX18_DBGFLG_IRQ   (1 << 7)
/* Flag to turn on high volume debugging */
#define CX18_DBGFLG_HIGHVOL (1 << 8)

/* NOTE: extra space before comma in 'cx->num , ## args' is required for
   gcc-2.95, otherwise it won't compile. */
#define CX18_DEBUG(x, type, fmt, args...) \
	do { \
		if ((x) & cx18_debug) \
			printk(KERN_INFO "cx18-%d " type ": " fmt, cx->num , ## args); \
	} while (0)
#define CX18_DEBUG_WARN(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_WARN, "warning", fmt , ## args)
#define CX18_DEBUG_INFO(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_INFO, "info", fmt , ## args)
#define CX18_DEBUG_API(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_API, "api", fmt , ## args)
#define CX18_DEBUG_DMA(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_DMA, "dma", fmt , ## args)
#define CX18_DEBUG_IOCTL(fmt, args...) CX18_DEBUG(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
#define CX18_DEBUG_FILE(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_FILE, "file", fmt , ## args)
#define CX18_DEBUG_I2C(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
#define CX18_DEBUG_IRQ(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_IRQ, "irq", fmt , ## args)

#define CX18_DEBUG_HIGH_VOL(x, type, fmt, args...) \
	do { \
		if (((x) & cx18_debug) && (cx18_debug & CX18_DBGFLG_HIGHVOL)) \
			printk(KERN_INFO "cx18%d " type ": " fmt, cx->num , ## args); \
	} while (0)
#define CX18_DEBUG_HI_WARN(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_WARN, "warning", fmt , ## args)
#define CX18_DEBUG_HI_INFO(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_INFO, "info", fmt , ## args)
#define CX18_DEBUG_HI_API(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_API, "api", fmt , ## args)
#define CX18_DEBUG_HI_DMA(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_DMA, "dma", fmt , ## args)
#define CX18_DEBUG_HI_IOCTL(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
#define CX18_DEBUG_HI_FILE(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_FILE, "file", fmt , ## args)
#define CX18_DEBUG_HI_I2C(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
#define CX18_DEBUG_HI_IRQ(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IRQ, "irq", fmt , ## args)

/* Standard kernel messages */
#define CX18_ERR(fmt, args...)      printk(KERN_ERR  "cx18-%d: " fmt, cx->num , ## args)
#define CX18_WARN(fmt, args...)     printk(KERN_WARNING "cx18-%d: " fmt, cx->num , ## args)
#define CX18_INFO(fmt, args...)     printk(KERN_INFO "cx18-%d: " fmt, cx->num , ## args)

/* Values for CX18_API_DEC_PLAYBACK_SPEED mpeg_frame_type_mask parameter: */
#define MPEG_FRAME_TYPE_IFRAME 1
#define MPEG_FRAME_TYPE_IFRAME_PFRAME 3
#define MPEG_FRAME_TYPE_ALL 7

#define CX18_MAX_PGM_INDEX (400)

extern int cx18_retry_mmio;	/* enable check & retry of mmio accesses */
extern int cx18_debug;


struct cx18_options {
	int megabytes[CX18_MAX_STREAMS]; /* Size in megabytes of each stream */
	int cardtype;		/* force card type on load */
	int tuner;		/* set tuner on load */
	int radio;		/* enable/disable radio */
	unsigned long mmio_ndelay; /* delay in ns after every PCI mmio access */
};

/* per-buffer bit flags */
#define CX18_F_B_NEED_BUF_SWAP  0	/* this buffer should be byte swapped */

/* per-stream, s_flags */
#define CX18_F_S_CLAIMED 	3	/* this stream is claimed */
#define CX18_F_S_STREAMING      4	/* the fw is decoding/encoding this stream */
#define CX18_F_S_INTERNAL_USE	5	/* this stream is used internally (sliced VBI processing) */
#define CX18_F_S_STREAMOFF	7	/* signal end of stream EOS */
#define CX18_F_S_APPL_IO        8	/* this stream is used read/written by an application */

/* per-cx18, i_flags */
#define CX18_F_I_LOADED_FW	0 	/* Loaded the firmware the first time */
#define CX18_F_I_EOS		4 	/* End of encoder stream reached */
#define CX18_F_I_RADIO_USER	5 	/* The radio tuner is selected */
#define CX18_F_I_ENC_PAUSED	13 	/* the encoder is paused */
#define CX18_F_I_INITED		21 	/* set after first open */
#define CX18_F_I_FAILED		22 	/* set if first open failed */

/* These are the VBI types as they appear in the embedded VBI private packets. */
#define CX18_SLICED_TYPE_TELETEXT_B     (1)
#define CX18_SLICED_TYPE_CAPTION_525    (4)
#define CX18_SLICED_TYPE_WSS_625        (5)
#define CX18_SLICED_TYPE_VPS            (7)

struct cx18_buffer {
	struct list_head list;
	dma_addr_t dma_handle;
	u32 id;
	unsigned long b_flags;
	char *buf;

	u32 bytesused;
	u32 readpos;
};

struct cx18_queue {
	struct list_head list;
	atomic_t buffers;
	u32 bytesused;
};

struct cx18_dvb {
	struct dmx_frontend hw_frontend;
	struct dmx_frontend mem_frontend;
	struct dmxdev dmxdev;
	struct dvb_adapter dvb_adapter;
	struct dvb_demux demux;
	struct dvb_frontend *fe;
	struct dvb_net dvbnet;
	int enabled;
	int feeding;
	struct mutex feedlock;
};

struct cx18;	 /* forward reference */
struct cx18_scb; /* forward reference */

#define CX18_INVALID_TASK_HANDLE 0xffffffff

struct cx18_stream {
	/* These first four fields are always set, even if the stream
	   is not actually created. */
	struct video_device *v4l2dev;	/* NULL when stream not created */
	struct cx18 *cx; 		/* for ease of use */
	const char *name;		/* name of the stream */
	int type;			/* stream type */
	u32 handle;			/* task handle */
	unsigned mdl_offset;

	u32 id;
	spinlock_t qlock; 	/* locks access to the queues */
	unsigned long s_flags;	/* status flags, see above */
	int dma;		/* can be PCI_DMA_TODEVICE,
				   PCI_DMA_FROMDEVICE or
				   PCI_DMA_NONE */
	u64 dma_pts;
	wait_queue_head_t waitq;

	/* Buffer Stats */
	u32 buffers;
	u32 buf_size;

	/* Buffer Queues */
	struct cx18_queue q_free;	/* free buffers */
	struct cx18_queue q_full;	/* full buffers */
	struct cx18_queue q_io;		/* waiting for I/O */

	/* DVB / Digital Transport */
	struct cx18_dvb dvb;
};

struct cx18_open_id {
	u32 open_id;
	int type;
	enum v4l2_priority prio;
	struct cx18 *cx;
};

/* forward declaration of struct defined in cx18-cards.h */
struct cx18_card;


#define CX18_VBI_FRAMES 32

/* VBI data */
struct vbi_info {
	u32 enc_size;
	u32 frame;
	u8 cc_data_odd[256];
	u8 cc_data_even[256];
	int cc_pos;
	u8 cc_no_update;
	u8 vps[5];
	u8 vps_found;
	int wss;
	u8 wss_found;
	u8 wss_no_update;
	u32 raw_decoder_line_size;
	u8 raw_decoder_sav_odd_field;
	u8 raw_decoder_sav_even_field;
	u32 sliced_decoder_line_size;
	u8 sliced_decoder_sav_odd_field;
	u8 sliced_decoder_sav_even_field;
	struct v4l2_format in;
	/* convenience pointer to sliced struct in vbi_in union */
	struct v4l2_sliced_vbi_format *sliced_in;
	u32 service_set_in;
	int insert_mpeg;

	/* Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
	   One for /dev/vbi0 and one for /dev/vbi8 */
	struct v4l2_sliced_vbi_data sliced_data[36];

	/* Buffer for VBI data inserted into MPEG stream.
	   The first byte is a dummy byte that's never used.
	   The next 16 bytes contain the MPEG header for the VBI data,
	   the remainder is the actual VBI data.
	   The max size accepted by the MPEG VBI reinsertion turns out
	   to be 1552 bytes, which happens to be 4 + (1 + 42) * (2 * 18) bytes,
	   where 4 is a four byte header, 42 is the max sliced VBI payload, 1 is
	   a single line header byte and 2 * 18 is the number of VBI lines per frame.

	   However, it seems that the data must be 1K aligned, so we have to
	   pad the data until the 1 or 2 K boundary.

	   This pointer array will allocate 2049 bytes to store each VBI frame. */
	u8 *sliced_mpeg_data[CX18_VBI_FRAMES];
	u32 sliced_mpeg_size[CX18_VBI_FRAMES];
	struct cx18_buffer sliced_mpeg_buf;
	u32 inserted_frame;

	u32 start[2], count;
	u32 raw_size;
	u32 sliced_size;
};

/* Per cx23418, per I2C bus private algo callback data */
struct cx18_i2c_algo_callback_data {
	struct cx18 *cx;
	int bus_index;   /* 0 or 1 for the cx23418's 1st or 2nd I2C bus */
};

#define CX18_MAX_MMIO_RETRIES 10

struct cx18_mmio_stats {
	atomic_t retried_write[CX18_MAX_MMIO_RETRIES+1];
	atomic_t retried_read[CX18_MAX_MMIO_RETRIES+1];
};

/* Struct to hold info about cx18 cards */
struct cx18 {
	int num;		/* board number, -1 during init! */
	char name[8];		/* board name for printk and interrupts (e.g. 'cx180') */
	struct pci_dev *dev;	/* PCI device */
	const struct cx18_card *card;	/* card information */
	const char *card_name;  /* full name of the card */
	const struct cx18_card_tuner_i2c *card_i2c; /* i2c addresses to probe for tuner */
	u8 is_50hz;
	u8 is_60hz;
	u8 is_out_50hz;
	u8 is_out_60hz;
	u8 nof_inputs;		/* number of video inputs */
	u8 nof_audio_inputs;	/* number of audio inputs */
	u16 buffer_id;		/* buffer ID counter */
	u32 v4l2_cap;		/* V4L2 capabilities of card */
	u32 hw_flags; 		/* Hardware description of the board */
	unsigned mdl_offset;
	struct cx18_scb __iomem *scb;   /* pointer to SCB */

	struct cx18_av_state av_state;

	/* codec settings */
	struct cx2341x_mpeg_params params;
	u32 filter_mode;
	u32 temporal_strength;
	u32 spatial_strength;

	/* dualwatch */
	unsigned long dualwatch_jiffies;
	u16 dualwatch_stereo_mode;

	/* Digitizer type */
	int digitizer;		/* 0x00EF = saa7114 0x00FO = saa7115 0x0106 = mic */

	struct mutex serialize_lock;    /* mutex used to serialize open/close/start/stop/ioctl operations */
	struct cx18_options options; 	/* User options */
	int stream_buf_size[CX18_MAX_STREAMS]; /* Stream buffer size */
	struct cx18_stream streams[CX18_MAX_STREAMS]; 	/* Stream data */
	unsigned long i_flags;  /* global cx18 flags */
	atomic_t ana_capturing;	/* count number of active analog capture streams */
	atomic_t tot_capturing;	/* total count number of active capture streams */
	spinlock_t lock;        /* lock access to this struct */
	int search_pack_header;

	int open_id;		/* incremented each time an open occurs, used as
				   unique ID. Starts at 1, so 0 can be used as
				   uninitialized value in the stream->id. */

	u32 base_addr;
	struct v4l2_prio_state prio;

	u8 card_rev;
	void __iomem *enc_mem, *reg_mem;

	struct vbi_info vbi;

	u32 pgm_info_offset;
	u32 pgm_info_num;
	u32 pgm_info_write_idx;
	u32 pgm_info_read_idx;
	struct v4l2_enc_idx_entry pgm_info[CX18_MAX_PGM_INDEX];

	u64 mpg_data_received;
	u64 vbi_data_inserted;

	wait_queue_head_t mb_apu_waitq;
	wait_queue_head_t mb_cpu_waitq;
	wait_queue_head_t mb_epu_waitq;
	wait_queue_head_t mb_hpu_waitq;
	wait_queue_head_t cap_w;
	/* when the current DMA is finished this queue is woken up */
	wait_queue_head_t dma_waitq;

	/* i2c */
	struct i2c_adapter i2c_adap[2];
	struct i2c_algo_bit_data i2c_algo[2];
	struct cx18_i2c_algo_callback_data i2c_algo_cb_data[2];
	struct i2c_client i2c_client[2];
	struct mutex i2c_bus_lock[2];
	struct i2c_client *i2c_clients[I2C_CLIENTS_MAX];

	/* gpio */
	u32 gpio_dir;
	u32 gpio_val;
	struct mutex gpio_lock;

	/* Statistics */
	struct cx18_mmio_stats mmio_stats;

	/* v4l2 and User settings */

	/* codec settings */
	u32 audio_input;
	u32 active_input;
	u32 active_output;
	v4l2_std_id std;
	v4l2_std_id tuner_std;	/* The norm of the tuner (fixed) */
};

/* Globals */
extern struct cx18 *cx18_cards[];
extern int cx18_cards_active;
extern int cx18_first_minor;
extern spinlock_t cx18_cards_lock;

/*==============Prototypes==================*/

/* Return non-zero if a signal is pending */
int cx18_msleep_timeout(unsigned int msecs, int intr);

/* Read Hauppauge eeprom */
struct tveeprom; /* forward reference */
void cx18_read_eeprom(struct cx18 *cx, struct tveeprom *tv);

/* First-open initialization: load firmware, etc. */
int cx18_init_on_first_open(struct cx18 *cx);

#endif /* CX18_DRIVER_H */
Commit	Line	Data
1c1e45d1 HV	1	/*
	2	* cx18 driver internal defines and structures
	3	*
	4	* Derived from ivtv-driver.h
	5	*
	6	* Copyright (C) 2007 Hans Verkuil <hverkuil@xs4all.nl>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
	21	* 02111-1307 USA
	22	*/
	23
	24	#ifndef CX18_DRIVER_H
	25	#define CX18_DRIVER_H
	26
	27	#include <linux/version.h>
	28	#include <linux/module.h>
	29	#include <linux/moduleparam.h>
	30	#include <linux/init.h>
	31	#include <linux/delay.h>
	32	#include <linux/sched.h>
	33	#include <linux/fs.h>
	34	#include <linux/pci.h>
	35	#include <linux/interrupt.h>
	36	#include <linux/spinlock.h>
	37	#include <linux/i2c.h>
	38	#include <linux/i2c-algo-bit.h>
	39	#include <linux/list.h>
	40	#include <linux/unistd.h>
1c1e45d1 HV	41	#include <linux/pagemap.h>
	42	#include <linux/workqueue.h>
	43	#include <linux/mutex.h>
1a651a00	44	#include <asm/byteorder.h>
1c1e45d1 HV	45
	46	#include <linux/dvb/video.h>
	47	#include <linux/dvb/audio.h>
	48	#include <media/v4l2-common.h>
35ea11ff	49	#include <media/v4l2-ioctl.h>
1c1e45d1 HV	50	#include <media/tuner.h>
	51	#include "cx18-mailbox.h"
	52	#include "cx18-av-core.h"
	53	#include "cx23418.h"
	54
	55	/* DVB */
	56	#include "demux.h"
	57	#include "dmxdev.h"
	58	#include "dvb_demux.h"
	59	#include "dvb_frontend.h"
	60	#include "dvb_net.h"
	61	#include "dvbdev.h"
	62
	63	#ifndef CONFIG_PCI
	64	# error "This driver requires kernel PCI support."
	65	#endif
	66
446f2459 AW	67	/* Default delay to throttle mmio access to the CX23418 */
446f2459 AW	68	#define CX18_DEFAULT_MMIO_NDELAY 0 /* 0 ns = 0 PCI clock(s) / 33 MHz */
c641d09c	69
1c1e45d1 HV	70	#define CX18_MEM_OFFSET 0x00000000
	71	#define CX18_MEM_SIZE 0x04000000
	72	#define CX18_REG_OFFSET 0x02000000
	73
	74	/* Maximum cx18 driver instances. */
	75	#define CX18_MAX_CARDS 32
	76
	77	/* Supported cards */
	78	#define CX18_CARD_HVR_1600_ESMT 0 /* Hauppauge HVR 1600 (ESMT memory) */
	79	#define CX18_CARD_HVR_1600_SAMSUNG 1 /* Hauppauge HVR 1600 (Samsung memory) */
	80	#define CX18_CARD_COMPRO_H900 2 /* Compro VideoMate H900 */
	81	#define CX18_CARD_YUAN_MPC718 3 /* Yuan MPC718 */
03c28085	82	#define CX18_CARD_CNXT_RAPTOR_PAL 4 /* Conexant Raptor PAL */
9eee4fb6 AW	83	#define CX18_CARD_TOSHIBA_QOSMIO_DVBT 5 /* Toshiba Qosmio Interal DVB-T/Analog*/
	84	#define CX18_CARD_LEADTEK_PVR2100 6 /* Leadtek WinFast PVR2100 */
	85	#define CX18_CARD_LAST 6
1c1e45d1 HV	86
	87	#define CX18_ENC_STREAM_TYPE_MPG 0
	88	#define CX18_ENC_STREAM_TYPE_TS 1
	89	#define CX18_ENC_STREAM_TYPE_YUV 2
	90	#define CX18_ENC_STREAM_TYPE_VBI 3
	91	#define CX18_ENC_STREAM_TYPE_PCM 4
	92	#define CX18_ENC_STREAM_TYPE_IDX 5
	93	#define CX18_ENC_STREAM_TYPE_RAD 6
	94	#define CX18_MAX_STREAMS 7
	95
	96	/* system vendor and device IDs */
	97	#define PCI_VENDOR_ID_CX 0x14f1
	98	#define PCI_DEVICE_ID_CX23418 0x5b7a
	99
	100	/* subsystem vendor ID */
	101	#define CX18_PCI_ID_HAUPPAUGE 0x0070
	102	#define CX18_PCI_ID_COMPRO 0x185b
	103	#define CX18_PCI_ID_YUAN 0x12ab
03c28085	104	#define CX18_PCI_ID_CONEXANT 0x14f1
9eee4fb6 AW	105	#define CX18_PCI_ID_TOSHIBA 0x1179
9eee4fb6 AW	106	#define CX18_PCI_ID_LEADTEK 0x107D
1c1e45d1 HV	107
	108	/* ======================================================================== */
	109	/* ========================== START USER SETTABLE DMA VARIABLES =========== */
	110	/* ======================================================================== */
	111
	112	/* DMA Buffers, Default size in MB allocated */
	113	#define CX18_DEFAULT_ENC_TS_BUFFERS 1
	114	#define CX18_DEFAULT_ENC_MPG_BUFFERS 2
	115	#define CX18_DEFAULT_ENC_IDX_BUFFERS 1
	116	#define CX18_DEFAULT_ENC_YUV_BUFFERS 2
	117	#define CX18_DEFAULT_ENC_VBI_BUFFERS 1
	118	#define CX18_DEFAULT_ENC_PCM_BUFFERS 1
	119
	120	/* i2c stuff */
	121	#define I2C_CLIENTS_MAX 16
	122
	123	/* debugging */
	124
	125	/* Flag to turn on high volume debugging */
	126	#define CX18_DBGFLG_WARN (1 << 0)
	127	#define CX18_DBGFLG_INFO (1 << 1)
	128	#define CX18_DBGFLG_API (1 << 2)
	129	#define CX18_DBGFLG_DMA (1 << 3)
	130	#define CX18_DBGFLG_IOCTL (1 << 4)
	131	#define CX18_DBGFLG_FILE (1 << 5)
	132	#define CX18_DBGFLG_I2C (1 << 6)
	133	#define CX18_DBGFLG_IRQ (1 << 7)
	134	/* Flag to turn on high volume debugging */
	135	#define CX18_DBGFLG_HIGHVOL (1 << 8)
	136
	137	/* NOTE: extra space before comma in 'cx->num , ## args' is required for
	138	gcc-2.95, otherwise it won't compile. */
	139	#define CX18_DEBUG(x, type, fmt, args...) \
	140	do { \
	141	if ((x) & cx18_debug) \
	142	printk(KERN_INFO "cx18-%d " type ": " fmt, cx->num , ## args); \
	143	} while (0)
	144	#define CX18_DEBUG_WARN(fmt, args...) CX18_DEBUG(CX18_DBGFLG_WARN, "warning", fmt , ## args)
	145	#define CX18_DEBUG_INFO(fmt, args...) CX18_DEBUG(CX18_DBGFLG_INFO, "info", fmt , ## args)
	146	#define CX18_DEBUG_API(fmt, args...) CX18_DEBUG(CX18_DBGFLG_API, "api", fmt , ## args)
	147	#define CX18_DEBUG_DMA(fmt, args...) CX18_DEBUG(CX18_DBGFLG_DMA, "dma", fmt , ## args)
	148	#define CX18_DEBUG_IOCTL(fmt, args...) CX18_DEBUG(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
	149	#define CX18_DEBUG_FILE(fmt, args...) CX18_DEBUG(CX18_DBGFLG_FILE, "file", fmt , ## args)
	150	#define CX18_DEBUG_I2C(fmt, args...) CX18_DEBUG(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
	151	#define CX18_DEBUG_IRQ(fmt, args...) CX18_DEBUG(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
	152
	153	#define CX18_DEBUG_HIGH_VOL(x, type, fmt, args...) \
	154	do { \
	155	if (((x) & cx18_debug) && (cx18_debug & CX18_DBGFLG_HIGHVOL)) \
	156	printk(KERN_INFO "cx18%d " type ": " fmt, cx->num , ## args); \
	157	} while (0)
	158	#define CX18_DEBUG_HI_WARN(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_WARN, "warning", fmt , ## args)
	159	#define CX18_DEBUG_HI_INFO(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_INFO, "info", fmt , ## args)
	160	#define CX18_DEBUG_HI_API(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_API, "api", fmt , ## args)
	161	#define CX18_DEBUG_HI_DMA(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_DMA, "dma", fmt , ## args)
	162	#define CX18_DEBUG_HI_IOCTL(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
	163	#define CX18_DEBUG_HI_FILE(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_FILE, "file", fmt , ## args)
	164	#define CX18_DEBUG_HI_I2C(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
	165	#define CX18_DEBUG_HI_IRQ(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
	166
	167	/* Standard kernel messages */
	168	#define CX18_ERR(fmt, args...) printk(KERN_ERR "cx18-%d: " fmt, cx->num , ## args)
	169	#define CX18_WARN(fmt, args...) printk(KERN_WARNING "cx18-%d: " fmt, cx->num , ## args)
	170	#define CX18_INFO(fmt, args...) printk(KERN_INFO "cx18-%d: " fmt, cx->num , ## args)
171
172	/* Values for CX18_API_DEC_PLAYBACK_SPEED mpeg_frame_type_mask parameter: */
173	#define MPEG_FRAME_TYPE_IFRAME 1
174	#define MPEG_FRAME_TYPE_IFRAME_PFRAME 3
175	#define MPEG_FRAME_TYPE_ALL 7
176
177	#define CX18_MAX_PGM_INDEX (400)
178
d267d851	179	extern int cx18_retry_mmio; /* enable check & retry of mmio accesses */
1c1e45d1 HV	180	extern int cx18_debug;
	181
	182
	183	struct cx18_options {
	184	int megabytes[CX18_MAX_STREAMS]; /* Size in megabytes of each stream */
	185	int cardtype; /* force card type on load */
	186	int tuner; /* set tuner on load */
	187	int radio; /* enable/disable radio */
c641d09c	188	unsigned long mmio_ndelay; /* delay in ns after every PCI mmio access */
1c1e45d1 HV	189	};
	190
	191	/* per-buffer bit flags */
	192	#define CX18_F_B_NEED_BUF_SWAP 0 /* this buffer should be byte swapped */
	193
	194	/* per-stream, s_flags */
	195	#define CX18_F_S_CLAIMED 3 /* this stream is claimed */
	196	#define CX18_F_S_STREAMING 4 /* the fw is decoding/encoding this stream */
	197	#define CX18_F_S_INTERNAL_USE 5 /* this stream is used internally (sliced VBI processing) */
	198	#define CX18_F_S_STREAMOFF 7 /* signal end of stream EOS */
	199	#define CX18_F_S_APPL_IO 8 /* this stream is used read/written by an application */
	200
	201	/* per-cx18, i_flags */
	202	#define CX18_F_I_LOADED_FW 0 /* Loaded the firmware the first time */
	203	#define CX18_F_I_EOS 4 /* End of encoder stream reached */
	204	#define CX18_F_I_RADIO_USER 5 /* The radio tuner is selected */
	205	#define CX18_F_I_ENC_PAUSED 13 /* the encoder is paused */
	206	#define CX18_F_I_INITED 21 /* set after first open */
	207	#define CX18_F_I_FAILED 22 /* set if first open failed */
	208
	209	/* These are the VBI types as they appear in the embedded VBI private packets. */
	210	#define CX18_SLICED_TYPE_TELETEXT_B (1)
	211	#define CX18_SLICED_TYPE_CAPTION_525 (4)
	212	#define CX18_SLICED_TYPE_WSS_625 (5)
	213	#define CX18_SLICED_TYPE_VPS (7)
	214
	215	struct cx18_buffer {
	216	struct list_head list;
	217	dma_addr_t dma_handle;
	218	u32 id;
	219	unsigned long b_flags;
	220	char *buf;
	221
	222	u32 bytesused;
	223	u32 readpos;
	224	};
	225
	226	struct cx18_queue {
	227	struct list_head list;
b04bce47	228	atomic_t buffers;
1c1e45d1 HV	229	u32 bytesused;
	230	};
	231
	232	struct cx18_dvb {
	233	struct dmx_frontend hw_frontend;
	234	struct dmx_frontend mem_frontend;
	235	struct dmxdev dmxdev;
	236	struct dvb_adapter dvb_adapter;
	237	struct dvb_demux demux;
	238	struct dvb_frontend *fe;
	239	struct dvb_net dvbnet;
	240	int enabled;
	241	int feeding;
1c1e45d1	242	struct mutex feedlock;
1c1e45d1 HV	243	};
	244
	245	struct cx18; /* forward reference */
	246	struct cx18_scb; /* forward reference */
	247
d3c5e707 AW	248	#define CX18_INVALID_TASK_HANDLE 0xffffffff
d3c5e707 AW	249
1c1e45d1 HV	250	struct cx18_stream {
	251	/* These first four fields are always set, even if the stream
	252	is not actually created. */
	253	struct video_device v4l2dev; / NULL when stream not created */
	254	struct cx18 cx; / for ease of use */
	255	const char name; / name of the stream */
	256	int type; /* stream type */
	257	u32 handle; /* task handle */
	258	unsigned mdl_offset;
	259
	260	u32 id;
	261	spinlock_t qlock; /* locks access to the queues */
	262	unsigned long s_flags; /* status flags, see above */
	263	int dma; /* can be PCI_DMA_TODEVICE,
	264	PCI_DMA_FROMDEVICE or
	265	PCI_DMA_NONE */
	266	u64 dma_pts;
	267	wait_queue_head_t waitq;
	268
	269	/* Buffer Stats */
	270	u32 buffers;
	271	u32 buf_size;
1c1e45d1 HV	272
	273	/* Buffer Queues */
	274	struct cx18_queue q_free; /* free buffers */
	275	struct cx18_queue q_full; /* full buffers */
	276	struct cx18_queue q_io; /* waiting for I/O */
	277
	278	/* DVB / Digital Transport */
	279	struct cx18_dvb dvb;
	280	};
	281
	282	struct cx18_open_id {
	283	u32 open_id;
	284	int type;
	285	enum v4l2_priority prio;
	286	struct cx18 *cx;
	287	};
	288
	289	/* forward declaration of struct defined in cx18-cards.h */
	290	struct cx18_card;
	291
	292
	293	#define CX18_VBI_FRAMES 32
	294
	295	/* VBI data */
	296	struct vbi_info {
	297	u32 enc_size;
	298	u32 frame;
	299	u8 cc_data_odd[256];
	300	u8 cc_data_even[256];
	301	int cc_pos;
	302	u8 cc_no_update;
	303	u8 vps[5];
	304	u8 vps_found;
	305	int wss;
	306	u8 wss_found;
	307	u8 wss_no_update;
	308	u32 raw_decoder_line_size;
	309	u8 raw_decoder_sav_odd_field;
	310	u8 raw_decoder_sav_even_field;
	311	u32 sliced_decoder_line_size;
	312	u8 sliced_decoder_sav_odd_field;
	313	u8 sliced_decoder_sav_even_field;
	314	struct v4l2_format in;
	315	/* convenience pointer to sliced struct in vbi_in union */
	316	struct v4l2_sliced_vbi_format *sliced_in;
	317	u32 service_set_in;
	318	int insert_mpeg;
	319
	320	/* Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
	321	One for /dev/vbi0 and one for /dev/vbi8 */
	322	struct v4l2_sliced_vbi_data sliced_data[36];
	323
	324	/* Buffer for VBI data inserted into MPEG stream.
	325	The first byte is a dummy byte that's never used.
	326	The next 16 bytes contain the MPEG header for the VBI data,
	327	the remainder is the actual VBI data.
	328	The max size accepted by the MPEG VBI reinsertion turns out
	329	to be 1552 bytes, which happens to be 4 + (1 + 42) * (2 * 18) bytes,
	330	where 4 is a four byte header, 42 is the max sliced VBI payload, 1 is
	331	a single line header byte and 2 * 18 is the number of VBI lines per frame.
	332
	333	However, it seems that the data must be 1K aligned, so we have to
	334	pad the data until the 1 or 2 K boundary.
	335
336	This pointer array will allocate 2049 bytes to store each VBI frame. */
337	u8 *sliced_mpeg_data[CX18_VBI_FRAMES];
338	u32 sliced_mpeg_size[CX18_VBI_FRAMES];
339	struct cx18_buffer sliced_mpeg_buf;
340	u32 inserted_frame;
341
342	u32 start[2], count;
343	u32 raw_size;
344	u32 sliced_size;
345	};
346
347	/* Per cx23418, per I2C bus private algo callback data */
348	struct cx18_i2c_algo_callback_data {
349	struct cx18 *cx;
350	int bus_index; /* 0 or 1 for the cx23418's 1st or 2nd I2C bus */
351	};
352
d267d851 AW	353	#define CX18_MAX_MMIO_RETRIES 10
	354
	355	struct cx18_mmio_stats {
	356	atomic_t retried_write[CX18_MAX_MMIO_RETRIES+1];
	357	atomic_t retried_read[CX18_MAX_MMIO_RETRIES+1];
	358	};
	359
1c1e45d1 HV	360	/* Struct to hold info about cx18 cards */
	361	struct cx18 {
	362	int num; /* board number, -1 during init! */
	363	char name[8]; /* board name for printk and interrupts (e.g. 'cx180') */
	364	struct pci_dev dev; / PCI device */
	365	const struct cx18_card card; / card information */
	366	const char card_name; / full name of the card */
	367	const struct cx18_card_tuner_i2c card_i2c; / i2c addresses to probe for tuner */
	368	u8 is_50hz;
	369	u8 is_60hz;
	370	u8 is_out_50hz;
	371	u8 is_out_60hz;
	372	u8 nof_inputs; /* number of video inputs */
	373	u8 nof_audio_inputs; /* number of audio inputs */
	374	u16 buffer_id; /* buffer ID counter */
	375	u32 v4l2_cap; /* V4L2 capabilities of card */
	376	u32 hw_flags; /* Hardware description of the board */
	377	unsigned mdl_offset;
990c81c8	378	struct cx18_scb __iomem scb; / pointer to SCB */
1c1e45d1 HV	379
	380	struct cx18_av_state av_state;
	381
	382	/* codec settings */
	383	struct cx2341x_mpeg_params params;
	384	u32 filter_mode;
	385	u32 temporal_strength;
	386	u32 spatial_strength;
	387
	388	/* dualwatch */
	389	unsigned long dualwatch_jiffies;
	390	u16 dualwatch_stereo_mode;
	391
	392	/* Digitizer type */
	393	int digitizer; /* 0x00EF = saa7114 0x00FO = saa7115 0x0106 = mic */
	394
	395	struct mutex serialize_lock; /* mutex used to serialize open/close/start/stop/ioctl operations */
	396	struct cx18_options options; /* User options */
	397	int stream_buf_size[CX18_MAX_STREAMS]; /* Stream buffer size */
	398	struct cx18_stream streams[CX18_MAX_STREAMS]; /* Stream data */
	399	unsigned long i_flags; /* global cx18 flags */
31554ae5 HV	400	atomic_t ana_capturing; /* count number of active analog capture streams */
31554ae5 HV	401	atomic_t tot_capturing; /* total count number of active capture streams */
1c1e45d1 HV	402	spinlock_t lock; /* lock access to this struct */
	403	int search_pack_header;
	404
1c1e45d1 HV	405	int open_id; /* incremented each time an open occurs, used as
	406	unique ID. Starts at 1, so 0 can be used as
	407	uninitialized value in the stream->id. */
	408
	409	u32 base_addr;
	410	struct v4l2_prio_state prio;
	411
	412	u8 card_rev;
	413	void __iomem enc_mem, reg_mem;
	414
	415	struct vbi_info vbi;
	416
	417	u32 pgm_info_offset;
	418	u32 pgm_info_num;
	419	u32 pgm_info_write_idx;
	420	u32 pgm_info_read_idx;
	421	struct v4l2_enc_idx_entry pgm_info[CX18_MAX_PGM_INDEX];
	422
	423	u64 mpg_data_received;
	424	u64 vbi_data_inserted;
	425
	426	wait_queue_head_t mb_apu_waitq;
	427	wait_queue_head_t mb_cpu_waitq;
	428	wait_queue_head_t mb_epu_waitq;
	429	wait_queue_head_t mb_hpu_waitq;
	430	wait_queue_head_t cap_w;
	431	/* when the current DMA is finished this queue is woken up */
	432	wait_queue_head_t dma_waitq;
	433
	434	/* i2c */
	435	struct i2c_adapter i2c_adap[2];
	436	struct i2c_algo_bit_data i2c_algo[2];
	437	struct cx18_i2c_algo_callback_data i2c_algo_cb_data[2];
	438	struct i2c_client i2c_client[2];
	439	struct mutex i2c_bus_lock[2];
	440	struct i2c_client *i2c_clients[I2C_CLIENTS_MAX];
	441
ba60bc67 HV	442	/* gpio */
	443	u32 gpio_dir;
	444	u32 gpio_val;
8abdd00d	445	struct mutex gpio_lock;
ba60bc67	446
d267d851 AW	447	/* Statistics */
	448	struct cx18_mmio_stats mmio_stats;
	449
1c1e45d1 HV	450	/* v4l2 and User settings */
	451
	452	/* codec settings */
	453	u32 audio_input;
	454	u32 active_input;
	455	u32 active_output;
	456	v4l2_std_id std;
	457	v4l2_std_id tuner_std; /* The norm of the tuner (fixed) */
	458	};
	459
	460	/* Globals */
	461	extern struct cx18 *cx18_cards[];
	462	extern int cx18_cards_active;
	463	extern int cx18_first_minor;
	464	extern spinlock_t cx18_cards_lock;
	465
	466	/==============Prototypes==================/
	467
	468	/* Return non-zero if a signal is pending */
	469	int cx18_msleep_timeout(unsigned int msecs, int intr);
	470
1c1e45d1 HV	471	/* Read Hauppauge eeprom */
	472	struct tveeprom; /* forward reference */
	473	void cx18_read_eeprom(struct cx18 cx, struct tveeprom tv);
	474
	475	/* First-open initialization: load firmware, etc. */
	476	int cx18_init_on_first_open(struct cx18 *cx);
	477
1c1e45d1	478	#endif /* CX18_DRIVER_H */