aboutsummaryrefslogtreecommitdiff
path: root/docs/source/lang/api/board-values.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-05-20 15:30:15 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-05-23 10:18:39 -0400
commit02e69a342f81e0c8bf040c4da3faed48d36deebe (patch)
tree529839c78bb0b23dae882e113a9b916d6e830ee0 /docs/source/lang/api/board-values.rst
parentf9e8116cfdfd651c18e0579ba7e10910d2c9d1ef (diff)
0.0.10 docs RC
Diffstat (limited to 'docs/source/lang/api/board-values.rst')
-rw-r--r--docs/source/lang/api/board-values.rst13
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/source/lang/api/board-values.rst b/docs/source/lang/api/board-values.rst
index 5fbf20f..7198407 100644
--- a/docs/source/lang/api/board-values.rst
+++ b/docs/source/lang/api/board-values.rst
@@ -23,9 +23,6 @@ Documentation <index-boards>`.
Constants
---------
-.. TODO [systick.rst] Add a link to systick.rst instead of systick.h
-.. below, when systick.rst exists.
-
- ``CYCLES_PER_MICROSECOND``: Number of CPU cycles per microsecond on
your board.
@@ -35,9 +32,8 @@ Constants
- ``CLOCK_SPEED_HZ``: Clock speed of your board, in hertz (Hz). This
is the same as ``CLOCK_SPEED_MHZ`` × 1,000,000.
-- ``SYSTICK_RELOAD_VAL``: Value used when reloading the :ref:`SysTick
- <libmaple-systick>` timer's counter. For :ref:`lang-millis` to work
- properly, this must be ``CYCLES_PER_MICROSECOND`` × 1,000 - 1.
+- ``SYSTICK_RELOAD_VAL``: Value used when reloading the :ref:`systick`
+ timer's counter [#fmillis]_.
.. _lang-board-values-but:
@@ -205,3 +201,8 @@ See Also
- :ref:`lang-pwmwrite`
- :ref:`lang-enabledebugports`
- :ref:`lang-disabledebugports`
+
+.. rubric:: Footnotes
+
+.. [#fmillis] In order for :ref:`lang-millis` to work properly, this
+ must be ``CYCLES_PER_MICROSECOND`` × 1,000 - 1.