[Docs] Random Fixes (#8340)

* fix CLI section links in the Summary * fix heading in Pointing Device doc * fix headings in PS/2 Mouse Support doc * add explicit section ids to I2C Master Driver doc * reformat GPIO Controls table Much like the I2C Master Driver doc, I found this a bit less than ideal to read. (The table was actually wider than the space available for it.) Reformatted so each GPIO function is an H3 heading, followed by a paragraph and a table of each architecture's old-style function. * migrate changes from I2C Master Driver doc to Japanese translation * add explicit anchors to I2C Master Driver docs * fix code block language markers The language markers are case-sensitive; using the wrong case means the syntax highlighting doesn't work. Good: ```c Bad: ```C * restore Japanese I2C Master Driver doc to current master Can't update the internal tracking references accurately until the changes to the English doc are committed to master. * add explicit anchors to edited files * change ChibiOS/ARM to ARM/ChibiOS Because ARM/ATSAM is also a thing that exists. * fix code block language markers again Used the wrong markers in a few spots. Also these are apparently always supposed to be lowercase. * add section anchors to cli.md * restore table formatting on GPIO Control doc * remove changes to _summary.md
author: James Young <18669334+noroadsleft@users.noreply.github.com> 2020-03-15 20:29:11 -0700
committer: GitHub <noreply@github.com> 2020-03-15 20:29:11 -0700
commit: b272c035ba7fa8555a88c922b3e94c3f3817c4ff (patch)
tree: a5c9a1f6e4a1d9c02b72a12e33b2f9e69b5bf85b /docs/internals_gpio_control.md
parent: 5f1f370463d818a5283a17001ad832073efc45a4 (diff)
download: qmk_firmware-b272c035ba7fa8555a88c922b3e94c3f3817c4ff.tar.gz
qmk_firmware-b272c035ba7fa8555a88c922b3e94c3f3817c4ff.zip
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/internals_gpio_control.md b/docs/internals_gpio_control.md
index 8b8351382..74ac09035 100644
--- a/docs/internals_gpio_control.md
+++ b/docs/internals_gpio_control.md
@@ -1,22 +1,22 @@
-# GPIO Control
+# GPIO Control :id=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
+## Functions :id=functions
 The following functions can provide basic control of GPIOs and are found in `quantum/quantum.h`.
-|Function              |Description                                                       | Old AVR Examples                               | Old ChibiOS/ARM Examples                        |
+|Function                |Description                                       | Old AVR Examples                                | Old ChibiOS/ARM Examples                        |
-|----------------------|------------------------------------------------------------------|------------------------------------------------|-------------------------------------------------|
+|------------------------|--------------------------------------------------|-------------------------------------------------|-------------------------------------------------|
-|`setPinInput(pin)`    |Set pin as input with high impedance (High-Z)                     | `DDRB &= ~(1<<2)`                              | `palSetLineMode(pin, PAL_MODE_INPUT)`           |
+| `setPinInput(pin)`     | Set pin as input with high impedance (High-Z)    | `DDRB &= ~(1<<2)`                               | `palSetLineMode(pin, PAL_MODE_INPUT)`           |
-|`setPinInputHigh(pin)`|Set pin as input with builtin pull-up resistor                    | `DDRB &= ~(1<<2); PORTB \|= (1<<2)`             | `palSetLineMode(pin, PAL_MODE_INPUT_PULLUP)`    |
+| `setPinInputHigh(pin)` | Set pin as input with builtin pull-up resistor   | `DDRB &= ~(1<<2); PORTB \|= (1<<2)`             | `palSetLineMode(pin, PAL_MODE_INPUT_PULLUP)`    |
-|`setPinInputLow(pin)` |Set pin as input with builtin pull-down resistor                  | N/A (Not supported on AVR)                     | `palSetLineMode(pin, PAL_MODE_INPUT_PULLDOWN)`  |
+| `setPinInputLow(pin)`  | Set pin as input with builtin pull-down resistor | N/A (Not supported on AVR)                      | `palSetLineMode(pin, PAL_MODE_INPUT_PULLDOWN)`  |
-|`setPinOutput(pin)`   |Set pin as output                                                 | `DDRB \|= (1<<2)`                               | `palSetLineMode(pin, PAL_MODE_OUTPUT_PUSHPULL)` |
+| `setPinOutput(pin)`    | Set pin as output                                | `DDRB \|= (1<<2)`                               | `palSetLineMode(pin, PAL_MODE_OUTPUT_PUSHPULL)` |
-|`writePinHigh(pin)`   |Set pin level as high, assuming it is an output                   | `PORTB \|= (1<<2)`                              | `palSetLine(pin)`                               |
+| `writePinHigh(pin)`    | Set pin level as high, assuming it is an output  | `PORTB \|= (1<<2)`                              | `palSetLine(pin)`                               |
-|`writePinLow(pin)`    |Set pin level as low, assuming it is an output                    | `PORTB &= ~(1<<2)`                             | `palClearLine(pin)`                             |
+| `writePinLow(pin)`     | Set pin level as low, assuming it is an output   | `PORTB &= ~(1<<2)`                              | `palClearLine(pin)`                             |
-|`writePin(pin, level)`|Set pin level, assuming it is an output                           | `(level) ? PORTB \|= (1<<2) : PORTB &= ~(1<<2)` | `(level) ? palSetLine(pin) : palClearLine(pin)` |
+| `writePin(pin, level)` | Set pin level, assuming it is an output          | `(level) ? PORTB \|= (1<<2) : PORTB &= ~(1<<2)` | `(level) ? palSetLine(pin) : palClearLine(pin)` |
-|`readPin(pin)`        |Returns the level of the pin                                      | `_SFR_IO8(pin >> 4) & _BV(pin & 0xF)`          | `palReadLine(pin)`                              |
+| `readPin(pin)`         | Returns the level of the pin                     | `_SFR_IO8(pin >> 4) & _BV(pin & 0xF)`           | `palReadLine(pin)`                              |
-## Advanced Settings
+## Advanced Settings :id=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.
author	James Young <18669334+noroadsleft@users.noreply.github.com>	2020-03-15 20:29:11 -0700
committer	GitHub <noreply@github.com>	2020-03-15 20:29:11 -0700
commit	b272c035ba7fa8555a88c922b3e94c3f3817c4ff (patch)
tree	a5c9a1f6e4a1d9c02b72a12e33b2f9e69b5bf85b /docs/internals_gpio_control.md
parent	5f1f370463d818a5283a17001ad832073efc45a4 (diff)
download	qmk_firmware-b272c035ba7fa8555a88c922b3e94c3f3817c4ff.tar.gz qmk_firmware-b272c035ba7fa8555a88c922b3e94c3f3817c4ff.zip

diff --git a/docs/internals_gpio_control.md b/docs/internals_gpio_control.md index 8b8351382..74ac09035 100644 --- a/docs/internals_gpio_control.md +++ b/docs/internals_gpio_control.md
@@ -1,22 +1,22 @@
1	# GPIO Control	1	# GPIO Control :id=gpio-control
2		2
3	QMK has a GPIO control abstraction layer which is microcontroller agnostic. This is done to allow easy access to pin control across different platforms.	3	QMK has a GPIO control abstraction layer which is microcontroller agnostic. This is done to allow easy access to pin control across different platforms.
4		4
5	## Functions	5	## Functions :id=functions
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 \| Old AVR Examples \| Old ChibiOS/ARM Examples \|	9	\|Function \|Description \| Old AVR Examples \| Old ChibiOS/ARM Examples \|
10	\|----------------------\|------------------------------------------------------------------\|------------------------------------------------\|-------------------------------------------------\|	10	\|------------------------\|--------------------------------------------------\|-------------------------------------------------\|-------------------------------------------------\|
11	\|`setPinInput(pin)` \|Set pin as input with high impedance (High-Z) \| `DDRB &= ~(1<<2)` \| `palSetLineMode(pin, PAL_MODE_INPUT)` \|	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 builtin pull-up resistor \| `DDRB &= ~(1<<2); PORTB \\|= (1<<2)` \| `palSetLineMode(pin, PAL_MODE_INPUT_PULLUP)` \|	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 builtin pull-down resistor \| N/A (Not supported on AVR) \| `palSetLineMode(pin, PAL_MODE_INPUT_PULLDOWN)` \|	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 \| `DDRB \\|= (1<<2)` \| `palSetLineMode(pin, PAL_MODE_OUTPUT_PUSHPULL)` \|	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 \| `PORTB \\|= (1<<2)` \| `palSetLine(pin)` \|	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 \| `PORTB &= ~(1<<2)` \| `palClearLine(pin)` \|	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 \| `(level) ? PORTB \\|= (1<<2) : PORTB &= ~(1<<2)` \| `(level) ? palSetLine(pin) : palClearLine(pin)` \|	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 \| `_SFR_IO8(pin >> 4) & _BV(pin & 0xF)` \| `palReadLine(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 :id=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.