aboutsummaryrefslogtreecommitdiffstats
path: root/source/gpio.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-02-16 05:45:40 -0500
committerMarti Bolivar <mbolivar@leaflabs.com>2011-02-16 05:45:40 -0500
commitc4177d18f5a433fcac11f8ce96a91bdb5a4207e7 (patch)
tree3db2b38b9543093832f2d9a9cf78ef47c4b69d16 /source/gpio.rst
parente6317f828d346adafad4f03e9f7cf74b1e9acfa8 (diff)
downloadlibrambutan-c4177d18f5a433fcac11f8ce96a91bdb5a4207e7.tar.gz
librambutan-c4177d18f5a433fcac11f8ce96a91bdb5a4207e7.zip
docs fixes
Diffstat (limited to 'source/gpio.rst')
-rw-r--r--source/gpio.rst17
1 files changed, 12 insertions, 5 deletions
diff --git a/source/gpio.rst b/source/gpio.rst
index 4017862..cebb402 100644
--- a/source/gpio.rst
+++ b/source/gpio.rst
@@ -11,7 +11,7 @@ silkscreen.
Many of these pins may additionally be used for special features or
peripheral functions. This page documents those capabilities, by pin.
-The current and voltage limitations have not been copied over from the
+The current and voltage limitations have been copied over from the
STM32 datasheet (see the :ref:`Recommended Reading
<gpio-recommended-reading>` for a link). In particular, a number of
GPIO pins are 5V tolerant (which means that applying 5 volts to a pin
@@ -31,6 +31,9 @@ peripheral type. The "STM32" column refers to the port and number that
the header is connected to on the microcontroller. The "5V?" column
documents whether or not the pin is 5 volt tolerant (see above).
+.. TODO silkscreen pictures which let you know what each abbreviation
+.. means, with links to the relevant documentation.
+
.. csv-table::
:header: "Pin", "STM32", ":ref:`ADC <adc>`", ":ref:`Timer <timers>`", ":ref:`I2C <i2c>`", ":ref:`UART <usart>`", ":ref:`SPI <spi>`", "5v?"
@@ -83,13 +86,17 @@ GPIO Modes
Function Reference
------------------
-.. doxygenfunction:: pinMode
+- :ref:`pinMode() <lang-pinmode>`
+
+- :ref:`digitalRead() <lang-digitalread>`
-.. doxygenfunction:: digitalRead
+- :ref:`digitalWrite() <lang-digitalwrite>`
-.. doxygenfunction:: digitalWrite
+- :ref:`analogRead() <lang-analogread>`
-.. doxygenfunction:: analogRead
+- :ref:`pwmWrite() <lang-pwmwrite>` (Maple's equivalent to
+ ``analogWrite()``; see the :ref:`analogWrite() reference
+ <lang-analogwrite>` for differences from the Arduino version).
.. _gpio-recommended-reading: