summaryrefslogtreecommitdiff
path: root/board/nucleo-h743zi/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'board/nucleo-h743zi/README.md')
-rw-r--r--board/nucleo-h743zi/README.md62
1 files changed, 30 insertions, 32 deletions
diff --git a/board/nucleo-h743zi/README.md b/board/nucleo-h743zi/README.md
index 58d47219da..7ba8a143a3 100644
--- a/board/nucleo-h743zi/README.md
+++ b/board/nucleo-h743zi/README.md
@@ -1,22 +1,19 @@
# Nucleo H743ZI
-This is a simpler EC example for the ST Nucleo H743ZI
-development board.
+This is a simpler EC example for the ST Nucleo H743ZI development board.
# Quick Start
-The Nucleo dev boards have lots of developer friendly features,
-like an in-circuit debugger/programmer/UART-bridge, programmable
-LEDs, and a button, to name a few.
+The Nucleo dev boards have lots of developer friendly features, like an
+in-circuit debugger/programmer/UART-bridge, programmable LEDs, and a button, to
+name a few.
-The built-in debugger can be connected to using a Micro USB cable.
-It provides three great interfaces to the host.
-1. Mass storage interface for drag-drop programming
-2. Full ST-Link in-circuit debugger
-3. UART bridge for logs/consoles
+The built-in debugger can be connected to using a Micro USB cable. It provides
+three great interfaces to the host. 1. Mass storage interface for drag-drop
+programming 2. Full ST-Link in-circuit debugger 3. UART bridge for logs/consoles
-We will use a few of these interfaces below to program and interact
-with out Nucleo dev board.
+We will use a few of these interfaces below to program and interact with out
+Nucleo dev board.
## Build
@@ -26,17 +23,17 @@ make BOARD=nucleo-h743zi -j
## Program
-The easiest way to flash the Nucleo board is to Copy-Paste/Drag-Drop
-the firmware image onto the exposed mass storage drive.
+The easiest way to flash the Nucleo board is to Copy-Paste/Drag-Drop the
+firmware image onto the exposed mass storage drive.
-Open a file browser and `Copy` the file in `build/nucleo-h743zi/ec.bin`.
-Now, find the removable storage that the Nucleo device has presented,
-and `Paste` the file into the directory.
+Open a file browser and `Copy` the file in `build/nucleo-h743zi/ec.bin`. Now,
+find the removable storage that the Nucleo device has presented, and `Paste` the
+file into the directory.
## Interact
-After the Nucelo finishes programming, you can open the EC console.
-On GNU/Linux, this is mapped to `/dev/ttyACM0`.
+After the Nucleo finishes programming, you can open the EC console. On
+GNU/Linux, this is mapped to `/dev/ttyACM0`.
Install `minicom` and issue the following command:
@@ -48,9 +45,9 @@ minicom -D/dev/ttyACM0
A fun EC feature is that unit tests can be run on-device.
-This is made possible by an alternative build rule that generates a
-test image per unit test. These test images use a unit test specific taskset
-and console command to trigger them.
+This is made possible by an alternative build rule that generates a test image
+per unit test. These test images use a unit test specific taskset and console
+command to trigger them.
## Create
@@ -67,19 +64,20 @@ To build all unit test images for this board, run the following command:
make BOARD=nucleo-h743zi tests
```
-You can build a specific unit test image by changing `tests` to `test-aes`,
-for the `aes` unit test.
+You can build a specific unit test image by changing `tests` to `test-aes`, for
+the `aes` unit test.
## Flash
-Copy/paste the `build/nucleo-h743zi/${TEST}/${TEST}.bin` file to the
-Nucleo's mass storage drive, where `${TEST}` is the name of the unit test,
-like `aes`.
+Copy/paste the `build/nucleo-h743zi/${TEST}/${TEST}.bin` file to the Nucleo's
+mass storage drive, where `${TEST}` is the name of the unit test, like `aes`.
## Run
-1. Connect to UART console
- ```bash
- minicom -D/dev/ttyACM0
- ```
-2. Run the `runtest` command \ No newline at end of file
+1. Connect to UART console
+
+```bash
+minicom -D/dev/ttyACM0
+```
+
+1. Run the `runtest` command