text: /* Copyright (c) 2010-2011 mbed.org, MIT License
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
  * and associated documentation files (the "Software"), to deal in the Software without
  * restriction, including without limitation the rights to use, copy, modify, merge, publish,
  * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
  * Software is furnished to do so, subject to the following conditions:
  *
  * The above copyright notice and this permission notice shall be included in all copies or
  * substantial portions of the Software.
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
  
  #ifndef USBCLASS_HID_TYPES
  #define USBCLASS_HID_TYPES
  
  #include <stdint.h>
  
  /* */
  #define HID_VERSION_1_11    (0x0111)
  
  /* HID Class */
  #define HID_CLASS           (3)
  #define HID_SUBCLASS_NONE   (0)
  #define HID_PROTOCOL_NONE   (0)
  
  /* Descriptors */
  #define HID_DESCRIPTOR          (33)
  #define HID_DESCRIPTOR_LENGTH   (0x09)
  #define REPORT_DESCRIPTOR       (34)
  
  /* Class requests */
  #define GET_REPORT (0x1)
  #define GET_IDLE   (0x2)
  #define SET_REPORT (0x9)
  #define SET_IDLE   (0xa)
  
  /* HID Class Report Descriptor */
  /* Short items: size is 0, 1, 2 or 3 specifying 0, 1, 2 or 4 (four) bytes */
  /* of data as per HID Class standard */
  
  /* Main items */
  #define INPUT(size)             (0x80 | size)
  #define OUTPUT(size)            (0x90 | size)
  #define FEATURE(size)           (0xb0 | size)
  #define COLLECTION(size)        (0xa0 | size)
  #define END_COLLECTION(size)    (0xc0 | size)
  
  /* Global items */
  #define USAGE_PAGE(size)        (0x04 | size)
  #define LOGICAL_MINIMUM(size)   (0x14 | size)
  #define LOGICAL_MAXIMUM(size)   (0x24 | size)
  #define PHYSICAL_MINIMUM(size)  (0x34 | size)
  #define PHYSICAL_MAXIMUM(size)  (0x44 | size)
  #define UNIT_EXPONENT(size)     (0x54 | size)
  #define UNIT(size)              (0x64 | size)
  #define REPORT_SIZE(size)       (0x74 | size)
  #define REPORT_ID(size)         (0x84 | size)
  #define REPORT_COUNT(size)      (0x94 | size)
  #define PUSH(size)              (0xa4 | size)
  #define POP(size)               (0xb4 | size)
  
  /* Local items */
  #define USAGE(size)                 (0x08 | size)
  #define USAGE_MINIMUM(size)         (0x18 | size)
  #define USAGE_MAXIMUM(size)         (0x28 | size)
  #define DESIGNATOR_INDEX(size)      (0x38 | size)
  #define DESIGNATOR_MINIMUM(size)    (0x48 | size)
  #define DESIGNATOR_MAXIMUM(size)    (0x58 | size)
  #define STRING_INDEX(size)          (0x78 | size)
  #define STRING_MINIMUM(size)        (0x88 | size)
  #define STRING_MAXIMUM(size)        (0x98 | size)
  #define DELIMITER(size)             (0xa8 | size)
  
  /* HID Report */
  /* Where report IDs are used the first byte of 'data' will be the */
  /* report ID and 'length' will include this report ID byte. */
  
  #define MAX_HID_REPORT_SIZE (116)
  
  typedef struct {
      uint32_t length;
      uint8_t data[MAX_HID_REPORT_SIZE];
  } HID_REPORT;
  
  #endif
  