dynamic_keymap.h (3538B)
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 #pragma once 17 18 #include <stdint.h> 19 #include <stdbool.h> 20 21 #ifndef DYNAMIC_KEYMAP_LAYER_COUNT 22 # define DYNAMIC_KEYMAP_LAYER_COUNT 4 23 #endif 24 25 #ifndef DYNAMIC_KEYMAP_MACRO_COUNT 26 # define DYNAMIC_KEYMAP_MACRO_COUNT 16 27 #endif 28 29 uint8_t dynamic_keymap_get_layer_count(void); 30 uint16_t dynamic_keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t column); 31 void dynamic_keymap_set_keycode(uint8_t layer, uint8_t row, uint8_t column, uint16_t keycode); 32 #ifdef ENCODER_MAP_ENABLE 33 uint16_t dynamic_keymap_get_encoder(uint8_t layer, uint8_t encoder_id, bool clockwise); 34 void dynamic_keymap_set_encoder(uint8_t layer, uint8_t encoder_id, bool clockwise, uint16_t keycode); 35 #endif // ENCODER_MAP_ENABLE 36 void dynamic_keymap_reset(void); 37 // These get/set the keycodes as stored in the EEPROM buffer 38 // Data is big-endian 16-bit values (the keycodes) 39 // Order is by layer/row/column 40 // Thus offset 0 = 0,0,0, offset MATRIX_COLS*2 = 0,1,0, offset MATRIX_ROWS*MATRIX_COLS*2 = 1,0,0 41 // Note the *2, because offset is in bytes and keycodes are two bytes 42 // This is only really useful for host applications that want to get a whole keymap fast, 43 // by reading 14 keycodes (28 bytes) at a time, reducing the number of raw HID transfers by 44 // a factor of 14. 45 void dynamic_keymap_get_buffer(uint16_t offset, uint16_t size, uint8_t *data); 46 void dynamic_keymap_set_buffer(uint16_t offset, uint16_t size, uint8_t *data); 47 48 // This overrides the one in quantum/keymap_common.c 49 // uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key); 50 51 // Note regarding dynamic_keymap_macro_set_buffer(): 52 // The last byte of the buffer is used as a valid flag, 53 // so macro sending is disabled during writing a new buffer, 54 // should it happen during, or after an interrupted transfer. 55 // 56 // Users writing to the buffer must first set the last byte of the buffer 57 // to non-zero (i.e. 0xFF). After (or during) the final write, set the 58 // last byte of the buffer to zero. 59 // 60 // Since the contents of the buffer must be a list of null terminated 61 // strings, the last byte must be a null when at maximum capacity, 62 // and it not being null means the buffer can be considered in an 63 // invalid state. 64 // 65 // The buffer *may* contain less macro strings than the maximum. 66 // This allows a higher maximum number of macros without requiring that 67 // number of nulls to be in the buffer. 68 // Note: dynamic_keymap_macro_get_count() returns the maximum that *can* be 69 // stored, not the current count of macros in the buffer. 70 71 uint8_t dynamic_keymap_macro_get_count(void); 72 uint16_t dynamic_keymap_macro_get_buffer_size(void); 73 void dynamic_keymap_macro_get_buffer(uint16_t offset, uint16_t size, uint8_t *data); 74 void dynamic_keymap_macro_set_buffer(uint16_t offset, uint16_t size, uint8_t *data); 75 void dynamic_keymap_macro_reset(void); 76 77 void dynamic_keymap_macro_send(uint8_t id);