Blame view

lufa-master/Demos/Host/LowLevel/VirtualSerialHost/ConfigDescriptor.h 2.66 KB
142ecdaf   rguillom   first commit
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
  /*
               LUFA Library
       Copyright (C) Dean Camera, 2019.
  
    dean [at] fourwalledcubicle [dot] com
             www.lufa-lib.org
  */
  
  /*
    Copyright 2019  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  
    Permission to use, copy, modify, distribute, and sell this
    software and its documentation for any purpose is hereby granted
    without fee, 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 disclaims 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: */
  		#include <LUFA/Drivers/USB/USB.h>
  
  		#include "VirtualSerialHost.h"
  
  	/* Macros: */
  		/** Pipe address for the CDC data IN pipe. */
  		#define CDC_DATA_IN_PIPE               (PIPE_DIR_IN  | 1)
  
  		/** Pipe address for the CDC data OUT pipe. */
  		#define CDC_DATA_OUT_PIPE              (PIPE_DIR_OUT | 2)
  
  		/** Pipe address for the CDC notification IN pipe. */
  		#define CDC_NOTIFICATION_PIPE          (PIPE_DIR_IN  | 3)
  
  	/* Enums: */
  		/** Enum for the possible return codes of the \ref 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 */
  			NoCompatibleInterfaceFound      = 4, /**< A compatible interface with the required endpoints was not found */
  		};
  
  	/* Function Prototypes: */
  		uint8_t ProcessConfigurationDescriptor(void);
  
  		uint8_t DComp_NextCDCControlInterface(void* CurrentDescriptor);
  		uint8_t DComp_NextCDCDataInterface(void* CurrentDescriptor);
  		uint8_t DComp_NextCDCDataInterfaceEndpoint(void* CurrentDescriptor);
  
  #endif