feat: translate the rp2040 project template for the rp235x

Author: ithinuel

.cargo/config.toml

@@ -1,25 +1,29 @@
-[target.'cfg(all(target_arch = "arm", target_os = "none"))']
+[target.thumbv8m.main-none-eabihf]
 # Choose a default "cargo run" tool (see README for more info)
 # - `probe-rs` provides flashing and defmt via a hardware debugger, and stack unwind on panic
-# - elf2uf2-rs loads firmware over USB when the rp2040 is in boot mode
-runner = "probe-rs run --chip RP2040 --protocol swd"
-# runner = "elf2uf2-rs -d"
+# - `picotool` loads an elf, skipping unchanged flash sectors, verify it, and execute it
+#runner = "probe-rs run --chip RP235x --protocol swd"
+runner = "picotool load -u -v -x -t elf"
 
-linker = "flip-link"
+# Pass some extra options to rustc, some of which get passed on to the linker.
+#
+# * linker argument --nmagic turns off page alignment of sections (which saves
+#   flash space)
+# * linker argument -Tlink.x tells the linker to use link.x as a linker script.
+#   This is usually provided by the cortex-m-rt crate, and by default the
+#   version in that crate will include a file called `memory.x` which describes
+#   the particular memory layout for your specific chip.
+# * linker argument -Tdefmt.x also tells the linker to use `defmt.x` as a
+#   secondary linker script. This is required to make defmt_rtt work.
 rustflags = [
-  "-C", "link-arg=--nmagic",
-  "-C", "link-arg=-Tlink.x",
-  "-C", "link-arg=-Tdefmt.x",
-
-  # Code-size optimizations.
-  #   trap unreachable can save a lot of space, but requires nightly compiler.
-  #   uncomment the next line if you wish to enable it
-  # "-Z", "trap-unreachable=no",
-  "-C", "no-vectorize-loops",
+    "-C", "link-arg=--nmagic",
+    "-C", "link-arg=-Tlink.x",
+    "-C", "link-arg=-Tdefmt.x",
+    "-C", "target-cpu=cortex-m33",
 ]
 
 [build]
-target = "thumbv6m-none-eabi"
+target = "thumbv8m.main-none-eabihf"
 
 [env]
 DEFMT_LOG = "debug"

.envrc

@@ -0,0 +1 @@
+use flake

.vscode/launch.json

@@ -6,10 +6,10 @@
             "preLaunchTask": "rust: cargo build",
             "type": "probe-rs-debug",
             "request": "launch",
-            "name": "rp2040-project",
+            "name": "rp235x-project",
             "cwd": "${workspaceFolder}",
-            "chip": "rp2040",
-            // RP2040 doesn't support connectUnderReset
+            "chip": "rp235x",
+            // TODO: Does RP235x support connectUnderReset?
             "connectUnderReset": false,
             "speed": 4000,
             "runtimeExecutable": "probe-rs",
@@ -23,16 +23,16 @@
             "coreConfigs": [
                 {
                     "coreIndex": 0,
-                    "programBinary": "target/thumbv6m-none-eabi/debug/rp2040-project-template",
+                    "programBinary": "target/thumbv8m.main-none-eabihf/debug/rp235x-project-template",
                     "rttEnabled": true
                     // Uncomment this if you've downloaded the SVD from
-                    // https://github.com/raspberrypi/pico-sdk/raw/1.3.1/src/rp2040/hardware_regs/rp2040.svd
+                    // https://github.com/raspberrypi/pico-sdk/raw/2.1.1/src/rp2350/hardware_regs/RP2350.svd
                     // and placed it in the .vscode directory
-                    // "svdFile": "./.vscode/rp2040.svd",
+                    // "svdFile": "./.vscode/rp235x.svd",
                 }
             ],
             "consoleLogLevel": "Info", //Error, Warn, Info, Debug, Trace
             "wireProtocol": "Swd"
         }
     ]
-}
+}

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 edition = "2021"
-name = "rp2040-project-template"
+name = "rp235x-project-template"
 version = "0.1.0"
 license = "MIT OR Apache-2.0"
 
@@ -13,64 +13,50 @@ defmt = "1"
 defmt-rtt = "1"
 panic-probe = { version = "1", features = ["print-defmt"] }
 
-# We're using a Pico by default on this template
-rp-pico = "0.9"
-
-# but you can use any BSP. Uncomment this to use the pro_micro_rp2040 BSP instead
-# sparkfun-pro-micro-rp2040 = "0.8"
+# We're using a Pico 2 by default on this template
+#rp-pico2 = "0.9" # TODO: Do we have that crate already ?
 
 # If you're not going to use a Board Support Package you'll need these:
-# rp2040-hal = { version="0.11", features=["rt", "critical-section-impl"] }
-# rp2040-boot2 = "0.3"
+rp235x-hal = { version="0.3", features=["rt", "critical-section-impl"] }
 
 # cargo build/run
 [profile.dev]
-codegen-units = 1
 debug = 2
 debug-assertions = true
-incremental = false
-opt-level = 3
+opt-level = 2
 overflow-checks = true
 
 # cargo build/run --release
 [profile.release]
-codegen-units = 1
 debug = 2
 debug-assertions = false
-incremental = false
 lto = 'fat'
-opt-level = 3
+opt-level = 2
 overflow-checks = false
 
 # do not optimize proc-macro crates = faster builds from scratch
 [profile.dev.build-override]
-codegen-units = 8
 debug = false
 debug-assertions = false
-opt-level = 0
 overflow-checks = false
+opt-level = 0
 
 [profile.release.build-override]
-codegen-units = 8
 debug = false
 debug-assertions = false
-opt-level = 0
 overflow-checks = false
+opt-level = 0
 
 # cargo test
 [profile.test]
-codegen-units = 1
 debug = 2
 debug-assertions = true
-incremental = false
-opt-level = 3
+opt-level = 2
 overflow-checks = true
 
 # cargo test --release
 [profile.bench]
-codegen-units = 1
 debug = 2
 debug-assertions = false
-incremental = false
 lto = 'fat'
 opt-level = 3

README.md

@@ -1,6 +1,6 @@
-# Project template for rp2040-hal
+# Project template for rp235x-hal
 
-This template is intended as a starting point for developing your own firmware based on the rp2040-hal.
+This template is intended as a starting point for developing your own firmware based on the rp235x-hal.
 
 It includes all of the `knurling-rs` tooling as showcased in https://github.com/knurling-rs/app-template (`defmt`, `defmt-rtt`, `panic-probe`, `flip-link`) to make development as easy as possible.
 
@@ -21,7 +21,6 @@ If you aren't using a debugger (or want to use other debugging configurations),
     <li><a href="#project-creation">Project Creation</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="#feature-flags">Feature flags</a></li>
     <li><a href="#roadmap">Roadmap</a></li>
     <li><a href="#contributing">Contributing</a></li>
@@ -37,7 +36,7 @@ If you aren't using a debugger (or want to use other debugging configurations),
 
 - The standard Rust tooling (cargo, rustup) which you can install from https://rustup.rs/
 
-- Toolchain support for the cortex-m0+ processors in the rp2040 (thumbv6m-none-eabi)
+- Toolchain support for the cortex-m33 processors in the rp235x (thumbv8m.main-none-eabihf)
 
 - flip-link - this allows you to detect stack-overflows on the first core, which is the only supported target for now.
 
@@ -55,13 +54,13 @@ If you aren't using a debugger (or want to use other debugging configurations),
 <details open="open">
   <summary><h2 style="display: inline-block" id="installation-of-development-dependencies">Installation of development dependencies</h2></summary>
 
+If you are using Nix, you can use the `devShell` made available in `flake.nix`. Otherwise, you can follow these commands (provided you already have [`Rustup`](https://rustup.rs/) installed):
+
 ```sh
-rustup target install thumbv6m-none-eabi
+rustup target install thumbv8m.main-none-eabihf
 cargo install flip-link
 # Installs the probe-rs tools, including probe-rs run, our recommended default runner
 cargo install --locked probe-rs-tools
-# If you want to use elf2uf2-rs instead, do...
-cargo install --locked elf2uf2-rs
 ```
 If you get the error ``binary `cargo-embed` already exists`` during installation of probe-rs, run `cargo uninstall cargo-embed` to uninstall your older version of cargo-embed before trying again.
 
@@ -74,7 +73,7 @@ If you get the error ``binary `cargo-embed` already exists`` during installation
 ### Using `cargo-generate`
 
 ```sh
-cargo generate --git https://github.com/rp-rs/rp2040-project-template
+cargo generate --git https://github.com/rp-rs/rp235x-project-template
 ```
 
 Follow the wizard 🪄 and enjoy your new project.
@@ -192,30 +191,25 @@ Some of the options for your `runner` are listed below:
   *Step 5* - Launch a debug session by choosing `Run`>`Start Debugging` (or press F5)
 
 * **Loading a UF2 over USB**  
-  *Step 1* - Install [`elf2uf2-rs`](https://github.com/JoNil/elf2uf2-rs):
-
-  ```console
-  $ cargo install elf2uf2-rs --locked
-  ```
+  *Step 1* - Install [`picotool`](https://github.com/raspberrypi/picotool):
 
   *Step 2* - Modify `.cargo/config` to change the default runner
 
   ```toml
   [target.`cfg(all(target-arch = "arm", target_os = "none"))`]
-  runner = "elf2uf2-rs -d"
+  runner = "picotool load -u -v -x -t elf"
   ```
 
   The all-Arm wildcard `'cfg(all(target_arch = "arm", target_os = "none"))'` is used
   by default in the template files, but may also be replaced by
-  `thumbv6m-none-eabi`.
+  `thumbv8m.main-none-eabihf`.
 
-  *Step 3* - Boot your RP2040 into "USB Bootloader mode", typically by rebooting
+  *Step 3* - Boot your RP235x into "USB Bootloader mode", typically by rebooting
   whilst holding some kind of "Boot Select" button. On Linux, you will also need
   to 'mount' the device, like you would a USB Thumb Drive.
 
   *Step 4* - Use `cargo run`, which will compile the code and start the
-  specified 'runner'. As the 'runner' is the `elf2uf2-rs` tool, it will build a UF2
-  file and copy it to your RP2040.
+  specified 'runner'. As the 'runner' is the `picotool`, it will copy the firmware to your RP235x.
 
   ```console
   $ cargo run --release
@@ -236,33 +230,17 @@ Some of the options for your `runner` are listed below:
   information in the ELF file in a way that `picotool info` can read it out, are
   not supported in Rust. An alternative is TBC.
 
-</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>
 
 <!-- Feature flags -->
 <details open="open">
   <summary><h2 style="display: inline-block" id="feature-flags">Feature flags</h2></summary>
 
-  There are several [feature flags in rp2040-hal](https://docs.rs/rp2040-hal/latest/rp2040_hal/#crate-features).
-  If you want to enable some of them, uncomment the `rp2040-hal` dependency in `Cargo.toml` and add the
+  There are several [feature flags in rp235x-hal](https://docs.rs/rp235x-hal/latest/rp235x_hal/#crate-features).
+  If you want to enable some of them, uncomment the `rp235x-hal` dependency in `Cargo.toml` and add the
   desired feature flags there. For example, to enable ROM functions for f64 math using the feature `rom-v2-intrinsics`:
   ```
-  rp2040-hal = { version="0.10", features=["rt", "critical-section-impl", "rom-v2-intrinsics"] }
+  rp235x-hal = { version="0.3", features=["rt", "critical-section-impl", "rom-v2-intrinsics"] }
   ```
 </details>
 
@@ -273,7 +251,7 @@ Some of the options for your `runner` are listed below:
 NOTE These packages are under active development. As such, it is likely to
 remain volatile until a 1.0.0 release.
 
-See the [open issues](https://github.com/rp-rs/rp2040-project-template/issues) for a list of
+See the [open issues](https://github.com/rp-rs/rp235x-project-template/issues) for a list of
 proposed features (and known issues).
 
 ## Contributing
@@ -287,7 +265,7 @@ The steps are:
 3. Make some changes to the code or documentation.
 4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
 5. Push to the Feature Branch (`git push origin feature/AmazingFeature`)
-6. Create a [New Pull Request](https://github.com/rp-rs/rp2040-project-template/pulls)
+6. Create a [New Pull Request](https://github.com/rp-rs/rp235x-project-template/pulls)
 7. An admin will review the Pull Request and discuss any changes that may be required.
 8. Once everyone is happy, the Pull Request can be merged by an admin, and your work is part of our project!
 
@@ -311,5 +289,5 @@ under these terms.
 
 ## Contact
 
-Raise an issue: [https://github.com/rp-rs/rp2040-project-template/issues](https://github.com/rp-rs/rp2040-project-template/issues)
+Raise an issue: [https://github.com/rp-rs/rp235x-project-template/issues](https://github.com/rp-rs/rp235x-project-template/issues)
 Chat to us on Matrix: [#rp-rs:matrix.org](https://matrix.to/#/#rp-rs:matrix.org)

build.rs

@@ -8,24 +8,21 @@
 //! updating `memory.x` ensures a rebuild of the application with the
 //! new memory settings.
 
-use std::env;
 use std::fs::File;
 use std::io::Write;
 use std::path::PathBuf;
 
 fn main() {
-    // Put `memory.x` in our output directory and ensure it's
-    // on the linker search path.
-    let out = &PathBuf::from(env::var_os("OUT_DIR").unwrap());
-    File::create(out.join("memory.x"))
-        .unwrap()
-        .write_all(include_bytes!("memory.x"))
-        .unwrap();
+    // Put the linker script somewhere the linker can find it
+    let out = PathBuf::from(std::env::var_os("OUT_DIR").unwrap());
     println!("cargo:rustc-link-search={}", out.display());
 
-    // By default, Cargo will re-run a build script whenever
-    // any file in the project changes. By specifying `memory.x`
-    // here, we ensure the build script is only re-run when
-    // `memory.x` is changed.
+    // The file `memory.x` is loaded by cortex-m-rt's `link.x` script, which
+    // is what we specify in `.cargo/config.toml` for Arm builds
+    let memory_x = include_bytes!("memory.x");
+    let mut f = File::create(out.join("memory.x")).unwrap();
+    f.write_all(memory_x).unwrap();
     println!("cargo:rerun-if-changed=memory.x");
+
+    println!("cargo:rerun-if-changed=build.rs");
 }

cargo-generate.toml

@@ -7,10 +7,10 @@ pre = ["cargo-generate/remove_rprs.rhai"]
 [placeholders]
 flash_method = { prompt = "Which flashing method do you intend to use?", choices = [
   "probe-rs",
-  "elf2uf2-rs",
+  "picotool",
   "custom",
   "none"
-], default = "probe-rs", type = "string" }
+], default = "picotool", type = "string" }
 
 [conditional.'flash_method == "custom"'.placeholders]
 flash_method_custom = { prompt = "Enter the runner command to use", type = "string" }