Remove default pointing device driver. (#16190)

* remove custom as default

* add missing pointing_device_driver to rules.mk

* Update docs
master
Dasky 2022-02-05 14:29:15 +00:00 committed by GitHub
parent 065f6eeb4e
commit b1debfb12f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 19 additions and 3 deletions

View File

@ -109,7 +109,6 @@ ifeq ($(strip $(MOUSEKEY_ENABLE)), yes)
endif endif
VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick cirque_pinnacle_i2c cirque_pinnacle_spi pmw3360 pmw3389 pimoroni_trackball custom VALID_POINTING_DEVICE_DRIVER_TYPES := adns5050 adns9800 analog_joystick cirque_pinnacle_i2c cirque_pinnacle_spi pmw3360 pmw3389 pimoroni_trackball custom
POINTING_DEVICE_DRIVER ?= custom
ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes) ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
ifeq ($(filter $(POINTING_DEVICE_DRIVER),$(VALID_POINTING_DEVICE_DRIVER_TYPES)),) ifeq ($(filter $(POINTING_DEVICE_DRIVER),$(VALID_POINTING_DEVICE_DRIVER_TYPES)),)
$(call CATASTROPHIC_ERROR,Invalid POINTING_DEVICE_DRIVER,POINTING_DEVICE_DRIVER="$(POINTING_DEVICE_DRIVER)" is not a valid pointing device type) $(call CATASTROPHIC_ERROR,Invalid POINTING_DEVICE_DRIVER,POINTING_DEVICE_DRIVER="$(POINTING_DEVICE_DRIVER)" is not a valid pointing device type)

View File

@ -2,7 +2,7 @@
Pointing Device is a generic name for a feature intended to be generic: moving the system pointer around. There are certainly other options for it - like mousekeys - but this aims to be easily modifiable and hardware driven. You can implement custom keys to control functionality, or you can gather information from other peripherals and insert it directly here - let QMK handle the processing for you. Pointing Device is a generic name for a feature intended to be generic: moving the system pointer around. There are certainly other options for it - like mousekeys - but this aims to be easily modifiable and hardware driven. You can implement custom keys to control functionality, or you can gather information from other peripherals and insert it directly here - let QMK handle the processing for you.
To enable Pointing Device, uncomment the following line in your rules.mk: To enable Pointing Device, add the following line in your rules.mk and specify one of the driver options below.
```make ```make
POINTING_DEVICE_ENABLE = yes POINTING_DEVICE_ENABLE = yes
@ -181,7 +181,13 @@ The CPI range is 50-16000, in increments of 50. Defaults to 2000 CPI.
### Custom Driver ### Custom Driver
If you have a sensor type that isn't supported here, you can manually implement it, by adding these functions (with the correct implementation for your device): If you have a sensor type that isn't supported above, a custom option is available by adding the following to your `rules.mk`
```make
POINTING_DEVICE_DRIVER = custom
```
Using the custom driver will require implementing the following functions:
```c ```c
void pointing_device_driver_init(void) {} void pointing_device_driver_init(void) {}

View File

@ -1,3 +1,4 @@
POINTING_DEVICE_ENABLE = yes POINTING_DEVICE_ENABLE = yes
POINTING_DEVICE_DRIVER = custom
SRC += pimoroni_trackball.c SRC += pimoroni_trackball.c
MOUSEKEY_ENABLE = no MOUSEKEY_ENABLE = no

View File

@ -1,5 +1,6 @@
# Build Options # Build Options
POINTING_DEVICE_ENABLE = yes # Generic Pointer, not as big as mouse keys hopefully. POINTING_DEVICE_ENABLE = yes # Generic Pointer, not as big as mouse keys hopefully.
POINTING_DEVICE_DRIVER = custom
MOUSEKEY_ENABLE = yes # Mouse keys(+4700) MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
EXTRAKEY_ENABLE = yes # Audio control and System control(+450) EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight. RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight.

View File

@ -10,6 +10,7 @@ BOOTLOADER = caterina
BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite
#MOUSEKEY_ENABLE = yes # Mouse keys #MOUSEKEY_ENABLE = yes # Mouse keys
POINTING_DEVICE_ENABLE = yes # Generic Pointer, not as big as mouse keys hopefully. POINTING_DEVICE_ENABLE = yes # Generic Pointer, not as big as mouse keys hopefully.
POINTING_DEVICE_DRIVER = custom
EXTRAKEY_ENABLE = yes # Audio control and System control EXTRAKEY_ENABLE = yes # Audio control and System control
CONSOLE_ENABLE = yes # Console for debug CONSOLE_ENABLE = yes # Console for debug
COMMAND_ENABLE = yes # Commands for debug and configuration COMMAND_ENABLE = yes # Commands for debug and configuration

View File

@ -27,6 +27,7 @@ ifneq ($(strip $(SCROLLSTEP)),)
endif endif
ifeq ($(strip $(BALLER)), yes) ifeq ($(strip $(BALLER)), yes)
POINTING_DEVICE_ENABLE = yes POINTING_DEVICE_ENABLE = yes
POINTING_DEVICE_DRIVER = custom
OPT_DEFS += -DBALLER OPT_DEFS += -DBALLER
endif endif
ifeq ($(strip $(DEBUG_BALLER)), yes) ifeq ($(strip $(DEBUG_BALLER)), yes)

View File

@ -27,6 +27,7 @@ ifneq ($(strip $(SCROLLSTEP)),)
endif endif
ifeq ($(strip $(BALLER)), yes) ifeq ($(strip $(BALLER)), yes)
POINTING_DEVICE_ENABLE = yes POINTING_DEVICE_ENABLE = yes
POINTING_DEVICE_DRIVER = custom
OPT_DEFS += -DBALLER OPT_DEFS += -DBALLER
endif endif
ifeq ($(strip $(DEBUG_BALLER)), yes) ifeq ($(strip $(DEBUG_BALLER)), yes)

View File

@ -28,6 +28,7 @@ endif
ifeq ($(strip $(BALLER)), yes) ifeq ($(strip $(BALLER)), yes)
OPT_DEFS += -DBALLER OPT_DEFS += -DBALLER
POINTING_DEVICE_ENABLE = yes POINTING_DEVICE_ENABLE = yes
POINTING_DEVICE_DRIVER = custom
endif endif
ifeq ($(strip $(DEBUG_BALLER)), yes) ifeq ($(strip $(DEBUG_BALLER)), yes)
OPT_DEFS += -DDEBUG_BALLER OPT_DEFS += -DDEBUG_BALLER

View File

@ -27,6 +27,7 @@ ifneq ($(strip $(SCROLLSTEP)),)
endif endif
ifeq ($(strip $(BALLER)), yes) ifeq ($(strip $(BALLER)), yes)
POINTING_DEVICE_ENABLE = yes POINTING_DEVICE_ENABLE = yes
POINTING_DEVICE_DRIVER = custom
OPT_DEFS += -DBALLER OPT_DEFS += -DBALLER
endif endif
ifeq ($(strip $(DEBUG_BALLER)), yes) ifeq ($(strip $(DEBUG_BALLER)), yes)

View File

@ -29,6 +29,7 @@ ifneq ($(strip $(SCROLLSTEP)),)
endif endif
ifeq ($(strip $(BALLER)), yes) ifeq ($(strip $(BALLER)), yes)
POINTING_DEVICE_ENABLE = yes POINTING_DEVICE_ENABLE = yes
POINTING_DEVICE_DRIVER = custom
OPT_DEFS += -DBALLER OPT_DEFS += -DBALLER
endif endif
ifeq ($(strip $(DEBUG_BALLER)), yes) ifeq ($(strip $(DEBUG_BALLER)), yes)

View File

@ -10,6 +10,7 @@ BOOTLOADER = caterina
BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite
#MOUSEKEY_ENABLE = yes # Mouse keys #MOUSEKEY_ENABLE = yes # Mouse keys
POINTING_DEVICE_ENABLE = yes # Generic Pointer, not as big as mouse keys hopefully. POINTING_DEVICE_ENABLE = yes # Generic Pointer, not as big as mouse keys hopefully.
POINTING_DEVICE_DRIVER = custom
EXTRAKEY_ENABLE = yes # Audio control and System control EXTRAKEY_ENABLE = yes # Audio control and System control
CONSOLE_ENABLE = yes # Console for debug CONSOLE_ENABLE = yes # Console for debug
COMMAND_ENABLE = yes # Commands for debug and configuration COMMAND_ENABLE = yes # Commands for debug and configuration

View File

@ -19,5 +19,6 @@ AUDIO_ENABLE = no # Audio output
# Add trackball support # Add trackball support
POINTING_DEVICE_ENABLE = yes POINTING_DEVICE_ENABLE = yes
POINTING_DEVICE_DRIVER = custom
SRC += adns.c SRC += adns.c
QUANTUM_LIB_SRC += spi_master.c QUANTUM_LIB_SRC += spi_master.c

View File

@ -16,6 +16,7 @@ endif
ifeq ($(strip $(THUMBSTICK_ENABLE)), yes) ifeq ($(strip $(THUMBSTICK_ENABLE)), yes)
POINTING_DEVICE_ENABLE = yes POINTING_DEVICE_ENABLE = yes
POINTING_DEVICE_DRIVER = custom
OPT_DEFS += -DTHUMBSTICK_ENABLE OPT_DEFS += -DTHUMBSTICK_ENABLE
SRC += analog.c SRC += analog.c
SRC += thumbstick.c SRC += thumbstick.c