summaryrefslogtreecommitdiffstats
path: root/tmk_core/common/eeconfig.h
blob: 8d4e1d4d00832af1816fd7a48fb0808f56812684 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/*
Copyright 2013 Jun Wako <wakojun@gmail.com>

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/>.
*/

#ifndef EECONFIG_H
#define EECONFIG_H

#include <stdint.h>
#include <stdbool.h>


#define EECONFIG_MAGIC_NUMBER                       (uint16_t)0xFEED
#define EECONFIG_MAGIC_NUMBER_OFF                   (uint16_t)0xFFFF

/* eeprom parameteter address */
#if !defined(STM32_EEPROM_ENABLE)
#define EECONFIG_MAGIC                              (uint16_t *)0
#define EECONFIG_DEBUG                               (uint8_t *)2
#define EECONFIG_DEFAULT_LAYER                       (uint8_t *)3
#define EECONFIG_KEYMAP                              (uint8_t *)4
#define EECONFIG_MOUSEKEY_ACCEL                      (uint8_t *)5
#define EECONFIG_BACKLIGHT                           (uint8_t *)6
#define EECONFIG_AUDIO                               (uint8_t *)7
#define EECONFIG_RGBLIGHT                           (uint32_t *)8
#define EECONFIG_UNICODEMODE                        (uint8_t *)12
#define EECONFIG_STENOMODE                          (uint8_t *)13
// EEHANDS for two handed boards
#define EECONFIG_HANDEDNESS         			        	(uint8_t *)14
#define EECONFIG_KEYBOARD                          (uint32_t *)15
#define EECONFIG_USER                              (uint32_t *)19

#else
/* STM32F3 uses 16byte block. Reconfigure memory map */
#define EECONFIG_MAGIC                              (uint16_t *)0
#define EECONFIG_DEBUG                               (uint8_t *)1
#define EECONFIG_DEFAULT_LAYER                       (uint8_t *)2
#define EECONFIG_KEYMAP                              (uint8_t *)3
#define EECONFIG_MOUSEKEY_ACCEL                      (uint8_t *)4
#define EECONFIG_BACKLIGHT                           (uint8_t *)5
#define EECONFIG_AUDIO                               (uint8_t *)6
#define EECONFIG_RGBLIGHT                           (uint32_t *)7
#define EECONFIG_UNICODEMODE                         (uint8_t *)9
#define EECONFIG_STENOMODE                          (uint8_t *)10
// EEHANDS for two handed boards
#define EECONFIG_HANDEDNESS                     		(uint8_t *)11
#define EECONFIG_KEYBOARD                          (uint32_t *)12
#define EECONFIG_USER                              (uint32_t *)14
#endif

/* debug bit */
#define EECONFIG_DEBUG_ENABLE                       (1<<0)
#define EECONFIG_DEBUG_MATRIX                       (1<<1)
#define EECONFIG_DEBUG_KEYBOARD                     (1<<2)
#define EECONFIG_DEBUG_MOUSE                        (1<<3)

/* keyconf bit */
#define EECONFIG_KEYMAP_SWAP_CONTROL_CAPSLOCK       (1<<0)
#define EECONFIG_KEYMAP_CAPSLOCK_TO_CONTROL         (1<<1)
#define EECONFIG_KEYMAP_SWAP_LALT_LGUI              (1<<2)
#define EECONFIG_KEYMAP_SWAP_RALT_RGUI              (1<<3)
#define EECONFIG_KEYMAP_NO_GUI                      (1<<4)
#define EECONFIG_KEYMAP_SWAP_GRAVE_ESC              (1<<5)
#define EECONFIG_KEYMAP_SWAP_BACKSLASH_BACKSPACE    (1<<6)
#define EECONFIG_KEYMAP_NKRO                        (1<<7)


bool eeconfig_is_enabled(void);
bool eeconfig_is_disabled(void);

void eeconfig_init(void);
void eeconfig_init_quantum(void);
void eeconfig_init_kb(void);
void eeconfig_init_user(void);

void eeconfig_enable(void);

void eeconfig_disable(void);

uint8_t eeconfig_read_debug(void);
void eeconfig_update_debug(uint8_t val);

uint8_t eeconfig_read_default_layer(void);
void eeconfig_update_default_layer(uint8_t val);

uint8_t eeconfig_read_keymap(void);
void eeconfig_update_keymap(uint8_t val);

#ifdef BACKLIGHT_ENABLE
uint8_t eeconfig_read_backlight(void);
void eeconfig_update_backlight(uint8_t val);
#endif

#ifdef AUDIO_ENABLE
uint8_t eeconfig_read_audio(void);
void eeconfig_update_audio(uint8_t val);
#endif

uint32_t eeconfig_read_kb(void);
void eeconfig_update_kb(uint32_t val);
uint32_t eeconfig_read_user(void);
void eeconfig_update_user(uint32_t val);

#endif