keyboards/crkbd/serial.h

   1 #pragma once
   2
   3 #include <stdbool.h>
   4
   5 // /////////////////////////////////////////////////////////////////
   6 // Need Soft Serial defines in serial_config.h
   7 // /////////////////////////////////////////////////////////////////
   8 // ex.
   9 //  #define SERIAL_PIN_DDR DDRD
  10 //  #define SERIAL_PIN_PORT PORTD
  11 //  #define SERIAL_PIN_INPUT PIND
  12 //  #define SERIAL_PIN_MASK _BV(PD?)   ?=0,2
  13 //  #define SERIAL_PIN_INTERRUPT INT?_vect  ?=0,2
  14 //
  15 // //// USE Simple API (OLD API, compatible with let's split serial.c)
  16 // ex.
  17 //  #define SERIAL_SLAVE_BUFFER_LENGTH MATRIX_ROWS/2
  18 //  #define SERIAL_MASTER_BUFFER_LENGTH 1
  19 //
  20 // //// USE flexible API (using multi-type transaction function)
  21 //  #define SERIAL_USE_MULTI_TRANSACTION
  22 //
  23 // /////////////////////////////////////////////////////////////////
  24
  25
  26 #ifndef SERIAL_USE_MULTI_TRANSACTION
  27 /* --- USE Simple API (OLD API, compatible with let's split serial.c) */
  28 #if SERIAL_SLAVE_BUFFER_LENGTH > 0
  29 extern volatile uint8_t serial_slave_buffer[SERIAL_SLAVE_BUFFER_LENGTH];
  30 #endif
  31 #if SERIAL_MASTER_BUFFER_LENGTH > 0
  32 extern volatile uint8_t serial_master_buffer[SERIAL_MASTER_BUFFER_LENGTH];
  33 #endif
  34
  35 void serial_master_init(void);
  36 void serial_slave_init(void);
  37 int serial_update_buffers(void);
  38
  39 #endif // USE Simple API
  40
  41 // Soft Serial Transaction Descriptor
  42 typedef struct _SSTD_t  {
  43     uint8_t *status;
  44     uint8_t initiator2target_buffer_size;
  45     uint8_t *initiator2target_buffer;
  46     uint8_t target2initiator_buffer_size;
  47     uint8_t *target2initiator_buffer;
  48 } SSTD_t;
  49
  50 // initiator is transaction start side
  51 void soft_serial_initiator_init(SSTD_t *sstd_table);
  52 // target is interrupt accept side
  53 void soft_serial_target_init(SSTD_t *sstd_table);
  54
  55 // initiator resullt
  56 #define TRANSACTION_END 0
  57 #define TRANSACTION_NO_RESPONSE 0x1
  58 #define TRANSACTION_DATA_ERROR  0x2
  59 #ifndef SERIAL_USE_MULTI_TRANSACTION
  60 int  soft_serial_transaction(void);
  61 #else
  62 int  soft_serial_transaction(int sstd_index);
  63 #endif
  64
  65 // target status
  66 // *SSTD_t.status has
  67 //   initiator:
  68 //       TRANSACTION_END
  69 //    or TRANSACTION_NO_RESPONSE
  70 //    or TRANSACTION_DATA_ERROR
  71 //   target:
  72 //       TRANSACTION_DATA_ERROR
  73 //    or TRANSACTION_ACCEPTED
  74 #define TRANSACTION_ACCEPTED 0x4
  75 #ifdef SERIAL_USE_MULTI_TRANSACTION
  76 int  soft_serial_get_and_clean_status(int sstd_index);
  77 #endif