aboutsummaryrefslogtreecommitdiffstats
path: root/source/lang
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-09-08 01:47:13 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-09-08 01:51:20 -0400
commit2f6d6831bcd187e777cba35aac0d2de391442024 (patch)
tree425b79196734e852d86a2da72de4763e7ea9106d /source/lang
parente654bf72d5c1f20e575c6d3ebb3d78fe8dd82ed2 (diff)
downloadlibrambutan-2f6d6831bcd187e777cba35aac0d2de391442024.tar.gz
librambutan-2f6d6831bcd187e777cba35aac0d2de391442024.zip
hardwarespi: Note about disable JTAG+SW when using SPI3.
Diffstat (limited to 'source/lang')
-rw-r--r--source/lang/api/hardwarespi.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/source/lang/api/hardwarespi.rst b/source/lang/api/hardwarespi.rst
index f90fc07..a44a65f 100644
--- a/source/lang/api/hardwarespi.rst
+++ b/source/lang/api/hardwarespi.rst
@@ -15,9 +15,6 @@ the :ref:`SPI reference <spi>`.
Getting Started
---------------
-.. TODO [0.1.0] Add a note about calling disableDebugPorts() when
-.. using SPI3 on Maple Native
-
In order to get started, you'll first need to define a ``HardwareSPI``
variable, which you'll use to control the SPI port. Do this by
putting the line "``HardwareSPI spi(number);``" with your variables,
@@ -47,6 +44,10 @@ function (an example is given below).
.. doxygenfunction:: HardwareSPI::begin
+.. note:: If you are using SPI port 3 (on a board that supports it;
+ not all do); you'll need to call :ref:`lang-disabledebugports`
+ before calling ``begin()``.
+
The speed at which the SPI port communicates is configured using a
``SPIFrequency`` value: