dynamic_keymap.h 3.4 KB

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