/src/lib.rs
#![no_std]
//! A Hardware Abstraction Layer for the DoA Hallönbrod.
//!
//! This crate serves as a HAL (Hardware Abstraction Layer) for the DoA Hallönbrod. Since the DoA Hallönbrod
//! is based on the RP2040 chip, it re-exports the [rp2040_hal] crate which contains the tooling to work with the
//! rp2040 chip.
//!
//! # Examples:
//!
//! The following example turns on the onboard LED. Note that most of the logic works through the [rp2040_hal] crate.
//! ```ignore
//! #![no_main]
//! use rp_pico::entry;
//! use panic_halt as _;
//! use embedded_hal::digital::v2::OutputPin;
//! use rp_pico::hal::pac;
//! use rp_pico::hal;
//! #[entry]
//! fn does_not_have_to_be_main() -> ! {
//! let mut pac = pac::Peripherals::take().unwrap();
//! let sio = hal::Sio::new(pac.SIO);
//! let pins = rp_pico::Pins::new(
//! pac.IO_BANK0,
//! pac.PADS_BANK0,
//! sio.gpio_bank0,
//! &mut pac.RESETS,
//! );
//! let mut led_pin = pins.led.into_push_pull_output();
//! led_pin.set_high().unwrap();
//! loop {
//! }
//! }
//! ```
pub extern crate rp2040_hal as hal;
#[cfg(feature = "rt")]
extern crate cortex_m_rt;
/// The `entry` macro declares the starting function to the linker.
/// This is similar to the `main` function in console applications.
///
/// It is based on the [cortex_m_rt](https://docs.rs/cortex-m-rt/latest/cortex_m_rt/attr.entry.html) crate.
///
/// # Examples
/// ```ignore
/// #![no_std]
/// #![no_main]
/// use rp_pico::entry;
/// #[entry]
/// fn you_can_use_a_custom_main_name_here() -> ! {
/// loop {}
/// }
/// ```
#[cfg(feature = "rt")]
pub use hal::entry;
/// The linker will place this boot block at the start of our program image. We
/// need this to help the ROM bootloader get our code up and running.
#[cfg(feature = "boot2")]
#[link_section = ".boot2"]
#[no_mangle]
#[used]
pub static BOOT2_FIRMWARE: [u8; 256] = rp2040_boot2::BOOT_LOADER_W25Q080;
pub use hal::pac;
hal::bsp_pins!(
/// GPIO 0 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 RX` | [crate::Gp0Spi0Rx] |
/// | `UART0 TX` | [crate::Gp0Uart0Tx] |
/// | `I2C0 SDA` | [crate::Gp0I2C0Sda] |
/// | `PWM0 A` | [crate::Gp0Pwm0A] |
/// | `PIO0` | [crate::Gp0Pio0] |
/// | `PIO1` | [crate::Gp0Pio1] |
Gpio0 {
name: gpio0,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio0].
FunctionUart, PullNone: Gp0Uart0Tx,
/// SPI Function alias for pin [crate::Pins::gpio0].
FunctionSpi, PullNone: Gp0Spi0Rx,
/// I2C Function alias for pin [crate::Pins::gpio0].
FunctionI2C, PullUp: Gp0I2C0Sda,
/// PWM Function alias for pin [crate::Pins::gpio0].
FunctionPwm, PullNone: Gp0Pwm0A,
/// PIO0 Function alias for pin [crate::Pins::gpio0].
FunctionPio0, PullNone: Gp0Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio0].
FunctionPio1, PullNone: Gp0Pio1
}
},
/// GPIO 1 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 CSn` | [crate::Gp1Spi0Csn] |
/// | `UART0 RX` | [crate::Gp1Uart0Rx] |
/// | `I2C0 SCL` | [crate::Gp1I2C0Scl] |
/// | `PWM0 B` | [crate::Gp1Pwm0B] |
/// | `PIO0` | [crate::Gp1Pio0] |
/// | `PIO1` | [crate::Gp1Pio1] |
Gpio1 {
name: gpio1,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio1].
FunctionUart, PullNone: Gp1Uart0Rx,
/// SPI Function alias for pin [crate::Pins::gpio1].
FunctionSpi, PullNone: Gp1Spi0Csn,
/// I2C Function alias for pin [crate::Pins::gpio1].
FunctionI2C, PullUp: Gp1I2C0Scl,
/// PWM Function alias for pin [crate::Pins::gpio1].
FunctionPwm, PullNone: Gp1Pwm0B,
/// PIO0 Function alias for pin [crate::Pins::gpio1].
FunctionPio0, PullNone: Gp1Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio1].
FunctionPio1, PullNone: Gp1Pio1
}
},
/// GPIO 2 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 SCK` | [crate::Gp2Spi0Sck] |
/// | `UART0 CTS` | [crate::Gp2Uart0Cts] |
/// | `I2C1 SDA` | [crate::Gp2I2C1Sda] |
/// | `PWM1 A` | [crate::Gp2Pwm1A] |
/// | `PIO0` | [crate::Gp2Pio0] |
/// | `PIO1` | [crate::Gp2Pio1] |
Gpio2 {
name: gpio2,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio2].
FunctionUart, PullNone: Gp2Uart0Cts,
/// SPI Function alias for pin [crate::Pins::gpio2].
FunctionSpi, PullNone: Gp2Spi0Sck,
/// I2C Function alias for pin [crate::Pins::gpio2].
FunctionI2C, PullUp: Gp2I2C1Sda,
/// PWM Function alias for pin [crate::Pins::gpio2].
FunctionPwm, PullNone: Gp2Pwm1A,
/// PIO0 Function alias for pin [crate::Pins::gpio2].
FunctionPio0, PullNone: Gp2Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio2].
FunctionPio1, PullNone: Gp2Pio1
}
},
/// GPIO 3 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 TX` | [crate::Gp3Spi0Tx] |
/// | `UART0 RTS` | [crate::Gp3Uart0Rts] |
/// | `I2C1 SCL` | [crate::Gp3I2C1Scl] |
/// | `PWM1 B` | [crate::Gp3Pwm1B] |
/// | `PIO0` | [crate::Gp3Pio0] |
/// | `PIO1` | [crate::Gp3Pio1] |
Gpio3 {
name: gpio3,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio3].
FunctionUart, PullNone: Gp3Uart0Rts,
/// SPI Function alias for pin [crate::Pins::gpio3].
FunctionSpi, PullNone: Gp3Spi0Tx,
/// I2C Function alias for pin [crate::Pins::gpio3].
FunctionI2C, PullUp: Gp3I2C1Scl,
/// PWM Function alias for pin [crate::Pins::gpio3].
FunctionPwm, PullNone: Gp3Pwm1B,
/// PIO0 Function alias for pin [crate::Pins::gpio3].
FunctionPio0, PullNone: Gp3Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio3].
FunctionPio1, PullNone: Gp3Pio1
}
},
/// GPIO 4 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 RX` | [crate::Gp4Spi0Rx] |
/// | `UART1 TX` | [crate::Gp4Uart1Tx] |
/// | `I2C0 SDA` | [crate::Gp4I2C0Sda] |
/// | `PWM2 A` | [crate::Gp4Pwm2A] |
/// | `PIO0` | [crate::Gp4Pio0] |
/// | `PIO1` | [crate::Gp4Pio1] |
Gpio4 {
name: gpio4,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio4].
FunctionUart, PullNone: Gp4Uart1Tx,
/// SPI Function alias for pin [crate::Pins::gpio4].
FunctionSpi, PullNone: Gp4Spi0Rx,
/// I2C Function alias for pin [crate::Pins::gpio4].
FunctionI2C, PullUp: Gp4I2C0Sda,
/// PWM Function alias for pin [crate::Pins::gpio4].
FunctionPwm, PullNone: Gp4Pwm2A,
/// PIO0 Function alias for pin [crate::Pins::gpio4].
FunctionPio0, PullNone: Gp4Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio4].
FunctionPio1, PullNone: Gp4Pio1
}
},
/// GPIO 5 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 CSn` | [crate::Gp5Spi0Csn] |
/// | `UART1 RX` | [crate::Gp5Uart1Rx] |
/// | `I2C0 SCL` | [crate::Gp5I2C0Scl] |
/// | `PWM2 B` | [crate::Gp5Pwm2B] |
/// | `PIO0` | [crate::Gp5Pio0] |
/// | `PIO1` | [crate::Gp5Pio1] |
Gpio5 {
name: gpio5,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio5].
FunctionUart, PullNone: Gp5Uart1Rx,
/// SPI Function alias for pin [crate::Pins::gpio5].
FunctionSpi, PullNone: Gp5Spi0Csn,
/// I2C Function alias for pin [crate::Pins::gpio5].
FunctionI2C, PullUp: Gp5I2C0Scl,
/// PWM Function alias for pin [crate::Pins::gpio5].
FunctionPwm, PullNone: Gp5Pwm2B,
/// PIO0 Function alias for pin [crate::Pins::gpio5].
FunctionPio0, PullNone: Gp5Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio5].
FunctionPio1, PullNone: Gp5Pio1
}
},
/// GPIO 6 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 SCK` | [crate::Gp6Spi0Sck] |
/// | `UART1 CTS` | [crate::Gp6Uart1Cts] |
/// | `I2C1 SDA` | [crate::Gp6I2C1Sda] |
/// | `PWM3 A` | [crate::Gp6Pwm3A] |
/// | `PIO0` | [crate::Gp6Pio0] |
/// | `PIO1` | [crate::Gp6Pio1] |
Gpio6 {
name: gpio6,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio6].
FunctionUart, PullNone: Gp6Uart1Cts,
/// SPI Function alias for pin [crate::Pins::gpio6].
FunctionSpi, PullNone: Gp6Spi0Sck,
/// I2C Function alias for pin [crate::Pins::gpio6].
FunctionI2C, PullUp: Gp6I2C1Sda,
/// PWM Function alias for pin [crate::Pins::gpio6].
FunctionPwm, PullNone: Gp6Pwm3A,
/// PIO0 Function alias for pin [crate::Pins::gpio6].
FunctionPio0, PullNone: Gp6Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio6].
FunctionPio1, PullNone: Gp6Pio1
}
},
/// GPIO 7 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 TX` | [crate::Gp7Spi0Tx] |
/// | `UART1 RTS` | [crate::Gp7Uart1Rts] |
/// | `I2C1 SCL` | [crate::Gp7I2C1Scl] |
/// | `PWM3 B` | [crate::Gp7Pwm3B] |
/// | `PIO0` | [crate::Gp7Pio0] |
/// | `PIO1` | [crate::Gp7Pio1] |
Gpio7 {
name: led,
aliases: {
/// UART Function alias for pin [crate::Pins::led].
FunctionUart, PullNone: Gp7Uart1Rts,
/// SPI Function alias for pin [crate::Pins::led].
FunctionSpi, PullNone: Gp7Spi0Tx,
/// I2C Function alias for pin [crate::Pins::led].
FunctionI2C, PullUp: Gp7I2C1Scl,
/// PWM Function alias for pin [crate::Pins::led].
FunctionPwm, PullNone: Gp7Pwm3B,
/// PIO0 Function alias for pin [crate::Pins::led].
FunctionPio0, PullNone: Gp7Pio0,
/// PIO1 Function alias for pin [crate::Pins::led].
FunctionPio1, PullNone: Gp7Pio1
}
},
/// GPIO 8 is connected to keyboard column 9
Gpio8 {
name: kb_c9
},
/// GPIO 9 is connected to keyboard column 8
Gpio9 {
name: kb_c8
},
/// GPIO 10 is connected to keyboard column 7
Gpio10 {
name: kb_c7,
},
/// GPIO 11 is connected to keyboard column 6
Gpio11 {
name: kb_c6,
},
/// GPIO 12 is connected to keyboard column 5
Gpio12 {
name: kb_c5,
},
/// GPIO 13 is connected to keyboard column 4
Gpio13 {
name: kb_c4,
},
/// GPIO 14 is connected to keyboard column 3
Gpio14 {
name: kb_c3,
},
/// GPIO 15 is connected to keyboard column 2
Gpio15 {
name: kb_c2,
},
/// GPIO 16 is connected to keyboard column 1
Gpio16 {
name: kb_c1,
},
/// GPIO 17 is connected to keyboard row 9
Gpio17 {
name: kb_r9,
},
/// GPIO 18 is connected to keyboard row 8
Gpio18 {
name: kb_r8,
},
/// GPIO 19 is connected to keyboard row 7
Gpio19 {
name: kb_r7,
},
/// GPIO 20 is connected to keyboard row 6
Gpio20 {
name: kb_r6,
},
/// GPIO 21 is connected to keyboard row 5
Gpio21 {
name: kb_r5,
},
/// GPIO 22 is connected to keyboard row 4
Gpio22 {
name: kb_r4,
},
/// GPIO 23 is connected to keyboard row 3
Gpio23 {
name: kb_r3,
},
/// GPIO 24 is connected to keyboard row 2
Gpio24 {
name: kb_r2,
},
/// GPIO 25 is connected to keyboard row 1
Gpio25 {
name: kb_r1,
},
/// GPIO 26 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 SCK` | [crate::Gp26Spi1Sck] |
/// | `UART1 CTS` | [crate::Gp26Uart1Cts] |
/// | `I2C1 SDA` | [crate::Gp26I2C1Sda] |
/// | `PWM5 A` | [crate::Gp26Pwm5A] |
/// | `PIO0` | [crate::Gp26Pio0] |
/// | `PIO1` | [crate::Gp26Pio1] |
Gpio26 {
name: gpio26,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio26].
FunctionUart, PullNone: Gp26Uart1Cts,
/// SPI Function alias for pin [crate::Pins::gpio26].
FunctionSpi, PullNone: Gp26Spi1Sck,
/// I2C Function alias for pin [crate::Pins::gpio26].
FunctionI2C, PullUp: Gp26I2C1Sda,
/// PWM Function alias for pin [crate::Pins::gpio26].
FunctionPwm, PullNone: Gp26Pwm5A,
/// PIO0 Function alias for pin [crate::Pins::gpio26].
FunctionPio0, PullNone: Gp26Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio26].
FunctionPio1, PullNone: Gp26Pio1
}
},
/// GPIO 27 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 TX` | [crate::Gp27Spi1Tx] |
/// | `UART1 RTS` | [crate::Gp27Uart1Rts] |
/// | `I2C1 SCL` | [crate::Gp27I2C1Scl] |
/// | `PWM5 B` | [crate::Gp27Pwm5B] |
/// | `PIO0` | [crate::Gp27Pio0] |
/// | `PIO1` | [crate::Gp27Pio1] |
Gpio27 {
name: gpio27,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio27].
FunctionUart, PullNone: Gp27Uart1Rts,
/// SPI Function alias for pin [crate::Pins::gpio27].
FunctionSpi, PullNone: Gp27Spi1Tx,
/// I2C Function alias for pin [crate::Pins::gpio27].
FunctionI2C, PullUp: Gp27I2C1Scl,
/// PWM Function alias for pin [crate::Pins::gpio27].
FunctionPwm, PullNone: Gp27Pwm5B,
/// PIO0 Function alias for pin [crate::Pins::gpio27].
FunctionPio0, PullNone: Gp27Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio27].
FunctionPio1, PullNone: Gp27Pio1
}
},
/// GPIO 28 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 RX` | [crate::Gp28Spi1Rx] |
/// | `UART0 TX` | [crate::Gp28Uart0Tx] |
/// | `I2C0 SDA` | [crate::Gp28I2C0Sda] |
/// | `PWM6 A` | [crate::Gp28Pwm6A] |
/// | `PIO0` | [crate::Gp28Pio0] |
/// | `PIO1` | [crate::Gp28Pio1] |
Gpio28 {
name: gpio28,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio28].
FunctionUart, PullNone: Gp28Uart0Tx,
/// SPI Function alias for pin [crate::Pins::gpio28].
FunctionSpi, PullNone: Gp28Spi1Rx,
/// I2C Function alias for pin [crate::Pins::gpio28].
FunctionI2C, PullUp: Gp28I2C0Sda,
/// PWM Function alias for pin [crate::Pins::gpio28].
FunctionPwm, PullNone: Gp28Pwm6A,
/// PIO0 Function alias for pin [crate::Pins::gpio28].
FunctionPio0, PullNone: Gp28Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio28].
FunctionPio1, PullNone: Gp28Pio1
}
},
/// GPIO 29 supports following functions
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 RX` | [crate::Gp29Spi1Rx] |
/// | `UART0 TX` | [crate::Gp29Uart0Tx] |
/// | `I2C0 SDA` | [crate::Gp29I2C0Sda] |
/// | `PWM6 A` | [crate::Gp29Pwm6A] |
/// | `PIO0` | [crate::Gp29Pio0] |
/// | `PIO1` | [crate::Gp29Pio1] |
Gpio29 {
name: gpio29,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio29].
FunctionUart, PullNone: Gp29Uart0Tx,
/// SPI Function alias for pin [crate::Pins::gpio29].
FunctionSpi, PullNone: Gp29Spi1Rx,
/// I2C Function alias for pin [crate::Pins::gpio29].
FunctionI2C, PullUp: Gp29I2C0Sda,
/// PWM Function alias for pin [crate::Pins::gpio29].
FunctionPwm, PullNone: Gp29Pwm6A,
/// PIO0 Function alias for pin [crate::Pins::gpio29].
FunctionPio0, PullNone: Gp29Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio29].
FunctionPio1, PullNone: Gp29Pio1
}
},
);
pub const XOSC_CRYSTAL_FREQ: u32 = 12_000_000;