[linux-2.6-block.git] / include / media / cx2341x.h

/*
    cx23415/6 header containing common defines.

    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 CX2341X_H
#define CX2341X_H

enum cx2341x_port {
	CX2341X_PORT_MEMORY    = 0,
	CX2341X_PORT_STREAMING = 1,
	CX2341X_PORT_SERIAL    = 2
};

enum cx2341x_cap {
	CX2341X_CAP_HAS_SLICED_VBI = 1 << 0,
};

struct cx2341x_mpeg_params {
	/* misc */
	u32 capabilities;
	enum cx2341x_port port;
	u16 width;
	u16 height;
	u16 is_50hz;

	/* stream */
	enum v4l2_mpeg_stream_type stream_type;
	enum v4l2_mpeg_stream_vbi_fmt stream_vbi_fmt;
	u16 stream_insert_nav_packets;

	/* audio */
	enum v4l2_mpeg_audio_sampling_freq audio_sampling_freq;
	enum v4l2_mpeg_audio_encoding audio_encoding;
	enum v4l2_mpeg_audio_l2_bitrate audio_l2_bitrate;
	enum v4l2_mpeg_audio_mode audio_mode;
	enum v4l2_mpeg_audio_mode_extension audio_mode_extension;
	enum v4l2_mpeg_audio_emphasis audio_emphasis;
	enum v4l2_mpeg_audio_crc audio_crc;
	u16 audio_properties;
	u16 audio_mute;

	/* video */
	enum v4l2_mpeg_video_encoding video_encoding;
	enum v4l2_mpeg_video_aspect video_aspect;
	u16 video_b_frames;
	u16 video_gop_size;
	u16 video_gop_closure;
	enum v4l2_mpeg_video_bitrate_mode video_bitrate_mode;
	u32 video_bitrate;
	u32 video_bitrate_peak;
	u16 video_temporal_decimation;
	u16 video_mute;
	u32 video_mute_yuv;

	/* encoding filters */
	enum v4l2_mpeg_cx2341x_video_spatial_filter_mode video_spatial_filter_mode;
	u16 video_spatial_filter;
	enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type video_luma_spatial_filter_type;
	enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type video_chroma_spatial_filter_type;
	enum v4l2_mpeg_cx2341x_video_temporal_filter_mode video_temporal_filter_mode;
	u16 video_temporal_filter;
	enum v4l2_mpeg_cx2341x_video_median_filter_type video_median_filter_type;
	u16 video_luma_median_filter_top;
	u16 video_luma_median_filter_bottom;
	u16 video_chroma_median_filter_top;
	u16 video_chroma_median_filter_bottom;
};

#define CX2341X_MBOX_MAX_DATA 16

extern const u32 cx2341x_mpeg_ctrls[];
typedef int (*cx2341x_mbox_func)(void *priv, u32 cmd, int in, int out,
		u32 data[CX2341X_MBOX_MAX_DATA]);
int cx2341x_update(void *priv, cx2341x_mbox_func func,
		const struct cx2341x_mpeg_params *old,
		const struct cx2341x_mpeg_params *new);
int cx2341x_ctrl_query(struct cx2341x_mpeg_params *params,
		struct v4l2_queryctrl *qctrl);
const char **cx2341x_ctrl_get_menu(u32 id);
int cx2341x_ext_ctrls(struct cx2341x_mpeg_params *params, int busy,
		struct v4l2_ext_controls *ctrls, unsigned int cmd);
void cx2341x_fill_defaults(struct cx2341x_mpeg_params *p);
void cx2341x_log_status(struct cx2341x_mpeg_params *p, const char *prefix);

/* Firmware names */
#define CX2341X_FIRM_ENC_FILENAME "v4l-cx2341x-enc.fw"
/* Decoder firmware for the cx23415 only */
#define CX2341X_FIRM_DEC_FILENAME "v4l-cx2341x-dec.fw"

/* Firmware API commands */

/* MPEG decoder API, specific to the cx23415 */
#define CX2341X_DEC_PING_FW 			0x00
#define CX2341X_DEC_START_PLAYBACK 		0x01
#define CX2341X_DEC_STOP_PLAYBACK 		0x02
#define CX2341X_DEC_SET_PLAYBACK_SPEED 		0x03
#define CX2341X_DEC_STEP_VIDEO 			0x05
#define CX2341X_DEC_SET_DMA_BLOCK_SIZE 		0x08
#define CX2341X_DEC_GET_XFER_INFO		0x09
#define CX2341X_DEC_GET_DMA_STATUS		0x0a
#define CX2341X_DEC_SCHED_DMA_FROM_HOST		0x0b
#define CX2341X_DEC_PAUSE_PLAYBACK 		0x0d
#define CX2341X_DEC_HALT_FW 			0x0e
#define CX2341X_DEC_SET_STANDARD 		0x10
#define CX2341X_DEC_GET_VERSION			0x11
#define CX2341X_DEC_SET_STREAM_INPUT 		0x14
#define CX2341X_DEC_GET_TIMING_INFO 		0x15
#define CX2341X_DEC_SET_AUDIO_MODE 		0x16
#define CX2341X_DEC_SET_EVENT_NOTIFICATION	0x17
#define CX2341X_DEC_SET_DISPLAY_BUFFERS		0x18
#define CX2341X_DEC_EXTRACT_VBI 		0x19
#define CX2341X_DEC_SET_DECODER_SOURCE 		0x1a
#define CX2341X_DEC_SET_PREBUFFERING		0x1e

/* MPEG encoder API */
#define CX2341X_ENC_PING_FW 			0x80
#define CX2341X_ENC_START_CAPTURE 		0x81
#define CX2341X_ENC_STOP_CAPTURE 		0x82
#define CX2341X_ENC_SET_AUDIO_ID 		0x89
#define CX2341X_ENC_SET_VIDEO_ID 		0x8b
#define CX2341X_ENC_SET_PCR_ID 			0x8d
#define CX2341X_ENC_SET_FRAME_RATE 		0x8f
#define CX2341X_ENC_SET_FRAME_SIZE 		0x91
#define CX2341X_ENC_SET_BIT_RATE 		0x95
#define CX2341X_ENC_SET_GOP_PROPERTIES 		0x97
#define CX2341X_ENC_SET_ASPECT_RATIO 		0x99
#define CX2341X_ENC_SET_DNR_FILTER_MODE 	0x9b
#define CX2341X_ENC_SET_DNR_FILTER_PROPS 	0x9d
#define CX2341X_ENC_SET_CORING_LEVELS 		0x9f
#define CX2341X_ENC_SET_SPATIAL_FILTER_TYPE 	0xa1
#define CX2341X_ENC_SET_VBI_LINE 		0xb7
#define CX2341X_ENC_SET_STREAM_TYPE 		0xb9
#define CX2341X_ENC_SET_OUTPUT_PORT 		0xbb
#define CX2341X_ENC_SET_AUDIO_PROPERTIES 	0xbd
#define CX2341X_ENC_HALT_FW 			0xc3
#define CX2341X_ENC_GET_VERSION			0xc4
#define CX2341X_ENC_SET_GOP_CLOSURE 		0xc5
#define CX2341X_ENC_GET_SEQ_END 		0xc6
#define CX2341X_ENC_SET_PGM_INDEX_INFO 		0xc7
#define CX2341X_ENC_SET_VBI_CONFIG		0xc8
#define CX2341X_ENC_SET_DMA_BLOCK_SIZE 		0xc9
#define CX2341X_ENC_GET_PREV_DMA_INFO_MB_10	0xca
#define CX2341X_ENC_GET_PREV_DMA_INFO_MB_9	0xcb
#define CX2341X_ENC_SCHED_DMA_TO_HOST 		0xcc
#define CX2341X_ENC_INITIALIZE_INPUT 		0xcd
#define CX2341X_ENC_SET_FRAME_DROP_RATE 	0xd0
#define CX2341X_ENC_PAUSE_ENCODER 		0xd2
#define CX2341X_ENC_REFRESH_INPUT 		0xd3
#define CX2341X_ENC_SET_COPYRIGHT		0xd4
#define CX2341X_ENC_SET_EVENT_NOTIFICATION 	0xd5
#define CX2341X_ENC_SET_NUM_VSYNC_LINES 	0xd6
#define CX2341X_ENC_SET_PLACEHOLDER 		0xd7
#define CX2341X_ENC_MUTE_VIDEO 			0xd9
#define CX2341X_ENC_MUTE_AUDIO 			0xda
#define CX2341X_ENC_SET_VERT_CROP_LINE		0xdb
#define CX2341X_ENC_MISC 			0xdc

/* OSD API, specific to the cx23415 */
#define CX2341X_OSD_GET_FRAMEBUFFER 		0x41
#define CX2341X_OSD_GET_PIXEL_FORMAT 		0x42
#define CX2341X_OSD_SET_PIXEL_FORMAT 		0x43
#define CX2341X_OSD_GET_STATE 			0x44
#define CX2341X_OSD_SET_STATE 			0x45
#define CX2341X_OSD_GET_OSD_COORDS 		0x46
#define CX2341X_OSD_SET_OSD_COORDS 		0x47
#define CX2341X_OSD_GET_SCREEN_COORDS 		0x48
#define CX2341X_OSD_SET_SCREEN_COORDS 		0x49
#define CX2341X_OSD_GET_GLOBAL_ALPHA 		0x4a
#define CX2341X_OSD_SET_GLOBAL_ALPHA 		0x4b
#define CX2341X_OSD_SET_BLEND_COORDS 		0x4c
#define CX2341X_OSD_GET_FLICKER_STATE 		0x4f
#define CX2341X_OSD_SET_FLICKER_STATE 		0x50
#define CX2341X_OSD_BLT_COPY 			0x52
#define CX2341X_OSD_BLT_FILL 			0x53
#define CX2341X_OSD_BLT_TEXT 			0x54
#define CX2341X_OSD_SET_FRAMEBUFFER_WINDOW 	0x56
#define CX2341X_OSD_SET_CHROMA_KEY 		0x60
#define CX2341X_OSD_GET_ALPHA_CONTENT_INDEX 	0x61
#define CX2341X_OSD_SET_ALPHA_CONTENT_INDEX 	0x62

#endif /* CX2341X_H */
Commit	Line	Data
ebfbc305 MCC	1	/*
	2	cx23415/6 header containing common defines.
	3
	4	This program is free software; you can redistribute it and/or modify
	5	it under the terms of the GNU General Public License as published by
	6	the Free Software Foundation; either version 2 of the License, or
	7	(at your option) any later version.
	8
	9	This program is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	GNU General Public License for more details.
	13
	14	You should have received a copy of the GNU General Public License
	15	along with this program; if not, write to the Free Software
	16	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	17	*/
	18
	19	#ifndef CX2341X_H
	20	#define CX2341X_H
	21
45ad9f8b	22	enum cx2341x_port {
0ccac4af HV	23	CX2341X_PORT_MEMORY = 0,
	24	CX2341X_PORT_STREAMING = 1,
	25	CX2341X_PORT_SERIAL = 2
45ad9f8b HV	26	};
45ad9f8b HV	27
8cbde94b HV	28	enum cx2341x_cap {
	29	CX2341X_CAP_HAS_SLICED_VBI = 1 << 0,
	30	};
	31
5d1a9ae6 HV	32	struct cx2341x_mpeg_params {
5d1a9ae6 HV	33	/* misc */
8cbde94b	34	u32 capabilities;
45ad9f8b	35	enum cx2341x_port port;
5d1a9ae6 HV	36	u16 width;
	37	u16 height;
	38	u16 is_50hz;
	39
	40	/* stream */
	41	enum v4l2_mpeg_stream_type stream_type;
8cbde94b	42	enum v4l2_mpeg_stream_vbi_fmt stream_vbi_fmt;
5eee72e8	43	u16 stream_insert_nav_packets;
5d1a9ae6 HV	44
	45	/* audio */
	46	enum v4l2_mpeg_audio_sampling_freq audio_sampling_freq;
	47	enum v4l2_mpeg_audio_encoding audio_encoding;
	48	enum v4l2_mpeg_audio_l2_bitrate audio_l2_bitrate;
	49	enum v4l2_mpeg_audio_mode audio_mode;
	50	enum v4l2_mpeg_audio_mode_extension audio_mode_extension;
	51	enum v4l2_mpeg_audio_emphasis audio_emphasis;
	52	enum v4l2_mpeg_audio_crc audio_crc;
cb2c7b49	53	u16 audio_properties;
5eee72e8	54	u16 audio_mute;
5d1a9ae6 HV	55
	56	/* video */
	57	enum v4l2_mpeg_video_encoding video_encoding;
	58	enum v4l2_mpeg_video_aspect video_aspect;
	59	u16 video_b_frames;
	60	u16 video_gop_size;
	61	u16 video_gop_closure;
5d1a9ae6 HV	62	enum v4l2_mpeg_video_bitrate_mode video_bitrate_mode;
	63	u32 video_bitrate;
	64	u32 video_bitrate_peak;
	65	u16 video_temporal_decimation;
5eee72e8 HV	66	u16 video_mute;
5eee72e8 HV	67	u32 video_mute_yuv;
5d1a9ae6 HV	68
	69	/* encoding filters */
	70	enum v4l2_mpeg_cx2341x_video_spatial_filter_mode video_spatial_filter_mode;
	71	u16 video_spatial_filter;
	72	enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type video_luma_spatial_filter_type;
	73	enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type video_chroma_spatial_filter_type;
	74	enum v4l2_mpeg_cx2341x_video_temporal_filter_mode video_temporal_filter_mode;
	75	u16 video_temporal_filter;
	76	enum v4l2_mpeg_cx2341x_video_median_filter_type video_median_filter_type;
	77	u16 video_luma_median_filter_top;
	78	u16 video_luma_median_filter_bottom;
	79	u16 video_chroma_median_filter_top;
	80	u16 video_chroma_median_filter_bottom;
	81	};
	82
	83	#define CX2341X_MBOX_MAX_DATA 16
	84
cc7bc648	85	extern const u32 cx2341x_mpeg_ctrls[];
ea48c13a	86	typedef int (cx2341x_mbox_func)(void priv, u32 cmd, int in, int out,
5d1a9ae6 HV	87	u32 data[CX2341X_MBOX_MAX_DATA]);
	88	int cx2341x_update(void *priv, cx2341x_mbox_func func,
	89	const struct cx2341x_mpeg_params *old,
	90	const struct cx2341x_mpeg_params *new);
	91	int cx2341x_ctrl_query(struct cx2341x_mpeg_params *params,
	92	struct v4l2_queryctrl *qctrl);
	93	const char **cx2341x_ctrl_get_menu(u32 id);
01f1e44f	94	int cx2341x_ext_ctrls(struct cx2341x_mpeg_params *params, int busy,
4d6b5aee	95	struct v4l2_ext_controls *ctrls, unsigned int cmd);
5d1a9ae6	96	void cx2341x_fill_defaults(struct cx2341x_mpeg_params *p);
99eb44fe	97	void cx2341x_log_status(struct cx2341x_mpeg_params p, const char prefix);
5d1a9ae6	98
ebfbc305 MCC	99	/* Firmware names */
	100	#define CX2341X_FIRM_ENC_FILENAME "v4l-cx2341x-enc.fw"
	101	/* Decoder firmware for the cx23415 only */
	102	#define CX2341X_FIRM_DEC_FILENAME "v4l-cx2341x-dec.fw"
	103
	104	/* Firmware API commands */
	105
	106	/* MPEG decoder API, specific to the cx23415 */
	107	#define CX2341X_DEC_PING_FW 0x00
	108	#define CX2341X_DEC_START_PLAYBACK 0x01
	109	#define CX2341X_DEC_STOP_PLAYBACK 0x02
	110	#define CX2341X_DEC_SET_PLAYBACK_SPEED 0x03
	111	#define CX2341X_DEC_STEP_VIDEO 0x05
	112	#define CX2341X_DEC_SET_DMA_BLOCK_SIZE 0x08
	113	#define CX2341X_DEC_GET_XFER_INFO 0x09
	114	#define CX2341X_DEC_GET_DMA_STATUS 0x0a
	115	#define CX2341X_DEC_SCHED_DMA_FROM_HOST 0x0b
	116	#define CX2341X_DEC_PAUSE_PLAYBACK 0x0d
	117	#define CX2341X_DEC_HALT_FW 0x0e
	118	#define CX2341X_DEC_SET_STANDARD 0x10
	119	#define CX2341X_DEC_GET_VERSION 0x11
	120	#define CX2341X_DEC_SET_STREAM_INPUT 0x14
	121	#define CX2341X_DEC_GET_TIMING_INFO 0x15
	122	#define CX2341X_DEC_SET_AUDIO_MODE 0x16
	123	#define CX2341X_DEC_SET_EVENT_NOTIFICATION 0x17
	124	#define CX2341X_DEC_SET_DISPLAY_BUFFERS 0x18
	125	#define CX2341X_DEC_EXTRACT_VBI 0x19
	126	#define CX2341X_DEC_SET_DECODER_SOURCE 0x1a
ebfbc305 MCC	127	#define CX2341X_DEC_SET_PREBUFFERING 0x1e
	128
	129	/* MPEG encoder API */
	130	#define CX2341X_ENC_PING_FW 0x80
	131	#define CX2341X_ENC_START_CAPTURE 0x81
	132	#define CX2341X_ENC_STOP_CAPTURE 0x82
	133	#define CX2341X_ENC_SET_AUDIO_ID 0x89
	134	#define CX2341X_ENC_SET_VIDEO_ID 0x8b
	135	#define CX2341X_ENC_SET_PCR_ID 0x8d
	136	#define CX2341X_ENC_SET_FRAME_RATE 0x8f
	137	#define CX2341X_ENC_SET_FRAME_SIZE 0x91
	138	#define CX2341X_ENC_SET_BIT_RATE 0x95
	139	#define CX2341X_ENC_SET_GOP_PROPERTIES 0x97
	140	#define CX2341X_ENC_SET_ASPECT_RATIO 0x99
	141	#define CX2341X_ENC_SET_DNR_FILTER_MODE 0x9b
	142	#define CX2341X_ENC_SET_DNR_FILTER_PROPS 0x9d
	143	#define CX2341X_ENC_SET_CORING_LEVELS 0x9f
	144	#define CX2341X_ENC_SET_SPATIAL_FILTER_TYPE 0xa1
ebfbc305 MCC	145	#define CX2341X_ENC_SET_VBI_LINE 0xb7
	146	#define CX2341X_ENC_SET_STREAM_TYPE 0xb9
	147	#define CX2341X_ENC_SET_OUTPUT_PORT 0xbb
	148	#define CX2341X_ENC_SET_AUDIO_PROPERTIES 0xbd
	149	#define CX2341X_ENC_HALT_FW 0xc3
	150	#define CX2341X_ENC_GET_VERSION 0xc4
	151	#define CX2341X_ENC_SET_GOP_CLOSURE 0xc5
	152	#define CX2341X_ENC_GET_SEQ_END 0xc6
	153	#define CX2341X_ENC_SET_PGM_INDEX_INFO 0xc7
	154	#define CX2341X_ENC_SET_VBI_CONFIG 0xc8
	155	#define CX2341X_ENC_SET_DMA_BLOCK_SIZE 0xc9
	156	#define CX2341X_ENC_GET_PREV_DMA_INFO_MB_10 0xca
	157	#define CX2341X_ENC_GET_PREV_DMA_INFO_MB_9 0xcb
	158	#define CX2341X_ENC_SCHED_DMA_TO_HOST 0xcc
	159	#define CX2341X_ENC_INITIALIZE_INPUT 0xcd
	160	#define CX2341X_ENC_SET_FRAME_DROP_RATE 0xd0
	161	#define CX2341X_ENC_PAUSE_ENCODER 0xd2
	162	#define CX2341X_ENC_REFRESH_INPUT 0xd3
	163	#define CX2341X_ENC_SET_COPYRIGHT 0xd4
	164	#define CX2341X_ENC_SET_EVENT_NOTIFICATION 0xd5
	165	#define CX2341X_ENC_SET_NUM_VSYNC_LINES 0xd6
	166	#define CX2341X_ENC_SET_PLACEHOLDER 0xd7
	167	#define CX2341X_ENC_MUTE_VIDEO 0xd9
	168	#define CX2341X_ENC_MUTE_AUDIO 0xda
0b20060f	169	#define CX2341X_ENC_SET_VERT_CROP_LINE 0xdb
ebfbc305 MCC	170	#define CX2341X_ENC_MISC 0xdc
	171
	172	/* OSD API, specific to the cx23415 */
	173	#define CX2341X_OSD_GET_FRAMEBUFFER 0x41
	174	#define CX2341X_OSD_GET_PIXEL_FORMAT 0x42
	175	#define CX2341X_OSD_SET_PIXEL_FORMAT 0x43
	176	#define CX2341X_OSD_GET_STATE 0x44
	177	#define CX2341X_OSD_SET_STATE 0x45
	178	#define CX2341X_OSD_GET_OSD_COORDS 0x46
	179	#define CX2341X_OSD_SET_OSD_COORDS 0x47
	180	#define CX2341X_OSD_GET_SCREEN_COORDS 0x48
	181	#define CX2341X_OSD_SET_SCREEN_COORDS 0x49
	182	#define CX2341X_OSD_GET_GLOBAL_ALPHA 0x4a
	183	#define CX2341X_OSD_SET_GLOBAL_ALPHA 0x4b
	184	#define CX2341X_OSD_SET_BLEND_COORDS 0x4c
	185	#define CX2341X_OSD_GET_FLICKER_STATE 0x4f
	186	#define CX2341X_OSD_SET_FLICKER_STATE 0x50
	187	#define CX2341X_OSD_BLT_COPY 0x52
	188	#define CX2341X_OSD_BLT_FILL 0x53
	189	#define CX2341X_OSD_BLT_TEXT 0x54
	190	#define CX2341X_OSD_SET_FRAMEBUFFER_WINDOW 0x56
	191	#define CX2341X_OSD_SET_CHROMA_KEY 0x60
	192	#define CX2341X_OSD_GET_ALPHA_CONTENT_INDEX 0x61
	193	#define CX2341X_OSD_SET_ALPHA_CONTENT_INDEX 0x62
	194
	195	#endif /* CX2341X_H */