[mirror_ubuntu-jammy-kernel.git] / drivers / media / pci / cx18 / cx18-cards.h

/*
 *  cx18 functions to query card hardware
 *
 *  Derived from ivtv-cards.c
 *
 *  Copyright (C) 2007  Hans Verkuil <hverkuil@xs4all.nl>
 *  Copyright (C) 2008  Andy Walls <awalls@md.metrocast.net>
 *
 *  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.
 */

/* hardware flags */
#define CX18_HW_TUNER			(1 << 0)
#define CX18_HW_TVEEPROM		(1 << 1)
#define CX18_HW_CS5345			(1 << 2)
#define CX18_HW_DVB			(1 << 3)
#define CX18_HW_418_AV			(1 << 4)
#define CX18_HW_GPIO_MUX		(1 << 5)
#define CX18_HW_GPIO_RESET_CTRL		(1 << 6)
#define CX18_HW_Z8F0811_IR_HAUP		(1 << 7)

/* video inputs */
#define	CX18_CARD_INPUT_VID_TUNER	1
#define	CX18_CARD_INPUT_SVIDEO1		2
#define	CX18_CARD_INPUT_SVIDEO2		3
#define	CX18_CARD_INPUT_COMPOSITE1	4
#define	CX18_CARD_INPUT_COMPOSITE2	5
#define	CX18_CARD_INPUT_COMPONENT1	6

/* audio inputs */
#define	CX18_CARD_INPUT_AUD_TUNER	1
#define	CX18_CARD_INPUT_LINE_IN1	2
#define	CX18_CARD_INPUT_LINE_IN2	3

#define CX18_CARD_MAX_VIDEO_INPUTS 6
#define CX18_CARD_MAX_AUDIO_INPUTS 3
#define CX18_CARD_MAX_TUNERS	   2

/* V4L2 capability aliases */
#define CX18_CAP_ENCODER (V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TUNER | \
			  V4L2_CAP_AUDIO | V4L2_CAP_READWRITE | \
			  V4L2_CAP_STREAMING | V4L2_CAP_VBI_CAPTURE | \
			  V4L2_CAP_SLICED_VBI_CAPTURE)

struct cx18_card_video_input {
	u8  video_type;		/* video input type */
	u8  audio_index;	/* index in cx18_card_audio_input array */
	u32 video_input;	/* hardware video input */
};

struct cx18_card_audio_input {
	u8  audio_type;		/* audio input type */
	u32 audio_input;	/* hardware audio input */
	u16 muxer_input;	/* hardware muxer input for boards with a
				   multiplexer chip */
};

struct cx18_card_pci_info {
	u16 device;
	u16 subsystem_vendor;
	u16 subsystem_device;
};

/* GPIO definitions */

/* The mask is the set of bits used by the operation */

struct cx18_gpio_init { /* set initial GPIO DIR and OUT values */
	u32 direction;	/* DIR setting. Leave to 0 if no init is needed */
	u32 initial_value;
};

struct cx18_gpio_i2c_slave_reset {
	u32 active_lo_mask; /* GPIO outputs that reset i2c chips when low */
	u32 active_hi_mask; /* GPIO outputs that reset i2c chips when high */
	int msecs_asserted; /* time period reset must remain asserted */
	int msecs_recovery; /* time after deassert for chips to be ready */
	u32 ir_reset_mask;  /* GPIO to reset the Zilog Z8F0811 IR contoller */
};

struct cx18_gpio_audio_input {	/* select tuner/line in input */
	u32 mask;		/* leave to 0 if not supported */
	u32 tuner;
	u32 linein;
	u32 radio;
};

struct cx18_card_tuner {
	v4l2_std_id std;	/* standard for which the tuner is suitable */
	int	    tuner;	/* tuner ID (from tuner.h) */
};

struct cx18_card_tuner_i2c {
	unsigned short radio[2];/* radio tuner i2c address to probe */
	unsigned short demod[3];/* demodulator i2c address to probe */
	unsigned short tv[4];	/* tv tuner i2c addresses to probe */
};

struct cx18_ddr {		/* DDR config data */
	u32 chip_config;
	u32 refresh;
	u32 timing1;
	u32 timing2;
	u32 tune_lane;
	u32 initial_emrs;
};

/* for card information/parameters */
struct cx18_card {
	int type;
	char *name;
	char *comment;
	u32 v4l2_capabilities;
	u32 hw_audio_ctrl;	/* hardware used for the V4L2 controls (only
				   1 dev allowed currently) */
	u32 hw_muxer;		/* hardware used to multiplex audio input */
	u32 hw_all;		/* all hardware used by the board */
	struct cx18_card_video_input video_inputs[CX18_CARD_MAX_VIDEO_INPUTS];
	struct cx18_card_audio_input audio_inputs[CX18_CARD_MAX_AUDIO_INPUTS];
	struct cx18_card_audio_input radio_input;

	/* GPIO card-specific settings */
	u8 xceive_pin;		/* XCeive tuner GPIO reset pin */
	struct cx18_gpio_init		 gpio_init;
	struct cx18_gpio_i2c_slave_reset gpio_i2c_slave_reset;
	struct cx18_gpio_audio_input    gpio_audio_input;

	struct cx18_card_tuner tuners[CX18_CARD_MAX_TUNERS];
	struct cx18_card_tuner_i2c *i2c;

	struct cx18_ddr ddr;

	/* list of device and subsystem vendor/devices that
	   correspond to this card type. */
	const struct cx18_card_pci_info *pci_list;
};

int cx18_get_input(struct cx18 *cx, u16 index, struct v4l2_input *input);
int cx18_get_audio_input(struct cx18 *cx, u16 index, struct v4l2_audio *input);
const struct cx18_card *cx18_get_card(u16 index);
Commit	Line	Data
1c1e45d1 HV	1	/*
	2	* cx18 functions to query card hardware
	3	*
	4	* Derived from ivtv-cards.c
	5	*
	6	* Copyright (C) 2007 Hans Verkuil <hverkuil@xs4all.nl>
6afdeaf8	7	* Copyright (C) 2008 Andy Walls <awalls@md.metrocast.net>
1c1e45d1 HV	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
1c1e45d1 HV	18	*/
	19
	20	/* hardware flags */
8ca95568 AW	21	#define CX18_HW_TUNER (1 << 0)
	22	#define CX18_HW_TVEEPROM (1 << 1)
	23	#define CX18_HW_CS5345 (1 << 2)
	24	#define CX18_HW_DVB (1 << 3)
	25	#define CX18_HW_418_AV (1 << 4)
	26	#define CX18_HW_GPIO_MUX (1 << 5)
	27	#define CX18_HW_GPIO_RESET_CTRL (1 << 6)
ab5222ed	28	#define CX18_HW_Z8F0811_IR_HAUP (1 << 7)
83526190	29
1c1e45d1 HV	30	/* video inputs */
1c1e45d1 HV	31	#define CX18_CARD_INPUT_VID_TUNER 1
6e6a8b5a MCC	32	#define CX18_CARD_INPUT_SVIDEO1 2
	33	#define CX18_CARD_INPUT_SVIDEO2 3
	34	#define CX18_CARD_INPUT_COMPOSITE1 4
	35	#define CX18_CARD_INPUT_COMPOSITE2 5
	36	#define CX18_CARD_INPUT_COMPONENT1 6
1c1e45d1	37
1c1e45d1 HV	38	/* audio inputs */
1c1e45d1 HV	39	#define CX18_CARD_INPUT_AUD_TUNER 1
6e6a8b5a MCC	40	#define CX18_CARD_INPUT_LINE_IN1 2
6e6a8b5a MCC	41	#define CX18_CARD_INPUT_LINE_IN2 3
1c1e45d1 HV	42
	43	#define CX18_CARD_MAX_VIDEO_INPUTS 6
	44	#define CX18_CARD_MAX_AUDIO_INPUTS 3
6e6a8b5a	45	#define CX18_CARD_MAX_TUNERS 2
1c1e45d1	46
1c1e45d1 HV	47	/* V4L2 capability aliases */
1c1e45d1 HV	48	#define CX18_CAP_ENCODER (V4L2_CAP_VIDEO_CAPTURE \| V4L2_CAP_TUNER \| \
af009cf6	49	V4L2_CAP_AUDIO \| V4L2_CAP_READWRITE \| \
dfdf780b HV	50	V4L2_CAP_STREAMING \| V4L2_CAP_VBI_CAPTURE \| \
dfdf780b HV	51	V4L2_CAP_SLICED_VBI_CAPTURE)
1c1e45d1 HV	52
1c1e45d1 HV	53	struct cx18_card_video_input {
6e6a8b5a	54	u8 video_type; /* video input type */
1c1e45d1	55	u8 audio_index; /* index in cx18_card_audio_input array */
d9a325a8	56	u32 video_input; /* hardware video input */
1c1e45d1 HV	57	};
	58
	59	struct cx18_card_audio_input {
	60	u8 audio_type; /* audio input type */
	61	u32 audio_input; /* hardware audio input */
	62	u16 muxer_input; /* hardware muxer input for boards with a
	63	multiplexer chip */
	64	};
	65
	66	struct cx18_card_pci_info {
	67	u16 device;
	68	u16 subsystem_vendor;
	69	u16 subsystem_device;
	70	};
	71
	72	/* GPIO definitions */
	73
	74	/* The mask is the set of bits used by the operation */
	75
	76	struct cx18_gpio_init { /* set initial GPIO DIR and OUT values */
6e6a8b5a	77	u32 direction; /* DIR setting. Leave to 0 if no init is needed */
9dcbf35a	78	u32 initial_value;
1c1e45d1 HV	79	};
1c1e45d1 HV	80
1f09e8a2 AW	81	struct cx18_gpio_i2c_slave_reset {
	82	u32 active_lo_mask; /* GPIO outputs that reset i2c chips when low */
	83	u32 active_hi_mask; /* GPIO outputs that reset i2c chips when high */
	84	int msecs_asserted; /* time period reset must remain asserted */
	85	int msecs_recovery; /* time after deassert for chips to be ready */
02fa272f	86	u32 ir_reset_mask; /* GPIO to reset the Zilog Z8F0811 IR contoller */
1f09e8a2 AW	87	};
1f09e8a2 AW	88
6e6a8b5a MCC	89	struct cx18_gpio_audio_input { /* select tuner/line in input */
6e6a8b5a MCC	90	u32 mask; /* leave to 0 if not supported */
03c28085 SD	91	u32 tuner;
	92	u32 linein;
	93	u32 radio;
	94	};
	95
1c1e45d1	96	struct cx18_card_tuner {
6e6a8b5a MCC	97	v4l2_std_id std; /* standard for which the tuner is suitable */
6e6a8b5a MCC	98	int tuner; /* tuner ID (from tuner.h) */
1c1e45d1 HV	99	};
	100
	101	struct cx18_card_tuner_i2c {
	102	unsigned short radio[2];/* radio tuner i2c address to probe */
2bfe2fa4	103	unsigned short demod[3];/* demodulator i2c address to probe */
1c1e45d1 HV	104	unsigned short tv[4]; /* tv tuner i2c addresses to probe */
	105	};
	106
	107	struct cx18_ddr { /* DDR config data */
	108	u32 chip_config;
	109	u32 refresh;
	110	u32 timing1;
	111	u32 timing2;
	112	u32 tune_lane;
	113	u32 initial_emrs;
	114	};
	115
	116	/* for card information/parameters */
	117	struct cx18_card {
	118	int type;
	119	char *name;
	120	char *comment;
	121	u32 v4l2_capabilities;
	122	u32 hw_audio_ctrl; /* hardware used for the V4L2 controls (only
ff2a2001	123	1 dev allowed currently) */
1c1e45d1 HV	124	u32 hw_muxer; /* hardware used to multiplex audio input */
	125	u32 hw_all; /* all hardware used by the board */
	126	struct cx18_card_video_input video_inputs[CX18_CARD_MAX_VIDEO_INPUTS];
	127	struct cx18_card_audio_input audio_inputs[CX18_CARD_MAX_AUDIO_INPUTS];
	128	struct cx18_card_audio_input radio_input;
	129
	130	/* GPIO card-specific settings */
6e6a8b5a MCC	131	u8 xceive_pin; /* XCeive tuner GPIO reset pin */
6e6a8b5a MCC	132	struct cx18_gpio_init gpio_init;
1f09e8a2	133	struct cx18_gpio_i2c_slave_reset gpio_i2c_slave_reset;
fdea5d69	134	struct cx18_gpio_audio_input gpio_audio_input;
1c1e45d1 HV	135
	136	struct cx18_card_tuner tuners[CX18_CARD_MAX_TUNERS];
	137	struct cx18_card_tuner_i2c *i2c;
	138
	139	struct cx18_ddr ddr;
	140
	141	/* list of device and subsystem vendor/devices that
	142	correspond to this card type. */
	143	const struct cx18_card_pci_info *pci_list;
	144	};
	145
	146	int cx18_get_input(struct cx18 cx, u16 index, struct v4l2_input input);
	147	int cx18_get_audio_input(struct cx18 cx, u16 index, struct v4l2_audio input);
	148	const struct cx18_card *cx18_get_card(u16 index);