noisymime
/
STM32GENERIC
mirror of https://github.com/noisymime/STM32GENERIC.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation

This commit is contained in:
Daniel Fekete 2017-04-18 18:55:15 +02:00
parent 436fabbd95
commit 0c81a54677
3 changed files with 22 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
tools/documentation/mkdocs/index.md
View File

@ -37,10 +37,10 @@ Please go to the [Arduino API implementation](arduino_api.md) page.
## General development direction
* Self-test code to run on a board to check if the API works for that variant.
* Automatic unit test compilation. This ensures that every code will work on every board.
* Automatic unit test compilation. This ensures that a code change does not break other boards.
* Automatic library compilation, to be as arduino-compatible as possible.
* Benchmarks to pinpoint bottlenecks.
* Hacker-friendly: Enable to use HAL/CMSIS; override every IRQ handler.
* Hacker-friendly: Enable to use HAL/CMSIS; enable overriding of every IRQ handler.
* Add DFU/MSC/HID/MIDI to USB. Rewrite USB to PluggableUSB to be more arduino-compatible.
* Create SDIO library
* Create I2S library

23
tools/documentation/mkdocs/menu_options.md
View File

@ -1,7 +1,24 @@
# Upload method
See the [uploading](upload) page.
# USB
TODO documentation
The following options are available for USB
# ST-Link SWD / JTAG
* Serial. A Virtual COM port will be available when connected. Note: On Windows 7, you will need to install drivers located in tool/win/drivers folder.
* Disabled, no USB. Note: If you use USB based uploading method, the board will not reset automatically.
TODO documentation
# Automatic Serial
Select the default for `Serial`:
Automatically selected:
* If the board is Nucleo, automatic Serial is aliased to [SerialUART2](Serial UART) (ST-Link Virtual COM port).
* If the upload method is based on UART (Serial upload, ST-Link), automatic Serial is aliased to [SerialUART1](Serial UART).
* If the upload method is based on USB (DFU), automatic Serial aliased to [SerialUSB](Serial USB).
SerialUSB
SerialUART1

12
tools/documentation/mkdocs/upload.md
View File

@ -6,15 +6,3 @@ Flash Bootloader | USB | USB connector, Bootloader already installed
System bootloader | UART | BOOT0 / BOOT1 pins accessible, USB to UART adapter
SWD / ST-link / JTAG | SWD pins | Programmer hardware, (included in Nucleo and Discovery boards)
Black Magic Probe | |
## Flash Bootloader
## System Bootloader
## SWD / ST-link / JTAG
## Black Magic Probe