1 /******************************************************************************
2  *  Filename:       systick_doc.h
3  *
4  *  Copyright (c) 2022 Texas Instruments Incorporated
5  *
6  *  Redistribution and use in source and binary forms, with or without
7  *  modification, are permitted provided that the following conditions are met:
8  *
9  *  1) Redistributions of source code must retain the above copyright notice,
10  *     this list of conditions and the following disclaimer.
11  *
12  *  2) Redistributions in binary form must reproduce the above copyright notice,
13  *     this list of conditions and the following disclaimer in the documentation
14  *     and/or other materials provided with the distribution.
15  *
16  *  3) Neither the name of the copyright holder nor the names of its
17  *     contributors may be used to endorse or promote products derived from this
18  *     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, THE
22  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  *  POSSIBILITY OF SUCH DAMAGE.
31  *
32  ******************************************************************************/
33 //! \addtogroup systick_api
34 //! @{
35 //! \section sec_systick Introduction
36 //!
37 //! The system CPU includes a system timer, SysTick, integrated in the NVIC which provides a simple, 24-bit,
38 //! clear-on-write, decrementing, wrap-on-zero counter with a flexible control mechanism.
39 //! When enabled, the timer counts down on each clock from the reload value to 0, reloads (wraps) on
40 //! the next clock edge, then decrements on subsequent clocks.
41 //!
42 //! The SysTick counter runs on the system clock. If this clock signal is stopped for low-power mode, the
43 //! SysTick counter stops.
44 //!
45 //! When the processor is halted for debugging, the counter does not decrement.
46 //!
47 //! \section sec_systick_api API
48 //!
49 //! The API functions can be grouped like this:
50 //!
51 //! Configuration and status:
52 //! - \ref SysTickSetPeriod()
53 //! - \ref SysTickGetPeriod()
54 //! - \ref SysTickGetValue()
55 //!
56 //! Enable and disable:
57 //! - \ref SysTickEnable()
58 //! - \ref SysTickDisable()
59 //!
60 //! Interrupt configuration:
61 //! - \ref SysTickRegisterInt()
62 //! - \ref SysTickUnregisterInt()
63 //! - \ref SysTickEnableInt()
64 //! - \ref SysTickDisableInt()
65 //! @}
66