mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-21 14:16:26 +00:00
d2e4903a42
Add/update docs for the pw_dumb_io facade and backends. Configures GN build files such that all the backend docs are built even if the backend isn't in use. Change-Id: I91fca1cb2d3f5d4b57ae1f6991a89270a35be1c6
52 lines
1.8 KiB
ReStructuredText
52 lines
1.8 KiB
ReStructuredText
.. _chapter-pw-dumb-io-baremetal-stm32f429:
|
|
|
|
.. default-domain:: cpp
|
|
|
|
.. highlight:: sh
|
|
|
|
------------------------------
|
|
pw_dumb_io_baremetal_stm32f429
|
|
------------------------------
|
|
|
|
``pw_dumb_io_baremetal_stm32f429`` implements the ``pw_dumb_io`` facade over
|
|
UART.
|
|
|
|
The STM32F429 baremetal dumb IO backend provides device startup code and a UART
|
|
driver layer that allows applications built against the ``pw_dumb_io`` interface
|
|
to run on a STM32F429 chip and do simple input/output via UART. The code is
|
|
optimized for the STM32F429I-DISC1, using USART1 (which is connected to the
|
|
virtual COM port on the embedded ST-LINKv2 chip). However, this should work with
|
|
all STM32F429 variations (and even some STM32F4xx chips).
|
|
|
|
This backend has no configuration options. The point of it is to provide bare-
|
|
minimum platform code needed to do UART reads/writes.
|
|
|
|
Setup
|
|
=====
|
|
This module requires relatively minimal setup:
|
|
|
|
1. Write code against the ``pw_dumb_io`` facade.
|
|
2. Specify the ``dir_pw_dumb_io_backend`` GN global variable to point to this
|
|
backend.
|
|
3. Build an executable with a main() function using a toolchain that
|
|
supports Cortex-M4.
|
|
|
|
.. note::
|
|
This module provides early firmware init and a linker script, so it will
|
|
conflict with other modules that do any early device init or provide a linker
|
|
script.
|
|
|
|
Module usage
|
|
============
|
|
After building a an executable that utilizes this backend, flash the
|
|
produced .elf binary to the development board. Then, using a serial
|
|
communication terminal (like minicom or screen), connect to the device at a
|
|
baud rate of 115200 (8N1). If you're not using a STM32F429I-DISC1 development
|
|
board, manually connect a USB TLL adapter to pins `A9` (TX) and
|
|
`A10` (RX).
|
|
|
|
Dependencies
|
|
============
|
|
* pw_dumb_io facade
|
|
* pw_preprocessor module
|