LUFA/Drivers/USB/Class/Host/RNDIS.h

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