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