quantum/api.h

   1 /* Copyright 2016 Jack Humbert
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17 #ifndef _API_H_
  18 #define _API_H_
  19
  20 #ifdef __AVR__
  21 #include "lufa.h"
  22 #endif
  23
  24 enum MESSAGE_TYPE {
  25     MT_GET_DATA =      0x10, // Get data from keyboard
  26     MT_GET_DATA_ACK =  0x11, // returned data to process (ACK)
  27     MT_SET_DATA =      0x20, // Set data on keyboard
  28     MT_SET_DATA_ACK =  0x21, // returned data to confirm (ACK)
  29     MT_SEND_DATA =     0x30, // Sending data/action from keyboard
  30     MT_SEND_DATA_ACK = 0x31, // returned data/action confirmation (ACK)
  31     MT_EXE_ACTION =    0x40, // executing actions on keyboard
  32     MT_EXE_ACTION_ACK =0x41, // return confirmation/value (ACK)
  33     MT_TYPE_ERROR =    0x80 // type not recognised (ACK)
  34 };
  35
  36 enum DATA_TYPE {
  37     DT_NONE = 0x00,
  38     DT_HANDSHAKE,
  39     DT_DEFAULT_LAYER,
  40     DT_CURRENT_LAYER,
  41     DT_KEYMAP_OPTIONS,
  42     DT_BACKLIGHT,
  43     DT_RGBLIGHT,
  44     DT_UNICODE,
  45     DT_DEBUG,
  46     DT_AUDIO,
  47     DT_QUANTUM_ACTION,
  48     DT_KEYBOARD_ACTION,
  49     DT_USER_ACTION,
  50     DT_KEYMAP_SIZE,
  51     DT_KEYMAP
  52 };
  53
  54 void dword_to_bytes(uint32_t dword, uint8_t * bytes);
  55 uint32_t bytes_to_dword(uint8_t * bytes, uint8_t index);
  56
  57 #define MT_GET_DATA(data_type, data, length) SEND_BYTES(MT_GET_DATA, data_type, data, length)
  58 #define MT_GET_DATA_ACK(data_type, data, length) SEND_BYTES(MT_GET_DATA_ACK, data_type, data, length)
  59 #define MT_SET_DATA(data_type, data, length) SEND_BYTES(MT_SET_DATA, data_type, data, length)
  60 #define MT_SET_DATA_ACK(data_type, data, length) SEND_BYTES(MT_SET_DATA_ACK, data_type, data, length)
  61 #define MT_SEND_DATA(data_type, data, length) SEND_BYTES(MT_SEND_DATA, data_type, data, length)
  62 #define MT_SEND_DATA_ACK(data_type, data, length) SEND_BYTES(MT_SEND_DATA_ACK, data_type, data, length)
  63 #define MT_EXE_ACTION(data_type, data, length) SEND_BYTES(MT_EXE_ACTION, data_type, data, length)
  64 #define MT_EXE_ACTION_ACK(data_type, data, length) SEND_BYTES(MT_EXE_ACTION_ACK, data_type, data, length)
  65
  66 void process_api(uint16_t length, uint8_t * data);
  67
  68 __attribute__ ((weak))
  69 bool process_api_quantum(uint8_t length, uint8_t * data);
  70
  71 __attribute__ ((weak))
  72 bool process_api_keyboard(uint8_t length, uint8_t * data);
  73
  74 __attribute__ ((weak))
  75 bool process_api_user(uint8_t length, uint8_t * data);
  76
  77 #endif