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