Skip to content

Commit d4bf08a

Browse files
committed
README: Documented new Makefile
1 parent e3f5a7a commit d4bf08a

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

boards/nucleo_u545re_q/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,40 +14,40 @@ make
1414

1515
## Programming and Deployment
1616

17-
The Makefile in this directory provides several helper targets for deployment:
17+
The Makefile for this board is simplified to focus on OpenOCD-based deployment.
18+
19+
### Makefile Targets
1820

1921
| Target | Description |
2022
| :--- | :--- |
2123
| **`make`** | Compiles the Tock kernel for the Nucleo-U545RE-Q. |
22-
| **`make flash`** | Flashes **only the kernel** to the board using `probe-rs`. |
23-
| **`make flash_ocd`** | Flashes **only the kernel** to the board using `openocd`. |
24-
| **`make app`** | Merges the kernel with a userspace app (`.tbf`) into a single unified ELF. Requires `APP_PATH`. |
25-
| **`make app_flash`** | Compiles, merges, and **flashes both the kernel and app** in one step using `probe-rs`. |
26-
| **`make app_flash_ocd`** | Compiles, merges, and **flashes both the kernel and app** in one step using `openocd`. |
24+
| **`make flash`** | Flashes the release kernel using `openocd`. |
25+
| **`make flash-debug`** | Flashes the debug kernel using `openocd`. |
26+
| **`make program`** | Installs apps using `tockloader` via `openocd`. Requires `APP`. |
27+
| **`make install`** | Alias for `make flash`. |
2728

2829
### Usage Examples
2930

30-
**1. Flash only the kernel:**
31+
**1. Flash the release kernel:**
3132
```bash
3233
make flash
33-
# OR
34-
make flash_ocd
3534
```
3635

37-
**2. Flash kernel merged with a specific app:**
36+
**2. Flash the debug kernel:**
37+
```bash
38+
make flash-debug
39+
```
40+
41+
**3. Install an application:**
42+
Note: This requires a `.tab` (Tock Application Bundle) file.
3843
```bash
39-
# Provide the path to your compiled Tock Binary Format (.tbf) file
40-
make app_flash APP_PATH=/path/to/your/app.tbf
41-
# OR
42-
make app_flash_ocd APP_PATH=/path/to/your/app.tbf
44+
make program APP=/path/to/your/app.tab
4345
```
4446

4547
## Flashing Notes
4648

47-
This board is flashed using **`probe-rs`** or **`openocd`**. Due to the specific
48-
memory layout and metadata sections of the STM32U5, the Makefile surgically
49-
extracts executable sections (stripping metadata like `.ARM.attributes`) before
50-
flashing to prevent errors when writing to protected system memory addresses.
49+
This board is flashed using **`openocd`**. The Makefile handles the necessary
50+
initialization and mass erase before programming.
5151

5252
### OpenOCD Requirements
5353

0 commit comments

Comments
 (0)