USB/pjrc/usb_com.h

   1 /* Copyright (C) 2011 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 #ifndef __usb_com_h
  23 #define __usb_com_h
  24
  25 // ----- Includes -----
  26
  27 // AVR Includes
  28
  29 // Compiler Includes
  30 #include <stdint.h>
  31
  32 // Local Includes
  33
  34
  35
  36 // ----- Defines -----
  37
  38 // Indicator for other modules through USBKeys_MaxSize for how capable the USB module is when sending large number of keypresses
  39 #define USB_MAX_KEY_SEND 6
  40
  41
  42 // You can change these to give your code its own name.
  43 #define STR_MANUFACTURER        L"MfgName"
  44 #define STR_PRODUCT             L"Keyboard"
  45
  46
  47 // Mac OS-X and Linux automatically load the correct drivers.  On
  48 // Windows, even though the driver is supplied by Microsoft, an
  49 // INF file is needed to load the driver.  These numbers need to
  50 // match the INF file.
  51 #define VENDOR_ID               0x16C0
  52 #define PRODUCT_ID              0x047D
  53
  54
  55
  56 // ----- Variables -----
  57
  58 // Variables used to communciate to the usb module
  59 extern                       uint8_t USBKeys_Modifiers;
  60 extern                       uint8_t USBKeys_Array[USB_MAX_KEY_SEND];
  61 extern                       uint8_t USBKeys_Sent;
  62 extern volatile              uint8_t USBKeys_LEDs;
  63                 static const uint8_t USBKeys_MaxSize = USB_MAX_KEY_SEND;
  64
  65
  66
  67 // ----- Functions -----
  68
  69 void usb_setup(void);
  70 void usb_send(void);
  71
  72 #endif
  73