diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/examples/basic/.cargo/config.toml | 4 | ||||
| -rw-r--r-- | docs/examples/layer-by-layer/.cargo/config.toml | 3 | ||||
| -rw-r--r-- | docs/pages/faq.adoc | 2 | ||||
| -rw-r--r-- | docs/pages/getting_started.adoc | 2 | ||||
| -rw-r--r-- | docs/pages/imxrt.adoc | 3 | ||||
| -rw-r--r-- | docs/pages/new_project.adoc | 2 | ||||
| -rw-r--r-- | docs/pages/project_structure.adoc | 4 |
7 files changed, 11 insertions, 9 deletions
diff --git a/docs/examples/basic/.cargo/config.toml b/docs/examples/basic/.cargo/config.toml index 8ca28df39..17616a054 100644 --- a/docs/examples/basic/.cargo/config.toml +++ b/docs/examples/basic/.cargo/config.toml | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | [target.'cfg(all(target_arch = "arm", target_os = "none"))'] | 1 | [target.'cfg(all(target_arch = "arm", target_os = "none"))'] |
| 2 | # replace nRF82840_xxAA with your chip as listed in `probe-run --list-chips` | 2 | # replace nRF82840_xxAA with your chip as listed in `probe-rs chip list` |
| 3 | runner = "probe-run --chip nRF52840_xxAA" | 3 | runner = "probe-rs run --chip nRF52840_xxAA" |
| 4 | 4 | ||
| 5 | [build] | 5 | [build] |
| 6 | target = "thumbv7em-none-eabi" | 6 | target = "thumbv7em-none-eabi" |
diff --git a/docs/examples/layer-by-layer/.cargo/config.toml b/docs/examples/layer-by-layer/.cargo/config.toml index 3012f05dc..f30d9e446 100644 --- a/docs/examples/layer-by-layer/.cargo/config.toml +++ b/docs/examples/layer-by-layer/.cargo/config.toml | |||
| @@ -1,5 +1,6 @@ | |||
| 1 | [target.'cfg(all(target_arch = "arm", target_os = "none"))'] | 1 | [target.'cfg(all(target_arch = "arm", target_os = "none"))'] |
| 2 | runner = "probe-run --chip STM32L475VG" | 2 | # replace your chip as listed in `probe-rs chip list` |
| 3 | runner = "probe-rs run --chip STM32L475VG" | ||
| 3 | 4 | ||
| 4 | rustflags = [ | 5 | rustflags = [ |
| 5 | "-C", "link-arg=--nmagic", | 6 | "-C", "link-arg=--nmagic", |
diff --git a/docs/pages/faq.adoc b/docs/pages/faq.adoc index a535e89f8..b21be9a30 100644 --- a/docs/pages/faq.adoc +++ b/docs/pages/faq.adoc | |||
| @@ -268,7 +268,7 @@ General steps: | |||
| 268 | 1. Find out which memory region BDMA has access to. You can get this information from the bus matrix and the memory mapping table in the STM32 datasheet. | 268 | 1. Find out which memory region BDMA has access to. You can get this information from the bus matrix and the memory mapping table in the STM32 datasheet. |
| 269 | 2. Add the memory region to `memory.x`, you can modify the generated one from https://github.com/embassy-rs/stm32-data-generated/tree/main/data/chips. | 269 | 2. Add the memory region to `memory.x`, you can modify the generated one from https://github.com/embassy-rs/stm32-data-generated/tree/main/data/chips. |
| 270 | 3. You might need to modify `build.rs` to make cargo pick up the modified `memory.x`. | 270 | 3. You might need to modify `build.rs` to make cargo pick up the modified `memory.x`. |
| 271 | 4. In your code, access the defined memory region using `#[link_section = ".xxx"]` | 271 | 4. In your code, access the defined memory region using `#[unsafe(link_section = ".xxx")]` |
| 272 | 5. Copy data to that region before using BDMA. | 272 | 5. Copy data to that region before using BDMA. |
| 273 | 273 | ||
| 274 | See link:https://github.com/embassy-rs/embassy/blob/main/examples/stm32h7/src/bin/spi_bdma.rs[SMT32H7 SPI BDMA example] for more details. | 274 | See link:https://github.com/embassy-rs/embassy/blob/main/examples/stm32h7/src/bin/spi_bdma.rs[SMT32H7 SPI BDMA example] for more details. |
diff --git a/docs/pages/getting_started.adoc b/docs/pages/getting_started.adoc index 954f3fd28..d1f65a885 100644 --- a/docs/pages/getting_started.adoc +++ b/docs/pages/getting_started.adoc | |||
| @@ -66,7 +66,7 @@ If everything worked correctly, you should see a blinking LED on your board, and | |||
| 66 | [source] | 66 | [source] |
| 67 | ---- | 67 | ---- |
| 68 | Finished dev [unoptimized + debuginfo] target(s) in 1m 56s | 68 | Finished dev [unoptimized + debuginfo] target(s) in 1m 56s |
| 69 | Running `probe-run --chip STM32F407VGTx target/thumbv7em-none-eabi/debug/blinky` | 69 | Running `probe-rs run --chip STM32F407VGTx target/thumbv7em-none-eabi/debug/blinky` |
| 70 | (HOST) INFO flashing program (71.36 KiB) | 70 | (HOST) INFO flashing program (71.36 KiB) |
| 71 | (HOST) INFO success! | 71 | (HOST) INFO success! |
| 72 | ──────────────────────────────────────────────────────────────────────────────── | 72 | ──────────────────────────────────────────────────────────────────────────────── |
diff --git a/docs/pages/imxrt.adoc b/docs/pages/imxrt.adoc index adf5218e8..bbd65e494 100644 --- a/docs/pages/imxrt.adoc +++ b/docs/pages/imxrt.adoc | |||
| @@ -9,5 +9,6 @@ The link: link:https://github.com/embassy-rs/embassy/tree/main/embassy-imxrt[Emb | |||
| 9 | 9 | ||
| 10 | The following peripherals have a HAL implementation at present | 10 | The following peripherals have a HAL implementation at present |
| 11 | 11 | ||
| 12 | * CRC | ||
| 12 | * GPIO | 13 | * GPIO |
| 13 | 14 | * RNG | |
diff --git a/docs/pages/new_project.adoc b/docs/pages/new_project.adoc index af1cb75c5..cd943b4f6 100644 --- a/docs/pages/new_project.adoc +++ b/docs/pages/new_project.adoc | |||
| @@ -150,7 +150,7 @@ stm32g474-example | |||
| 150 | # Before upgrading check that everything is available on all tier1 targets here: | 150 | # Before upgrading check that everything is available on all tier1 targets here: |
| 151 | # https://rust-lang.github.io/rustup-components-history | 151 | # https://rust-lang.github.io/rustup-components-history |
| 152 | [toolchain] | 152 | [toolchain] |
| 153 | channel = "nightly-2023-11-01" | 153 | channel = "1.85" |
| 154 | components = [ "rust-src", "rustfmt", "llvm-tools", "miri" ] | 154 | components = [ "rust-src", "rustfmt", "llvm-tools", "miri" ] |
| 155 | targets = ["thumbv7em-none-eabi"] | 155 | targets = ["thumbv7em-none-eabi"] |
| 156 | ---- | 156 | ---- |
diff --git a/docs/pages/project_structure.adoc b/docs/pages/project_structure.adoc index 722ec8d9d..227508b97 100644 --- a/docs/pages/project_structure.adoc +++ b/docs/pages/project_structure.adoc | |||
| @@ -85,9 +85,9 @@ A minimal example: | |||
| 85 | [source,toml] | 85 | [source,toml] |
| 86 | ---- | 86 | ---- |
| 87 | [toolchain] | 87 | [toolchain] |
| 88 | channel = "nightly-2023-08-19" # <- as of writing, this is the exact rust version embassy uses | 88 | channel = "1.85" # <- as of writing, this is the exact rust version embassy uses |
| 89 | components = [ "rust-src", "rustfmt" ] # <- optionally add "llvm-tools-preview" for some extra features like "cargo size" | 89 | components = [ "rust-src", "rustfmt" ] # <- optionally add "llvm-tools-preview" for some extra features like "cargo size" |
| 90 | targets = [ | 90 | targets = [ |
| 91 | "thumbv6m-none-eabi" # <-change for your platform | 91 | "thumbv6m-none-eabi" # <- change for your platform |
| 92 | ] | 92 | ] |
| 93 | ---- | 93 | ---- |
