quantum/dynamic_keymap.c

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