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