keyboards/treadstone48/serial.h

   1 #pragma once
   2
   3 #include <stdbool.h>
   4
   5 // /////////////////////////////////////////////////////////////////
   6 // Need Soft Serial defines in config.h
   7 // /////////////////////////////////////////////////////////////////
   8 // ex.
   9 //  #define SOFT_SERIAL_PIN ??   // ?? = D0,D1,D2,D3,E6
  10 //  OPTIONAL: #define SELECT_SOFT_SERIAL_SPEED ? // ? = 1,2,3,4,5
  11 //                                               //  1: about 137kbps (default)
  12 //                                               //  2: about 75kbps
  13 //                                               //  3: about 39kbps
  14 //                                               //  4: about 26kbps
  15 //                                               //  5: about 20kbps
  16 //
  17 // //// USE OLD API (compatible with let's split serial.c)
  18 // ex.
  19 //  #define SERIAL_SLAVE_BUFFER_LENGTH MATRIX_ROWS/2
  20 //  #define SERIAL_MASTER_BUFFER_LENGTH 1
  21 //
  22 // //// USE NEW API
  23 //    //// USE simple API (using signle-type transaction function)
  24 //      #define SERIAL_USE_SINGLE_TRANSACTION
  25 // //// USE flexible API (using multi-type transaction function)
  26 //  #define SERIAL_USE_MULTI_TRANSACTION
  27 //
  28 // /////////////////////////////////////////////////////////////////
  29
  30
  31 //////////////// for backward compatibility ////////////////////////////////
  32 #if !defined(SERIAL_USE_SINGLE_TRANSACTION) && !defined(SERIAL_USE_MULTI_TRANSACTION)
  33 /* --- USE OLD API (compatible with let's split serial.c) */
  34  #if SERIAL_SLAVE_BUFFER_LENGTH > 0
  35  extern volatile uint8_t serial_slave_buffer[SERIAL_SLAVE_BUFFER_LENGTH];
  36  #endif
  37  #if SERIAL_MASTER_BUFFER_LENGTH > 0
  38  extern volatile uint8_t serial_master_buffer[SERIAL_MASTER_BUFFER_LENGTH];
  39  #endif
  40
  41  void serial_master_init(void);
  42  void serial_slave_init(void);
  43  int serial_update_buffers(void);
  44
  45 #endif // end of USE OLD API
  46 ////////////////////////////////////////////////////////////////////////////
  47
  48 // Soft Serial Transaction Descriptor
  49 typedef struct _SSTD_t  {
  50     uint8_t *status;
  51     uint8_t initiator2target_buffer_size;
  52     uint8_t *initiator2target_buffer;
  53     uint8_t target2initiator_buffer_size;
  54     uint8_t *target2initiator_buffer;
  55 } SSTD_t;
  56 #define TID_LIMIT( table ) (sizeof(table) / sizeof(SSTD_t))
  57
  58 // initiator is transaction start side
  59 void soft_serial_initiator_init(SSTD_t *sstd_table, int sstd_table_size);
  60 // target is interrupt accept side
  61 void soft_serial_target_init(SSTD_t *sstd_table, int sstd_table_size);
  62
  63 // initiator resullt
  64 #define TRANSACTION_END 0
  65 #define TRANSACTION_NO_RESPONSE 0x1
  66 #define TRANSACTION_DATA_ERROR  0x2
  67 #define TRANSACTION_TYPE_ERROR  0x4
  68 #ifndef SERIAL_USE_MULTI_TRANSACTION
  69 int  soft_serial_transaction(void);
  70 #else
  71 int  soft_serial_transaction(int sstd_index);
  72 #endif
  73
  74 // target status
  75 // *SSTD_t.status has
  76 //   initiator:
  77 //       TRANSACTION_END
  78 //    or TRANSACTION_NO_RESPONSE
  79 //    or TRANSACTION_DATA_ERROR
  80 //   target:
  81 //       TRANSACTION_DATA_ERROR
  82 //    or TRANSACTION_ACCEPTED
  83 #define TRANSACTION_ACCEPTED 0x8
  84 #ifdef SERIAL_USE_MULTI_TRANSACTION
  85 int  soft_serial_get_and_clean_status(int sstd_index);
  86 #endif