dynamic_keymap.h

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