aboutsummaryrefslogtreecommitdiffstats
path: root/source/lang/api
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-04-08 15:56:14 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-04-08 18:58:58 -0400
commit5d17fbe13cc6baeeb1f54c925a0c67ae60e5f23e (patch)
tree08b975e9d8fc2c4d34beee41e154897b89e77b00 /source/lang/api
parentd70af49f021da7da497b45b18c4fea73cfbd3cb7 (diff)
downloadlibrambutan-5d17fbe13cc6baeeb1f54c925a0c67ae60e5f23e.tar.gz
librambutan-5d17fbe13cc6baeeb1f54c925a0c67ae60e5f23e.zip
Adding CLOCK_SPEED_MHZ and CLOCK_SPEED_HZ as derived board-specific values.
Diffstat (limited to 'source/lang/api')
-rw-r--r--source/lang/api/board-values.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/source/lang/api/board-values.rst b/source/lang/api/board-values.rst
index 367adbb..d6d78f6 100644
--- a/source/lang/api/board-values.rst
+++ b/source/lang/api/board-values.rst
@@ -18,6 +18,12 @@ boards. Some example usages are given :ref:`below
Constants
---------
+- ``CLOCK_SPEED_MHZ``: Clock speed of your board, in megahertz
+ (MHz). This is the same as ``CYCLES_PER_MICROSECOND``.
+
+- ``CLOCK_SPEED_HZ``: Clock speed of your board, in hertz (Hz). This
+ is the same as ``CLOCK_SPEED_MHZ * 1000000``.
+
- ``CYCLES_PER_MICROSECOND``: Number of CPU cycles per microsecond on
your board.