6 // /////////////////////////////////////////////////////////////////
7 // Need Soft Serial defines in config.h
8 // /////////////////////////////////////////////////////////////////
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)
18 // //// USE Simple API (OLD API, compatible with let's split serial.c)
20 // #define SERIAL_SLAVE_BUFFER_LENGTH MATRIX_ROWS/2
21 // #define SERIAL_MASTER_BUFFER_LENGTH 1
23 // //// USE flexible API (using multi-type transaction function)
24 // #define SERIAL_USE_MULTI_TRANSACTION
26 // /////////////////////////////////////////////////////////////////
29 #ifndef SERIAL_USE_MULTI_TRANSACTION
30 /* --- USE Simple API (OLD API, compatible with let's split serial.c) */
31 #if SERIAL_SLAVE_BUFFER_LENGTH > 0
32 extern volatile uint8_t serial_slave_buffer[SERIAL_SLAVE_BUFFER_LENGTH];
34 #if SERIAL_MASTER_BUFFER_LENGTH > 0
35 extern volatile uint8_t serial_master_buffer[SERIAL_MASTER_BUFFER_LENGTH];
38 void serial_master_init(void);
39 void serial_slave_init(void);
40 int serial_update_buffers(void);
42 #endif // USE Simple API
44 // Soft Serial Transaction Descriptor
45 typedef struct _SSTD_t {
47 uint8_t initiator2target_buffer_size;
48 uint8_t *initiator2target_buffer;
49 uint8_t target2initiator_buffer_size;
50 uint8_t *target2initiator_buffer;
52 #define TID_LIMIT( table ) (sizeof(table) / sizeof(SSTD_t))
54 // initiator is transaction start side
55 void soft_serial_initiator_init(SSTD_t *sstd_table, int sstd_table_size);
56 // target is interrupt accept side
57 void soft_serial_target_init(SSTD_t *sstd_table, int sstd_table_size);
60 #define TRANSACTION_END 0
61 #define TRANSACTION_NO_RESPONSE 0x1
62 #define TRANSACTION_DATA_ERROR 0x2
63 #define TRANSACTION_TYPE_ERROR 0x4
64 #ifndef SERIAL_USE_MULTI_TRANSACTION
65 int soft_serial_transaction(void);
67 int soft_serial_transaction(int sstd_index);
74 // or TRANSACTION_NO_RESPONSE
75 // or TRANSACTION_DATA_ERROR
77 // TRANSACTION_DATA_ERROR
78 // or TRANSACTION_ACCEPTED
79 #define TRANSACTION_ACCEPTED 0x8
80 #ifdef SERIAL_USE_MULTI_TRANSACTION
81 int soft_serial_get_and_clean_status(int sstd_index);
84 #endif /* SOFT_SERIAL_H */