lib/lufa/Demos/Host/LowLevel/KeyboardHostWithParser/ConfigDescriptor.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 2017  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 disclaims 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>
  41
  42                 #include "HIDReport.h"
  43
  44         /* Macros: */
  45                 /** Pipe address for the keyboard report data IN pipe. */
  46                 #define KEYBOARD_DATA_IN_PIPE          (PIPE_DIR_IN | 1)
  47
  48         /* Enums: */
  49                 /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */
  50                 enum KeyboardHostWithParser_GetConfigDescriptorDataCodes_t
  51                 {
  52                         SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
  53                         ControlError                    = 1, /**< A control request to the device failed to complete successfully */
  54                         DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
  55                         InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */
  56                         NoCompatibleInterfaceFound      = 4, /**< A compatible interface with the required endpoints was not found */
  57                 };
  58
  59         /* Function Prototypes: */
  60                 uint8_t ProcessConfigurationDescriptor(void);
  61
  62                 uint8_t DComp_NextKeyboardInterface(void* CurrentDescriptor);
  63                 uint8_t DComp_NextKeyboardInterfaceDataEndpoint(void* CurrentDescriptor);
  64                 uint8_t DComp_NextHID(void* CurrentDescriptor);
  65
  66 #endif
  67