Output/pjrcUSB/output_com.h

   1 /* Copyright (C) 2013-2016 by Jacob Alexander
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to deal
   5  * in the Software without restriction, including without limitation the rights
   6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   7  * copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19  * THE SOFTWARE.
  20  */
  21
  22 #pragma once
  23
  24 // ----- Includes -----
  25
  26 // Compiler Includes
  27 #include <stdint.h>
  28
  29 // Local Includes
  30 #include <buildvars.h> // Defines USB Parameters, partially generated by CMake
  31
  32
  33
  34 // ----- Defines -----
  35
  36 // Max size of key buffer needed for NKRO
  37 // Boot mode uses only the first 6 bytes
  38 #define USB_NKRO_BITFIELD_SIZE_KEYS 27
  39 #define USB_BOOT_MAX_KEYS 6
  40
  41
  42
  43 // ----- Enumerations -----
  44
  45 // USB NKRO state transitions (indicates which Report ID's need refreshing)
  46 // Boot mode just checks if any keys were changed (as everything is sent every time)
  47 typedef enum USBKeyChangeState {
  48         USBKeyChangeState_None          = 0x00,
  49         USBKeyChangeState_Modifiers     = 0x01,
  50         USBKeyChangeState_MainKeys      = 0x02,
  51         USBKeyChangeState_SecondaryKeys = 0x04,
  52         USBKeyChangeState_TertiaryKeys  = 0x08,
  53         USBKeyChangeState_QuartiaryKeys = 0x10,
  54         USBKeyChangeState_System        = 0x20,
  55         USBKeyChangeState_Consumer      = 0x40,
  56         USBKeyChangeState_All           = 0x7F,
  57 } USBKeyChangeState;
  58
  59 // Allows for selective USB descriptor pushes
  60 // However, in most cases everything is updated for each packet push
  61 typedef enum USBMouseChangeState {
  62         USBMouseChangeState_None     = 0x00,
  63         USBMouseChangeState_Buttons  = 0x01,
  64         USBMouseChangeState_Relative = 0x02,
  65 } USBMouseChangeState;
  66
  67
  68
  69 // ----- Variables -----
  70
  71 // Variables used to communciate to the output module
  72 // XXX Even if the output module is not USB, this is internally understood keymapping scheme
  73 extern          uint8_t  USBKeys_Modifiers;
  74 extern          uint8_t  USBKeys_Keys[USB_NKRO_BITFIELD_SIZE_KEYS];
  75 extern          uint8_t  USBKeys_Sent;
  76 extern volatile uint8_t  USBKeys_LEDs;
  77
  78 extern          uint8_t  USBKeys_SysCtrl;  // 1KRO container for System Control HID table
  79 extern          uint16_t USBKeys_ConsCtrl; // 1KRO container for Consumer Control HID table
  80
  81 extern volatile uint8_t  USBKeys_Protocol; // 0 - Boot Mode, 1 - NKRO Mode
  82
  83 extern volatile uint16_t USBMouse_Buttons; // Bitmask for mouse buttons
  84 extern volatile uint16_t USBMouse_Relative_x;
  85 extern volatile uint16_t USBMouse_Relative_y;
  86
  87 // Misc variables (XXX Some are only properly utilized using AVR)
  88 extern          uint8_t  USBKeys_Idle_Config;
  89 extern          uint8_t  USBKeys_Idle_Count;
  90
  91 extern USBKeyChangeState   USBKeys_Changed;
  92 extern USBMouseChangeState USBMouse_Changed;
  93
  94 extern volatile uint8_t  Output_Available; // 0 - Output module not fully functional, 1 - Output module working
  95
  96 extern          uint8_t  Output_DebugMode; // 0 - Debug disabled, 1 - Debug enabled
  97
  98 extern          uint16_t Output_ExtCurrent_Available; // mA - Set by outside module if not using USB (i.e. Interconnect)
  99
 100
 101
 102 // ----- Functions -----
 103
 104 void Output_setup();
 105 void Output_send();
 106
 107 void Output_flushBuffers();
 108
 109 void Output_firmwareReload();
 110 void Output_softReset();
 111
 112 // Relies on USB serial module
 113 unsigned int Output_availablechar();
 114
 115 // Returns the total mA available (total, if used in a chain, each device will have to use a slice of it)
 116 unsigned int Output_current_available();
 117
 118 void Output_update_external_current( unsigned int current );
 119 void Output_update_usb_current( unsigned int current );
 120
 121 int Output_getchar();
 122 int Output_putchar( char c );
 123 int Output_putstr( char* str );
 124