Document the RP2040-specific PS/2 implementation (#22079)

Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
This commit is contained in:
Michael Büchler 2023-09-25 05:00:13 +02:00 committed by GitHub
parent c10a46aa43
commit 4d994458f0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 1 deletions

View file

@ -155,6 +155,29 @@ In your keyboard config.h:
#endif #endif
``` ```
### RP2040 PIO Version :id=rp2040-pio-version
The `PIO` subsystem is a Raspberry Pi RP2040 specific implementation, using the integrated PIO peripheral and is therefore only available on this MCU.
There are strict requirements for pin ordering but any pair of GPIO pins can be used. The GPIO used for clock must be directly after data, see the included info.json snippet for an example of correct order.
You may optionally switch the PIO peripheral used with the following define in config.h:
```c
#define PS2_PIO_USE_PIO1 // Force the usage of PIO1 peripheral, by default the PS2 implementation uses the PIO0 peripheral
```
Example info.json content:
```json
"ps2": {
"clock_pin": "GP1",
"data_pin": "GP0",
"driver": "vendor",
"enabled": true,
"mouse_enabled": true
}
```
## Additional Settings :id=additional-settings ## Additional Settings :id=additional-settings
### PS/2 Mouse Features :id=ps2-mouse-features ### PS/2 Mouse Features :id=ps2-mouse-features

View file

@ -22,7 +22,7 @@
#endif #endif
#if PS2_DATA_PIN + 1 != PS2_CLOCK_PIN #if PS2_DATA_PIN + 1 != PS2_CLOCK_PIN
# error PS/2 Clock pin must be followed by data pin! # error PS/2 clock pin must be data pin + 1!
#endif #endif
static inline void pio_serve_interrupt(void); static inline void pio_serve_interrupt(void);