EMTime/libopencm3-examples
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[README] Coarse sweep to use markup in READMEs.

Browse Source 
This should improve online readability of the readme files.
This commit is contained in:
Piotr Esden-Tempski
2015-01-19 19:20:12 -08:00
parent ab7efee88e
commit 1c4ae95729
121 changed files with 411 additions and 609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
examples/stm32/l1/stm32l-discovery/button-irq-printf-lowpower/README.md
View File

@@ -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

43
examples/stm32/l1/stm32l-discovery/button-irq-printf/README.md
View File

@@ -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!

6
examples/stm32/l1/stm32l-discovery/lcd-display/README.md
View File

@@ -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.

4
examples/stm32/l1/stm32l-discovery/miniblink/README.md
View File

@@ -1,6 +1,4 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This is the smallest-possible example program using libopencm3.

60
examples/stm32/l1/stm32l-discovery/usart-semihosting/README.md
View File

@@ -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

6
examples/stm32/l1/stm32l-discovery/usart/README.md
View File

@@ -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.