quantum/split_common/serial.h

   1 #ifndef SOFT_SERIAL_H
   2 #define SOFT_SERIAL_H
   3
   4 #include <stdbool.h>
   5
   6 // /////////////////////////////////////////////////////////////////
   7 // Need Soft Serial defines in config.h
   8 // /////////////////////////////////////////////////////////////////
   9 // ex.
  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
  17 //
  18 // //// USE simple API (using signle-type transaction function)
  19 //   /* nothing */
  20 // //// USE flexible API (using multi-type transaction function)
  21 //   #define SERIAL_USE_MULTI_TRANSACTION
  22 //
  23 // /////////////////////////////////////////////////////////////////
  24
  25 // Soft Serial Transaction Descriptor
  26 typedef struct _SSTD_t  {
  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))
  34
  35 // initiator is transaction start side
  36 void soft_serial_initiator_init(SSTD_t *sstd_table, int sstd_table_size);
  37 // target is interrupt accept side
  38 void soft_serial_target_init(SSTD_t *sstd_table, int sstd_table_size);
  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
  46 int  soft_serial_transaction(void);
  47 #else
  48 int  soft_serial_transaction(int sstd_index);
  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
  62 int  soft_serial_get_and_clean_status(int sstd_index);
  63 #endif
  64
  65 #endif /* SOFT_SERIAL_H */