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         /* Macros: */
  50                 /** HID Class Specific Request to get the current HID report from the device. */
  51                 #define REQ_GetReport                   0x01
  52
  53                 /** HID Class Specific Request to get the current device idle count. */
  54                 #define REQ_GetIdle                     0x02
  55
  56                 /** HID Class Specific Request to set the current HID report to the device. */
  57                 #define REQ_SetReport                   0x09
  58
  59                 /** HID Class Specific Request to set the device's idle count. */
  60                 #define REQ_SetIdle                     0x0A
  61
  62                 /** HID Class Specific Request to get the current HID report protocol mode. */
  63                 #define REQ_GetProtocol                 0x03
  64
  65                 /** HID Class Specific Request to set the current HID report protocol mode. */
  66                 #define REQ_SetProtocol                 0x0B
  67
  68                 /** Descriptor header type value, to indicate a HID class HID descriptor. */
  69                 #define DTYPE_HID                       0x21
  70
  71                 /** Descriptor header type value, to indicate a HID class HID report descriptor. */
  72                 #define DTYPE_Report                    0x22
  73
  74                 /** Constant for the protocol value of a HID interface descriptor, indicating that the interface does not support
  75                  *  any HID class boot protocol (see HID Class Specification).
  76                  */
  77                 #define HID_NON_BOOT_PROTOCOL           0x00
  78
  79                 /** Constant for the protocol value of a HID interface descriptor, indicating that the interface supports the
  80                  *  HID class Keyboard boot protocol (see HID Class Specification).
  81                  */
  82                 #define HID_BOOT_KEYBOARD_PROTOCOL      0x01
  83
  84                 /** Constant for the protocol value of a HID interface descriptor, indicating that the interface supports the
  85                  *  HID class Mouse boot protocol (see HID Class Specification).
  86                  */
  87                 #define HID_BOOT_MOUSE_PROTOCOL         0x02
  88
  89                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left control key is currently pressed. */
  90                 #define HID_KEYBOARD_MODIFER_LEFTCTRL   (1 << 0)
  91
  92                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left shift key is currently pressed. */
  93                 #define HID_KEYBOARD_MODIFER_LEFTSHIFT  (1 << 1)
  94
  95                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left alt key is currently pressed. */
  96                 #define HID_KEYBOARD_MODIFER_LEFTALT    (1 << 2)
  97
  98                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left GUI key is currently pressed. */
  99                 #define HID_KEYBOARD_MODIFER_LEFTGUI    (1 << 3)
 100
 101                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right control key is currently pressed. */
 102                 #define HID_KEYBOARD_MODIFER_RIGHTCTRL  (1 << 4)
 103
 104                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right shift key is currently pressed. */
 105                 #define HID_KEYBOARD_MODIFER_RIGHTSHIFT (1 << 5)
 106
 107                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right alt key is currently pressed. */
 108                 #define HID_KEYBOARD_MODIFER_RIGHTALT   (1 << 6)
 109
 110                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */
 111                 #define HID_KEYBOARD_MODIFER_RIGHTGUI   (1 << 7)
 112
 113                 /** Constant for a keyboard output report LED byte, indicating that the host's NUM LOCK mode is currently set. */
 114                 #define HID_KEYBOARD_LED_NUMLOCK        (1 << 0)
 115
 116                 /** Constant for a keyboard output report LED byte, indicating that the host's CAPS LOCK mode is currently set. */
 117                 #define HID_KEYBOARD_LED_CAPSLOCK       (1 << 1)
 118
 119                 /** Constant for a keyboard output report LED byte, indicating that the host's SCROLL LOCK mode is currently set. */
 120                 #define HID_KEYBOARD_LED_SCROLLLOCK     (1 << 2)
 121
 122                 /** Constant for a keyboard output report LED byte, indicating that the host's KATANA mode is currently set. */
 123                 #define HID_KEYBOARD_LED_KATANA         (1 << 3)
 124
 125         /* Type Defines: */
 126                 /** Enum for the different types of HID reports. */
 127                 enum HID_ReportItemTypes_t
 128                 {
 129                         REPORT_ITEM_TYPE_In                   = 0, /**< Indicates that the item is an IN report type. */
 130                         REPORT_ITEM_TYPE_Out                  = 1, /**< Indicates that the item is an OUT report type. */
 131                         REPORT_ITEM_TYPE_Feature              = 2, /**< Indicates that the item is a FEATURE report type. */
 132                 };
 133
 134                 /** Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID
 135                  *  specification for details on the structure elements.
 136                  */
 137                 typedef struct
 138                 {
 139                         USB_Descriptor_Header_t  Header;
 140
 141                         uint16_t                 HIDSpec;
 142                         uint8_t                  CountryCode;
 143
 144                         uint8_t                  TotalReportDescriptors;
 145
 146                         uint8_t                  HIDReportType;
 147                         uint16_t                 HIDReportLength;
 148                 } USB_HID_Descriptor_t;
 149
 150                 /** Type define for a standard Boot Protocol Mouse report */
 151                 typedef struct
 152                 {
 153                         uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */
 154                         int8_t  X; /**< Current delta X movement of the mouse */
 155                         int8_t  Y; /**< Current delta Y movement on the mouse */
 156                 } USB_MouseReport_Data_t;
 157
 158                 /** Type define for a standard Boot Protocol Keyboard report */
 159                 typedef struct
 160                 {
 161                         uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of
 162                                            *   HID_KEYBOARD_MODIFER_* masks)
 163                                            */
 164                         uint8_t Reserved; /**< Reserved for OEM use, always set to 0 */
 165                         uint8_t KeyCode[6]; /**< Key codes of the currently pressed keys */
 166                 } USB_KeyboardReport_Data_t;
 167
 168                 /** Type define for the data type used to store HID report descriptor elements. */
 169                 typedef uint8_t USB_Descriptor_HIDReport_Datatype_t;
 170
 171 #endif
 172
 173 /** @} */