Projects/Magstripe/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
  11   Copyright 2017  Dean Camera (dean [at] fourwalledcubicle [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 <avr/pgmspace.h>
  42
  43                 #include <LUFA/Drivers/USB/USB.h>
  44
  45                 #include "Config/AppConfig.h"
  46
  47         /* Type Defines: */
  48                 /** Type define for the device configuration descriptor structure. This must be defined in the
  49                  *  application code, as the configuration descriptor contains several sub-descriptors which
  50                  *  vary between devices, and which describe the device's usage to the host.
  51                  */
  52                 typedef struct
  53                 {
  54                         USB_Descriptor_Configuration_Header_t Config; /**< Configuration descriptor header structure */
  55
  56                         // Keyboard HID Interface
  57                         USB_Descriptor_Interface_t            HID_Interface; /**< Keyboard interface descriptor */
  58                         USB_HID_Descriptor_HID_t              HID_KeyboardHID; /**< Keyboard HID descriptor */
  59                         USB_Descriptor_Endpoint_t             HID_ReportINEndpoint; /**< Keyboard key report endpoint descriptor */
  60                 } USB_Descriptor_Configuration_t;
  61
  62                 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
  63                  *  should have a unique ID index associated with it, which can be used to refer to the
  64                  *  interface from other descriptors.
  65                  */
  66                 enum InterfaceDescriptors_t
  67                 {
  68                         INTERFACE_ID_Keyboard = 0, /**< Keyboard interface descriptor ID */
  69                 };
  70
  71                 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
  72                  *  have a unique ID index associated with it, which can be used to refer to the string from
  73                  *  other descriptors.
  74                  */
  75                 enum StringDescriptors_t
  76                 {
  77                         STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
  78                         STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
  79                         STRING_ID_Product      = 2, /**< Product string ID */
  80                 };
  81
  82         /* Macros: */
  83                 /** Endpoint address of the keyboard key press reporting endpoint. */
  84                 #define KEYBOARD_EPADDR              (ENDPOINT_DIR_IN | 1)
  85
  86                 /** Size of the keyboard report endpoints, in bytes. */
  87                 #define KEYBOARD_EPSIZE              8
  88
  89         /* Function Prototypes: */
  90                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
  91                                                     const uint16_t wIndex,
  92                                                     const void** const DescriptorAddress)
  93                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
  94
  95 #endif
  96