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