Commit | Line | Data |
---|---|---|
48a992f1 W |
1 | /* Copyright 2017 Jason Williams (Wilba) |
2 | * | |
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 | * | |
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. | |
12 | * | |
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/>. | |
15 | */ | |
16 | ||
17 | #include "config.h" | |
b624f32f | 18 | #include "keymap.h" // to get keymaps[][][] |
a173eda6 | 19 | #include "tmk_core/common/eeprom.h" |
b624f32f | 20 | #include "progmem.h" // to read default from flash |
21 | #include "quantum.h" // for send_string() | |
48a992f1 | 22 | #include "dynamic_keymap.h" |
667045b4 | 23 | #include "via.h" // for default VIA_EEPROM_ADDR_END |
320822d7 W |
24 | |
25 | #ifndef DYNAMIC_KEYMAP_LAYER_COUNT | |
667045b4 | 26 | # define DYNAMIC_KEYMAP_LAYER_COUNT 4 |
320822d7 W |
27 | #endif |
28 | ||
29 | #ifndef DYNAMIC_KEYMAP_MACRO_COUNT | |
667045b4 | 30 | # define DYNAMIC_KEYMAP_MACRO_COUNT 16 |
320822d7 W |
31 | #endif |
32 | ||
33 | // If DYNAMIC_KEYMAP_EEPROM_ADDR not explicitly defined in config.h, | |
34 | // default it start after VIA_EEPROM_CUSTOM_ADDR+VIA_EEPROM_CUSTOM_SIZE | |
35 | #ifndef DYNAMIC_KEYMAP_EEPROM_ADDR | |
667045b4 JC |
36 | # ifdef VIA_EEPROM_CUSTOM_CONFIG_ADDR |
37 | # define DYNAMIC_KEYMAP_EEPROM_ADDR (VIA_EEPROM_CUSTOM_CONFIG_ADDR + VIA_EEPROM_CUSTOM_CONFIG_SIZE) | |
38 | # else | |
39 | # error DYNAMIC_KEYMAP_EEPROM_ADDR not defined | |
40 | # endif | |
320822d7 W |
41 | #endif |
42 | ||
43 | // Dynamic macro starts after dynamic keymaps | |
44 | #ifndef DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR | |
667045b4 | 45 | # define DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR (DYNAMIC_KEYMAP_EEPROM_ADDR + (DYNAMIC_KEYMAP_LAYER_COUNT * MATRIX_ROWS * MATRIX_COLS * 2)) |
320822d7 W |
46 | #endif |
47 | ||
48 | // Dynamic macro uses up all remaining memory | |
49 | // Assumes 1K EEPROM on ATMega32U4 | |
50 | // Override for anything different | |
51 | #ifndef DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE | |
667045b4 | 52 | # define DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE (1024 - DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR) |
320822d7 | 53 | #endif |
d7f1e072 | 54 | |
b624f32f | 55 | uint8_t dynamic_keymap_get_layer_count(void) { return DYNAMIC_KEYMAP_LAYER_COUNT; } |
d7f1e072 | 56 | |
b624f32f | 57 | void *dynamic_keymap_key_to_eeprom_address(uint8_t layer, uint8_t row, uint8_t column) { |
58 | // TODO: optimize this with some left shifts | |
59 | return ((void *)DYNAMIC_KEYMAP_EEPROM_ADDR) + (layer * MATRIX_ROWS * MATRIX_COLS * 2) + (row * MATRIX_COLS * 2) + (column * 2); | |
48a992f1 W |
60 | } |
61 | ||
b624f32f | 62 | uint16_t dynamic_keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t column) { |
63 | void *address = dynamic_keymap_key_to_eeprom_address(layer, row, column); | |
64 | // Big endian, so we can read/write EEPROM directly from host if we want | |
65 | uint16_t keycode = eeprom_read_byte(address) << 8; | |
66 | keycode |= eeprom_read_byte(address + 1); | |
67 | return keycode; | |
48a992f1 W |
68 | } |
69 | ||
b624f32f | 70 | void dynamic_keymap_set_keycode(uint8_t layer, uint8_t row, uint8_t column, uint16_t keycode) { |
71 | void *address = dynamic_keymap_key_to_eeprom_address(layer, row, column); | |
72 | // Big endian, so we can read/write EEPROM directly from host if we want | |
73 | eeprom_update_byte(address, (uint8_t)(keycode >> 8)); | |
74 | eeprom_update_byte(address + 1, (uint8_t)(keycode & 0xFF)); | |
48a992f1 W |
75 | } |
76 | ||
b624f32f | 77 | void dynamic_keymap_reset(void) { |
78 | // Reset the keymaps in EEPROM to what is in flash. | |
79 | // All keyboards using dynamic keymaps should define a layout | |
80 | // for the same number of layers as DYNAMIC_KEYMAP_LAYER_COUNT. | |
81 | for (int layer = 0; layer < DYNAMIC_KEYMAP_LAYER_COUNT; layer++) { | |
82 | for (int row = 0; row < MATRIX_ROWS; row++) { | |
83 | for (int column = 0; column < MATRIX_COLS; column++) { | |
84 | dynamic_keymap_set_keycode(layer, row, column, pgm_read_word(&keymaps[layer][row][column])); | |
85 | } | |
86 | } | |
87 | } | |
48a992f1 W |
88 | } |
89 | ||
b624f32f | 90 | void dynamic_keymap_get_buffer(uint16_t offset, uint16_t size, uint8_t *data) { |
91 | uint16_t dynamic_keymap_eeprom_size = DYNAMIC_KEYMAP_LAYER_COUNT * MATRIX_ROWS * MATRIX_COLS * 2; | |
92 | void * source = (void *)(DYNAMIC_KEYMAP_EEPROM_ADDR + offset); | |
93 | uint8_t *target = data; | |
94 | for (uint16_t i = 0; i < size; i++) { | |
95 | if (offset + i < dynamic_keymap_eeprom_size) { | |
96 | *target = eeprom_read_byte(source); | |
97 | } else { | |
98 | *target = 0x00; | |
99 | } | |
100 | source++; | |
101 | target++; | |
102 | } | |
d7f1e072 W |
103 | } |
104 | ||
b624f32f | 105 | void dynamic_keymap_set_buffer(uint16_t offset, uint16_t size, uint8_t *data) { |
106 | uint16_t dynamic_keymap_eeprom_size = DYNAMIC_KEYMAP_LAYER_COUNT * MATRIX_ROWS * MATRIX_COLS * 2; | |
107 | void * target = (void *)(DYNAMIC_KEYMAP_EEPROM_ADDR + offset); | |
108 | uint8_t *source = data; | |
109 | for (uint16_t i = 0; i < size; i++) { | |
110 | if (offset + i < dynamic_keymap_eeprom_size) { | |
111 | eeprom_update_byte(target, *source); | |
112 | } | |
113 | source++; | |
114 | target++; | |
115 | } | |
d7f1e072 W |
116 | } |
117 | ||
48a992f1 | 118 | // This overrides the one in quantum/keymap_common.c |
b624f32f | 119 | uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key) { |
120 | if (layer < DYNAMIC_KEYMAP_LAYER_COUNT && key.row < MATRIX_ROWS && key.col < MATRIX_COLS) { | |
121 | return dynamic_keymap_get_keycode(layer, key.row, key.col); | |
122 | } else { | |
123 | return KC_NO; | |
124 | } | |
d7f1e072 W |
125 | } |
126 | ||
b624f32f | 127 | uint8_t dynamic_keymap_macro_get_count(void) { return DYNAMIC_KEYMAP_MACRO_COUNT; } |
128 | ||
129 | uint16_t dynamic_keymap_macro_get_buffer_size(void) { return DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE; } | |
130 | ||
131 | void dynamic_keymap_macro_get_buffer(uint16_t offset, uint16_t size, uint8_t *data) { | |
132 | void * source = (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR + offset); | |
133 | uint8_t *target = data; | |
134 | for (uint16_t i = 0; i < size; i++) { | |
135 | if (offset + i < DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE) { | |
136 | *target = eeprom_read_byte(source); | |
137 | } else { | |
138 | *target = 0x00; | |
139 | } | |
140 | source++; | |
141 | target++; | |
142 | } | |
d7f1e072 W |
143 | } |
144 | ||
b624f32f | 145 | void dynamic_keymap_macro_set_buffer(uint16_t offset, uint16_t size, uint8_t *data) { |
146 | void * target = (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR + offset); | |
147 | uint8_t *source = data; | |
148 | for (uint16_t i = 0; i < size; i++) { | |
149 | if (offset + i < DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE) { | |
150 | eeprom_update_byte(target, *source); | |
151 | } | |
152 | source++; | |
153 | target++; | |
154 | } | |
d7f1e072 W |
155 | } |
156 | ||
b624f32f | 157 | void dynamic_keymap_macro_reset(void) { |
158 | void *p = (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR); | |
159 | void *end = (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR + DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE); | |
160 | while (p != end) { | |
161 | eeprom_update_byte(p, 0); | |
162 | ++p; | |
163 | } | |
d7f1e072 W |
164 | } |
165 | ||
b624f32f | 166 | void dynamic_keymap_macro_send(uint8_t id) { |
167 | if (id >= DYNAMIC_KEYMAP_MACRO_COUNT) { | |
168 | return; | |
169 | } | |
170 | ||
171 | // Check the last byte of the buffer. | |
172 | // If it's not zero, then we are in the middle | |
173 | // of buffer writing, possibly an aborted buffer | |
174 | // write. So do nothing. | |
175 | void *p = (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR + DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE - 1); | |
176 | if (eeprom_read_byte(p) != 0) { | |
177 | return; | |
178 | } | |
179 | ||
180 | // Skip N null characters | |
181 | // p will then point to the Nth macro | |
182 | p = (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR); | |
183 | void *end = (void *)(DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR + DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE); | |
184 | while (id > 0) { | |
185 | // If we are past the end of the buffer, then the buffer | |
186 | // contents are garbage, i.e. there were not DYNAMIC_KEYMAP_MACRO_COUNT | |
187 | // nulls in the buffer. | |
188 | if (p == end) { | |
189 | return; | |
190 | } | |
191 | if (eeprom_read_byte(p) == 0) { | |
192 | --id; | |
193 | } | |
194 | ++p; | |
195 | } | |
196 | ||
197 | // Send the macro string one or two chars at a time | |
198 | // by making temporary 1 or 2 char strings | |
199 | char data[3] = {0, 0, 0}; | |
200 | // We already checked there was a null at the end of | |
201 | // the buffer, so this cannot go past the end | |
202 | while (1) { | |
203 | data[0] = eeprom_read_byte(p++); | |
204 | data[1] = 0; | |
205 | // Stop at the null terminator of this macro string | |
206 | if (data[0] == 0) { | |
207 | break; | |
208 | } | |
209 | // If the char is magic (tap, down, up), | |
210 | // add the next char (key to use) and send a 2 char string. | |
211 | if (data[0] == SS_TAP_CODE || data[0] == SS_DOWN_CODE || data[0] == SS_UP_CODE) { | |
212 | data[1] = eeprom_read_byte(p++); | |
213 | if (data[1] == 0) { | |
214 | break; | |
215 | } | |
216 | } | |
217 | send_string(data); | |
218 | } | |
d7f1e072 | 219 | } |