quantum/api.h

   1 #ifndef _API_H_
   2 #define _API_H_
   3
   4 #include "lufa.h"
   5
   6 enum MESSAGE_TYPE {
   7     MT_GET_DATA =      0x10, // Get data from keyboard
   8     MT_GET_DATA_ACK =  0x11, // returned data to process (ACK)
   9     MT_SET_DATA =      0x20, // Set data on keyboard
  10     MT_SET_DATA_ACK =  0x21, // returned data to confirm (ACK)
  11     MT_SEND_DATA =     0x30, // Sending data/action from keyboard
  12     MT_SEND_DATA_ACK = 0x31, // returned data/action confirmation (ACK)
  13     MT_EXE_ACTION =    0x40, // executing actions on keyboard
  14     MT_EXE_ACTION_ACK =0x41, // return confirmation/value (ACK)
  15     MT_TYPE_ERROR =    0x80 // type not recofgnised (ACK)
  16 };
  17
  18 enum DATA_TYPE {
  19     DT_NONE = 0x00,
  20     DT_HANDSHAKE,
  21     DT_DEFAULT_LAYER,
  22     DT_CURRENT_LAYER,
  23     DT_KEYMAP_OPTIONS,
  24     DT_BACKLIGHT,
  25     DT_RGBLIGHT,
  26     DT_UNICODE,
  27     DT_DEBUG,
  28     DT_AUDIO,
  29     DT_QUANTUM_ACTION,
  30     DT_KEYBOARD_ACTION,
  31     DT_USER_ACTION,
  32     DT_KEYMAP_SIZE,
  33     DT_KEYMAP
  34 };
  35
  36 void dword_to_bytes(uint32_t dword, uint8_t * bytes);
  37 uint32_t bytes_to_dword(uint8_t * bytes, uint8_t index);
  38
  39 #define MT_GET_DATA(data_type, data, length) SEND_BYTES(MT_GET_DATA, data_type, data, length)
  40 #define MT_GET_DATA_ACK(data_type, data, length) SEND_BYTES(MT_GET_DATA_ACK, data_type, data, length)
  41 #define MT_SET_DATA(data_type, data, length) SEND_BYTES(MT_SET_DATA, data_type, data, length)
  42 #define MT_SET_DATA_ACK(data_type, data, length) SEND_BYTES(MT_SET_DATA_ACK, data_type, data, length)
  43 #define MT_SEND_DATA(data_type, data, length) SEND_BYTES(MT_SEND_DATA, data_type, data, length)
  44 #define MT_SEND_DATA_ACK(data_type, data, length) SEND_BYTES(MT_SEND_DATA_ACK, data_type, data, length)
  45 #define MT_EXE_ACTION(data_type, data, length) SEND_BYTES(MT_EXE_ACTION, data_type, data, length)
  46 #define MT_EXE_ACTION_ACK(data_type, data, length) SEND_BYTES(MT_EXE_ACTION_ACK, data_type, data, length)
  47
  48 void process_api(uint16_t length, uint8_t * data);
  49
  50 __attribute__ ((weak))
  51 bool process_api_quantum(uint8_t length, uint8_t * data);
  52
  53 __attribute__ ((weak))
  54 bool process_api_keyboard(uint8_t length, uint8_t * data);
  55
  56 __attribute__ ((weak))
  57 bool process_api_user(uint8_t length, uint8_t * data);
  58
  59 #endif