aboutsummaryrefslogtreecommitdiffstats
path: root/demos/STM32/RT-STM32F429-DISCOVERY-TRIBUF/readme.txt
diff options
context:
space:
mode:
authorTexZK <texzk@email.it>2015-07-08 21:57:53 +0200
committerTexZK <texzk@email.it>2015-07-08 21:57:53 +0200
commit5270aa500f88e13ae2f9cebded4271d52d08706c (patch)
tree6591594bdc3c563021aee2a0838d0dbf7a654855 /demos/STM32/RT-STM32F429-DISCOVERY-TRIBUF/readme.txt
parent567cfe388f25ae32621ac3f2d7d27b94cab617be (diff)
downloadChibiOS-Contrib-5270aa500f88e13ae2f9cebded4271d52d08706c.tar.gz
ChibiOS-Contrib-5270aa500f88e13ae2f9cebded4271d52d08706c.tar.bz2
ChibiOS-Contrib-5270aa500f88e13ae2f9cebded4271d52d08706c.zip
Added descriptions and code simplified
Diffstat (limited to 'demos/STM32/RT-STM32F429-DISCOVERY-TRIBUF/readme.txt')
-rw-r--r--demos/STM32/RT-STM32F429-DISCOVERY-TRIBUF/readme.txt29
1 files changed, 16 insertions, 13 deletions
diff --git a/demos/STM32/RT-STM32F429-DISCOVERY-TRIBUF/readme.txt b/demos/STM32/RT-STM32F429-DISCOVERY-TRIBUF/readme.txt
index 7a0b396..cc7f406 100644
--- a/demos/STM32/RT-STM32F429-DISCOVERY-TRIBUF/readme.txt
+++ b/demos/STM32/RT-STM32F429-DISCOVERY-TRIBUF/readme.txt
@@ -8,20 +8,23 @@ The demo runs on an ST STM32F429I-Discovery board.
** The Demo **
-A simple command shell is activated on virtual serial port SD1.
-TODO
+This demo shows how to use a triple buffer handler, with one writer thread and
+one reader thread.
+The writer thread puts a character into the current back buffer, thus swapping
+the back buffer with the orphan buffer for a new write. The writer then sleeps
+for a specified delay in milliseconds.
+The reader thread gets waits (if there is a timeout) until the orphan buffer
+contains available data, becoming the new front buffer. The character is read
+from the new front buffer and printed. The reader then sleeps for a specified
+delay in milliseconds.
+A simple command shell is activated on virtual serial port SD1 or SDU1.
+Via command line it is possible to start, stop, set the delay, and set the
+thread priority of the reader and writer threads.
+The reader can also be assigned a wait timeout in milliseconds, with special
+cases of "*" for infinite timeout, and "-" (or 0 ms) for none.
** Build Procedure **
-The demo has been tested by using the free Codesourcery GCC-based toolchain
-and YAGARTO. just modify the TRGT line in the makefile in order to use
+The demo has been tested by using the free GNU Tools ARM Embedded toolchain
+and ChibiStudio. Just modify the TRGT line in the makefile in order to use
different GCC toolchains.
-
-** Notes **
-
-Some files used by the demo are not part of ChibiOS/RT but are copyright of
-ST Microelectronics and are licensed under a different license.
-Also note that not all the files present in the ST library are distributed
-with ChibiOS/RT, you can find the whole library on the ST web site:
-
- http://www.st.com