tmk_core/common/eeconfig.h

   1 /*
   2 Copyright 2013 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 #ifndef EECONFIG_H
  19 #define EECONFIG_H
  20
  21 #include <stdint.h>
  22 #include <stdbool.h>
  23
  24
  25 #define EECONFIG_MAGIC_NUMBER                       (uint16_t)0xFEED
  26 #define EECONFIG_MAGIC_NUMBER_OFF                   (uint16_t)0xFFFF
  27
  28 /* EEPROM parameter address */
  29 #define EECONFIG_MAGIC                              (uint16_t *)0
  30 #define EECONFIG_DEBUG                               (uint8_t *)2
  31 #define EECONFIG_DEFAULT_LAYER                       (uint8_t *)3
  32 #define EECONFIG_KEYMAP                              (uint8_t *)4
  33 #define EECONFIG_MOUSEKEY_ACCEL                      (uint8_t *)5
  34 #define EECONFIG_BACKLIGHT                           (uint8_t *)6
  35 #define EECONFIG_AUDIO                               (uint8_t *)7
  36 #define EECONFIG_RGBLIGHT                           (uint32_t *)8
  37 #define EECONFIG_UNICODEMODE                        (uint8_t *)12
  38 #define EECONFIG_STENOMODE                          (uint8_t *)13
  39 // EEHANDS for two handed boards
  40 #define EECONFIG_HANDEDNESS                                             (uint8_t *)14
  41 #define EECONFIG_KEYBOARD                          (uint32_t *)15
  42 #define EECONFIG_USER                              (uint32_t *)19
  43
  44 /* debug bit */
  45 #define EECONFIG_DEBUG_ENABLE                       (1<<0)
  46 #define EECONFIG_DEBUG_MATRIX                       (1<<1)
  47 #define EECONFIG_DEBUG_KEYBOARD                     (1<<2)
  48 #define EECONFIG_DEBUG_MOUSE                        (1<<3)
  49
  50 /* keyconf bit */
  51 #define EECONFIG_KEYMAP_SWAP_CONTROL_CAPSLOCK       (1<<0)
  52 #define EECONFIG_KEYMAP_CAPSLOCK_TO_CONTROL         (1<<1)
  53 #define EECONFIG_KEYMAP_SWAP_LALT_LGUI              (1<<2)
  54 #define EECONFIG_KEYMAP_SWAP_RALT_RGUI              (1<<3)
  55 #define EECONFIG_KEYMAP_NO_GUI                      (1<<4)
  56 #define EECONFIG_KEYMAP_SWAP_GRAVE_ESC              (1<<5)
  57 #define EECONFIG_KEYMAP_SWAP_BACKSLASH_BACKSPACE    (1<<6)
  58 #define EECONFIG_KEYMAP_NKRO                        (1<<7)
  59
  60
  61 bool eeconfig_is_enabled(void);
  62 bool eeconfig_is_disabled(void);
  63
  64 void eeconfig_init(void);
  65 void eeconfig_init_quantum(void);
  66 void eeconfig_init_kb(void);
  67 void eeconfig_init_user(void);
  68
  69 void eeconfig_enable(void);
  70
  71 void eeconfig_disable(void);
  72
  73 uint8_t eeconfig_read_debug(void);
  74 void eeconfig_update_debug(uint8_t val);
  75
  76 uint8_t eeconfig_read_default_layer(void);
  77 void eeconfig_update_default_layer(uint8_t val);
  78
  79 uint8_t eeconfig_read_keymap(void);
  80 void eeconfig_update_keymap(uint8_t val);
  81
  82 #ifdef BACKLIGHT_ENABLE
  83 uint8_t eeconfig_read_backlight(void);
  84 void eeconfig_update_backlight(uint8_t val);
  85 #endif
  86
  87 #ifdef AUDIO_ENABLE
  88 uint8_t eeconfig_read_audio(void);
  89 void eeconfig_update_audio(uint8_t val);
  90 #endif
  91
  92 uint32_t eeconfig_read_kb(void);
  93 void eeconfig_update_kb(uint32_t val);
  94 uint32_t eeconfig_read_user(void);
  95 void eeconfig_update_user(uint32_t val);
  96
  97 #endif