]> git.gir.st - tmk_keyboard.git/blob - common/command.c
Add eeconfig.c - eeprom stored paramerters
[tmk_keyboard.git] / common / command.c
1 /*
2 Copyright 2011 Jun Wako <wakojun@gmail.com>
3
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 2 of the License, or
7 (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17 #include <stdint.h>
18 #include <stdbool.h>
19 #include <util/delay.h>
20 #include "keycode.h"
21 #include "host.h"
22 #include "keymap.h"
23 #include "print.h"
24 #include "debug.h"
25 #include "util.h"
26 #include "timer.h"
27 #include "keyboard.h"
28 #include "bootloader.h"
29 #include "layer_switch.h"
30 #include "eeconfig.h"
31 #include "command.h"
32
33 #ifdef MOUSEKEY_ENABLE
34 #include "mousekey.h"
35 #endif
36
37 #ifdef HOST_PJRC
38 # include "usb_keyboard.h"
39 # ifdef EXTRAKEY_ENABLE
40 # include "usb_extra.h"
41 # endif
42 #endif
43
44 #ifdef HOST_VUSB
45 # include "usbdrv.h"
46 #endif
47
48
49 static bool command_common(uint8_t code);
50 static void command_common_help(void);
51 static bool command_console(uint8_t code);
52 static void command_console_help(void);
53 #ifdef MOUSEKEY_ENABLE
54 static bool mousekey_console(uint8_t code);
55 static void mousekey_console_help(void);
56 #endif
57
58 static uint8_t numkey2num(uint8_t code);
59 static void switch_default_layer(uint8_t layer);
60
61
62 typedef enum { ONESHOT, CONSOLE, MOUSEKEY } cmdstate_t;
63 static cmdstate_t state = ONESHOT;
64
65
66 bool command_proc(uint8_t code)
67 {
68 switch (state) {
69 case ONESHOT:
70 if (!IS_COMMAND())
71 return false;
72 return (command_extra(code) || command_common(code));
73 case CONSOLE:
74 command_console(code);
75 break;
76 #ifdef MOUSEKEY_ENABLE
77 case MOUSEKEY:
78 mousekey_console(code);
79 break;
80 #endif
81 default:
82 state = ONESHOT;
83 return false;
84 }
85 return true;
86 }
87
88 /* This allows to define extra commands. return false when not processed. */
89 bool command_extra(uint8_t code) __attribute__ ((weak));
90 bool command_extra(uint8_t code)
91 {
92 return false;
93 }
94
95
96 /***********************************************************
97 * Command common
98 ***********************************************************/
99 static void command_common_help(void)
100 {
101 print_enable = true;
102 print("\n\n----- Command Help -----\n");
103 print("c: enter console mode\n");
104 print("d: toggle debug enable\n");
105 print("x: toggle matrix debug\n");
106 print("k: toggle keyboard debug\n");
107 print("m: toggle mouse debug\n");
108 print("p: toggle print enable\n");
109 print("v: print device version & info\n");
110 print("t: print timer count\n");
111 print("s: print status\n");
112 print("e: print eeprom config\n");
113 #ifdef NKRO_ENABLE
114 print("n: toggle NKRO\n");
115 #endif
116 print("0/F10: switch to Layer0 \n");
117 print("1/F1: switch to Layer1 \n");
118 print("2/F2: switch to Layer2 \n");
119 print("3/F3: switch to Layer3 \n");
120 print("4/F4: switch to Layer4 \n");
121 print("PScr: power down/remote wake-up\n");
122 print("Caps: Lock Keyboard(Child Proof)\n");
123 print("Paus: jump to bootloader\n");
124 }
125
126 static void print_eeprom_config(void)
127 {
128 uint8_t eebyte;
129
130 print("magic: "); print_hex16(eeprom_read_word((uint16_t)0)); print("\n");
131
132 eebyte = eeconfig_read_debug();
133 print("debug: "); print_hex8(eebyte); print("\n");
134
135 eebyte = eeconfig_read_defalt_layer();
136 print("defalt_layer: "); print_hex8(eebyte); print("\n");
137
138 eebyte = eeconfig_read_modifier();
139 print("modifiers: "); print_hex8(eebyte); print("\n");
140 }
141
142 static bool command_common(uint8_t code)
143 {
144 static host_driver_t *host_driver = 0;
145 switch (code) {
146 case KC_E:
147 print("eeprom config\n");
148 print_eeprom_config();
149 break;
150 case KC_CAPSLOCK:
151 if (host_get_driver()) {
152 host_driver = host_get_driver();
153 host_set_driver(0);
154 print("Locked.\n");
155 } else {
156 host_set_driver(host_driver);
157 print("Unlocked.\n");
158 }
159 break;
160 case KC_H:
161 case KC_SLASH: /* ? */
162 command_common_help();
163 break;
164 case KC_C:
165 print_enable = true;
166 debug_matrix = false;
167 debug_keyboard = false;
168 debug_mouse = false;
169 debug_enable = false;
170 command_console_help();
171 print("\nEnter Console Mode\n");
172 print("C> ");
173 state = CONSOLE;
174 break;
175 case KC_PAUSE:
176 clear_keyboard();
177 print("\n\nJump to bootloader... ");
178 _delay_ms(1000);
179 bootloader_jump(); // not return
180 print("not supported.\n");
181 break;
182 case KC_D:
183 if (debug_enable) {
184 print("\nDEBUG: disabled.\n");
185 debug_matrix = false;
186 debug_keyboard = false;
187 debug_mouse = false;
188 debug_enable = false;
189 } else {
190 print("\nDEBUG: enabled.\n");
191 debug_enable = true;
192 }
193 break;
194 case KC_X: // debug matrix toggle
195 debug_matrix = !debug_matrix;
196 if (debug_matrix) {
197 print("\nDEBUG: matrix enabled.\n");
198 debug_enable = true;
199 } else {
200 print("\nDEBUG: matrix disabled.\n");
201 }
202 break;
203 case KC_K: // debug keyboard toggle
204 debug_keyboard = !debug_keyboard;
205 if (debug_keyboard) {
206 print("\nDEBUG: keyboard enabled.\n");
207 debug_enable = true;
208 } else {
209 print("\nDEBUG: keyboard disabled.\n");
210 }
211 break;
212 case KC_M: // debug mouse toggle
213 debug_mouse = !debug_mouse;
214 if (debug_mouse) {
215 print("\nDEBUG: mouse enabled.\n");
216 debug_enable = true;
217 } else {
218 print("\nDEBUG: mouse disabled.\n");
219 }
220 break;
221 case KC_V: // print version & information
222 print("\n\n----- Version -----\n");
223 print(STR(DESCRIPTION) "\n");
224 print(STR(MANUFACTURER) "(" STR(VENDOR_ID) ")/");
225 print(STR(PRODUCT) "(" STR(PRODUCT_ID) ") ");
226 print("VERSION: " STR(DEVICE_VER) "\n");
227 break;
228 case KC_T: // print timer
229 print_val_hex32(timer_count);
230 break;
231 case KC_P: // print toggle
232 if (print_enable) {
233 print("print disabled.\n");
234 print_enable = false;
235 } else {
236 print_enable = true;
237 print("print enabled.\n");
238 }
239 break;
240 case KC_S:
241 print("\n\n----- Status -----\n");
242 print_val_hex8(host_keyboard_leds());
243 #ifdef HOST_PJRC
244 print_val_hex8(UDCON);
245 print_val_hex8(UDIEN);
246 print_val_hex8(UDINT);
247 print_val_hex8(usb_keyboard_leds);
248 print_val_hex8(usb_keyboard_protocol);
249 print_val_hex8(usb_keyboard_idle_config);
250 print_val_hex8(usb_keyboard_idle_count);
251 #endif
252
253 #ifdef HOST_VUSB
254 # if USB_COUNT_SOF
255 print_val_hex8(usbSofCount);
256 # endif
257 #endif
258 break;
259 #ifdef NKRO_ENABLE
260 case KC_N:
261 clear_keyboard(); //Prevents stuck keys.
262 keyboard_nkro = !keyboard_nkro;
263 if (keyboard_nkro)
264 print("NKRO: enabled\n");
265 else
266 print("NKRO: disabled\n");
267 break;
268 #endif
269 #ifdef EXTRAKEY_ENABLE
270 case KC_PSCREEN:
271 // TODO: Power key should take this feature? otherwise any key during suspend.
272 #ifdef HOST_PJRC
273 if (suspend && remote_wakeup) {
274 usb_remote_wakeup();
275 } else {
276 host_system_send(SYSTEM_POWER_DOWN);
277 host_system_send(0);
278 _delay_ms(500);
279 }
280 #else
281 host_system_send(SYSTEM_POWER_DOWN);
282 _delay_ms(100);
283 host_system_send(0);
284 _delay_ms(500);
285 #endif
286 break;
287 #endif
288 case KC_ESC:
289 case KC_GRV:
290 case KC_0:
291 switch_default_layer(0);
292 break;
293 case KC_1 ... KC_9:
294 switch_default_layer((code - KC_1) + 1);
295 break;
296 case KC_F1 ... KC_F12:
297 switch_default_layer((code - KC_F1) + 1);
298 break;
299 default:
300 print("?");
301 return false;
302 }
303 return true;
304 }
305
306
307 /***********************************************************
308 * Command console
309 ***********************************************************/
310 static void command_console_help(void)
311 {
312 print_enable = true;
313 print("\n\n----- Console Help -----\n");
314 print("ESC/q: quit\n");
315 #ifdef MOUSEKEY_ENABLE
316 print("m: mousekey\n");
317 #endif
318 }
319
320 static bool command_console(uint8_t code)
321 {
322 switch (code) {
323 case KC_H:
324 case KC_SLASH: /* ? */
325 command_console_help();
326 break;
327 case KC_Q:
328 case KC_ESC:
329 print("\nQuit Console Mode\n");
330 state = ONESHOT;
331 return false;
332 #ifdef MOUSEKEY_ENABLE
333 case KC_M:
334 mousekey_console_help();
335 print("\nEnter Mousekey Console\n");
336 print("M0>");
337 state = MOUSEKEY;
338 return true;
339 #endif
340 default:
341 print("?");
342 return false;
343 }
344 print("C> ");
345 return true;
346 }
347
348
349 #ifdef MOUSEKEY_ENABLE
350 /***********************************************************
351 * Mousekey console
352 ***********************************************************/
353 static uint8_t mousekey_param = 0;
354
355 static void mousekey_param_print(void)
356 {
357 print("\n\n----- Mousekey Parameters -----\n");
358 print("1: mk_delay(*10ms): "); pdec(mk_delay); print("\n");
359 print("2: mk_interval(ms): "); pdec(mk_interval); print("\n");
360 print("3: mk_max_speed: "); pdec(mk_max_speed); print("\n");
361 print("4: mk_time_to_max: "); pdec(mk_time_to_max); print("\n");
362 print("5: mk_wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
363 print("6: mk_wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
364 }
365
366 #define PRINT_SET_VAL(v) print(#v " = "); print_dec(v); print("\n");
367 static void mousekey_param_inc(uint8_t param, uint8_t inc)
368 {
369 switch (param) {
370 case 1:
371 if (mk_delay + inc < UINT8_MAX)
372 mk_delay += inc;
373 else
374 mk_delay = UINT8_MAX;
375 PRINT_SET_VAL(mk_delay);
376 break;
377 case 2:
378 if (mk_interval + inc < UINT8_MAX)
379 mk_interval += inc;
380 else
381 mk_interval = UINT8_MAX;
382 PRINT_SET_VAL(mk_interval);
383 break;
384 case 3:
385 if (mk_max_speed + inc < UINT8_MAX)
386 mk_max_speed += inc;
387 else
388 mk_max_speed = UINT8_MAX;
389 PRINT_SET_VAL(mk_max_speed);
390 break;
391 case 4:
392 if (mk_time_to_max + inc < UINT8_MAX)
393 mk_time_to_max += inc;
394 else
395 mk_time_to_max = UINT8_MAX;
396 PRINT_SET_VAL(mk_time_to_max);
397 break;
398 case 5:
399 if (mk_wheel_max_speed + inc < UINT8_MAX)
400 mk_wheel_max_speed += inc;
401 else
402 mk_wheel_max_speed = UINT8_MAX;
403 PRINT_SET_VAL(mk_wheel_max_speed);
404 break;
405 case 6:
406 if (mk_wheel_time_to_max + inc < UINT8_MAX)
407 mk_wheel_time_to_max += inc;
408 else
409 mk_wheel_time_to_max = UINT8_MAX;
410 PRINT_SET_VAL(mk_wheel_time_to_max);
411 break;
412 }
413 }
414
415 static void mousekey_param_dec(uint8_t param, uint8_t dec)
416 {
417 switch (param) {
418 case 1:
419 if (mk_delay > dec)
420 mk_delay -= dec;
421 else
422 mk_delay = 0;
423 PRINT_SET_VAL(mk_delay);
424 break;
425 case 2:
426 if (mk_interval > dec)
427 mk_interval -= dec;
428 else
429 mk_interval = 0;
430 PRINT_SET_VAL(mk_interval);
431 break;
432 case 3:
433 if (mk_max_speed > dec)
434 mk_max_speed -= dec;
435 else
436 mk_max_speed = 0;
437 PRINT_SET_VAL(mk_max_speed);
438 break;
439 case 4:
440 if (mk_time_to_max > dec)
441 mk_time_to_max -= dec;
442 else
443 mk_time_to_max = 0;
444 PRINT_SET_VAL(mk_time_to_max);
445 break;
446 case 5:
447 if (mk_wheel_max_speed > dec)
448 mk_wheel_max_speed -= dec;
449 else
450 mk_wheel_max_speed = 0;
451 PRINT_SET_VAL(mk_wheel_max_speed);
452 break;
453 case 6:
454 if (mk_wheel_time_to_max > dec)
455 mk_wheel_time_to_max -= dec;
456 else
457 mk_wheel_time_to_max = 0;
458 PRINT_SET_VAL(mk_wheel_time_to_max);
459 break;
460 }
461 }
462
463 static void mousekey_console_help(void)
464 {
465 print("\n\n----- Mousekey Parameters Help -----\n");
466 print("ESC/q: quit\n");
467 print("1: select mk_delay(*10ms)\n");
468 print("2: select mk_interval(ms)\n");
469 print("3: select mk_max_speed\n");
470 print("4: select mk_time_to_max\n");
471 print("5: select mk_wheel_max_speed\n");
472 print("6: select mk_wheel_time_to_max\n");
473 print("p: print prameters\n");
474 print("d: set default values\n");
475 print("up: increase prameters(+1)\n");
476 print("down: decrease prameters(-1)\n");
477 print("pgup: increase prameters(+10)\n");
478 print("pgdown: decrease prameters(-10)\n");
479 print("\nspeed = delta * max_speed * (repeat / time_to_max)\n");
480 print("where delta: cursor="); pdec(MOUSEKEY_MOVE_DELTA);
481 print(", wheel="); pdec(MOUSEKEY_WHEEL_DELTA); print("\n");
482 print("See http://en.wikipedia.org/wiki/Mouse_keys\n");
483 }
484
485 static bool mousekey_console(uint8_t code)
486 {
487 switch (code) {
488 case KC_H:
489 case KC_SLASH: /* ? */
490 mousekey_console_help();
491 break;
492 case KC_Q:
493 case KC_ESC:
494 mousekey_param = 0;
495 print("\nQuit Mousekey Console\n");
496 print("C> ");
497 state = CONSOLE;
498 return false;
499 case KC_P:
500 mousekey_param_print();
501 break;
502 case KC_1:
503 case KC_2:
504 case KC_3:
505 case KC_4:
506 case KC_5:
507 case KC_6:
508 case KC_7:
509 case KC_8:
510 case KC_9:
511 case KC_0:
512 mousekey_param = numkey2num(code);
513 print("selected parameter: "); pdec(mousekey_param); print("\n");
514 break;
515 case KC_UP:
516 mousekey_param_inc(mousekey_param, 1);
517 break;
518 case KC_DOWN:
519 mousekey_param_dec(mousekey_param, 1);
520 break;
521 case KC_PGUP:
522 mousekey_param_inc(mousekey_param, 10);
523 break;
524 case KC_PGDN:
525 mousekey_param_dec(mousekey_param, 10);
526 break;
527 case KC_D:
528 mk_delay = MOUSEKEY_DELAY/10;
529 mk_interval = MOUSEKEY_INTERVAL;
530 mk_max_speed = MOUSEKEY_MAX_SPEED;
531 mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
532 mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
533 mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
534 print("set default values.\n");
535 break;
536 default:
537 print("?");
538 return false;
539 }
540 print("M"); pdec(mousekey_param); print("> ");
541 return true;
542 }
543 #endif
544
545
546 /***********************************************************
547 * Utilities
548 ***********************************************************/
549 static uint8_t numkey2num(uint8_t code)
550 {
551 switch (code) {
552 case KC_1: return 1;
553 case KC_2: return 2;
554 case KC_3: return 3;
555 case KC_4: return 4;
556 case KC_5: return 5;
557 case KC_6: return 6;
558 case KC_7: return 7;
559 case KC_8: return 8;
560 case KC_9: return 9;
561 case KC_0: return 0;
562 }
563 return 0;
564 }
565
566 static void switch_default_layer(uint8_t layer)
567 {
568 print("switch_default_layer: "); print_dec(default_layer); print(" to "); print_dec(layer); print("\n");
569 default_layer_set(layer);
570 overlay_clear();
571 clear_keyboard();
572 }
Imprint / Impressum