diff options
| author | Ryan <fauxpark@gmail.com> | 2025-01-27 08:37:37 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-01-26 22:37:37 +0100 |
| commit | ee63d39058deee162b794c62d7180d61f540914a (patch) | |
| tree | b5f181826176b74cfbac3de4aadad4230b4aa3b0 /docs/drivers | |
| parent | 0747f887d6820da8903d60c751e9e04c92b72d4d (diff) | |
Unify spi_master headers (#24857)
* Move default config to .c file
* Explicitly define PAL modes for boards with custom init
* Unify spi_master headers
Diffstat (limited to 'docs/drivers')
| -rw-r--r-- | docs/drivers/spi.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/drivers/spi.md b/docs/drivers/spi.md index 43d2a056d5..140b204945 100644 --- a/docs/drivers/spi.md +++ b/docs/drivers/spi.md | |||
| @@ -88,7 +88,7 @@ Start an SPI transaction. | |||
| 88 | #### Arguments {#api-spi-start-arguments} | 88 | #### Arguments {#api-spi-start-arguments} |
| 89 | 89 | ||
| 90 | - `pin_t slavePin` | 90 | - `pin_t slavePin` |
| 91 | The QMK pin to assert as the slave select pin, eg. `B4`. | 91 | The GPIO pin connected to the desired device's `SS` line. |
| 92 | - `bool lsbFirst` | 92 | - `bool lsbFirst` |
| 93 | Determines the endianness of the transmission. If `true`, the least significant bit of each byte is sent first. | 93 | Determines the endianness of the transmission. If `true`, the least significant bit of each byte is sent first. |
| 94 | - `uint8_t mode` | 94 | - `uint8_t mode` |
| @@ -106,7 +106,7 @@ Start an SPI transaction. | |||
| 106 | 106 | ||
| 107 | #### Return Value {#api-spi-start-return} | 107 | #### Return Value {#api-spi-start-return} |
| 108 | 108 | ||
| 109 | `false` if the supplied parameters are invalid or the SPI peripheral is already in use, or `true`. | 109 | `true` if the operation was successful, otherwise `false` if the supplied parameters are invalid or the SPI peripheral is already in use. |
| 110 | 110 | ||
| 111 | --- | 111 | --- |
| 112 | 112 | ||
| @@ -131,7 +131,7 @@ Read a byte from the selected SPI device. | |||
| 131 | 131 | ||
| 132 | #### Return Value {#api-spi-read-return} | 132 | #### Return Value {#api-spi-read-return} |
| 133 | 133 | ||
| 134 | `SPI_STATUS_TIMEOUT` if the timeout period elapses, or the byte read from the device. | 134 | `SPI_STATUS_TIMEOUT` if the timeout period elapses, otherwise the byte read from the device. |
| 135 | 135 | ||
| 136 | --- | 136 | --- |
| 137 | 137 | ||
| @@ -159,7 +159,7 @@ Receive multiple bytes from the selected SPI device. | |||
| 159 | #### Arguments {#api-spi-receive-arguments} | 159 | #### Arguments {#api-spi-receive-arguments} |
| 160 | 160 | ||
| 161 | - `uint8_t *data` | 161 | - `uint8_t *data` |
| 162 | A pointer to the buffer to read into. | 162 | A pointer to a buffer to read into. |
| 163 | - `uint16_t length` | 163 | - `uint16_t length` |
| 164 | The number of bytes to read. Take care not to overrun the length of `data`. | 164 | The number of bytes to read. Take care not to overrun the length of `data`. |
| 165 | 165 | ||
