projects / pub / USBasp.git / blob
? search:


fc9b4b325dc66c1e49ff1815a2776b556ea03d9c
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / RNDIS.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 /** \ingroup Group_USBClassRNDIS
32 * @defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver
33 *
34 * \section Sec_Dependencies Module Source Dependencies
35 * The following files must be built with any user project that uses this module:
36 * - LUFA/Drivers/USB/Class/Host/RNDIS.c
37 *
38 * \section Module Description
39 * Host Mode USB Class driver framework interface, for the Microsoft RNDIS Ethernet
40 * USB Class driver.
41 *
42 * @{
43 */
44
45 #ifndef __RNDIS_CLASS_HOST_H__
46 #define __RNDIS_CLASS_HOST_H__
47
48 /* Includes: */
49 #include "../../USB.h"
50 #include "../Common/RNDIS.h"
51
52 #include <stdio.h>
53 #include <string.h>
54
55 /* Enable C linkage for C++ Compilers: */
56 #if defined(__cplusplus)
57 extern "C" {
58 #endif
59
60 /* Public Interface - May be used in end-application: */
61 /* Type Defines: */
62 /** Class state structure. An instance of this structure should be made within the user application,
63 * and passed to each of the RNDIS class driver functions as the RNDISInterfaceInfo parameter. This
64 * stores each RNDIS interface's configuration and state information.
65 */
66 typedef struct
67 {
68 const struct
69 {
70 uint8_t DataINPipeNumber; /**< Pipe number of the RNDIS interface's IN data pipe */
71 bool DataINPipeDoubleBank; /** Indicates if the RNDIS interface's IN data pipe should use double banking */
72
73 uint8_t DataOUTPipeNumber; /**< Pipe number of the RNDIS interface's OUT data pipe */
74 bool DataOUTPipeDoubleBank; /** Indicates if the RNDIS interface's OUT data pipe should use double banking */
75
76 uint8_t NotificationPipeNumber; /**< Pipe number of the RNDIS interface's IN notification endpoint, if used */
77 bool NotificationPipeDoubleBank; /** Indicates if the RNDIS interface's notification pipe should use double banking */
78
79 uint32_t HostMaxPacketSize; /**< Maximum size of a packet which can be buffered by the host */
80 } Config; /**< Config data for the USB class interface within the device. All elements in this section
81 * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
82 */
83 struct
84 {
85 bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
86 * after \ref RNDIS_Host_ConfigurePipes() is called and the Host state machine is in the
87 * Configured state
88 */
89 uint8_t ControlInterfaceNumber; /**< Interface index of the RNDIS control interface within the attached device */
90
91 uint16_t DataINPipeSize; /**< Size in bytes of the RNDIS interface's IN data pipe */
92 uint16_t DataOUTPipeSize; /**< Size in bytes of the RNDIS interface's OUT data pipe */
93 uint16_t NotificationPipeSize; /**< Size in bytes of the RNDIS interface's IN notification pipe, if used */
94
95 bool BidirectionalDataEndpoints; /**< Indicates if the attached RNDIS interface uses bidirectional data endpoints,
96 * and this has only the IN pipe configured (with \ref Pipe_SetPipeToken()
97 * used to switch the pipe's direction)
98 */
99 uint32_t DeviceMaxPacketSize; /**< Maximum size of a packet which can be buffered by the attached RNDIS device */
100
101 uint32_t RequestID; /**< Request ID counter to give a unique ID for each command/response pair */
102 } State; /**< State data for the USB class interface within the device. All elements in this section
103 * <b>may</b> be set to initial values, but may also be ignored to default to sane values when
104 * the interface is enumerated.
105 */
106 } USB_ClassInfo_RNDIS_Host_t;
107
108 /* Enums: */
109 /** Enum for the possible error codes returned by the \ref RNDIS_Host_ConfigurePipes() function. */
110 enum RNDISHost_EnumerationFailure_ErrorCodes_t
111 {
112 RNDIS_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */
113 RNDIS_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */
114 RNDIS_ENUMERROR_NoRNDISInterfaceFound = 2, /**< A compatible RNDIS interface was not found in the device's Configuration Descriptor */
115 RNDIS_ENUMERROR_EndpointsNotFound = 3, /**< Compatible RNDIS endpoints were not found in the device's RNDIS interface */
116 };
117
118 /* Macros: */
119 /** Additional error code for RNDIS functions when a device returns a logical command failure */
120 #define RNDIS_COMMAND_FAILED 0xC0
121
122 /* Function Prototypes: */
123 /** Host interface configuration routine, to configure a given RNDIS host interface instance using the Configuration
124 * Descriptor read from an attached USB device. This function automatically updates the given RNDIS Host instance's
125 * state values and configures the pipes required to communicate with the interface if it is found within the device.
126 * This should be called once after the stack has enumerated the attached device, while the host state machine is in
127 * the Addressed state.
128 *
129 * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
130 * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor
131 * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
132 *
133 * \return A value from the \ref RNDISHost_EnumerationFailure_ErrorCodes_t enum
134 */
135 uint8_t RNDIS_Host_ConfigurePipes(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, uint16_t ConfigDescriptorSize,
136 void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
137
138 /** Sends a RNDIS KEEPALIVE command to the device, to ensure that it does not enter standby mode after periods
139 * of long inactivity.
140 *
141 * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
142 *
143 * \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
144 * logical command failure
145 */
146 uint8_t RNDIS_Host_SendKeepAlive(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
147
148 /** Initializes the attached RNDIS device's RNDIS interface. This should be called after the device's pipes have been
149 * configured via the call to \ref RNDIS_Host_ConfigurePipes().
150 *
151 * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
152 *
153 * \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
154 * logical command failure
155 */
156 uint8_t RNDIS_Host_InitializeDevice(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
157
158 /** Sets a given RNDIS property of an attached RNDIS device.
159 *
160 * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
161 * \param[in] Oid OID number of the parameter to set
162 * \param[in] Buffer Pointer to where the property data is to be sourced from
163 * \param[in] Length Length in bytes of the property data to sent to the device
164 *
165 * \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
166 * logical command failure
167 */
168 uint8_t RNDIS_Host_SetRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, uint32_t Oid, void* Buffer,
169 uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
170
171 /** Gets a given RNDIS property of an attached RNDIS device.
172 *
173 * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
174 * \param[in] Oid OID number of the parameter to get
175 * \param[in] Buffer Pointer to where the property data is to be written to
176 * \param[in] MaxLength Length in bytes of the destination buffer size
177 *
178 * \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
179 * logical command failure
180 */
181 uint8_t RNDIS_Host_QueryRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, uint32_t Oid, void* Buffer,
182 uint16_t MaxLength) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
183
184 /** Determines if a packet is currently waiting for the host to read in and process.
185 *
186 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
187 * call will fail.
188 *
189 * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
190 *
191 * \return Boolean true if a packet is waiting to be read in by the host, false otherwise
192 */
193
194 bool RNDIS_Host_IsPacketReceived(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo);
195
196 /** Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave
197 * only the packet contents for processing by the host in the nominated buffer.
198 *
199 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
200 * call will fail.
201 *
202 * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
203 * \param[out] Buffer Pointer to a buffer where the packer data is to be written to
204 * \param[out] PacketLength Pointer to where the length in bytes of the read packet is to be stored
205 *
206 * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
207 */
208 uint8_t RNDIS_Host_ReadPacket(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, void* Buffer, uint16_t* PacketLength)
209 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(3);
210
211 /** Sends the given packet to the attached RNDIS device, after adding a RNDIS packet message header.
212 *
213 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
214 * call will fail.
215 *
216 * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
217 * \param[in] Buffer Pointer to a buffer where the packer data is to be read from
218 * \param[in] PacketLength Length in bytes of the packet to send
219 *
220 * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
221 */
222 uint8_t RNDIS_Host_SendPacket(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, void* Buffer, uint16_t PacketLength)
223 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
224
225 /* Inline Functions: */
226 /** General management task for a given RNDIS host class interface, required for the correct operation of the interface. This should
227 * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
228 *
229 * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
230 */
231 static inline void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo);
232 static inline void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo)
233 {
234 (void)RNDISInterfaceInfo;
235 }
236
237 /* Private Interface - For use in library only: */
238 #if !defined(__DOXYGEN__)
239 /* Macros: */
240 #define RNDIS_CONTROL_CLASS 0x02
241 #define RNDIS_CONTROL_SUBCLASS 0x02
242 #define RNDIS_CONTROL_PROTOCOL 0xFF
243 #define RNDIS_DATA_CLASS 0x0A
244 #define RNDIS_DATA_SUBCLASS 0x00
245 #define RNDIS_DATA_PROTOCOL 0x00
246
247 #define RNDIS_FOUND_DATAPIPE_IN (1 << 0)
248 #define RNDIS_FOUND_DATAPIPE_OUT (1 << 1)
249 #define RNDIS_FOUND_NOTIFICATION_IN (1 << 2)
250
251 /* Function Prototypes: */
252 #if defined(INCLUDE_FROM_RNDIS_CLASS_HOST_C)
253 static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
254 void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
255 static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
256 void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
257
258 static uint8_t DComp_RNDIS_Host_NextRNDISControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
259 static uint8_t DComp_RNDIS_Host_NextRNDISDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
260 static uint8_t DComp_RNDIS_Host_NextRNDISInterfaceEndpoint(void* const CurrentDescriptor);
261 #endif
262 #endif
263
264 /* Disable C linkage for C++ Compilers: */
265 #if defined(__cplusplus)
266 }
267 #endif
268
269 #endif
270
271 /** @} */
USB isp AVR programmer