hal_gdc_hal.h
Go to the documentation of this file.
1 /** @addtogroup GRAPHICS_SDK Graphics
2  * @{
3  */
4 
5 /** @defgroup HAL_GDC_HAL Hal gdc sys
6  * @brief DC basic function definition.
7  * @{
8  */
9 
10 #ifndef HAL_GDC_HAL_H__
11 #define HAL_GDC_HAL_H__
12 
13 #include "hal_gfx_sys_defs.h"
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 /**
20  * @defgroup HAL_GDC_HAL_FUNCTION Functions
21  * @{
22  */
23 /**
24  *****************************************************************************************
25  * @brief Initialize system. Implementor defined. Called in hal_gdc_init().
26  *
27  * @return 0 if no errors occurred
28  *****************************************************************************************
29  */
30 int32_t hal_gdc_sys_init(void);
31 
32 /**
33  *****************************************************************************************
34  * @brief Wait for VSYNC.
35  *****************************************************************************************
36  */
37 void hal_gdc_wait_vsync(void);
38 
39 /**
40  *****************************************************************************************
41  * @brief Read Hardware register.
42  *
43  * @param[in] reg: Register to read
44  *
45  * @return Value read from the register
46  *****************************************************************************************
47  */
48 uint32_t hal_gdc_reg_read(uint32_t reg);
49 
50 /**
51  *****************************************************************************************
52  * @brief Write Hardware Register
53  *
54  * @param[in] reg: Register to write
55  * @param[in] value: value to write
56  *****************************************************************************************
57  */
58 void hal_gdc_reg_write(uint32_t reg, uint32_t value);
59 
60 /** @} */
61 
62 #ifdef __cplusplus
63 }
64 #endif
65 
66 #endif
67 /** @} */
68 /** @} */
69 
70 
hal_gdc_reg_read
uint32_t hal_gdc_reg_read(uint32_t reg)
Read Hardware register.
hal_gfx_sys_defs.h
hal_gdc_reg_write
void hal_gdc_reg_write(uint32_t reg, uint32_t value)
Write Hardware Register.
hal_gdc_sys_init
int32_t hal_gdc_sys_init(void)
Initialize system. Implementor defined. Called in hal_gdc_init().
hal_gdc_wait_vsync
void hal_gdc_wait_vsync(void)
Wait for VSYNC.