app_systick.h
Go to the documentation of this file.
1 /**
2 ****************************************************************************************
3 *
4 * @file app_systick.h
5 * @author BLE Driver Team
6 * @brief Header file containing functions prototypes of systick 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_SYSTICK SYSTICK
47 * @brief SYSTICK APP module driver.
48 * @{
49 */
50
51
52 #ifndef _APP_SYSTICK_H_
53 #define _APP_SYSTICK_H_
54
55 #include <stdint.h>
56
57 /* Exported functions --------------------------------------------------------*/
58 /** @addtogroup APP_SYSTICK_DRIVER_FUNCTIONS Functions
59 * @{
60 */
61
62 /**
63 ****************************************************************************************
64 * @brief This function configures time base source, NVIC and Low level hardware.
65 *
66 * @note This function is called at the beginning of program after reset and before
67 * the clock configuration.
68 * The Systick configuration is based on AHB clock and the NVIC configuration
69 * is set to Priority group 4.
70 * The time base configuration is done, time base tick starts incrementing.
71 * In the default implementation, Systick is used as source of time base.
72 * The tick variable is incremented each 1ms in its ISR.
73 *
74 ****************************************************************************************
75 */
76 void app_systick_init(void);
77
78 /**
79 ****************************************************************************************
80 * @brief This function de-Initializes common part of the HAL and stops the source
81 * of time base.
82 *
83 * @note This function is optional.
84 *
85 ****************************************************************************************
86 */
87 void app_systick_deinit(void);
88
89 /** @} */
90
91 #endif
92
93 /** @} */
94 /** @} */
95 /** @} */
app_systick_deinit
void app_systick_deinit(void)
This function de-Initializes common part of the HAL and stops the source of time base.
app_systick_init
void app_systick_init(void)
This function configures time base source, NVIC and Low level hardware.