summaryrefslogtreecommitdiff
path: root/docs/platformdev_rp2040.md
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2024-06-02 12:42:24 +1000
committerGitHub <noreply@github.com>2024-06-02 12:42:24 +1000
commit78a0adfbb4d2c4e12f93f2a62ded0020d406243e (patch)
treee6e123b36569559233025add654580e090dc0154 /docs/platformdev_rp2040.md
parentfa6d23235bf429446250cd5212e209d5fbfdbac2 (diff)
[docs] Organize driver & feature docs into subfolders (#23848)
Co-authored-by: Nick Brassel <nick@tzarc.org>
Diffstat (limited to 'docs/platformdev_rp2040.md')
-rw-r--r--docs/platformdev_rp2040.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/platformdev_rp2040.md b/docs/platformdev_rp2040.md
index f0b006cf6e..1269ffeeb5 100644
--- a/docs/platformdev_rp2040.md
+++ b/docs/platformdev_rp2040.md
@@ -4,16 +4,16 @@ The following table shows the current driver status for peripherals on RP2040 MC
4 4
5| System | Support | 5| System | Support |
6| ---------------------------------------------------------------- | ---------------------------------------------- | 6| ---------------------------------------------------------------- | ---------------------------------------------- |
7| [ADC driver](adc_driver) | :heavy_check_mark: | 7| [ADC driver](drivers/adc) | :heavy_check_mark: |
8| [Audio](audio_driver#pwm-hardware) | :heavy_check_mark: | 8| [Audio](drivers/audio#pwm-hardware) | :heavy_check_mark: |
9| [Backlight](feature_backlight) | :heavy_check_mark: | 9| [Backlight](features/backlight) | :heavy_check_mark: |
10| [I2C driver](i2c_driver) | :heavy_check_mark: | 10| [I2C driver](drivers/i2c) | :heavy_check_mark: |
11| [SPI driver](spi_driver) | :heavy_check_mark: | 11| [SPI driver](drivers/spi) | :heavy_check_mark: |
12| [WS2812 driver](ws2812_driver) | :heavy_check_mark: using `PIO` driver | 12| [WS2812 driver](drivers/ws2812) | :heavy_check_mark: using `PIO` driver |
13| [External EEPROMs](eeprom_driver) | :heavy_check_mark: using `I2C` or `SPI` driver | 13| [External EEPROMs](drivers/eeprom) | :heavy_check_mark: using `I2C` or `SPI` driver |
14| [EEPROM emulation](eeprom_driver#wear_leveling-configuration) | :heavy_check_mark: | 14| [EEPROM emulation](drivers/eeprom#wear_leveling-configuration) | :heavy_check_mark: |
15| [serial driver](serial_driver) | :heavy_check_mark: using `SIO` or `PIO` driver | 15| [serial driver](drivers/serial) | :heavy_check_mark: using `SIO` or `PIO` driver |
16| [UART driver](uart_driver) | :heavy_check_mark: using `SIO` driver | 16| [UART driver](drivers/uart) | :heavy_check_mark: using `SIO` driver |
17 17
18## GPIO 18## GPIO
19 19
@@ -43,7 +43,7 @@ QMK RP2040 support builds upon ChibiOS and thus follows their convention for act
43| `I2C0` | `RP_I2C_USE_I2C0` | `I2CD0` | 43| `I2C0` | `RP_I2C_USE_I2C0` | `I2CD0` |
44| `I2C1` | `RP_I2C_USE_I2C1` | `I2CD1` | 44| `I2C1` | `RP_I2C_USE_I2C1` | `I2CD1` |
45 45
46To configure the I2C driver please read the [ChibiOS/ARM](i2c_driver#arm-configuration) section. 46To configure the I2C driver please read the [ChibiOS/ARM](drivers/i2c#arm-configuration) section.
47 47
48### SPI Driver 48### SPI Driver
49 49
@@ -52,7 +52,7 @@ To configure the I2C driver please read the [ChibiOS/ARM](i2c_driver#arm-configu
52| `SPI0` | `RP_SPI_USE_SPI0` | `SPID0` | 52| `SPI0` | `RP_SPI_USE_SPI0` | `SPID0` |
53| `SPI1` | `RP_SPI_USE_SPI1` | `SPID1` | 53| `SPI1` | `RP_SPI_USE_SPI1` | `SPID1` |
54 54
55To configure the SPI driver please read the [ChibiOS/ARM](spi_driver#chibiosarm-configuration) section. 55To configure the SPI driver please read the [ChibiOS/ARM](drivers/spi#chibiosarm-configuration) section.
56 56
57### UART Driver 57### UART Driver
58 58
@@ -92,7 +92,7 @@ This is the default board that is chosen, unless any other RP2040 board is selec
92| `SPI_MISO_PIN` | `GP20` | 92| `SPI_MISO_PIN` | `GP20` |
93| `SPI_MOSI_PIN` | `GP19` | 93| `SPI_MOSI_PIN` | `GP19` |
94| **Serial driver** | | 94| **Serial driver** | |
95| `SERIAL_USART_DRIVER` ([SIO Driver](serial_driver#the-sio-driver) only) | `SIOD0` | 95| `SERIAL_USART_DRIVER` ([SIO Driver](drivers/serial#the-sio-driver) only) | `SIOD0` |
96| `SOFT_SERIAL_PIN` | undefined, use `SERIAL_USART_TX_PIN` | 96| `SOFT_SERIAL_PIN` | undefined, use `SERIAL_USART_TX_PIN` |
97| `SERIAL_USART_TX_PIN` | `GP0` | 97| `SERIAL_USART_TX_PIN` | `GP0` |
98| `SERIAL_USART_RX_PIN` | `GP1` | 98| `SERIAL_USART_RX_PIN` | `GP1` |
@@ -115,9 +115,9 @@ BOARD = GENERIC_RP_RP2040
115 115
116## Split keyboard support 116## Split keyboard support
117 117
118Split keyboards are fully supported using the [serial driver](serial_driver) in both full-duplex and half-duplex configurations. Two driver subsystems are supported by the RP2040, the hardware UART based `SIO` and the Programmable IO based `PIO` driver. 118Split keyboards are fully supported using the [serial driver](drivers/serial) in both full-duplex and half-duplex configurations. Two driver subsystems are supported by the RP2040, the hardware UART based `SIO` and the Programmable IO based `PIO` driver.
119 119
120| Feature | [SIO Driver](serial_driver#the-sio-driver) | [PIO Driver](serial_driver#the-pio-driver) | 120| Feature | [SIO Driver](drivers/serial#the-sio-driver) | [PIO Driver](drivers/serial#the-pio-driver) |
121| ----------------------------- | --------------------------------------------- | --------------------------------------------- | 121| ----------------------------- | --------------------------------------------- | --------------------------------------------- |
122| Half-Duplex operation | | :heavy_check_mark: | 122| Half-Duplex operation | | :heavy_check_mark: |
123| Full-Duplex operation | :heavy_check_mark: | :heavy_check_mark: | 123| Full-Duplex operation | :heavy_check_mark: | :heavy_check_mark: |
generated by cgit v1.2.3 (git 2.25.1) at 2026-09-03 09:30:03 +0000