eeconfig.h 3.4 KB

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