aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-09-01 10:18:55 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-09-06 20:03:03 -0400
commit2633129a66849b754544b47eb3a4faf81ceb0aab (patch)
treecdc1bb904d50f08cd6117fb0c55b0e1b902020dd
parent1c4ae6d18cb1b1300856b9eb2923cb745277f47b (diff)
downloadlibrambutan-2633129a66849b754544b47eb3a4faf81ceb0aab.tar.gz
librambutan-2633129a66849b754544b47eb3a4faf81ceb0aab.zip
hardware: Fix up board pages.
Make the following changes to each of the board files under source/hardware/: - Link to ST docs from MCU name in Technical Specifications. - Tweak RM0008 description. - Beautify technical specifications. - Note that pin maps aren't exhaustive. It's becoming clear that we should eventually use some kind of templating language to get these pages done, but it's still overkill for now.
-rw-r--r--source/hardware/maple-mini.rst30
-rw-r--r--source/hardware/maple-ret6.rst34
-rw-r--r--source/hardware/maple.rst30
3 files changed, 56 insertions, 38 deletions
diff --git a/source/hardware/maple-mini.rst b/source/hardware/maple-mini.rst
index 665970a..6f3f437 100644
--- a/source/hardware/maple-mini.rst
+++ b/source/hardware/maple-mini.rst
@@ -15,25 +15,26 @@ breadboard.
Technical Specifications
------------------------
-* MCU: **STM32F103RCBT6**, a 32-bit ARM Cortex M3 microprocessor
+* MCU: :ref:`STM32F103RCBT6 <maple-mini-stdocs>`, a 32-bit ARM Cortex
+ M3 microprocessor
* Clock Speed: **72 MHz**
* **128 KB Flash** and **20 KB SRAM**
-* 34 Digital I/O Pins (:ref:`gpio`)
-* 12 **PWM** pins at 16 bit resolution (:ref:`pwm`)
-* 9 analog input pins, 12 bit **ADC** resolution (:ref:`adc`)
-* 2 **SPI** peripherals (:ref:`spi`)
-* 2 **I2C** peripherals (:ref:`i2c`)
+* 34 :ref:`digital I/ pins (GPIOs) <gpio>`
+* 12 :ref:`PWM <pwm>` pins at 16 bit resolution
+* 9 :ref:`analog input (ADC) <adc>` pins at 12 bit resolution
+* 2 :ref:`SPI <spi>` peripherals
+* 2 :ref:`I2C <i2c>` peripherals
* 7 Channels of Direct Memory Access (**DMA**) (:ref:`libmaple-dma`)
-* 3 **USART** peripherals (:ref:`usart`)
-* 1 advanced and 3 general-purpose **timers** (:ref:`timers`)
-* Dedicated **USB** port for programming and communications (:ref:`usb`)
-* **JTAG** (:ref:`jtag`)
+* 3 :ref:`USART (serial port) <usart>` peripherals
+* 1 advanced and 3 general-purpose :ref:`timers <timers>`
+* Dedicated :ref:`USB <usb>` port for programming and communications
+* :ref:`jtag`
* Nested Vectored Interrupt Controller (NVIC) (including
:ref:`external interrupt <external-interrupts>` on GPIOs)
* Supplies up to 500 mA at 3.3 V, with :ref:`separate 250 mA digital
and analog regulators <maple-mini-adc-bank>` for low-noise analog
performance
-* :ref:`Four layer design <maple-mini-hardware>`
+* :ref:`Open source, four layer design <maple-mini-hardware>`
* Support for low power, sleep, and standby modes (<500 μA)
* Operating Voltage: 3.3 V
* Input Voltage (recommended): 3 V — 12 V
@@ -97,6 +98,9 @@ This table shows a summary the available functionality on every GPIO
pin, by peripheral type. The "5 V?" column documents whether or not
the pin is :ref:`5 volt tolerant <gpio-5v-tolerant>`.
+Note that this table is not exhaustive; on some pins, more peripherals
+are available than are listed here.
+
.. csv-table::
:header: Pin, :ref:`GPIO <gpio>`, :ref:`ADC <adc>`, :ref:`Timer <timers>`, :ref:`I2C <i2c>`, :ref:`UART <usart>`, :ref:`SPI <spi>`, 5 V?
@@ -347,6 +351,8 @@ This section lists known issues and warnings for the Maple Mini Rev 2
Recommended Reading
-------------------
+.. _maple-mini-stdocs:
+
STMicro documentation for STM32F103CB microcontroller:
* `Datasheet
@@ -354,7 +360,7 @@ STMicro documentation for STM32F103CB microcontroller:
(PDF); covers STM32F103x8, STM32F103xB.
* `Reference Manual RM0008
<http://www.st.com/internet/com/TECHNICAL_RESOURCES/TECHNICAL_LITERATURE/REFERENCE_MANUAL/CD00171190.pdf>`_
- (PDF); general, definitive resource for STM32F1 line.
+ (PDF); definitive resource for peripherals on the STM32F1 line.
* `Programming Manual PM0056
<http://www.st.com/internet/com/TECHNICAL_RESOURCES/TECHNICAL_LITERATURE/PROGRAMMING_MANUAL/CD00228163.pdf>`_
(PDF); assembly language and register reference.
diff --git a/source/hardware/maple-ret6.rst b/source/hardware/maple-ret6.rst
index 25c1294..5d244af 100644
--- a/source/hardware/maple-ret6.rst
+++ b/source/hardware/maple-ret6.rst
@@ -21,27 +21,28 @@ the hands of Maple developers.
Technical Specifications
------------------------
-* MCU: **STM32F103RET6**, a 32-bit ARM Cortex M3 microprocessor
+* MCU: :ref:`STM32F103RET6 <maple-ret6-stdocs>`, a 32-bit ARM Cortex
+ M3 microprocessor
* Clock Speed: **72 MHz**
* **512 KB Flash** and **64 KB SRAM**
-* 43 Digital I/O Pins (:ref:`gpio`)
-* 18 **PWM** pins at 16 bit resolution (:ref:`pwm`)
-* 15 analog input pins, 12 bit **ADC** resolution (:ref:`adc`)
+* 43 :ref:`digital I/O pins (GPIOs) <gpio>`
+* 18 :ref:`PWM <pwm>` pins at 16 bit resolution
+* 15 :ref:`analog input (ADC) <adc>` pins at 12 bit resolution
* Built-in, 2 channel **DAC** at 12 bit resolution (:ref:`libmaple-dac`).
-* 2 **SPI** peripherals with **I2S** support (:ref:`spi`)
-* 2 **I2C** peripherals (:ref:`i2c`)
-* 12 Channels of Direct Memory Access (**DMA**)
- (:ref:`libmaple-dma`) with 2 DMA controllers
-* 3 **USART** devices (:ref:`usart`)
-* 2 advanced, 4 general-purpose, and 2 basic **timers** (:ref:`timers`)
-* Dedicated **USB** port for programming and communications (:ref:`usb`)
-* **JTAG** (:ref:`jtag`)
+* 2 :ref:`SPI <spi>` peripherals with **I2S** support
+* 2 :ref:`I2C <i2c>` peripherals
+* 12 Channels of Direct Memory Access (**DMA**) (:ref:`libmaple-dma`)
+ with 2 DMA controllers
+* 3 :ref:`USART (serial port) <usart>` peripherals
+* 2 advanced, 4 general-purpose, and 2 basic :ref:`timers <timers>`
+* Dedicated :ref:`USB <usb>` port for programming and communications
+* :ref:`JTAG <jtag>`
* Nested Vectored Interrupt Controller (NVIC) (including
:ref:`external interrupt <lang-attachinterrupt>` on GPIOs)
* Supplies up to 500 mA at 3.3 V, with :ref:`separate 250 mA digital
and analog regulators <maple-ret6-adc-bank>` for low-noise analog
performance
-* :ref:`Four layer design <maple-ret6-hardware>`
+* :ref:`Open-source, four layer design <maple-ret6-hardware>`
* Support for low power, sleep, and standby modes (<500 μA)
* Operating Voltage: 3.3 V
* Input Voltage (recommended): 4 V — 12 V
@@ -107,6 +108,9 @@ This table shows a summary of the available functionality on every
GPIO pin, by peripheral type. The "5 V?" column documents whether or
not the pin is :ref:`5 volt tolerant <gpio-5v-tolerant>`.
+Note that this table is not exhaustive; on some pins, more peripherals
+are available than are listed here.
+
.. csv-table::
:header: Pin, :ref:`GPIO <gpio>`, :ref:`ADC <adc>`, :ref:`Timer <timers>`, :ref:`I2C <i2c>`, :ref:`UART/USART <usart>`, :ref:`SPI <spi>`, 5 V?
@@ -429,6 +433,8 @@ features only available on the STM32F103RET6.
Recommended Reading
-------------------
+.. _maple-ret6-stdocs:
+
STMicro documentation for STM32F103RE microcontroller:
* `Datasheet
@@ -436,7 +442,7 @@ STMicro documentation for STM32F103RE microcontroller:
(PDF); covers STM32F103xC, STM32F103xD, STM32F103xE.
* `Reference Manual RM0008
<http://www.st.com/internet/com/TECHNICAL_RESOURCES/TECHNICAL_LITERATURE/REFERENCE_MANUAL/CD00171190.pdf>`_
- (PDF); general, definitive resource for STM32F1 line.
+ (PDF); definitive resource for peripherals on the STM32F1 line.
* `Programming Manual PM0056
<http://www.st.com/internet/com/TECHNICAL_RESOURCES/TECHNICAL_LITERATURE/PROGRAMMING_MANUAL/CD00228163.pdf>`_
(PDF); assembly language and register reference.
diff --git a/source/hardware/maple.rst b/source/hardware/maple.rst
index 91198f2..69c3845 100644
--- a/source/hardware/maple.rst
+++ b/source/hardware/maple.rst
@@ -16,24 +16,25 @@ This page is a general resource for information specific to the Maple.
Technical Specifications
------------------------
-* MCU: **STM32F103RBT6**, a 32-bit ARM Cortex M3 microprocessor
+* MCU: :ref:`STM32F103RBT6 <maple-stdocs>`, a 32-bit ARM Cortex M3
+ microprocessor
* Clock Speed: **72 MHz**
* **128 KB Flash** and **20 KB SRAM**
-* 43 Digital I/O Pins (:ref:`gpio`)
-* 15 **PWM** pins at 16 bit resolution (:ref:`pwm`)
-* 15 analog input pins, 12-bit **ADC** resolution (:ref:`adc`)
-* 2 **SPI** peripherals (:ref:`spi`)
-* 2 **I2C** peripherals (:ref:`i2c`)
+* 43 :ref:`digital I/O pins (GPIOs) <gpio>`
+* 15 :ref:`PWM <pwm>` pins at 16 bit resolution
+* 15 :ref:`analog input (ADC) <adc>` pins at 12-bit resolution
+* 2 :ref:`SPI <spi>` peripherals
+* 2 :ref:`I2C <i2c>` peripherals
* 7 Channels of Direct Memory Access (**DMA**) (:ref:`libmaple-dma`)
-* 3 **USART** peripherals (:ref:`usart`)
-* One advanced and three general-purpose **timers** (:ref:`timers`)
-* Dedicated **USB** port for programming and communications (:ref:`usb`)
-* **JTAG** (:ref:`jtag`)
+* 3 :ref:`USART (serial port) <usart>` peripherals
+* One advanced and three general-purpose :ref:`timers <timers>`
+* Dedicated :ref:`USB <usb>` port for programming and communications
+* :ref:`JTAG <jtag>`
* Nested Vectored Interrupt Controller (NVIC) (including
:ref:`external interrupt <external-interrupts>` on GPIOs)
* Supplies up to 500 mA at 3.3 V, with separate 250 mA digital and
analog regulators for low-noise analog performance
-* :ref:`Four layer design <maple-hardware>`
+* :ref:`Open source, four layer design <maple-hardware>`
* Support for low power, sleep, and standby modes (<500 μA)
* Operating Voltage: 3.3 V
* Input Voltage (recommended): 4 V — 12 V
@@ -155,6 +156,9 @@ This table shows a summary of the available functionality on every
GPIO pin, by peripheral type. The "5 V?" column documents whether or
not the pin is :ref:`5 volt tolerant <gpio-5v-tolerant>`.
+Note that this table is not exhaustive; on some pins, more peripherals
+are available than are listed here.
+
.. csv-table::
:header: Pin, :ref:`GPIO <gpio>`, :ref:`ADC <adc>`, :ref:`Timer <timers>`, :ref:`I2C <i2c>`, :ref:`UART <usart>`, :ref:`SPI <spi>`, 5 V?
@@ -552,6 +556,8 @@ Rev 1
Recommended Reading
-------------------
+.. _maple-stdocs:
+
STMicro documentation for STM32F103RB microcontroller:
* `Datasheet
@@ -559,7 +565,7 @@ STMicro documentation for STM32F103RB microcontroller:
(PDF); covers STM32F103x8, STM32F103xB.
* `Reference Manual RM0008
<http://www.st.com/internet/com/TECHNICAL_RESOURCES/TECHNICAL_LITERATURE/REFERENCE_MANUAL/CD00171190.pdf>`_
- (PDF); general, definitive resource for STM32F1 line.
+ (PDF); definitive resource for peripherals on the STM32F1 line.
* `Programming Manual PM0056
<http://www.st.com/internet/com/TECHNICAL_RESOURCES/TECHNICAL_LITERATURE/PROGRAMMING_MANUAL/CD00228163.pdf>`_
(PDF); assembly language and register reference.