* initial work to add eeprom to haptic feedback and decouple the feedback process from keyboards * Haptic feedback enhancements: on/off toggle working, feedback order working todo: -work on modes switching -get modes switching to save to eeprom * haptic enhancement - eeprom and modes added * Added set and get functions for haptic feedback * initial implementation of solenoids under haptic feedback * changed eeprom to 32 bits to reserve blocks for future features * start documentation of haptic feedback * change keycode per comment from reviewers * typo fixes * added eeprom for solenoid configs * added solenoid and docs * Add/fix default parameters configs, improve docs * more doc cleanup * add in solenoid buzz toggle, clean up doc * some fixes for error in compiling solenoid * fix a chibios specific i2c read function and added one for AVR controllers in DRV2605L.c * fixes for avr side issues * update keymap * fix keymap compile error * fix bugs found during solenoid testing * set pin that is not powered during bootloader * added warning about certain pins on the MCU may trip solenoid during DFU/bootloader
		
			
				
	
	
		
			83 lines
		
	
	
		
			2.1 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			83 lines
		
	
	
		
			2.1 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/* 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;
 | 
						|
    uint16_t reserved  :16; 
 | 
						|
  };
 | 
						|
} 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_play(void);
 | 
						|
void haptic_shutdown(void);
 | 
						|
 | 
						|
 | 
						|
 | 
						|
 | 
						|
 |