logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

charybdis.c (14565B)

    

  1. /*
  2.  * Copyright 2020 Christopher Courtney <drashna@live.com> (@drashna)
  3.  * Copyright 2021 Quentin LEBASTARD <qlebastard@gmail.com>
  4.  * Copyright 2021 Charly Delay <charly@codesink.dev> (@0xcharly)
  5.  *
  6.  * This program is free software: you can redistribute it and/or modify
  7.  * it under the terms of the GNU General Publicw License as published by
  8.  * the Free Software Foundation, either version 2 of the License, or
  9.  * (at your option) any later version.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  */
  20. #include "charybdis.h"
  21. #include "transactions.h"
  22. #include <string.h>
  24. #ifdef CONSOLE_ENABLE
  25. #    include "print.h"
  26. #endif // CONSOLE_ENABLE
  28. #ifdef POINTING_DEVICE_ENABLE
  29. #    ifndef CHARYBDIS_MINIMUM_DEFAULT_DPI
  30. #        define CHARYBDIS_MINIMUM_DEFAULT_DPI 400
  31. #    endif // CHARYBDIS_MINIMUM_DEFAULT_DPI
  33. #    ifndef CHARYBDIS_DEFAULT_DPI_CONFIG_STEP
  34. #        define CHARYBDIS_DEFAULT_DPI_CONFIG_STEP 200
  35. #    endif // CHARYBDIS_DEFAULT_DPI_CONFIG_STEP
  37. #    ifndef CHARYBDIS_MINIMUM_SNIPING_DPI
  38. #        define CHARYBDIS_MINIMUM_SNIPING_DPI 200
  39. #    endif // CHARYBDIS_MINIMUM_SNIPER_MODE_DPI
  41. #    ifndef CHARYBDIS_SNIPING_DPI_CONFIG_STEP
  42. #        define CHARYBDIS_SNIPING_DPI_CONFIG_STEP 100
  43. #    endif // CHARYBDIS_SNIPING_DPI_CONFIG_STEP
  45. // Fixed DPI for drag-scroll.
  46. #    ifndef CHARYBDIS_DRAGSCROLL_DPI
  47. #        define CHARYBDIS_DRAGSCROLL_DPI 100
  48. #    endif // CHARYBDIS_DRAGSCROLL_DPI
  50. #    ifndef CHARYBDIS_DRAGSCROLL_BUFFER_SIZE
  51. #        define CHARYBDIS_DRAGSCROLL_BUFFER_SIZE 6
  52. #    endif // !CHARYBDIS_DRAGSCROLL_BUFFER_SIZE
  54. typedef union {
  55.     uint8_t raw;
  56.     struct {
  57.         uint8_t pointer_default_dpi : 4; // 16 steps available.
  58.         uint8_t pointer_sniping_dpi : 2; // 4 steps available.
  59.         bool    is_dragscroll_enabled : 1;
  60.         bool    is_sniping_enabled : 1;
  61.     } __attribute__((packed));
  62. } charybdis_config_t;
  64. static charybdis_config_t g_charybdis_config = {0};
  66. /**
  67.  * \brief Set the value of `config` from EEPROM.
  68.  *
  69.  * Note that `is_dragscroll_enabled` and `is_sniping_enabled` are purposefully
  70.  * ignored since we do not want to persist this state to memory.  In practice,
  71.  * this state is always written to maximize write-performances.  Therefore, we
  72.  * explicitly set them to `false` in this function.
  73.  */
  74. static void read_charybdis_config_from_eeprom(charybdis_config_t* config) {
  75.     config->raw                   = eeconfig_read_kb() & 0xff;
  76.     config->is_dragscroll_enabled = false;
  77.     config->is_sniping_enabled    = false;
  78. }
  80. /**
  81.  * \brief Save the value of `config` to eeprom.
  82.  *
  83.  * Note that all values are written verbatim, including whether drag-scroll
  84.  * and/or sniper mode are enabled.  `read_charybdis_config_from_eeprom(…)`
  85.  * resets these 2 values to `false` since it does not make sense to persist
  86.  * these across reboots of the board.
  87.  */
  88. static void write_charybdis_config_to_eeprom(charybdis_config_t* config) {
  89.     eeconfig_update_kb(config->raw);
  90. }
  92. /** \brief Return the current value of the pointer's default DPI. */
  93. static uint16_t get_pointer_default_dpi(charybdis_config_t* config) {
  94.     return (uint16_t)config->pointer_default_dpi * CHARYBDIS_DEFAULT_DPI_CONFIG_STEP + CHARYBDIS_MINIMUM_DEFAULT_DPI;
  95. }
  97. /** \brief Return the current value of the pointer's sniper-mode DPI. */
  98. static uint16_t get_pointer_sniping_dpi(charybdis_config_t* config) {
  99.     return (uint16_t)config->pointer_sniping_dpi * CHARYBDIS_SNIPING_DPI_CONFIG_STEP + CHARYBDIS_MINIMUM_SNIPING_DPI;
  100. }
  102. /** \brief Set the appropriate DPI for the input config. */
  103. static void maybe_update_pointing_device_cpi(charybdis_config_t* config) {
  104.     if (config->is_dragscroll_enabled) {
  105.         pointing_device_set_cpi(CHARYBDIS_DRAGSCROLL_DPI);
  106.     } else if (config->is_sniping_enabled) {
  107.         pointing_device_set_cpi(get_pointer_sniping_dpi(config));
  108.     } else {
  109.         pointing_device_set_cpi(get_pointer_default_dpi(config));
  110.     }
  111. }
  113. /**
  114.  * \brief Update the pointer's default DPI to the next or previous step.
  115.  *
  116.  * Increases the DPI value if `forward` is `true`, decreases it otherwise.
  117.  * The increment/decrement steps are equal to CHARYBDIS_DEFAULT_DPI_CONFIG_STEP.
  118.  */
  119. static void step_pointer_default_dpi(charybdis_config_t* config, bool forward) {
  120.     config->pointer_default_dpi += forward ? 1 : -1;
  121.     maybe_update_pointing_device_cpi(config);
  122. }
  124. /**
  125.  * \brief Update the pointer's sniper-mode DPI to the next or previous step.
  126.  *
  127.  * Increases the DPI value if `forward` is `true`, decreases it otherwise.
  128.  * The increment/decrement steps are equal to CHARYBDIS_SNIPING_DPI_CONFIG_STEP.
  129.  */
  130. static void step_pointer_sniping_dpi(charybdis_config_t* config, bool forward) {
  131.     config->pointer_sniping_dpi += forward ? 1 : -1;
  132.     maybe_update_pointing_device_cpi(config);
  133. }
  135. uint16_t charybdis_get_pointer_default_dpi(void) {
  136.     return get_pointer_default_dpi(&g_charybdis_config);
  137. }
  139. uint16_t charybdis_get_pointer_sniping_dpi(void) {
  140.     return get_pointer_sniping_dpi(&g_charybdis_config);
  141. }
  143. void charybdis_cycle_pointer_default_dpi_noeeprom(bool forward) {
  144.     step_pointer_default_dpi(&g_charybdis_config, forward);
  145. }
  147. void charybdis_cycle_pointer_default_dpi(bool forward) {
  148.     step_pointer_default_dpi(&g_charybdis_config, forward);
  149.     write_charybdis_config_to_eeprom(&g_charybdis_config);
  150. }
  152. void charybdis_cycle_pointer_sniping_dpi_noeeprom(bool forward) {
  153.     step_pointer_sniping_dpi(&g_charybdis_config, forward);
  154. }
  156. void charybdis_cycle_pointer_sniping_dpi(bool forward) {
  157.     step_pointer_sniping_dpi(&g_charybdis_config, forward);
  158.     write_charybdis_config_to_eeprom(&g_charybdis_config);
  159. }
  161. bool charybdis_get_pointer_sniping_enabled(void) {
  162.     return g_charybdis_config.is_sniping_enabled;
  163. }
  165. void charybdis_set_pointer_sniping_enabled(bool enable) {
  166.     g_charybdis_config.is_sniping_enabled = enable;
  167.     maybe_update_pointing_device_cpi(&g_charybdis_config);
  168. }
  170. bool charybdis_get_pointer_dragscroll_enabled(void) {
  171.     return g_charybdis_config.is_dragscroll_enabled;
  172. }
  174. void charybdis_set_pointer_dragscroll_enabled(bool enable) {
  175.     g_charybdis_config.is_dragscroll_enabled = enable;
  176.     maybe_update_pointing_device_cpi(&g_charybdis_config);
  177. }
  179. /**
  180.  * \brief Augment the pointing device behavior.
  181.  *
  182.  * Implement drag-scroll.
  183.  */
  184. static void pointing_device_task_charybdis(report_mouse_t* mouse_report) {
  185.     static int16_t scroll_buffer_x = 0;
  186.     static int16_t scroll_buffer_y = 0;
  187.     if (g_charybdis_config.is_dragscroll_enabled) {
  188. #    ifdef CHARYBDIS_DRAGSCROLL_REVERSE_X
  189.         scroll_buffer_x -= mouse_report->x;
  190. #    else
  191.         scroll_buffer_x += mouse_report->x;
  192. #    endif // CHARYBDIS_DRAGSCROLL_REVERSE_X
  193. #    ifdef CHARYBDIS_DRAGSCROLL_REVERSE_Y
  194.         scroll_buffer_y -= mouse_report->y;
  195. #    else
  196.         scroll_buffer_y += mouse_report->y;
  197. #    endif // CHARYBDIS_DRAGSCROLL_REVERSE_Y
  198.         mouse_report->x = 0;
  199.         mouse_report->y = 0;
  200.         if (abs(scroll_buffer_x) > CHARYBDIS_DRAGSCROLL_BUFFER_SIZE) {
  201.             mouse_report->h = scroll_buffer_x > 0 ? 1 : -1;
  202.             scroll_buffer_x = 0;
  203.         }
  204.         if (abs(scroll_buffer_y) > CHARYBDIS_DRAGSCROLL_BUFFER_SIZE) {
  205.             mouse_report->v = scroll_buffer_y > 0 ? 1 : -1;
  206.             scroll_buffer_y = 0;
  207.         }
  208.     }
  209. }
  211. report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) {
  212.     if (is_keyboard_master()) {
  213.         pointing_device_task_charybdis(&mouse_report);
  214.         mouse_report = pointing_device_task_user(mouse_report);
  215.     }
  216.     return mouse_report;
  217. }
  219. #    if defined(POINTING_DEVICE_ENABLE) && !defined(NO_CHARYBDIS_KEYCODES)
  220. /** \brief Whether SHIFT mod is enabled. */
  221. static bool has_shift_mod(void) {
  222. #        ifdef NO_ACTION_ONESHOT
  223.     return mod_config(get_mods()) & MOD_MASK_SHIFT;
  224. #        else
  225.     return mod_config(get_mods() | get_oneshot_mods()) & MOD_MASK_SHIFT;
  226. #        endif // NO_ACTION_ONESHOT
  227. }
  228. #    endif // POINTING_DEVICE_ENABLE && !NO_CHARYBDIS_KEYCODES
  230. /**
  231.  * \brief Outputs the Charybdis configuration to console.
  232.  *
  233.  * Prints the in-memory configuration structure to console, for debugging.
  234.  * Includes:
  235.  *   - raw value
  236.  *   - drag-scroll: on/off
  237.  *   - sniping: on/off
  238.  *   - default DPI: internal table index/actual DPI
  239.  *   - sniping DPI: internal table index/actual DPI
  240.  */
  241. static void debug_charybdis_config_to_console(charybdis_config_t* config) {
  242. #    ifdef CONSOLE_ENABLE
  243.     dprintf("(charybdis) process_record_kb: config = {\n"
  244.             "\traw = 0x%X,\n"
  245.             "\t{\n"
  246.             "\t\tis_dragscroll_enabled=%u\n"
  247.             "\t\tis_sniping_enabled=%u\n"
  248.             "\t\tdefault_dpi=0x%X (%u)\n"
  249.             "\t\tsniping_dpi=0x%X (%u)\n"
  250.             "\t}\n"
  251.             "}\n",
  252.             config->raw, config->is_dragscroll_enabled, config->is_sniping_enabled, config->pointer_default_dpi, get_pointer_default_dpi(config), config->pointer_sniping_dpi, get_pointer_sniping_dpi(config));
  253. #    endif // CONSOLE_ENABLE
  254. }
  256. bool process_record_kb(uint16_t keycode, keyrecord_t* record) {
  257.     if (!process_record_user(keycode, record)) {
  258.         debug_charybdis_config_to_console(&g_charybdis_config);
  259.         return false;
  260.     }
  261. #    ifdef POINTING_DEVICE_ENABLE
  262. #        ifndef NO_CHARYBDIS_KEYCODES
  263.     switch (keycode) {
  264.         case POINTER_DEFAULT_DPI_FORWARD:
  265.             if (record->event.pressed) {
  266.                 // Step backward if shifted, forward otherwise.
  267.                 charybdis_cycle_pointer_default_dpi(/* forward= */ !has_shift_mod());
  268.             }
  269.             break;
  270.         case POINTER_DEFAULT_DPI_REVERSE:
  271.             if (record->event.pressed) {
  272.                 // Step forward if shifted, backward otherwise.
  273.                 charybdis_cycle_pointer_default_dpi(/* forward= */ has_shift_mod());
  274.             }
  275.             break;
  276.         case POINTER_SNIPING_DPI_FORWARD:
  277.             if (record->event.pressed) {
  278.                 // Step backward if shifted, forward otherwise.
  279.                 charybdis_cycle_pointer_sniping_dpi(/* forward= */ !has_shift_mod());
  280.             }
  281.             break;
  282.         case POINTER_SNIPING_DPI_REVERSE:
  283.             if (record->event.pressed) {
  284.                 // Step forward if shifted, backward otherwise.
  285.                 charybdis_cycle_pointer_sniping_dpi(/* forward= */ has_shift_mod());
  286.             }
  287.             break;
  288.         case SNIPING_MODE:
  289.             charybdis_set_pointer_sniping_enabled(record->event.pressed);
  290.             break;
  291.         case SNIPING_MODE_TOGGLE:
  292.             if (record->event.pressed) {
  293.                 charybdis_set_pointer_sniping_enabled(!charybdis_get_pointer_sniping_enabled());
  294.             }
  295.             break;
  296.         case DRAGSCROLL_MODE:
  297.             charybdis_set_pointer_dragscroll_enabled(record->event.pressed);
  298.             break;
  299.         case DRAGSCROLL_MODE_TOGGLE:
  300.             if (record->event.pressed) {
  301.                 charybdis_set_pointer_dragscroll_enabled(!charybdis_get_pointer_dragscroll_enabled());
  302.             }
  303.             break;
  304.     }
  305. #        endif // !NO_CHARYBDIS_KEYCODES
  306. #    endif     // POINTING_DEVICE_ENABLE
  307.     if (IS_QK_KB(keycode) || IS_MOUSEKEY(keycode)) {
  308.         debug_charybdis_config_to_console(&g_charybdis_config);
  309.     }
  310.     return true;
  311. }
  313. void eeconfig_init_kb(void) {
  314.     g_charybdis_config.raw = 0;
  315.     write_charybdis_config_to_eeprom(&g_charybdis_config);
  316.     maybe_update_pointing_device_cpi(&g_charybdis_config);
  317.     eeconfig_init_user();
  318. }
  320. void matrix_init_kb(void) {
  321.     read_charybdis_config_from_eeprom(&g_charybdis_config);
  322.     matrix_init_user();
  323. }
  325. #    ifdef CHARYBDIS_CONFIG_SYNC
  326. void charybdis_config_sync_handler(uint8_t initiator2target_buffer_size, const void* initiator2target_buffer, uint8_t target2initiator_buffer_size, void* target2initiator_buffer) {
  327.     if (initiator2target_buffer_size == sizeof(g_charybdis_config)) {
  328.         memcpy(&g_charybdis_config, initiator2target_buffer, sizeof(g_charybdis_config));
  329.     }
  330. }
  331. #    endif
  333. void keyboard_post_init_kb(void) {
  334.     maybe_update_pointing_device_cpi(&g_charybdis_config);
  335. #    ifdef CHARYBDIS_CONFIG_SYNC
  336.     transaction_register_rpc(RPC_ID_KB_CONFIG_SYNC, charybdis_config_sync_handler);
  337. #    endif
  338.     keyboard_post_init_user();
  339. }
  341. #    ifdef CHARYBDIS_CONFIG_SYNC
  342. void housekeeping_task_kb(void) {
  343.     if (is_keyboard_master()) {
  344.         // Keep track of the last state, so that we can tell if we need to propagate to slave.
  345.         static charybdis_config_t last_charybdis_config = {0};
  346.         static uint32_t           last_sync             = 0;
  347.         bool                      needs_sync            = false;
  349.         // Check if the state values are different.
  350.         if (memcmp(&g_charybdis_config, &last_charybdis_config, sizeof(g_charybdis_config))) {
  351.             needs_sync = true;
  352.             memcpy(&last_charybdis_config, &g_charybdis_config, sizeof(g_charybdis_config));
  353.         }
  354.         // Send to slave every 500ms regardless of state change.
  355.         if (timer_elapsed32(last_sync) > 500) {
  356.             needs_sync = true;
  357.         }
  359.         // Perform the sync if requested.
  360.         if (needs_sync) {
  361.             if (transaction_rpc_send(RPC_ID_KB_CONFIG_SYNC, sizeof(g_charybdis_config), &g_charybdis_config)) {
  362.                 last_sync = timer_read32();
  363.             }
  364.         }
  365.     }
  366.     // No need to invoke the user-specific callback, as it's been called
  367.     // already.
  368. }
  369. #    endif // CHARYBDIS_CONFIG_SYNC
  370. #endif     // POINTING_DEVICE_ENABLE
  372. #if defined(KEYBOARD_bastardkb_charybdis_3x5_blackpill) || defined(KEYBOARD_bastardkb_charybdis_4x6_blackpill)
  373. void keyboard_pre_init_kb(void) {
  374.     gpio_set_pin_input_high(A0);
  375.     keyboard_pre_init_user();
  376. }
  378. void matrix_scan_kb(void) {
  379.     if (!gpio_read_pin(A0)) {
  380.         reset_keyboard();
  381.     }
  382.     matrix_scan_user();
  383. }
  384. #endif // KEYBOARD_bastardkb_charybdis_3x5_blackpill || KEYBOARD_bastardkb_charybdis_4x6_blackpill
  386. bool shutdown_kb(bool jump_to_bootloader) {
  387.     if (!shutdown_user(jump_to_bootloader)) {
  388.         return false;
  389.     }
  390. #ifdef RGBLIGHT_ENABLE
  391.     rgblight_enable_noeeprom();
  392.     rgblight_mode_noeeprom(RGBLIGHT_MODE_STATIC_LIGHT);
  393.     rgblight_setrgb(RGB_RED);
  394. #endif // RGBLIGHT_ENABLE
  395. #ifdef RGB_MATRIX_ENABLE
  396.     rgb_matrix_set_color_all(RGB_RED);
  397.     rgb_matrix_update_pwm_buffers();
  398. #endif // RGB_MATRIX_ENABLE
  399.     return true;
  400. }