Merge pull request #62 from s7rul/no_pico_hal_docs

Added section for note about rp2040_boot2
This commit is contained in:
Jan Niehusmann 2023-06-17 10:26:47 +02:00 committed by GitHub
commit 4db7b897e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -20,6 +20,7 @@ If you aren't using a debugger (or want to use cargo-embed/probe-rs-debugger), c
<li><a href="#installation-of-development-dependencies">Installation of development dependencies</a></li>
<li><a href="#running">Running</a></li>
<li><a href="#alternative-runners">Alternative runners</a></li>
<li><a href="#notes-on-using-rp2040_boot2">Notes on using rp2040_boot2</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#code-of-conduct">Code of conduct</a></li>
@ -231,6 +232,24 @@ Some of the options for your `runner` are listed below:
</details>
</details>
<!-- Notes on using rp2040_hal and rp2040_boot2 -->
<details open="open">
<summary><h2 style="display: inline-block" id="notes-on-using-rp2040_boot2">Notes on using rp2040_boot2</h2></summary>
The second-stage boot loader must be written to the .boot2 section. That
is usually handled by the board support package (e.g.`rp-pico`). If you don't use
one, you should initialize the boot loader manually. This can be done by adding the
following to the beginning of main.rs:
```rust
use rp2040_boot2;
#[link_section = ".boot2"]
#[used]
pub static BOOT_LOADER: [u8; 256] = rp2040_boot2::BOOT_LOADER_W25Q080;
```
</details>
<!-- ROADMAP -->
## Roadmap