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
  23 #ifndef EECONFIG_IS_ENABLED
  24 #define EECONFIG_IS_ENABLED()       true
  25 #endif
  26
  27 #define EECONFIG_MAGIC_NUMBER                   (uint16_t)0xFEED
  28
  29 /* eeprom parameteter address */
  30 #define EECONFIG_MAGIC                          (uint16_t *)0
  31 #define EECONFIG_DEBUG                          (uint8_t *)2
  32 #define EECONFIG_DEFAULT_LAYER                  (uint8_t *)3
  33 #define EECONFIG_KEYCONF                        (uint8_t *)4
  34 #define EECONFIG_MOUSEKEY_ACCEL                 (uint8_t *)5
  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_KEYCONF_SWAP_CONTROL_CAPSLOCK     (1<<0)
  45 #define EECONFIG_KEYCONF_CAPSLOCK_TO_CONTROL       (1<<1)
  46 #define EECONFIG_KEYCONF_SWAP_LALT_LGUI            (1<<2)
  47 #define EECONFIG_KEYCONF_SWAP_RALT_RGUI            (1<<3)
  48 #define EECONFIG_KEYCONF_NO_GUI                    (1<<4)
  49 #define EECONFIG_KEYCONF_SWAP_GRAVE_ESC            (1<<5)
  50 #define EECONFIG_KEYCONF_SWAP_BACKSLASH_BACKSPACE  (1<<6)
  51
  52
  53 /* XXX: Not portable. Bit field order depends on implementation */
  54 typedef union {
  55     uint8_t raw;
  56     struct {
  57         bool swap_control_capslock:1;
  58         bool capslock_to_control:1;
  59         bool swap_lalt_lgui:1;
  60         bool swap_ralt_rgui:1;
  61         bool no_gui:1;
  62         bool swap_grave_esc:1;
  63         bool swap_backslash_backspace:1;
  64         bool reserved:1;
  65     };
  66 } keyconf;
  67
  68 bool eeconfig_is_enabled(void);
  69
  70 void eeconfig_init(void);
  71
  72 void eeconfig_enable(void);
  73
  74 void eeconfig_disable(void);
  75
  76 uint8_t eeconfig_read_debug(void);
  77 void eeconfig_write_debug(uint8_t val);
  78
  79 uint8_t eeconfig_read_defalt_layer(void);
  80 void eeconfig_write_defalt_layer(uint8_t val);
  81
  82 uint8_t eeconfig_read_keyconf(void);
  83 void eeconfig_write_keyconf(uint8_t val);
  84
  85 #endif