aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/libmaple/api/systick.rst
blob: 45b6d63efc97be800a039b589fcc90acc5684a90 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
.. highlight:: c

.. _libmaple-systick:

``systick.h``
=============

System timer (SysTick) support.

.. contents:: Contents
   :local:

Types
-----

.. doxygenstruct:: systick_reg_map

Devices
-------

None.

Functions
---------

.. doxygenfunction:: systick_init
.. _libmaple-systick-enable:
.. doxygenfunction:: systick_enable
.. _libmaple-systick-disable:
.. doxygenfunction:: systick_disable
.. doxygenfunction:: systick_uptime
.. doxygenfunction:: systick_get_count
.. doxygenfunction:: systick_check_underflow

Register Map Base Pointers
--------------------------

.. doxygendefine:: SYSTICK_BASE

Register Bit Definitions
------------------------

Control and status register
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. doxygendefine:: SYSTICK_CSR_COUNTFLAG
.. doxygendefine:: SYSTICK_CSR_CLKSOURCE
.. doxygendefine:: SYSTICK_CSR_CLKSOURCE_EXTERNAL
.. doxygendefine:: SYSTICK_CSR_CLKSOURCE_CORE
.. doxygendefine:: SYSTICK_CSR_TICKINT
.. doxygendefine:: SYSTICK_CSR_TICKINT_PEND
.. doxygendefine:: SYSTICK_CSR_TICKINT_NO_PEND
.. doxygendefine:: SYSTICK_CSR_ENABLE
.. doxygendefine:: SYSTICK_CSR_ENABLE_MULTISHOT
.. doxygendefine:: SYSTICK_CSR_ENABLE_DISABLED

Calibration value register
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. doxygendefine:: SYSTICK_CVR_NOREF
.. doxygendefine:: SYSTICK_CVR_SKEW
.. doxygendefine:: SYSTICK_CVR_TENMS