Add documentation for Teensy, STM32 and Atmel SAM platforms; Add Digispark boards to Atmel AVR platform

2025-07-29 17:47:14 +02:00 · 2015-02-23 21:04:08 +02:00
parent aa578fd8ec
commit d28430d8ae
5 changed files with 397 additions and 0 deletions
--- a/docs/platforms/atmelavr.rst
+++ b/docs/platforms/atmelavr.rst
@ -29,6 +29,9 @@ Packages
    * - ``tool-avrdude``
      - uploader
      - `AVRDUDE <http://www.nongnu.org/avrdude/>`_
+    * - ``tool-micronucleus``
+      - uploader
+      - `Micronucleus <https://github.com/micronucleus/micronucleus>`_
    * - ``framework-arduinoavr``
      -
      - See below in :ref:`atmelavr_frameworks`
@ -281,6 +284,106 @@ More detailed information you can find here
 `Arduino boards <http://arduino.cc/en/Main/Products>`_.


+Adafruit
+~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller ``board_mcu``
+      - Frequency ``board_f_cpu``
+      - Flash
+      - RAM
+    * - ``flora8``
+      - `Adafruit Flora
+        <http://www.adafruit.com/product/659>`_
+      - ATmega32 ``atmega32u4``
+      - 8 MHz ``8000000L``
+      - 32 Kb
+      - 2.5 Kb
+    * - ``trinket3``
+      - `Adafruit Trinket 8MHz 3.3V LOGIC
+        <http://www.adafruit.com/products/1500>`_
+      - ATtiny85 ``attiny85``
+      - 8 MHz ``16000000L``
+      - 8 Kb
+      - 0.5 Kb
+    * - ``trinket5``
+      - `Adafruit Trinket 16MHz 5V LOGIC
+        <http://www.adafruit.com/products/1501>`_
+      - ATtiny85 ``ATtiny85``
+      - 16 MHz ``16000000L``
+      - 8 Kb
+      - 0.5 Kb
+    * - ``protrinket3``
+      - `Pro Trinket 3V/12MHz (USB)
+        <http://www.adafruit.com/products/2010>`_
+      - ATmega328 ``atmega328p``
+      - 12 MHz ``12000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``protrinket3ftdi``
+      - `Pro Trinket 3V/12MHz (FTDI)
+        <http://www.adafruit.com/products/2010>`_
+      - ATmega328 ``atmega328p``
+      - 12 MHz ``12000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``protrinket5``
+      - `Pro Trinket 5V/16MHz (USB)
+        <http://www.adafruit.com/products/2000>`_
+      - ATmega328 ``atmega328p``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2 Kb
+    * - ``protrinket5ftdi``
+      - `Pro Trinket 5V/16MHz (FTDI)
+        <http://www.adafruit.com/products/2000>`_
+      - ATmega328 ``atmega328p``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2 Kb  
+
+More detailed information you can find here
+`Adafruits boards <https://learn.adafruit.com/category/trinket>`_.
+
+
+Digispark
+~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller ``board_mcu``
+      - Frequency ``board_f_cpu``
+      - Flash
+      - RAM
+    * - ``digispark-tiny``
+      - `Digispark USB Development Board <http://digistump.com/products/1>`_
+      - ATtiny85 ``attiny85``
+      - 16 MHz ``16000000L``
+      - 8 Kb
+      - 0.5 Kb
+    * - ``digispark-pro``
+      - `Digispark Pro (Default 16 Mhz) <http://digistump.com/products/109>`_
+      - ATtiny167 ``attiny167``
+      - 16 MHz ``16000000L``
+      - 16 Kb
+      - 0.5 Kb
+    * - ``digispark-pro32``
+      - `Digispark Pro (16 Mhz) (32 byte buffer) <http://digistump.com/products/109>`_
+      - ATtiny167 ``attiny167``
+      - 16 Mhz ``16000000L``
+      - 16 kb
+      - 0.5 Kb 
+
+More detailed information you can find here
+`Digistump Development Boards <http://digistump.com/wiki/start>`_.
+
 Engduino
 ~~~~~~~~

--- a/docs/platforms/atmelsam.rst
+++ b/docs/platforms/atmelsam.rst
@ -0,0 +1,86 @@
+.. _platform_atmelsam:
+
+Platform ``atmelsam``
+=====================
+
+`Atmel® | SMART <http://www.atmel.com/products/microcontrollers/arm/default.aspx>`_ 
+offers Flash- based ARM® products based on the ARM Cortex-®M0+, Cortex-M3 and 
+Cortex-M4 architectures, ranging from 8KB to 2MB of Flash including a rich 
+peripheral and feature mix.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Alias
+      - Contents
+    * - ``toolchain-gccarmnoneeabi``
+      - toolchain
+      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_,
+        `GDB <http://www.gnu.org/software/gdb/>`_
+    * - ``tool-bossac``
+      - uploader
+      - `Bossac <https://sourceforge.net/projects/b-o-s-s-a/>`_
+    * - ``framework-arduino``
+      -
+      - See below in :ref:`atmelsam_frameworks`
+
+
+.. note::
+    You can install ``atmelsam`` platform with these packages
+    via :ref:`cmd_install` command.
+
+
+.. _atmelsam_frameworks:
+
+Frameworks
+----------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``framework``
+      - Name
+      - Reference
+    * - ``arduino``
+      - Arduino Wiring-based Framework
+      - `Documentation <http://arduino.cc/en/Reference/HomePage>`_
+
+
+Boards
+------
+
+.. note::
+    * You can list pre-configured boards by :ref:`cmd_boards` command
+    * For more detailed ``board`` information please scroll tables below by
+      horizontal.
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller ``board_mcu``
+      - Frequency ``board_f_cpu``
+      - Flash
+      - RAM
+    * - ``due``
+      - `Arduino Due <http://arduino.cc/en/Main/arduinoBoardDue>`_
+      - at91sam3x8e ``cortex-m3``
+      - 84 MHz ``84000000L``
+      - 512 Kb
+      - 32 Kb
+    * - ``digix``
+      - `Digistump DigiX <http://digistump.com/products/50>`_
+      - at91sam3x8e ``cortex-m3``
+      - 84 MHz ``84000000L``
+      - 512 kb
+      - 32 Kb
+
+More detailed information you can find here
+`Atmel SMART ARM-based MCUs <http://www.atmel.com/products/microcontrollers/arm/default.aspx>`_.
--- a/docs/platforms/index.rst
+++ b/docs/platforms/index.rst
@ -15,6 +15,9 @@ MCU, upload protocol or etc. Please use ``board`` option.
    :maxdepth: 2

    atmelavr
+    atmelsam
+    stm32
    timsp430
    titiva
+    teensy
    creating_platform
--- a/docs/platforms/stm32.rst
+++ b/docs/platforms/stm32.rst
@ -0,0 +1,104 @@
+.. _platform_stm32:
+
+Platform ``stm32``
+==================
+
+`The STM32 family of 32-bit Flash microcontrollers <http://www.st.com/web/en/catalog/mmc/FM141/SC1169?sc=stm32>`_ based on the ARM® Cortex®-M processor is designed to offer new degrees of freedom to MCU users. It offers a 32-bit product range that combines very high performance, real-time capabilities, digital signal processing, and low-power, low-voltage operation, while maintaining full integration and ease of development.
+
+The unparalleled and large range of STM32 devices, based on an industry-standard core and accompanied by a vast choice of tools and software, makes this family of products the ideal choice, both for small projects and for entire platform decisions.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Alias
+      - Contents
+    * - ``toolchain-gccarmnoneeabi``
+      - toolchain
+      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_,
+        `GDB <http://www.gnu.org/software/gdb/>`_
+    * - ``tool-stlink``
+      - uploader
+      - `Flash Programmer <https://github.com/texane/stlink>`_
+    * - ``framework-cmsis``
+      -
+      - See below in :ref:`stm32_frameworks`
+    * - ``framework-spl``
+      -
+      - See below in :ref:`stm32_frameworks`
+    * - ``framework-opencm3``
+      -
+      - See below in :ref:`stm32_frameworks`
+
+.. note::
+    You can install ``stm32`` platform with these packages
+    via :ref:`cmd_install` command.
+
+
+.. _stm32_frameworks:
+
+Frameworks
+----------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``framework``
+      - Name
+      - Reference
+    * - ``cmsis``
+      - Vendor-independent hardware abstraction layer for the Cortex-M processor series
+      - `Documentation <http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php>`__
+    * - ``spl``
+      - Standard Peripheral Library for STM32 MCUs
+      - `Documentation <http://www.st.com/web/catalog/tools/FM147/CL1794/SC961/SS1743/PF257890>`__
+    * - ``opencm3``
+      - libOpenCM3 Framework
+      - `Documentation <http://www.libopencm3.org>`__
+
+
+Boards
+------
+
+.. note::
+    * You can list pre-configured boards by :ref:`cmd_boards` command
+    * For more detailed ``board`` information please scroll tables below by
+      horizontal.
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller ``board_mcu``
+      - Frequency ``board_f_cpu``
+      - Flash
+      - RAM
+    * - ``stm32ldiscovery``
+      - `Discovery kit for STM32L151/152 line <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/PF250990?sc=internet/evalboard/product/250990.jsp>`_
+      - stm32l152rbt6 ``cortex-m3``
+      - 32 MHz ``32000000L``
+      - 128 Kb
+      - 16 Kb
+    * - ``stm32f3discovery``
+      - `Discovery kit for STM32F303xx microcontrollers
+        <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/PF254044>`_
+      - stm32f303vct6 ``cortex-m4``
+      - 72 MHz ``72000000L``
+      - 256 Kb
+      - 48 Kb
+    * - ``stm32f4discovery``
+      - `Discovery kit for STM32F407/417 lines
+        <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/PF252419>`_
+      - stm32f407vgt6 ``cortex-m4``
+      - 168 Mhz ``168000000L``
+      - 1 Mb
+      - 192 Kb
+
+More detailed information you can find here
+`STM32 Discovery kits <http://www.st.com/web/en/catalog/tools/FM116/SC959/SS1532/LN1848?icmp=ln1848_pron_pr-stm32f446_dec2014&sc=stm32discovery-pr>`_.
--- a/docs/platforms/teensy.rst
+++ b/docs/platforms/teensy.rst
@ -0,0 +1,101 @@
+.. _platform_teensy:
+
+Platform ``teensy``
+===================
+
+`Teensy <https://www.pjrc.com/teensy/>`_ is a complete USB-based microcontroller development system, in a very small footprint, capable of implementing many types of projects. All programming is done via the USB port. No special programmer is needed, only a standard "Mini-B" USB cable and a PC or Macintosh with a USB port.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Alias
+      - Contents
+    * - ``toolchain-gccarmnoneeabi``
+      - toolchain
+      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_,
+        `GDB <http://www.gnu.org/software/gdb/>`_
+    * - ``toolchain-atmelavr``
+      - toolchain
+      - `avr-gcc <https://gcc.gnu.org/wiki/avr-gcc>`_,
+        `GDB <http://www.gnu.org/software/gdb/>`_,
+        `AVaRICE <http://avarice.sourceforge.net>`_,
+        `SimulAVR <http://www.nongnu.org/simulavr/>`_
+    * - ``tool-teensy``
+      - uploader
+      - `Flash Programmer <https://www.pjrc.com/teensy/loader.html>`_
+    * - ``framework-arduino``
+      -
+      - See below in :ref:`teensy_frameworks`
+
+
+.. note::
+    You can install ``teensy`` platform with these packages
+    via :ref:`cmd_install` command.
+
+
+.. _teensy_frameworks:
+
+Frameworks
+----------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``framework``
+      - Name
+      - Reference
+    * - ``arduino``
+      - Arduino Wiring-based Framework
+      - `Documentation <http://arduino.cc/en/Reference/HomePage>`_
+
+
+Boards
+------
+
+.. note::
+    * You can list pre-configured boards by :ref:`cmd_boards` command
+    * For more detailed ``board`` information please scroll tables below by
+      horizontal.
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller ``board_mcu``
+      - Frequency ``board_f_cpu``
+      - Flash
+      - RAM
+    * - ``teensy20``
+      - `Teensy USB Board, Version 2.0 <https://www.pjrc.com/store/teensy.html>`_
+      - ATmega32 ``atmega32u4``
+      - 16 MHz ``16000000L``
+      - 32 Kb
+      - 2.5 Kb
+    * - ``teensy20pp``
+      - `Teensy++ USB Board, Version 2.0 <https://www.pjrc.com/store/teensypp.html>`_
+      - AT90USB1289 ``at90usb1286``
+      - 16 MHz ``16000000L``
+      - 128 Kb
+      - 8 Kb
+    * - ``teensy30``
+      - `Teensy USB Board, Version 3.0 <https://www.pjrc.com/store/teensy3.html>`_
+      - mk20dx128 ``cortex-m4``
+      - 48 Mhz ``48000000L``
+      - 128 kb
+      - 16 Kb
+    * - ``teensy31``
+      - `Teensy USB Board, Version 3.1 <https://www.pjrc.com/store/teensy31.html>`_
+      - mk20dx256 ``cortex-m4``
+      - 72 Mhz ``72000000L``
+      - 256 kb
+      - 64 Kb
+
+More detailed information you can find here
+`Teensy USB Development Boards <https://www.pjrc.com/teensy/>`_.