summaryrefslogtreecommitdiff
path: root/board/nucleo-h743zi/README.md
diff options
context:
space:
mode:
authorJack Rosenthal <jrosenth@chromium.org>2021-11-04 12:11:58 -0600
committerCommit Bot <commit-bot@chromium.org>2021-11-05 04:22:34 +0000
commit252457d4b21f46889eebad61d4c0a65331919cec (patch)
tree01856c4d31d710b20e85a74c8d7b5836e35c3b98 /board/nucleo-h743zi/README.md
parent08f5a1e6fc2c9467230444ac9b582dcf4d9f0068 (diff)
downloadchrome-ec-stabilize-14388.61.B-ish.tar.gz
In the interest of making long-term branch maintenance incur as little technical debt on us as possible, we should not maintain any files on the branch we are not actually using. This has the added effect of making it extremely clear when merging CLs from the main branch when changes have the possibility to affect us. The follow-on CL adds a convenience script to actually pull updates from the main branch and generate a CL for the update. BUG=b:204206272 BRANCH=ish TEST=make BOARD=arcada_ish && make BOARD=drallion_ish Signed-off-by: Jack Rosenthal <jrosenth@chromium.org> Change-Id: I17e4694c38219b5a0823e0a3e55a28d1348f4b18 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3262038 Reviewed-by: Jett Rink <jettrink@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org>
Diffstat (limited to 'board/nucleo-h743zi/README.md')
-rw-r--r--board/nucleo-h743zi/README.md83
1 files changed, 0 insertions, 83 deletions
diff --git a/board/nucleo-h743zi/README.md b/board/nucleo-h743zi/README.md
deleted file mode 100644
index 7ba8a143a3..0000000000
--- a/board/nucleo-h743zi/README.md
+++ /dev/null
@@ -1,83 +0,0 @@
-# Nucleo H743ZI
-
-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 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.
-
-## Build
-
-```bash
-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.
-
-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 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:
-
-```bash
-minicom -D/dev/ttyACM0
-```
-
-# Unit Testing
-
-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.
-
-## Create
-
-To enable an existing unit test, add it to the [build.mk](build.mk)'s
-`test-list-y` variable.
-
-See the main [README.md](/README.md) on how to write a new unit test.
-
-## Build
-
-To build all unit test images for this board, run the following command:
-
-```bash
-make BOARD=nucleo-h743zi tests
-```
-
-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`.
-
-## Run
-
-1. Connect to UART console
-
-```bash
-minicom -D/dev/ttyACM0
-```
-
-1. Run the `runtest` command