diff options
author | Nick Brassel <nick@tzarc.org> | 2021-06-18 09:10:06 +1000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-06-18 09:10:06 +1000 |
commit | 172e6a703041363decd6fc829542f33180c13beb (patch) | |
tree | a5d4afaa672ab44826865fd76b201e3899083192 /quantum/split_common/transaction_id_define.h | |
parent | ef92c9ee2cf4745637635ec1895399e4f013914c (diff) | |
download | qmk_firmware-172e6a703041363decd6fc829542f33180c13beb.tar.gz qmk_firmware-172e6a703041363decd6fc829542f33180c13beb.zip |
Extensible split data sync (#11930)
* Extensible split data sync capability through transactions.
- Split common transport has been split up between the transport layer
and data layer.
- Split "transactions" model used, with convergence between I2C and
serial data definitions.
- Slave matrix "generation count" is used to determine if the full slave
matrix needs to be retrieved.
- Encoders get the same "generation count" treatment.
- All other blocks of data are synchronised when a change is detected.
- All transmissions have a globally-configurable deadline before a
transmission is forced (`FORCED_SYNC_THROTTLE_MS`, default 100ms).
- Added atomicity for all core-synced data, preventing partial updates
- Added retries to AVR i2c_master's i2c_start, to minimise the number of
failed transactions when interrupts are disabled on the slave due to
atomicity checks.
- Some keyboards have had slight modifications made in order to ensure
that they still build due to firmware size restrictions.
* Fixup LED_MATRIX compile.
* Parameterise ERROR_DISCONNECT_COUNT.
Diffstat (limited to 'quantum/split_common/transaction_id_define.h')
-rw-r--r-- | quantum/split_common/transaction_id_define.h | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/quantum/split_common/transaction_id_define.h b/quantum/split_common/transaction_id_define.h new file mode 100644 index 000000000..464c73478 --- /dev/null +++ b/quantum/split_common/transaction_id_define.h | |||
@@ -0,0 +1,94 @@ | |||
1 | /* Copyright 2021 QMK | ||
2 | * | ||
3 | * This program is free software: you can redistribute it and/or modify | ||
4 | * it under the terms of the GNU General Public License as published by | ||
5 | * the Free Software Foundation, either version 2 of the License, or | ||
6 | * (at your option) any later version. | ||
7 | * | ||
8 | * This program is distributed in the hope that it will be useful, | ||
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
11 | * GNU General Public License for more details. | ||
12 | * | ||
13 | * You should have received a copy of the GNU General Public License | ||
14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
15 | */ | ||
16 | |||
17 | #pragma once | ||
18 | |||
19 | enum serial_transaction_id { | ||
20 | #ifdef USE_I2C | ||
21 | I2C_EXECUTE_CALLBACK, | ||
22 | #endif // USE_I2C | ||
23 | |||
24 | GET_SLAVE_MATRIX_CHECKSUM, | ||
25 | GET_SLAVE_MATRIX_DATA, | ||
26 | |||
27 | #ifdef SPLIT_TRANSPORT_MIRROR | ||
28 | PUT_MASTER_MATRIX, | ||
29 | #endif // SPLIT_TRANSPORT_MIRROR | ||
30 | |||
31 | #ifdef ENCODER_ENABLE | ||
32 | GET_ENCODERS_CHECKSUM, | ||
33 | GET_ENCODERS_DATA, | ||
34 | #endif // ENCODER_ENABLE | ||
35 | |||
36 | #ifndef DISABLE_SYNC_TIMER | ||
37 | PUT_SYNC_TIMER, | ||
38 | #endif // DISABLE_SYNC_TIMER | ||
39 | |||
40 | #if !defined(NO_ACTION_LAYER) && defined(SPLIT_LAYER_STATE_ENABLE) | ||
41 | PUT_LAYER_STATE, | ||
42 | PUT_DEFAULT_LAYER_STATE, | ||
43 | #endif // !defined(NO_ACTION_LAYER) && defined(SPLIT_LAYER_STATE_ENABLE) | ||
44 | |||
45 | #ifdef SPLIT_LED_STATE_ENABLE | ||
46 | PUT_LED_STATE, | ||
47 | #endif // SPLIT_LED_STATE_ENABLE | ||
48 | |||
49 | #ifdef SPLIT_MODS_ENABLE | ||
50 | PUT_MODS, | ||
51 | #endif // SPLIT_MODS_ENABLE | ||
52 | |||
53 | #ifdef BACKLIGHT_ENABLE | ||
54 | PUT_BACKLIGHT, | ||
55 | #endif // BACKLIGHT_ENABLE | ||
56 | |||
57 | #if defined(RGBLIGHT_ENABLE) && defined(RGBLIGHT_SPLIT) | ||
58 | PUT_RGBLIGHT, | ||
59 | #endif // defined(RGBLIGHT_ENABLE) && defined(RGBLIGHT_SPLIT) | ||
60 | |||
61 | #if defined(LED_MATRIX_ENABLE) && defined(LED_MATRIX_SPLIT) | ||
62 | PUT_LED_MATRIX, | ||
63 | #endif // defined(LED_MATRIX_ENABLE) && defined(LED_MATRIX_SPLIT) | ||
64 | |||
65 | #if defined(RGB_MATRIX_ENABLE) && defined(RGB_MATRIX_SPLIT) | ||
66 | PUT_RGB_MATRIX, | ||
67 | #endif // defined(RGBLIGHT_ENABLE) && defined(RGBLIGHT_SPLIT) | ||
68 | |||
69 | #if defined(WPM_ENABLE) && defined(SPLIT_WPM_ENABLE) | ||
70 | PUT_WPM, | ||
71 | #endif // defined(WPM_ENABLE) && defined(SPLIT_WPM_ENABLE) | ||
72 | |||
73 | #if defined(SPLIT_TRANSACTION_IDS_KB) || defined(SPLIT_TRANSACTION_IDS_USER) | ||
74 | PUT_RPC_INFO, | ||
75 | PUT_RPC_REQ_DATA, | ||
76 | EXECUTE_RPC, | ||
77 | GET_RPC_RESP_DATA, | ||
78 | #endif // defined(SPLIT_TRANSACTION_IDS_KB) || defined(SPLIT_TRANSACTION_IDS_USER) | ||
79 | |||
80 | // keyboard-specific | ||
81 | #ifdef SPLIT_TRANSACTION_IDS_KB | ||
82 | SPLIT_TRANSACTION_IDS_KB, | ||
83 | #endif // SPLIT_TRANSACTION_IDS_KB | ||
84 | |||
85 | // user/keymap-specific | ||
86 | #ifdef SPLIT_TRANSACTION_IDS_USER | ||
87 | SPLIT_TRANSACTION_IDS_USER, | ||
88 | #endif // SPLIT_TRANSACTION_IDS_USER | ||
89 | |||
90 | NUM_TOTAL_TRANSACTIONS | ||
91 | }; | ||
92 | |||
93 | // Ensure we only use 5 bits for transaction | ||
94 | _Static_assert(NUM_TOTAL_TRANSACTIONS <= (1 << 5), "Max number of usable transactions exceeded"); | ||