Haptic: driver-> feature (#13713)

2 files changed, 0 insertions, 503 deletions

diff --git a/drivers/haptic/haptic.c b/drivers/haptic/haptic.c
deleted file mode 100644
index 3fab1be1a..000000000
--- a/drivers/haptic/haptic.c
+++ /dev/null
@@ -1,422 +0,0 @@
-/* Copyright 2019 ishtob
- * Driver for haptic feedback written for QMK
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-#include "haptic.h"
-#include "eeconfig.h"
-#include "progmem.h"
-#include "debug.h"
-#ifdef DRV2605L
-#    include "DRV2605L.h"
-#endif
-#ifdef SOLENOID_ENABLE
-#    include "solenoid.h"
-#endif
-
-haptic_config_t haptic_config;
-
-void haptic_init(void) {
-    debug_enable = 1;  // Debug is ON!
-    if (!eeconfig_is_enabled()) {
-        eeconfig_init();
-    }
-    haptic_config.raw = eeconfig_read_haptic();
-#ifdef SOLENOID_ENABLE
-    solenoid_set_dwell(haptic_config.dwell);
-#endif
-    if ((haptic_config.raw == 0)
-#ifdef SOLENOID_ENABLE
-        || (haptic_config.dwell == 0)
-#endif
-    ) {
-        // this will be called, if the eeprom is not corrupt,
-        // but the previous firmware didn't have haptic enabled,
-        // or the previous firmware didn't have solenoid enabled,
-        // and the current one has solenoid enabled.
-        haptic_reset();
-    }
-#ifdef SOLENOID_ENABLE
-    solenoid_setup();
-    dprintf("Solenoid driver initialized\n");
-#endif
-#ifdef DRV2605L
-    DRV_init();
-    dprintf("DRV2605 driver initialized\n");
-#endif
-    eeconfig_debug_haptic();
-}
-
-void haptic_task(void) {
-#ifdef SOLENOID_ENABLE
-    solenoid_check();
-#endif
-}
-
-void eeconfig_debug_haptic(void) {
-    dprintf("haptic_config eprom\n");
-    dprintf("haptic_config.enable = %d\n", haptic_config.enable);
-    dprintf("haptic_config.mode = %d\n", haptic_config.mode);
-}
-
-void haptic_enable(void) {
-    haptic_config.enable = 1;
-    xprintf("haptic_config.enable = %u\n", haptic_config.enable);
-    eeconfig_update_haptic(haptic_config.raw);
-}
-
-void haptic_disable(void) {
-    haptic_config.enable = 0;
-    xprintf("haptic_config.enable = %u\n", haptic_config.enable);
-    eeconfig_update_haptic(haptic_config.raw);
-}
-
-void haptic_toggle(void) {
-    if (haptic_config.enable) {
-        haptic_disable();
-    } else {
-        haptic_enable();
-    }
-    eeconfig_update_haptic(haptic_config.raw);
-}
-
-void haptic_feedback_toggle(void) {
-    haptic_config.feedback++;
-    if (haptic_config.feedback >= HAPTIC_FEEDBACK_MAX) haptic_config.feedback = KEY_PRESS;
-    xprintf("haptic_config.feedback = %u\n", !haptic_config.feedback);
-    eeconfig_update_haptic(haptic_config.raw);
-}
-
-void haptic_buzz_toggle(void) {
-    bool buzz_stat     = !haptic_config.buzz;
-    haptic_config.buzz = buzz_stat;
-    haptic_set_buzz(buzz_stat);
-}
-
-void haptic_mode_increase(void) {
-    uint8_t mode = haptic_config.mode + 1;
-#ifdef DRV2605L
-    if (haptic_config.mode >= drv_effect_max) {
-        mode = 1;
-    }
-#endif
-    haptic_set_mode(mode);
-}
-
-void haptic_mode_decrease(void) {
-    uint8_t mode = haptic_config.mode - 1;
-#ifdef DRV2605L
-    if (haptic_config.mode < 1) {
-        mode = (drv_effect_max - 1);
-    }
-#endif
-    haptic_set_mode(mode);
-}
-
-void haptic_dwell_increase(void) {
-#ifdef SOLENOID_ENABLE
-    int16_t next_dwell = ((int16_t)haptic_config.dwell) + SOLENOID_DWELL_STEP_SIZE;
-    if (haptic_config.dwell >= SOLENOID_MAX_DWELL) {
-        // if it's already at max, we wrap back to min
-        next_dwell = SOLENOID_MIN_DWELL;
-    } else if (next_dwell > SOLENOID_MAX_DWELL) {
-        // if we overshoot the max, then cap at max
-        next_dwell = SOLENOID_MAX_DWELL;
-    }
-    solenoid_set_dwell(next_dwell);
-#else
-    int16_t next_dwell = ((int16_t)haptic_config.dwell) + 1;
-#endif
-    haptic_set_dwell(next_dwell);
-}
-
-void haptic_dwell_decrease(void) {
-#ifdef SOLENOID_ENABLE
-    int16_t next_dwell = ((int16_t)haptic_config.dwell) - SOLENOID_DWELL_STEP_SIZE;
-    if (haptic_config.dwell <= SOLENOID_MIN_DWELL) {
-        // if it's already at min, we wrap to max
-        next_dwell = SOLENOID_MAX_DWELL;
-    } else if (next_dwell < SOLENOID_MIN_DWELL) {
-        // if we go below min, then we cap to min
-        next_dwell = SOLENOID_MIN_DWELL;
-    }
-    solenoid_set_dwell(next_dwell);
-#else
-    int16_t next_dwell = ((int16_t)haptic_config.dwell) - 1;
-#endif
-    haptic_set_dwell(next_dwell);
-}
-
-void haptic_reset(void) {
-    haptic_config.enable   = true;
-    uint8_t feedback       = HAPTIC_FEEDBACK_DEFAULT;
-    haptic_config.feedback = feedback;
-#ifdef DRV2605L
-    uint8_t mode       = HAPTIC_MODE_DEFAULT;
-    haptic_config.mode = mode;
-#endif
-#ifdef SOLENOID_ENABLE
-    uint8_t dwell       = SOLENOID_DEFAULT_DWELL;
-    haptic_config.dwell = dwell;
-    haptic_config.buzz  = SOLENOID_DEFAULT_BUZZ;
-    solenoid_set_dwell(dwell);
-#else
-    // This is to trigger haptic_reset again, if solenoid is enabled in the future.
-    haptic_config.dwell = 0;
-    haptic_config.buzz  = 0;
-#endif
-    eeconfig_update_haptic(haptic_config.raw);
-    xprintf("haptic_config.feedback = %u\n", haptic_config.feedback);
-    xprintf("haptic_config.mode = %u\n", haptic_config.mode);
-}
-
-void haptic_set_feedback(uint8_t feedback) {
-    haptic_config.feedback = feedback;
-    eeconfig_update_haptic(haptic_config.raw);
-    xprintf("haptic_config.feedback = %u\n", haptic_config.feedback);
-}
-
-void haptic_set_mode(uint8_t mode) {
-    haptic_config.mode = mode;
-    eeconfig_update_haptic(haptic_config.raw);
-    xprintf("haptic_config.mode = %u\n", haptic_config.mode);
-}
-
-void haptic_set_amplitude(uint8_t amp) {
-    haptic_config.amplitude = amp;
-    eeconfig_update_haptic(haptic_config.raw);
-    xprintf("haptic_config.amplitude = %u\n", haptic_config.amplitude);
-#ifdef DRV2605L
-    DRV_amplitude(amp);
-#endif
-}
-
-void haptic_set_buzz(uint8_t buzz) {
-    haptic_config.buzz = buzz;
-    eeconfig_update_haptic(haptic_config.raw);
-    xprintf("haptic_config.buzz = %u\n", haptic_config.buzz);
-}
-
-void haptic_set_dwell(uint8_t dwell) {
-    haptic_config.dwell = dwell;
-    eeconfig_update_haptic(haptic_config.raw);
-    xprintf("haptic_config.dwell = %u\n", haptic_config.dwell);
-}
-
-uint8_t haptic_get_mode(void) {
-    if (!haptic_config.enable) {
-        return false;
-    }
-    return haptic_config.mode;
-}
-
-uint8_t haptic_get_feedback(void) {
-    if (!haptic_config.enable) {
-        return false;
-    }
-    return haptic_config.feedback;
-}
-
-uint8_t haptic_get_dwell(void) {
-    if (!haptic_config.enable) {
-        return false;
-    }
-    return haptic_config.dwell;
-}
-
-void haptic_enable_continuous(void) {
-    haptic_config.cont = 1;
-    xprintf("haptic_config.cont = %u\n", haptic_config.cont);
-    eeconfig_update_haptic(haptic_config.raw);
-#ifdef DRV2605L
-    DRV_rtp_init();
-#endif
-}
-
-void haptic_disable_continuous(void) {
-    haptic_config.cont = 0;
-    xprintf("haptic_config.cont = %u\n", haptic_config.cont);
-    eeconfig_update_haptic(haptic_config.raw);
-#ifdef DRV2605L
-    DRV_write(DRV_MODE, 0x00);
-#endif
-}
-
-void haptic_toggle_continuous(void) {
-#ifdef DRV2605L
-    if (haptic_config.cont) {
-        haptic_disable_continuous();
-    } else {
-        haptic_enable_continuous();
-    }
-    eeconfig_update_haptic(haptic_config.raw);
-#endif
-}
-
-void haptic_cont_increase(void) {
-    uint8_t amp = haptic_config.amplitude + 10;
-    if (haptic_config.amplitude >= 120) {
-        amp = 120;
-    }
-    haptic_set_amplitude(amp);
-}
-
-void haptic_cont_decrease(void) {
-    uint8_t amp = haptic_config.amplitude - 10;
-    if (haptic_config.amplitude < 20) {
-        amp = 20;
-    }
-    haptic_set_amplitude(amp);
-}
-
-void haptic_play(void) {
-#ifdef DRV2605L
-    uint8_t play_eff = 0;
-    play_eff         = haptic_config.mode;
-    DRV_pulse(play_eff);
-#endif
-#ifdef SOLENOID_ENABLE
-    solenoid_fire();
-#endif
-}
-
-__attribute__((weak)) bool get_haptic_enabled_key(uint16_t keycode, keyrecord_t *record) {
-    switch(keycode) {
-#    ifdef NO_HAPTIC_MOD
-        case QK_MOD_TAP ... QK_MOD_TAP_MAX:
-            if (record->tap.count == 0) return false;
-            break;
-        case QK_LAYER_TAP_TOGGLE ... QK_LAYER_TAP_TOGGLE_MAX:
-            if (record->tap.count != TAPPING_TOGGLE) return false;
-            break;
-        case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
-            if (record->tap.count == 0) return false;
-            break;
-        case KC_LCTRL ... KC_RGUI:
-        case QK_MOMENTARY ... QK_MOMENTARY_MAX:
-#    endif
-#    ifdef NO_HAPTIC_FN
-        case KC_FN0 ... KC_FN31:
-#    endif
-#    ifdef NO_HAPTIC_ALPHA
-        case KC_A ... KC_Z:
-#    endif
-#    ifdef NO_HAPTIC_PUNCTUATION
-        case KC_ENTER:
-        case KC_ESCAPE:
-        case KC_BSPACE:
-        case KC_SPACE:
-        case KC_MINUS:
-        case KC_EQUAL:
-        case KC_LBRACKET:
-        case KC_RBRACKET:
-        case KC_BSLASH:
-        case KC_NONUS_HASH:
-        case KC_SCOLON:
-        case KC_QUOTE:
-        case KC_GRAVE:
-        case KC_COMMA:
-        case KC_SLASH:
-        case KC_DOT:
-        case KC_NONUS_BSLASH:
-#    endif
-#    ifdef NO_HAPTIC_LOCKKEYS
-        case KC_CAPSLOCK:
-        case KC_SCROLLLOCK:
-        case KC_NUMLOCK:
-#    endif
-#    ifdef NO_HAPTIC_NAV
-        case KC_PSCREEN:
-        case KC_PAUSE:
-        case KC_INSERT:
-        case KC_DELETE:
-        case KC_PGDOWN:
-        case KC_PGUP:
-        case KC_LEFT:
-        case KC_UP:
-        case KC_RIGHT:
-        case KC_DOWN:
-        case KC_END:
-        case KC_HOME:
-#    endif
-#    ifdef NO_HAPTIC_NUMERIC
-        case KC_1 ... KC_0:
-#    endif
-         return false;
-    }
-    return true;
-}
-
-bool process_haptic(uint16_t keycode, keyrecord_t *record) {
-    if (keycode == HPT_ON && record->event.pressed) {
-        haptic_enable();
-    }
-    if (keycode == HPT_OFF && record->event.pressed) {
-        haptic_disable();
-    }
-    if (keycode == HPT_TOG && record->event.pressed) {
-        haptic_toggle();
-    }
-    if (keycode == HPT_RST && record->event.pressed) {
-        haptic_reset();
-    }
-    if (keycode == HPT_FBK && record->event.pressed) {
-        haptic_feedback_toggle();
-    }
-    if (keycode == HPT_BUZ && record->event.pressed) {
-        haptic_buzz_toggle();
-    }
-    if (keycode == HPT_MODI && record->event.pressed) {
-        haptic_mode_increase();
-    }
-    if (keycode == HPT_MODD && record->event.pressed) {
-        haptic_mode_decrease();
-    }
-    if (keycode == HPT_DWLI && record->event.pressed) {
-        haptic_dwell_increase();
-    }
-    if (keycode == HPT_DWLD && record->event.pressed) {
-        haptic_dwell_decrease();
-    }
-    if (keycode == HPT_CONT && record->event.pressed) {
-        haptic_toggle_continuous();
-    }
-    if (keycode == HPT_CONI && record->event.pressed) {
-        haptic_cont_increase();
-    }
-    if (keycode == HPT_COND && record->event.pressed) {
-        haptic_cont_decrease();
-    }
-
-    if (haptic_config.enable) {
-        if (record->event.pressed) {
-            // keypress
-            if (haptic_config.feedback < 2 && get_haptic_enabled_key(keycode, record)) {
-                haptic_play();
-            }
-        } else {
-            // keyrelease
-            if (haptic_config.feedback > 0 && get_haptic_enabled_key(keycode, record)) {
-                haptic_play();
-            }
-        }
-    }
-    return true;
-}
-
-void haptic_shutdown(void) {
-#ifdef SOLENOID_ENABLE
-    solenoid_shutdown();
-#endif
-}
diff --git a/drivers/haptic/haptic.h b/drivers/haptic/haptic.h
deleted file mode 100644
index ba8e0d20b..000000000
--- a/drivers/haptic/haptic.h
+++ /dev/null
@@ -1,81 +0,0 @@
-/* Copyright 2019 ishtob
- * Driver for haptic feedback written for QMK
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#pragma once
-#include <stdint.h>
-#include <stdbool.h>
-#include "quantum.h"
-#ifdef DRV2605L
-#    include "DRV2605L.h"
-#endif
-
-#ifndef HAPTIC_FEEDBACK_DEFAULT
-#    define HAPTIC_FEEDBACK_DEFAULT 0
-#endif
-#ifndef HAPTIC_MODE_DEFAULT
-#    define HAPTIC_MODE_DEFAULT DRV_MODE_DEFAULT
-#endif
-
-/* EEPROM config settings */
-typedef union {
-    uint32_t raw;
-    struct {
-        bool    enable : 1;
-        uint8_t feedback : 2;
-        uint8_t mode : 7;
-        bool    buzz : 1;
-        uint8_t dwell : 7;
-        bool    cont : 1;
-        uint8_t amplitude : 8;
-        uint8_t reserved : 5;
-    };
-} haptic_config_t;
-
-typedef enum HAPTIC_FEEDBACK {
-    KEY_PRESS,
-    KEY_PRESS_RELEASE,
-    KEY_RELEASE,
-    HAPTIC_FEEDBACK_MAX,
-} HAPTIC_FEEDBACK;
-
-bool    process_haptic(uint16_t keycode, keyrecord_t *record);
-void    haptic_init(void);
-void    haptic_task(void);
-void    eeconfig_debug_haptic(void);
-void    haptic_enable(void);
-void    haptic_disable(void);
-void    haptic_toggle(void);
-void    haptic_feedback_toggle(void);
-void    haptic_mode_increase(void);
-void    haptic_mode_decrease(void);
-void    haptic_mode(uint8_t mode);
-void    haptic_reset(void);
-void    haptic_set_feedback(uint8_t feedback);
-void    haptic_set_mode(uint8_t mode);
-void    haptic_set_dwell(uint8_t dwell);
-void    haptic_set_buzz(uint8_t buzz);
-void    haptic_buzz_toggle(void);
-uint8_t haptic_get_mode(void);
-uint8_t haptic_get_feedback(void);
-void    haptic_dwell_increase(void);
-void    haptic_dwell_decrease(void);
-void    haptic_toggle_continuous(void);
-void    haptic_cont_increase(void);
-void    haptic_cont_decrease(void);
-
-void haptic_play(void);
-void haptic_shutdown(void);