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);
41 void eeprom_reset(void)
43 // Set the Zeal60 specific EEPROM state as invalid.
44 eeprom_set_valid(false);
45 // Set the TMK/QMK EEPROM state as invalid.
51 void raw_hid_receive( uint8_t *data, uint8_t length )
53 uint8_t *command_id = &(data[0]);
54 uint8_t *command_data = &(data[1]);
55 switch ( *command_id )
57 case id_get_protocol_version:
59 command_data[0] = PROTOCOL_VERSION >> 8;
60 command_data[1] = PROTOCOL_VERSION & 0xFF;
63 case id_get_keyboard_value:
65 if ( command_data[0] == id_uptime )
67 uint32_t value = timer_read32();
68 command_data[1] = (value >> 24 ) & 0xFF;
69 command_data[2] = (value >> 16 ) & 0xFF;
70 command_data[3] = (value >> 8 ) & 0xFF;
71 command_data[4] = value & 0xFF;
75 *command_id = id_unhandled;
79 #ifdef DYNAMIC_KEYMAP_ENABLE
80 case id_dynamic_keymap_get_keycode:
82 uint16_t keycode = dynamic_keymap_get_keycode( command_data[0], command_data[1], command_data[2] );
83 command_data[3] = keycode >> 8;
84 command_data[4] = keycode & 0xFF;
87 case id_dynamic_keymap_set_keycode:
89 dynamic_keymap_set_keycode( command_data[0], command_data[1], command_data[2], ( command_data[3] << 8 ) | command_data[4] );
92 case id_dynamic_keymap_reset:
94 dynamic_keymap_reset();
97 case id_dynamic_keymap_macro_get_count:
99 command_data[0] = dynamic_keymap_macro_get_count();
102 case id_dynamic_keymap_macro_get_buffer_size:
104 uint16_t size = dynamic_keymap_macro_get_buffer_size();
105 command_data[0] = size >> 8;
106 command_data[1] = size & 0xFF;
109 case id_dynamic_keymap_macro_get_buffer:
111 uint16_t offset = ( command_data[0] << 8 ) | command_data[1];
112 uint16_t size = command_data[2]; // size <= 28
113 dynamic_keymap_macro_get_buffer( offset, size, &command_data[3] );
116 case id_dynamic_keymap_macro_set_buffer:
118 uint16_t offset = ( command_data[0] << 8 ) | command_data[1];
119 uint16_t size = command_data[2]; // size <= 28
120 dynamic_keymap_macro_set_buffer( offset, size, &command_data[3] );
123 case id_dynamic_keymap_macro_reset:
125 dynamic_keymap_macro_reset();
128 case id_dynamic_keymap_get_layer_count:
130 command_data[0] = dynamic_keymap_get_layer_count();
133 case id_dynamic_keymap_get_buffer:
135 uint16_t offset = ( command_data[0] << 8 ) | command_data[1];
136 uint16_t size = command_data[2]; // size <= 28
137 dynamic_keymap_get_buffer( offset, size, &command_data[3] );
140 case id_dynamic_keymap_set_buffer:
142 uint16_t offset = ( command_data[0] << 8 ) | command_data[1];
143 uint16_t size = command_data[2]; // size <= 28
144 dynamic_keymap_set_buffer( offset, size, &command_data[3] );
147 #endif // DYNAMIC_KEYMAP_ENABLE
148 #if RGB_BACKLIGHT_ENABLED
149 case id_backlight_config_set_value:
151 backlight_config_set_value(command_data);
154 case id_backlight_config_get_value:
156 backlight_config_get_value(command_data);
159 case id_backlight_config_save:
161 backlight_config_save();
164 #endif // RGB_BACKLIGHT_ENABLED
165 case id_eeprom_reset:
170 case id_bootloader_jump:
172 // Need to send data back before the jump
173 // Informs host that the command is handled
174 raw_hid_send( data, length );
175 // Give host time to read it
182 // Unhandled message.
183 *command_id = id_unhandled;
188 // Return same buffer with values changed
189 raw_hid_send( data, length );
197 // If the EEPROM has the magic, the data is good.
198 // OK to load from EEPROM.
199 if (eeprom_is_valid()) {
200 #if RGB_BACKLIGHT_ENABLED
201 backlight_config_load();
202 #endif // RGB_BACKLIGHT_ENABLED
204 #if RGB_BACKLIGHT_ENABLED
205 // If the EEPROM has not been saved before, or is out of date,
206 // save the default values to the EEPROM. Default values
207 // come from construction of the zeal_backlight_config instance.
208 backlight_config_save();
209 #endif // RGB_BACKLIGHT_ENABLED
210 #ifdef DYNAMIC_KEYMAP_ENABLE
211 // This resets the keymaps in EEPROM to what is in flash.
212 dynamic_keymap_reset();
213 // This resets the macros in EEPROM to nothing.
214 dynamic_keymap_macro_reset();
216 // Save the magic number last, in case saving was interrupted
217 eeprom_set_valid(true);
220 #if RGB_BACKLIGHT_ENABLED
221 // Initialize LED drivers for backlight.
222 backlight_init_drivers();
224 backlight_timer_init();
225 backlight_timer_enable();
226 #endif // RGB_BACKLIGHT_ENABLED
229 void bootmagic_lite(void)
231 // The lite version of TMK's bootmagic.
232 // 100% less potential for accidentally making the
233 // keyboard do stupid things.
235 // We need multiple scans because debouncing can't be turned off.
241 // If the Esc (matrix 0,0) is held down on power up,
242 // reset the EEPROM valid state and jump to bootloader.
243 if ( matrix_get_row(0) & (1<<0) ) {
249 void matrix_init_kb(void)
256 void matrix_scan_kb(void)
258 #if RGB_BACKLIGHT_ENABLED
259 // This only updates the LED driver buffers if something has changed.
260 backlight_update_pwm_buffers();
261 #endif // BACKLIGHT_ENABLED
265 bool process_record_kb(uint16_t keycode, keyrecord_t *record)
267 #if RGB_BACKLIGHT_ENABLED
268 process_record_backlight(keycode, record);
269 #endif // BACKLIGHT_ENABLED
273 if (record->event.pressed) {
275 update_tri_layer(1, 2, 3);
278 update_tri_layer(1, 2, 3);
283 if (record->event.pressed) {
285 update_tri_layer(1, 2, 3);
288 update_tri_layer(1, 2, 3);
294 #ifdef DYNAMIC_KEYMAP_ENABLE
296 if (record->event.pressed) {
297 if ( keycode >= MACRO00 && keycode <= MACRO15 )
299 uint8_t id = keycode - MACRO00;
300 dynamic_keymap_macro_send(id);
304 #endif //DYNAMIC_KEYMAP_ENABLE
306 return process_record_user(keycode, record);
309 // This overrides the one in quantum/keymap_common.c
310 uint16_t keymap_function_id_to_action( uint16_t function_id )
312 // Zeal60 specific "action functions" are 0xF00 to 0xFFF
313 // i.e. F(0xF00) to F(0xFFF) are mapped to
314 // enum zeal60_action_functions by masking last 8 bits.
315 if ( function_id >= 0x0F00 && function_id <= 0x0FFF )
317 uint8_t id = function_id & 0xFF;
322 return ACTION_FUNCTION_TAP(id);
330 return pgm_read_word(&fn_actions[function_id]);
334 // Zeal60 specific "action functions"
335 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
341 if (record->event.pressed) {
342 layer_on( id == TRIPLE_TAP_1_3 ? 1 : 2 );
343 if (record->tap.count && !record->tap.interrupted) {
344 if (record->tap.count >= 3) {
348 record->tap.count = 0;
351 layer_off( id == TRIPLE_TAP_1_3 ? 1 : 2 );
357 void led_set_kb(uint8_t usb_led)
359 #if RGB_BACKLIGHT_ENABLED
360 backlight_set_indicator_state(usb_led);
361 #endif // RGB_BACKLIGHT_ENABLED
364 void suspend_power_down_kb(void)
366 #if RGB_BACKLIGHT_ENABLED
367 backlight_set_suspend_state(true);
368 #endif // RGB_BACKLIGHT_ENABLED
371 void suspend_wakeup_init_kb(void)
373 #if RGB_BACKLIGHT_ENABLED
374 backlight_set_suspend_state(false);
375 #endif // RGB_BACKLIGHT_ENABLED