mirror of
https://github.com/zsa/qmk_firmware.git
synced 2026-04-28 02:18:59 +00:00
551d63b98f
* feat: tentative fix for keyboard crash during esd testing * feat: adds support for the GD32 voyager * feat: adds voyager's dfu suffix * fix: instability issues over i2c * fix: more robust right side scan * fix: tentative delay after init * Revert "fix: tentative delay after init" This reverts commitb0a6461cf1. * fix: scan left side in between right scan process * fix: resets matrix + layer state when reconnecting the right side * chore: comments and code cleanup * fix: restore previous control flow * fix: decouple led driver reinit from io expander reinit * feat: reinit led drivers independtly * fix: prevents slamming the led driver over i2c * Revert "fix: prevents slamming the led driver over i2c" This reverts commit48b8c809ea. * Revert "feat: reinit led drivers independtly" This reverts commit6405e6b367. * fix: reboot on io expander * fix: wait time after reading the io expander * chore: code cleanup and some refactors. * feat: adds led brightness and status led control over hid * fix: remove stray printf * fix: compilation error on ergodox * fix: gd32 eeprom fix * fix: caps lock crash * fix: soft reset to bootloader key. * chore: move the app address define where it should be * fix: cleanup + debounce default * feat: tentatively set gd32 clock to 98Mhz * feat: realign to latest chibios contrib * chore: points to ZSA's chibios contrib fork --------- Co-authored-by: Florian Didron <0x6664@hey.com>
100 lines
3.0 KiB
C
100 lines
3.0 KiB
C
#pragma once
|
|
/*
|
|
The Oryx Webhid protocol
|
|
|
|
Each HID packet is a series of bytes. The first byte is the packet type is the command. The rest of the bytes are the params.
|
|
|
|
Before sending a packet, the host needs to be paired or should request a pairing code.
|
|
|
|
The pairing code is a sequence of key positions derived from Oryx's firmware version code stored in the FIRMWARE_VERSION define.
|
|
|
|
Once the host has paired, it can freely use the commands define in the Oryx_Command_Code enum for which the board will always respond with a Oryx_Event_Code or a Oryx_Error_Code.
|
|
*/
|
|
|
|
#include "quantum.h"
|
|
#include "raw_hid.h"
|
|
|
|
#ifndef RAW_ENABLE
|
|
# error "Raw hid needs to be enabled, please enable it!"
|
|
#endif
|
|
#ifndef RAW_EPSIZE
|
|
# define RAW_EPSIZE 32
|
|
#endif
|
|
|
|
#define ORYX_PROTOCOL_VERSION = 0x01
|
|
#define ORYX_STOP_BIT -2
|
|
#define PAIRING_BLINK_STEPS 512
|
|
#define PAIRING_BLINK_END PAIRING_BLINK_STEPS * 60
|
|
#define PAIRING_SEQUENCE_SIZE 3
|
|
#define PAIRING_SEQUENCE_NUM_STORED 3
|
|
#define PAIRING_STORAGE_SIZE PAIRING_SEQUENCE_SIZE* PAIRING_SEQUENCE_NUM_STORED * sizeof(uint16_t)
|
|
|
|
enum Oryx_Command_Code {
|
|
ORYX_CMD_GET_FW_VERSION,
|
|
ORYX_CMD_PAIRING_INIT,
|
|
ORYX_CMD_PAIRING_VALIDATE,
|
|
ORYX_CMD_DISCONNECT,
|
|
ORYX_SET_LAYER,
|
|
ORYX_RGB_CONTROL,
|
|
ORYX_SET_RGB_LED,
|
|
ORYX_SET_STATUS_LED,
|
|
ORYX_UPDATE_BRIGHTNESS,
|
|
ORYX_GET_PROTOCOL_VERSION = 0xFE,
|
|
};
|
|
|
|
enum Oryx_Event_Code {
|
|
ORYX_EVT_GET_FW_VERSION,
|
|
ORYX_EVT_PAIRING_INPUT,
|
|
ORYX_EVT_PAIRING_KEY_INPUT,
|
|
ORYX_EVT_PAIRING_FAILED,
|
|
ORYX_EVT_PAIRING_SUCCESS,
|
|
ORYX_EVT_LAYER,
|
|
ORYX_EVT_KEYDOWN,
|
|
ORYX_EVT_KEYUP,
|
|
ORYX_EVT_RGB_CONTROL,
|
|
ORYX_EVT_GET_PROTOCOL_VERSION = 0XFE,
|
|
ORYX_EVT_ERROR = 0xFF,
|
|
};
|
|
|
|
enum Oryx_Error_Code {
|
|
ORYX_ERR_PAIRING_INIT_FAILED,
|
|
ORYX_ERR_PAIRING_INPUT_FAILED,
|
|
ORYX_ERR_PAIRING_KEY_INPUT_FAILED,
|
|
ORYX_ERR_PAIRING_FAILED,
|
|
ORYX_ERR_RGB_MATRIX_NOT_ENABLED,
|
|
ORYX_ERR_STATUS_LED_OUT_OF_RANGE,
|
|
ORYX_ERR_UNKNOWN_COMMAND = 0xFF,
|
|
};
|
|
|
|
extern bool oryx_state_live_training_enabled;
|
|
|
|
typedef struct {
|
|
bool pairing;
|
|
bool paired;
|
|
bool rgb_control;
|
|
} rawhid_state_t;
|
|
|
|
extern rawhid_state_t rawhid_state;
|
|
|
|
void create_pairing_code(void);
|
|
void oryx_error(uint8_t code);
|
|
bool store_pairing_sequence(keypos_t* pairing_sequence);
|
|
keypos_t get_random_keypos(void);
|
|
void pairing_init_handler(void);
|
|
void pairing_validate_handler(void);
|
|
void pairing_validate_eeprom_handler(void);
|
|
void pairing_init_event(void);
|
|
bool compare_sequences(keypos_t a[PAIRING_SEQUENCE_SIZE], keypos_t b[PAIRING_SEQUENCE_SIZE]);
|
|
void pairing_key_input_event(void);
|
|
void pairing_failed_event(void);
|
|
void pairing_succesful_event(void);
|
|
keypos_t* pairing_sequence(void);
|
|
|
|
void oryx_layer_event(void);
|
|
bool is_oryx_live_training_enabled(void);
|
|
bool process_record_oryx(uint16_t keycode, keyrecord_t* record);
|
|
void layer_state_set_oryx(layer_state_t state);
|
|
|
|
#if defined(RGB_MATRIX_ENABLE) && !defined(KEYBOARD_ergodox_ez_glow)
|
|
RGB webhid_leds[DRIVER_LED_TOTAL];
|
|
#endif |