3 Copyright (C) Dean Camera, 2012.
\r
5 dean [at] fourwalledcubicle [dot] com
\r
10 Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
\r
12 Permission to use, copy, modify, distribute, and sell this
\r
13 software and its documentation for any purpose is hereby granted
\r
14 without fee, provided that the above copyright notice appear in
\r
15 all copies and that both that the copyright notice and this
\r
16 permission notice and warranty disclaimer appear in supporting
\r
17 documentation, and that the name of the author not be used in
\r
18 advertising or publicity pertaining to distribution of the
\r
19 software without specific, written prior permission.
\r
21 The author disclaim all warranties with regard to this
\r
22 software, including all implied warranties of merchantability
\r
23 and fitness. In no event shall the author be liable for any
\r
24 special, indirect or consequential damages or any damages
\r
25 whatsoever resulting from loss of use, data or profits, whether
\r
26 in an action of contract, negligence or other tortious action,
\r
27 arising out of or in connection with the use or performance of
\r
32 * \brief Common definitions and declarations for the library USB RNDIS Class driver.
\r
34 * Common definitions and declarations for the library USB RNDIS Class driver.
\r
36 * \note This file should not be included directly. It is automatically included as needed by the USB module driver
\r
37 * dispatch header located in LUFA/Drivers/USB.h.
\r
40 /** \ingroup Group_USBClassRNDIS
\r
41 * \defgroup Group_USBClassRNDISCommon Common Class Definitions
\r
43 * \section Sec_ModDescription Module Description
\r
44 * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
\r
50 #ifndef _RNDIS_CLASS_COMMON_H_
\r
51 #define _RNDIS_CLASS_COMMON_H_
\r
54 #define __INCLUDE_FROM_CDC_DRIVER
\r
57 #include "../../Core/StdDescriptors.h"
\r
58 #include "CDCClassCommon.h"
\r
60 /* Enable C linkage for C++ Compilers: */
\r
61 #if defined(__cplusplus)
\r
65 /* Preprocessor Checks: */
\r
66 #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)
\r
67 #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
\r
71 /** Additional error code for RNDIS functions when a device returns a logical command failure. */
\r
72 #define RNDIS_ERROR_LOGICAL_CMD_FAILED 0x80
\r
74 /** Implemented RNDIS Version Major. */
\r
75 #define REMOTE_NDIS_VERSION_MAJOR 0x01
\r
77 /** Implemented RNDIS Version Minor. */
\r
78 #define REMOTE_NDIS_VERSION_MINOR 0x00
\r
80 /** \name RNDIS Message Values */
\r
82 #define REMOTE_NDIS_PACKET_MSG 0x00000001UL
\r
83 #define REMOTE_NDIS_INITIALIZE_MSG 0x00000002UL
\r
84 #define REMOTE_NDIS_HALT_MSG 0x00000003UL
\r
85 #define REMOTE_NDIS_QUERY_MSG 0x00000004UL
\r
86 #define REMOTE_NDIS_SET_MSG 0x00000005UL
\r
87 #define REMOTE_NDIS_RESET_MSG 0x00000006UL
\r
88 #define REMOTE_NDIS_INDICATE_STATUS_MSG 0x00000007UL
\r
89 #define REMOTE_NDIS_KEEPALIVE_MSG 0x00000008UL
\r
92 /** \name RNDIS Response Values */
\r
94 #define REMOTE_NDIS_INITIALIZE_CMPLT 0x80000002UL
\r
95 #define REMOTE_NDIS_QUERY_CMPLT 0x80000004UL
\r
96 #define REMOTE_NDIS_SET_CMPLT 0x80000005UL
\r
97 #define REMOTE_NDIS_RESET_CMPLT 0x80000006UL
\r
98 #define REMOTE_NDIS_KEEPALIVE_CMPLT 0x80000008UL
\r
101 /** \name RNDIS Status Values */
\r
103 #define REMOTE_NDIS_STATUS_SUCCESS 0x00000000UL
\r
104 #define REMOTE_NDIS_STATUS_FAILURE 0xC0000001UL
\r
105 #define REMOTE_NDIS_STATUS_INVALID_DATA 0xC0010015UL
\r
106 #define REMOTE_NDIS_STATUS_NOT_SUPPORTED 0xC00000BBUL
\r
107 #define REMOTE_NDIS_STATUS_MEDIA_CONNECT 0x4001000BUL
\r
108 #define REMOTE_NDIS_STATUS_MEDIA_DISCONNECT 0x4001000CUL
\r
111 /** \name RNDIS Media States */
\r
113 #define REMOTE_NDIS_MEDIA_STATE_CONNECTED 0x00000000UL
\r
114 #define REMOTE_NDIS_MEDIA_STATE_DISCONNECTED 0x00000001UL
\r
117 /** \name RNDIS Media Types */
\r
119 #define REMOTE_NDIS_MEDIUM_802_3 0x00000000UL
\r
122 /** \name RNDIS Connection Types */
\r
124 #define REMOTE_NDIS_DF_CONNECTIONLESS 0x00000001UL
\r
125 #define REMOTE_NDIS_DF_CONNECTION_ORIENTED 0x00000002UL
\r
128 /** \name RNDIS Packet Types */
\r
130 #define REMOTE_NDIS_PACKET_DIRECTED 0x00000001UL
\r
131 #define REMOTE_NDIS_PACKET_MULTICAST 0x00000002UL
\r
132 #define REMOTE_NDIS_PACKET_ALL_MULTICAST 0x00000004UL
\r
133 #define REMOTE_NDIS_PACKET_BROADCAST 0x00000008UL
\r
134 #define REMOTE_NDIS_PACKET_SOURCE_ROUTING 0x00000010UL
\r
135 #define REMOTE_NDIS_PACKET_PROMISCUOUS 0x00000020UL
\r
136 #define REMOTE_NDIS_PACKET_SMT 0x00000040UL
\r
137 #define REMOTE_NDIS_PACKET_ALL_LOCAL 0x00000080UL
\r
138 #define REMOTE_NDIS_PACKET_GROUP 0x00001000UL
\r
139 #define REMOTE_NDIS_PACKET_ALL_FUNCTIONAL 0x00002000UL
\r
140 #define REMOTE_NDIS_PACKET_FUNCTIONAL 0x00004000UL
\r
141 #define REMOTE_NDIS_PACKET_MAC_FRAME 0x00008000UL
\r
144 /** \name RNDIS OID Values */
\r
146 #define OID_GEN_SUPPORTED_LIST 0x00010101UL
\r
147 #define OID_GEN_HARDWARE_STATUS 0x00010102UL
\r
148 #define OID_GEN_MEDIA_SUPPORTED 0x00010103UL
\r
149 #define OID_GEN_MEDIA_IN_USE 0x00010104UL
\r
150 #define OID_GEN_MAXIMUM_FRAME_SIZE 0x00010106UL
\r
151 #define OID_GEN_MAXIMUM_TOTAL_SIZE 0x00010111UL
\r
152 #define OID_GEN_LINK_SPEED 0x00010107UL
\r
153 #define OID_GEN_TRANSMIT_BLOCK_SIZE 0x0001010AUL
\r
154 #define OID_GEN_RECEIVE_BLOCK_SIZE 0x0001010BUL
\r
155 #define OID_GEN_VENDOR_ID 0x0001010CUL
\r
156 #define OID_GEN_VENDOR_DESCRIPTION 0x0001010DUL
\r
157 #define OID_GEN_CURRENT_PACKET_FILTER 0x0001010EUL
\r
158 #define OID_GEN_MAXIMUM_TOTAL_SIZE 0x00010111UL
\r
159 #define OID_GEN_MEDIA_CONNECT_STATUS 0x00010114UL
\r
160 #define OID_GEN_PHYSICAL_MEDIUM 0x00010202UL
\r
161 #define OID_GEN_XMIT_OK 0x00020101UL
\r
162 #define OID_GEN_RCV_OK 0x00020102UL
\r
163 #define OID_GEN_XMIT_ERROR 0x00020103UL
\r
164 #define OID_GEN_RCV_ERROR 0x00020104UL
\r
165 #define OID_GEN_RCV_NO_BUFFER 0x00020105UL
\r
166 #define OID_802_3_PERMANENT_ADDRESS 0x01010101UL
\r
167 #define OID_802_3_CURRENT_ADDRESS 0x01010102UL
\r
168 #define OID_802_3_MULTICAST_LIST 0x01010103UL
\r
169 #define OID_802_3_MAXIMUM_LIST_SIZE 0x01010104UL
\r
170 #define OID_802_3_RCV_ERROR_ALIGNMENT 0x01020101UL
\r
171 #define OID_802_3_XMIT_ONE_COLLISION 0x01020102UL
\r
172 #define OID_802_3_XMIT_MORE_COLLISIONS 0x01020103UL
\r
175 /** Maximum size in bytes of a RNDIS control message which can be sent or received. */
\r
176 #define RNDIS_MESSAGE_BUFFER_SIZE 128
\r
178 /** Maximum size in bytes of an Ethernet frame according to the Ethernet standard. */
\r
179 #define ETHERNET_FRAME_SIZE_MAX 1500
\r
182 /** Enum for the RNDIS class specific control requests that can be issued by the USB bus host. */
\r
183 enum RNDIS_ClassRequests_t
\r
185 RNDIS_REQ_SendEncapsulatedCommand = 0x00, /**< RNDIS request to issue a host-to-device NDIS command. */
\r
186 RNDIS_REQ_GetEncapsulatedResponse = 0x01, /**< RNDIS request to issue a device-to-host NDIS response. */
\r
189 /** Enum for the possible NDIS adapter states. */
\r
190 enum RNDIS_States_t
\r
192 RNDIS_Uninitialized = 0, /**< Adapter currently uninitialized. */
\r
193 RNDIS_Initialized = 1, /**< Adapter currently initialized but not ready for data transfers. */
\r
194 RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers. */
\r
197 /** Enum for the RNDIS class specific notification requests that can be issued by a RNDIS device to a host. */
\r
198 enum RNDIS_ClassNotifications_t
\r
200 RNDIS_NOTIF_ResponseAvailable = 0x01, /**< Notification request value for a RNDIS Response Available notification. */
\r
203 /** Enum for the NDIS hardware states. */
\r
204 enum NDIS_Hardware_Status_t
\r
206 NDIS_HardwareStatus_Ready, /**< Hardware Ready to accept commands from the host. */
\r
207 NDIS_HardwareStatus_Initializing, /**< Hardware busy initializing. */
\r
208 NDIS_HardwareStatus_Reset, /**< Hardware reset. */
\r
209 NDIS_HardwareStatus_Closing, /**< Hardware currently closing. */
\r
210 NDIS_HardwareStatus_NotReady /**< Hardware not ready to accept commands from the host. */
\r
213 /* Type Defines: */
\r
214 /** \brief MAC Address Structure.
\r
216 * Type define for a physical MAC address of a device on a network.
\r
220 uint8_t Octets[6]; /**< Individual bytes of a MAC address */
\r
221 } ATTR_PACKED MAC_Address_t;
\r
223 /** \brief RNDIS Common Message Header Structure.
\r
225 * Type define for a RNDIS message header, sent before RNDIS messages.
\r
227 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
231 uint32_t MessageType; /**< RNDIS message type, a \c REMOTE_NDIS_*_MSG constant */
\r
232 uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */
\r
233 } ATTR_PACKED RNDIS_Message_Header_t;
\r
235 /** \brief RNDIS Message Structure.
\r
237 * Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter.
\r
239 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
243 uint32_t MessageType;
\r
244 uint32_t MessageLength;
\r
245 uint32_t DataOffset;
\r
246 uint32_t DataLength;
\r
247 uint32_t OOBDataOffset;
\r
248 uint32_t OOBDataLength;
\r
249 uint32_t NumOOBDataElements;
\r
250 uint32_t PerPacketInfoOffset;
\r
251 uint32_t PerPacketInfoLength;
\r
254 } ATTR_PACKED RNDIS_Packet_Message_t;
\r
256 /** \brief RNDIS Initialization Message Structure.
\r
258 * Type define for a RNDIS Initialize command message.
\r
260 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
264 uint32_t MessageType;
\r
265 uint32_t MessageLength;
\r
266 uint32_t RequestId;
\r
268 uint32_t MajorVersion;
\r
269 uint32_t MinorVersion;
\r
270 uint32_t MaxTransferSize;
\r
271 } ATTR_PACKED RNDIS_Initialize_Message_t;
\r
273 /** \brief RNDIS Initialize Complete Message Structure.
\r
275 * Type define for a RNDIS Initialize Complete response message.
\r
277 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
281 uint32_t MessageType;
\r
282 uint32_t MessageLength;
\r
283 uint32_t RequestId;
\r
286 uint32_t MajorVersion;
\r
287 uint32_t MinorVersion;
\r
288 uint32_t DeviceFlags;
\r
290 uint32_t MaxPacketsPerTransfer;
\r
291 uint32_t MaxTransferSize;
\r
292 uint32_t PacketAlignmentFactor;
\r
293 uint32_t AFListOffset;
\r
294 uint32_t AFListSize;
\r
295 } ATTR_PACKED RNDIS_Initialize_Complete_t;
\r
297 /** \brief RNDIS Keep Alive Message Structure.
\r
299 * Type define for a RNDIS Keep Alive command message.
\r
301 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
305 uint32_t MessageType;
\r
306 uint32_t MessageLength;
\r
307 uint32_t RequestId;
\r
308 } ATTR_PACKED RNDIS_KeepAlive_Message_t;
\r
310 /** \brief RNDIS Keep Alive Complete Message Structure.
\r
312 * Type define for a RNDIS Keep Alive Complete response message.
\r
314 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
318 uint32_t MessageType;
\r
319 uint32_t MessageLength;
\r
320 uint32_t RequestId;
\r
322 } ATTR_PACKED RNDIS_KeepAlive_Complete_t;
\r
324 /** \brief RNDIS Reset Complete Message Structure.
\r
326 * Type define for a RNDIS Reset Complete response message.
\r
328 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
332 uint32_t MessageType;
\r
333 uint32_t MessageLength;
\r
336 uint32_t AddressingReset;
\r
337 } ATTR_PACKED RNDIS_Reset_Complete_t;
\r
339 /** \brief RNDIS OID Property Set Message Structure.
\r
341 * Type define for a RNDIS OID Property Set command message.
\r
343 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
347 uint32_t MessageType;
\r
348 uint32_t MessageLength;
\r
349 uint32_t RequestId;
\r
352 uint32_t InformationBufferLength;
\r
353 uint32_t InformationBufferOffset;
\r
354 uint32_t DeviceVcHandle;
\r
355 } ATTR_PACKED RNDIS_Set_Message_t;
\r
357 /** \brief RNDIS OID Property Set Complete Message Structure.
\r
359 * Type define for a RNDIS OID Property Set Complete response message.
\r
361 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
365 uint32_t MessageType;
\r
366 uint32_t MessageLength;
\r
367 uint32_t RequestId;
\r
369 } ATTR_PACKED RNDIS_Set_Complete_t;
\r
371 /** \brief RNDIS OID Property Query Message Structure.
\r
373 * Type define for a RNDIS OID Property Query command message.
\r
375 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
379 uint32_t MessageType;
\r
380 uint32_t MessageLength;
\r
381 uint32_t RequestId;
\r
384 uint32_t InformationBufferLength;
\r
385 uint32_t InformationBufferOffset;
\r
386 uint32_t DeviceVcHandle;
\r
387 } ATTR_PACKED RNDIS_Query_Message_t;
\r
389 /** \brief RNDIS OID Property Query Complete Message Structure.
\r
391 * Type define for a RNDIS OID Property Query Complete response message.
\r
393 * \note Regardless of CPU architecture, these values should be stored as little endian.
\r
397 uint32_t MessageType;
\r
398 uint32_t MessageLength;
\r
399 uint32_t RequestId;
\r
402 uint32_t InformationBufferLength;
\r
403 uint32_t InformationBufferOffset;
\r
404 } ATTR_PACKED RNDIS_Query_Complete_t;
\r
406 /* Disable C linkage for C++ Compilers: */
\r
407 #if defined(__cplusplus)
\r