Add support for nullbits BIT-C PRO

Cargo.toml

@@ -10,6 +10,7 @@ members = [
     "boards/adafruit-trinkey-qt2040",
     "boards/arduino_nano_connect",
     "boards/boardsource-blok",
+    "boards/nullbits-bit-c-pro",
     "boards/pimoroni_badger2040",
     "boards/pimoroni-pico-explorer",
     "boards/pimoroni-pico-lipo-16mb",
@@ -48,7 +49,7 @@ hd44780-driver = "0.4.0"
 heapless = "0.7.16"
 i2c-pio = "0.8.0"
 nb = "1.1"
-panic-halt= "0.2.0"
+panic-halt = "0.2.0"
 panic-probe = "0.3.1"
 pio = "0.2.1"
 pio-proc = "0.2.2"

README.md

@@ -191,6 +191,19 @@ RP2040 chip according to how it is connected up on the Blok.
 [boardsource-blok]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/boardsource-blok
 [Boardsource]: https://boardsource.xyz/
 
+### [nullbits-bit-c-pro] - Board Support for the [BIT-C PRO]
+
+You should include this crate if you are writing code that you want to run on
+a [BIT-C PRO] - an RP2040 based controller, made by [nullbits],
+built for the keyboard community.
+
+This crate includes the [rp2040-hal], but also configures each pin of the
+RP2040 chip according to how it is connected up on the BIT-C PRO.
+
+[nullbits-bit-c-pro]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/nullbits-bit-c-pro
+[BIT-C PRO]: https://nullbits.co/bit-c-pro
+[nullbits]: https://nullbits.co/
+
 ### [pimoroni_badger2040] - Board Support for the [Pimoroni Badger2040]
 
 You should include this crate if you are writing code that you want to run on

boards/nullbits-bit-c-pro/.gitignore

@@ -0,0 +1,11 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk

boards/nullbits-bit-c-pro/CHANGELOG.md

@@ -0,0 +1,12 @@
+# 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
+
+## 0.1.0 - 2024-04-05
+
+- Initial release

boards/nullbits-bit-c-pro/Cargo.toml

@@ -0,0 +1,51 @@
+[package]
+name = "nullbits-bit-c-pro"
+version = "0.1.0"
+edition = "2021"
+authors = ["Ian McLinden", "The rp-rs Developers"]
+homepage = "https://github.com/rp-rs/rp-hal-boards/tree/main/boards/nullbits-bit-c-pro"
+description = "Board Support Package for the rp2040 based BIT-C PRO"
+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 }
+rp2040-boot2 = { workspace = true, optional = true }
+rp2040-hal.workspace = true
+
+[dev-dependencies]
+cortex-m.workspace = true
+panic-halt.workspace = true
+embedded-hal.workspace = true
+usb-device.workspace = true
+usbd-hid.workspace = true
+critical-section.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 also works for RP2040 B2 and above
+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/nullbits-bit-c-pro/README.md

@@ -0,0 +1,103 @@
+# [nullbits-bit-c-pro] - Board Support for the [BIT-C PRO]
+
+You should include this crate if you are writing code that you want to run on
+a [BIT-C PRO] - an RP2040 based controller, made by [nullbits], built for the keyboard community. 
+
+This crate includes the [rp2040-hal], but also configures each pin of the
+RP2040 chip according to how it is connected up on the BIT-C PRO.
+
+More Information about the board from the [BIT-C PRO Docs].
+A [pinout diagram] is also available.
+
+[nullbits-bit-c-pro]: https://github.com/rp-rs/rp-hal-boards/tree/main/boards/nullbits-bit-c-pro
+[BIT-C PRO]: https://nullbits.co/bit-c-pro
+[nullbits]: https://nullbits.co/
+[BIT-C PRO Docs]: https://github.com/nullbitsco/docs/blob/main/bit-c-pro/user_guide_en.md
+[pinout diagram]: https://nullbits.co/static/img/bitc_pro_pinout.png
+
+## Using
+
+To use this crate, your `Cargo.toml` file should contain:
+
+```toml
+nullbits-bit-c-pro = "0.1.0"
+```
+
+In your program, you will need to call `nullbits_bit_c_pro::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/nullbits-bit-c-pro $ 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/nullbits-bit-c-pro $ 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 try repeating the `cargo run` command above.
+
+### [bit_c_pro_blinky](./examples/bit_c_pro_blinky.rs)
+
+Flashes the BIT-C PRO's three on-board LEDs in sequence.
+
+### [bit_c_pro_hid_keyboard](./examples/bit_c_pro_hid_keyboard.rs)
+
+Demonstrates emulating a USB Human Input Device (HID) Keyboard.
+
+## 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/nullbits-bit-c-pro/examples/bit_c_pro_blinky.rs

@@ -0,0 +1,69 @@
+//! Blinks the 3 colour LEDs on a BIT-C PRO in sequence
+#![no_std]
+#![no_main]
+
+use embedded_hal::digital::OutputPin;
+use panic_halt as _;
+
+use nullbits_bit_c_pro as bsp;
+
+use bsp::hal::{
+    clocks::{init_clocks_and_plls, Clock},
+    gpio::PinState,
+    pac,
+    sio::Sio,
+    watchdog::Watchdog,
+};
+
+/// Entry point to our bare-metal application.
+///
+/// The `#[rp2040_hal::entry]` macro ensures the Cortex-M start-up code calls this function
+/// as soon as all global variables and the spinlock are initialised.
+#[rp2040_hal::entry]
+fn main() -> ! {
+    let mut pac = pac::Peripherals::take().unwrap();
+    let core = pac::CorePeripherals::take().unwrap();
+    let mut watchdog = Watchdog::new(pac.WATCHDOG);
+    let sio = Sio::new(pac.SIO);
+
+    let clocks = init_clocks_and_plls(
+        bsp::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 pins = bsp::Pins::new(
+        pac.IO_BANK0,
+        pac.PADS_BANK0,
+        sio.gpio_bank0,
+        &mut pac.RESETS,
+    );
+
+    let mut led_red = pins.led_red.into_push_pull_output_in_state(PinState::High);
+    let mut led_green = pins
+        .led_green
+        .into_push_pull_output_in_state(PinState::High);
+    let mut led_blue = pins.led_blue.into_push_pull_output_in_state(PinState::High);
+
+    loop {
+        led_red.set_low().unwrap();
+        delay.delay_ms(500);
+        led_red.set_high().unwrap();
+        led_green.set_low().unwrap();
+        delay.delay_ms(500);
+        led_green.set_high().unwrap();
+        led_blue.set_low().unwrap();
+        delay.delay_ms(500);
+        led_blue.set_high().unwrap();
+    }
+}
+
+// End of file