Add cx23415/6 firmware documentation and header.

- Added cx23415/6 firmware documentation from the ivtv project.
- Added header containing the firmware API commands for use
  by all projects that use the cx2341x. First step towards a
  shared cx2341x driver.

Signed-off-by: Hans Verkuil <hverkuil@xs4all.nl>

1 files changed, 121 insertions, 0 deletions

diff --git a/linux/drivers/media/video/cx2341x.h b/linux/drivers/media/video/cx2341x.h
new file mode 100644
index 000000000..fc2ddb13f
--- /dev/null
+++ b/linux/drivers/media/video/cx2341x.h
@@ -0,0 +1,121 @@
+/*
+    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
+
+/* 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_PLAYBACK_SPEED 		0x03
+#define CX2341X_DEC_STEP_VIDEO 			0x05
+#define CX2341X_DEC_DMA_BLOCKSIZE 		0x08
+#define CX2341X_DEC_XFER_INFO 			0x09
+#define CX2341X_DEC_DMA_STATUS 			0x0a
+#define CX2341X_DEC_DMA_FROM_HOST 		0x0b
+#define CX2341X_DEC_PAUSE_PLAYBACK 		0x0d
+#define CX2341X_DEC_HALT_FW 			0x0e
+#define CX2341X_DEC_DISP_STANDARD 		0x10
+#define CX2341X_DEC_GETVER 			0x11
+#define CX2341X_DEC_STREAM_INPUT 		0x14
+#define CX2341X_DEC_TIMING_INFO 		0x15
+#define CX2341X_DEC_SELECT_AUDIO 		0x16
+#define CX2341X_DEC_EVENT_NOTIFICATION 		0x17
+#define CX2341X_DEC_DISPLAY_BUFFERS 		0x18
+#define CX2341X_DEC_EXTRACT_VBI 		0x19
+#define CX2341X_DEC_DECODE_SOURCE 		0x1a
+#define CX2341X_DEC_AUDIO_OUTPUT 		0x1b
+#define CX2341X_DEC_SET_AV_DELAY 		0x1c
+#define CX2341X_DEC_BUFFER 			0x1e
+
+/* MPEG encoder API */
+#define CX2341X_ENC_PING_FW 			0x80
+#define CX2341X_ENC_BEGIN_CAPTURE 		0x81
+#define CX2341X_ENC_END_CAPTURE 		0x82
+#define CX2341X_ENC_ASSIGN_AUDIO_ID 		0x89
+#define CX2341X_ENC_ASSIGN_VIDEO_ID 		0x8b
+#define CX2341X_ENC_ASSIGN_PCR_ID 		0x8d
+#define CX2341X_ENC_ASSIGN_FRAMERATE 		0x8f
+#define CX2341X_ENC_ASSIGN_FRAME_SIZE 		0x91
+#define CX2341X_ENC_ASSIGN_BITRATES 		0x95
+#define CX2341X_ENC_ASSIGN_GOP_PROPERTIES 	0x97
+#define CX2341X_ENC_ASSIGN_ASPECT_RATIO 	0x99
+#define CX2341X_ENC_ASSIGN_DNR_FILTER_MODE 	0x9b
+#define CX2341X_ENC_ASSIGN_DNR_FILTER_PROPS 	0x9d
+#define CX2341X_ENC_ASSIGN_CORING_LEVELS 	0x9f
+#define CX2341X_ENC_ASSIGN_SPATIAL_FILTER_TYPE 	0xa1
+#define CX2341X_ENC_ASSIGN_3_2_PULLDOWN 	0xb1
+#define CX2341X_ENC_SELECT_VBI_LINE 		0xb7
+#define CX2341X_ENC_ASSIGN_STREAM_TYPE 		0xb9
+#define CX2341X_ENC_ASSIGN_OUTPUT_PORT 		0xbb
+#define CX2341X_ENC_ASSIGN_AUDIO_PROPERTIES 	0xbd
+#define CX2341X_ENC_HALT_FW 			0xc3
+#define CX2341X_ENC_GETVER 			0xc4
+#define CX2341X_ENC_ASSIGN_GOP_CLOSURE 		0xc5
+#define CX2341X_ENC_GET_SEQ_END 		0xc6
+#define CX2341X_ENC_ASSIGN_PGM_INDEX_INFO 	0xc7
+#define CX2341X_ENC_CONFIG_VBI 			0xc8
+#define CX2341X_ENC_ASSIGN_DMA_BLOCKLEN 	0xc9
+#define CX2341X_ENC_PREV_DMA_INFO_MB_10		0xca
+#define CX2341X_ENC_PREV_DMA_INFO_MB_9		0xcb
+#define CX2341X_ENC_SCHED_DMA_TO_HOST 		0xcc
+#define CX2341X_ENC_INITIALIZE_INPUT 		0xcd
+#define CX2341X_ENC_ASSIGN_FRAME_DROP_RATE 	0xd0
+#define CX2341X_ENC_PAUSE_ENCODER 		0xd2
+#define CX2341X_ENC_REFRESH_INPUT 		0xd3
+#define CX2341X_ENC_ASSIGN_COPYRIGHT		0xd4
+#define CX2341X_ENC_EVENT_NOTIFICATION 		0xd5
+#define CX2341X_ENC_ASSIGN_NUM_VSYNC_LINES 	0xd6
+#define CX2341X_ENC_ASSIGN_PLACEHOLDER 		0xd7
+#define CX2341X_ENC_MUTE_VIDEO 			0xd9
+#define CX2341X_ENC_MUTE_AUDIO 			0xda
+#define CX2341X_ENC_UNKNOWN			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 */