Demos/Host/LowLevel/VirtualSerialHost/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 /** \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 "VirtualSerialHost.h"
  43
  44         /* Macros: */
  45                 /** Interface Class value for the CDC class */
  46                 #define CDC_CONTROL_CLASS              0x02
  47
  48                 /** Interface Class value for the CDC Communication Interface subclass */
  49                 #define CDC_CONTROL_SUBCLASS           0x02
  50
  51                 /** Interface Class value for the CDC protocol */
  52                 #define CDC_CONTROL_PROTOCOL           0x01
  53
  54                 /** Interface Class value for the CDC data class */
  55                 #define CDC_DATA_CLASS                 0x0A
  56
  57                 /** Interface Class value for the CDC data subclass */
  58                 #define CDC_DATA_SUBCLASS              0x00
  59
  60                 /** Interface Class value for the CDC data protocol */
  61                 #define CDC_DATA_PROTOCOL              0x00
  62
  63                 /** Maximum size of a device configuration descriptor which can be processed by the host, in bytes */
  64                 #define MAX_CONFIG_DESCRIPTOR_SIZE     512
  65
  66         /* Enums: */
  67                 /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */
  68                 enum CDCHost_GetConfigDescriptorDataCodes_t
  69                 {
  70                         SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
  71                         ControlError                    = 1, /**< A control request to the device failed to complete successfully */
  72                         DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
  73                         InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */
  74                         NoCDCInterfaceFound             = 4, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
  75                         NoEndpointFound                 = 5, /**< Compatible CDC endpoints were not found in the device's CDC interface */
  76                 };
  77
  78         /* Function Prototypes: */
  79                 uint8_t ProcessConfigurationDescriptor(void);
  80
  81                 uint8_t DComp_NextCDCControlInterface(void* CurrentDescriptor);
  82                 uint8_t DComp_NextCDCDataInterface(void* CurrentDescriptor);
  83                 uint8_t DComp_NextCDCDataInterfaceEndpoint(void* CurrentDescriptor);
  84
  85 #endif