1 /*
2 * Copyright (c) 2021 HPMicro
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 *
6 */
7
8 #ifndef HPM_CAM_DRV_H
9 #define HPM_CAM_DRV_H
10
11 #include "hpm_common.h"
12 #include "hpm_display_common.h"
13 #include "hpm_cam_regs.h"
14 #include "hpm_soc_feature.h"
15
16 /**
17 * @brief CAM driver APIs
18 * @defgroup cam_interface CAM driver APIs
19 * @ingroup io_interfaces
20 * @{
21 */
22
23 /**
24 * @brief CAM data store mode
25 */
26 #define CAM_DATA_STORE_MODE_NORMAL (0U)
27 #define CAM_DATA_STORE_MODE_Y_UV_PLANES (CAM_CR1_STORAGE_MODE_SET(1))
28 #define CAM_DATA_STORE_MODE_Y_ONLY (CAM_CR1_STORAGE_MODE_SET(2))
29 #define CAM_DATA_STORE_MODE_BINARY (CAM_CR1_STORAGE_MODE_SET(3))
30
31 /**
32 * @brief CAM sensor bitwidth
33 */
34 #define CAM_SENSOR_BITWIDTH_8BITS (CAM_CR1_SENSOR_BIT_WIDTH_SET(0))
35 #define CAM_SENSOR_BITWIDTH_10BITS (CAM_CR1_SENSOR_BIT_WIDTH_SET(1))
36 #define CAM_SENSOR_BITWIDTH_24BITS (CAM_CR1_SENSOR_BIT_WIDTH_SET(3))
37
38 /**
39 * @brief CAM IRQ mask
40 */
41 typedef enum {
42 cam_irq_unsupported_configuration = CAM_INT_EN_ERR_CL_BWID_CFG_INT_EN_MASK,
43 cam_irq_hist_calculation_done = CAM_INT_EN_HIST_DONE_INT_EN_MASK,
44 cam_irq_hresponse_error = CAM_INT_EN_HRESP_ERR_EN_MASK,
45 cam_irq_end_of_frame = CAM_INT_EN_EOF_INT_EN_MASK,
46 cam_irq_rx_fifo_overrun = CAM_INT_EN_RF_OR_INTEN_MASK,
47 cam_irq_fb2_dma_transfer_done = CAM_INT_EN_FB2_DMA_DONE_INTEN_MASK,
48 cam_irq_fb1_dma_transfer_done = CAM_INT_EN_FB1_DMA_DONE_INTEN_MASK,
49 cam_irq_start_of_frame = CAM_INT_EN_SOF_INT_EN_MASK
50 } cam_irq_mask_t;
51
52 /**
53 * @brief CAM status mask
54 */
55 typedef enum {
56 cam_status_unsupported_configuration = CAM_STA_ERR_CL_BWID_CFG_MASK,
57 cam_status_hist_calculation_done = CAM_STA_HIST_DONE_MASK,
58 cam_status_rx_fifo_overrun = CAM_STA_RF_OR_INT_MASK,
59 cam_status_fb2_dma_transfer_done = CAM_STA_DMA_TSF_DONE_FB2_MASK,
60 cam_status_fb1_dma_transfer_done = CAM_STA_DMA_TSF_DONE_FB1_MASK,
61 cam_status_end_of_frame = CAM_STA_EOF_INT_MASK,
62 cam_status_start_of_frame = CAM_STA_SOF_INT_MASK,
63 cam_status_hresponse_error = CAM_STA_HRESP_ERR_INT_MASK
64 } cam_status_mask_t;
65
66 /**
67 * @brief CAM input color format
68 */
69 #define CAM_COLOR_FORMAT_RGB888 (CAM_CR1_COLOR_FORMATS_SET(2))
70 #define CAM_COLOR_FORMAT_RGB565 (CAM_CR1_COLOR_FORMATS_SET(4))
71 #define CAM_COLOR_FORMAT_RGB555 (CAM_CR1_COLOR_FORMATS_SET(6))
72 #define CAM_COLOR_FORMAT_YCBCR422 (CAM_CR1_COLOR_FORMATS_SET(7))
73 #define CAM_COLOR_FORMAT_YUV444 (CAM_CR1_COLOR_FORMATS_SET(8))
74 #define CAM_COLOR_FORMAT_RAW8 (CAM_CR1_COLOR_FORMATS_SET(0xf))
75 #define CAM_COLOR_FORMAT_UNSUPPORTED (1)
76
77 /**
78 * @brief CAM config
79 */
80 typedef struct {
81 uint32_t width;
82 uint32_t height;
83 bool pixclk_sampling_falling;
84 #if defined(HPM_IP_FEATURE_CAM_INV_DEN) && (HPM_IP_FEATURE_CAM_INV_DEN == 1)
85 bool de_active_low; /* de_active_low must is same with hsync_active_low when dvp be used */
86 #endif
87 bool hsync_active_low;
88 bool vsync_active_low;
89 bool color_ext;
90 bool data_pack_msb;
91 uint16_t data_store_mode;
92 uint8_t color_format;
93 uint8_t sensor_bitwidth;
94 uint32_t buffer1;
95 uint32_t buffer2;
96 display_yuv2rgb_config_t csc_config;
97 } cam_config_t;
98
99 /**
100 * @brief cam input pixel byte order
101 */
102 typedef enum {
103 cam_input_pixel_yuv444 = 0, /* Y[23:16] U[15:8] V[7:0] */
104 cam_input_pixel_yvu444 = 1, /* Y[23:16] V[15:8] U[7:0] */
105 cam_input_pixel_uyv444 = 2, /* U[23:16] Y[15:8] V[7:0] */
106 cam_input_pixel_vyu444 = 3, /* V[23:16] Y[15:8] U[7:0] */
107 cam_input_pixel_uvy444 = 4, /* U[23:16] V[15:8] Y[7:0] */
108 cam_input_pixel_vuy444 = 5, /* V[23:16] U[15:8] Y[7:0] */
109 cam_input_pixel_yuyv422 = 0, /* Y0[31:24] U0[23:16] Y1[15:8] V0[7:0] */
110 cam_input_pixel_yvyu422 = 1, /* Y0[31:24] V0[23:16] Y1[15:8] U0[7:0] */
111 cam_input_pixel_uyvy422 = 2, /* U0[31:24] Y0[23:16] V0[15:8] Y1[7:0] */
112 cam_input_pixel_vyuy422 = 3, /* V0[31:24] Y0[23:16] U0[15:8] Y1[7:0] */
113 cam_input_pixel_rgb565 = 0, /* R[15:11] G[10:8] G[7:5] B[4:0] */
114 cam_input_pixel_bgr565 = 1, /* B[15:11] G[10:8] G[7:5] R[4:0] */
115 cam_input_pixel_gbr888 = 0, /* G[23:16] B[15:8] R[7:0] */
116 cam_input_pixel_grb888 = 1, /* G[23:16] R[15:8] B[7:0] */
117 cam_input_pixel_bgr888 = 2, /* B[23:16] G[15:8] R[7:0] */
118 cam_input_pixel_rgb888 = 3, /* R[23:16] G[15:8] B[7:0] */
119 cam_input_pixel_brg888 = 4, /* B[23:16] R[15:8] G[7:0] */
120 cam_input_pixel_rbg888 = 5, /* R[23:16] B[15:8] G[7:0] */
121 } cam_input_pixel_byte_order_t;
122
123 #ifdef __cplusplus
124 extern "C" {
125 #endif
126
127 /**
128 * @brief cam get pixel format value
129 *
130 * @param format display_pixel_format_t
131 * @return uint32_t cam color format, like CAM_COLOR_FORMAT_RGB565
132 */
cam_get_pixel_format(display_pixel_format_t format)133 static inline uint32_t cam_get_pixel_format(display_pixel_format_t format)
134 {
135 switch (format) {
136 case display_pixel_format_rgb565:
137 return CAM_COLOR_FORMAT_RGB565;
138 case display_pixel_format_ycbcr422:
139 return CAM_COLOR_FORMAT_YCBCR422;
140 case display_pixel_format_raw8:
141 return CAM_COLOR_FORMAT_RAW8;
142 default:
143 return CAM_COLOR_FORMAT_UNSUPPORTED;
144 }
145 }
146
147 /**
148 * @brief CAM set high and low limits of color key
149 *
150 * @param [in] ptr CAM base address
151 * @param [in] high color key high limits
152 * @param [in] low color key low limits
153 */
cam_set_color_key(CAM_Type * ptr,uint32_t high,uint32_t low)154 static inline void cam_set_color_key(CAM_Type *ptr, uint32_t high, uint32_t low)
155 {
156 ptr->CLRKEY_LOW = CAM_CLRKEY_LOW_LIMIT_SET(low);
157 ptr->CLRKEY_HIGH = CAM_CLRKEY_HIGH_LIMIT_SET(high);
158 }
159
160 /**
161 * @brief CAM get default config
162 *
163 * @param [in] ptr CAM base address
164 * @param [out] config cam_config_t
165 * @param [in] pixel_format display_pixel_format_t
166 */
167 void cam_get_default_config(CAM_Type *ptr, cam_config_t *config, display_pixel_format_t pixel_format);
168
169 /**
170 * @brief CAM init
171 *
172 * @param [in] ptr CAM base address
173 * @param [in] config cam_config_t
174 *
175 * @retval hpm_stat_t status_invalid_argument or status_success
176 */
177 hpm_stat_t cam_init(CAM_Type *ptr, cam_config_t *config);
178
179 /**
180 * @brief CAM start
181 *
182 * @param [in] ptr CAM base address
183 */
184 void cam_start(CAM_Type *ptr);
185
186 /**
187 * @brief CAM stop
188 *
189 * @note this API will stop CAM immediately no matter there's any frame is being processed or not
190 *
191 * @param [in] ptr CAM base address
192 */
193 void cam_stop(CAM_Type *ptr);
194
195 /**
196 * @brief CAM update DMASA_FB1 buffer
197 *
198 * @param [in] ptr CAM base address
199 * @param [in] buffer buffer point address
200 */
cam_update_buffer(CAM_Type * ptr,uint32_t buffer)201 static inline void cam_update_buffer(CAM_Type *ptr, uint32_t buffer)
202 {
203 ptr->DMASA_FB1 = buffer;
204 }
205
206 /**
207 * @brief CAM update DMASA_FB2 buffer
208 *
209 * @param [in] ptr CAM base address
210 * @param [in] buffer buffer point address
211 */
cam_update_buffer2(CAM_Type * ptr,uint32_t buffer)212 static inline void cam_update_buffer2(CAM_Type *ptr, uint32_t buffer)
213 {
214 ptr->DMASA_FB2 = buffer;
215 }
216
217 /**
218 * @brief CAM enable binary output
219 *
220 * This function is used to enable CAM binary output after
221 * the CAM is initialized by the cam_init.
222 *
223 * @param [in] ptr CAM base address
224 */
cam_enable_binary_output(CAM_Type * ptr)225 static inline void cam_enable_binary_output(CAM_Type *ptr)
226 {
227 ptr->CR20 |= CAM_CR20_BINARY_EN_MASK;
228 }
229
230 /**
231 * @brief CAM disable binary output
232 *
233 * @param [in] ptr CAM base address
234 */
cam_disable_binary_output(CAM_Type * ptr)235 static inline void cam_disable_binary_output(CAM_Type *ptr)
236 {
237 ptr->CR20 &= ~CAM_CR20_BINARY_EN_MASK;
238 }
239
240 /**
241 * @brief CAM set binary threshold
242 *
243 * @param [in] ptr CAM base address
244 * @param [in] threshold threshold value of binary output
245 */
cam_set_binary_threshold(CAM_Type * ptr,uint8_t threshold)246 static inline void cam_set_binary_threshold(CAM_Type *ptr, uint8_t threshold)
247 {
248 ptr->CR20 = (ptr->CR20 & (~CAM_CR20_THRESHOLD_MASK)) | CAM_CR20_THRESHOLD_SET(threshold);
249 }
250
251 /**
252 * @brief CAM enable argb8888 output
253 *
254 * This function is used to enable CAM argb8888 pixel output after the CAM is initialized by
255 * the cam_init and input pixel byte order is configured by the cam_set_input_pixel_byte_order.
256 *
257 * @param [in] ptr CAM base address
258 */
cam_enable_argb8888_output(CAM_Type * ptr)259 static inline void cam_enable_argb8888_output(CAM_Type *ptr)
260 {
261 ptr->CR1 |= CAM_CR1_COLOR_EXT_MASK;
262 }
263
264 /**
265 * @brief CAM disable argb8888 output
266 *
267 * @param [in] ptr CAM base address
268 */
cam_disable_argb8888_output(CAM_Type * ptr)269 static inline void cam_disable_argb8888_output(CAM_Type *ptr)
270 {
271 ptr->CR1 &= ~CAM_CR1_COLOR_EXT_MASK;
272 }
273
274 /**
275 * @brief CAM set input pixel byte order
276 *
277 * @param [in] ptr CAM base address
278 * @param [in] order cam_input_pixel_byte_order_t
279 */
cam_set_input_pixel_byte_order(CAM_Type * ptr,cam_input_pixel_byte_order_t order)280 static inline void cam_set_input_pixel_byte_order(CAM_Type *ptr, cam_input_pixel_byte_order_t order)
281 {
282 ptr->CR2 = (ptr->CR2 & (~CAM_CR2_CLRBITFORMAT_MASK)) | CAM_CR2_CLRBITFORMAT_SET(order);
283 }
284
285 /**
286 * @brief CAM enable irq
287 *
288 * @param [in] ptr CAM base address
289 * @param [in] irq_mask irq mask value
290 */
cam_enable_irq(CAM_Type * ptr,cam_irq_mask_t irq_mask)291 static inline void cam_enable_irq(CAM_Type *ptr, cam_irq_mask_t irq_mask)
292 {
293 ptr->INT_EN |= irq_mask;
294 }
295
296
297 /**
298 * @brief CAM disable irq
299 *
300 * @param [in] ptr CAM base address
301 * @param [in] irq_mask irq mask value
302 */
cam_disable_irq(CAM_Type * ptr,cam_irq_mask_t irq_mask)303 static inline void cam_disable_irq(CAM_Type *ptr, cam_irq_mask_t irq_mask)
304 {
305 ptr->INT_EN &= ~irq_mask;
306 }
307
308 /**
309 * @brief Check CAM status according to the given status mask
310 *
311 * @param [in] ptr CAM base address
312 * @param sta_mask sta_mask refer to cam_status_mask_t
313 * @retval true if any bit in given mask is set
314 * @retval false if none of any bit in given mask is set
315 */
cam_check_status(CAM_Type * ptr,cam_status_mask_t sta_mask)316 static inline bool cam_check_status(CAM_Type *ptr, cam_status_mask_t sta_mask)
317 {
318 return ((ptr->STA & sta_mask) != 0U) ? true : false;
319 }
320
321 /**
322 * @brief Clear CAM status according to the given status mask
323 *
324 * @param [in] ptr CAM base address
325 * @param sta_mask sta_mask refer to cam_status_mask_t
326 */
cam_clear_status(CAM_Type * ptr,cam_status_mask_t sta_mask)327 static inline void cam_clear_status(CAM_Type *ptr, cam_status_mask_t sta_mask)
328 {
329 ptr->STA = sta_mask;
330 }
331
332 /**
333 * @brief CAM safety stop
334 *
335 * @note this API will wait for end-of-frame event before stopping CAM
336 *
337 * @param [in] ptr CAM base address
338 */
339 void cam_stop_safely(CAM_Type *ptr);
340
341 /**
342 * @}
343 *
344 */
345
346 #ifdef __cplusplus
347 }
348 #endif
349
350 #endif /* HPM_CAM_DRV_H */
351
352
353