2 * Samsung S5P Multi Format Codec v 5.0
4 * This file contains definitions of enums and structs used by the codec
7 * Copyright (C) 2011 Samsung Electronics Co., Ltd.
8 * Kamil Debski, <k.debski@samsung.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the
13 * License, or (at your option) any later version
16 #ifndef S5P_MFC_COMMON_H_
17 #define S5P_MFC_COMMON_H_
19 #include <linux/platform_device.h>
20 #include <linux/videodev2.h>
21 #include <media/v4l2-ctrls.h>
22 #include <media/v4l2-device.h>
23 #include <media/v4l2-ioctl.h>
24 #include <media/videobuf2-v4l2.h>
26 #include "regs-mfc-v8.h"
28 #define S5P_MFC_NAME "s5p-mfc"
30 /* Definitions related to MFC memory */
32 /* Offset base used to differentiate between CAPTURE and OUTPUT
34 #define DST_QUEUE_OFF_BASE (1 << 30)
36 #define MFC_BANK1_ALLOC_CTX 0
37 #define MFC_BANK2_ALLOC_CTX 1
39 #define MFC_BANK1_ALIGN_ORDER 13
40 #define MFC_BANK2_ALIGN_ORDER 13
41 #define MFC_BASE_ALIGN_ORDER 17
43 #define MFC_FW_MAX_VERSIONS 2
45 #include <media/videobuf2-dma-contig.h>
47 static inline dma_addr_t
s5p_mfc_mem_cookie(void *a
, void *b
)
49 /* Same functionality as the vb2_dma_contig_plane_paddr */
50 dma_addr_t
*paddr
= vb2_dma_contig_memops
.cookie(b
);
56 #define MFC_MAX_EXTRA_DPB 5
57 #define MFC_MAX_BUFFERS 32
58 #define MFC_NUM_CONTEXTS 4
59 /* Interrupt timeout */
60 #define MFC_INT_TIMEOUT 2000
61 /* Busy wait timeout */
62 #define MFC_BW_TIMEOUT 500
63 /* Watchdog interval */
64 #define MFC_WATCHDOG_INTERVAL 1000
65 /* After how many executions watchdog should assume lock up */
66 #define MFC_WATCHDOG_CNT 10
67 #define MFC_NO_INSTANCE_SET -1
68 #define MFC_ENC_CAP_PLANE_COUNT 1
69 #define MFC_ENC_OUT_PLANE_COUNT 2
71 #define MFC_MAX_CTRLS 77
73 #define S5P_MFC_CODEC_NONE -1
74 #define S5P_MFC_CODEC_H264_DEC 0
75 #define S5P_MFC_CODEC_H264_MVC_DEC 1
76 #define S5P_MFC_CODEC_VC1_DEC 2
77 #define S5P_MFC_CODEC_MPEG4_DEC 3
78 #define S5P_MFC_CODEC_MPEG2_DEC 4
79 #define S5P_MFC_CODEC_H263_DEC 5
80 #define S5P_MFC_CODEC_VC1RCV_DEC 6
81 #define S5P_MFC_CODEC_VP8_DEC 7
83 #define S5P_MFC_CODEC_H264_ENC 20
84 #define S5P_MFC_CODEC_H264_MVC_ENC 21
85 #define S5P_MFC_CODEC_MPEG4_ENC 22
86 #define S5P_MFC_CODEC_H263_ENC 23
87 #define S5P_MFC_CODEC_VP8_ENC 24
89 #define S5P_MFC_R2H_CMD_EMPTY 0
90 #define S5P_MFC_R2H_CMD_SYS_INIT_RET 1
91 #define S5P_MFC_R2H_CMD_OPEN_INSTANCE_RET 2
92 #define S5P_MFC_R2H_CMD_SEQ_DONE_RET 3
93 #define S5P_MFC_R2H_CMD_INIT_BUFFERS_RET 4
94 #define S5P_MFC_R2H_CMD_CLOSE_INSTANCE_RET 6
95 #define S5P_MFC_R2H_CMD_SLEEP_RET 7
96 #define S5P_MFC_R2H_CMD_WAKEUP_RET 8
97 #define S5P_MFC_R2H_CMD_COMPLETE_SEQ_RET 9
98 #define S5P_MFC_R2H_CMD_DPB_FLUSH_RET 10
99 #define S5P_MFC_R2H_CMD_NAL_ABORT_RET 11
100 #define S5P_MFC_R2H_CMD_FW_STATUS_RET 12
101 #define S5P_MFC_R2H_CMD_FRAME_DONE_RET 13
102 #define S5P_MFC_R2H_CMD_FIELD_DONE_RET 14
103 #define S5P_MFC_R2H_CMD_SLICE_DONE_RET 15
104 #define S5P_MFC_R2H_CMD_ENC_BUFFER_FUL_RET 16
105 #define S5P_MFC_R2H_CMD_ERR_RET 32
107 #define MFC_MAX_CLOCKS 4
109 #define mfc_read(dev, offset) readl(dev->regs_base + (offset))
110 #define mfc_write(dev, data, offset) writel((data), dev->regs_base + \
114 * enum s5p_mfc_fmt_type - type of the pixelformat
116 enum s5p_mfc_fmt_type
{
123 * enum s5p_mfc_inst_type - The type of an MFC instance.
125 enum s5p_mfc_inst_type
{
132 * enum s5p_mfc_inst_state - The state of an MFC instance.
134 enum s5p_mfc_inst_state
{
139 MFCINST_HEAD_PRODUCED
,
148 MFCINST_RES_CHANGE_INIT
,
149 MFCINST_RES_CHANGE_FLUSH
,
150 MFCINST_RES_CHANGE_END
,
154 * enum s5p_mfc_queue_state - The state of buffer queue.
156 enum s5p_mfc_queue_state
{
158 QUEUE_BUFS_REQUESTED
,
164 * enum s5p_mfc_decode_arg - type of frame decoding
166 enum s5p_mfc_decode_arg
{
172 enum s5p_mfc_fw_ver
{
177 #define MFC_BUF_FLAG_USED (1 << 0)
178 #define MFC_BUF_FLAG_EOS (1 << 1)
183 * struct s5p_mfc_buf - MFC buffer
186 struct vb2_v4l2_buffer
*b
;
187 struct list_head list
;
199 * struct s5p_mfc_pm - power management data structure
202 struct clk
*clock_gate
;
203 const char **clk_names
;
204 struct clk
*clocks
[MFC_MAX_CLOCKS
];
206 bool use_clock_gating
;
208 struct device
*device
;
211 struct s5p_mfc_buf_size_v5
{
212 unsigned int h264_ctx
;
213 unsigned int non_h264_ctx
;
218 struct s5p_mfc_buf_size_v6
{
219 unsigned int dev_ctx
;
220 unsigned int h264_dec_ctx
;
221 unsigned int other_dec_ctx
;
222 unsigned int h264_enc_ctx
;
223 unsigned int other_enc_ctx
;
226 struct s5p_mfc_buf_size
{
232 struct s5p_mfc_buf_align
{
236 struct s5p_mfc_variant
{
237 unsigned int version
;
238 unsigned int port_num
;
240 struct s5p_mfc_buf_size
*buf_size
;
241 struct s5p_mfc_buf_align
*buf_align
;
242 char *fw_name
[MFC_FW_MAX_VERSIONS
];
243 const char *clk_names
[MFC_MAX_CLOCKS
];
245 bool use_clock_gating
;
249 * struct s5p_mfc_priv_buf - represents internal used buffer
250 * @ofs: offset of each buffer, will be used for MFC
251 * @virt: kernel virtual address, only valid when the
252 * buffer accessed by driver
253 * @dma: DMA address, only valid when kernel DMA API used
254 * @size: size of the buffer
256 struct s5p_mfc_priv_buf
{
264 * struct s5p_mfc_dev - The struct containing driver internal parameters.
266 * @v4l2_dev: v4l2_device
267 * @vfd_dec: video device for decoding
268 * @vfd_enc: video device for encoding
269 * @plat_dev: platform device
270 * @mem_dev_l: child device of the left memory bank (0)
271 * @mem_dev_r: child device of the right memory bank (1)
272 * @regs_base: base address of the MFC hw registers
274 * @dec_ctrl_handler: control framework handler for decoding
275 * @enc_ctrl_handler: control framework handler for encoding
276 * @pm: power management control
277 * @variant: MFC hardware variant information
278 * @num_inst: couter of active MFC instances
279 * @irqlock: lock for operations on videobuf2 queues
280 * @condlock: lock for changing/checking if a context is ready to be
282 * @mfc_mutex: lock for video_device
283 * @int_cond: variable used by the waitqueue
284 * @int_type: type of last interrupt
285 * @int_err: error number for last interrupt
286 * @queue: waitqueue for waiting for completion of device commands
287 * @fw_size: size of firmware
288 * @fw_virt_addr: virtual firmware address
289 * @bank1: address of the beginning of bank 1 memory
290 * @bank2: address of the beginning of bank 2 memory
291 * @hw_lock: used for hardware locking
292 * @ctx: array of driver contexts
293 * @curr_ctx: number of the currently running context
294 * @ctx_work_bits: used to mark which contexts are waiting for hardware
295 * @watchdog_cnt: counter for the watchdog
296 * @watchdog_workqueue: workqueue for the watchdog
297 * @watchdog_work: worker for the watchdog
298 * @enter_suspend: flag set when entering suspend
299 * @ctx_buf: common context memory (MFCv6)
300 * @warn_start: hardware error code from which warnings start
301 * @mfc_ops: ops structure holding HW operation function pointers
302 * @mfc_cmds: cmd structure holding HW commands function pointers
303 * @mfc_regs: structure holding MFC registers
304 * @fw_ver: loaded firmware sub-version
305 * risc_on: flag indicates RISC is on or off
309 struct v4l2_device v4l2_dev
;
310 struct video_device
*vfd_dec
;
311 struct video_device
*vfd_enc
;
312 struct platform_device
*plat_dev
;
313 struct device
*mem_dev_l
;
314 struct device
*mem_dev_r
;
315 void __iomem
*regs_base
;
317 struct v4l2_ctrl_handler dec_ctrl_handler
;
318 struct v4l2_ctrl_handler enc_ctrl_handler
;
319 struct s5p_mfc_pm pm
;
320 struct s5p_mfc_variant
*variant
;
322 spinlock_t irqlock
; /* lock when operating on context */
323 spinlock_t condlock
; /* lock when changing/checking if a context is
324 ready to be processed */
325 struct mutex mfc_mutex
; /* video_device lock */
328 unsigned int int_err
;
329 wait_queue_head_t queue
;
334 unsigned long hw_lock
;
335 struct s5p_mfc_ctx
*ctx
[MFC_NUM_CONTEXTS
];
337 unsigned long ctx_work_bits
;
338 atomic_t watchdog_cnt
;
339 struct timer_list watchdog_timer
;
340 struct workqueue_struct
*watchdog_workqueue
;
341 struct work_struct watchdog_work
;
342 unsigned long enter_suspend
;
344 struct s5p_mfc_priv_buf ctx_buf
;
346 struct s5p_mfc_hw_ops
*mfc_ops
;
347 struct s5p_mfc_hw_cmds
*mfc_cmds
;
348 const struct s5p_mfc_regs
*mfc_regs
;
349 enum s5p_mfc_fw_ver fw_ver
;
350 bool risc_on
; /* indicates if RISC is on or off */
354 * struct s5p_mfc_h264_enc_params - encoding parameters for h264
356 struct s5p_mfc_h264_enc_params
{
357 enum v4l2_mpeg_video_h264_profile profile
;
358 enum v4l2_mpeg_video_h264_loop_filter_mode loop_filter_mode
;
359 s8 loop_filter_alpha
;
361 enum v4l2_mpeg_video_h264_entropy_mode entropy_mode
;
371 u16 vui_ext_sar_width
;
372 u16 vui_ext_sar_height
;
380 enum v4l2_mpeg_video_h264_level level_v4l2
;
387 u8 hier_qp_layer_qp
[7];
388 u8 sei_frame_packing
;
389 u8 sei_fp_curr_frame_0
;
390 u8 sei_fp_arrangement_type
;
399 u32 aso_slice_order
[8];
403 * struct s5p_mfc_mpeg4_enc_params - encoding parameters for h263 and mpeg4
405 struct s5p_mfc_mpeg4_enc_params
{
407 enum v4l2_mpeg_video_mpeg4_profile profile
;
409 /* Common for MPEG4, H263 */
417 enum v4l2_mpeg_video_mpeg4_level level_v4l2
;
422 * struct s5p_mfc_vp8_enc_params - encoding parameters for vp8
424 struct s5p_mfc_vp8_enc_params
{
426 enum v4l2_vp8_num_partitions num_partitions
;
427 enum v4l2_vp8_num_ref_frames num_ref
;
430 u32 golden_frame_ref_period
;
431 enum v4l2_vp8_golden_frame_sel golden_frame_sel
;
442 * struct s5p_mfc_enc_params - general encoding parameters
444 struct s5p_mfc_enc_params
{
451 enum v4l2_mpeg_video_multi_slice_mode slice_mode
;
454 u16 intra_refresh_mb
;
462 u16 rc_reaction_coeff
;
466 enum v4l2_mpeg_video_header_mode seq_hdr_mode
;
467 enum v4l2_mpeg_mfc51_video_frame_skip_mode frame_skip_mode
;
468 int fixed_target_bit
;
471 u32 rc_framerate_num
;
472 u32 rc_framerate_denom
;
475 struct s5p_mfc_h264_enc_params h264
;
476 struct s5p_mfc_mpeg4_enc_params mpeg4
;
477 struct s5p_mfc_vp8_enc_params vp8
;
483 * struct s5p_mfc_codec_ops - codec ops, used by encoding
485 struct s5p_mfc_codec_ops
{
486 /* initialization routines */
487 int (*pre_seq_start
) (struct s5p_mfc_ctx
*ctx
);
488 int (*post_seq_start
) (struct s5p_mfc_ctx
*ctx
);
489 /* execution routines */
490 int (*pre_frame_start
) (struct s5p_mfc_ctx
*ctx
);
491 int (*post_frame_start
) (struct s5p_mfc_ctx
*ctx
);
494 #define call_cop(c, op, args...) \
495 (((c)->c_ops->op) ? \
496 ((c)->c_ops->op(args)) : 0)
499 * struct s5p_mfc_ctx - This struct contains the instance context
501 * @dev: pointer to the s5p_mfc_dev of the device
502 * @fh: struct v4l2_fh
503 * @num: number of the context that this structure describes
504 * @int_cond: variable used by the waitqueue
505 * @int_type: type of the last interrupt
506 * @int_err: error number received from MFC hw in the interrupt
507 * @queue: waitqueue that can be used to wait for this context to
509 * @src_fmt: source pixelformat information
510 * @dst_fmt: destination pixelformat information
511 * @vq_src: vb2 queue for source buffers
512 * @vq_dst: vb2 queue for destination buffers
513 * @src_queue: driver internal queue for source buffers
514 * @dst_queue: driver internal queue for destination buffers
515 * @src_queue_cnt: number of buffers queued on the source internal queue
516 * @dst_queue_cnt: number of buffers queued on the dest internal queue
517 * @type: type of the instance - decoder or encoder
518 * @state: state of the context
519 * @inst_no: number of hw instance associated with the context
520 * @img_width: width of the image that is decoded or encoded
521 * @img_height: height of the image that is decoded or encoded
522 * @buf_width: width of the buffer for processed image
523 * @buf_height: height of the buffer for processed image
524 * @luma_size: size of a luma plane
525 * @chroma_size: size of a chroma plane
526 * @mv_size: size of a motion vectors buffer
527 * @consumed_stream: number of bytes that have been used so far from the
529 * @dpb_flush_flag: flag used to indicate that a DPB buffers are being
531 * @head_processed: flag mentioning whether the header data is processed
533 * @bank1: handle to memory allocated for temporary buffers from
535 * @bank2: handle to memory allocated for temporary buffers from
537 * @capture_state: state of the capture buffers queue
538 * @output_state: state of the output buffers queue
539 * @src_bufs: information on allocated source buffers
540 * @dst_bufs: information on allocated destination buffers
541 * @sequence: counter for the sequence number for v4l2
542 * @dec_dst_flag: flags for buffers queued in the hardware
543 * @dec_src_buf_size: size of the buffer for source buffers in decoding
544 * @codec_mode: number of codec mode used by MFC hw
545 * @slice_interface: slice interface flag
546 * @loop_filter_mpeg4: loop filter for MPEG4 flag
547 * @display_delay: value of the display delay for H264
548 * @display_delay_enable: display delay for H264 enable flag
549 * @after_packed_pb: flag used to track buffer when stream is in
551 * @sei_fp_parse: enable/disable parsing of frame packing SEI information
552 * @dpb_count: count of the DPB buffers required by MFC hw
553 * @total_dpb_count: count of DPB buffers with additional buffers
554 * requested by the application
555 * @ctx: context buffer information
556 * @dsc: descriptor buffer information
557 * @shm: shared memory buffer information
558 * @mv_count: number of MV buffers allocated for decoding
559 * @enc_params: encoding parameters for MFC
560 * @enc_dst_buf_size: size of the buffers for encoder output
561 * @luma_dpb_size: dpb buffer size for luma
562 * @chroma_dpb_size: dpb buffer size for chroma
563 * @me_buffer_size: size of the motion estimation buffer
564 * @tmv_buffer_size: size of temporal predictor motion vector buffer
565 * @frame_type: used to force the type of the next encoded frame
566 * @ref_queue: list of the reference buffers for encoding
567 * @ref_queue_cnt: number of the buffers in the reference list
568 * @c_ops: ops for encoding
569 * @ctrls: array of controls, used when adding controls to the
570 * v4l2 control framework
571 * @ctrl_handler: handler for v4l2 framework
574 struct s5p_mfc_dev
*dev
;
581 unsigned int int_err
;
582 wait_queue_head_t queue
;
584 struct s5p_mfc_fmt
*src_fmt
;
585 struct s5p_mfc_fmt
*dst_fmt
;
587 struct vb2_queue vq_src
;
588 struct vb2_queue vq_dst
;
590 struct list_head src_queue
;
591 struct list_head dst_queue
;
593 unsigned int src_queue_cnt
;
594 unsigned int dst_queue_cnt
;
596 enum s5p_mfc_inst_type type
;
597 enum s5p_mfc_inst_state state
;
600 /* Image parameters */
610 unsigned long consumed_stream
;
612 unsigned int dpb_flush_flag
;
613 unsigned int head_processed
;
615 struct s5p_mfc_priv_buf bank1
;
616 struct s5p_mfc_priv_buf bank2
;
618 enum s5p_mfc_queue_state capture_state
;
619 enum s5p_mfc_queue_state output_state
;
621 struct s5p_mfc_buf src_bufs
[MFC_MAX_BUFFERS
];
623 struct s5p_mfc_buf dst_bufs
[MFC_MAX_BUFFERS
];
626 unsigned int sequence
;
627 unsigned long dec_dst_flag
;
628 size_t dec_src_buf_size
;
633 int loop_filter_mpeg4
;
635 int display_delay_enable
;
643 struct s5p_mfc_priv_buf ctx
;
644 struct s5p_mfc_priv_buf dsc
;
645 struct s5p_mfc_priv_buf shm
;
647 struct s5p_mfc_enc_params enc_params
;
649 size_t enc_dst_buf_size
;
650 size_t luma_dpb_size
;
651 size_t chroma_dpb_size
;
652 size_t me_buffer_size
;
653 size_t tmv_buffer_size
;
655 enum v4l2_mpeg_mfc51_video_force_frame_type force_frame_type
;
657 struct list_head ref_queue
;
658 unsigned int ref_queue_cnt
;
660 enum v4l2_mpeg_video_multi_slice_mode slice_mode
;
666 const struct s5p_mfc_codec_ops
*c_ops
;
668 struct v4l2_ctrl
*ctrls
[MFC_MAX_CTRLS
];
669 struct v4l2_ctrl_handler ctrl_handler
;
670 unsigned int frame_tag
;
671 size_t scratch_buf_size
;
675 * struct s5p_mfc_fmt - structure used to store information about pixelformats
682 enum s5p_mfc_fmt_type type
;
688 * struct mfc_control - structure used to store information about MFC controls
689 * it is used to initialize the control framework.
693 enum v4l2_ctrl_type type
;
694 __u8 name
[32]; /* Whatever */
695 __s32 minimum
; /* Note signedness */
698 __u32 menu_skip_mask
;
705 /* Macro for making hardware specific calls */
706 #define s5p_mfc_hw_call(f, op, args...) \
707 ((f && f->op) ? f->op(args) : (typeof(f->op(args)))(-ENODEV))
709 #define fh_to_ctx(__fh) container_of(__fh, struct s5p_mfc_ctx, fh)
710 #define ctrl_to_ctx(__ctrl) \
711 container_of((__ctrl)->handler, struct s5p_mfc_ctx, ctrl_handler)
713 void clear_work_bit(struct s5p_mfc_ctx
*ctx
);
714 void set_work_bit(struct s5p_mfc_ctx
*ctx
);
715 void clear_work_bit_irqsave(struct s5p_mfc_ctx
*ctx
);
716 void set_work_bit_irqsave(struct s5p_mfc_ctx
*ctx
);
717 int s5p_mfc_get_new_ctx(struct s5p_mfc_dev
*dev
);
718 void s5p_mfc_cleanup_queue(struct list_head
*lh
, struct vb2_queue
*vq
);
720 #define HAS_PORTNUM(dev) (dev ? (dev->variant ? \
721 (dev->variant->port_num ? 1 : 0) : 0) : 0)
722 #define IS_TWOPORT(dev) (dev->variant->port_num == 2 ? 1 : 0)
723 #define IS_MFCV6_PLUS(dev) (dev->variant->version >= 0x60 ? 1 : 0)
724 #define IS_MFCV7_PLUS(dev) (dev->variant->version >= 0x70 ? 1 : 0)
725 #define IS_MFCV8(dev) (dev->variant->version >= 0x80 ? 1 : 0)
727 #define MFC_V5_BIT BIT(0)
728 #define MFC_V6_BIT BIT(1)
729 #define MFC_V7_BIT BIT(2)
730 #define MFC_V8_BIT BIT(3)
733 #endif /* S5P_MFC_COMMON_H_ */