protocol/lufa/LUFA-git/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.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
  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 #ifndef _CONFIGDESCRIPTOR_H_
  32 #define _CONFIGDESCRIPTOR_H_
  33
  34         /* Includes: */
  35                 #include <LUFA/Drivers/USB/USB.h>
  36
  37                 #include "PrinterHost.h"
  38                 #include "Lib/PrinterCommands.h"
  39
  40         /* Macros: */
  41                 /** Pipe address of the Printer data IN pipe. */
  42                 #define PRINTER_DATA_IN_PIPE             (PIPE_DIR_IN  | 1)
  43
  44                 /** Pipe address of the Printer data OUT pipe. */
  45                 #define PRINTER_DATA_OUT_PIPE            (PIPE_DIR_OUT | 2)
  46
  47         /* Enums: */
  48                 /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */
  49                 enum PrinterHost_GetConfigDescriptorDataCodes_t
  50                 {
  51                         SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
  52                         ControlError                    = 1, /**< A control request to the device failed to complete successfully */
  53                         DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
  54                         InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */
  55                         NoCompatibleInterfaceFound      = 4, /**< A compatible interface with the required endpoints was not found */
  56                 };
  57
  58         /* External Variables: */
  59                 /** Interface index of the Bidirectional Printer interface within the device, once the Configuration
  60                  *  Descriptor has been processed.
  61                  */
  62                 extern uint8_t PrinterInterfaceNumber;
  63
  64                 /** Interface Alternate Setting index of the Bidirectional Printer interface within the device, once
  65                  *  the Configuration Descriptor has been processed.
  66                  */
  67                 extern uint8_t PrinterAltSetting;
  68
  69         /* Function Prototypes: */
  70                 uint8_t ProcessConfigurationDescriptor(void);
  71
  72                 uint8_t DComp_NextBidirectionalPrinterInterface(void* CurrentDescriptor);
  73                 uint8_t DComp_NextPrinterInterfaceBulkDataEndpoint(void* CurrentDescriptor);
  74
  75 #endif
  76