tmk_core/protocol/lufa/LUFA-git/Demos/Device/LowLevel/Keyboard/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
  12
  13   Permission to use, copy, modify, distribute, and sell this
  14   software and its documentation for any purpose is hereby granted
  15   without fee, provided that the above copyright notice appear in
  16   all copies and that both that the copyright notice and this
  17   permission notice and warranty disclaimer appear in supporting
  18   documentation, and that the name of the author not be used in
  19   advertising or publicity pertaining to distribution of the
  20   software without specific, written prior permission.
  21
  22   The author disclaims all warranties with regard to this
  23   software, including all implied warranties of merchantability
  24   and fitness.  In no event shall the author be liable for any
  25   special, indirect or consequential damages or any damages
  26   whatsoever resulting from loss of use, data or profits, whether
  27   in an action of contract, negligence or other tortious action,
  28   arising out of or in connection with the use or performance of
  29   this software.
  30 */
  31
  32 /** \file
  33  *
  34  *  Header file for Descriptors.c.
  35  */
  36
  37 #ifndef _DESCRIPTORS_H_
  38 #define _DESCRIPTORS_H_
  39
  40         /* Includes: */
  41                 #include <LUFA/Drivers/USB/USB.h>
  42
  43                 #include <avr/pgmspace.h>
  44
  45         /* Type Defines: */
  46                 /** Type define for the device configuration descriptor structure. This must be defined in the
  47                  *  application code, as the configuration descriptor contains several sub-descriptors which
  48                  *  vary between devices, and which describe the device's usage to the host.
  49                  */
  50                 typedef struct
  51                 {
  52                         USB_Descriptor_Configuration_Header_t Config;
  53
  54                         // Keyboard HID Interface
  55                         USB_Descriptor_Interface_t            HID_Interface;
  56                         USB_HID_Descriptor_HID_t              HID_KeyboardHID;
  57                         USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
  58                         USB_Descriptor_Endpoint_t             HID_ReportOUTEndpoint;
  59                 } USB_Descriptor_Configuration_t;
  60
  61                 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
  62                  *  should have a unique ID index associated with it, which can be used to refer to the
  63                  *  interface from other descriptors.
  64                  */
  65                 enum InterfaceDescriptors_t
  66                 {
  67                         INTERFACE_ID_Keyboard = 0, /**< Keyboard interface descriptor ID */
  68                 };
  69
  70                 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
  71                  *  have a unique ID index associated with it, which can be used to refer to the string from
  72                  *  other descriptors.
  73                  */
  74                 enum StringDescriptors_t
  75                 {
  76                         STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
  77                         STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
  78                         STRING_ID_Product      = 2, /**< Product string ID */
  79                 };
  80
  81         /* Macros: */
  82                 /** Endpoint address of the Keyboard HID reporting IN endpoint. */
  83                 #define KEYBOARD_IN_EPADDR        (ENDPOINT_DIR_IN  | 1)
  84
  85                 /** Endpoint address of the Keyboard HID reporting OUT endpoint. */
  86                 #define KEYBOARD_OUT_EPADDR       (ENDPOINT_DIR_OUT | 2)
  87
  88                 /** Size in bytes of the Keyboard HID reporting IN and OUT endpoints. */
  89                 #define KEYBOARD_EPSIZE           8
  90
  91         /* Function Prototypes: */
  92                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
  93                                                     const uint8_t wIndex,
  94                                                     const void** const DescriptorAddress)
  95                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
  96
  97 #endif
  98