1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * camss-vfe.h
4  *
5  * Qualcomm MSM Camera Subsystem - VFE (Video Front End) Module
6  *
7  * Copyright (c) 2013-2015, The Linux Foundation. All rights reserved.
8  * Copyright (C) 2015-2018 Linaro Ltd.
9  */
10 #ifndef QC_MSM_CAMSS_VFE_H
11 #define QC_MSM_CAMSS_VFE_H
12 
13 #include <linux/clk.h>
14 #include <linux/spinlock_types.h>
15 #include <media/media-entity.h>
16 #include <media/v4l2-device.h>
17 #include <media/v4l2-subdev.h>
18 
19 #include "camss-video.h"
20 #include "camss-vfe-gen1.h"
21 
22 #define MSM_VFE_PAD_SINK 0
23 #define MSM_VFE_PAD_SRC 1
24 #define MSM_VFE_PADS_NUM 2
25 
26 #define MSM_VFE_IMAGE_MASTERS_NUM 7
27 #define MSM_VFE_COMPOSITE_IRQ_NUM 4
28 
29 /* VFE halt timeout */
30 #define VFE_HALT_TIMEOUT_MS 100
31 /* Frame drop value. VAL + UPDATES - 1 should not exceed 31 */
32 #define VFE_FRAME_DROP_VAL 30
33 
34 #define vfe_line_array(ptr_line)	\
35 	((const struct vfe_line (*)[]) &(ptr_line)[-(ptr_line)->id])
36 
37 #define to_vfe(ptr_line)	\
38 	container_of(vfe_line_array(ptr_line), struct vfe_device, line)
39 
40 enum vfe_output_state {
41 	VFE_OUTPUT_OFF,
42 	VFE_OUTPUT_RESERVED,
43 	VFE_OUTPUT_SINGLE,
44 	VFE_OUTPUT_CONTINUOUS,
45 	VFE_OUTPUT_IDLE,
46 	VFE_OUTPUT_STOPPING,
47 	VFE_OUTPUT_ON,
48 };
49 
50 enum vfe_line_id {
51 	VFE_LINE_NONE = -1,
52 	VFE_LINE_RDI0 = 0,
53 	VFE_LINE_RDI1 = 1,
54 	VFE_LINE_RDI2 = 2,
55 	VFE_LINE_PIX = 3,
56 	VFE_LINE_NUM_MAX = 4
57 };
58 
59 struct vfe_output {
60 	u8 wm_num;
61 	u8 wm_idx[3];
62 
63 	struct camss_buffer *buf[2];
64 	struct camss_buffer *last_buffer;
65 	struct list_head pending_bufs;
66 
67 	unsigned int drop_update_idx;
68 
69 	union {
70 		struct {
71 			int active_buf;
72 			int wait_sof;
73 		} gen1;
74 		struct {
75 			int active_num;
76 		} gen2;
77 	};
78 	enum vfe_output_state state;
79 	unsigned int sequence;
80 
81 	int wait_reg_update;
82 	struct completion sof;
83 	struct completion reg_update;
84 };
85 
86 struct vfe_line {
87 	enum vfe_line_id id;
88 	struct v4l2_subdev subdev;
89 	struct media_pad pads[MSM_VFE_PADS_NUM];
90 	struct v4l2_mbus_framefmt fmt[MSM_VFE_PADS_NUM];
91 	struct v4l2_rect compose;
92 	struct v4l2_rect crop;
93 	struct camss_video video_out;
94 	struct vfe_output output;
95 	const struct camss_format_info *formats;
96 	unsigned int nformats;
97 };
98 
99 struct vfe_device;
100 
101 struct vfe_hw_ops {
102 	void (*enable_irq)(struct vfe_device *vfe);
103 	void (*global_reset)(struct vfe_device *vfe);
104 	u32 (*hw_version)(struct vfe_device *vfe);
105 	irqreturn_t (*isr)(int irq, void *dev);
106 	void (*isr_read)(struct vfe_device *vfe, u32 *value0, u32 *value1);
107 	void (*pm_domain_off)(struct vfe_device *vfe);
108 	int (*pm_domain_on)(struct vfe_device *vfe);
109 	void (*reg_update)(struct vfe_device *vfe, enum vfe_line_id line_id);
110 	void (*reg_update_clear)(struct vfe_device *vfe,
111 				 enum vfe_line_id line_id);
112 	void (*subdev_init)(struct device *dev, struct vfe_device *vfe);
113 	int (*vfe_disable)(struct vfe_line *line);
114 	int (*vfe_enable)(struct vfe_line *line);
115 	int (*vfe_halt)(struct vfe_device *vfe);
116 	void (*violation_read)(struct vfe_device *vfe);
117 	void (*vfe_wm_start)(struct vfe_device *vfe, u8 wm,
118 			     struct vfe_line *line);
119 	void (*vfe_wm_stop)(struct vfe_device *vfe, u8 wm);
120 	void (*vfe_buf_done)(struct vfe_device *vfe, int port_id);
121 	void (*vfe_wm_update)(struct vfe_device *vfe, u8 wm, u32 addr,
122 			      struct vfe_line *line);
123 };
124 
125 struct vfe_isr_ops {
126 	void (*reset_ack)(struct vfe_device *vfe);
127 	void (*halt_ack)(struct vfe_device *vfe);
128 	void (*reg_update)(struct vfe_device *vfe, enum vfe_line_id line_id);
129 	void (*sof)(struct vfe_device *vfe, enum vfe_line_id line_id);
130 	void (*comp_done)(struct vfe_device *vfe, u8 comp);
131 	void (*wm_done)(struct vfe_device *vfe, u8 wm);
132 };
133 
134 struct vfe_subdev_resources {
135 	bool is_lite;
136 	u8 line_num;
137 	bool has_pd;
138 	char *pd_name;
139 	const struct vfe_hw_ops *hw_ops;
140 	const struct camss_formats *formats_rdi;
141 	const struct camss_formats *formats_pix;
142 };
143 
144 struct vfe_device {
145 	struct camss *camss;
146 	u8 id;
147 	void __iomem *base;
148 	u32 irq;
149 	char irq_name[30];
150 	struct camss_clock *clock;
151 	int nclocks;
152 	struct completion reset_complete;
153 	struct completion halt_complete;
154 	struct mutex power_lock;
155 	int power_count;
156 	struct mutex stream_lock;
157 	int stream_count;
158 	spinlock_t output_lock;
159 	enum vfe_line_id wm_output_map[MSM_VFE_IMAGE_MASTERS_NUM];
160 	struct vfe_line line[VFE_LINE_NUM_MAX];
161 	u32 reg_update;
162 	u8 was_streaming;
163 	const struct vfe_subdev_resources *res;
164 	const struct vfe_hw_ops_gen1 *ops_gen1;
165 	struct vfe_isr_ops isr_ops;
166 	struct camss_video_ops video_ops;
167 	struct device *genpd;
168 	struct device_link *genpd_link;
169 };
170 
171 struct camss_subdev_resources;
172 
173 int msm_vfe_subdev_init(struct camss *camss, struct vfe_device *vfe,
174 			const struct camss_subdev_resources *res, u8 id);
175 
176 void msm_vfe_genpd_cleanup(struct vfe_device *vfe);
177 
178 int msm_vfe_register_entities(struct vfe_device *vfe,
179 			      struct v4l2_device *v4l2_dev);
180 
181 void msm_vfe_unregister_entities(struct vfe_device *vfe);
182 
183 /*
184  * vfe_buf_add_pending - Add output buffer to list of pending
185  * @output: VFE output
186  * @buffer: Video buffer
187  */
188 void vfe_buf_add_pending(struct vfe_output *output, struct camss_buffer *buffer);
189 
190 struct camss_buffer *vfe_buf_get_pending(struct vfe_output *output);
191 
192 int vfe_flush_buffers(struct camss_video *vid, enum vb2_buffer_state state);
193 
194 /*
195  * vfe_isr_comp_done - Process composite image done interrupt
196  * @vfe: VFE Device
197  * @comp: Composite image id
198  */
199 void vfe_isr_comp_done(struct vfe_device *vfe, u8 comp);
200 
201 void vfe_isr_reset_ack(struct vfe_device *vfe);
202 int vfe_put_output(struct vfe_line *line);
203 int vfe_release_wm(struct vfe_device *vfe, u8 wm);
204 int vfe_reserve_wm(struct vfe_device *vfe, enum vfe_line_id line_id);
205 
206 /*
207  * vfe_reset - Trigger reset on VFE module and wait to complete
208  * @vfe: VFE device
209  *
210  * Return 0 on success or a negative error code otherwise
211  */
212 int vfe_reset(struct vfe_device *vfe);
213 
214 /*
215  * vfe_disable - Disable streaming on VFE line
216  * @line: VFE line
217  *
218  * Return 0 on success or a negative error code otherwise
219  */
220 int vfe_disable(struct vfe_line *line);
221 
222 /*
223  * vfe_pm_domain_off - Disable power domains specific to this VFE.
224  * @vfe: VFE Device
225  */
226 void vfe_pm_domain_off(struct vfe_device *vfe);
227 
228 /*
229  * vfe_pm_domain_on - Enable power domains specific to this VFE.
230  * @vfe: VFE Device
231  */
232 int vfe_pm_domain_on(struct vfe_device *vfe);
233 
234 extern const struct camss_formats vfe_formats_rdi_8x16;
235 extern const struct camss_formats vfe_formats_pix_8x16;
236 extern const struct camss_formats vfe_formats_rdi_8x96;
237 extern const struct camss_formats vfe_formats_pix_8x96;
238 extern const struct camss_formats vfe_formats_rdi_845;
239 extern const struct camss_formats vfe_formats_pix_845;
240 
241 extern const struct vfe_hw_ops vfe_ops_4_1;
242 extern const struct vfe_hw_ops vfe_ops_4_7;
243 extern const struct vfe_hw_ops vfe_ops_4_8;
244 extern const struct vfe_hw_ops vfe_ops_170;
245 extern const struct vfe_hw_ops vfe_ops_480;
246 extern const struct vfe_hw_ops vfe_ops_780;
247 
248 int vfe_get(struct vfe_device *vfe);
249 void vfe_put(struct vfe_device *vfe);
250 
251 /*
252  * vfe_is_lite - Return if VFE is VFE lite.
253  * @vfe: VFE Device
254  *
255  * Some VFE lites have a different register layout.
256  *
257  * Return whether VFE is VFE lite
258  */
259 bool vfe_is_lite(struct vfe_device *vfe);
260 
261 /*
262  * vfe_hw_version - Process write master done interrupt
263  * @vfe: VFE Device
264  *
265  * Return vfe hw version
266  */
267 u32 vfe_hw_version(struct vfe_device *vfe);
268 /*
269  * vfe_enable - Enable streaming on VFE line
270  * @line: VFE line
271  *
272  * Return 0 on success or a negative error code otherwise
273  */
274 int vfe_enable_v2(struct vfe_line *line);
275 
276 /*
277  * vfe_buf_done - Process write master done interrupt
278  * @vfe: VFE Device
279  * @wm: Write master id
280  */
281 void vfe_buf_done(struct vfe_device *vfe, int wm);
282 
283 /*
284  * vfe_get_output_v2 - Get vfe output line
285  * line: VFE line
286  *
287  * Return 0 on success or a negative error code otherwise
288  */
289 int vfe_get_output_v2(struct vfe_line *line);
290 
291 /*
292  * vfe_enable_output_v2 - Enable vfe output line
293  * line: VFE line
294  *
295  * Return 0 on success or a negative error code otherwise
296  */
297 int vfe_enable_output_v2(struct vfe_line *line);
298 
299 /*
300  * vfe_queue_buffer_v2 - Add empty buffer
301  * @vid: Video device structure
302  * @buf: Buffer to be enqueued
303  *
304  * Add an empty buffer - depending on the current number of buffers it will be
305  * put in pending buffer queue or directly given to the hardware to be filled.
306  *
307  * Return 0 on success or a negative error code otherwise
308  */
309 int vfe_queue_buffer_v2(struct camss_video *vid,
310 			struct camss_buffer *buf);
311 
312 #endif /* QC_MSM_CAMSS_VFE_H */
313