1 /* Copyright 2017 Jason Williams (Wilba)
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.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #include "keymap.h" // to get keymaps[][][]
19 #include "tmk_core/common/eeprom.h"
20 #include "progmem.h" // to read default from flash
21 #include "quantum.h" // for send_string()
22 #include "dynamic_keymap.h"
23 #include "via.h" // for default VIA_EEPROM_ADDR_END
25 #ifndef DYNAMIC_KEYMAP_LAYER_COUNT
26 # define DYNAMIC_KEYMAP_LAYER_COUNT 4
29 #ifndef DYNAMIC_KEYMAP_MACRO_COUNT
30 # define DYNAMIC_KEYMAP_MACRO_COUNT 16
33 // This is the default EEPROM max address to use for dynamic keymaps.
34 // The default is the ATmega32u4 EEPROM max address.
35 // Explicitly override it if the keyboard uses a microcontroller with
36 // more EEPROM *and* it makes sense to increase it.
37 #ifndef DYNAMIC_KEYMAP_EEPROM_MAX_ADDR
38 # define DYNAMIC_KEYMAP_EEPROM_MAX_ADDR 1023
41 // If DYNAMIC_KEYMAP_EEPROM_ADDR not explicitly defined in config.h,
42 // default it start after VIA_EEPROM_CUSTOM_ADDR+VIA_EEPROM_CUSTOM_SIZE
43 #ifndef DYNAMIC_KEYMAP_EEPROM_ADDR
44 # ifdef VIA_EEPROM_CUSTOM_CONFIG_ADDR
45 # define DYNAMIC_KEYMAP_EEPROM_ADDR (VIA_EEPROM_CUSTOM_CONFIG_ADDR + VIA_EEPROM_CUSTOM_CONFIG_SIZE)
47 # error DYNAMIC_KEYMAP_EEPROM_ADDR not defined
51 // Dynamic macro starts after dynamic keymaps
52 #ifndef DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR
53 # define DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR (DYNAMIC_KEYMAP_EEPROM_ADDR + (DYNAMIC_KEYMAP_LAYER_COUNT * MATRIX_ROWS * MATRIX_COLS * 2))
56 // Sanity check that dynamic keymaps fit in available EEPROM
57 // If there's not 100 bytes available for macros, then something is wrong.
58 // The keyboard should override DYNAMIC_KEYMAP_LAYER_COUNT to reduce it,
59 // or DYNAMIC_KEYMAP_EEPROM_MAX_ADDR to increase it, *only if* the microcontroller has
60 // more than the default.
61 #if DYNAMIC_KEYMAP_EEPROM_MAX_ADDR - DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR < 100
62 # error Dynamic keymaps are configured to use more EEPROM than is available.
65 // Dynamic macros are stored after the keymaps and use what is available
66 // up to and including DYNAMIC_KEYMAP_EEPROM_MAX_ADDR.
67 #ifndef DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE
68 # define DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE (DYNAMIC_KEYMAP_EEPROM_MAX_ADDR - DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR + 1)
71 uint8_t dynamic_keymap_get_layer_count(void) { return DYNAMIC_KEYMAP_LAYER_COUNT
; }
73 void *dynamic_keymap_key_to_eeprom_address(uint8_t layer
, uint8_t row
, uint8_t column
) {
74 // TODO: optimize this with some left shifts
75 return ((void *)DYNAMIC_KEYMAP_EEPROM_ADDR
) + (layer
* MATRIX_ROWS
* MATRIX_COLS
* 2) + (row
* MATRIX_COLS
* 2) + (column
* 2);
78 uint16_t dynamic_keymap_get_keycode(uint8_t layer
, uint8_t row
, uint8_t column
) {
79 void *address
= dynamic_keymap_key_to_eeprom_address(layer
, row
, column
);
80 // Big endian, so we can read/write EEPROM directly from host if we want
81 uint16_t keycode
= eeprom_read_byte(address
) << 8;
82 keycode
|= eeprom_read_byte(address
+ 1);
86 void dynamic_keymap_set_keycode(uint8_t layer
, uint8_t row
, uint8_t column
, uint16_t keycode
) {
87 void *address
= dynamic_keymap_key_to_eeprom_address(layer
, row
, column
);
88 // Big endian, so we can read/write EEPROM directly from host if we want
89 eeprom_update_byte(address
, (uint8_t)(keycode
>> 8));
90 eeprom_update_byte(address
+ 1, (uint8_t)(keycode
& 0xFF));
93 void dynamic_keymap_reset(void) {
94 // Reset the keymaps in EEPROM to what is in flash.
95 // All keyboards using dynamic keymaps should define a layout
96 // for the same number of layers as DYNAMIC_KEYMAP_LAYER_COUNT.
97 for (int layer
= 0; layer
< DYNAMIC_KEYMAP_LAYER_COUNT
; layer
++) {
98 for (int row
= 0; row
< MATRIX_ROWS
; row
++) {
99 for (int column
= 0; column
< MATRIX_COLS
; column
++) {
100 dynamic_keymap_set_keycode(layer
, row
, column
, pgm_read_word(&keymaps
[layer
][row
][column
]));
106 void dynamic_keymap_get_buffer(uint16_t offset
, uint16_t size
, uint8_t *data
) {
107 uint16_t dynamic_keymap_eeprom_size
= DYNAMIC_KEYMAP_LAYER_COUNT
* MATRIX_ROWS
* MATRIX_COLS
* 2;
108 void * source
= (void *)(DYNAMIC_KEYMAP_EEPROM_ADDR
+ offset
);
109 uint8_t *target
= data
;
110 for (uint16_t i
= 0; i
< size
; i
++) {
111 if (offset
+ i
< dynamic_keymap_eeprom_size
) {
112 *target
= eeprom_read_byte(source
);
121 void dynamic_keymap_set_buffer(uint16_t offset
, uint16_t size
, uint8_t *data
) {
122 uint16_t dynamic_keymap_eeprom_size
= DYNAMIC_KEYMAP_LAYER_COUNT
* MATRIX_ROWS
* MATRIX_COLS
* 2;
123 void * target
= (void *)(DYNAMIC_KEYMAP_EEPROM_ADDR
+ offset
);
124 uint8_t *source
= data
;
125 for (uint16_t i
= 0; i
< size
; i
++) {
126 if (offset
+ i
< dynamic_keymap_eeprom_size
) {
127 eeprom_update_byte(target
, *source
);
134 // This overrides the one in quantum/keymap_common.c
135 uint16_t keymap_key_to_keycode(uint8_t layer
, keypos_t key
) {
136 if (layer
< DYNAMIC_KEYMAP_LAYER_COUNT
&& key
.row
< MATRIX_ROWS
&& key
.col
< MATRIX_COLS
) {
137 return dynamic_keymap_get_keycode(layer
, key
.row
, key
.col
);
143 uint8_t dynamic_keymap_macro_get_count(void) { return DYNAMIC_KEYMAP_MACRO_COUNT
; }
145 uint16_t dynamic_keymap_macro_get_buffer_size(void) { return DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE
; }
147 void dynamic_keymap_macro_get_buffer(uint16_t offset
, uint16_t size
, uint8_t *data
) {
148 void * source
= (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR
+ offset
);
149 uint8_t *target
= data
;
150 for (uint16_t i
= 0; i
< size
; i
++) {
151 if (offset
+ i
< DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE
) {
152 *target
= eeprom_read_byte(source
);
161 void dynamic_keymap_macro_set_buffer(uint16_t offset
, uint16_t size
, uint8_t *data
) {
162 void * target
= (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR
+ offset
);
163 uint8_t *source
= data
;
164 for (uint16_t i
= 0; i
< size
; i
++) {
165 if (offset
+ i
< DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE
) {
166 eeprom_update_byte(target
, *source
);
173 void dynamic_keymap_macro_reset(void) {
174 void *p
= (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR
);
175 void *end
= (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR
+ DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE
);
177 eeprom_update_byte(p
, 0);
182 void dynamic_keymap_macro_send(uint8_t id
) {
183 if (id
>= DYNAMIC_KEYMAP_MACRO_COUNT
) {
187 // Check the last byte of the buffer.
188 // If it's not zero, then we are in the middle
189 // of buffer writing, possibly an aborted buffer
190 // write. So do nothing.
191 void *p
= (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR
+ DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE
- 1);
192 if (eeprom_read_byte(p
) != 0) {
196 // Skip N null characters
197 // p will then point to the Nth macro
198 p
= (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR
);
199 void *end
= (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR
+ DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE
);
201 // If we are past the end of the buffer, then the buffer
202 // contents are garbage, i.e. there were not DYNAMIC_KEYMAP_MACRO_COUNT
203 // nulls in the buffer.
207 if (eeprom_read_byte(p
) == 0) {
213 // Send the macro string one or three chars at a time
214 // by making temporary 1 or 3 char strings
215 char data
[4] = {0, 0, 0, 0};
216 // We already checked there was a null at the end of
217 // the buffer, so this cannot go past the end
219 data
[0] = eeprom_read_byte(p
++);
221 // Stop at the null terminator of this macro string
225 // If the char is magic (tap, down, up),
226 // add the next char (key to use) and send a 3 char string.
227 if (data
[0] == SS_TAP_CODE
|| data
[0] == SS_DOWN_CODE
|| data
[0] == SS_UP_CODE
) {
229 data
[0] = SS_QMK_PREFIX
;
230 data
[2] = eeprom_read_byte(p
++);