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
  20 #include "dynamic_keymap.h"
  21
  22 #ifdef DYNAMIC_KEYMAP_ENABLE
  23
  24 #ifndef DYNAMIC_KEYMAP_EEPROM_ADDR
  25 #error DYNAMIC_KEYMAP_EEPROM_ADDR not defined
  26 #endif
  27
  28 #ifndef DYNAMIC_KEYMAP_LAYER_COUNT
  29 #error DYNAMIC_KEYMAP_LAYER_COUNT not defined
  30 #endif
  31
  32 #define KC_EENULL 0xFFFF // TODO: move to enum quantum_keycodes
  33
  34 void *dynamic_keymap_key_to_eeprom_address(uint8_t layer, uint8_t row, uint8_t column)
  35 {
  36         // TODO: optimize this with some left shifts
  37         return ((void*)DYNAMIC_KEYMAP_EEPROM_ADDR) + ( layer * MATRIX_ROWS * MATRIX_COLS * 2 ) +
  38                 ( row * MATRIX_COLS * 2 ) + ( column * 2 );
  39 }
  40
  41 uint16_t dynamic_keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t column)
  42 {
  43         void *address = dynamic_keymap_key_to_eeprom_address(layer, row, column);
  44         // Big endian, so we can read/write EEPROM directly from host if we want
  45         uint16_t keycode = eeprom_read_byte(address) << 8;
  46         keycode |= eeprom_read_byte(address + 1);
  47         return keycode;
  48 }
  49
  50 void dynamic_keymap_set_keycode(uint8_t layer, uint8_t row, uint8_t column, uint16_t keycode)
  51 {
  52         void *address = dynamic_keymap_key_to_eeprom_address(layer, row, column);
  53         // Big endian, so we can read/write EEPROM directly from host if we want
  54         eeprom_update_byte(address, (uint8_t)(keycode >> 8));
  55         eeprom_update_byte(address+1, (uint8_t)(keycode & 0xFF));
  56 }
  57
  58 void dynamic_keymap_clear_all(void)
  59 {
  60         // Save "empty" keymaps.
  61         for ( int layer = 0; layer < DYNAMIC_KEYMAP_LAYER_COUNT; layer++ )
  62         {
  63                 for ( int row = 0; row < MATRIX_ROWS; row++ )
  64                 {
  65                         for ( int column = 0; column < MATRIX_COLS; column++ )
  66                         {
  67                                 dynamic_keymap_set_keycode(layer, row, column, KC_EENULL);
  68                         }
  69                 }
  70         }
  71 }
  72
  73 // This overrides the one in quantum/keymap_common.c
  74 uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key)
  75 {
  76         // This used to test EEPROM for magic bytes, but it was redundant.
  77         // Test for EEPROM usage change (fresh install, address change, etc.)
  78         // externally and call dynamic_keymap_default_save()
  79         if ( layer < DYNAMIC_KEYMAP_LAYER_COUNT &&
  80                  key.row < MATRIX_ROWS && // possibly redundant
  81                  key.col < MATRIX_COLS ) // possibly redundant
  82         {
  83                 uint16_t keycode = dynamic_keymap_get_keycode(layer, key.row, key.col);
  84
  85                 // If keycode is not "empty", return it, otherwise
  86                 // drop down to return the one in flash
  87                 if ( keycode != KC_EENULL)
  88                 {
  89                         return keycode;
  90                 }
  91         }
  92
  93         return pgm_read_word(&keymaps[layer][key.row][key.col]);
  94 }
  95
  96 #endif // DYNAMIC_KEYMAP_ENABLE
  97