Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 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 #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                 /** Interface Class value for the Printer Device class */
  42                 #define PRINTER_CLASS                    0x07
  43
  44                 /** Interface Subclass value for the Printer Device class */
  45                 #define PRINTER_SUBCLASS                 0x01
  46
  47                 /** Interface Protocol value for a Bidirectional communication encapsulation */
  48                 #define PRINTER_PROTOCOL                 0x02
  49
  50                 /** Maximum size of a device configuration descriptor which can be processed by the host, in bytes */
  51                 #define MAX_CONFIG_DESCRIPTOR_SIZE       512
  52
  53         /* Enums: */
  54                 /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */
  55                 enum PrinterHost_GetConfigDescriptorDataCodes_t
  56                 {
  57                         SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
  58                         ControlError                    = 1, /**< A control request to the device failed to complete successfully */
  59                         DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
  60                         InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */
  61                         NoInterfaceFound                = 4, /**< A compatible printer interface was not found in the device's Configuration Descriptor */
  62                         NoEndpointFound                 = 5, /**< The printer data endpoints were not found in the device's Configuration Descriptor */
  63                 };
  64
  65         /* External Variables: */
  66                 /** Interface index of the Bidirectional Printer interface within the device, once the Configuration
  67                  *  Descriptor has been processed.
  68                  */
  69                 uint8_t PrinterInterfaceNumber;
  70
  71                 /** Interface Alternate Setting index of the Bidirectional Printer interface within the device, once
  72                  *  the Configuration Descriptor has been processed.
  73                  */
  74                 uint8_t PrinterAltSetting;
  75
  76         /* Function Prototypes: */
  77                 uint8_t ProcessConfigurationDescriptor(void);
  78
  79                 uint8_t DComp_NextBidirectionalPrinterInterface(void* CurrentDescriptor);
  80                 uint8_t DComp_NextPrinterInterfaceBulkDataEndpoint(void* CurrentDescriptor);
  81
  82 #endif