ConfigDescriptor.h 3.33 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, provided that the above copyright notice appear in all
  copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Header file for ConfigDescriptor.c.
 */

#ifndef _CONFIGDESCRIPTOR_H_
#define _CONFIGDESCRIPTOR_H_

	/* Includes: */
40
		#include <LUFA/Drivers/USB/USB.h>
41
		
42
		#include "VirtualSerialHost.h"
43
44
45
46
47
48
49
50
51
52
53
54
55
56
		
	/* Macros: */
		/** Interface Class value for the CDC class */
		#define CDC_CONTROL_CLASS              0x02

		/** Interface Class value for the CDC Communication Interface subclass */
		#define CDC_CONTROL_SUBCLASS           0x02

		/** Interface Class value for the CDC protocol */
		#define CDC_CONTROL_PROTOCOL           0x01
		
		/** Interface Class value for the CDC data class */
		#define CDC_DATA_CLASS                 0x0A

57
		/** Interface Class value for the CDC data subclass */
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
		#define CDC_DATA_SUBCLASS              0x00

		/** Interface Class value for the CDC data protocol */
		#define CDC_DATA_PROTOCOL              0x00

		/** Maximum size of a device configuration descriptor which can be processed by the host, in bytes */
		#define MAX_CONFIG_DESCRIPTOR_SIZE     512
	
	/* Enums: */
		/** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */
		enum CDCHost_GetConfigDescriptorDataCodes_t
		{
			SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
			ControlError                    = 1, /**< A control request to the device failed to complete successfully */
			DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
			InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */
			NoCDCInterfaceFound             = 4, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
			NoEndpointFound                 = 5, /**< Compatible CDC endpoints were not found in the device's CDC interface */
		};

	/* Function Prototypes: */
		uint8_t ProcessConfigurationDescriptor(void);	
		
		uint8_t DComp_NextCDCControlInterface(void* CurrentDescriptor);
		uint8_t DComp_NextCDCDataInterface(void* CurrentDescriptor);
83
		uint8_t DComp_NextCDCDataInterfaceEndpoint(void* CurrentDescriptor);
84
85
		
#endif