systick.h
Go to the documentation of this file.
1 /* --COPYRIGHT--,BSD
2  * Copyright (c) 2017, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  * --/COPYRIGHT--*/
32 #ifndef __SYSTICK_H__
33 #define __SYSTICK_H__
34 
35 //*****************************************************************************
36 //
39 //
40 //*****************************************************************************
41 
42 //*****************************************************************************
43 //
44 // If building with a C++ compiler, make all of the definitions in this header
45 // have a C binding.
46 //
47 //*****************************************************************************
48 #ifdef __cplusplus
49 extern "C"
50 {
51 #endif
52 #include <stdint.h>
53 
54 //*****************************************************************************
55 //
56 // Prototypes for the APIs.
57 //
58 //*****************************************************************************
59 
60 //*****************************************************************************
61 //
76 //
77 //*****************************************************************************
78 extern void SysTick_enableModule(void);
79 
80 //*****************************************************************************
81 //
88 //
89 //*****************************************************************************
90 extern void SysTick_disableModule(void);
91 
92 //*****************************************************************************
93 //
106 //
107 //*****************************************************************************
108 extern void SysTick_registerInterrupt(void (*intHandler)(void));
109 
110 //*****************************************************************************
111 //
121 //
122 //*****************************************************************************
123 extern void SysTick_unregisterInterrupt(void);
124 
125 //*****************************************************************************
126 //
137 //
138 //*****************************************************************************
139 extern void SysTick_enableInterrupt(void);
140 
141 //*****************************************************************************
142 //
149 //
150 //*****************************************************************************
151 extern void SysTick_disableInterrupt(void);
152 
153 //*****************************************************************************
154 //
170 //
171 //*****************************************************************************
172 extern void SysTick_setPeriod(uint32_t period);
173 
174 //*****************************************************************************
175 //
182 //
183 //*****************************************************************************
184 extern uint32_t SysTick_getPeriod(void);
185 
186 //*****************************************************************************
187 //
194 //
195 //*****************************************************************************
196 extern uint32_t SysTick_getValue(void);
197 
198 //*****************************************************************************
199 //
200 // Mark the end of the C bindings section for C++ compilers.
201 //
202 //*****************************************************************************
203 #ifdef __cplusplus
204 }
205 #endif
206 
207 //*****************************************************************************
208 //
209 // Close the Doxygen group.
211 //
212 //*****************************************************************************
213 
214 #endif // __SYSTICK_H__
SysTick_registerInterrupt
void SysTick_registerInterrupt(void(*intHandler)(void))
Definition: systick.c:52
SysTick_unregisterInterrupt
void SysTick_unregisterInterrupt(void)
Definition: systick.c:61
SysTick_setPeriod
void SysTick_setPeriod(uint32_t period)
Definition: systick.c:86
SysTick_disableModule
void SysTick_disableModule(void)
Definition: systick.c:44
SysTick_enableInterrupt
void SysTick_enableInterrupt(void)
Definition: systick.c:70
SysTick_getValue
uint32_t SysTick_getValue(void)
Definition: systick.c:107
SysTick_getPeriod
uint32_t SysTick_getPeriod(void)
Definition: systick.c:99
SysTick_enableModule
void SysTick_enableModule(void)
Definition: systick.c:36
SysTick_disableInterrupt
void SysTick_disableInterrupt(void)
Definition: systick.c:78
Copyright 2018, Texas Instruments Incorporated