xref: /linux/drivers/media/platform/renesas/rzg2l-cru/rzg2l-cru.h (revision 55a42f78ffd386e01a5404419f8c5ded7db70a21)
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Driver for Renesas RZ/G2L CRU
4  *
5  * Copyright (C) 2022 Renesas Electronics Corp.
6  */
7 
8 #ifndef __RZG2L_CRU__
9 #define __RZG2L_CRU__
10 
11 #include <linux/irqreturn.h>
12 #include <linux/reset.h>
13 
14 #include <media/v4l2-async.h>
15 #include <media/v4l2-dev.h>
16 #include <media/v4l2-device.h>
17 #include <media/videobuf2-v4l2.h>
18 
19 /* Number of HW buffers */
20 #define RZG2L_CRU_HW_BUFFER_MAX		8
21 #define RZG2L_CRU_HW_BUFFER_DEFAULT	3
22 
23 /* Address alignment mask for HW buffers */
24 #define RZG2L_CRU_HW_BUFFER_MASK	0x1ff
25 
26 /* Maximum number of CSI2 virtual channels */
27 #define RZG2L_CRU_CSI2_VCHANNEL		4
28 
29 #define RZG2L_CRU_MIN_INPUT_WIDTH	320
30 #define RZG2L_CRU_MIN_INPUT_HEIGHT	240
31 
32 enum rzg2l_csi2_pads {
33 	RZG2L_CRU_IP_SINK = 0,
34 	RZG2L_CRU_IP_SOURCE,
35 };
36 
37 struct rzg2l_cru_dev;
38 
39 /**
40  * enum rzg2l_cru_dma_state - DMA states
41  * @RZG2L_CRU_DMA_STOPPED:   No operation in progress
42  * @RZG2L_CRU_DMA_STARTING:  Capture starting up
43  * @RZG2L_CRU_DMA_RUNNING:   Operation in progress have buffers
44  * @RZG2L_CRU_DMA_STOPPING:  Stopping operation
45  */
46 enum rzg2l_cru_dma_state {
47 	RZG2L_CRU_DMA_STOPPED = 0,
48 	RZG2L_CRU_DMA_STARTING,
49 	RZG2L_CRU_DMA_RUNNING,
50 	RZG2L_CRU_DMA_STOPPING,
51 };
52 
53 struct rzg2l_cru_csi {
54 	struct v4l2_async_connection *asd;
55 	struct v4l2_subdev *subdev;
56 };
57 
58 struct rzg2l_cru_ip {
59 	struct v4l2_subdev subdev;
60 	struct media_pad pads[2];
61 	struct v4l2_async_notifier notifier;
62 	struct v4l2_subdev *remote;
63 };
64 
65 /**
66  * struct rzg2l_cru_ip_format - CRU IP format
67  * @codes: Array of up to four media bus codes
68  * @datatype: MIPI CSI2 data type
69  * @format: 4CC format identifier (V4L2_PIX_FMT_*)
70  * @icndmr: ICnDMR register value
71  * @yuv: Flag to indicate whether the format is YUV-based.
72  */
73 struct rzg2l_cru_ip_format {
74 	/*
75 	 * RAW output formats might be produced by RAW media codes with any one
76 	 * of the 4 common bayer patterns.
77 	 */
78 	u32 codes[4];
79 	u32 datatype;
80 	u32 format;
81 	u32 icndmr;
82 	bool yuv;
83 };
84 
85 struct rzg2l_cru_info {
86 	unsigned int max_width;
87 	unsigned int max_height;
88 	u16 image_conv;
89 	const u16 *regs;
90 	bool has_stride;
91 	irqreturn_t (*irq_handler)(int irq, void *data);
92 	void (*enable_interrupts)(struct rzg2l_cru_dev *cru);
93 	void (*disable_interrupts)(struct rzg2l_cru_dev *cru);
94 	bool (*fifo_empty)(struct rzg2l_cru_dev *cru);
95 };
96 
97 /**
98  * struct rzg2l_cru_dev - Renesas CRU device structure
99  * @dev:		(OF) device
100  * @base:		device I/O register space remapped to virtual memory
101  * @info:		info about CRU instance
102  *
103  * @presetn:		CRU_PRESETN reset line
104  * @aresetn:		CRU_ARESETN reset line
105  *
106  * @vclk:		CRU Main clock
107  *
108  * @vdev:		V4L2 video device associated with CRU
109  * @v4l2_dev:		V4L2 device
110  * @num_buf:		Holds the current number of buffers enabled
111  * @svc_channel:	SVC0/1/2/3 to use for RZ/G3E
112  * @buf_addr:		Memory addresses where current video data is written.
113  * @notifier:		V4L2 asynchronous subdevs notifier
114  *
115  * @ip:			Image processing subdev info
116  * @csi:		CSI info
117  * @mdev:		media device
118  * @mdev_lock:		protects the count, notifier and csi members
119  * @pad:		media pad for the video device entity
120  *
121  * @lock:		protects @queue
122  * @queue:		vb2 buffers queue
123  * @scratch:		cpu address for scratch buffer
124  * @scratch_phys:	physical address of the scratch buffer
125  *
126  * @qlock:		protects @queue_buf, @buf_list, @sequence
127  *			@state
128  * @queue_buf:		Keeps track of buffers given to HW slot
129  * @buf_list:		list of queued buffers
130  * @sequence:		V4L2 buffers sequence number
131  * @state:		keeps track of operation state
132  *
133  * @format:		active V4L2 pixel format
134  */
135 struct rzg2l_cru_dev {
136 	struct device *dev;
137 	void __iomem *base;
138 	const struct rzg2l_cru_info *info;
139 
140 	struct reset_control *presetn;
141 	struct reset_control *aresetn;
142 
143 	struct clk *vclk;
144 
145 	struct video_device vdev;
146 	struct v4l2_device v4l2_dev;
147 	u8 num_buf;
148 
149 	u8 svc_channel;
150 	dma_addr_t buf_addr[RZG2L_CRU_HW_BUFFER_DEFAULT];
151 
152 	struct v4l2_async_notifier notifier;
153 
154 	struct rzg2l_cru_ip ip;
155 	struct rzg2l_cru_csi csi;
156 	struct media_device mdev;
157 	struct mutex mdev_lock;
158 	struct media_pad pad;
159 
160 	struct mutex lock;
161 	struct vb2_queue queue;
162 	void *scratch;
163 	dma_addr_t scratch_phys;
164 
165 	spinlock_t qlock;
166 	struct vb2_v4l2_buffer *queue_buf[RZG2L_CRU_HW_BUFFER_MAX];
167 	struct list_head buf_list;
168 	unsigned int sequence;
169 	enum rzg2l_cru_dma_state state;
170 
171 	struct v4l2_pix_format format;
172 };
173 
174 int rzg2l_cru_start_image_processing(struct rzg2l_cru_dev *cru);
175 void rzg2l_cru_stop_image_processing(struct rzg2l_cru_dev *cru);
176 
177 int rzg2l_cru_dma_register(struct rzg2l_cru_dev *cru);
178 void rzg2l_cru_dma_unregister(struct rzg2l_cru_dev *cru);
179 
180 int rzg2l_cru_video_register(struct rzg2l_cru_dev *cru);
181 void rzg2l_cru_video_unregister(struct rzg2l_cru_dev *cru);
182 irqreturn_t rzg2l_cru_irq(int irq, void *data);
183 irqreturn_t rzg3e_cru_irq(int irq, void *data);
184 
185 const struct v4l2_format_info *rzg2l_cru_format_from_pixel(u32 format);
186 
187 int rzg2l_cru_ip_subdev_register(struct rzg2l_cru_dev *cru);
188 void rzg2l_cru_ip_subdev_unregister(struct rzg2l_cru_dev *cru);
189 struct v4l2_mbus_framefmt *rzg2l_cru_ip_get_src_fmt(struct rzg2l_cru_dev *cru);
190 
191 const struct rzg2l_cru_ip_format *rzg2l_cru_ip_code_to_fmt(unsigned int code);
192 const struct rzg2l_cru_ip_format *rzg2l_cru_ip_format_to_fmt(u32 format);
193 const struct rzg2l_cru_ip_format *rzg2l_cru_ip_index_to_fmt(u32 index);
194 bool rzg2l_cru_ip_fmt_supports_mbus_code(const struct rzg2l_cru_ip_format *fmt,
195 					 unsigned int code);
196 
197 void rzg2l_cru_enable_interrupts(struct rzg2l_cru_dev *cru);
198 void rzg2l_cru_disable_interrupts(struct rzg2l_cru_dev *cru);
199 void rzg3e_cru_enable_interrupts(struct rzg2l_cru_dev *cru);
200 void rzg3e_cru_disable_interrupts(struct rzg2l_cru_dev *cru);
201 
202 bool rzg2l_fifo_empty(struct rzg2l_cru_dev *cru);
203 bool rzg3e_fifo_empty(struct rzg2l_cru_dev *cru);
204 
205 #endif
206