mirrors/embedded-trainings-2020
1
0
Fork 0
mirror of https://github.com/ferrous-systems/embedded-trainings-2020.git synced 2024-05-05 10:09:08 +00:00
Code Issues Projects Releases Wiki Activity

documentation fix

Browse source
This commit is contained in:
Amanjeev Sethi 2023-06-21 14:40:02 -04:00
parent 22bf96a0c4
commit 6dd2ae5e19
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
embedded-workshop-book/src/api-documentation.md
View file

@ -9,4 +9,4 @@ $ cargo doc -p dk --open
```
> NOTE: If you are using Safari and the documentation is hard to read due to missing CSS, try opening it in a different browser.
> ❗️ If you are using Safari and the documentation is hard to read due to missing CSS, try opening it in a different browser.

8
embedded-workshop-book/src/hello-world.md
View file

@ -4,7 +4,7 @@ In this section, we'll set up the integration in VS Code and run the first progr
✅ Open the `advanced/firmware` folder in VS Code and open the `src/bin/hello.rs` file.
> Note: To ensure full rust-analyzer support, do not open the whole `embedded-trainings-2020` folder.
> ❗️ To ensure full rust-analyzer support, do not open the whole `embedded-trainings-2020` folder.
Give rust-analyzer some time to analyze the file and its dependency graph. When it's done, a "Run" button will appear over the `main` function. If it doesn't appear on its own, type something in the file, delete and save. This should trigger a re-load.
@ -12,11 +12,11 @@ Give rust-analyzer some time to analyze the file and its dependency graph. When
If you are not using VS code run the `cargo run --bin hello` command from the `advanced/firmware` folder.
> NOTE if you run into an error along the lines of "Debug power request failed" retry the operation and the error should disappear
> ❗️ If you run into an error along the lines of "Debug power request failed" retry the operation and the error should disappear
The `firmware` workspace has been configured to cross-compile applications to the ARM Cortex-M architecture and then run them using the `probe-run` custom Cargo runner. The `probe-run` tool will load and run the embedded application on the microcontroller and collect logs from the microcontroller.
The `firmware` workspace has been configured to cross-compile applications to the ARM Cortex-M architecture and then run them using the `probe-run` custom Cargo runner. This is set in `.cargo/config.toml`. The `probe-run` tool will load and run the embedded application on the microcontroller and collect logs from the microcontroller.
The `probe-run` process will terminate when the microcontroller enters the "halted" state. From the embedded application, one can enter the "halted" state using the `asm::bkpt` function. For convenience, an `exit` function is provided in the `dk` Hardware Abstraction Layer (HAL). This function is divergent like `std::process::exit` (`fn() -> !`) and can be used to halt the device and terminate the `probe-run` process.
Note that when the `probe-run` tool sees the device enter the halted state it will proceed to *reset-halt* the device. This is particularly important when writing USB applications because simply leaving the device in a halted state will make it appear as an unresponsive USB device to the host. Some OSes (e.g. Linux) will try to make an unresponsive device respond by power cycling the entire USB bus -- this will cause all other USB devices on the bus to be re-enumerated. Reset-halting the device will cause it to be electrically disconnected from the host USB bus and avoid the "power cycle the whole USB bus" scenario.
>🔎 When the `probe-run` tool sees the device enter the halted state it will proceed to *reset-halt* the device. This is particularly important when writing USB applications because simply leaving the device in a halted state will make it appear as an unresponsive USB device to the host. Some OSes (e.g. Linux) will try to make an unresponsive device respond by power cycling the entire USB bus -- this will cause all other USB devices on the bus to be re-enumerated. Reset-halting the device will cause it to be electrically disconnected from the host USB bus and avoid the "power cycle the whole USB bus" scenario.