Add support for Adafruit CANBus Feather RP2040 (supersedes #36)

Cargo.toml

@@ -2,6 +2,7 @@
 resolver = "2"
 members = [
     "boards/adafruit-feather-rp2040",
+    "boards/adafruit-canbus-feather-rp2040",
     "boards/adafruit-itsy-bitsy-rp2040",
     "boards/adafruit-kb2040",
     "boards/adafruit-macropad",
@@ -26,7 +27,7 @@ members = [
     "boards/vcc-gnd-yd-rp2040",
     "boards/waveshare-rp2040-zero",
     "boards/waveshare-rp2040-lcd-0-96",
-	"boards/waveshare-rp2040-lcd-1-28",
+    "boards/waveshare-rp2040-lcd-1-28",
 ]
 
 [workspace.dependencies]
@@ -39,20 +40,24 @@ defmt = "0.3.5"
 defmt-rtt = "0.4.0"
 display-interface = "0.4.1"
 display-interface-spi = "0.4.1"
+embedded-can = "0.4.1"
 embedded-graphics = "0.7.1"
 embedded-hal = "1.0.0"
+embedded-hal-bus = "0.2.0"
 embedded-hal-nb = "1.0.0"
 embedded-sdmmc = "0.5.0"
 embedded_hal_0_2 = { package = "embedded-hal", version = "0.2.5", features = ["unproven", ] }
 fugit = "0.3.7"
 hd44780-driver = "0.4.0"
 heapless = "0.7.16"
 i2c-pio = "0.8.0"
+mcp25xx = "0.2.0"
 nb = "1.1"
 panic-halt= "0.2.0"
 panic-probe = "0.3.1"
 pio = "0.2.1"
 pio-proc = "0.2.2"
+portable-atomic = "1.9.0"
 rp2040-boot2 = "0.3.0"
 rp2040-hal = "0.10.0"
 st7789 = "0.6.1"

README.md

@@ -112,6 +112,19 @@ RP2040 chip according to how it is connected up on the Feather RP2040.
 [Adafruit Feather RP2040]: https://www.adafruit.com/product/4884
 [adafruit-feather-rp2040]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/adafruit-feather-rp2040
 
+### [adafruit-canbus-feather-rp2040] - Board Support for the [Adafruit CANBus Feather RP2040]
+
+The [Adafruit CANBus Feather RP2040] is similar to the regular 2040 board above,
+but it adds an [MCP25625] CAN controller with integrated transceiver.
+
+This crate includes the [rp2040-hal], but also configures each pin of the RP2040
+chip according to how it is connected on the CANBus Feather.
+
+[Adafruit CANBus Feather RP2040]: https://www.adafruit.com/product/5724
+[adafruit-canbus-feather-rp2040]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/adafruit-canbus-feather-rp2040
+[MCP25625]: https://ww1.microchip.com/downloads/aemDocuments/documents/OTH/ProductDocuments/DataSheets/MCP25625-CAN-Controller-Data-Sheet-20005282C.pdf
+[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
+
 ### [adafruit-itsy-bitsy-rp2040] - Board Support for the [Adafruit ItsyBitsy RP2040]
 
 You should include this crate if you are writing code that you want to run on

boards/adafruit-canbus-feather-rp2040/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+- Initial release

boards/adafruit-canbus-feather-rp2040/Cargo.toml

@@ -0,0 +1,55 @@
+[package]
+name = "adafruit-canbus-feather-rp2040"
+version = "0.1.0"
+authors = ["Ethan Creeger <[email protected]>", "Thad House <[email protected]>", "The rp-rs Developers"]
+edition = "2018"
+homepage = "https://github.com/rp-rs/rp-hal-boards/tree/main/boards/adafruit-canbus-feather-rp2040"
+description = "Board Support Package for the Adafruit CANBus Feather RP2040"
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/rp-rs/rp-hal-boards.git"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+cortex-m-rt = { workspace = true, optional = true }
+embedded-hal-bus.workspace = true
+rp2040-boot2 = { workspace = true, optional = true }
+rp2040-hal.workspace = true
+
+[dev-dependencies]
+cortex-m.workspace = true
+panic-halt.workspace = true
+embedded-can.workspace = true
+embedded-hal.workspace = true
+fugit.workspace = true
+mcp25xx = { workspace = true, features = ["mcp25625"] }
+nb.workspace = true
+portable-atomic = { workspace = true, features = ["critical-section"] }
+smart-leds.workspace = true
+ws2812-pio.workspace = true
+
+[features]
+# This is the set of features we enable by default
+default = ["boot2", "rt", "critical-section-impl", "rom-func-cache"]
+
+# critical section that is safe for multicore use
+critical-section-impl = ["rp2040-hal/critical-section-impl"]
+
+# 2nd stage bootloaders for rp2040
+boot2 = ["rp2040-boot2"]
+
+# Minimal startup / runtime for Cortex-M microcontrollers
+rt = ["cortex-m-rt","rp2040-hal/rt"]
+
+# This enables a fix for USB errata 5: USB device fails to exit RESET state on busy USB bus.
+# Only required for RP2040 B0 and RP2040 B1, but it doesn't hurt to enable it
+rp2040-e5 = ["rp2040-hal/rp2040-e5"]
+
+# Memoize(cache) ROM function pointers on first use to improve performance
+rom-func-cache = ["rp2040-hal/rom-func-cache"]
+
+# Disable automatic mapping of language features (like floating point math) to ROM functions
+disable-intrinsics = ["rp2040-hal/disable-intrinsics"]
+
+# This enables ROM functions for f64 math that were not present in the earliest RP2040s
+rom-v2-intrinsics = ["rp2040-hal/rom-v2-intrinsics"]

boards/adafruit-canbus-feather-rp2040/README.md

@@ -0,0 +1,110 @@
+# [adafruit-canbus-feather-rp2040] - Board Support for the [Adafruit CANBus Feather RP2040]
+
+You should include this crate if you are writing code that you want to run on
+an [Adafruit CANBus Feather RP2040] - a Feather form-factor RP2040 board from
+Adafruit with built in CAN Bus support.
+
+This crate includes the [rp2040-hal], but also configures each pin of the RP2040
+chip according to how it is connected on the Feather.
+
+The board's CAN header is wired up to an [MCP25625] CAN controller which
+includes an integrated transceiver. That device is made available to you on the
+SPI1 bus. See src/lib.rs and the [Adafruit docs] for complete pinout, and check
+the examples for a simple send/receive on 500k CAN.
+
+[Adafruit CANBus Feather RP2040]: https://www.adafruit.com/product/5724
+[adafruit-canbus-feather-rp2040]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/adafruit-canbus-feather-rp2040
+[rp2040-hal]: https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal
+[MCP25625]: https://ww1.microchip.com/downloads/aemDocuments/documents/OTH/ProductDocuments/DataSheets/MCP25625-CAN-Controller-Data-Sheet-20005282C.pdf
+[Adafruit docs]: https://learn.adafruit.com/adafruit-rp2040-can-bus-feather/pinouts
+
+## Using
+
+To use this crate, your `Cargo.toml` file should contain:
+
+```toml
+adafruit-canbus-feather-rp2040 = "0.1.0"
+```
+
+In your program, you will need to call `adafruit_canbus_feather_rp2040::Pins::new` to create
+a new `Pins` structure. This will set up all the GPIOs for any on-board
+devices. See the [examples](./examples) folder for more details.
+
+## Examples
+
+### General Instructions
+
+To compile an example, clone the _rp-hal-boards_ repository and run:
+
+```console
+rp-hal-boards/boards/adafruit-canbus-feather-rp2040 $ cargo build --release --example <name>
+```
+
+You will get an ELF file called
+`./target/thumbv6m-none-eabi/release/examples/<name>`, where the `target`
+folder is located at the top of the _rp-hal-boards_ repository checkout. Normally
+you would also need to specify `--target=thumbv6m-none-eabi` but when
+building examples from this git repository, that is set as the default.
+
+If you want to convert the ELF file to a UF2 and automatically copy it to the
+USB drive exported by the RP2040 bootloader, simply boot your board into
+bootloader mode and run:
+
+```console
+rp-hal-boards/boards/adafruit-canbus-feather-rp2040 $ cargo run --release --example <name>
+```
+
+If you get an error about not being able to find `elf2uf2-rs`, try:
+
+```console
+$ cargo install elf2uf2-rs, then repeating the `cargo run` command above.
+```
+
+### [adafruit_canbus_feather_blinky](./examples/adafruit_canbus_feather_blinky.rs)
+
+Flashes the Feather's onboard LED on and off.
+
+### [adafruit_canbus_feather_neopixel_rainbow](./examples/adafruit_canbus_feather_neopixel_rainbow.rs)
+
+Flows smoothly through various colors on the Feather's onboard NeoPixel LED.
+
+### [adafruit_canbus_feather_can](./examples/adafruit_canbus_feather_can.rs)
+
+Flashes onboard LED and transmits on MCP25625 CAN once per second. LED goes
+solid upon receipt of any CAN message.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to
+be, learn, inspire, and create. Any contributions you make are **greatly
+appreciated**.
+
+The steps are:
+
+1. Fork the Project by clicking the 'Fork' button at the top of the page.
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+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/rp-hal-boards/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!
+
+## Code of Conduct
+
+Contribution to this crate is organized under the terms of the [Rust Code of
+Conduct][CoC], and the maintainer of this crate, the [rp-rs team], promises
+to intervene to uphold that code of conduct.
+
+[CoC]: CODE_OF_CONDUCT.md
+[rp-rs team]: https://github.com/orgs/rp-rs/teams/rp-rs
+
+## License
+
+The contents of this repository are dual-licensed under the _MIT OR Apache
+2.0_ License. That means you can choose either the MIT license or the
+Apache-2.0 license when you re-use this code. See `MIT` or `APACHE2.0` for more
+information on each specific license.
+
+Any submissions to this project (e.g. as Pull Requests) must be made available
+under these terms.

boards/adafruit-canbus-feather-rp2040/examples/adafruit_canbus_feather_blinky.rs

@@ -0,0 +1,56 @@
+//! Blinks the LED on a Adafruit Feather RP2040 board
+//!
+//! This will blink on-board LED.
+#![no_std]
+#![no_main]
+
+use adafruit_canbus_feather_rp2040::entry;
+use adafruit_canbus_feather_rp2040::{
+    hal::{
+        clocks::{init_clocks_and_plls, Clock},
+        pac,
+        watchdog::Watchdog,
+        Sio,
+    },
+    Pins, XOSC_CRYSTAL_FREQ,
+};
+use embedded_hal::digital::OutputPin;
+use panic_halt as _;
+
+#[entry]
+fn main() -> ! {
+    let mut pac = pac::Peripherals::take().unwrap();
+    let core = pac::CorePeripherals::take().unwrap();
+
+    let mut watchdog = Watchdog::new(pac.WATCHDOG);
+
+    let clocks = init_clocks_and_plls(
+        XOSC_CRYSTAL_FREQ,
+        pac.XOSC,
+        pac.CLOCKS,
+        pac.PLL_SYS,
+        pac.PLL_USB,
+        &mut pac.RESETS,
+        &mut watchdog,
+    )
+    .ok()
+    .unwrap();
+
+    let mut delay = cortex_m::delay::Delay::new(core.SYST, clocks.system_clock.freq().to_Hz());
+
+    let sio = Sio::new(pac.SIO);
+    let pins = Pins::new(
+        pac.IO_BANK0,
+        pac.PADS_BANK0,
+        sio.gpio_bank0,
+        &mut pac.RESETS,
+    );
+    let mut led_pin = pins.d13.into_push_pull_output();
+
+    loop {
+        led_pin.set_high().unwrap();
+        delay.delay_ms(1500);
+        led_pin.set_low().unwrap();
+        delay.delay_ms(1500);
+    }
+}