1 /* Copyright 2017 Jason Williams (Wilba)
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.
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.
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/>.
17 #include "zeal60_api.h"
19 // Check that no backlight functions are called
20 #if RGB_BACKLIGHT_ENABLED
21 #include "rgb_backlight.h"
22 #endif // BACKLIGHT_ENABLED
25 #include "dynamic_keymap.h"
27 #include "tmk_core/common/eeprom.h"
29 bool eeprom_is_valid(void)
31 return (eeprom_read_word(((void*)EEPROM_MAGIC_ADDR)) == EEPROM_MAGIC &&
32 eeprom_read_byte(((void*)EEPROM_VERSION_ADDR)) == EEPROM_VERSION);
35 void eeprom_set_valid(bool valid)
37 eeprom_update_word(((void*)EEPROM_MAGIC_ADDR), valid ? EEPROM_MAGIC : 0xFFFF);
38 eeprom_update_byte(((void*)EEPROM_VERSION_ADDR), valid ? EEPROM_VERSION : 0xFF);
43 void raw_hid_receive( uint8_t *data, uint8_t length )
45 uint8_t *command_id = &(data[0]);
46 uint8_t *command_data = &(data[1]);
47 switch ( *command_id )
49 case id_get_protocol_version:
51 command_data[0] = PROTOCOL_VERSION >> 8;
52 command_data[1] = PROTOCOL_VERSION & 0xFF;
55 case id_get_keyboard_value:
57 if ( command_data[0] == 0x01 )
59 uint32_t value = timer_read32();
60 command_data[1] = (value >> 24 ) & 0xFF;
61 command_data[2] = (value >> 16 ) & 0xFF;
62 command_data[3] = (value >> 8 ) & 0xFF;
63 command_data[4] = value & 0xFF;
67 *command_id = id_unhandled;
71 #ifdef DYNAMIC_KEYMAP_ENABLE
72 case id_dynamic_keymap_get_keycode:
74 uint16_t keycode = dynamic_keymap_get_keycode( command_data[0], command_data[1], command_data[2] );
75 command_data[3] = keycode >> 8;
76 command_data[4] = keycode & 0xFF;
79 case id_dynamic_keymap_set_keycode:
81 dynamic_keymap_set_keycode( command_data[0], command_data[1], command_data[2], ( command_data[3] << 8 ) | command_data[4] );
84 case id_dynamic_keymap_clear_all:
86 dynamic_keymap_clear_all();
89 #endif // DYNAMIC_KEYMAP_ENABLE
90 #if RGB_BACKLIGHT_ENABLED
91 case id_backlight_config_set_value:
93 backlight_config_set_value(command_data);
96 case id_backlight_config_get_value:
98 backlight_config_get_value(command_data);
101 case id_backlight_config_save:
103 backlight_config_save();
106 #endif // RGB_BACKLIGHT_ENABLED
109 // Unhandled message.
110 *command_id = id_unhandled;
115 // Return same buffer with values changed
116 raw_hid_send( data, length );
122 void bootmagic_lite(void)
124 // The lite version of TMK's bootmagic.
125 // 100% less potential for accidentally making the
126 // keyboard do stupid things.
128 // We need multiple scans because debouncing can't be turned off.
130 wait_ms(DEBOUNCING_DELAY);
131 wait_ms(DEBOUNCING_DELAY);
134 // If the Esc and space bar are held down on power up,
135 // reset the EEPROM valid state and jump to bootloader.
136 // Assumes Esc is at [0,0] and spacebar is at [4,7].
137 // This isn't very generalized, but we need something that doesn't
138 // rely on user's keymaps in firmware or EEPROM.
139 if ( ( matrix_get_row(0) & (1<<0) ) &&
140 ( matrix_get_row(4) & (1<<7) ) )
142 // Set the Zeal60 specific EEPROM state as invalid.
143 eeprom_set_valid(false);
144 // Set the TMK/QMK EEPROM state as invalid.
146 // Jump to bootloader.
151 void matrix_init_kb(void)
155 // If the EEPROM has the magic, the data is good.
156 // OK to load from EEPROM.
157 if (eeprom_is_valid())
159 #if RGB_BACKLIGHT_ENABLED
160 backlight_config_load();
161 #endif // RGB_BACKLIGHT_ENABLED
162 // TODO: do something to "turn on" keymaps in EEPROM?
166 #if RGB_BACKLIGHT_ENABLED
167 // If the EEPROM has not been saved before, or is out of date,
168 // save the default values to the EEPROM. Default values
169 // come from construction of the zeal_backlight_config instance.
170 backlight_config_save();
171 #endif // RGB_BACKLIGHT_ENABLED
173 #ifdef DYNAMIC_KEYMAP_ENABLE
174 // This saves "empty" keymaps so it falls back to the keymaps
175 // in the firmware (aka. progmem/flash)
176 dynamic_keymap_clear_all();
179 // Save the magic number last, in case saving was interrupted
180 eeprom_set_valid(true);
183 #if RGB_BACKLIGHT_ENABLED
184 // Initialize LED drivers for backlight.
185 backlight_init_drivers();
187 backlight_timer_init();
188 backlight_timer_enable();
189 #endif // RGB_BACKLIGHT_ENABLED
194 void matrix_scan_kb(void)
196 #if RGB_BACKLIGHT_ENABLED
197 // This only updates the LED driver buffers if something has changed.
198 backlight_update_pwm_buffers();
199 #endif // BACKLIGHT_ENABLED
203 bool process_record_kb(uint16_t keycode, keyrecord_t *record)
205 #if RGB_BACKLIGHT_ENABLED
206 process_record_backlight(keycode, record);
207 #endif // BACKLIGHT_ENABLED
212 if (record->event.pressed)
215 update_tri_layer(1, 2, 3);
220 update_tri_layer(1, 2, 3);
225 if (record->event.pressed)
228 update_tri_layer(1, 2, 3);
233 update_tri_layer(1, 2, 3);
239 return process_record_user(keycode, record);
242 // This overrides the one in quantum/keymap_common.c
243 uint16_t keymap_function_id_to_action( uint16_t function_id )
245 // Zeal60 specific "action functions" are 0xF00 to 0xFFF
246 // i.e. F(0xF00) to F(0xFFF) are mapped to
247 // enum zeal60_action_functions by masking last 8 bits.
248 if ( function_id >= 0x0F00 && function_id <= 0x0FFF )
250 uint8_t id = function_id & 0xFF;
256 return ACTION_FUNCTION_TAP(id);
264 #if USE_KEYMAPS_IN_EEPROM
267 // This is how to implement actions stored in EEPROM.
268 // Not yet implemented. Not sure if it's worth the trouble
269 // before we have a nice GUI for keymap editing.
270 if ( eeprom_is_valid() &&
271 function_id < 32 ) // TODO: replace magic number
273 uint16_t action = keymap_action_load(function_id);
275 // If action is not "empty", return it, otherwise
276 // drop down to return the one in flash
277 if ( action != 0x0000 ) // TODO: replace magic number
284 #endif // USE_KEYMAPS_IN_EEPROM
286 return pgm_read_word(&fn_actions[function_id]);
290 // Zeal60 specific "action functions"
291 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
297 if (record->event.pressed)
299 layer_on( id == TRIPLE_TAP_1_3 ? 1 : 2 );
301 if (record->tap.count && !record->tap.interrupted)
303 if (record->tap.count >= 3)
310 record->tap.count = 0;
315 layer_off( id == TRIPLE_TAP_1_3 ? 1 : 2 );
321 void led_set_kb(uint8_t usb_led)
323 #if RGB_BACKLIGHT_ENABLED
324 backlight_set_indicator_state(usb_led);
325 #endif // RGB_BACKLIGHT_ENABLED
328 void suspend_power_down_kb(void)
330 #if RGB_BACKLIGHT_ENABLED
331 backlight_set_suspend_state(true);
332 #endif // RGB_BACKLIGHT_ENABLED
335 void suspend_wakeup_init_kb(void)
337 #if RGB_BACKLIGHT_ENABLED
338 backlight_set_suspend_state(false);
339 #endif // RGB_BACKLIGHT_ENABLED