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