media/drv-intf/cx2341x.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003     cx23415/6/8 header containing common defines.
0004
0005  */
0006
0007 #ifndef CX2341X_H
0008 #define CX2341X_H
0009
0010 #include <media/v4l2-ctrls.h>
0011
0012 enum cx2341x_port {
0013     CX2341X_PORT_MEMORY    = 0,
0014     CX2341X_PORT_STREAMING = 1,
0015     CX2341X_PORT_SERIAL    = 2
0016 };
0017
0018 enum cx2341x_cap {
0019     CX2341X_CAP_HAS_SLICED_VBI = 1 << 0,
0020     CX2341X_CAP_HAS_TS     = 1 << 1,
0021     CX2341X_CAP_HAS_AC3    = 1 << 2,
0022 };
0023
0024 struct cx2341x_mpeg_params {
0025     /* misc */
0026     u32 capabilities;
0027     enum cx2341x_port port;
0028     u16 width;
0029     u16 height;
0030     u16 is_50hz;
0031
0032     /* stream */
0033     enum v4l2_mpeg_stream_type stream_type;
0034     enum v4l2_mpeg_stream_vbi_fmt stream_vbi_fmt;
0035     u16 stream_insert_nav_packets;
0036
0037     /* audio */
0038     enum v4l2_mpeg_audio_sampling_freq audio_sampling_freq;
0039     enum v4l2_mpeg_audio_encoding audio_encoding;
0040     enum v4l2_mpeg_audio_l2_bitrate audio_l2_bitrate;
0041     enum v4l2_mpeg_audio_ac3_bitrate audio_ac3_bitrate;
0042     enum v4l2_mpeg_audio_mode audio_mode;
0043     enum v4l2_mpeg_audio_mode_extension audio_mode_extension;
0044     enum v4l2_mpeg_audio_emphasis audio_emphasis;
0045     enum v4l2_mpeg_audio_crc audio_crc;
0046     u32 audio_properties;
0047     u16 audio_mute;
0048
0049     /* video */
0050     enum v4l2_mpeg_video_encoding video_encoding;
0051     enum v4l2_mpeg_video_aspect video_aspect;
0052     u16 video_b_frames;
0053     u16 video_gop_size;
0054     u16 video_gop_closure;
0055     enum v4l2_mpeg_video_bitrate_mode video_bitrate_mode;
0056     u32 video_bitrate;
0057     u32 video_bitrate_peak;
0058     u16 video_temporal_decimation;
0059     u16 video_mute;
0060     u32 video_mute_yuv;
0061
0062     /* encoding filters */
0063     enum v4l2_mpeg_cx2341x_video_spatial_filter_mode video_spatial_filter_mode;
0064     u16 video_spatial_filter;
0065     enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type video_luma_spatial_filter_type;
0066     enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type video_chroma_spatial_filter_type;
0067     enum v4l2_mpeg_cx2341x_video_temporal_filter_mode video_temporal_filter_mode;
0068     u16 video_temporal_filter;
0069     enum v4l2_mpeg_cx2341x_video_median_filter_type video_median_filter_type;
0070     u16 video_luma_median_filter_top;
0071     u16 video_luma_median_filter_bottom;
0072     u16 video_chroma_median_filter_top;
0073     u16 video_chroma_median_filter_bottom;
0074 };
0075
0076 #define CX2341X_MBOX_MAX_DATA 16
0077
0078 extern const u32 cx2341x_mpeg_ctrls[];
0079 typedef int (*cx2341x_mbox_func)(void *priv, u32 cmd, int in, int out,
0080         u32 data[CX2341X_MBOX_MAX_DATA]);
0081 int cx2341x_update(void *priv, cx2341x_mbox_func func,
0082         const struct cx2341x_mpeg_params *old,
0083         const struct cx2341x_mpeg_params *new);
0084 int cx2341x_ctrl_query(const struct cx2341x_mpeg_params *params,
0085         struct v4l2_queryctrl *qctrl);
0086 const char * const *cx2341x_ctrl_get_menu(const struct cx2341x_mpeg_params *p, u32 id);
0087 int cx2341x_ext_ctrls(struct cx2341x_mpeg_params *params, int busy,
0088         struct v4l2_ext_controls *ctrls, unsigned int cmd);
0089 void cx2341x_fill_defaults(struct cx2341x_mpeg_params *p);
0090 void cx2341x_log_status(const struct cx2341x_mpeg_params *p, const char *prefix);
0091
0092 struct cx2341x_handler;
0093
0094 struct cx2341x_handler_ops {
0095     /* needed for the video clock freq */
0096     int (*s_audio_sampling_freq)(struct cx2341x_handler *hdl, u32 val);
0097     /* needed for dualwatch */
0098     int (*s_audio_mode)(struct cx2341x_handler *hdl, u32 val);
0099     /* needed for setting up the video resolution */
0100     int (*s_video_encoding)(struct cx2341x_handler *hdl, u32 val);
0101     /* needed for setting up the sliced vbi insertion data structures */
0102     int (*s_stream_vbi_fmt)(struct cx2341x_handler *hdl, u32 val);
0103 };
0104
0105 struct cx2341x_handler {
0106     u32 capabilities;
0107     enum cx2341x_port port;
0108     u16 width;
0109     u16 height;
0110     u16 is_50hz;
0111     u32 audio_properties;
0112
0113     struct v4l2_ctrl_handler hdl;
0114     void *priv;
0115     cx2341x_mbox_func func;
0116     const struct cx2341x_handler_ops *ops;
0117
0118     struct v4l2_ctrl *stream_vbi_fmt;
0119
0120     struct {
0121         /* audio cluster */
0122         struct v4l2_ctrl *audio_sampling_freq;
0123         struct v4l2_ctrl *audio_encoding;
0124         struct v4l2_ctrl *audio_l2_bitrate;
0125         struct v4l2_ctrl *audio_mode;
0126         struct v4l2_ctrl *audio_mode_extension;
0127         struct v4l2_ctrl *audio_emphasis;
0128         struct v4l2_ctrl *audio_crc;
0129         struct v4l2_ctrl *audio_ac3_bitrate;
0130     };
0131
0132     struct {
0133         /* video gop cluster */
0134         struct v4l2_ctrl *video_b_frames;
0135         struct v4l2_ctrl *video_gop_size;
0136     };
0137
0138     struct {
0139         /* stream type cluster */
0140         struct v4l2_ctrl *stream_type;
0141         struct v4l2_ctrl *video_encoding;
0142         struct v4l2_ctrl *video_bitrate_mode;
0143         struct v4l2_ctrl *video_bitrate;
0144         struct v4l2_ctrl *video_bitrate_peak;
0145     };
0146
0147     struct {
0148         /* video mute cluster */
0149         struct v4l2_ctrl *video_mute;
0150         struct v4l2_ctrl *video_mute_yuv;
0151     };
0152
0153     struct {
0154         /* video filter mode cluster */
0155         struct v4l2_ctrl *video_spatial_filter_mode;
0156         struct v4l2_ctrl *video_temporal_filter_mode;
0157         struct v4l2_ctrl *video_median_filter_type;
0158     };
0159
0160     struct {
0161         /* video filter type cluster */
0162         struct v4l2_ctrl *video_luma_spatial_filter_type;
0163         struct v4l2_ctrl *video_chroma_spatial_filter_type;
0164     };
0165
0166     struct  {
0167         /* video filter cluster */
0168         struct v4l2_ctrl *video_spatial_filter;
0169         struct v4l2_ctrl *video_temporal_filter;
0170     };
0171
0172     struct {
0173         /* video median cluster */
0174         struct v4l2_ctrl *video_luma_median_filter_top;
0175         struct v4l2_ctrl *video_luma_median_filter_bottom;
0176         struct v4l2_ctrl *video_chroma_median_filter_top;
0177         struct v4l2_ctrl *video_chroma_median_filter_bottom;
0178     };
0179 };
0180
0181 int cx2341x_handler_init(struct cx2341x_handler *cxhdl,
0182              unsigned nr_of_controls_hint);
0183 void cx2341x_handler_set_50hz(struct cx2341x_handler *cxhdl, int is_50hz);
0184 int cx2341x_handler_setup(struct cx2341x_handler *cxhdl);
0185 void cx2341x_handler_set_busy(struct cx2341x_handler *cxhdl, int busy);
0186
0187 /* Firmware names */
0188 #define CX2341X_FIRM_ENC_FILENAME "v4l-cx2341x-enc.fw"
0189 /* Decoder firmware for the cx23415 only */
0190 #define CX2341X_FIRM_DEC_FILENAME "v4l-cx2341x-dec.fw"
0191
0192 /* Firmware API commands */
0193
0194 /* MPEG decoder API, specific to the cx23415 */
0195 #define CX2341X_DEC_PING_FW         0x00
0196 #define CX2341X_DEC_START_PLAYBACK      0x01
0197 #define CX2341X_DEC_STOP_PLAYBACK       0x02
0198 #define CX2341X_DEC_SET_PLAYBACK_SPEED      0x03
0199 #define CX2341X_DEC_STEP_VIDEO          0x05
0200 #define CX2341X_DEC_SET_DMA_BLOCK_SIZE      0x08
0201 #define CX2341X_DEC_GET_XFER_INFO       0x09
0202 #define CX2341X_DEC_GET_DMA_STATUS      0x0a
0203 #define CX2341X_DEC_SCHED_DMA_FROM_HOST     0x0b
0204 #define CX2341X_DEC_PAUSE_PLAYBACK      0x0d
0205 #define CX2341X_DEC_HALT_FW         0x0e
0206 #define CX2341X_DEC_SET_STANDARD        0x10
0207 #define CX2341X_DEC_GET_VERSION         0x11
0208 #define CX2341X_DEC_SET_STREAM_INPUT        0x14
0209 #define CX2341X_DEC_GET_TIMING_INFO     0x15
0210 #define CX2341X_DEC_SET_AUDIO_MODE      0x16
0211 #define CX2341X_DEC_SET_EVENT_NOTIFICATION  0x17
0212 #define CX2341X_DEC_SET_DISPLAY_BUFFERS     0x18
0213 #define CX2341X_DEC_EXTRACT_VBI         0x19
0214 #define CX2341X_DEC_SET_DECODER_SOURCE      0x1a
0215 #define CX2341X_DEC_SET_PREBUFFERING        0x1e
0216
0217 /* MPEG encoder API */
0218 #define CX2341X_ENC_PING_FW         0x80
0219 #define CX2341X_ENC_START_CAPTURE       0x81
0220 #define CX2341X_ENC_STOP_CAPTURE        0x82
0221 #define CX2341X_ENC_SET_AUDIO_ID        0x89
0222 #define CX2341X_ENC_SET_VIDEO_ID        0x8b
0223 #define CX2341X_ENC_SET_PCR_ID          0x8d
0224 #define CX2341X_ENC_SET_FRAME_RATE      0x8f
0225 #define CX2341X_ENC_SET_FRAME_SIZE      0x91
0226 #define CX2341X_ENC_SET_BIT_RATE        0x95
0227 #define CX2341X_ENC_SET_GOP_PROPERTIES      0x97
0228 #define CX2341X_ENC_SET_ASPECT_RATIO        0x99
0229 #define CX2341X_ENC_SET_DNR_FILTER_MODE     0x9b
0230 #define CX2341X_ENC_SET_DNR_FILTER_PROPS    0x9d
0231 #define CX2341X_ENC_SET_CORING_LEVELS       0x9f
0232 #define CX2341X_ENC_SET_SPATIAL_FILTER_TYPE 0xa1
0233 #define CX2341X_ENC_SET_VBI_LINE        0xb7
0234 #define CX2341X_ENC_SET_STREAM_TYPE     0xb9
0235 #define CX2341X_ENC_SET_OUTPUT_PORT     0xbb
0236 #define CX2341X_ENC_SET_AUDIO_PROPERTIES    0xbd
0237 #define CX2341X_ENC_HALT_FW         0xc3
0238 #define CX2341X_ENC_GET_VERSION         0xc4
0239 #define CX2341X_ENC_SET_GOP_CLOSURE     0xc5
0240 #define CX2341X_ENC_GET_SEQ_END         0xc6
0241 #define CX2341X_ENC_SET_PGM_INDEX_INFO      0xc7
0242 #define CX2341X_ENC_SET_VBI_CONFIG      0xc8
0243 #define CX2341X_ENC_SET_DMA_BLOCK_SIZE      0xc9
0244 #define CX2341X_ENC_GET_PREV_DMA_INFO_MB_10 0xca
0245 #define CX2341X_ENC_GET_PREV_DMA_INFO_MB_9  0xcb
0246 #define CX2341X_ENC_SCHED_DMA_TO_HOST       0xcc
0247 #define CX2341X_ENC_INITIALIZE_INPUT        0xcd
0248 #define CX2341X_ENC_SET_FRAME_DROP_RATE     0xd0
0249 #define CX2341X_ENC_PAUSE_ENCODER       0xd2
0250 #define CX2341X_ENC_REFRESH_INPUT       0xd3
0251 #define CX2341X_ENC_SET_COPYRIGHT       0xd4
0252 #define CX2341X_ENC_SET_EVENT_NOTIFICATION  0xd5
0253 #define CX2341X_ENC_SET_NUM_VSYNC_LINES     0xd6
0254 #define CX2341X_ENC_SET_PLACEHOLDER     0xd7
0255 #define CX2341X_ENC_MUTE_VIDEO          0xd9
0256 #define CX2341X_ENC_MUTE_AUDIO          0xda
0257 #define CX2341X_ENC_SET_VERT_CROP_LINE      0xdb
0258 #define CX2341X_ENC_MISC            0xdc
0259
0260 /* OSD API, specific to the cx23415 */
0261 #define CX2341X_OSD_GET_FRAMEBUFFER     0x41
0262 #define CX2341X_OSD_GET_PIXEL_FORMAT        0x42
0263 #define CX2341X_OSD_SET_PIXEL_FORMAT        0x43
0264 #define CX2341X_OSD_GET_STATE           0x44
0265 #define CX2341X_OSD_SET_STATE           0x45
0266 #define CX2341X_OSD_GET_OSD_COORDS      0x46
0267 #define CX2341X_OSD_SET_OSD_COORDS      0x47
0268 #define CX2341X_OSD_GET_SCREEN_COORDS       0x48
0269 #define CX2341X_OSD_SET_SCREEN_COORDS       0x49
0270 #define CX2341X_OSD_GET_GLOBAL_ALPHA        0x4a
0271 #define CX2341X_OSD_SET_GLOBAL_ALPHA        0x4b
0272 #define CX2341X_OSD_SET_BLEND_COORDS        0x4c
0273 #define CX2341X_OSD_GET_FLICKER_STATE       0x4f
0274 #define CX2341X_OSD_SET_FLICKER_STATE       0x50
0275 #define CX2341X_OSD_BLT_COPY            0x52
0276 #define CX2341X_OSD_BLT_FILL            0x53
0277 #define CX2341X_OSD_BLT_TEXT            0x54
0278 #define CX2341X_OSD_SET_FRAMEBUFFER_WINDOW  0x56
0279 #define CX2341X_OSD_SET_CHROMA_KEY      0x60
0280 #define CX2341X_OSD_GET_ALPHA_CONTENT_INDEX 0x61
0281 #define CX2341X_OSD_SET_ALPHA_CONTENT_INDEX 0x62
0282
0283 #endif /* CX2341X_H */