gr55xx_delay.h
Go to the documentation of this file.
1 /**
2  ****************************************************************************************
3  *
4  * @file gr55xx_delay.h
5  *
6  * @brief PERIPHERAL API DELAY DRIVER
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 HAL_DRIVER HAL Driver
43  * @{
44  */
45 
46 /** @defgroup HAL_Delay HAL_Delay
47  * @brief CGC HAL module driver.
48  * @{
49  */
50 
51 #ifndef __GR55xx_DELAY_H__
52 #define __GR55xx_DELAY_H__
53 
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 #include "gr55xx.h"
59 
60 /** @addtogroup DELAY_DRIVER_FUNCTIONS Functions
61  * @{
62  */
63 
64 /**
65  ****************************************************************************************
66  * @brief Function for delaying execution for number of microseconds. GR55xxx is based on
67  * Cortex-M4, and this function is based on Data Watchpoint and Trace (DWT) unit.
68  * @param[in] number_of_us: number of microseconds
69  ****************************************************************************************
70  */
71 void delay_us(uint32_t number_of_us);
72 
73 /**
74  ****************************************************************************************
75  * @brief Function for delaying execution for number of milliseconds. GR55xxx is based on
76  * Cortex-M4, and this function is based on Data Watchpoint and Trace (DWT) unit.
77  * @param[in] number_of_ms: number of milliseconds
78  ****************************************************************************************
79  */
80 void delay_ms(uint32_t number_of_ms);
81 
82 /** @} */
83 
84 #ifdef __cplusplus
85 }
86 #endif
87 
88 #endif /* __GR55xx_DELAY_H__ */
89 /** @} */
90 
91 /** @} */
92 
93 /** @} */
delay_us
void delay_us(uint32_t number_of_us)
Function for delaying execution for number of microseconds. GR55xxx is based on Cortex-M4,...
delay_ms
void delay_ms(uint32_t number_of_ms)
Function for delaying execution for number of milliseconds. GR55xxx is based on Cortex-M4,...