LUFA/Drivers/USB/Class/Common/HID.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \ingroup Group_USBClassHID
  32  *  @defgroup Group_USBClassHIDCommon  Common Class Definitions
  33  *
  34  *  \section Module Description
  35  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  36  *  HID Class.
  37  *
  38  *  @{
  39  */
  40
  41 #ifndef _HID_CLASS_COMMON_H_
  42 #define _HID_CLASS_COMMON_H_
  43
  44         /* Includes: */
  45                 #include "../../USB.h"
  46
  47                 #include <string.h>
  48
  49         /* Preprocessor Checks: */
  50                 #if !defined(__INCLUDE_FROM_HID_DRIVER)
  51                         #error Do not include this file directly. Include LUFA/Drivers/Class/HID.h instead.
  52                 #endif
  53
  54         /* Macros: */
  55                 /** HID Class Specific Request to get the current HID report from the device. */
  56                 #define REQ_GetReport                   0x01
  57
  58                 /** HID Class Specific Request to get the current device idle count. */
  59                 #define REQ_GetIdle                     0x02
  60
  61                 /** HID Class Specific Request to set the current HID report to the device. */
  62                 #define REQ_SetReport                   0x09
  63
  64                 /** HID Class Specific Request to set the device's idle count. */
  65                 #define REQ_SetIdle                     0x0A
  66
  67                 /** HID Class Specific Request to get the current HID report protocol mode. */
  68                 #define REQ_GetProtocol                 0x03
  69
  70                 /** HID Class Specific Request to set the current HID report protocol mode. */
  71                 #define REQ_SetProtocol                 0x0B
  72
  73                 /** Descriptor header type value, to indicate a HID class HID descriptor. */
  74                 #define DTYPE_HID                       0x21
  75
  76                 /** Descriptor header type value, to indicate a HID class HID report descriptor. */
  77                 #define DTYPE_Report                    0x22
  78
  79                 /** Constant for the protocol value of a HID interface descriptor, indicating that the interface does not support
  80                  *  any HID class boot protocol (see HID Class Specification).
  81                  */
  82                 #define HID_NON_BOOT_PROTOCOL           0x00
  83
  84                 /** Constant for the protocol value of a HID interface descriptor, indicating that the interface supports the
  85                  *  HID class Keyboard boot protocol (see HID Class Specification).
  86                  */
  87                 #define HID_BOOT_KEYBOARD_PROTOCOL      0x01
  88
  89                 /** Constant for the protocol value of a HID interface descriptor, indicating that the interface supports the
  90                  *  HID class Mouse boot protocol (see HID Class Specification).
  91                  */
  92                 #define HID_BOOT_MOUSE_PROTOCOL         0x02
  93
  94                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left control key is currently pressed. */
  95                 #define HID_KEYBOARD_MODIFER_LEFTCTRL   (1 << 0)
  96
  97                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left shift key is currently pressed. */
  98                 #define HID_KEYBOARD_MODIFER_LEFTSHIFT  (1 << 1)
  99
 100                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left alt key is currently pressed. */
 101                 #define HID_KEYBOARD_MODIFER_LEFTALT    (1 << 2)
 102
 103                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left GUI key is currently pressed. */
 104                 #define HID_KEYBOARD_MODIFER_LEFTGUI    (1 << 3)
 105
 106                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right control key is currently pressed. */
 107                 #define HID_KEYBOARD_MODIFER_RIGHTCTRL  (1 << 4)
 108
 109                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right shift key is currently pressed. */
 110                 #define HID_KEYBOARD_MODIFER_RIGHTSHIFT (1 << 5)
 111
 112                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right alt key is currently pressed. */
 113                 #define HID_KEYBOARD_MODIFER_RIGHTALT   (1 << 6)
 114
 115                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */
 116                 #define HID_KEYBOARD_MODIFER_RIGHTGUI   (1 << 7)
 117
 118                 /** Constant for a keyboard output report LED byte, indicating that the host's NUM LOCK mode is currently set. */
 119                 #define HID_KEYBOARD_LED_NUMLOCK        (1 << 0)
 120
 121                 /** Constant for a keyboard output report LED byte, indicating that the host's CAPS LOCK mode is currently set. */
 122                 #define HID_KEYBOARD_LED_CAPSLOCK       (1 << 1)
 123
 124                 /** Constant for a keyboard output report LED byte, indicating that the host's SCROLL LOCK mode is currently set. */
 125                 #define HID_KEYBOARD_LED_SCROLLLOCK     (1 << 2)
 126
 127                 /** Constant for a keyboard output report LED byte, indicating that the host's KATANA mode is currently set. */
 128                 #define HID_KEYBOARD_LED_KATANA         (1 << 3)
 129
 130         /* Type Defines: */
 131                 /** Enum for the different types of HID reports. */
 132                 enum HID_ReportItemTypes_t
 133                 {
 134                         REPORT_ITEM_TYPE_In                   = 0, /**< Indicates that the item is an IN report type. */
 135                         REPORT_ITEM_TYPE_Out                  = 1, /**< Indicates that the item is an OUT report type. */
 136                         REPORT_ITEM_TYPE_Feature              = 2, /**< Indicates that the item is a FEATURE report type. */
 137                 };
 138
 139                 /** Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID
 140                  *  specification for details on the structure elements.
 141                  */
 142                 typedef struct
 143                 {
 144                         USB_Descriptor_Header_t  Header;
 145
 146                         uint16_t                 HIDSpec;
 147                         uint8_t                  CountryCode;
 148
 149                         uint8_t                  TotalReportDescriptors;
 150
 151                         uint8_t                  HIDReportType;
 152                         uint16_t                 HIDReportLength;
 153                 } USB_HID_Descriptor_t;
 154
 155                 /** Type define for a standard Boot Protocol Mouse report */
 156                 typedef struct
 157                 {
 158                         uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */
 159                         int8_t  X; /**< Current delta X movement of the mouse */
 160                         int8_t  Y; /**< Current delta Y movement on the mouse */
 161                 } USB_MouseReport_Data_t;
 162
 163                 /** Type define for a standard Boot Protocol Keyboard report */
 164                 typedef struct
 165                 {
 166                         uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of
 167                                            *   HID_KEYBOARD_MODIFER_* masks)
 168                                            */
 169                         uint8_t Reserved; /**< Reserved for OEM use, always set to 0 */
 170                         uint8_t KeyCode[6]; /**< Key codes of the currently pressed keys */
 171                 } USB_KeyboardReport_Data_t;
 172
 173                 /** Type define for the data type used to store HID report descriptor elements. */
 174                 typedef uint8_t USB_Descriptor_HIDReport_Datatype_t;
 175
 176 #endif
 177
 178 /** @} */