Demos/Host/KeyboardHostWithParser/ConfigDescriptor.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 /** \file
  32  *
  33  *  Header file for ConfigDescriptor.c.
  34  */
  35
  36 #ifndef _CONFIGDESCRIPTOR_H_
  37 #define _CONFIGDESCRIPTOR_H_
  38
  39         /* Includes: */
  40                 #include <LUFA/Drivers/USB/USB.h>                        // USB Functionality
  41
  42                 #include "HIDReport.h"
  43
  44         /* Macros: */
  45                 /** Interface Class value for the Human Interface Device class */
  46                 #define KEYBOARD_CLASS                 0x03
  47
  48                 /** Interface Protocol value for a Boot Protocol Keyboard compliant device */
  49                 #define KEYBOARD_PROTOCOL              0x01
  50
  51                 /** Maximum size of a device configuration descriptor which can be processed by the host, in bytes */
  52                 #define MAX_CONFIG_DESCRIPTOR_SIZE     512
  53
  54                 /** Descriptor header type constant for a HID descriptor */
  55                 #define DTYPE_HID                      0x21
  56
  57                 /** Descriptor header type constant for a HID report descriptor */
  58                 #define DTYPE_Report                   0x22
  59
  60         /* Enums: */
  61                 enum KeyboardHostWithParser_GetConfigDescriptorDataCodes_t
  62                 {
  63                         SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
  64                         ControlError                    = 1, /**< A control request to the device failed to complete successfully */
  65                         DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
  66                         InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */
  67                         NoHIDInterfaceFound             = 4, /**< A compatible HID interface was not found in the device's Configuration Descriptor */
  68                         NoHIDDescriptorFound            = 5, /**< A compatible HID descriptor was not found in the device's HID interface */
  69                         NoEndpointFound                 = 5, /**< A compatible HID IN endpoint was not found in the device's HID interface */
  70                 };
  71
  72         /* Configuration Descriptor Comparison Functions: */
  73                 DESCRIPTOR_COMPARATOR(NextKeyboardInterface);
  74                 DESCRIPTOR_COMPARATOR(NextInterfaceKeyboardDataEndpoint);
  75                 DESCRIPTOR_COMPARATOR(NextHID);
  76
  77         /* Function Prototypes: */
  78                 uint8_t ProcessConfigurationDescriptor(void);
  79
  80 #endif