haptic: naming cleanups (qmk#21551)

builddefs/common_features.mk

@@ -721,18 +721,23 @@ ifeq ($(strip $(FNV_ENABLE)), yes)
  SRC += qmk_fnv_type_validation.c hash_32a.c hash_64a.c
 endif
 
+VALID_HAPTIC_DRIVER_TYPES := drv2605l solenoid
 ifeq ($(strip $(HAPTIC_ENABLE)),yes)
- COMMON_VPATH += $(DRIVER_PATH)/haptic
+ ifeq ($(filter $(HAPTIC_DRIVER),$(VALID_HAPTIC_DRIVER_TYPES)),)
+ $(call CATASTROPHIC_ERROR,Invalid HAPTIC_DRIVER,HAPTIC_DRIVER="$(HAPTIC_DRIVER)" is not a valid Haptic driver)
+ else
+ COMMON_VPATH += $(DRIVER_PATH)/haptic
 
- ifneq ($(filter DRV2605L, $(HAPTIC_DRIVER)), )
- SRC += DRV2605L.c
- QUANTUM_LIB_SRC += i2c_master.c
- OPT_DEFS += -DDRV2605L
- endif
+  ifeq ($(strip $(HAPTIC_DRIVER)), drv2605l)
+  SRC += drv2605l.c
+  QUANTUM_LIB_SRC += i2c_master.c
+  OPT_DEFS += -DHAPTIC_DRV2605L
+  endif
 
- ifneq ($(filter SOLENOID, $(HAPTIC_DRIVER)), )
- SRC += solenoid.c
- OPT_DEFS += -DSOLENOID_ENABLE
+ ifeq ($(strip $(HAPTIC_DRIVER)), solenoid)
+ SRC += solenoid.c
+ OPT_DEFS += -DHAPTIC_SOLENOID
+ endif
  endif
 endif
 

docs/feature_haptic_feedback.md

@@ -4,11 +4,12 @@
 
 The following options are currently available for haptic feedback in `rules.mk`:
 
-```
+```make
 HAPTIC_ENABLE = yes
 
-HAPTIC_DRIVER += DRV2605L
-HAPTIC_DRIVER += SOLENOID
+HAPTIC_DRIVER = drv2605l
+# or
+HAPTIC_DRIVER = solenoid
 ```
 
 The following `config.h` settings are available for all types of haptic feedback:
@@ -92,7 +93,7 @@ This driver supports 2 different feedback motors. Set the following in your `con
 
 Eccentric Rotating Mass vibration motors (ERM) is motor with a off-set weight attached so when drive signal is attached, the off-set weight spins and causes a sinusoidal wave that translate into vibrations.
 
-```
+```c
 #define FB_ERM_LRA 0
 #define FB_BRAKEFACTOR 3 /* For 1x:0, 2x:1, 3x:2, 4x:3, 6x:4, 8x:5, 16x:6, Disable Braking:7 */
 #define FB_LOOPGAIN 1 /* For Low:0, Medium:1, High:2, Very High:3 */
@@ -105,7 +106,7 @@ Eccentric Rotating Mass vibration motors (ERM) is motor with a off-set weight at
 
 Linear resonant actuators (LRA, also know as a linear vibrator) works different from a ERM. A LRA has a weight and magnet suspended by springs and a voice coil. When the drive signal is applied, the weight would be vibrate on a single axis (side to side or up and down). Since the weight is attached to a spring, there is a resonance effect at a specific frequency. This frequency is where the LRA will operate the most efficiently. Refer to the motor's datasheet for the recommanded range for this frequency.
 
-``` 
+```c
 #define FB_ERM_LRA 1
 #define FB_BRAKEFACTOR 3 /* For 1x:0, 2x:1, 3x:2, 4x:3, 6x:4, 8x:5, 16x:6, Disable Braking:7 */
 #define FB_LOOPGAIN 1 /* For Low:0, Medium:1, High:2, Very High:3 */
@@ -170,13 +171,13 @@ List of waveform sequences from the datasheet:
 | 42 | lg_dblclick_med_80 | 84 | transition_rampup_med_smooth1 | | |
 ### Optional DRV2605L defines
 
-```
-#define DRV_GREETING *sequence name or number*
+```c
+#define DRV2605L_GREETING *sequence name or number*
 ```
 If haptic feedback is enabled, the keyboard will vibrate to a specific sequence during startup. That can be selected using the following define:
 
-```
-#define DRV_MODE_DEFAULT *sequence name or number*
+```c
+#define DRV2605L_DEFAULT_MODE *sequence name or number*
 ```
 This will set what sequence `HF_RST` will set as the active mode. If not defined, mode will be set to 1 when `HF_RST` is pressed.