xref: /linux/drivers/staging/media/rkvdec/rkvdec.h (revision 0be3ff0c)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Rockchip Video Decoder driver
4  *
5  * Copyright (C) 2019 Collabora, Ltd.
6  *
7  * Based on rkvdec driver by Google LLC. (Tomasz Figa <tfiga@chromium.org>)
8  * Based on s5p-mfc driver by Samsung Electronics Co., Ltd.
9  * Copyright (C) 2011 Samsung Electronics Co., Ltd.
10  */
11 #ifndef RKVDEC_H_
12 #define RKVDEC_H_
13 
14 #include <linux/platform_device.h>
15 #include <linux/videodev2.h>
16 #include <linux/wait.h>
17 #include <linux/clk.h>
18 
19 #include <media/v4l2-ctrls.h>
20 #include <media/v4l2-device.h>
21 #include <media/v4l2-ioctl.h>
22 #include <media/videobuf2-core.h>
23 #include <media/videobuf2-dma-contig.h>
24 
25 struct rkvdec_ctx;
26 
27 struct rkvdec_ctrl_desc {
28 	struct v4l2_ctrl_config cfg;
29 };
30 
31 struct rkvdec_ctrls {
32 	const struct rkvdec_ctrl_desc *ctrls;
33 	unsigned int num_ctrls;
34 };
35 
36 struct rkvdec_run {
37 	struct {
38 		struct vb2_v4l2_buffer *src;
39 		struct vb2_v4l2_buffer *dst;
40 	} bufs;
41 };
42 
43 struct rkvdec_vp9_decoded_buffer_info {
44 	/* Info needed when the decoded frame serves as a reference frame. */
45 	unsigned short width;
46 	unsigned short height;
47 	unsigned int bit_depth : 4;
48 };
49 
50 struct rkvdec_decoded_buffer {
51 	/* Must be the first field in this struct. */
52 	struct v4l2_m2m_buffer base;
53 
54 	union {
55 		struct rkvdec_vp9_decoded_buffer_info vp9;
56 	};
57 };
58 
59 static inline struct rkvdec_decoded_buffer *
60 vb2_to_rkvdec_decoded_buf(struct vb2_buffer *buf)
61 {
62 	return container_of(buf, struct rkvdec_decoded_buffer,
63 			    base.vb.vb2_buf);
64 }
65 
66 struct rkvdec_coded_fmt_ops {
67 	int (*adjust_fmt)(struct rkvdec_ctx *ctx,
68 			  struct v4l2_format *f);
69 	int (*start)(struct rkvdec_ctx *ctx);
70 	void (*stop)(struct rkvdec_ctx *ctx);
71 	int (*run)(struct rkvdec_ctx *ctx);
72 	void (*done)(struct rkvdec_ctx *ctx, struct vb2_v4l2_buffer *src_buf,
73 		     struct vb2_v4l2_buffer *dst_buf,
74 		     enum vb2_buffer_state result);
75 };
76 
77 struct rkvdec_coded_fmt_desc {
78 	u32 fourcc;
79 	struct v4l2_frmsize_stepwise frmsize;
80 	const struct rkvdec_ctrls *ctrls;
81 	const struct rkvdec_coded_fmt_ops *ops;
82 	unsigned int num_decoded_fmts;
83 	const u32 *decoded_fmts;
84 };
85 
86 struct rkvdec_dev {
87 	struct v4l2_device v4l2_dev;
88 	struct media_device mdev;
89 	struct video_device vdev;
90 	struct v4l2_m2m_dev *m2m_dev;
91 	struct device *dev;
92 	struct clk_bulk_data *clocks;
93 	void __iomem *regs;
94 	struct mutex vdev_lock; /* serializes ioctls */
95 	struct delayed_work watchdog_work;
96 };
97 
98 struct rkvdec_ctx {
99 	struct v4l2_fh fh;
100 	struct v4l2_format coded_fmt;
101 	struct v4l2_format decoded_fmt;
102 	const struct rkvdec_coded_fmt_desc *coded_fmt_desc;
103 	struct v4l2_ctrl_handler ctrl_hdl;
104 	struct rkvdec_dev *dev;
105 	void *priv;
106 };
107 
108 static inline struct rkvdec_ctx *fh_to_rkvdec_ctx(struct v4l2_fh *fh)
109 {
110 	return container_of(fh, struct rkvdec_ctx, fh);
111 }
112 
113 struct rkvdec_aux_buf {
114 	void *cpu;
115 	dma_addr_t dma;
116 	size_t size;
117 };
118 
119 void rkvdec_run_preamble(struct rkvdec_ctx *ctx, struct rkvdec_run *run);
120 void rkvdec_run_postamble(struct rkvdec_ctx *ctx, struct rkvdec_run *run);
121 
122 extern const struct rkvdec_coded_fmt_ops rkvdec_h264_fmt_ops;
123 extern const struct rkvdec_coded_fmt_ops rkvdec_vp9_fmt_ops;
124 
125 #endif /* RKVDEC_H_ */
126