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


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