diff options
| author | Drashna Jaelre <drashna@live.com> | 2019-04-09 09:26:11 -0700 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-04-09 09:26:11 -0700 |
| commit | 51a7fb1f1ea74648dc926354c887a04929297aba (patch) | |
| tree | 653632f08da46b9dc8dc8ab65055927635087f85 /docs/internals_gpio_control.md | |
| parent | 7c9d1d58ee9da18fa64cacd564fdf512ec4cb74e (diff) | |
Remove documentation folder
Diffstat (limited to 'docs/internals_gpio_control.md')
| -rw-r--r-- | docs/internals_gpio_control.md | 23 |
1 files changed, 0 insertions, 23 deletions
diff --git a/docs/internals_gpio_control.md b/docs/internals_gpio_control.md deleted file mode 100644 index 51a549f1c9..0000000000 --- a/docs/internals_gpio_control.md +++ /dev/null @@ -1,23 +0,0 @@ -# GPIO Control - -QMK has a GPIO control abstraction layer which is microcontroller agnostic. This is done to allow easy access to pin control across different platforms. - -## Functions - -The following functions can provide basic control of GPIOs and are found in `quantum/quantum.h`. - -|Function |Description | -|----------------------|------------------------------------------------------------------| -|`setPinInput(pin)` |Set pin as input with high impedance (High-Z) | -|`setPinInputHigh(pin)`|Set pin as input with build in pull-up | -|`setPinInputLow(pin)` |Set pin as input with build in pull-down (Supported only on STM32)| -|`setPinOutput(pin)` |Set pin as output | -|`writePinHigh(pin)` |Set pin level as high, assuming it is an output | -|`writePinLow(pin)` |Set pin level as low, assuming it is an output | -|`writePin(pin, level)`|Set pin level, assuming it is an output | -|`readPin(pin)` |Returns the level of the pin | - -## Advanced Settings - -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. - |