RNDIS.h 7.57 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
/*
             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.
*/

31
32
/** \ingroup Group_USBClassRNDIS
 *  @defgroup Group_USBClassRNDISDevice RNDIS Class Device Mode Driver
33
34
 *
 *  \section Module Description
35
 *  Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.
36
37
38
39
 *
 *  @{
 */

40
41
#ifndef _RNDIS_CLASS_DEVICE_H_
#define _RNDIS_CLASS_DEVICE_H_
42
43

	/* Includes: */
44
		#include "../../USB.h"
45
		#include "../Common/RNDIS.h"
46
		#include "RNDISConstants.h"
47
		
48
49
		#include <string.h>
	
50
51
52
53
54
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

55
	/* Public Interface - May be used in end-application: */
56
57
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
		/* Type Defines: */
			/** Configuration information structure for \ref USB_ClassInfo_RNDIS_Device_t RNDIS device interface structures. */
			typedef struct
			{
				uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */

				uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */
				uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */

				uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */
				uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */

				uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */
				uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
				
				char*         AdapterVendorDescription; /**< String description of the adapter vendor */
				MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter */
			} USB_ClassInfo_MS_Device_Config_t;
			
			/** Current State information structure for \ref USB_ClassInfo_RNDIS_Device_t RNDIS device interface structures. */
			typedef struct
			{
				uint8_t  RNDISMessageBuffer[RNDIS_MESSAGE_BUFFER_SIZE]; /**< Buffer to hold RNDIS messages to and from the host,
																		 *   managed by the class driver
																		 */
				bool     ResponseReady; /**< Internal flag indicating if a RNDIS message is waiting to be returned to the host */
				uint8_t  CurrRNDISState; /**< Current RNDIS state of the adapter, a value from the RNDIS_States_t enum */
				uint32_t CurrPacketFilter; /**< Current packet filter mode, used internally by the class driver */
				Ethernet_Frame_Info_t FrameIN; /**< Structure holding the last received Ethernet frame from the host, for user
												*   processing
												*/
				Ethernet_Frame_Info_t FrameOUT; /**< Structure holding the next Ethernet frame to send to the host, populated by the
												 *   user application
												 */
			} USB_ClassInfo_MS_Device_State_t;
					 
			/** Class state structure. An instance of this structure should be made for each RNDIS interface
			 *  within the user application, and passed to each of the RNDIS class driver functions as the
			 *  RNDISInterfaceInfo parameter. This stores each RNDIS interface's configuration and state information.
			 */
			typedef struct
			{
				const USB_ClassInfo_MS_Device_Config_t Config; /**< Config data for the USB class interface within
				                                                *   the device. All elements in this section
				                                                *   <b>must</b> be set or the interface will fail
				                                                *   to enumerate and operate correctly.
				                                                */
															 
				USB_ClassInfo_MS_Device_State_t State; /**< State data for the USB class interface within
				                                        *   the device. All elements in this section
				                                        *   <b>may</b> be set to initial values, but may
				                                        *   also be ignored to default to sane values when
				                                        *   the interface is enumerated.
				                                        */
			} USB_ClassInfo_RNDIS_Device_t;
	
112
113
114
115
116
117
118
119
120
		/* Function Prototypes: */
			/** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library
			 *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration
			 *  containing the given HID interface is selected.
			 *
			 *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
			 *
			 *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
			 */
121
			bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);
122
123
124
125
126
127

			/** Processes incomming control requests from the host, that are directed to the given RNDIS class interface. This should be
			 *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
			 *
			 *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
			 */		
128
			void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);
129
130
131
132
133
134
			
			/** General management task for a given HID class interface, required for the correct operation of the interface. This should
			 *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
			 *
			 *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
			 */
135
			void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);
136
137
138
139
		
	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Function Prototypes: */
140
		#if defined(INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)
141
142
			static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);
			static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo, 
143
144
			                                          uint32_t OId, void* QueryData, uint16_t QuerySize,
										              void* ResponseData, uint16_t* ResponseSize);
145
			static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo, uint32_t OId,
146
			                                        void* SetData, uint16_t SetSize);	
147
		#endif
148
		
149
150
	#endif
	
151
152
153
154
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
155
156
		
#endif
157
158

/** @} */