mirror of
https://github.com/qmk/qmk_firmware.git
synced 2026-10-02 14:58:59 +02:00
Tomasz bla FortunaandTomasz bla Fortuna
f771cb545f
* bla personal ap2-c18 keymap. * Bidirectional, asynchronous message-based communication with Shine. - Requires a matching Shine version. - Protocol is resiliant to loosing bytes during communication, chips won't lock waiting for bytes that aren't coming. - Chips resynchronize in event of loosing a byte using a AA0D header. Regressions: - Key masking/locking doesn't work right now. (did it work before?) - Not all user keymaps build against it. * Clang-format + code to ease reducing speed of LED UART. - Did clang-format --style=file -i on multiple files according to coding_conventions_c.md - Added separate serial speed for IAP boot and Led communication, it's possible that reducing this to 9600 helped someone with faulty HW. With this code they can do it with simple replacing of a value. * Main chip can set/clear foreground using a mask mechanism. - Some preparations for selective colouring. * Selective mask works - tested on capslock. - Migrated personal keymaps to new status API. * Clear the foreground colors to show profile when it's modified. - Show example of achieving selective caps-lock painting + foreground painting for layers. - annepro2LedMaskSetRow is implemented, but still requires testing. * Implement the QMK side of led blinking to indicate the command was received. - This stupidly blinks the key when user presses one of the bluetooth commands to let the user know that the command was received and forwarded to the BT chip. - TODO: Row/col key positions are hardcoded and not taken from the keymap. * Reduce memory footprint. Applying code review suggestions. Moved msgId to globals - preparing for transmission without copying payload when no retries are necessary. Added empty readme.md files - required by QMK lint. Co-authored-by: Tomasz bla Fortuna <bla@thera.be>
116 lines
2.7 KiB
C
116 lines
2.7 KiB
C
/*
|
|
* (c) 2021 by Tomasz bla Fortuna
|
|
* License: GPLv2
|
|
*
|
|
* This file is shared with the Shine firmware. Keep it in sync (and in the
|
|
* shine's clang formatting).
|
|
*/
|
|
|
|
#ifndef PROTOCOL_INCLUDED
|
|
#define PROTOCOL_INCLUDED
|
|
#include <inttypes.h>
|
|
|
|
#define PROTOCOL_SD SD0
|
|
|
|
enum {
|
|
/*
|
|
* Main -> LED
|
|
*/
|
|
/* Basic config */
|
|
CMD_LED_ON = 0x01,
|
|
CMD_LED_OFF = 0x02,
|
|
|
|
CMD_LED_SET_PROFILE = 0x03,
|
|
CMD_LED_NEXT_PROFILE = 0x04,
|
|
CMD_LED_PREV_PROFILE = 0x05,
|
|
|
|
CMD_LED_NEXT_INTENSITY = 0x06,
|
|
CMD_LED_NEXT_ANIMATION_SPEED = 0x07,
|
|
|
|
/* Masks */
|
|
/* Override a key color, eg. capslock */
|
|
CMD_LED_MASK_SET_KEY = 0x10,
|
|
/* Override all keys in a row with configurable colors */
|
|
CMD_LED_MASK_SET_ROW = 0x11,
|
|
|
|
/* Override all keys with single color (eg. foreground color) */
|
|
CMD_LED_MASK_SET_MONO = 0x12,
|
|
|
|
/* Reactive / status */
|
|
CMD_LED_GET_STATUS = 0x20,
|
|
CMD_LED_KEY_BLINK = 0x21,
|
|
CMD_LED_KEY_DOWN = 0x22,
|
|
CMD_LED_KEY_UP = 0x23, /* TODO */
|
|
CMD_LED_IAP = 0x24,
|
|
|
|
/* LED -> Main */
|
|
/* Payload with data to send over HID */
|
|
CMD_LED_DEBUG = 0x40,
|
|
|
|
/* Number of profiles, current profile, on/off state,
|
|
reactive flag, brightness, errors */
|
|
CMD_LED_STATUS = 0x41,
|
|
};
|
|
|
|
/* 1 ROW * 14 COLS * 4B (RGBX) = 56 + header prefix. */
|
|
#define MAX_PAYLOAD_SIZE 64
|
|
|
|
/** Enum of the states used for the serial protocol finite-state automaton */
|
|
enum protoState {
|
|
/* 2-byte initial start-of-message sync */
|
|
STATE_SYNC_1,
|
|
STATE_SYNC_2,
|
|
/* Waiting for command byte */
|
|
STATE_CMD,
|
|
/* Waiting for ID byte */
|
|
STATE_ID,
|
|
/* Waiting for payload size */
|
|
STATE_PAYLOAD_SIZE,
|
|
/* Reading payload until payloadPosition == payloadSize */
|
|
STATE_PAYLOAD,
|
|
};
|
|
|
|
/* Buffer holding a single message */
|
|
typedef struct {
|
|
uint8_t command;
|
|
uint8_t msgId;
|
|
uint8_t payloadSize;
|
|
uint8_t payload[MAX_PAYLOAD_SIZE];
|
|
} message_t;
|
|
|
|
/* Internal protocol state */
|
|
typedef struct {
|
|
/* Callback to call upon receiving a valid message */
|
|
void (*callback)(const message_t *);
|
|
|
|
/* Number of read payload bytes */
|
|
uint8_t payloadPosition;
|
|
|
|
/* Current finite-state-automata state */
|
|
enum protoState state;
|
|
|
|
uint8_t previousId;
|
|
uint8_t errors;
|
|
|
|
/* Currently received message */
|
|
message_t buffer;
|
|
} protocol_t;
|
|
|
|
/* NOTE: This didn't work when defined on stack */
|
|
extern protocol_t proto;
|
|
|
|
/* Init state */
|
|
extern void protoInit(protocol_t *proto, void (*callback)(const message_t *));
|
|
|
|
/* Consume one byte and push state forward - might call the callback */
|
|
extern void protoConsume(protocol_t *proto, uint8_t byte);
|
|
|
|
/* Prolonged silence - reset state */
|
|
extern void protoSilence(protocol_t *proto);
|
|
|
|
/* Transmit message */
|
|
extern void protoTx(uint8_t cmd, const unsigned char *buf, int payloadSize,
|
|
int retries);
|
|
|
|
#endif
|