From 022cc475bfb8b1e3780dd876f7d5dcaec14af65c Mon Sep 17 00:00:00 2001 From: Frantisek Burian Date: Fri, 3 Jan 2014 13:28:57 +0100 Subject: [PATCH] [DOC] Updated README's for F0 and F4 examples to describe the needed board connections. --- examples/stm32/f0/stm32f0-discovery/adc/README | 11 ++++++----- examples/stm32/f0/stm32f0-discovery/button/README | 4 ++++ examples/stm32/f0/stm32f0-discovery/miniblink/README | 10 +++++++--- .../stm32/f0/stm32f0-discovery/systick_blink/README | 7 ++++++- examples/stm32/f0/stm32f0-discovery/usart/README | 10 ++++++---- .../stm32/f0/stm32f0-discovery/usart_stdio/README | 10 ++++++---- examples/stm32/f4/stm32f4-discovery/button/README | 6 +++++- examples/stm32/f4/stm32f4-discovery/fancyblink/README | 4 ++++ examples/stm32/f4/stm32f4-discovery/mandelbrot/README | 4 +++- examples/stm32/f4/stm32f4-discovery/miniblink/README | 6 +++++- examples/stm32/f4/stm32f4-discovery/random/README | 9 ++++++++- examples/stm32/f4/stm32f4-discovery/tick_blink/README | 8 +++++++- examples/stm32/f4/stm32f4-discovery/usart/README | 10 ++++++---- examples/stm32/f4/stm32f4-discovery/usart_irq/README | 10 +++++----- examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README | 4 ++++ 15 files changed, 82 insertions(+), 31 deletions(-) diff --git a/examples/stm32/f0/stm32f0-discovery/adc/README b/examples/stm32/f0/stm32f0-discovery/adc/README index 6eec4af..5e717f6 100644 --- a/examples/stm32/f0/stm32f0-discovery/adc/README +++ b/examples/stm32/f0/stm32f0-discovery/adc/README @@ -2,10 +2,11 @@ README ------------------------------------------------------------------------------ -This is the smallest-possible example program using libopencm3. - -It's intended for the ST STM32F0DISCOVERY eval board. It should read from the -ADC_IN1 (PA1) pin its voltage and print it to the serial port on pin PA9 with -parameters (38400,8,N,1) +It's intended for the ST STM32F0DISCOVERY eval board. Measures voltage on the +ADC_IN1 input, and prints it to the serial port. +Board connections: +------------------ + PA1 (ADC_IN1) Analog input + PA9 (USART1) TTL serial output (38400,8,N,1) diff --git a/examples/stm32/f0/stm32f0-discovery/button/README b/examples/stm32/f0/stm32f0-discovery/button/README index f082444..fdb606f 100644 --- a/examples/stm32/f0/stm32f0-discovery/button/README +++ b/examples/stm32/f0/stm32f0-discovery/button/README @@ -6,3 +6,7 @@ This example blinks the green LED on the ST STM32F0DISCOVERY eval board. When you press the 'USER' button, the blinking is slower. +Board connections: +------------------ + + diff --git a/examples/stm32/f0/stm32f0-discovery/miniblink/README b/examples/stm32/f0/stm32f0-discovery/miniblink/README index 351655f..6c54bfe 100644 --- a/examples/stm32/f0/stm32f0-discovery/miniblink/README +++ b/examples/stm32/f0/stm32f0-discovery/miniblink/README @@ -2,8 +2,12 @@ README ------------------------------------------------------------------------------ -This is the smallest-possible example program using libopencm3. +This is the smallest-possible example program using libopencm3 and ST +STM32F0DISCOVERY eval board. -It's intended for the ST STM32F0-DISCOVERY eval board. It should blink -the blue LED on the board. +It should blink the blue LED on the board. +Board connections: +------------------ + + diff --git a/examples/stm32/f0/stm32f0-discovery/systick_blink/README b/examples/stm32/f0/stm32f0-discovery/systick_blink/README index 791fce6..db06304 100644 --- a/examples/stm32/f0/stm32f0-discovery/systick_blink/README +++ b/examples/stm32/f0/stm32f0-discovery/systick_blink/README @@ -5,5 +5,10 @@ README 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. -On pin PA9, there is MCO output of internal reference clock. This can be used +There is internal reference clock available on MCO output pin. This can be used to debug the PLL clock setup by scope. + +Board connections: +------------------ + + PA9 (MCO) Internal reference clock diff --git a/examples/stm32/f0/stm32f0-discovery/usart/README b/examples/stm32/f0/stm32f0-discovery/usart/README index 8d6a711..2016bbf 100644 --- a/examples/stm32/f0/stm32f0-discovery/usart/README +++ b/examples/stm32/f0/stm32f0-discovery/usart/README @@ -2,10 +2,12 @@ README ------------------------------------------------------------------------------ -This example program sends some characters on USART0 on the -ST STM32F0DISCOVERY eval board. +This example program sends repeating sequence of characters "0123456789" on +USART1 serial line of ST STM32F0DISCOVERY eval board. -The terminal settings for the receiving device/PC are 38400 8n1. +The sending is done in a blocking way. -The sending is done in a blocking way in the code. +Board connections: +------------------ + PA9 (USART1_TX) TTL serial output (38400,8,N,1) diff --git a/examples/stm32/f0/stm32f0-discovery/usart_stdio/README b/examples/stm32/f0/stm32f0-discovery/usart_stdio/README index 8b888c1..ecedccb 100644 --- a/examples/stm32/f0/stm32f0-discovery/usart_stdio/README +++ b/examples/stm32/f0/stm32f0-discovery/usart_stdio/README @@ -2,10 +2,12 @@ README ------------------------------------------------------------------------------ -This example program sends some characters on USART1 on the -ST STM32F0DISCOVERY eval board. PA9 +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 terminal settings for the receiving device/PC are 38400 8n1. +The sending is done using newlib-nano library in a blocking way. -The sending is done using newlib-nano library in a blocking way in the code. +Board connections: +------------------ + PA9 (USART1_TX) TTL serial output (38400,8,N,1) diff --git a/examples/stm32/f4/stm32f4-discovery/button/README b/examples/stm32/f4/stm32f4-discovery/button/README index b794dda..c0f3875 100644 --- a/examples/stm32/f4/stm32f4-discovery/button/README +++ b/examples/stm32/f4/stm32f4-discovery/button/README @@ -2,7 +2,11 @@ README ------------------------------------------------------------------------------ -This example blinks the green LED on the ST STM32F4DISCOVERY eval board. +This example blinks the GREEN LED on the ST STM32F4DISCOVERY eval board. When you press the 'USER' button, the blinking is slower. +Board connections: +------------------ + + diff --git a/examples/stm32/f4/stm32f4-discovery/fancyblink/README b/examples/stm32/f4/stm32f4-discovery/fancyblink/README index 88e24bf..ef7320e 100644 --- a/examples/stm32/f4/stm32f4-discovery/fancyblink/README +++ b/examples/stm32/f4/stm32f4-discovery/fancyblink/README @@ -7,3 +7,7 @@ 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: +------------------ + + diff --git a/examples/stm32/f4/stm32f4-discovery/mandelbrot/README b/examples/stm32/f4/stm32f4-discovery/mandelbrot/README index fe4fb13..b179088 100644 --- a/examples/stm32/f4/stm32f4-discovery/mandelbrot/README +++ b/examples/stm32/f4/stm32f4-discovery/mandelbrot/README @@ -8,5 +8,7 @@ the ST STM32F4DISCOVERY eval board. A mandelbrot fractal is calculated and sent as "ascii-art" image through the USART2. -The terminal settings for the receiving device/PC are 38400 8n1. +Board connections: +------------------ + PA2 (USART2_TX) TTL serial output (38400,8,N,1) diff --git a/examples/stm32/f4/stm32f4-discovery/miniblink/README b/examples/stm32/f4/stm32f4-discovery/miniblink/README index cba9d42..2565682 100644 --- a/examples/stm32/f4/stm32f4-discovery/miniblink/README +++ b/examples/stm32/f4/stm32f4-discovery/miniblink/README @@ -5,5 +5,9 @@ README This is the smallest-possible example program using libopencm3. It's intended for the ST STM32F4DISCOVERY eval board. It should blink -the blue LED on the board. +the GREEN LED on the board. +Board connections: +------------------ + + diff --git a/examples/stm32/f4/stm32f4-discovery/random/README b/examples/stm32/f4/stm32f4-discovery/random/README index 875e6bf..c3be28a 100644 --- a/examples/stm32/f4/stm32f4-discovery/random/README +++ b/examples/stm32/f4/stm32f4-discovery/random/README @@ -2,4 +2,11 @@ README ------------------------------------------------------------------------------ -This example randomly blinks the green LED on the ST STM32F4DISCOVERY eval board. +This example randomly blinks the GREEN LED on the ST STM32F4DISCOVERY eval +board. + +Board connections: +------------------ + + + diff --git a/examples/stm32/f4/stm32f4-discovery/tick_blink/README b/examples/stm32/f4/stm32f4-discovery/tick_blink/README index a407c54..bf5a173 100644 --- a/examples/stm32/f4/stm32f4-discovery/tick_blink/README +++ b/examples/stm32/f4/stm32f4-discovery/tick_blink/README @@ -1,8 +1,14 @@ +------------------------------------------------------------------------------ README ------- +------------------------------------------------------------------------------ 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: +------------------ + + diff --git a/examples/stm32/f4/stm32f4-discovery/usart/README b/examples/stm32/f4/stm32f4-discovery/usart/README index 168b364..640c00c 100644 --- a/examples/stm32/f4/stm32f4-discovery/usart/README +++ b/examples/stm32/f4/stm32f4-discovery/usart/README @@ -2,10 +2,12 @@ README ------------------------------------------------------------------------------ -This example program sends some characters on USART2 on the -ST STM32F4DISCOVERY eval board. +This example program sends repeating sequence of characters "0123456789" on +USART2 on the ST STM32F4DISCOVERY eval board. -The terminal settings for the receiving device/PC are 38400 8n1. +The sending is done in a blocking way. -The sending is done in a blocking way in the code. +Board connections: +------------------ + PA2 (USART2_TX) TTL serial output (38400,8,N,1) diff --git a/examples/stm32/f4/stm32f4-discovery/usart_irq/README b/examples/stm32/f4/stm32f4-discovery/usart_irq/README index ac859a9..2b275e0 100644 --- a/examples/stm32/f4/stm32f4-discovery/usart_irq/README +++ b/examples/stm32/f4/stm32f4-discovery/usart_irq/README @@ -5,10 +5,10 @@ README This example program echoes data sent in on USART2 on the ST STM32F4DISCOVERY eval board. Uses interrupts for that purpose. -Connect your TTL RX device line to PA2 on the discovery board. -Connect your TTL TX device line to PA3 on the discovery board. +The sending is done in a nonblocking way. -The terminal settings for the receiving device/PC are 38400 8n1. - -The sending is done in a blocking way in the code. +Board connections: +------------------ + 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 b/examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README index 2f1ee4b..e7cab9b 100644 --- a/examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README +++ b/examples/stm32/f4/stm32f4-discovery/usb_cdcacm/README @@ -5,3 +5,7 @@ README This example implements a USB CDC-ACM device (aka Virtual Serial Port) to demonstrate the use of the USB device stack. +Board connections: +------------------ + + CN5 (USB_OTG_FS) USB acting as device, connect to computer