aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/drivers/battery.md4
-rw-r--r--docs/features/key_overrides.md6
-rw-r--r--docs/features/ps2_mouse.md13
-rw-r--r--docs/license_violations.md3
4 files changed, 15 insertions, 11 deletions
diff --git a/docs/drivers/battery.md b/docs/drivers/battery.md
index 0bc8e5aec9..e482ffc8b6 100644
--- a/docs/drivers/battery.md
+++ b/docs/drivers/battery.md
@@ -36,8 +36,8 @@ The following `#define`s apply only to the `adc` driver:
|-----------------------------|--------------|--------------------------------------------------------------|
|`BATTERY_PIN` |*Not defined* |The GPIO pin connected to the voltage divider. |
|`BATTERY_REF_VOLTAGE_MV` |`3300` |The ADC reverence voltage, in millivolts. |
-|`BATTERY_VOLTAGE_DIVIDER_R1` |`100000` |The voltage divider resistance, in kOhm. Set to 0 to disable. |
-|`BATTERY_VOLTAGE_DIVIDER_R1` |`100000` |The voltage divider resistance, in kOhm. Set to 0 to disable. |
+|`BATTERY_VOLTAGE_DIVIDER_R1` |`100` |The voltage divider resistance, in kOhm. Set to 0 to disable. |
+|`BATTERY_VOLTAGE_DIVIDER_R2` |`100` |The voltage divider resistance, in kOhm. Set to 0 to disable. |
|`BATTERY_ADC_RESOLUTION` |`10` |The ADC resolution configured for the ADC Driver. |
## Functions
diff --git a/docs/features/key_overrides.md b/docs/features/key_overrides.md
index 9b6015175c..e83f0295ab 100644
--- a/docs/features/key_overrides.md
+++ b/docs/features/key_overrides.md
@@ -135,11 +135,11 @@ bool momentary_layer(bool key_down, void *layer) {
return false;
}
-const key_override_t fn_override = {.trigger_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL), //
+const key_override_t fn_override = {.trigger_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RALT), //
.layers = ~(1 << LAYER_FN), //
- .suppressed_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL), //
+ .suppressed_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RALT), //
.options = ko_option_no_unregister_on_other_key_down, //
- .negative_mod_mask = (uint8_t) ~(MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL)), //
+ .negative_mod_mask = (uint8_t) ~(MOD_BIT(KC_RGUI) | MOD_BIT(KC_RALT)), //
.custom_action = momentary_layer, //
.context = (void *)LAYER_FN, //
.trigger = KC_NO, //
diff --git a/docs/features/ps2_mouse.md b/docs/features/ps2_mouse.md
index 52443c3ce2..6ef7e46768 100644
--- a/docs/features/ps2_mouse.md
+++ b/docs/features/ps2_mouse.md
@@ -23,8 +23,11 @@ MODULE 5+ --------+--+--------- PWR CONTROLLER
CLK ------+------------ PIN
```
+## Driver Configuration {#driver-configuration}
-## Busywait Version {#busywait-version}
+Driver selection can be configured in `rules.mk` as `PS2_DRIVER`, or in `info.json` as `ps2.driver`. Valid values are `busywait` (default), `interrupt`, `usart`, or `vendor`. See below for information on individual drivers.
+
+### Busywait Driver {#busywait-driver}
Note: This is not recommended, you may encounter jerky movement or unsent inputs. Please use interrupt or USART version if possible.
@@ -45,7 +48,7 @@ In your keyboard config.h:
#endif
```
-### Interrupt Version (AVR/ATMega32u4) {#interrupt-version-avr}
+### Interrupt Driver (AVR/ATMega32u4) {#interrupt-driver-avr}
The following example uses D2 for clock and D5 for data. You can use any INT or PCINT pin for clock, and any pin for data.
@@ -78,7 +81,7 @@ In your keyboard config.h:
#endif
```
-### Interrupt Version (ARM chibios) {#interrupt-version-chibios}
+### Interrupt Driver (ARM chibios) {#interrupt-driver-chibios}
Pretty much any two pins can be used for the (software) interrupt variant on ARM cores. The example below uses A8 for clock, and A9 for data.
@@ -107,7 +110,7 @@ And in the ChibiOS specific `halconf.h`:
#include_next <halconf.h>
```
-### USART Version {#usart-version}
+### USART Driver {#usart-driver}
To use USART on the ATMega32u4, you have to use PD5 for clock and PD2 for data. If one of those are unavailable, you need to use interrupt version.
@@ -159,7 +162,7 @@ In your keyboard config.h:
#endif
```
-### RP2040 PIO Version {#rp2040-pio-version}
+### RP2040 PIO Driver {#rp2040-pio-driver}
The `PIO` subsystem is a Raspberry Pi RP2040 specific implementation, using the integrated PIO peripheral and is therefore only available on this MCU.
diff --git a/docs/license_violations.md b/docs/license_violations.md
index 0bc62102ed..0b152f6960 100644
--- a/docs/license_violations.md
+++ b/docs/license_violations.md
@@ -26,6 +26,7 @@ If you own a board from one of the following vendors already, consider asking th
| Chosfox | Selling L75 wired/wireless boards based on QMK without sources, just `via.json` provided. Raised on discord over multiple weeks without response. |
| CIDOO | Selling wired boards based on QMK without sources, just `via.json` provided. |
| ColorReco | Selling tri-mode boards based on QMK without sources. |
+| CrossDIY | Selling wired boards based on QMK without sources. |
| Darmoshark | Selling wired boards based on QMK without sources, just `via.json` provided. |
| Epomaker | Lots of historical keyboards with `via.json` but no corresponding sources. Wireless code for a small handful provided, pending core cleanup for QMK upstreaming. Most other boards have source nowhere to be seen. |
| Ergokbd (IFKB) | At least their crkbd clone ships with QMK+Vial, seemingly refuses to disclose sources despite multiple customers requesting them. |
@@ -50,7 +51,7 @@ If you own a board from one of the following vendors already, consider asking th
| Womier | Selling tri-mode boards based on QMK without sources, attempted upstreaming crippled firmware without wireless. |
| Wuque Studio | Selling wired and tri-mode boards based on QMK without sources, just `via.json` provided. |
| XVX | Ambiguity on PRs -- marketing says wireless, PR author said wired-only. Seemingly intentionally deceptive. |
-| Yunzii | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
+| Yunzii | Selling tri-mode boards based on QMK without sources, just `via.json` provided. Refuses to release sources due to proprietary wireless driver, in direct violation of the GPL. |
| Zuoya | Selling tri-mode boards based on QMK without sources, just `via.json` provided. |
::: danger Violations