hal_gdc_hal.h
Go to the documentation of this file.
1 /**
2 ****************************************************************************************
3 *
4 * @file hal_gdc_hal.h
5 * @author BLE Driver Team
6 * @brief Header file containing functions prototypes of Graphics library.
7 *
8 ****************************************************************************************
9 * @attention
10 #####Copyright (c) 2019 GOODIX
11 All rights reserved.
12
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15 * Redistributions of source code must retain the above copyright
16 notice, this list of conditions and the following disclaimer.
17 * Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
20 * Neither the name of GOODIX nor the names of its contributors may be used
21 to endorse or promote products derived from this software without
22 specific prior written permission.
23
24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 POSSIBILITY OF SUCH DAMAGE.
35 ****************************************************************************************
36 */
37
38 /** @addtogroup GRAPHICS_SDK Graphics
39 * @{
40 */
41
42 /** @addtogroup HAL_DC HAL DC
43 * @{
44 */
45
46 /** @defgroup HAL_GDC_HAL GDC HAL
47 * @brief DC basic function definition.
48 * @{
49 */
50
51 #ifndef HAL_GDC_HAL_H__
52 #define HAL_GDC_HAL_H__
53
54 #include "hal_gfx_sys_defs.h"
55
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59
60 /**
61 * @defgroup HAL_GDC_HAL_FUNCTION Functions
62 * @{
63 */
64 /**
65 *****************************************************************************************
66 * @brief Initialize system. Implementor defined. Called in hal_gdc_init().
67 *
68 * @return 0 if no errors occurred
69 *****************************************************************************************
70 */
71 int32_t hal_gdc_sys_init(void);
72
73 /**
74 *****************************************************************************************
75 * @brief Wait for VSYNC.
76 *****************************************************************************************
77 */
78 void hal_gdc_wait_vsync(void);
79
80 /**
81 *****************************************************************************************
82 * @brief Read Hardware register.
83 *
84 * @param[in] reg: Register to read
85 *
86 * @return Value read from the register
87 *****************************************************************************************
88 */
89 uint32_t hal_gdc_reg_read(uint32_t reg);
90
91 /**
92 *****************************************************************************************
93 * @brief Write Hardware Register
94 *
95 * @param[in] reg: Register to write
96 * @param[in] value: value to write
97 *****************************************************************************************
98 */
99 void hal_gdc_reg_write(uint32_t reg, uint32_t value);
100
101 /** @} */
102
103 #ifdef __cplusplus
104 }
105 #endif
106
107 #endif
108 /** @} */
109 /** @} */
110 /** @} */
111
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.
hal_gdc_wait_vsync
void hal_gdc_wait_vsync(void)
Wait for VSYNC.