diff options
| author | Drashna Jaelre <drashna@live.com> | 2019-10-07 19:08:14 -0700 |
|---|---|---|
| committer | noroadsleft <18669334+noroadsleft@users.noreply.github.com> | 2019-10-07 19:08:14 -0700 |
| commit | 403c139b34fe97f61eedb4a3cc4772d58bce0efc (patch) | |
| tree | 9bea09394dc8d8deb78c876a843efb6a4d8c0e20 | |
| parent | dc5876a8e62aa0f627aee85bca3a78a94f94fc5d (diff) | |
| download | qmk_firmware-403c139b34fe97f61eedb4a3cc4772d58bce0efc.tar.gz qmk_firmware-403c139b34fe97f61eedb4a3cc4772d58bce0efc.zip | |
[Docs] Add AVR and ARM examples to GPIO Commands (#6942)
* [Docs] Add AVR and ARM examples to GPIO Commands
Add examples for reference for people not as well versed in microcontroller coding, such as myself.
* Apply suggestions from code review
Co-Authored-By: fauxpark <fauxpark@gmail.com>
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
| -rw-r--r-- | docs/internals_gpio_control.md | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/docs/internals_gpio_control.md b/docs/internals_gpio_control.md index 51a549f1c..8b8351382 100644 --- a/docs/internals_gpio_control.md +++ b/docs/internals_gpio_control.md | |||
| @@ -6,18 +6,17 @@ QMK has a GPIO control abstraction layer which is microcontroller agnostic. This | |||
| 6 | 6 | ||
| 7 | The following functions can provide basic control of GPIOs and are found in `quantum/quantum.h`. | 7 | The following functions can provide basic control of GPIOs and are found in `quantum/quantum.h`. |
| 8 | 8 | ||
| 9 | |Function |Description | | 9 | |Function |Description | Old AVR Examples | Old ChibiOS/ARM Examples | |
| 10 | |----------------------|------------------------------------------------------------------| | 10 | |----------------------|------------------------------------------------------------------|------------------------------------------------|-------------------------------------------------| |
| 11 | |`setPinInput(pin)` |Set pin as input with high impedance (High-Z) | | 11 | |`setPinInput(pin)` |Set pin as input with high impedance (High-Z) | `DDRB &= ~(1<<2)` | `palSetLineMode(pin, PAL_MODE_INPUT)` | |
| 12 | |`setPinInputHigh(pin)`|Set pin as input with build in pull-up | | 12 | |`setPinInputHigh(pin)`|Set pin as input with builtin pull-up resistor | `DDRB &= ~(1<<2); PORTB \|= (1<<2)` | `palSetLineMode(pin, PAL_MODE_INPUT_PULLUP)` | |
| 13 | |`setPinInputLow(pin)` |Set pin as input with build in pull-down (Supported only on STM32)| | 13 | |`setPinInputLow(pin)` |Set pin as input with builtin pull-down resistor | N/A (Not supported on AVR) | `palSetLineMode(pin, PAL_MODE_INPUT_PULLDOWN)` | |
| 14 | |`setPinOutput(pin)` |Set pin as output | | 14 | |`setPinOutput(pin)` |Set pin as output | `DDRB \|= (1<<2)` | `palSetLineMode(pin, PAL_MODE_OUTPUT_PUSHPULL)` | |
| 15 | |`writePinHigh(pin)` |Set pin level as high, assuming it is an output | | 15 | |`writePinHigh(pin)` |Set pin level as high, assuming it is an output | `PORTB \|= (1<<2)` | `palSetLine(pin)` | |
| 16 | |`writePinLow(pin)` |Set pin level as low, assuming it is an output | | 16 | |`writePinLow(pin)` |Set pin level as low, assuming it is an output | `PORTB &= ~(1<<2)` | `palClearLine(pin)` | |
| 17 | |`writePin(pin, level)`|Set pin level, assuming it is an output | | 17 | |`writePin(pin, level)`|Set pin level, assuming it is an output | `(level) ? PORTB \|= (1<<2) : PORTB &= ~(1<<2)` | `(level) ? palSetLine(pin) : palClearLine(pin)` | |
| 18 | |`readPin(pin)` |Returns the level of the pin | | 18 | |`readPin(pin)` |Returns the level of the pin | `_SFR_IO8(pin >> 4) & _BV(pin & 0xF)` | `palReadLine(pin)` | |
| 19 | 19 | ||
| 20 | ## Advanced Settings | 20 | ## Advanced Settings |
| 21 | 21 | ||
| 22 | Each microcontroller can have multiple advanced settings regarding its GPIO. This abstraction layer does not limit the use of architecture-specific functions. Advanced users should consult the datasheet of their desired device and include any needed libraries. For AVR, the standard avr/io.h library is used; for STM32, the ChibiOS [PAL library](http://chibios.sourceforge.net/docs3/hal/group___p_a_l.html) is used. | 22 | Each microcontroller can have multiple advanced settings regarding its GPIO. This abstraction layer does not limit the use of architecture-specific functions. Advanced users should consult the datasheet of their desired device and include any needed libraries. For AVR, the standard avr/io.h library is used; for STM32, the ChibiOS [PAL library](http://chibios.sourceforge.net/docs3/hal/group___p_a_l.html) is used. |
| 23 | |||