Merge pull request #259 from WeirdConstructor/pico_board_documentation

Added pin function documentation from the datasheet to rp-pico
This commit is contained in:
Jonathan 'theJPster' Pallant 2022-01-12 20:05:11 +00:00 committed by GitHub
commit f7b8abfeb0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 772 additions and 30 deletions

View file

@ -18,37 +18,752 @@ pub static BOOT2_FIRMWARE: [u8; 256] = rp2040_boot2::BOOT_LOADER_W25Q080;
pub use hal::pac; pub use hal::pac;
hal::bsp_pins!( hal::bsp_pins!(
Gpio0 { name: gpio0 }, /// GPIO 0 supports following functions:
Gpio1 { name: gpio1 }, ///
Gpio2 { name: gpio2 }, /// | Function | Alias with applied function |
Gpio3 { name: gpio3 }, /// |--------------|-----------------------------|
Gpio4 { name: gpio4 }, /// | `SPI0 RX` | [crate::Gp0Spi0Rx] |
Gpio5 { name: gpio5 }, /// | `UART0 TX` | [crate::Gp0Uart0Tx] |
Gpio6 { name: gpio6 }, /// | `I2C0 SDA` | [crate::Gp0I2C0Sda] |
Gpio7 { name: gpio7 }, /// | `PWM0 A` | [crate::Gp0Pwm0A] |
Gpio8 { name: gpio8 }, /// | `PIO0` | [crate::Gp0Pio0] |
Gpio9 { name: gpio9 }, /// | `PIO1` | [crate::Gp0Pio1] |
Gpio10 { name: gpio10 }, Gpio0 {
Gpio11 { name: gpio11 }, name: gpio0,
Gpio12 { name: gpio12 }, aliases: {
Gpio13 { name: gpio13 }, /// UART Function alias for pin [crate::Pins::gpio0].
Gpio14 { name: gpio14 }, FunctionUart: Gp0Uart0Tx,
Gpio15 { name: gpio15 }, /// SPI Function alias for pin [crate::Pins::gpio0].
Gpio16 { name: gpio16 }, FunctionSpi: Gp0Spi0Rx,
Gpio17 { name: gpio17 }, /// I2C Function alias for pin [crate::Pins::gpio0].
Gpio18 { name: gpio18 }, FunctionI2C: Gp0I2C0Sda,
Gpio19 { name: gpio19 }, /// PWM Function alias for pin [crate::Pins::gpio0].
Gpio20 { name: gpio20 }, FunctionPwm: Gp0Pwm0A,
Gpio21 { name: gpio21 }, /// PIO0 Function alias for pin [crate::Pins::gpio0].
Gpio22 { name: gpio22 }, FunctionPio0: Gp0Pio0,
Gpio23 { name: b_power_save }, /// PIO1 Function alias for pin [crate::Pins::gpio0].
Gpio24 { name: vbus_detect }, FunctionPio1: Gp0Pio1
Gpio25 { name: led }, }
Gpio26 { name: gpio26 }, },
Gpio27 { name: gpio27 },
Gpio28 { name: gpio28 }, /// 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: Gp1Uart0Rx,
/// SPI Function alias for pin [crate::Pins::gpio1].
FunctionSpi: Gp1Spi0Csn,
/// I2C Function alias for pin [crate::Pins::gpio1].
FunctionI2C: Gp1I2C0Scl,
/// PWM Function alias for pin [crate::Pins::gpio1].
FunctionPwm: Gp1Pwm0B,
/// PIO0 Function alias for pin [crate::Pins::gpio1].
FunctionPio0: Gp1Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio1].
FunctionPio1: 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: Gp2Uart0Cts,
/// SPI Function alias for pin [crate::Pins::gpio2].
FunctionSpi: Gp2Spi0Sck,
/// I2C Function alias for pin [crate::Pins::gpio2].
FunctionI2C: Gp2I2C1Sda,
/// PWM Function alias for pin [crate::Pins::gpio2].
FunctionPwm: Gp2Pwm1A,
/// PIO0 Function alias for pin [crate::Pins::gpio2].
FunctionPio0: Gp2Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio2].
FunctionPio1: 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: Gp3Uart0Rts,
/// SPI Function alias for pin [crate::Pins::gpio3].
FunctionSpi: Gp3Spi0Tx,
/// I2C Function alias for pin [crate::Pins::gpio3].
FunctionI2C: Gp3I2C1Scl,
/// PWM Function alias for pin [crate::Pins::gpio3].
FunctionPwm: Gp3Pwm1B,
/// PIO0 Function alias for pin [crate::Pins::gpio3].
FunctionPio0: Gp3Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio3].
FunctionPio1: 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: Gp4Uart1Tx,
/// SPI Function alias for pin [crate::Pins::gpio4].
FunctionSpi: Gp4Spi0Rx,
/// I2C Function alias for pin [crate::Pins::gpio4].
FunctionI2C: Gp4I2C0Sda,
/// PWM Function alias for pin [crate::Pins::gpio4].
FunctionPwm: Gp4Pwm2A,
/// PIO0 Function alias for pin [crate::Pins::gpio4].
FunctionPio0: Gp4Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio4].
FunctionPio1: 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: Gp5Uart1Rx,
/// SPI Function alias for pin [crate::Pins::gpio5].
FunctionSpi: Gp5Spi0Csn,
/// I2C Function alias for pin [crate::Pins::gpio5].
FunctionI2C: Gp5I2C0Scl,
/// PWM Function alias for pin [crate::Pins::gpio5].
FunctionPwm: Gp5Pwm2B,
/// PIO0 Function alias for pin [crate::Pins::gpio5].
FunctionPio0: Gp5Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio5].
FunctionPio1: 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: Gp6Uart1Cts,
/// SPI Function alias for pin [crate::Pins::gpio6].
FunctionSpi: Gp6Spi0Sck,
/// I2C Function alias for pin [crate::Pins::gpio6].
FunctionI2C: Gp6I2C1Sda,
/// PWM Function alias for pin [crate::Pins::gpio6].
FunctionPwm: Gp6Pwm3A,
/// PIO0 Function alias for pin [crate::Pins::gpio6].
FunctionPio0: Gp6Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio6].
FunctionPio1: 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: gpio7,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio7].
FunctionUart: Gp7Uart1Rts,
/// SPI Function alias for pin [crate::Pins::gpio7].
FunctionSpi: Gp7Spi0Tx,
/// I2C Function alias for pin [crate::Pins::gpio7].
FunctionI2C: Gp7I2C1Scl,
/// PWM Function alias for pin [crate::Pins::gpio7].
FunctionPwm: Gp7Pwm3B,
/// PIO0 Function alias for pin [crate::Pins::gpio7].
FunctionPio0: Gp7Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio7].
FunctionPio1: Gp7Pio1
}
},
/// GPIO 8 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 RX` | [crate::Gp8Spi1Rx] |
/// | `UART1 TX` | [crate::Gp8Uart1Tx] |
/// | `I2C0 SDA` | [crate::Gp8I2C0Sda] |
/// | `PWM4 A` | [crate::Gp8Pwm4A] |
/// | `PIO0` | [crate::Gp8Pio0] |
/// | `PIO1` | [crate::Gp8Pio1] |
Gpio8 {
name: gpio8,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio8].
FunctionUart: Gp8Uart1Tx,
/// SPI Function alias for pin [crate::Pins::gpio8].
FunctionSpi: Gp8Spi1Rx,
/// I2C Function alias for pin [crate::Pins::gpio8].
FunctionI2C: Gp8I2C0Sda,
/// PWM Function alias for pin [crate::Pins::gpio8].
FunctionPwm: Gp8Pwm4A,
/// PIO0 Function alias for pin [crate::Pins::gpio8].
FunctionPio0: Gp8Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio8].
FunctionPio1: Gp8Pio1
}
},
/// GPIO 9 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 CSn` | [crate::Gp9Spi1Csn] |
/// | `UART1 RX` | [crate::Gp9Uart1Rx] |
/// | `I2C0 SCL` | [crate::Gp9I2C0Scl] |
/// | `PWM4 B` | [crate::Gp9Pwm4B] |
/// | `PIO0` | [crate::Gp9Pio0] |
/// | `PIO1` | [crate::Gp9Pio1] |
Gpio9 {
name: gpio9,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio9].
FunctionUart: Gp9Uart1Rx,
/// SPI Function alias for pin [crate::Pins::gpio9].
FunctionSpi: Gp9Spi1Csn,
/// I2C Function alias for pin [crate::Pins::gpio9].
FunctionI2C: Gp9I2C0Scl,
/// PWM Function alias for pin [crate::Pins::gpio9].
FunctionPwm: Gp9Pwm4B,
/// PIO0 Function alias for pin [crate::Pins::gpio9].
FunctionPio0: Gp9Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio9].
FunctionPio1: Gp9Pio1
}
},
/// GPIO 10 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 SCK` | [crate::Gp10Spi1Sck] |
/// | `UART1 CTS` | [crate::Gp10Uart1Cts] |
/// | `I2C1 SDA` | [crate::Gp10I2C1Sda] |
/// | `PWM5 A` | [crate::Gp10Pwm5A] |
/// | `PIO0` | [crate::Gp10Pio0] |
/// | `PIO1` | [crate::Gp10Pio1] |
Gpio10 {
name: gpio10,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio10].
FunctionUart: Gp10Uart1Cts,
/// SPI Function alias for pin [crate::Pins::gpio10].
FunctionSpi: Gp10Spi1Sck,
/// I2C Function alias for pin [crate::Pins::gpio10].
FunctionI2C: Gp10I2C1Sda,
/// PWM Function alias for pin [crate::Pins::gpio10].
FunctionPwm: Gp10Pwm5A,
/// PIO0 Function alias for pin [crate::Pins::gpio10].
FunctionPio0: Gp10Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio10].
FunctionPio1: Gp10Pio1
}
},
/// GPIO 11 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 TX` | [crate::Gp11Spi1Tx] |
/// | `UART1 RTS` | [crate::Gp11Uart1Rts] |
/// | `I2C1 SCL` | [crate::Gp11I2C1Scl] |
/// | `PWM5 B` | [crate::Gp11Pwm5B] |
/// | `PIO0` | [crate::Gp11Pio0] |
/// | `PIO1` | [crate::Gp11Pio1] |
Gpio11 {
name: gpio11,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio11].
FunctionUart: Gp11Uart1Rts,
/// SPI Function alias for pin [crate::Pins::gpio11].
FunctionSpi: Gp11Spi1Tx,
/// I2C Function alias for pin [crate::Pins::gpio11].
FunctionI2C: Gp11I2C1Scl,
/// PWM Function alias for pin [crate::Pins::gpio11].
FunctionPwm: Gp11Pwm5B,
/// PIO0 Function alias for pin [crate::Pins::gpio11].
FunctionPio0: Gp11Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio11].
FunctionPio1: Gp11Pio1
}
},
/// GPIO 12 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 RX` | [crate::Gp12Spi1Rx] |
/// | `UART0 TX` | [crate::Gp12Uart0Tx] |
/// | `I2C0 SDA` | [crate::Gp12I2C0Sda] |
/// | `PWM6 A` | [crate::Gp12Pwm6A] |
/// | `PIO0` | [crate::Gp12Pio0] |
/// | `PIO1` | [crate::Gp12Pio1] |
Gpio12 {
name: gpio12,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio12].
FunctionUart: Gp12Uart0Tx,
/// SPI Function alias for pin [crate::Pins::gpio12].
FunctionSpi: Gp12Spi1Rx,
/// I2C Function alias for pin [crate::Pins::gpio12].
FunctionI2C: Gp12I2C0Sda,
/// PWM Function alias for pin [crate::Pins::gpio12].
FunctionPwm: Gp12Pwm6A,
/// PIO0 Function alias for pin [crate::Pins::gpio12].
FunctionPio0: Gp12Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio12].
FunctionPio1: Gp12Pio1
}
},
/// GPIO 13 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 CSn` | [crate::Gp13Spi1Csn] |
/// | `UART0 RX` | [crate::Gp13Uart0Rx] |
/// | `I2C0 SCL` | [crate::Gp13I2C0Scl] |
/// | `PWM6 B` | [crate::Gp13Pwm6B] |
/// | `PIO0` | [crate::Gp13Pio0] |
/// | `PIO1` | [crate::Gp13Pio1] |
Gpio13 {
name: gpio13,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio13].
FunctionUart: Gp13Uart0Rx,
/// SPI Function alias for pin [crate::Pins::gpio13].
FunctionSpi: Gp13Spi1Csn,
/// I2C Function alias for pin [crate::Pins::gpio13].
FunctionI2C: Gp13I2C0Scl,
/// PWM Function alias for pin [crate::Pins::gpio13].
FunctionPwm: Gp13Pwm6B,
/// PIO0 Function alias for pin [crate::Pins::gpio13].
FunctionPio0: Gp13Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio13].
FunctionPio1: Gp13Pio1
}
},
/// GPIO 14 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 SCK` | [crate::Gp14Spi1Sck] |
/// | `UART0 CTS` | [crate::Gp14Uart0Cts] |
/// | `I2C1 SDA` | [crate::Gp14I2C1Sda] |
/// | `PWM7 A` | [crate::Gp14Pwm7A] |
/// | `PIO0` | [crate::Gp14Pio0] |
/// | `PIO1` | [crate::Gp14Pio1] |
Gpio14 {
name: gpio14,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio14].
FunctionUart: Gp14Uart0Cts,
/// SPI Function alias for pin [crate::Pins::gpio14].
FunctionSpi: Gp14Spi1Sck,
/// I2C Function alias for pin [crate::Pins::gpio14].
FunctionI2C: Gp14I2C1Sda,
/// PWM Function alias for pin [crate::Pins::gpio14].
FunctionPwm: Gp14Pwm7A,
/// PIO0 Function alias for pin [crate::Pins::gpio14].
FunctionPio0: Gp14Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio14].
FunctionPio1: Gp14Pio1
}
},
/// GPIO 15 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI1 TX` | [crate::Gp15Spi1Tx] |
/// | `UART0 RTS` | [crate::Gp15Uart0Rts] |
/// | `I2C1 SCL` | [crate::Gp15I2C1Scl] |
/// | `PWM7 B` | [crate::Gp15Pwm7B] |
/// | `PIO0` | [crate::Gp15Pio0] |
/// | `PIO1` | [crate::Gp15Pio1] |
Gpio15 {
name: gpio15,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio15].
FunctionUart: Gp15Uart0Rts,
/// SPI Function alias for pin [crate::Pins::gpio15].
FunctionSpi: Gp15Spi1Tx,
/// I2C Function alias for pin [crate::Pins::gpio15].
FunctionI2C: Gp15I2C1Scl,
/// PWM Function alias for pin [crate::Pins::gpio15].
FunctionPwm: Gp15Pwm7B,
/// PIO0 Function alias for pin [crate::Pins::gpio15].
FunctionPio0: Gp15Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio15].
FunctionPio1: Gp15Pio1
}
},
/// GPIO 16 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 RX` | [crate::Gp16Spi0Rx] |
/// | `UART0 TX` | [crate::Gp16Uart0Tx] |
/// | `I2C0 SDA` | [crate::Gp16I2C0Sda] |
/// | `PWM0 A` | [crate::Gp16Pwm0A] |
/// | `PIO0` | [crate::Gp16Pio0] |
/// | `PIO1` | [crate::Gp16Pio1] |
Gpio16 {
name: gpio16,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio16].
FunctionUart: Gp16Uart0Tx,
/// SPI Function alias for pin [crate::Pins::gpio16].
FunctionSpi: Gp16Spi0Rx,
/// I2C Function alias for pin [crate::Pins::gpio16].
FunctionI2C: Gp16I2C0Sda,
/// PWM Function alias for pin [crate::Pins::gpio16].
FunctionPwm: Gp16Pwm0A,
/// PIO0 Function alias for pin [crate::Pins::gpio16].
FunctionPio0: Gp16Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio16].
FunctionPio1: Gp16Pio1
}
},
/// GPIO 17 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 CSn` | [crate::Gp17Spi0Csn] |
/// | `UART0 RX` | [crate::Gp17Uart0Rx] |
/// | `I2C0 SCL` | [crate::Gp17I2C0Scl] |
/// | `PWM0 B` | [crate::Gp17Pwm0B] |
/// | `PIO0` | [crate::Gp17Pio0] |
/// | `PIO1` | [crate::Gp17Pio1] |
Gpio17 {
name: gpio17,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio17].
FunctionUart: Gp17Uart0Rx,
/// SPI Function alias for pin [crate::Pins::gpio17].
FunctionSpi: Gp17Spi0Csn,
/// I2C Function alias for pin [crate::Pins::gpio17].
FunctionI2C: Gp17I2C0Scl,
/// PWM Function alias for pin [crate::Pins::gpio17].
FunctionPwm: Gp17Pwm0B,
/// PIO0 Function alias for pin [crate::Pins::gpio17].
FunctionPio0: Gp17Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio17].
FunctionPio1: Gp17Pio1
}
},
/// GPIO 18 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 SCK` | [crate::Gp18Spi0Sck] |
/// | `UART0 CTS` | [crate::Gp18Uart0Cts] |
/// | `I2C1 SDA` | [crate::Gp18I2C1Sda] |
/// | `PWM1 A` | [crate::Gp18Pwm1A] |
/// | `PIO0` | [crate::Gp18Pio0] |
/// | `PIO1` | [crate::Gp18Pio1] |
Gpio18 {
name: gpio18,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio18].
FunctionUart: Gp18Uart0Cts,
/// SPI Function alias for pin [crate::Pins::gpio18].
FunctionSpi: Gp18Spi0Sck,
/// I2C Function alias for pin [crate::Pins::gpio18].
FunctionI2C: Gp18I2C1Sda,
/// PWM Function alias for pin [crate::Pins::gpio18].
FunctionPwm: Gp18Pwm1A,
/// PIO0 Function alias for pin [crate::Pins::gpio18].
FunctionPio0: Gp18Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio18].
FunctionPio1: Gp18Pio1
}
},
/// GPIO 19 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 TX` | [crate::Gp19Spi0Tx] |
/// | `UART0 RTS` | [crate::Gp19Uart0Rts] |
/// | `I2C1 SCL` | [crate::Gp19I2C1Scl] |
/// | `PWM1 B` | [crate::Gp19Pwm1B] |
/// | `PIO0` | [crate::Gp19Pio0] |
/// | `PIO1` | [crate::Gp19Pio1] |
Gpio19 {
name: gpio19,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio19].
FunctionUart: Gp19Uart0Rts,
/// SPI Function alias for pin [crate::Pins::gpio19].
FunctionSpi: Gp19Spi0Tx,
/// I2C Function alias for pin [crate::Pins::gpio19].
FunctionI2C: Gp19I2C1Scl,
/// PWM Function alias for pin [crate::Pins::gpio19].
FunctionPwm: Gp19Pwm1B,
/// PIO0 Function alias for pin [crate::Pins::gpio19].
FunctionPio0: Gp19Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio19].
FunctionPio1: Gp19Pio1
}
},
/// GPIO 20 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 RX` | [crate::Gp20Spi0Rx] |
/// | `UART1 TX` | [crate::Gp20Uart1Tx] |
/// | `I2C0 SDA` | [crate::Gp20I2C0Sda] |
/// | `PWM2 A` | [crate::Gp20Pwm2A] |
/// | `PIO0` | [crate::Gp20Pio0] |
/// | `PIO1` | [crate::Gp20Pio1] |
Gpio20 {
name: gpio20,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio20].
FunctionUart: Gp20Uart1Tx,
/// SPI Function alias for pin [crate::Pins::gpio20].
FunctionSpi: Gp20Spi0Rx,
/// I2C Function alias for pin [crate::Pins::gpio20].
FunctionI2C: Gp20I2C0Sda,
/// PWM Function alias for pin [crate::Pins::gpio20].
FunctionPwm: Gp20Pwm2A,
/// PIO0 Function alias for pin [crate::Pins::gpio20].
FunctionPio0: Gp20Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio20].
FunctionPio1: Gp20Pio1
}
},
/// GPIO 21 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 CSn` | [crate::Gp21Spi0Csn] |
/// | `UART1 RX` | [crate::Gp21Uart1Rx] |
/// | `I2C0 SCL` | [crate::Gp21I2C0Scl] |
/// | `PWM2 B` | [crate::Gp21Pwm2B] |
/// | `PIO0` | [crate::Gp21Pio0] |
/// | `PIO1` | [crate::Gp21Pio1] |
Gpio21 {
name: gpio21,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio21].
FunctionUart: Gp21Uart1Rx,
/// SPI Function alias for pin [crate::Pins::gpio21].
FunctionSpi: Gp21Spi0Csn,
/// I2C Function alias for pin [crate::Pins::gpio21].
FunctionI2C: Gp21I2C0Scl,
/// PWM Function alias for pin [crate::Pins::gpio21].
FunctionPwm: Gp21Pwm2B,
/// PIO0 Function alias for pin [crate::Pins::gpio21].
FunctionPio0: Gp21Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio21].
FunctionPio1: Gp21Pio1
}
},
/// GPIO 22 supports following functions:
///
/// | Function | Alias with applied function |
/// |--------------|-----------------------------|
/// | `SPI0 SCK` | [crate::Gp22Spi0Sck] |
/// | `UART1 CTS` | [crate::Gp22Uart1Cts] |
/// | `I2C1 SDA` | [crate::Gp22I2C1Sda] |
/// | `PWM3 A` | [crate::Gp22Pwm3A] |
/// | `PIO0` | [crate::Gp22Pio0] |
/// | `PIO1` | [crate::Gp22Pio1] |
Gpio22 {
name: gpio22,
aliases: {
/// UART Function alias for pin [crate::Pins::gpio22].
FunctionUart: Gp22Uart1Cts,
/// SPI Function alias for pin [crate::Pins::gpio22].
FunctionSpi: Gp22Spi0Sck,
/// I2C Function alias for pin [crate::Pins::gpio22].
FunctionI2C: Gp22I2C1Sda,
/// PWM Function alias for pin [crate::Pins::gpio22].
FunctionPwm: Gp22Pwm3A,
/// PIO0 Function alias for pin [crate::Pins::gpio22].
FunctionPio0: Gp22Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio22].
FunctionPio1: Gp22Pio1
}
},
/// GPIO 23 is connected to b_power_save of the Raspberry Pi Pico board.
Gpio23 {
name: b_power_save,
},
/// GPIO 24 is connected to vbus_detect of the Raspberry Pi Pico board.
Gpio24 {
name: vbus_detect,
},
/// GPIO 25 is connected to led of the Raspberry Pi Pico board.
Gpio25 {
name: led,
},
/// 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: Gp26Uart1Cts,
/// SPI Function alias for pin [crate::Pins::gpio26].
FunctionSpi: Gp26Spi1Sck,
/// I2C Function alias for pin [crate::Pins::gpio26].
FunctionI2C: Gp26I2C1Sda,
/// PWM Function alias for pin [crate::Pins::gpio26].
FunctionPwm: Gp26Pwm5A,
/// PIO0 Function alias for pin [crate::Pins::gpio26].
FunctionPio0: Gp26Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio26].
FunctionPio1: 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: Gp27Uart1Rts,
/// SPI Function alias for pin [crate::Pins::gpio27].
FunctionSpi: Gp27Spi1Tx,
/// I2C Function alias for pin [crate::Pins::gpio27].
FunctionI2C: Gp27I2C1Scl,
/// PWM Function alias for pin [crate::Pins::gpio27].
FunctionPwm: Gp27Pwm5B,
/// PIO0 Function alias for pin [crate::Pins::gpio27].
FunctionPio0: Gp27Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio27].
FunctionPio1: 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: Gp28Uart0Tx,
/// SPI Function alias for pin [crate::Pins::gpio28].
FunctionSpi: Gp28Spi1Rx,
/// I2C Function alias for pin [crate::Pins::gpio28].
FunctionI2C: Gp28I2C0Sda,
/// PWM Function alias for pin [crate::Pins::gpio28].
FunctionPwm: Gp28Pwm6A,
/// PIO0 Function alias for pin [crate::Pins::gpio28].
FunctionPio0: Gp28Pio0,
/// PIO1 Function alias for pin [crate::Pins::gpio28].
FunctionPio1: Gp28Pio1
}
},
/// GPIO 29 is connected to voltage_monitor of the Raspberry Pi Pico board.
Gpio29 { Gpio29 {
name: voltage_monitor name: voltage_monitor,
}, },
); );

View file

@ -1088,6 +1088,33 @@ macro_rules! bsp_pins {
/// ///
/// This type is intended to provide more meaningful names for the /// This type is intended to provide more meaningful names for the
/// given pins. /// given pins.
///
/// To enable specific functions of the pins you can use the
/// [rp2040_hal::gpio::pin::Pin::into_mode] function with
/// one of:
/// - [rp2040_hal::gpio::pin::FunctionI2C]
/// - [rp2040_hal::gpio::pin::FunctionPwm]
/// - [rp2040_hal::gpio::pin::FunctionSpi]
/// - [rp2040_hal::gpio::pin::FunctionXip]
/// - [rp2040_hal::gpio::pin::FunctionPio0]
/// - [rp2040_hal::gpio::pin::FunctionPio1]
/// - [rp2040_hal::gpio::pin::FunctionUart]
///
/// like this:
///```no_run
/// use rp2040_hal::{pac, gpio::{bank0::Gpio12, Pin, Pins, PushPullOutput}, sio::Sio};
///
/// let mut peripherals = pac::Peripherals::take().unwrap();
/// let sio = Sio::new(peripherals.SIO);
/// let pins = Pins::new(peripherals.IO_BANK0,peripherals.PADS_BANK0,sio.gpio_bank0, &mut peripherals.RESETS);
///
/// let _spi_sclk = pins.gpio2.into_mode::<rp2040_hal::gpio::FunctionSpi>();
/// let _spi_mosi = pins.gpio3.into_mode::<rp2040_hal::gpio::FunctionSpi>();
/// let _spi_miso = pins.gpio4.into_mode::<rp2040_hal::gpio::FunctionSpi>();
///```
///
/// **See also [rp2040_hal::gpio::pin] for more in depth information
/// about this**!
pub struct Pins { pub struct Pins {
$( $(
$( #[$id_cfg] )* $( #[$id_cfg] )*