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
  27 /* eeprom parameteter address */
  28 #define EECONFIG_MAGIC                              (uint16_t *)0
  29 #define EECONFIG_DEBUG                              (uint8_t *)2
  30 #define EECONFIG_DEFAULT_LAYER                      (uint8_t *)3
  31 #define EECONFIG_KEYMAP                             (uint8_t *)4
  32 #define EECONFIG_MOUSEKEY_ACCEL                     (uint8_t *)5
  33 #define EECONFIG_BACKLIGHT                          (uint8_t *)6
  34 #define EECONFIG_AUDIO                              (uint8_t *)7
  35
  36
  37 /* debug bit */
  38 #define EECONFIG_DEBUG_ENABLE                       (1<<0)
  39 #define EECONFIG_DEBUG_MATRIX                       (1<<1)
  40 #define EECONFIG_DEBUG_KEYBOARD                     (1<<2)
  41 #define EECONFIG_DEBUG_MOUSE                        (1<<3)
  42
  43 /* keyconf bit */
  44 #define EECONFIG_KEYMAP_SWAP_CONTROL_CAPSLOCK       (1<<0)
  45 #define EECONFIG_KEYMAP_CAPSLOCK_TO_CONTROL         (1<<1)
  46 #define EECONFIG_KEYMAP_SWAP_LALT_LGUI              (1<<2)
  47 #define EECONFIG_KEYMAP_SWAP_RALT_RGUI              (1<<3)
  48 #define EECONFIG_KEYMAP_NO_GUI                      (1<<4)
  49 #define EECONFIG_KEYMAP_SWAP_GRAVE_ESC              (1<<5)
  50 #define EECONFIG_KEYMAP_SWAP_BACKSLASH_BACKSPACE    (1<<6)
  51 #define EECONFIG_KEYMAP_NKRO                        (1<<7)
  52
  53
  54 bool eeconfig_is_enabled(void);
  55
  56 void eeconfig_init(void);
  57
  58 void eeconfig_enable(void);
  59
  60 void eeconfig_disable(void);
  61
  62 uint8_t eeconfig_read_debug(void);
  63 void eeconfig_write_debug(uint8_t val);
  64
  65 uint8_t eeconfig_read_default_layer(void);
  66 void eeconfig_write_default_layer(uint8_t val);
  67
  68 uint8_t eeconfig_read_keymap(void);
  69 void eeconfig_write_keymap(uint8_t val);
  70
  71 #ifdef BACKLIGHT_ENABLE
  72 uint8_t eeconfig_read_backlight(void);
  73 void eeconfig_write_backlight(uint8_t val);
  74 #endif
  75
  76 #ifdef AUDIO_ENABLE
  77 uint8_t eeconfig_read_audio(void);
  78 void eeconfig_write_audio(uint8_t val);
  79 #endif
  80
  81 #endif