From 1c4ae957295ead3546b6941fe8082932de19c966 Mon Sep 17 00:00:00 2001 From: Piotr Esden-Tempski Date: Mon, 19 Jan 2015 19:20:12 -0800 Subject: [PATCH] [README] Coarse sweep to use markup in READMEs. This should improve online readability of the readme files. --- .../lpc/lpc13xx/lpc-p1343/miniblink/README.md | 10 ++-- .../blueboard-lpc1768-h/miniblink/README.md | 10 ++-- .../lpc/lpc43xx/diolan-lpc-4350-db1/README.md | 5 +- .../diolan-lpc-4350-db1/miniblink/README.md | 8 +-- .../lpc/lpc43xx/hackrf-jellybean/README.md | 6 +- .../lpc43xx/hackrf-jellybean/i2c/README.md | 14 ++--- .../hackrf-jellybean/miniblink/README.md | 9 +-- .../miniblink_rom_to_ram/README.md | 9 +-- .../lpc43xx/hackrf-jellybean/ssp/README.md | 56 +++++++++-------- .../hackrf-jellybean/systick/README.md | 4 +- .../stm32/f0/stm32f0-discovery/adc/README.md | 15 +++-- .../f0/stm32f0-discovery/button/README.md | 9 +-- .../f0/stm32f0-discovery/miniblink/README.md | 9 +-- .../stm32f0-discovery/systick_blink/README.md | 13 ++-- .../f0/stm32f0-discovery/usart/README.md | 11 ++-- .../stm32f0-discovery/usart_stdio/README.md | 11 ++-- examples/stm32/f1/lisa-m-1/can/README.md | 2 + .../stm32/f1/lisa-m-1/usb_cdcacm/README.md | 4 +- examples/stm32/f1/lisa-m-1/usb_dfu/README.md | 4 +- examples/stm32/f1/lisa-m-1/usb_hid/README.md | 4 +- .../stm32/f1/lisa-m-2/adc_injec/README.md | 4 +- .../f1/lisa-m-2/adc_injec_timtrig/README.md | 4 +- .../lisa-m-2/adc_injec_timtrig_irq/README.md | 4 +- .../adc_injec_timtrig_irq_4ch/README.md | 4 +- .../stm32/f1/lisa-m-2/adc_regular/README.md | 4 +- examples/stm32/f1/lisa-m-2/can/README.md | 2 + examples/stm32/f1/lisa-m-2/spi/README.md | 8 +-- examples/stm32/f1/lisa-m-2/spi_dma/README.md | 8 +-- .../stm32/f1/lisa-m-2/spi_dma_adv/README.md | 8 +-- examples/stm32/f1/lisa-m-2/usart/README.md | 10 ++-- examples/stm32/f1/mb525/fancyblink/README.md | 8 +-- examples/stm32/f1/mb525/pwmleds/README.md | 8 +-- examples/stm32/f1/obldc-strip/can/README.md | 2 + .../f1/other/adc_temperature_sensor/README.md | 4 +- examples/stm32/f1/other/dma_mem2mem/README.md | 4 +- examples/stm32/f1/other/dogm128/README.md | 4 +- .../f1/other/i2c_stts75_sensor/README.md | 4 +- examples/stm32/f1/other/rtc/README.md | 4 +- examples/stm32/f1/other/systick/README.md | 4 +- .../stm32/f1/other/timer_interrupt/README.md | 4 +- examples/stm32/f1/other/usb_cdcacm/README.md | 4 +- examples/stm32/f1/other/usb_dfu/README.md | 4 +- examples/stm32/f1/other/usb_hid/README.md | 4 +- .../stm32/f1/stm32-h103/fancyblink/README.md | 10 ++-- .../stm32/f1/stm32-h103/miniblink/README.md | 10 ++-- examples/stm32/f1/stm32-h103/spi/README.md | 7 +-- .../stm32/f1/stm32-h103/traceswo/README.md | 4 +- examples/stm32/f1/stm32-h103/usart/README.md | 9 +-- .../stm32/f1/stm32-h103/usb_cdcacm/README.md | 4 +- .../stm32/f1/stm32-h103/usb_dfu/README.md | 4 +- .../stm32/f1/stm32-h103/usb_hid/README.md | 4 +- .../stm32/f1/stm32-h103/usb_iap/README.md | 4 +- .../stm32/f1/stm32-h107/fancyblink/README.md | 10 ++-- .../f1/stm32-h107/flash_rw_example/README.md | 13 ++-- .../stm32/f1/stm32-h107/usb_simple/README.md | 10 ++-- .../stm32/f1/stm32-maple/miniblink/README.md | 10 ++-- examples/stm32/f1/stm32-maple/usart/README.md | 9 +-- .../stm32/f1/stm32-maple/usb_cdcacm/README.md | 8 +-- .../adc-dac-printf/README.md | 25 ++++---- .../f1/stm32vl-discovery/button/README.md | 4 +- .../f1/stm32vl-discovery/fancyblink/README.md | 4 +- .../f1/stm32vl-discovery/miniblink/README.md | 4 +- .../stm32/f1/stm32vl-discovery/rtc/README.md | 4 +- .../stm32/f1/stm32vl-discovery/spi/README.md | 4 +- .../f1/stm32vl-discovery/usart/README.md | 6 +- .../f1/waveshare-open103r/button/README.md | 4 +- .../waveshare-open103r/fancyblink/README.md | 4 +- .../f1/waveshare-open103r/joystick/README.md | 4 +- .../f1/waveshare-open103r/miniblink/README.md | 4 +- .../f1/waveshare-open103r/usbserial/README.md | 4 +- examples/stm32/f2/jobygps/miniblink/README.md | 4 +- .../stm32/f3/stm32f3-discovery/adc/README.md | 7 +-- .../f3/stm32f3-discovery/button/README.md | 4 +- .../f3/stm32f3-discovery/fancyblink/README.md | 4 +- .../stm32/f3/stm32f3-discovery/i2c/README.md | 4 +- .../f3/stm32f3-discovery/miniblink/README.md | 4 +- .../stm32/f3/stm32f3-discovery/spi/README.md | 4 +- .../f3/stm32f3-discovery/usb_cdcacm/README.md | 4 +- .../stm32/f4/other/crypto-basic/README.md | 4 +- examples/stm32/f4/stm32f4-discovery/README.md | 2 + .../adc-dac-printf/README.md | 14 +++-- .../f4/stm32f4-discovery/button/README.md | 9 +-- .../f4/stm32f4-discovery/dac-dma/README.md | 2 + .../f4/stm32f4-discovery/fancyblink/README.md | 9 +-- .../f4/stm32f4-discovery/mandelbrot/README.md | 11 ++-- .../f4/stm32f4-discovery/miniblink/README.md | 9 +-- .../f4/stm32f4-discovery/random/README.md | 9 +-- .../f4/stm32f4-discovery/tick_blink/README.md | 11 ++-- .../f4/stm32f4-discovery/usart/README.md | 11 ++-- .../f4/stm32f4-discovery/usart_irq/README.md | 13 ++-- .../f4/stm32f4-discovery/usb_cdcacm/README.md | 11 ++-- .../f4/stm32f4-discovery/usb_midi/README.md | 16 +++-- .../f4/stm32f4-discovery/usb_msc/README.md | 4 +- .../stm32/f4/stm32f429i-discovery/README.md | 2 + .../adc-dac-printf/README.md | 14 +++-- .../f4/stm32f429i-discovery/button/README.md | 9 +-- .../f4/stm32f429i-discovery/dac-dma/README.md | 2 + .../stm32f429i-discovery/fancyblink/README.md | 9 +-- .../stm32f429i-discovery/mandelbrot/README.md | 11 ++-- .../stm32f429i-discovery/miniblink/README.md | 9 +-- .../f4/stm32f429i-discovery/random/README.md | 9 +-- .../stm32f429i-discovery/tick_blink/README.md | 11 ++-- .../f4/stm32f429i-discovery/usart/README.md | 14 ++--- .../stm32f429i-discovery/usart_irq/README.md | 16 +++-- .../stm32f429i-discovery/usb_cdcacm/README.md | 11 ++-- .../stm32f429i-discovery/usb_midi/README.md | 16 +++-- .../f4/stm32f429i-discovery/usb_msc/README.md | 4 +- .../l0/stm32l0538-disco/miniblink/README.md | 4 +- .../button-irq-printf-lowpower/README.md | 5 +- .../button-irq-printf/README.md | 43 ++++++------- .../l1/stm32l-discovery/lcd-display/README.md | 6 +- .../l1/stm32l-discovery/miniblink/README.md | 4 +- .../usart-semihosting/README.md | 60 +++++++++---------- .../stm32/l1/stm32l-discovery/usart/README.md | 6 +- .../lm3s/lm3s3748-evb/miniblink/README.md | 4 +- .../tiva/lm3s/lm3s811-evb/miniblink/README.md | 4 +- .../miniblink/README.md | 4 +- .../uart_echo_interrupt/README.md | 6 +- .../uart_echo_simple/README.md | 6 +- .../usb_bulk_dev/README.md | 16 ++--- .../usb_to_serial_cdcacm/README.md | 31 +++++----- 121 files changed, 411 insertions(+), 609 deletions(-) diff --git a/examples/lpc/lpc13xx/lpc-p1343/miniblink/README.md b/examples/lpc/lpc13xx/lpc-p1343/miniblink/README.md index eb7d663..c7f8869 100644 --- a/examples/lpc/lpc13xx/lpc-p1343/miniblink/README.md +++ b/examples/lpc/lpc13xx/lpc-p1343/miniblink/README.md @@ -1,9 +1,7 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. -It's intended for the NXP LPC1343-based Olimex LPC-1343 eval board (see -http://olimex.com/dev/lpc-p1343.html for details). It should blink -a LED on the board. +It's intended for the NXP LPC1343-based +[Olimex LPC-1343 eval board](http://olimex.com/dev/lpc-p1343.html for details). +It should blink a LED on the board. diff --git a/examples/lpc/lpc17xx/blueboard-lpc1768-h/miniblink/README.md b/examples/lpc/lpc17xx/blueboard-lpc1768-h/miniblink/README.md index 7354adf..ba52e1e 100644 --- a/examples/lpc/lpc17xx/blueboard-lpc1768-h/miniblink/README.md +++ b/examples/lpc/lpc17xx/blueboard-lpc1768-h/miniblink/README.md @@ -1,9 +1,7 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. -It's intended for the NXP LPC1768-based NGX Blueboard-LPC1768-H eval board (see -http://shop.ngxtechnologies.com/product_info.php?cPath=21&products_id=65). It should blink -a LED on the board. +It's intended for the NXP LPC1768-based +[NGX Blueboard-LPC1768-H eval board](http://shop.ngxtechnologies.com/product_info.php?cPath=21&products_id=65). +It should blink a LED on the board. diff --git a/examples/lpc/lpc43xx/diolan-lpc-4350-db1/README.md b/examples/lpc/lpc43xx/diolan-lpc-4350-db1/README.md index bff2388..234e285 100644 --- a/examples/lpc/lpc43xx/diolan-lpc-4350-db1/README.md +++ b/examples/lpc/lpc43xx/diolan-lpc-4350-db1/README.md @@ -1,3 +1,4 @@ -These example programs are written for the Diolan LPC-4350-DB1: +# README -http://www.diolan.com/lpc4350-features.html +These example programs are written for the +[Diolan LPC-4350-DB1](http://www.diolan.com/lpc4350-features.html) diff --git a/examples/lpc/lpc43xx/diolan-lpc-4350-db1/miniblink/README.md b/examples/lpc/lpc43xx/diolan-lpc-4350-db1/miniblink/README.md index 009b9a9..e593c09 100644 --- a/examples/lpc/lpc43xx/diolan-lpc-4350-db1/miniblink/README.md +++ b/examples/lpc/lpc43xx/diolan-lpc-4350-db1/miniblink/README.md @@ -1,11 +1,7 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. -It's intended for the Diolan LPC-4350-DB1: - -http://www.diolan.com/lpc4350-features.html +It's intended for the [Diolan LPC-4350-DB1](http://www.diolan.com/lpc4350-features.html). It should blink D2 on the board. diff --git a/examples/lpc/lpc43xx/hackrf-jellybean/README.md b/examples/lpc/lpc43xx/hackrf-jellybean/README.md index 07aaeee..5b95aee 100644 --- a/examples/lpc/lpc43xx/hackrf-jellybean/README.md +++ b/examples/lpc/lpc43xx/hackrf-jellybean/README.md @@ -1,4 +1,4 @@ -These example programs are written for the Jellybean development board from the -HackRF project: +# README -https://github.com/mossmann/hackrf +These example programs are written for the Jellybean development board from the +[HackRF project](https://github.com/mossmann/hackrf) diff --git a/examples/lpc/lpc43xx/hackrf-jellybean/i2c/README.md b/examples/lpc/lpc43xx/hackrf-jellybean/i2c/README.md index 86763fe..54d91ca 100644 --- a/examples/lpc/lpc43xx/hackrf-jellybean/i2c/README.md +++ b/examples/lpc/lpc43xx/hackrf-jellybean/i2c/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This program exercises the I2C peripheral on Jellybean's LPC43xx. You can scope SCL on P6 pin 3 and SDA on P6 pin 5. If Lemondrop is connected, LED1 @@ -8,8 +6,8 @@ will illuminate if I2C communication to the Si5351C on Lemondrop is successful. Required Lemondrop -> Jellybean connections: -SCL: Lemondrop P7 pin 3 -> Jellybean P6 pin 3 -SDA: Lemondrop P7 pin 5 -> Jellybean P6 pin 5 -VCC: Lemondrop P4 pin 2, 4, or 6 -> Jellybean P17 pin 2, 4, or 6 -1V8: Lemondrop P11 pin 2, 4, or 6 -> Jellybean P16 pin 2, 4, or 6 -GND: Lemondrop P5 -> Jellybean P13 + SCL: Lemondrop P7 pin 3 -> Jellybean P6 pin 3 + SDA: Lemondrop P7 pin 5 -> Jellybean P6 pin 5 + VCC: Lemondrop P4 pin 2, 4, or 6 -> Jellybean P17 pin 2, 4, or 6 + 1V8: Lemondrop P11 pin 2, 4, or 6 -> Jellybean P16 pin 2, 4, or 6 + GND: Lemondrop P5 -> Jellybean P13 diff --git a/examples/lpc/lpc43xx/hackrf-jellybean/miniblink/README.md b/examples/lpc/lpc43xx/hackrf-jellybean/miniblink/README.md index 556ed92..2b57f5b 100644 --- a/examples/lpc/lpc43xx/hackrf-jellybean/miniblink/README.md +++ b/examples/lpc/lpc43xx/hackrf-jellybean/miniblink/README.md @@ -1,11 +1,8 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. -It's intended for the Jellybean development board from the HackRF project: - -https://github.com/mossmann/hackrf +It's intended for the Jellybean development board from the +[HackRF project](https://github.com/mossmann/hackrf) It should blink LED1 on the board. diff --git a/examples/lpc/lpc43xx/hackrf-jellybean/miniblink_rom_to_ram/README.md b/examples/lpc/lpc43xx/hackrf-jellybean/miniblink_rom_to_ram/README.md index 02960fa..29978a6 100644 --- a/examples/lpc/lpc43xx/hackrf-jellybean/miniblink_rom_to_ram/README.md +++ b/examples/lpc/lpc43xx/hackrf-jellybean/miniblink_rom_to_ram/README.md @@ -1,12 +1,9 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. -It's intended for the Jellybean development board from the HackRF project: - -https://github.com/mossmann/hackrf +It's intended for the Jellybean development board from the +[HackRF project](https://github.com/mossmann/hackrf) It should blink LED1 on the board. This example copy the Code from ROM to RAM and execute code from RAM. diff --git a/examples/lpc/lpc43xx/hackrf-jellybean/ssp/README.md b/examples/lpc/lpc43xx/hackrf-jellybean/ssp/README.md index 5354a53..bcda71c 100644 --- a/examples/lpc/lpc43xx/hackrf-jellybean/ssp/README.md +++ b/examples/lpc/lpc43xx/hackrf-jellybean/ssp/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This program exercises the SSP1 peripheral on Jellybean's LPC43xx. @@ -13,36 +11,36 @@ This program exercises the SSP1 peripheral on Jellybean's LPC43xx. ||------|----------| |-------| -SSP1_MISO: Jellybean P9 SPI Pin6 -SSP1_MOSI: Jellybean P9 SPI Pin4 -SSP1_SCK: Jellybean P9 SPI Pin2 -SSP1_SSEL: Jellybean P9 SPI Pin3 -GND: Can be connected to P12 SD Pin1 + SSP1_MISO: Jellybean P9 SPI Pin6 + SSP1_MOSI: Jellybean P9 SPI Pin4 + SSP1_SCK: Jellybean P9 SPI Pin2 + SSP1_SSEL: Jellybean P9 SPI Pin3 + GND: Can be connected to P12 SD Pin1 PCLK clock source is PLL1 288MHz (from IRC 96MHz boot from SPIFI) Freq = PCLK / (CPSDVSR * [SCR+1]). By default (CPSDVSR=0 => Means MAX Divisor) -SSP1->CR0->SCR = 0x00 => CLK Freq 1.126MHz -SSP1->CR0->SCR = 0x01 => MOSI Freq 566.9KHz -... + SSP1->CR0->SCR = 0x00 => CLK Freq 1.126MHz + SSP1->CR0->SCR = 0x01 => MOSI Freq 566.9KHz + ... -Test Oscilloscpe: -SCR=0, CPSDVSR=32 => CLK 9.025MHz -SCR=1, CPSDVSR=2 => CLK 73MHz -SCR=2, CPSDVSR=2 => CLK 49MHz -SCR=4, CPSDVSR=2 => CLK 29MHz -SCR=8, CPSDVSR=2 => CLK 16MHz -SCR=16, CPSDVSR=2 => CLK 8.5MHz -SCR=32, CPSDVSR=2 => CLK 4.386MHz -SCR=64, CPSDVSR=2 => CLK 2.227MHz -SCR=1, CPSDVSR=64 => CLK 2.262MHz +_Test Oscilloscpe_: + SCR=0, CPSDVSR=32 => CLK 9.025MHz + SCR=1, CPSDVSR=2 => CLK 73MHz + SCR=2, CPSDVSR=2 => CLK 49MHz + SCR=4, CPSDVSR=2 => CLK 29MHz + SCR=8, CPSDVSR=2 => CLK 16MHz + SCR=16, CPSDVSR=2 => CLK 8.5MHz + SCR=32, CPSDVSR=2 => CLK 4.386MHz + SCR=64, CPSDVSR=2 => CLK 2.227MHz + SCR=1, CPSDVSR=64 => CLK 2.262MHz -Theory: -SCR=0, CPSDVSR=32 => 288MHz / (32*(0+1) = 9MHz -SCR=1, CPSDVSR=2 => 288MHz / (2*(1+1) = 72MHz -SCR=4, CPSDVSR=2 => 288MHz / (2*(4+1) = 28.8MHz -SCR=32, CPSDVSR=2 => 288MHz / (2*(32+1) = 4.364MHz -SCR=64, CPSDVSR=2 => 288MHz / (2*(64+1)) = 2.2154MHz -SCR=128, CPSDVSR=2 => 288MHz / (2*(128+1)) = 1.116MHz -SCR=1, CPSDVSR=64 => 288MHz / (64*(1+1)) = 2.25MHz +_Theory_: + SCR=0, CPSDVSR=32 => 288MHz / (32*(0+1) = 9MHz + SCR=1, CPSDVSR=2 => 288MHz / (2*(1+1) = 72MHz + SCR=4, CPSDVSR=2 => 288MHz / (2*(4+1) = 28.8MHz + SCR=32, CPSDVSR=2 => 288MHz / (2*(32+1) = 4.364MHz + SCR=64, CPSDVSR=2 => 288MHz / (2*(64+1)) = 2.2154MHz + SCR=128, CPSDVSR=2 => 288MHz / (2*(128+1)) = 1.116MHz + SCR=1, CPSDVSR=64 => 288MHz / (64*(1+1)) = 2.25MHz diff --git a/examples/lpc/lpc43xx/hackrf-jellybean/systick/README.md b/examples/lpc/lpc43xx/hackrf-jellybean/systick/README.md index 8c32cdc..5310e72 100644 --- a/examples/lpc/lpc43xx/hackrf-jellybean/systick/README.md +++ b/examples/lpc/lpc43xx/hackrf-jellybean/systick/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This program exercises the SysTick Interrupt of ARM CortexM4 on Jellybean's LPC43xx. It also enable Cycle Counter to be used for accurate delay independant from Clock Frequency. diff --git a/examples/stm32/f0/stm32f0-discovery/adc/README.md b/examples/stm32/f0/stm32f0-discovery/adc/README.md index 5e717f6..15c2388 100644 --- a/examples/stm32/f0/stm32f0-discovery/adc/README.md +++ b/examples/stm32/f0/stm32f0-discovery/adc/README.md @@ -1,12 +1,11 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README It's intended for the ST STM32F0DISCOVERY eval board. Measures voltage on the -ADC_IN1 input, and prints it to the serial port. +ADC\_IN1 input, and prints it to the serial port. -Board connections: ------------------- +## Board connections - PA1 (ADC_IN1) Analog input - PA9 (USART1) TTL serial output (38400,8,N,1) +| Port | Function | Description | +| ----- | ----------- | --------------------------------- | +| `PA1` | `(ADC_IN1)` | Analog input | +| `PA9` | `(USART1)` | TTL serial output `(38400,8,N,1)` | diff --git a/examples/stm32/f0/stm32f0-discovery/button/README.md b/examples/stm32/f0/stm32f0-discovery/button/README.md index fdb606f..1b92fba 100644 --- a/examples/stm32/f0/stm32f0-discovery/button/README.md +++ b/examples/stm32/f0/stm32f0-discovery/button/README.md @@ -1,12 +1,9 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example blinks the green LED on the ST STM32F0DISCOVERY eval board. When you press the 'USER' button, the blinking is slower. -Board connections: ------------------- +## Board connections: - +*none required* diff --git a/examples/stm32/f0/stm32f0-discovery/miniblink/README.md b/examples/stm32/f0/stm32f0-discovery/miniblink/README.md index 6c54bfe..21f9854 100644 --- a/examples/stm32/f0/stm32f0-discovery/miniblink/README.md +++ b/examples/stm32/f0/stm32f0-discovery/miniblink/README.md @@ -1,13 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3 and ST STM32F0DISCOVERY eval board. It should blink the blue LED on the board. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f0/stm32f0-discovery/systick_blink/README.md b/examples/stm32/f0/stm32f0-discovery/systick_blink/README.md index db06304..b43f488 100644 --- a/examples/stm32/f0/stm32f0-discovery/systick_blink/README.md +++ b/examples/stm32/f0/stm32f0-discovery/systick_blink/README.md @@ -1,14 +1,13 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README -This example is the same as fancy_blink except that it uses the systick timer +This example is the same as fancy\_blink except that it uses the systick timer to generate time accurate delays. The blue LED flashes four times per second. There is internal reference clock available on MCO output pin. This can be used to debug the PLL clock setup by scope. -Board connections: ------------------- +## Board connections - PA9 (MCO) Internal reference clock +| Port | Function | Description | +| ----- | -------- | ------------------------ | +| `PA9` | `(MCO)` | Internal reference clock | diff --git a/examples/stm32/f0/stm32f0-discovery/usart/README.md b/examples/stm32/f0/stm32f0-discovery/usart/README.md index 2016bbf..85b3626 100644 --- a/examples/stm32/f0/stm32f0-discovery/usart/README.md +++ b/examples/stm32/f0/stm32f0-discovery/usart/README.md @@ -1,13 +1,12 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends repeating sequence of characters "0123456789" on USART1 serial line of ST STM32F0DISCOVERY eval board. The sending is done in a blocking way. -Board connections: ------------------- +## Board connections - PA9 (USART1_TX) TTL serial output (38400,8,N,1) +| Port | Function | Description | +| ----- | ------------- | --------------------------------- | +| `PA9` | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` | diff --git a/examples/stm32/f0/stm32f0-discovery/usart_stdio/README.md b/examples/stm32/f0/stm32f0-discovery/usart_stdio/README.md index b3a103d..1cb60c5 100644 --- a/examples/stm32/f0/stm32f0-discovery/usart_stdio/README.md +++ b/examples/stm32/f0/stm32f0-discovery/usart_stdio/README.md @@ -1,13 +1,12 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends a message "Pass: n" with increasing number n from 0 to 200 on USART1 serial line of ST STM32F0DISCOVERY eval board. The sending is done using newlib library in a blocking way. -Board connections: ------------------- +## Board connections - PA9 (USART1_TX) TTL serial output (38400,8,N,1) +| Port | Function | Description | +| ----- | ------------- | --------------------------------- | +| `PA9` | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` | diff --git a/examples/stm32/f1/lisa-m-1/can/README.md b/examples/stm32/f1/lisa-m-1/can/README.md index 3a14e3b..f0699c0 100644 --- a/examples/stm32/f1/lisa-m-1/can/README.md +++ b/examples/stm32/f1/lisa-m-1/can/README.md @@ -1,3 +1,5 @@ +# README + This test sets up the CAN interface on Lisa/M and transmits 8 bites every 100ms. The first byte is being incremented in each cycle. The demo also receives messages and is displaing the first 4 bits of the first byte on the diff --git a/examples/stm32/f1/lisa-m-1/usb_cdcacm/README.md b/examples/stm32/f1/lisa-m-1/usb_cdcacm/README.md index 2f1ee4b..8c0c1e4 100644 --- a/examples/stm32/f1/lisa-m-1/usb_cdcacm/README.md +++ b/examples/stm32/f1/lisa-m-1/usb_cdcacm/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB CDC-ACM device (aka Virtual Serial Port) to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f1/lisa-m-1/usb_dfu/README.md b/examples/stm32/f1/lisa-m-1/usb_dfu/README.md index 9c0169a..9126843 100644 --- a/examples/stm32/f1/lisa-m-1/usb_dfu/README.md +++ b/examples/stm32/f1/lisa-m-1/usb_dfu/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB Device Firmware Upgrade (DFU) bootloader to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f1/lisa-m-1/usb_hid/README.md b/examples/stm32/f1/lisa-m-1/usb_hid/README.md index 92645c9..0e3e54d 100644 --- a/examples/stm32/f1/lisa-m-1/usb_hid/README.md +++ b/examples/stm32/f1/lisa-m-1/usb_hid/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB Human Interface Device (HID) to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f1/lisa-m-2/adc_injec/README.md b/examples/stm32/f1/lisa-m-2/adc_injec/README.md index f0c7d62..c3dd38f 100644 --- a/examples/stm32/f1/lisa-m-2/adc_injec/README.md +++ b/examples/stm32/f1/lisa-m-2/adc_injec/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is a simple polling example that sends the value read out from the temperature sensor ADC channel of the STM32 to the USART2. diff --git a/examples/stm32/f1/lisa-m-2/adc_injec_timtrig/README.md b/examples/stm32/f1/lisa-m-2/adc_injec_timtrig/README.md index d690f8a..823447c 100644 --- a/examples/stm32/f1/lisa-m-2/adc_injec_timtrig/README.md +++ b/examples/stm32/f1/lisa-m-2/adc_injec_timtrig/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is a simple example that sends the value read out from the temperature sensor ADC channel of the STM32 to the USART2. diff --git a/examples/stm32/f1/lisa-m-2/adc_injec_timtrig_irq/README.md b/examples/stm32/f1/lisa-m-2/adc_injec_timtrig_irq/README.md index 175edce..04e9665 100644 --- a/examples/stm32/f1/lisa-m-2/adc_injec_timtrig_irq/README.md +++ b/examples/stm32/f1/lisa-m-2/adc_injec_timtrig_irq/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is a simple example that sends the value read out from the temperature sensor ADC channel of the STM32 to the USART2. diff --git a/examples/stm32/f1/lisa-m-2/adc_injec_timtrig_irq_4ch/README.md b/examples/stm32/f1/lisa-m-2/adc_injec_timtrig_irq_4ch/README.md index 0339a11..c7cd893 100644 --- a/examples/stm32/f1/lisa-m-2/adc_injec_timtrig_irq_4ch/README.md +++ b/examples/stm32/f1/lisa-m-2/adc_injec_timtrig_irq_4ch/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is a simple example that sends the values read out from four ADC channels of the STM32 to the USART2. diff --git a/examples/stm32/f1/lisa-m-2/adc_regular/README.md b/examples/stm32/f1/lisa-m-2/adc_regular/README.md index 3b583ff..7da5538 100644 --- a/examples/stm32/f1/lisa-m-2/adc_regular/README.md +++ b/examples/stm32/f1/lisa-m-2/adc_regular/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is a simple polling example that sends the value read out from the temperature sensor ADC channel of the STM32 to the USART2. diff --git a/examples/stm32/f1/lisa-m-2/can/README.md b/examples/stm32/f1/lisa-m-2/can/README.md index 3a14e3b..f0699c0 100644 --- a/examples/stm32/f1/lisa-m-2/can/README.md +++ b/examples/stm32/f1/lisa-m-2/can/README.md @@ -1,3 +1,5 @@ +# README + This test sets up the CAN interface on Lisa/M and transmits 8 bites every 100ms. The first byte is being incremented in each cycle. The demo also receives messages and is displaing the first 4 bits of the first byte on the diff --git a/examples/stm32/f1/lisa-m-2/spi/README.md b/examples/stm32/f1/lisa-m-2/spi/README.md index 829f2f4..9eed33e 100644 --- a/examples/stm32/f1/lisa-m-2/spi/README.md +++ b/examples/stm32/f1/lisa-m-2/spi/README.md @@ -1,9 +1,7 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README -This example program demonstrates simple SPI transceive on Lisa/M 2.0 board -(http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details). +This example program demonstrates simple SPI transceive on +[Lisa/M 2.0 board](http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details). The terminal settings for the receiving device/PC are 9600 8n1. diff --git a/examples/stm32/f1/lisa-m-2/spi_dma/README.md b/examples/stm32/f1/lisa-m-2/spi_dma/README.md index 3c03e2d..009cf88 100644 --- a/examples/stm32/f1/lisa-m-2/spi_dma/README.md +++ b/examples/stm32/f1/lisa-m-2/spi_dma/README.md @@ -1,9 +1,7 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README -This example program demonstrates SPI transceive with DMA on Lisa/M 2.0 board -(http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details). +This example program demonstrates SPI transceive with DMA on +[Lisa/M 2.0 board](http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details). The terminal settings for the receiving device/PC are 9600 8n1. diff --git a/examples/stm32/f1/lisa-m-2/spi_dma_adv/README.md b/examples/stm32/f1/lisa-m-2/spi_dma_adv/README.md index 7d279c2..6a12578 100644 --- a/examples/stm32/f1/lisa-m-2/spi_dma_adv/README.md +++ b/examples/stm32/f1/lisa-m-2/spi_dma_adv/README.md @@ -1,9 +1,7 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README -This example program demonstrates SPI transceive with DMA on Lisa/M 2.0 board -(http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details). +This example program demonstrates SPI transceive with DMA on +[Lisa/M 2.0 board](http://paparazzi.enac.fr/wiki/Lisa/M_v20 for details). The terminal settings for the receiving device/PC are 9600 8n1. diff --git a/examples/stm32/f1/lisa-m-2/usart/README.md b/examples/stm32/f1/lisa-m-2/usart/README.md index 5a3f316..e86c2db 100644 --- a/examples/stm32/f1/lisa-m-2/usart/README.md +++ b/examples/stm32/f1/lisa-m-2/usart/README.md @@ -1,12 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README -This example program sends some characters on USART2 on Lisa/M 2.0 board -(see http://paparazzi.enac.fr/wiki/LisaM for details). +This example program sends some characters on USART2 on +[Lisa/M 2.0 board](see http://paparazzi.enac.fr/wiki/LisaM for details). The terminal settings for the receiving device/PC are 38400 8n1. -The sending is done in a blocking way in the code, see the usart_irq example +The sending is done in a blocking way in the code, see the usart\_irq example for a more elaborate USART example. diff --git a/examples/stm32/f1/mb525/fancyblink/README.md b/examples/stm32/f1/mb525/fancyblink/README.md index 497b689..62eba9d 100644 --- a/examples/stm32/f1/mb525/fancyblink/README.md +++ b/examples/stm32/f1/mb525/fancyblink/README.md @@ -1,10 +1,8 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is a blink example program using libopencm3. -It's intended for the ST STM32-based MB525 eval board (see -http://www.st.com/stonline/products/literature/um/13472.htm for details). +It's intended for the ST STM32-based +[MB525 eval board](http://www.st.com/stonline/products/literature/um/13472.htm for details). It should blink the LEDs on the board. diff --git a/examples/stm32/f1/mb525/pwmleds/README.md b/examples/stm32/f1/mb525/pwmleds/README.md index e9c37e0..7403138 100644 --- a/examples/stm32/f1/mb525/pwmleds/README.md +++ b/examples/stm32/f1/mb525/pwmleds/README.md @@ -1,9 +1,7 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is a PWM based LED fading example using libopencm3. -It's intended for the ST STM32-based MB525 eval board (see -http://www.st.com/stonline/products/literature/um/13472.htm for details). +It's intended for the ST STM32-based +[MB525 eval board](http://www.st.com/stonline/products/literature/um/13472.htm for details). diff --git a/examples/stm32/f1/obldc-strip/can/README.md b/examples/stm32/f1/obldc-strip/can/README.md index 3a14e3b..f0699c0 100644 --- a/examples/stm32/f1/obldc-strip/can/README.md +++ b/examples/stm32/f1/obldc-strip/can/README.md @@ -1,3 +1,5 @@ +# README + This test sets up the CAN interface on Lisa/M and transmits 8 bites every 100ms. The first byte is being incremented in each cycle. The demo also receives messages and is displaing the first 4 bits of the first byte on the diff --git a/examples/stm32/f1/other/adc_temperature_sensor/README.md b/examples/stm32/f1/other/adc_temperature_sensor/README.md index e17f8f8..1cbdef4 100644 --- a/examples/stm32/f1/other/adc_temperature_sensor/README.md +++ b/examples/stm32/f1/other/adc_temperature_sensor/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends some characters on USART1. Afterwards it read out the internal temperature sensor of the STM32 and diff --git a/examples/stm32/f1/other/dma_mem2mem/README.md b/examples/stm32/f1/other/dma_mem2mem/README.md index 3fb5320..ee61f02 100644 --- a/examples/stm32/f1/other/dma_mem2mem/README.md +++ b/examples/stm32/f1/other/dma_mem2mem/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This program demonstrates a little DMA MEM2MEM transfer. A string is sent out to USART1 and afterwards copied by DMA to another memory location. To check diff --git a/examples/stm32/f1/other/dogm128/README.md b/examples/stm32/f1/other/dogm128/README.md index dbf82a0..7e53de2 100644 --- a/examples/stm32/f1/other/dogm128/README.md +++ b/examples/stm32/f1/other/dogm128/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program writes some text on an DOGM128 LCD display connected to SPI2. diff --git a/examples/stm32/f1/other/i2c_stts75_sensor/README.md b/examples/stm32/f1/other/i2c_stts75_sensor/README.md index 91e3ff6..2d5132e 100644 --- a/examples/stm32/f1/other/i2c_stts75_sensor/README.md +++ b/examples/stm32/f1/other/i2c_stts75_sensor/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends some characters on USART1. Afterwards it connects to an STTS75 sensor (ST LM75 compatible) diff --git a/examples/stm32/f1/other/rtc/README.md b/examples/stm32/f1/other/rtc/README.md index f1e3975..09dd24b 100644 --- a/examples/stm32/f1/other/rtc/README.md +++ b/examples/stm32/f1/other/rtc/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is a small RTC example project. diff --git a/examples/stm32/f1/other/systick/README.md b/examples/stm32/f1/other/systick/README.md index affb4b8..c2d88af 100644 --- a/examples/stm32/f1/other/systick/README.md +++ b/examples/stm32/f1/other/systick/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program blinks a LED on PortB Pin 6. 1 second on / 1 second off. Blinking is done via the systick timer interrupt. diff --git a/examples/stm32/f1/other/timer_interrupt/README.md b/examples/stm32/f1/other/timer_interrupt/README.md index e6a22c4..f6edeeb 100644 --- a/examples/stm32/f1/other/timer_interrupt/README.md +++ b/examples/stm32/f1/other/timer_interrupt/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program blinks a LED on PortB Pin 6. 1 second on / 1 second off. Blinking is made only with the timer interrupt of the TIM2 timer. diff --git a/examples/stm32/f1/other/usb_cdcacm/README.md b/examples/stm32/f1/other/usb_cdcacm/README.md index 2f1ee4b..8c0c1e4 100644 --- a/examples/stm32/f1/other/usb_cdcacm/README.md +++ b/examples/stm32/f1/other/usb_cdcacm/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB CDC-ACM device (aka Virtual Serial Port) to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f1/other/usb_dfu/README.md b/examples/stm32/f1/other/usb_dfu/README.md index 9c0169a..9126843 100644 --- a/examples/stm32/f1/other/usb_dfu/README.md +++ b/examples/stm32/f1/other/usb_dfu/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB Device Firmware Upgrade (DFU) bootloader to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f1/other/usb_hid/README.md b/examples/stm32/f1/other/usb_hid/README.md index 92645c9..0e3e54d 100644 --- a/examples/stm32/f1/other/usb_hid/README.md +++ b/examples/stm32/f1/other/usb_hid/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB Human Interface Device (HID) to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f1/stm32-h103/fancyblink/README.md b/examples/stm32/f1/stm32-h103/fancyblink/README.md index bdb6ec8..f8e9d5c 100644 --- a/examples/stm32/f1/stm32-h103/fancyblink/README.md +++ b/examples/stm32/f1/stm32-h103/fancyblink/README.md @@ -1,10 +1,8 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is small LED blinking example program using libopencm3. -It's intended for the ST STM32-based Olimex STM32-H103 eval board (see -http://olimex.com/dev/stm32-h103.html for details). It should blink -the LED on the board. +It's intended for the ST STM32-based +[Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html). +It should blink the LED on the board. diff --git a/examples/stm32/f1/stm32-h103/miniblink/README.md b/examples/stm32/f1/stm32-h103/miniblink/README.md index 0e046f2..9d46f1f 100644 --- a/examples/stm32/f1/stm32-h103/miniblink/README.md +++ b/examples/stm32/f1/stm32-h103/miniblink/README.md @@ -1,10 +1,8 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. -It's intended for the ST STM32-based Olimex STM32-H103 eval board (see -http://olimex.com/dev/stm32-h103.html for details). It should blink -the LED on the board. +It's intended for the ST STM32-based +[Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html). +It should blink the LED on the board. diff --git a/examples/stm32/f1/stm32-h103/spi/README.md b/examples/stm32/f1/stm32-h103/spi/README.md index d4714c2..aa20111 100644 --- a/examples/stm32/f1/stm32-h103/spi/README.md +++ b/examples/stm32/f1/stm32-h103/spi/README.md @@ -1,8 +1,5 @@ -------------------------------------------------------------------------------- -README -------------------------------------------------------------------------------- +# README This example program repeatedly sends characters on SPI1 on the ST STM32-based -Olimex STM32-H103 eval board (see http://olimex.com/dev/stm32-h103.html -for details). +[Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html). diff --git a/examples/stm32/f1/stm32-h103/traceswo/README.md b/examples/stm32/f1/stm32-h103/traceswo/README.md index 6746f94..efad0b9 100644 --- a/examples/stm32/f1/stm32-h103/traceswo/README.md +++ b/examples/stm32/f1/stm32-h103/traceswo/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This experimental program sends some characters on the TRACESWO pin using the Instrumentation Trace Macrocell (ITM) and Trace Port Interface Unit (TPIU). diff --git a/examples/stm32/f1/stm32-h103/usart/README.md b/examples/stm32/f1/stm32-h103/usart/README.md index ecd7269..f6c0b1e 100644 --- a/examples/stm32/f1/stm32-h103/usart/README.md +++ b/examples/stm32/f1/stm32-h103/usart/README.md @@ -1,13 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends some characters on USART3 on the ST STM32-based -Olimex STM32-H103 eval board (see http://olimex.com/dev/stm32-h103.html -for details). +[Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html). The terminal settings for the receiving device/PC are 38400 8n1. -The sending is done in a blocking way in the code, see the usart_irq example +The sending is done in a blocking way in the code, see the usart\_irq example for a more elaborate USART example. diff --git a/examples/stm32/f1/stm32-h103/usb_cdcacm/README.md b/examples/stm32/f1/stm32-h103/usb_cdcacm/README.md index 2f1ee4b..8c0c1e4 100644 --- a/examples/stm32/f1/stm32-h103/usb_cdcacm/README.md +++ b/examples/stm32/f1/stm32-h103/usb_cdcacm/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB CDC-ACM device (aka Virtual Serial Port) to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f1/stm32-h103/usb_dfu/README.md b/examples/stm32/f1/stm32-h103/usb_dfu/README.md index 9c0169a..9126843 100644 --- a/examples/stm32/f1/stm32-h103/usb_dfu/README.md +++ b/examples/stm32/f1/stm32-h103/usb_dfu/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB Device Firmware Upgrade (DFU) bootloader to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f1/stm32-h103/usb_hid/README.md b/examples/stm32/f1/stm32-h103/usb_hid/README.md index 48a9b39..98d3caa 100644 --- a/examples/stm32/f1/stm32-h103/usb_hid/README.md +++ b/examples/stm32/f1/stm32-h103/usb_hid/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB Human Interface Device (HID) to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f1/stm32-h103/usb_iap/README.md b/examples/stm32/f1/stm32-h103/usb_iap/README.md index 2966684..cc6fc50 100644 --- a/examples/stm32/f1/stm32-h103/usb_iap/README.md +++ b/examples/stm32/f1/stm32-h103/usb_iap/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB bootloader for the Paparazzi project. diff --git a/examples/stm32/f1/stm32-h107/fancyblink/README.md b/examples/stm32/f1/stm32-h107/fancyblink/README.md index 6f1ac39..30e1f2d 100644 --- a/examples/stm32/f1/stm32-h107/fancyblink/README.md +++ b/examples/stm32/f1/stm32-h107/fancyblink/README.md @@ -1,10 +1,8 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is small LED blinking example program using libopencm3. -It's intended for the ST STM32-based Olimex STM32-H107 eval board (see -http://olimex.com/dev/stm32-h107.html for details). It should blink -the LED on the board. +It's intended for the ST STM32-based +[Olimex STM32-H107 eval board](http://olimex.com/dev/stm32-h107.html). +It should blink the LED on the board. diff --git a/examples/stm32/f1/stm32-h107/flash_rw_example/README.md b/examples/stm32/f1/stm32-h107/flash_rw_example/README.md index 4c7f20c..6ddbe6f 100644 --- a/examples/stm32/f1/stm32-h107/flash_rw_example/README.md +++ b/examples/stm32/f1/stm32-h107/flash_rw_example/README.md @@ -1,8 +1,9 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README -This small example program operates on internal FLASH memory by using libopencm3. +This small example program operates on internal FLASH memory by using +libopencm3. -It's intended for all devboards with STM32f107 microcontrollers. To use this example it is essential to use USART1 port. -It writes text string entered via serial port terminal (ex. teraterm) into internal FLASH memory and then it reads it. \ No newline at end of file +It's intended for all devboards with STM32f107 microcontrollers. To use this +example it is essential to use USART1 port. It writes text string entered via +serial port terminal (ex. teraterm) into internal FLASH memory and then it +reads it. diff --git a/examples/stm32/f1/stm32-h107/usb_simple/README.md b/examples/stm32/f1/stm32-h107/usb_simple/README.md index 93d4f03..03ec0f5 100644 --- a/examples/stm32/f1/stm32-h107/usb_simple/README.md +++ b/examples/stm32/f1/stm32-h107/usb_simple/README.md @@ -1,10 +1,8 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is small USB controlled LED blinking example program using libopencm3. -It's intended for the ST STM32-based Olimex STM32-H107 eval board (see -http://olimex.com/dev/stm32-h107.html for details). The usbtest.py -script in this directory maybe used to control the LED. +It's intended for the ST STM32-based +[Olimex STM32-H107 eval board](http://olimex.com/dev/stm32-h107.html). +The usbtest.py script in this directory maybe used to control the LED. diff --git a/examples/stm32/f1/stm32-maple/miniblink/README.md b/examples/stm32/f1/stm32-maple/miniblink/README.md index 6e38d7a..33d9a6a 100644 --- a/examples/stm32/f1/stm32-maple/miniblink/README.md +++ b/examples/stm32/f1/stm32-maple/miniblink/README.md @@ -1,9 +1,7 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. -It's intended for the ST STM32-based Leaf Labs Maple board (see -http://leaflabs.com for details). It should blink the LED on the board. - +It's intended for the ST STM32-based +[Leaf Labs Maple board](http://leaflabs.com). +It should blink the LED on the board. diff --git a/examples/stm32/f1/stm32-maple/usart/README.md b/examples/stm32/f1/stm32-maple/usart/README.md index ecd7269..f6c0b1e 100644 --- a/examples/stm32/f1/stm32-maple/usart/README.md +++ b/examples/stm32/f1/stm32-maple/usart/README.md @@ -1,13 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends some characters on USART3 on the ST STM32-based -Olimex STM32-H103 eval board (see http://olimex.com/dev/stm32-h103.html -for details). +[Olimex STM32-H103 eval board](http://olimex.com/dev/stm32-h103.html). The terminal settings for the receiving device/PC are 38400 8n1. -The sending is done in a blocking way in the code, see the usart_irq example +The sending is done in a blocking way in the code, see the usart\_irq example for a more elaborate USART example. diff --git a/examples/stm32/f1/stm32-maple/usb_cdcacm/README.md b/examples/stm32/f1/stm32-maple/usb_cdcacm/README.md index 2f1ee4b..dd7bada 100644 --- a/examples/stm32/f1/stm32-maple/usb_cdcacm/README.md +++ b/examples/stm32/f1/stm32-maple/usb_cdcacm/README.md @@ -1,7 +1,5 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README -This example implements a USB CDC-ACM device (aka Virtual Serial Port) -to demonstrate the use of the USB device stack. +This example implements a USB CDC-ACM device (aka Virtual Serial Port) to +demonstrate the use of the USB device stack. diff --git a/examples/stm32/f1/stm32vl-discovery/adc-dac-printf/README.md b/examples/stm32/f1/stm32vl-discovery/adc-dac-printf/README.md index 796cba2..805308d 100644 --- a/examples/stm32/f1/stm32vl-discovery/adc-dac-printf/README.md +++ b/examples/stm32/f1/stm32vl-discovery/adc-dac-printf/README.md @@ -1,17 +1,20 @@ -Console on PA2 (tx only) 115200@8n1 +# README -* Prints the ADC value on PA0 (adc channel 0) on the console +Console on `PA2` (tx only) 115200@8n1 + +* Prints the ADC value on `PA0` (adc channel 0) on the console * Echos half that ADC value out to DAC channel 2 on PA5 -* Prints the ADC value of PA1 (adc channel 1) to the console. +* Prints the ADC value of `PA1` (adc channel 1) to the console. Recommended wiring: -* pot or any resistor ladder to PA0 -* jumper from PA5 to PA1 +* pot or any resistor ladder to `PA0` +* jumper from `PA5` to `PA1` example output: -... -tick: 228: adc0= 3950, target adc1=1975, adc1=1979 -tick: 229: adc0= 3949, target adc1=1974, adc1=1978 -tick: 230: adc0= 3950, target adc1=1975, adc1=1979 -tick: 231: adc0= 3949, target adc1=1974, adc1=1978 -... + + ... + tick: 228: adc0= 3950, target adc1=1975, adc1=1979 + tick: 229: adc0= 3949, target adc1=1974, adc1=1978 + tick: 230: adc0= 3950, target adc1=1975, adc1=1979 + tick: 231: adc0= 3949, target adc1=1974, adc1=1978 + ... diff --git a/examples/stm32/f1/stm32vl-discovery/button/README.md b/examples/stm32/f1/stm32vl-discovery/button/README.md index 38bc1ea..7748818 100644 --- a/examples/stm32/f1/stm32vl-discovery/button/README.md +++ b/examples/stm32/f1/stm32vl-discovery/button/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example blinks the green LED on the ST STM32VLDISCOVERY eval board. diff --git a/examples/stm32/f1/stm32vl-discovery/fancyblink/README.md b/examples/stm32/f1/stm32vl-discovery/fancyblink/README.md index b5d794c..6ce2055 100644 --- a/examples/stm32/f1/stm32vl-discovery/fancyblink/README.md +++ b/examples/stm32/f1/stm32vl-discovery/fancyblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. diff --git a/examples/stm32/f1/stm32vl-discovery/miniblink/README.md b/examples/stm32/f1/stm32vl-discovery/miniblink/README.md index cffce60..6653e9f 100644 --- a/examples/stm32/f1/stm32vl-discovery/miniblink/README.md +++ b/examples/stm32/f1/stm32vl-discovery/miniblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. diff --git a/examples/stm32/f1/stm32vl-discovery/rtc/README.md b/examples/stm32/f1/stm32vl-discovery/rtc/README.md index d4509e4..4e63919 100644 --- a/examples/stm32/f1/stm32vl-discovery/rtc/README.md +++ b/examples/stm32/f1/stm32vl-discovery/rtc/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is a small RTC example project. diff --git a/examples/stm32/f1/stm32vl-discovery/spi/README.md b/examples/stm32/f1/stm32vl-discovery/spi/README.md index 955ad33..9b0251f 100644 --- a/examples/stm32/f1/stm32vl-discovery/spi/README.md +++ b/examples/stm32/f1/stm32vl-discovery/spi/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program demonstrates simple SPI transceive on stm32vl discovery board. diff --git a/examples/stm32/f1/stm32vl-discovery/usart/README.md b/examples/stm32/f1/stm32vl-discovery/usart/README.md index 6d09139..6432415 100644 --- a/examples/stm32/f1/stm32vl-discovery/usart/README.md +++ b/examples/stm32/f1/stm32vl-discovery/usart/README.md @@ -1,12 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends some characters on USART1 on the ST STM32VLDISCOVERY eval board. The terminal settings for the receiving device/PC are 38400 8n1. -The sending is done in a blocking way in the code, see the usart_irq example +The sending is done in a blocking way in the code, see the usart\_irq example for a more elaborate USART example. diff --git a/examples/stm32/f1/waveshare-open103r/button/README.md b/examples/stm32/f1/waveshare-open103r/button/README.md index c9e0735..8d1d729 100644 --- a/examples/stm32/f1/waveshare-open103r/button/README.md +++ b/examples/stm32/f1/waveshare-open103r/button/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example blinks LED1 on the WaveShare Open103R eval board. diff --git a/examples/stm32/f1/waveshare-open103r/fancyblink/README.md b/examples/stm32/f1/waveshare-open103r/fancyblink/README.md index a4209f1..053e525 100644 --- a/examples/stm32/f1/waveshare-open103r/fancyblink/README.md +++ b/examples/stm32/f1/waveshare-open103r/fancyblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This program will interleave the blinking of two sets of LEDs. LED1 and LED3 will blink at the same time and LED2 and LED4 will blink at diff --git a/examples/stm32/f1/waveshare-open103r/joystick/README.md b/examples/stm32/f1/waveshare-open103r/joystick/README.md index 3fffc3c..b317bf8 100644 --- a/examples/stm32/f1/waveshare-open103r/joystick/README.md +++ b/examples/stm32/f1/waveshare-open103r/joystick/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example uses the joystick to control the four LEDs on the WaveShare Open103R eval board. Joystick directions referenced here are diff --git a/examples/stm32/f1/waveshare-open103r/miniblink/README.md b/examples/stm32/f1/waveshare-open103r/miniblink/README.md index 5e81bcd..0b88504 100644 --- a/examples/stm32/f1/waveshare-open103r/miniblink/README.md +++ b/examples/stm32/f1/waveshare-open103r/miniblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. diff --git a/examples/stm32/f1/waveshare-open103r/usbserial/README.md b/examples/stm32/f1/waveshare-open103r/usbserial/README.md index 2f0ef4f..f0375a7 100644 --- a/examples/stm32/f1/waveshare-open103r/usbserial/README.md +++ b/examples/stm32/f1/waveshare-open103r/usbserial/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example uses the USB port as a serial port and implements a loopback interface that immediately echos back whatever it receives. After flashing the evaluation board with the usbserial program and connecting it to a host computer with a USB cable, you can run the echo.py command as follows: diff --git a/examples/stm32/f2/jobygps/miniblink/README.md b/examples/stm32/f2/jobygps/miniblink/README.md index 0130112..3abe858 100644 --- a/examples/stm32/f2/jobygps/miniblink/README.md +++ b/examples/stm32/f2/jobygps/miniblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. diff --git a/examples/stm32/f3/stm32f3-discovery/adc/README.md b/examples/stm32/f3/stm32f3-discovery/adc/README.md index 224f51f..7ffe279 100644 --- a/examples/stm32/f3/stm32f3-discovery/adc/README.md +++ b/examples/stm32/f3/stm32f3-discovery/adc/README.md @@ -1,9 +1,8 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. -It's intended for the ST STM32F3DISCOVERY eval board. It should read from the ADC1_IN1 (PA0) pin its voltage and print it in the LEDs. +It's intended for the ST STM32F3DISCOVERY eval board. It should read from the +`ADC1_IN1 (PA0)` pin its voltage and print it in the LEDs. diff --git a/examples/stm32/f3/stm32f3-discovery/button/README.md b/examples/stm32/f3/stm32f3-discovery/button/README.md index 157328c..0d43f81 100644 --- a/examples/stm32/f3/stm32f3-discovery/button/README.md +++ b/examples/stm32/f3/stm32f3-discovery/button/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example blinks the green LED on the ST STM32F3DISCOVERY eval board. diff --git a/examples/stm32/f3/stm32f3-discovery/fancyblink/README.md b/examples/stm32/f3/stm32f3-discovery/fancyblink/README.md index ade0bf7..21e20ff 100644 --- a/examples/stm32/f3/stm32f3-discovery/fancyblink/README.md +++ b/examples/stm32/f3/stm32f3-discovery/fancyblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. diff --git a/examples/stm32/f3/stm32f3-discovery/i2c/README.md b/examples/stm32/f3/stm32f3-discovery/i2c/README.md index 4794c3a..58f234f 100644 --- a/examples/stm32/f3/stm32f3-discovery/i2c/README.md +++ b/examples/stm32/f3/stm32f3-discovery/i2c/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README I2C example reading from the stm32f3discovery accelerometer. diff --git a/examples/stm32/f3/stm32f3-discovery/miniblink/README.md b/examples/stm32/f3/stm32f3-discovery/miniblink/README.md index 788b25e..128731e 100644 --- a/examples/stm32/f3/stm32f3-discovery/miniblink/README.md +++ b/examples/stm32/f3/stm32f3-discovery/miniblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. diff --git a/examples/stm32/f3/stm32f3-discovery/spi/README.md b/examples/stm32/f3/stm32f3-discovery/spi/README.md index 9403ea0..8cccaf6 100644 --- a/examples/stm32/f3/stm32f3-discovery/spi/README.md +++ b/examples/stm32/f3/stm32f3-discovery/spi/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README SPI example reading from the stm32f3discovery gyroscope. diff --git a/examples/stm32/f3/stm32f3-discovery/usb_cdcacm/README.md b/examples/stm32/f3/stm32f3-discovery/usb_cdcacm/README.md index 2f1ee4b..8c0c1e4 100644 --- a/examples/stm32/f3/stm32f3-discovery/usb_cdcacm/README.md +++ b/examples/stm32/f3/stm32f3-discovery/usb_cdcacm/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB CDC-ACM device (aka Virtual Serial Port) to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f4/other/crypto-basic/README.md b/examples/stm32/f4/other/crypto-basic/README.md index e9e3198..7cbb429 100644 --- a/examples/stm32/f4/other/crypto-basic/README.md +++ b/examples/stm32/f4/other/crypto-basic/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program is for demonstrating of use Crypto Controller on STM32F417 board. diff --git a/examples/stm32/f4/stm32f4-discovery/README.md b/examples/stm32/f4/stm32f4-discovery/README.md index 1a57862..b31c6b6 100644 --- a/examples/stm32/f4/stm32f4-discovery/README.md +++ b/examples/stm32/f4/stm32f4-discovery/README.md @@ -1,3 +1,5 @@ +# README + This directory contains examples for the _original_ stm32f4 discovery. The PCB should be labelled either MB997A or MB997B, and contains a user USB port, and an audio dac on board, along with a MEMs microphone and an diff --git a/examples/stm32/f4/stm32f4-discovery/adc-dac-printf/README.md b/examples/stm32/f4/stm32f4-discovery/adc-dac-printf/README.md index 796cba2..e09f36f 100644 --- a/examples/stm32/f4/stm32f4-discovery/adc-dac-printf/README.md +++ b/examples/stm32/f4/stm32f4-discovery/adc-dac-printf/README.md @@ -1,3 +1,5 @@ +# README + Console on PA2 (tx only) 115200@8n1 * Prints the ADC value on PA0 (adc channel 0) on the console @@ -9,9 +11,9 @@ Recommended wiring: * jumper from PA5 to PA1 example output: -... -tick: 228: adc0= 3950, target adc1=1975, adc1=1979 -tick: 229: adc0= 3949, target adc1=1974, adc1=1978 -tick: 230: adc0= 3950, target adc1=1975, adc1=1979 -tick: 231: adc0= 3949, target adc1=1974, adc1=1978 -... + ... + tick: 228: adc0= 3950, target adc1=1975, adc1=1979 + tick: 229: adc0= 3949, target adc1=1974, adc1=1978 + tick: 230: adc0= 3950, target adc1=1975, adc1=1979 + tick: 231: adc0= 3949, target adc1=1974, adc1=1978 + ... diff --git a/examples/stm32/f4/stm32f4-discovery/button/README.md b/examples/stm32/f4/stm32f4-discovery/button/README.md index c0f3875..6688adb 100644 --- a/examples/stm32/f4/stm32f4-discovery/button/README.md +++ b/examples/stm32/f4/stm32f4-discovery/button/README.md @@ -1,12 +1,9 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example blinks the GREEN LED on the ST STM32F4DISCOVERY eval board. When you press the 'USER' button, the blinking is slower. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f4/stm32f4-discovery/dac-dma/README.md b/examples/stm32/f4/stm32f4-discovery/dac-dma/README.md index 3b53fc7..8fefa61 100644 --- a/examples/stm32/f4/stm32f4-discovery/dac-dma/README.md +++ b/examples/stm32/f4/stm32f4-discovery/dac-dma/README.md @@ -1,3 +1,5 @@ +# README + DAC test with DMA and timer 2 trigger Timer 2 is setup to provide a trigger signal on OC1, with a period of 142 Hz diff --git a/examples/stm32/f4/stm32f4-discovery/fancyblink/README.md b/examples/stm32/f4/stm32f4-discovery/fancyblink/README.md index ef7320e..4dd7280 100644 --- a/examples/stm32/f4/stm32f4-discovery/fancyblink/README.md +++ b/examples/stm32/f4/stm32f4-discovery/fancyblink/README.md @@ -1,13 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. It's intended for the ST STM32F4DISCOVERY eval board. It should blink the LEDs on the board. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f4/stm32f4-discovery/mandelbrot/README.md b/examples/stm32/f4/stm32f4-discovery/mandelbrot/README.md index b179088..70acd49 100644 --- a/examples/stm32/f4/stm32f4-discovery/mandelbrot/README.md +++ b/examples/stm32/f4/stm32f4-discovery/mandelbrot/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program demonstrates the floating point coprocessor usage on the ST STM32F4DISCOVERY eval board. @@ -8,7 +6,8 @@ the ST STM32F4DISCOVERY eval board. A mandelbrot fractal is calculated and sent as "ascii-art" image through the USART2. -Board connections: ------------------- +## Board connections - PA2 (USART2_TX) TTL serial output (38400,8,N,1) +| Port | Function | Description | +| ----- | ------------- | --------------------------------- | +| `PA2` | `(USART2_TX)` | TTL serial output `(38400,8,N,1)` | diff --git a/examples/stm32/f4/stm32f4-discovery/miniblink/README.md b/examples/stm32/f4/stm32f4-discovery/miniblink/README.md index 2565682..ba380c0 100644 --- a/examples/stm32/f4/stm32f4-discovery/miniblink/README.md +++ b/examples/stm32/f4/stm32f4-discovery/miniblink/README.md @@ -1,13 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. It's intended for the ST STM32F4DISCOVERY eval board. It should blink the GREEN LED on the board. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f4/stm32f4-discovery/random/README.md b/examples/stm32/f4/stm32f4-discovery/random/README.md index c3be28a..2d0179a 100644 --- a/examples/stm32/f4/stm32f4-discovery/random/README.md +++ b/examples/stm32/f4/stm32f4-discovery/random/README.md @@ -1,12 +1,9 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example randomly blinks the GREEN LED on the ST STM32F4DISCOVERY eval board. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f4/stm32f4-discovery/tick_blink/README.md b/examples/stm32/f4/stm32f4-discovery/tick_blink/README.md index bf5a173..ff1acce 100644 --- a/examples/stm32/f4/stm32f4-discovery/tick_blink/README.md +++ b/examples/stm32/f4/stm32f4-discovery/tick_blink/README.md @@ -1,14 +1,11 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README -This example is the same as fancy_blink except that it uses the +This example is the same as fancy\_blink except that it uses the systick timer to generate time accurate delays. Shows how to set up the systick timer to create an interrupt every millisecond and how to write a delay routine (msleep) that can then delay for a specific number of milliseconds. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f4/stm32f4-discovery/usart/README.md b/examples/stm32/f4/stm32f4-discovery/usart/README.md index 640c00c..5d185bf 100644 --- a/examples/stm32/f4/stm32f4-discovery/usart/README.md +++ b/examples/stm32/f4/stm32f4-discovery/usart/README.md @@ -1,13 +1,12 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends repeating sequence of characters "0123456789" on USART2 on the ST STM32F4DISCOVERY eval board. The sending is done in a blocking way. -Board connections: ------------------- +## Board connections - PA2 (USART2_TX) TTL serial output (38400,8,N,1) +| Port | Function | Description | +| ----- | ------------- | --------------------------------- | +| `PA2` | `(USART2_TX)` | TTL serial output `(38400,8,N,1)` | diff --git a/examples/stm32/f4/stm32f4-discovery/usart_irq/README.md b/examples/stm32/f4/stm32f4-discovery/usart_irq/README.md index 2b275e0..e00afd2 100644 --- a/examples/stm32/f4/stm32f4-discovery/usart_irq/README.md +++ b/examples/stm32/f4/stm32f4-discovery/usart_irq/README.md @@ -1,14 +1,13 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program echoes data sent in on USART2 on the ST STM32F4DISCOVERY eval board. Uses interrupts for that purpose. The sending is done in a nonblocking way. -Board connections: ------------------- +## Board connections - PA2 (USART2_TX) TTL serial output (38400,8,N,1) - PA3 (USART2_RX) TTL serial input (38400,8,N,1) +| Port | Function | Description | +| ----- | ------------- | --------------------------------- | +| `PA2` | `(USART2_TX)` | TTL serial output `(38400,8,N,1)` | +| `PA3` | `(USART2_RX)` | TTL serial input `(38400,8,N,1)` | diff --git a/examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README.md b/examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README.md index e7cab9b..ab01811 100644 --- a/examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README.md +++ b/examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README.md @@ -1,11 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB CDC-ACM device (aka Virtual Serial Port) to demonstrate the use of the USB device stack. -Board connections: ------------------- +## Board connections - CN5 (USB_OTG_FS) USB acting as device, connect to computer +| Port | Function | Description | +| ----- | -------------- | ----------------------------------------- | +| `CN5` | `(USB_OTG_FS)` | USB acting as device, connect to computer | diff --git a/examples/stm32/f4/stm32f4-discovery/usb_midi/README.md b/examples/stm32/f4/stm32f4-discovery/usb_midi/README.md index d50c5a6..20f8f17 100644 --- a/examples/stm32/f4/stm32f4-discovery/usb_midi/README.md +++ b/examples/stm32/f4/stm32f4-discovery/usb_midi/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB MIDI device to demonstrate the use of the USB device stack. It implements the device configuration found in Appendix @@ -11,13 +9,13 @@ The 'USER' button sends note on/note off messages. The board will also react to identity request (or any other data sent to the board) by transmitting an identity message in reply. -Board connections: ------------------- +## Board connections - CN5 (USB_OTG_FS) USB acting as device, connect to computer +| Port | Function | Description | +| ----- | -------------- | ----------------------------------------- | +| `CN5` | `(USB_OTG_FS)` | USB acting as device, connect to computer | -Testing -------- +## Testing To list midi devices, which should include this demo device @@ -37,7 +35,7 @@ To record events, while pushing the user button 12 bytes read $ -To query the system identity, note this dump matches sysex_identity[] in the +To query the system identity, note this dump matches sysex\_identity[] in the source. $ amidi -d -p hw:2,0,0 -s Sysexdump.syx diff --git a/examples/stm32/f4/stm32f4-discovery/usb_msc/README.md b/examples/stm32/f4/stm32f4-discovery/usb_msc/README.md index b7b21c4..b14dd90 100644 --- a/examples/stm32/f4/stm32f4-discovery/usb_msc/README.md +++ b/examples/stm32/f4/stm32f4-discovery/usb_msc/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB Mass Storage Class (MSC) device to demonstrate the use of the USB device stack. diff --git a/examples/stm32/f4/stm32f429i-discovery/README.md b/examples/stm32/f4/stm32f429i-discovery/README.md index d0421fa..5f6809d 100644 --- a/examples/stm32/f4/stm32f429i-discovery/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/README.md @@ -1,3 +1,5 @@ +# README + This directory contains examples for the stm32f429i discovery board. The PCB should be labelled either MB1075B, and contains a user USB port, 2.4" QVGA TFT LCD display, 64Mbits external SDRAM and ST MEMS gyroscope. diff --git a/examples/stm32/f4/stm32f429i-discovery/adc-dac-printf/README.md b/examples/stm32/f4/stm32f429i-discovery/adc-dac-printf/README.md index d747cce..8959388 100644 --- a/examples/stm32/f4/stm32f429i-discovery/adc-dac-printf/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/adc-dac-printf/README.md @@ -1,3 +1,5 @@ +# README + Console on PA9 (tx only) 115200@8n1 * Prints the ADC value on PA0 (adc channel 0) on the console @@ -9,9 +11,9 @@ Recommended wiring: * jumper from PA5 to PA1 example output: -... -tick: 228: adc0= 3950, target adc1=1975, adc1=1979 -tick: 229: adc0= 3949, target adc1=1974, adc1=1978 -tick: 230: adc0= 3950, target adc1=1975, adc1=1979 -tick: 231: adc0= 3949, target adc1=1974, adc1=1978 -... + ... + tick: 228: adc0= 3950, target adc1=1975, adc1=1979 + tick: 229: adc0= 3949, target adc1=1974, adc1=1978 + tick: 230: adc0= 3950, target adc1=1975, adc1=1979 + tick: 231: adc0= 3949, target adc1=1974, adc1=1978 + ... diff --git a/examples/stm32/f4/stm32f429i-discovery/button/README.md b/examples/stm32/f4/stm32f429i-discovery/button/README.md index d366ec2..902cdf7 100644 --- a/examples/stm32/f4/stm32f429i-discovery/button/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/button/README.md @@ -1,12 +1,9 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example blinks the GREEN LED on the ST STM32F429IDISCOVERY eval board. When you press the 'USER' button, the blinking is slower. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f4/stm32f429i-discovery/dac-dma/README.md b/examples/stm32/f4/stm32f429i-discovery/dac-dma/README.md index 3b53fc7..8fefa61 100644 --- a/examples/stm32/f4/stm32f429i-discovery/dac-dma/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/dac-dma/README.md @@ -1,3 +1,5 @@ +# README + DAC test with DMA and timer 2 trigger Timer 2 is setup to provide a trigger signal on OC1, with a period of 142 Hz diff --git a/examples/stm32/f4/stm32f429i-discovery/fancyblink/README.md b/examples/stm32/f4/stm32f429i-discovery/fancyblink/README.md index 8d3d537..5ef6882 100644 --- a/examples/stm32/f4/stm32f429i-discovery/fancyblink/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/fancyblink/README.md @@ -1,13 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. It's intended for the ST STM32F429IDISCOVERY eval board. It should blink the LEDs on the board. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f4/stm32f429i-discovery/mandelbrot/README.md b/examples/stm32/f4/stm32f429i-discovery/mandelbrot/README.md index b76cd42..8c54c11 100644 --- a/examples/stm32/f4/stm32f429i-discovery/mandelbrot/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/mandelbrot/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program demonstrates the floating point coprocessor usage on the ST STM32F429IDISCOVERY eval board. @@ -8,7 +6,8 @@ the ST STM32F429IDISCOVERY eval board. A mandelbrot fractal is calculated and sent as "ascii-art" image through the USART1. -Board connections: ------------------- +## Board connections - PA9 (USART1_TX) TTL serial output (38400,8,N,1) +| Port | Function | Description | +| ----- | ------------- | --------------------------------- | +| `PA9` | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` | diff --git a/examples/stm32/f4/stm32f429i-discovery/miniblink/README.md b/examples/stm32/f4/stm32f429i-discovery/miniblink/README.md index 34a6de6..9b9c098 100644 --- a/examples/stm32/f4/stm32f429i-discovery/miniblink/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/miniblink/README.md @@ -1,13 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. It's intended for the ST STM32F429IDISCOVERY eval board. It should blink the GREEN LED on the board. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f4/stm32f429i-discovery/random/README.md b/examples/stm32/f4/stm32f429i-discovery/random/README.md index 472e6b5..4af00b9 100644 --- a/examples/stm32/f4/stm32f429i-discovery/random/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/random/README.md @@ -1,12 +1,9 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example randomly blinks the GREEN LED on the ST STM32F429IDISCOVERY eval board. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f4/stm32f429i-discovery/tick_blink/README.md b/examples/stm32/f4/stm32f429i-discovery/tick_blink/README.md index bf5a173..ff1acce 100644 --- a/examples/stm32/f4/stm32f429i-discovery/tick_blink/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/tick_blink/README.md @@ -1,14 +1,11 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README -This example is the same as fancy_blink except that it uses the +This example is the same as fancy\_blink except that it uses the systick timer to generate time accurate delays. Shows how to set up the systick timer to create an interrupt every millisecond and how to write a delay routine (msleep) that can then delay for a specific number of milliseconds. -Board connections: ------------------- +## Board connections - +*none required* diff --git a/examples/stm32/f4/stm32f429i-discovery/usart/README.md b/examples/stm32/f4/stm32f429i-discovery/usart/README.md index 6ed11a6..7f79ce4 100644 --- a/examples/stm32/f4/stm32f429i-discovery/usart/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/usart/README.md @@ -1,19 +1,17 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends repeating sequence of characters "0123456789" on USART1 on the ST STM32F429IDISCOVERY eval board. The sending is done in a blocking way. -Board connections: ------------------- +## Board connections - PA9 (USART1_TX) TTL serial output (38400,8,N,1) +| Port | Function | Description | +| ----- | ------------- | --------------------------------- | +| `PA9` | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` | -Notes: ------- +## Notes You can connect the UART to the stlink by closing the SB11 and SB15 solder jumpers. diff --git a/examples/stm32/f4/stm32f429i-discovery/usart_irq/README.md b/examples/stm32/f4/stm32f429i-discovery/usart_irq/README.md index d414954..b4cfac7 100644 --- a/examples/stm32/f4/stm32f429i-discovery/usart_irq/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/usart_irq/README.md @@ -1,19 +1,17 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program echoes data sent in on USART1 on the ST STM32F429IDISCOVERY eval board. Uses interrupts for that purpose. The sending is done in a nonblocking way. -Board connections: ------------------- +## Board connections - PA9 (USART1_TX) TTL serial output (38400,8,N,1) - PA10 (USART1_RX) TTL serial input (38400,8,N,1) +| Port | Function | Description | +| ------ | ------------- | --------------------------------- | +| `PA9` | `(USART1_TX)` | TTL serial output `(38400,8,N,1)` | +| `PA10` | `(USART1_RX)` | TTL serial input `(38400,8,N,1)` | -Notes: ------- +## Notes You can connect the USART to the stlink by closing the SB11 and SB15 jumpers. diff --git a/examples/stm32/f4/stm32f429i-discovery/usb_cdcacm/README.md b/examples/stm32/f4/stm32f429i-discovery/usb_cdcacm/README.md index 00b980a..6aa2b44 100644 --- a/examples/stm32/f4/stm32f429i-discovery/usb_cdcacm/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/usb_cdcacm/README.md @@ -1,11 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB CDC-ACM device (aka Virtual Serial Port) to demonstrate the use of the USB device stack. -Board connections: ------------------- +## Board connections - CN6 (USB_OTG_HS) USB acting as device, connect to computer +| Port | Function | Description | +| ----- | -------------- | ----------------------------------------- | +| `CN6` | `(USB_OTG_HS)` | USB acting as device, connect to computer | diff --git a/examples/stm32/f4/stm32f429i-discovery/usb_midi/README.md b/examples/stm32/f4/stm32f429i-discovery/usb_midi/README.md index a85760c..3345123 100644 --- a/examples/stm32/f4/stm32f429i-discovery/usb_midi/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/usb_midi/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB MIDI device to demonstrate the use of the USB device stack. It implements the device configuration found in Appendix @@ -11,13 +9,13 @@ The 'USER' button sends note on/note off messages. The board will also react to identity request (or any other data sent to the board) by transmitting an identity message in reply. -Board connections: ------------------- +## Board connections - CN6 (USB_OTG_HS) USB acting as device, connect to computer +| Port | Function | Description | +| ----- | -------------- | ----------------------------------------- | +| `CN6` | `(USB_OTG_HS)` | USB acting as device, connect to computer | -Testing -------- +## Testing To list midi devices, which should include this demo device @@ -37,7 +35,7 @@ To record events, while pushing the user button 12 bytes read $ -To query the system identity, note this dump matches sysex_identity[] in the +To query the system identity, note this dump matches sysex\_identity[] in the source. $ amidi -d -p hw:2,0,0 -s Sysexdump.syx diff --git a/examples/stm32/f4/stm32f429i-discovery/usb_msc/README.md b/examples/stm32/f4/stm32f429i-discovery/usb_msc/README.md index b7b21c4..b14dd90 100644 --- a/examples/stm32/f4/stm32f429i-discovery/usb_msc/README.md +++ b/examples/stm32/f4/stm32f429i-discovery/usb_msc/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example implements a USB Mass Storage Class (MSC) device to demonstrate the use of the USB device stack. diff --git a/examples/stm32/l0/stm32l0538-disco/miniblink/README.md b/examples/stm32/l0/stm32l0538-disco/miniblink/README.md index e114b54..a638584 100644 --- a/examples/stm32/l0/stm32l0538-disco/miniblink/README.md +++ b/examples/stm32/l0/stm32l0538-disco/miniblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. diff --git a/examples/stm32/l1/stm32l-discovery/button-irq-printf-lowpower/README.md b/examples/stm32/l1/stm32l-discovery/button-irq-printf-lowpower/README.md index 83cccfc..d2fe52d 100644 --- a/examples/stm32/l1/stm32l-discovery/button-irq-printf-lowpower/README.md +++ b/examples/stm32/l1/stm32l-discovery/button-irq-printf-lowpower/README.md @@ -1,3 +1,5 @@ +# README + This is _functionally_ identical to the "button-irq-printf" example, but has been modified to use some low power features. @@ -9,8 +11,7 @@ Instead of free running timers and busy loops, this version uses the RTC module and attempts to sleep as much as possible, including while the button is pressed. -Status -~~~~~~ +## Status Only very basic power savings are done! Current consumption, led off/on, 16Mhz HSI: 2.7mA/5.4mA diff --git a/examples/stm32/l1/stm32l-discovery/button-irq-printf/README.md b/examples/stm32/l1/stm32l-discovery/button-irq-printf/README.md index 5de96a2..09dc822 100644 --- a/examples/stm32/l1/stm32l-discovery/button-irq-printf/README.md +++ b/examples/stm32/l1/stm32l-discovery/button-irq-printf/README.md @@ -1,3 +1,5 @@ +# README + * Prints to the screen when the button is pushed/released (irq driven) 115200@8n1 console on PA2 (tx only) * uses basic timer 6 with overflows to generate a 1ms counter (not an ideal @@ -11,25 +13,24 @@ is ~7.5mA when the green tick led is off, and about 10.5mA when it is on. example output: -hi guys! -TICK 0 -TICK 1 -TICK 2 -Pushed down! -held: 443 ms -Pushed down! -TICK 3 -held: 217 ms -Pushed down! -held: 99 ms -Pushed down! -TICK 4 -held: 73 ms -Pushed down! -held: 60 ms -TICK 5 -Pushed down! -held: 98 ms -Pushed down! - + hi guys! + TICK 0 + TICK 1 + TICK 2 + Pushed down! + held: 443 ms + Pushed down! + TICK 3 + held: 217 ms + Pushed down! + held: 99 ms + Pushed down! + TICK 4 + held: 73 ms + Pushed down! + held: 60 ms + TICK 5 + Pushed down! + held: 98 ms + Pushed down! diff --git a/examples/stm32/l1/stm32l-discovery/lcd-display/README.md b/examples/stm32/l1/stm32l-discovery/lcd-display/README.md index 79b6bfe..f371a17 100644 --- a/examples/stm32/l1/stm32l-discovery/lcd-display/README.md +++ b/examples/stm32/l1/stm32l-discovery/lcd-display/README.md @@ -1,7 +1,5 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README -This example program display word *HELLO on default LCD screen of +This example program display word *HELLO* on default LCD screen of STM32L-DISCOVERY board. diff --git a/examples/stm32/l1/stm32l-discovery/miniblink/README.md b/examples/stm32/l1/stm32l-discovery/miniblink/README.md index 8bdd314..b3cbecc 100644 --- a/examples/stm32/l1/stm32l-discovery/miniblink/README.md +++ b/examples/stm32/l1/stm32l-discovery/miniblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. diff --git a/examples/stm32/l1/stm32l-discovery/usart-semihosting/README.md b/examples/stm32/l1/stm32l-discovery/usart-semihosting/README.md index 93ad917..7f086b0 100644 --- a/examples/stm32/l1/stm32l-discovery/usart-semihosting/README.md +++ b/examples/stm32/l1/stm32l-discovery/usart-semihosting/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends some characters on USART2 on the ST STM32L DISCOVERY eval board. (USART2 TX on PA2 @ 115200 8n1) @@ -12,45 +10,45 @@ https://launchpad.net/gcc-arm-embedded Semihosting is a neat feature, but remember that your application will NOT WORK standalone if you have semihosting turned on! -$ make ENABLE_SEMIHOSTING=0 will rebuild this image _without_ semihosting + $ make ENABLE_SEMIHOSTING=0 will rebuild this image _without_ semihosting Semihosting is supported in "recent"[1] OpenOCD versions, however, you need to enable semihosting first! If you have not enabled semihosting, you will receive a message like this: -(gdb) run -The program being debugged has been started already. -Start it from the beginning? (y or n) y - -Starting program: -/home/karlp/src/libopencm3-examples/examples/stm32/l1/stm32l-discovery/usart-semihosting/usart-semihosting.elf - -Program received signal SIGTRAP, Trace/breakpoint trap. -0x08000456 in initialise_monitor_handles () -(gdb) - -# Here we enable semi-hosting - -(gdb) mon arm semihosting enable -semihosting is enabled -(gdb) continue -... + (gdb) run + The program being debugged has been started already. + Start it from the beginning? (y or n) y + + Starting program: + /home/karlp/src/libopencm3-examples/examples/stm32/l1/stm32l-discovery/usart-semihosting/usart-semihosting.elf + + Program received signal SIGTRAP, Trace/breakpoint trap. + 0x08000456 in initialise_monitor_handles () + (gdb) + + # Here we enable semi-hosting + + (gdb) mon arm semihosting enable + semihosting is enabled + (gdb) continue + ... You should now see the semihosting output in the window running OpenOCD. -Size Notes -~~~~~~~~~~ +## Size Notes + Semihosting is basically free -# Without -$ arm-none-eabi-size usart-semihosting.elf - text data bss dec hex filename - 29056 2212 60 31328 7a60 usart-semihosting.elf +### Without + $ arm-none-eabi-size usart-semihosting.elf + text data bss dec hex filename + 29056 2212 60 31328 7a60 usart-semihosting.elf -# With -$ arm-none-eabi-size usart-semihosting.elf - text data bss dec hex filename - 29832 2212 232 32276 7e14 usart-semihosting.elf +### With + $ arm-none-eabi-size usart-semihosting.elf + text data bss dec hex filename + 29832 2212 232 32276 7e14 usart-semihosting.elf The large size here is because of printf being included regardless, see nano.specs if you care about this, this data here is to show that semihosting diff --git a/examples/stm32/l1/stm32l-discovery/usart/README.md b/examples/stm32/l1/stm32l-discovery/usart/README.md index dcbc5d9..13280aa 100644 --- a/examples/stm32/l1/stm32l-discovery/usart/README.md +++ b/examples/stm32/l1/stm32l-discovery/usart/README.md @@ -1,12 +1,10 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example program sends some characters on USART2 on the ST STM32L DISCOVERY eval board. (USART2 TX on PA2) The terminal settings for the receiving device/PC are 38400 8n1. -The sending is done in a blocking way in the code, see the usart_irq example +The sending is done in a blocking way in the code, see the usart\_irq example for a more elaborate USART example. diff --git a/examples/tiva/lm3s/lm3s3748-evb/miniblink/README.md b/examples/tiva/lm3s/lm3s3748-evb/miniblink/README.md index c566e5f..f315eb1 100644 --- a/examples/tiva/lm3s/lm3s3748-evb/miniblink/README.md +++ b/examples/tiva/lm3s/lm3s3748-evb/miniblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. diff --git a/examples/tiva/lm3s/lm3s811-evb/miniblink/README.md b/examples/tiva/lm3s/lm3s811-evb/miniblink/README.md index aed191a..f423536 100644 --- a/examples/tiva/lm3s/lm3s811-evb/miniblink/README.md +++ b/examples/tiva/lm3s/lm3s811-evb/miniblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This is the smallest-possible example program using libopencm3. diff --git a/examples/tiva/lm4f/stellaris-ek-lm4f120xl/miniblink/README.md b/examples/tiva/lm4f/stellaris-ek-lm4f120xl/miniblink/README.md index c7eddeb..19a83ff 100644 --- a/examples/tiva/lm4f/stellaris-ek-lm4f120xl/miniblink/README.md +++ b/examples/tiva/lm4f/stellaris-ek-lm4f120xl/miniblink/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example demonstrates the following: * Configuriong GPIO pins diff --git a/examples/tiva/lm4f/stellaris-ek-lm4f120xl/uart_echo_interrupt/README.md b/examples/tiva/lm4f/stellaris-ek-lm4f120xl/uart_echo_interrupt/README.md index 29008e5..3ca111b 100644 --- a/examples/tiva/lm4f/stellaris-ek-lm4f120xl/uart_echo_interrupt/README.md +++ b/examples/tiva/lm4f/stellaris-ek-lm4f120xl/uart_echo_interrupt/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example demonstrates the ease of setting up the UART with libopencm3, and using UART interrupts. UART echo is achieved by echoing back received characters @@ -15,4 +13,4 @@ necessary to test this example. Just connect the debug USB cable and use a terminal program to open the ACM port with 921600-8N1. For example: -$ picocom /dev/ttyACM0 -b921600 + picocom /dev/ttyACM0 -b921600 diff --git a/examples/tiva/lm4f/stellaris-ek-lm4f120xl/uart_echo_simple/README.md b/examples/tiva/lm4f/stellaris-ek-lm4f120xl/uart_echo_simple/README.md index e47dbcd..5531794 100644 --- a/examples/tiva/lm4f/stellaris-ek-lm4f120xl/uart_echo_simple/README.md +++ b/examples/tiva/lm4f/stellaris-ek-lm4f120xl/uart_echo_simple/README.md @@ -1,6 +1,4 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example demonstrates the ease of setting up the UART with libopencm3. Basic UART echo is achieved by using blocking reads and writes. The UART is set @@ -11,4 +9,4 @@ necessary to test this example. Just connect the debug USB cable and use a terminal program to open the ACM port with 921600-8N1. For example: -$ picocom /dev/ttyACM0 -b921600 + picocom /dev/ttyACM0 -b921600 diff --git a/examples/tiva/lm4f/stellaris-ek-lm4f120xl/usb_bulk_dev/README.md b/examples/tiva/lm4f/stellaris-ek-lm4f120xl/usb_bulk_dev/README.md index df443e5..4c6b757 100644 --- a/examples/tiva/lm4f/stellaris-ek-lm4f120xl/usb_bulk_dev/README.md +++ b/examples/tiva/lm4f/stellaris-ek-lm4f120xl/usb_bulk_dev/README.md @@ -1,13 +1,11 @@ -usb_bulk_dev -============ +# README This example demonstrates the following: * Setting up polled USB endpoints * Setting up interrupt driven USB endpoints * Using the UART as a debug tool -USB module ----------- +## USB module Several USB endpoints are being set up: * EP1 OUT - interrupt driven RX endpoint @@ -26,7 +24,7 @@ from the USB driver. Since the USB driver is run entirely from the USB ISR, these callbacks are essentially interrupt driven. The polled endpoints try to continuously read and write data. Even though -usbd_ep_read/write_packet is called continuously for these endpoints, the USB +usbd\_ep\_read/write\_packet is called continuously for these endpoints, the USB driver will only write a packet to the TX FIFO if it is empty, and only read a packet from the FIFO if one has arrived. @@ -34,8 +32,7 @@ The endpoints with a misaligned buffer show the performance drop when the buffer is not aligned to a 4 byte boundary. 32-bit memory accesses to the buffer are downgraded to 8-bit accesses by the hardware. -Clock change module -------------------- +## Clock change module Pressing SW2 toggles the system clock between 80MHz, 57MHz, 40MHz, 30MHz, 20MHz, and 16MHz by changing the PLL divisor. @@ -49,8 +46,7 @@ possible to change the system clock while benchmarking the USB endpoint. The current system clock is printed on the debug interface. This allows testing the performance of the USB endpoints under different clocks. -Debug module ------------- +## Debug module printf() support is provided via UART0. The UART0 pins are connected to the CDCACM interface on the ICDI chip, so no extra hardware is necessary to check @@ -58,4 +54,4 @@ the debug output. Just connect the debug USB cable and use a terminal program to open the ACM port with 921600-8N1. For example: -> $ picocom /dev/ttyACM0 -b921600 + picocom /dev/ttyACM0 -b921600 diff --git a/examples/tiva/lm4f/stellaris-ek-lm4f120xl/usb_to_serial_cdcacm/README.md b/examples/tiva/lm4f/stellaris-ek-lm4f120xl/usb_to_serial_cdcacm/README.md index 4547b89..1ffe289 100644 --- a/examples/tiva/lm4f/stellaris-ek-lm4f120xl/usb_to_serial_cdcacm/README.md +++ b/examples/tiva/lm4f/stellaris-ek-lm4f120xl/usb_to_serial_cdcacm/README.md @@ -1,16 +1,14 @@ ------------------------------------------------------------------------------- -README ------------------------------------------------------------------------------- +# README This example demonstrates the following: * Using the USB controller * Setting up a simple usb to serial converter (CDCACM) File list: - * usb_cdcacm.c - implementation of the CDCACM subclass - * uart.c - implementation of UART peripheral - * usb_to_serial_cdcacm.c - glue logic between UART and CDCACM device - * usb_to_serial_cdcacm.h - common definitions + * `usb_cdcacm.c` - implementation of the CDCACM subclass + * `uart.c` - implementation of UART peripheral + * `usb_to_serial_cdcacm.c` - glue logic between UART and CDCACM device + * `usb_to_serial_cdcacm.h` - common definitions Implements a USB-to-serial adapter, compliant to the CDCACM subclass. UART1 is @@ -31,7 +29,7 @@ Note that the CTS pin is unused. The CDCACM specification does not define a way to control this pin, nor does it define a way to switch between flow control mechanisms. -The glue logic in usb_to_serial_cdcacm.c receives requests from both the UART +The glue logic in `usb_to_serial_cdcacm.c` receives requests from both the UART and CDCACM interface, and forward them to their destination, while also controlling the LEDs @@ -41,28 +39,27 @@ The blue LED is lit while data is read from the UART. The red and blue LEDs will only be lit for very short periods of time, thus they may be difficult to notice. ------------------------------------------------------------------------------- -Windows Quirks ------------------------------------------------------------------------------- -On openening the CDCACM port Windows send a SET_LINE_CODING request with the +## Windows Quirks +On openening the CDCACM port Windows send a `SET_LINE_CODING` request with the desired baud rate but without valid databits. To run this example CDDACM device -under Windows you have to return always 1 when a SET_LINE_CODING request is +under Windows you have to return always 1 when a `SET_LINE_CODING` request is received. The following code should work: -File: usb_cdcacm.c -Function: cdcacm_control_request() +File: `usb_cdcacm.c` +Function: `cdcacm_control_request()` case USB_CDC_REQ_SET_LINE_CODING:{ struct usb_cdc_line_coding *coding; - + if (*len < sizeof(struct usb_cdc_line_coding)) { return 0; } - + coding = (struct usb_cdc_line_coding *)*buf; glue_set_line_coding_cb(coding->dwDTERate, coding->bDataBits, coding->bParityType, coding->bCharFormat); return 1; +