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 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
24 // //// USE simple API (using signle-type transaction function)
25 // #define SERIAL_USE_SINGLE_TRANSACTION
26 // //// USE flexible API (using multi-type transaction function)
27 // #define SERIAL_USE_MULTI_TRANSACTION
29 // /////////////////////////////////////////////////////////////////
32 //////////////// for backward compatibility ////////////////////////////////
33 #if !defined(SERIAL_USE_SINGLE_TRANSACTION) && !defined(SERIAL_USE_MULTI_TRANSACTION)
34 /* --- USE OLD API (compatible with let's split serial.c) */
35 #if SERIAL_SLAVE_BUFFER_LENGTH > 0
36 extern volatile uint8_t serial_slave_buffer[SERIAL_SLAVE_BUFFER_LENGTH];
38 #if SERIAL_MASTER_BUFFER_LENGTH > 0
39 extern volatile uint8_t serial_master_buffer[SERIAL_MASTER_BUFFER_LENGTH];
42 void serial_master_init(void);
43 void serial_slave_init(void);
44 int serial_update_buffers(void);
46 #endif // end of USE OLD API
47 ////////////////////////////////////////////////////////////////////////////
49 // Soft Serial Transaction Descriptor
50 typedef struct _SSTD_t {
52 uint8_t initiator2target_buffer_size;
53 uint8_t *initiator2target_buffer;
54 uint8_t target2initiator_buffer_size;
55 uint8_t *target2initiator_buffer;
57 #define TID_LIMIT( table ) (sizeof(table) / sizeof(SSTD_t))
59 // initiator is transaction start side
60 void soft_serial_initiator_init(SSTD_t *sstd_table, int sstd_table_size);
61 // target is interrupt accept side
62 void soft_serial_target_init(SSTD_t *sstd_table, int sstd_table_size);
65 #define TRANSACTION_END 0
66 #define TRANSACTION_NO_RESPONSE 0x1
67 #define TRANSACTION_DATA_ERROR 0x2
68 #define TRANSACTION_TYPE_ERROR 0x4
69 #ifndef SERIAL_USE_MULTI_TRANSACTION
70 int soft_serial_transaction(void);
72 int soft_serial_transaction(int sstd_index);
79 // or TRANSACTION_NO_RESPONSE
80 // or TRANSACTION_DATA_ERROR
82 // TRANSACTION_DATA_ERROR
83 // or TRANSACTION_ACCEPTED
84 #define TRANSACTION_ACCEPTED 0x8
85 #ifdef SERIAL_USE_MULTI_TRANSACTION
86 int soft_serial_get_and_clean_status(int sstd_index);
89 #endif /* SOFT_SERIAL_H */