app_uart.h
Go to the documentation of this file.
1 /**
2 ****************************************************************************************
3 *
4 * @file app_uart.h
5 * @author BLE Driver Team
6 * @brief Header file containing functions prototypes of UART app 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 PERIPHERAL Peripheral Driver
39 * @{
40 */
41
42 /** @addtogroup APP_DRIVER APP DRIVER
43 * @{
44 */
45
46 /** @defgroup APP_UART UART
47 * @brief UART APP module driver.
48 * @{
49 */
50
51
52 #ifndef _APP_UART_H_
53 #define _APP_UART_H_
54
55 #include "grx_hal.h"
56 #include "ring_buffer.h"
57 #include "app_io.h"
58 #include "app_dma.h"
59 #include "app_drv_config.h"
60
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
64
65 #ifdef HAL_UART_MODULE_ENABLED
66
67 /** @addtogroup APP_UART_MACRO Defines
68 * @{
69 */
70
71 #define TX_ONCE_MAX_SIZE 128 /**< UART max bytes size transmitted at one time */
72
73 /** @} */
74
75 /** @addtogroup APP_UART_ENUMERATIONS Enumerations
76 * @{
77 */
78
79 /**
80 * @brief UART module Enumerations definition
81 */
82 typedef enum
83 {
84 APP_UART_ID_0, /**< UART module 0 */
85 APP_UART_ID_1, /**< UART module 1 */
86 #if ((APP_DRIVER_CHIP_TYPE == APP_DRIVER_GR5525X) || (APP_DRIVER_CHIP_TYPE == APP_DRIVER_GR5526X))
87 APP_UART_ID_2, /**< UART module 2 */
88 APP_UART_ID_3, /**< UART module 3 */
89 #endif
90 #if (APP_DRIVER_CHIP_TYPE == APP_DRIVER_GR5526X)
91 APP_UART_ID_4, /**< UART module 4 */
92 APP_UART_ID_5, /**< UART module 5 */
93 #endif
94 APP_UART_ID_MAX, /**< Only for check parameter, not used as input parameters. */
95 } app_uart_id_t;
96
97 /**
98 * @brief UART event Enumerations definition
99 */
100 typedef enum
101 {
102 APP_UART_EVT_ERROR, /**< Error reported by UART peripheral. */
103 APP_UART_EVT_TX_CPLT, /**< Requested TX transfer completed. */
104 APP_UART_EVT_RX_DATA, /**< Requested RX transfer completed. */
105 APP_UART_EVT_ABORT_TX, /**< Requested TX abort completed. */
106 APP_UART_EVT_ABORT_RX, /**< Requested RX abort completed. */
107 APP_UART_EVT_ABORT_TXRX, /**< Requested TX, RX abort completed. */
108 } app_uart_evt_type_t;
109
110 /**@brief App uart state types. */
111 typedef enum
112 {
113 APP_UART_INVALID = 0,
114 APP_UART_ACTIVITY,
115 #ifdef APP_DRIVER_WAKEUP_CALL_FUN
116 APP_UART_SLEEP,
117 #endif
118 } app_uart_state_t;
119
120 /** @} */
121
122 /** @addtogroup APP_UART_STRUCTURES Structures
123 * @{
124 */
125
126 /**
127 * @brief UART pins Structures
128 */
129 typedef struct
130 {
131 app_io_type_t type; /**< Specifies the type of UART IO. */
132 app_io_mux_t mux; /**< Specifies the Peripheral to be connected to the selected pins. */
133 uint32_t pin; /**< Specifies the IO pins to be configured.
134 This parameter can be any value of @ref GR5xxx_pins. */
135 app_io_pull_t pull; /**< Specifies the Pull-up or Pull-Down activation for the selected pins. */
136
137 } app_uart_pin_t;
138
139 /**
140 * @brief UART pins config Structures
141 */
142 typedef struct
143 {
144 app_uart_pin_t tx; /**< Set the configuration of UART TX pin. */
145 app_uart_pin_t rx; /**< Set the configuration of UART RX pin. */
146 app_uart_pin_t cts; /**< Set the configuration of UART CTS pin. */
147 app_uart_pin_t rts; /**< Set the configuration of UART RTS pin. */
148 } app_uart_pin_cfg_t;
149
150 /**
151 * @brief UART DMA configuration structure definition
152 */
153 typedef struct
154 {
155 dma_regs_t *tx_dma_instance;/**< Specifies the TX DMA inistall.*/
156 dma_regs_t *rx_dma_instance;/**< Specifies the RX DMA inistall.*/
157 dma_channel_t tx_dma_channel; /**< Specifies the dma channel of UART TX. */
158 dma_channel_t rx_dma_channel; /**< Specifies the dma channel of UART RX. */
159 } app_uart_dma_cfg_t;
160
161
162 /**@brief App uart dma state types. */
163 typedef enum
164 {
165 APP_UART_DMA_INVALID = 0,
166 APP_UART_DMA_ACTIVITY,
167 } app_uart_dma_state_t;
168
169 /**
170 * @brief UART event structure definition
171 */
172 typedef struct
173 {
174 app_uart_evt_type_t type; /**< Type of event. */
175 union
176 {
177 uint32_t error_code; /**< UART Error code . */
178 uint16_t size; /**< UART transmitted/received counter. */
179 } data; /**< Data of event. */
180 } app_uart_evt_t;
181
182 /** @} */
183
184 /** @addtogroup APP_UART_TYPEDEFS Type definitions
185 * @{
186 */
187
188 /**
189 * @brief UART event callback definition
190 */
191 typedef void (*app_uart_evt_handler_t)(app_uart_evt_t *p_evt);
192
193 /** @} */
194
195 /** @addtogroup APP_UART_STRUCTURES Structures
196 * @{
197 */
198
199
200 /**
201 * @brief UART device structure definition
202 */
203 typedef struct
204 {
205 app_uart_evt_handler_t evt_handler; /**< UART event callback. */
206 uart_handle_t handle; /**< UART handle Structure. */
207 app_uart_pin_cfg_t *p_pin_cfg; /**< UART pins config Structures. */
208 dma_id_t dma_id[2]; /**< DMA id. */
209 app_uart_state_t uart_state; /**< App uart state types. */
210 app_uart_dma_state_t uart_dma_state; /**< App uart dma state types. */
211 ring_buffer_t tx_ring_buffer; /**< RING_BUFFER_STRUCT Structures. */
212 uint8_t tx_send_buf[TX_ONCE_MAX_SIZE]; /**< tx send buf. */
213 volatile bool start_tx_flag; /**< start tx flag. */
214 volatile bool start_flush_flag; /**< start flush flag. */
215 bool tx_abort_flag; /**< tx abort flag. */
216 bool rx_abort_flag; /**< rx abort flag. */
217 bool is_dma_tx_mode; /**< dma tx mode. */
218 } uart_env_t;
219
220 /**
221 * @brief UART parameters structure definition
222 */
223 typedef struct
224 {
225 app_uart_id_t id; /**< specified UART module ID. */
226 app_uart_pin_cfg_t pin_cfg; /**< the pin configuration information for the specified UART module. */
227 app_uart_dma_cfg_t dma_cfg; /**< UART DMA configuration. */
228 uart_init_t init; /**< UART communication parameters. */
229 uart_env_t uart_dev; /**< UART event data. */
230 } app_uart_params_t;
231
232 /**
233 * @brief UART buffer structure definition
234 */
235 typedef struct
236 {
237 uint8_t * tx_buf; /**< Pointer to the TX buffer. */
238 uint32_t tx_buf_size; /**< Size of the TX buffer. */
239 } app_uart_tx_buf_t;
240 /** @} */
241
242 /* Exported functions --------------------------------------------------------*/
243 /** @addtogroup APP_UART_DRIVER_FUNCTIONS Functions
244 * @{
245 */
246 /**
247 ****************************************************************************************
248 * @brief Initialize the APP UART DRIVER according to the specified parameters
249 * in the app_uart_params_t and app_uart_evt_handler_t.
250 *
251 * @param[in] p_params: Pointer to app_uart_params_t parameter which contains the
252 * configuration information for the specified UART module.
253 * @param[in] evt_handler: UART user callback function.
254 * @param[in] tx_buffer: Pointer to tx send buffer.
255 *
256 * @return Result of initialization.
257 ****************************************************************************************
258 */
259 uint16_t app_uart_init(app_uart_params_t *p_params, app_uart_evt_handler_t evt_handler, app_uart_tx_buf_t *tx_buffer);
260
261 /**
262 ****************************************************************************************
263 * @brief De-initialize the APP UART DRIVER peripheral.
264 *
265 * @param[in] id: De-initialize for a specific ID.
266 *
267 * @return Result of De-initialization.
268 ****************************************************************************************
269 */
270 uint16_t app_uart_deinit(app_uart_id_t id);
271
272 /**
273 ****************************************************************************************
274 * @brief Send an amount of data in interrupt mode.
275 *
276 * @param[in] id: which UART module want to receive.
277 * @param[in] p_data: Pointer to data buffer
278 * @param[in] size: Amount of data to be sent
279 *
280 * @return Result of operation.
281 ****************************************************************************************
282 */
283 uint16_t app_uart_transmit_async(app_uart_id_t id, uint8_t *p_data, uint16_t size);
284
285 /**
286 ****************************************************************************************
287 * @brief Send an amount of data in blocking mode.
288 *
289 * @param[in] id: which UART module want to receive.
290 * @param[in] p_data: Pointer to data buffer
291 * @param[in] size: Amount of data to be sent
292 * @param[in] timeout: Timeout duration
293 *
294 * @return Result of operation.
295 ****************************************************************************************
296 */
297 uint16_t app_uart_transmit_sync(app_uart_id_t id, uint8_t *p_data, uint16_t size, uint32_t timeout);
298
299 /**
300 ****************************************************************************************
301 * @brief Receive an amount of data in interrupt mode.
302 *
303 * @param[in] id: which UART module want to transmit.
304 * @param[in] p_data: Pointer to data buffer
305 * @param[in] size: Amount of data to be sent
306 *
307 * @return Result of operation.
308 ****************************************************************************************
309 */
310 uint16_t app_uart_receive_async(app_uart_id_t id, uint8_t *p_data, uint16_t size);
311
312 /**
313 ****************************************************************************************
314 * @brief Receive an amount of data in blocking mode.
315 *
316 * @param[in] id: which UART module want to transmit.
317 * @param[in] p_data: Pointer to data buffer
318 * @param[in] size: Amount of data to be sent
319 * @param[in] timeout: Timeout duration
320 *
321 * @return Result of operation.
322 ****************************************************************************************
323 */
324 uint16_t app_uart_receive_sync(app_uart_id_t id, uint8_t *p_data, uint16_t size, uint32_t timeout);
325
326 /**
327 ****************************************************************************************
328 * @brief Return the UART handle.
329 *
330 * @param[in] id: UART Channel ID.
331 *
332 * @return Pointer to the specified ID's UART handle.
333 ****************************************************************************************
334 */
335 uart_handle_t *app_uart_get_handle(app_uart_id_t id);
336
337 /**
338 *****************************************************************************************
339 * @brief Flush all log entries from the buffer
340 *
341 * @param[in] id: UART Channel ID.
342 *
343 *****************************************************************************************
344 */
345 void app_uart_flush(app_uart_id_t id);
346
347 /**
348 ****************************************************************************************
349 * @brief Abort transmit and receive process and generate abort callback.
350 *
351 * @param[in] id: which UART module want to use.
352 *
353 * @return Result of operation.
354 ****************************************************************************************
355 */
356 uint16_t app_uart_abort(app_uart_id_t id);
357
358 /**
359 ****************************************************************************************
360 * @brief Abort transmit process and generate abort transmit callback.
361 *
362 * @param[in] id: which UART module want to use.
363 *
364 * @return Result of operation.
365 ****************************************************************************************
366 */
367 uint16_t app_uart_abort_transmit(app_uart_id_t id);
368
369 /**
370 ****************************************************************************************
371 * @brief Abort receive process and generate abort receive callback.
372 *
373 * @param[in] id: which UART module want to use.
374 *
375 * @return Result of operation.
376 ****************************************************************************************
377 */
378 uint16_t app_uart_abort_receive(app_uart_id_t id);
379
380 /** @} */
381
382 #endif
383
384 #ifdef __cplusplus
385 }
386 #endif
387
388 #endif
389
390 /** @} */
391
392 /** @} */
393
394 /** @} */
395
app_uart_pin_cfg_t::rx
app_uart_pin_t rx
Set the configuration of UART RX pin.
Definition: app_uart.h:145
uart_env_t::uart_dma_state
app_uart_dma_state_t uart_dma_state
App uart dma state types.
Definition: app_uart.h:210
app_uart_params_t::pin_cfg
app_uart_pin_cfg_t pin_cfg
the pin configuration information for the specified UART module.
Definition: app_uart.h:226
app_uart_pin_t::pull
app_io_pull_t pull
Specifies the Pull-up or Pull-Down activation for the selected pins.
Definition: app_uart.h:135
uart_env_t::evt_handler
app_uart_evt_handler_t evt_handler
UART event callback.
Definition: app_uart.h:205
app_uart_params_t::init
uart_init_t init
UART communication parameters.
Definition: app_uart.h:228
APP_UART_EVT_ABORT_RX
@ APP_UART_EVT_ABORT_RX
Requested RX abort completed.
Definition: app_uart.h:106
app_uart_evt_type_t
app_uart_evt_type_t
UART event Enumerations definition.
Definition: app_uart.h:101
app_uart_transmit_sync
uint16_t app_uart_transmit_sync(app_uart_id_t id, uint8_t *p_data, uint16_t size, uint32_t timeout)
Send an amount of data in blocking mode.
uart_env_t::is_dma_tx_mode
bool is_dma_tx_mode
dma tx mode.
Definition: app_uart.h:217
APP_UART_DMA_INVALID
@ APP_UART_DMA_INVALID
Definition: app_uart.h:165
app_uart_params_t::id
app_uart_id_t id
specified UART module ID.
Definition: app_uart.h:225
uart_env_t::tx_ring_buffer
ring_buffer_t tx_ring_buffer
RING_BUFFER_STRUCT Structures.
Definition: app_uart.h:211
app_uart_pin_cfg_t::cts
app_uart_pin_t cts
Set the configuration of UART CTS pin.
Definition: app_uart.h:146
app_uart_dma_cfg_t::tx_dma_channel
dma_channel_t tx_dma_channel
Specifies the dma channel of UART TX.
Definition: app_uart.h:157
uart_env_t::uart_state
app_uart_state_t uart_state
App uart state types.
Definition: app_uart.h:209
app_uart_deinit
uint16_t app_uart_deinit(app_uart_id_t id)
De-initialize the APP UART DRIVER peripheral.
app_uart_abort
uint16_t app_uart_abort(app_uart_id_t id)
Abort transmit and receive process and generate abort callback.
app_uart_init
uint16_t app_uart_init(app_uart_params_t *p_params, app_uart_evt_handler_t evt_handler, app_uart_tx_buf_t *tx_buffer)
Initialize the APP UART DRIVER according to the specified parameters in the app_uart_params_t and app...
app_io_pull_t
app_io_pull_t
GPIO pull Enumerations definition.
Definition: app_io.h:181
app_uart_state_t
app_uart_state_t
App uart state types.
Definition: app_uart.h:112
app_io_type_t
app_io_type_t
GPIO type Enumerations definition.
Definition: app_io.h:145
app_uart_dma_cfg_t::rx_dma_channel
dma_channel_t rx_dma_channel
Specifies the dma channel of UART RX.
Definition: app_uart.h:158
APP_UART_EVT_ABORT_TX
@ APP_UART_EVT_ABORT_TX
Requested TX abort completed.
Definition: app_uart.h:105
uart_env_t::start_flush_flag
volatile bool start_flush_flag
start flush flag.
Definition: app_uart.h:214
uart_env_t::tx_abort_flag
bool tx_abort_flag
tx abort flag.
Definition: app_uart.h:215
_uart_handle
UART handle Structure definition.
Definition: gr55xx_hal_uart.h:153
app_uart_params_t
UART parameters structure definition.
Definition: app_uart.h:224
app_uart_tx_buf_t
UART buffer structure definition.
Definition: app_uart.h:236
app_uart_tx_buf_t::tx_buf_size
uint32_t tx_buf_size
Size of the TX buffer.
Definition: app_uart.h:238
app_uart_pin_cfg_t::tx
app_uart_pin_t tx
Set the configuration of UART TX pin.
Definition: app_uart.h:144
_uart_init
UART init structure definition.
Definition: gr55xx_hal_uart.h:120
app_uart_dma_cfg_t::rx_dma_instance
dma_regs_t * rx_dma_instance
Specifies the RX DMA inistall.
Definition: app_uart.h:156
APP_UART_ID_0
@ APP_UART_ID_0
UART module 0.
Definition: app_uart.h:84
APP_UART_ACTIVITY
@ APP_UART_ACTIVITY
Definition: app_uart.h:114
app_io.h
Header file containing functions prototypes of GPIO app library.
app_uart_abort_receive
uint16_t app_uart_abort_receive(app_uart_id_t id)
Abort receive process and generate abort receive callback.
app_uart_tx_buf_t::tx_buf
uint8_t * tx_buf
Pointer to the TX buffer.
Definition: app_uart.h:237
APP_UART_EVT_ABORT_TXRX
@ APP_UART_EVT_ABORT_TXRX
Requested TX, RX abort completed.
Definition: app_uart.h:107
app_uart_evt_t::type
app_uart_evt_type_t type
Type of event.
Definition: app_uart.h:174
APP_UART_EVT_RX_DATA
@ APP_UART_EVT_RX_DATA
Requested RX transfer completed.
Definition: app_uart.h:104
app_uart_receive_sync
uint16_t app_uart_receive_sync(app_uart_id_t id, uint8_t *p_data, uint16_t size, uint32_t timeout)
Receive an amount of data in blocking mode.
app_uart_params_t::uart_dev
uart_env_t uart_dev
UART event data.
Definition: app_uart.h:229
grx_hal.h
This file contains all the functions prototypes for the HAL module driver.
app_uart_evt_handler_t
void(* app_uart_evt_handler_t)(app_uart_evt_t *p_evt)
UART event callback definition.
Definition: app_uart.h:191
uart_env_t
UART device structure definition.
Definition: app_uart.h:204
app_uart_dma_cfg_t::tx_dma_instance
dma_regs_t * tx_dma_instance
Specifies the TX DMA inistall.
Definition: app_uart.h:155
uart_env_t::p_pin_cfg
app_uart_pin_cfg_t * p_pin_cfg
UART pins config Structures.
Definition: app_uart.h:207
app_uart_evt_t
UART event structure definition.
Definition: app_uart.h:173
app_uart_evt_t::size
uint16_t size
UART transmitted/received counter.
Definition: app_uart.h:178
app_uart_receive_async
uint16_t app_uart_receive_async(app_uart_id_t id, uint8_t *p_data, uint16_t size)
Receive an amount of data in interrupt mode.
APP_UART_ID_MAX
@ APP_UART_ID_MAX
Only for check parameter, not used as input parameters.
Definition: app_uart.h:94
app_dma.h
Header file containing functions prototypes of DMA app library.
app_uart_dma_cfg_t
UART DMA configuration structure definition.
Definition: app_uart.h:154
app_uart_transmit_async
uint16_t app_uart_transmit_async(app_uart_id_t id, uint8_t *p_data, uint16_t size)
Send an amount of data in interrupt mode.
app_uart_get_handle
uart_handle_t * app_uart_get_handle(app_uart_id_t id)
Return the UART handle.
app_uart_params_t::dma_cfg
app_uart_dma_cfg_t dma_cfg
UART DMA configuration.
Definition: app_uart.h:227
app_uart_dma_state_t
app_uart_dma_state_t
App uart dma state types.
Definition: app_uart.h:164
APP_UART_INVALID
@ APP_UART_INVALID
Definition: app_uart.h:113
app_uart_pin_t::mux
app_io_mux_t mux
Specifies the Peripheral to be connected to the selected pins.
Definition: app_uart.h:132
uart_env_t::rx_abort_flag
bool rx_abort_flag
rx abort flag.
Definition: app_uart.h:216
uart_env_t::handle
uart_handle_t handle
UART handle Structure.
Definition: app_uart.h:206
app_uart_id_t
app_uart_id_t
UART module Enumerations definition.
Definition: app_uart.h:83
app_io_mux_t
app_io_mux_t
GPIO mux Enumerations definition.
Definition: app_io.h:253
app_uart_pin_cfg_t::rts
app_uart_pin_t rts
Set the configuration of UART RTS pin.
Definition: app_uart.h:147
app_uart_pin_t::pin
uint32_t pin
Specifies the IO pins to be configured.
Definition: app_uart.h:133
APP_UART_DMA_ACTIVITY
@ APP_UART_DMA_ACTIVITY
Definition: app_uart.h:166
app_uart_pin_cfg_t
UART pins config Structures.
Definition: app_uart.h:143
app_uart_evt_t::error_code
uint32_t error_code
UART Error code .
Definition: app_uart.h:177
APP_UART_EVT_ERROR
@ APP_UART_EVT_ERROR
Error reported by UART peripheral.
Definition: app_uart.h:102
app_drv_config.h
Header file of app driver config code.
app_uart_pin_t
UART pins Structures.
Definition: app_uart.h:130
uart_env_t::start_tx_flag
volatile bool start_tx_flag
start tx flag.
Definition: app_uart.h:213
app_uart_flush
void app_uart_flush(app_uart_id_t id)
Flush all log entries from the buffer.
APP_UART_ID_1
@ APP_UART_ID_1
UART module 1.
Definition: app_uart.h:85
app_uart_pin_t::type
app_io_type_t type
Specifies the type of UART IO.
Definition: app_uart.h:131
TX_ONCE_MAX_SIZE
#define TX_ONCE_MAX_SIZE
UART max bytes size transmitted at one time.
Definition: app_uart.h:71
dma_id_t
int16_t dma_id_t
DMA id definition.
Definition: app_dma.h:98
dma_channel_t
dma_channel_t
HAL DMA Channel Enumerations definition.
Definition: gr55xx_hal_dma.h:93
APP_UART_EVT_TX_CPLT
@ APP_UART_EVT_TX_CPLT
Requested TX transfer completed.
Definition: app_uart.h:103
app_uart_abort_transmit
uint16_t app_uart_abort_transmit(app_uart_id_t id)
Abort transmit process and generate abort transmit callback.