aboutsummaryrefslogtreecommitdiff
path: root/quantum/split_common/serial.h
diff options
context:
space:
mode:
authorTakeshi ISHII <2170248+mtei@users.noreply.github.com>2018-12-25 04:14:57 +0900
committerDrashna Jaelre <drashna@live.com>2018-12-24 11:14:57 -0800
commit72d4e4bfd76b2c83b89787f8b3a8ba779a3e8d81 (patch)
tree694d3d9251aa752c11788e1e8550cba0cb78578b /quantum/split_common/serial.h
parent2149f3b5889f898fecde845a03d61c1a854d9393 (diff)
downloadqmk_firmware-72d4e4bfd76b2c83b89787f8b3a8ba779a3e8d81.tar.gz
qmk_firmware-72d4e4bfd76b2c83b89787f8b3a8ba779a3e8d81.zip
Replace serial.c of quantum/split_common/ (#4669)
* Add provisional Helix implementation to test the quantum/split_common. * copy keyboards/helix/serial.[ch] to quantum/split_common/ * Make serial.c a pure driver. Remove buffer name and buffer size from serial.c. They should be placed in the caller(matrix.c, split_utils.c). * remove quantum/split_common/serial_backward_compatibility.h * Changed array serial_master_buffer to structure serial_m2s_buffer. * Changed array serial_slave_buffer to structure serial_s2m_buffer. * Change keyboards/miniaxe/matrix.c I also made changes to quantum/split_comon/matrix.c to keyboards/miniaxe/matrix.c. Note: I contacted @ka2hiro, creator of miniaxe, and I got permission to change keyboards/miniaxe/matrix.c. * update history comment in quantum/split_common/serial.c * Revert "Add provisional Helix implementation to test the quantum/split_common." This reverts commit 168c82ef82c88e79979d9796bab9cc819cc2f685. * fix keyboards/miniaxe/matrix.c, quantum/split_common/matrix.c avr-gcc 4.9.[23] report error. avr-gcc 5.4.0, avr-gcc 7.3.0 pass. It is funny. * update comment quantum/split_common/serial.c * Reserve RGBLIGHT_SPLIT macro in quantum/split_common
Diffstat (limited to 'quantum/split_common/serial.h')
-rw-r--r--quantum/split_common/serial.h65
1 files changed, 52 insertions, 13 deletions
diff --git a/quantum/split_common/serial.h b/quantum/split_common/serial.h
index 0b99f352d..b6638b3bd 100644
--- a/quantum/split_common/serial.h
+++ b/quantum/split_common/serial.h
@@ -1,5 +1,5 @@
1#ifndef MY_SERIAL_H 1#ifndef SOFT_SERIAL_H
2#define MY_SERIAL_H 2#define SOFT_SERIAL_H
3 3
4#include <stdbool.h> 4#include <stdbool.h>
5 5
@@ -7,20 +7,59 @@
7// Need Soft Serial defines in config.h 7// Need Soft Serial defines in config.h
8// ///////////////////////////////////////////////////////////////// 8// /////////////////////////////////////////////////////////////////
9// ex. 9// ex.
10// /* Configuration of lower interface with the lower layer(hardware) of serial.c */
11// #define SOFT_SERIAL_PIN ?? // ?? = D0,D1,D2,D3,E6 10// #define SOFT_SERIAL_PIN ?? // ?? = D0,D1,D2,D3,E6
11// OPTIONAL: #define SELECT_SOFT_SERIAL_SPEED ? // ? = 1,2,3,4,5
12// // 1: about 137kbps (default)
13// // 2: about 75kbps
14// // 3: about 39kbps
15// // 4: about 26kbps
16// // 5: about 20kbps
12// 17//
13// /* Configuration of upper interface with the upper layer of serial.c */ 18// //// USE simple API (using signle-type transaction function)
14// #define SERIAL_SLAVE_BUFFER_LENGTH MATRIX_ROWS/2 19// /* nothing */
15// #define SERIAL_MASTER_BUFFER_LENGTH 1 20// //// USE flexible API (using multi-type transaction function)
21// #define SERIAL_USE_MULTI_TRANSACTION
22//
23// /////////////////////////////////////////////////////////////////
16 24
17// Buffers for master - slave communication 25// Soft Serial Transaction Descriptor
18extern volatile uint8_t serial_slave_buffer[SERIAL_SLAVE_BUFFER_LENGTH]; 26typedef struct _SSTD_t {
19extern volatile uint8_t serial_master_buffer[SERIAL_MASTER_BUFFER_LENGTH]; 27 uint8_t *status;
28 uint8_t initiator2target_buffer_size;
29 uint8_t *initiator2target_buffer;
30 uint8_t target2initiator_buffer_size;
31 uint8_t *target2initiator_buffer;
32} SSTD_t;
33#define TID_LIMIT( table ) (sizeof(table) / sizeof(SSTD_t))
20 34
21void serial_master_init(void); 35// initiator is transaction start side
22void serial_slave_init(void); 36void soft_serial_initiator_init(SSTD_t *sstd_table, int sstd_table_size);
23int serial_update_buffers(void); 37// target is interrupt accept side
24bool serial_slave_data_corrupt(void); 38void soft_serial_target_init(SSTD_t *sstd_table, int sstd_table_size);
25 39
40// initiator resullt
41#define TRANSACTION_END 0
42#define TRANSACTION_NO_RESPONSE 0x1
43#define TRANSACTION_DATA_ERROR 0x2
44#define TRANSACTION_TYPE_ERROR 0x4
45#ifndef SERIAL_USE_MULTI_TRANSACTION
46int soft_serial_transaction(void);
47#else
48int soft_serial_transaction(int sstd_index);
26#endif 49#endif
50
51// target status
52// *SSTD_t.status has
53// initiator:
54// TRANSACTION_END
55// or TRANSACTION_NO_RESPONSE
56// or TRANSACTION_DATA_ERROR
57// target:
58// TRANSACTION_DATA_ERROR
59// or TRANSACTION_ACCEPTED
60#define TRANSACTION_ACCEPTED 0x8
61#ifdef SERIAL_USE_MULTI_TRANSACTION
62int soft_serial_get_and_clean_status(int sstd_index);
63#endif
64
65#endif /* SOFT_SERIAL_H */