1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
/*
* (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).
*/
#pragma once
#include <stdint.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);
|
