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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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_USBClassRNDISHost_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/RNDISClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_USBClassRNDISHost_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/RNDISClassCommon.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                                 struct
  82                                 {
  83                                         USB_Pipe_Table_t DataINPipe; /**< Data IN Pipe configuration table. */
  84                                         USB_Pipe_Table_t DataOUTPipe; /**< Data OUT Pipe configuration table. */
  85                                         USB_Pipe_Table_t NotificationPipe; /**< Notification IN Pipe configuration table. */
  86
  87                                         uint32_t HostMaxPacketSize; /**< Maximum size of a packet which can be buffered by the host. */
  88                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  89                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  90                                            */
  91                                 struct
  92                                 {
  93                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  94                                                         *   after \ref RNDIS_Host_ConfigurePipes() is called and the Host state machine is in the
  95                                                         *   Configured state.
  96                                                         */
  97                                         uint8_t ControlInterfaceNumber; /**< Interface index of the RNDIS control interface within the attached device. */
  98
  99                                         uint32_t DeviceMaxPacketSize; /**< Maximum size of a packet which can be buffered by the attached RNDIS device. */
 100
 101                                         uint32_t RequestID; /**< Request ID counter to give a unique ID for each command/response pair. */
 102                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 103                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 104                                                   *   the interface is enumerated.
 105                                                   */
 106                         } USB_ClassInfo_RNDIS_Host_t;
 107
 108                 /* Enums: */
 109                         /** Enum for the possible error codes returned by the \ref RNDIS_Host_ConfigurePipes() function. */
 110                         enum RNDIS_Host_EnumerationFailure_ErrorCodes_t
 111                         {
 112                                 RNDIS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
 113                                 RNDIS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
 114                                 RNDIS_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible RNDIS interface was not found in the device's Configuration Descriptor. */
 115                                 RNDIS_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
 116                         };
 117
 118                 /* Function Prototypes: */
 119                         /** Host interface configuration routine, to configure a given RNDIS host interface instance using the Configuration
 120                          *  Descriptor read from an attached USB device. This function automatically updates the given RNDIS Host instance's
 121                          *  state values and configures the pipes required to communicate with the interface if it is found within the device.
 122                          *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
 123                          *  the Addressed state.
 124                          *
 125                          *  \param[in,out] RNDISInterfaceInfo    Pointer to a structure containing an RNDIS Class host configuration and state.
 126                          *  \param[in]     ConfigDescriptorSize  Length of the attached device's Configuration Descriptor.
 127                          *  \param[in]     ConfigDescriptorData  Pointer to a buffer containing the attached device's Configuration Descriptor.
 128                          *
 129                          *  \return A value from the \ref RNDIS_Host_EnumerationFailure_ErrorCodes_t enum.
 130                          */
 131                         uint8_t RNDIS_Host_ConfigurePipes(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
 132                                                           uint16_t ConfigDescriptorSize,
 133                                                           void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 134
 135                         /** Sends a RNDIS KEEPALIVE command to the device, to ensure that it does not enter standby mode after periods
 136                          *  of long inactivity.
 137                          *
 138                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
 139                          *
 140                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the device returned a
 141                          *          logical command failure.
 142                          */
 143                         uint8_t RNDIS_Host_SendKeepAlive(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 144
 145                         /** Initializes the attached RNDIS device's RNDIS interface. This should be called after the device's pipes have been
 146                          *  configured via the call to \ref RNDIS_Host_ConfigurePipes().
 147                          *
 148                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
 149                          *
 150                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the
 151                          *          device returned a logical command failure.
 152                          */
 153                         uint8_t RNDIS_Host_InitializeDevice(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 154
 155                         /** Sets a given RNDIS property of an attached RNDIS device.
 156                          *
 157                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
 158                          *  \param[in]     Oid                 OID number of the parameter to set.
 159                          *  \param[in]     Buffer              Pointer to where the property data is to be sourced from.
 160                          *  \param[in]     Length              Length in bytes of the property data to sent to the device.
 161                          *
 162                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the
 163                          *          device returned a logical command failure.
 164                          */
 165                         uint8_t RNDIS_Host_SetRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
 166                                                             const uint32_t Oid,
 167                                                             void* Buffer,
 168                                                             const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 169
 170                         /** Gets a given RNDIS property of an attached RNDIS device.
 171                          *
 172                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
 173                          *  \param[in]     Oid                 OID number of the parameter to get.
 174                          *  \param[in]     Buffer              Pointer to where the property data is to be written to.
 175                          *  \param[in]     MaxLength           Length in bytes of the destination buffer size.
 176                          *
 177                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the
 178                          *          device returned a logical command failure.
 179                          */
 180                         uint8_t RNDIS_Host_QueryRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
 181                                                               const uint32_t Oid,
 182                                                               void* Buffer,
 183                                                               const uint16_t MaxLength) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 184
 185                         /** Determines if a packet is currently waiting for the host to read in and process.
 186                          *
 187                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 188                          *       call will fail.
 189                          *
 190                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
 191                          *
 192                          *  \return Boolean \c true if a packet is waiting to be read in by the host, \c false otherwise.
 193                          */
 194                         bool RNDIS_Host_IsPacketReceived(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 195
 196                         /** Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave
 197                          *  only the packet contents for processing by the host in the nominated buffer.
 198                          *
 199                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 200                          *       call will fail.
 201                          *
 202                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
 203                          *  \param[out]    Buffer              Pointer to a buffer where the packer data is to be written to.
 204                          *  \param[out]    PacketLength        Pointer to where the length in bytes of the read packet is to be stored.
 205                          *
 206                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 207                          */
 208                         uint8_t RNDIS_Host_ReadPacket(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
 209                                                       void* Buffer,
 210                                                       uint16_t* const PacketLength) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2)
 211                                                       ATTR_NON_NULL_PTR_ARG(3);
 212
 213                         /** Sends the given packet to the attached RNDIS device, after adding a RNDIS packet message header.
 214                          *
 215                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 216                          *       call will fail.
 217                          *
 218                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
 219                          *  \param[in]     Buffer              Pointer to a buffer where the packer data is to be read from.
 220                          *  \param[in]     PacketLength        Length in bytes of the packet to send.
 221                          *
 222                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 223                          */
 224                         uint8_t RNDIS_Host_SendPacket(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
 225                                                       void* Buffer,
 226                                                       const uint16_t PacketLength) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 227
 228                 /* Inline Functions: */
 229                         /** General management task for a given RNDIS host class interface, required for the correct operation of the interface. This should
 230                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 231                          *
 232                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state.
 233                          */
 234                         static inline void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 235                         static inline void RNDIS_Host_USBTask(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo)
 236                         {
 237                                 (void)RNDISInterfaceInfo;
 238                         }
 239
 240         /* Private Interface - For use in library only: */
 241         #if !defined(__DOXYGEN__)
 242                 /* Function Prototypes: */
 243                         #if defined(__INCLUDE_FROM_RNDIS_HOST_C)
 244                                 static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
 245                                                                              void* Buffer,
 246                                                                              const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1)
 247                                                                              ATTR_NON_NULL_PTR_ARG(2);
 248                                 static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
 249                                                                              void* Buffer,
 250                                                                              const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1)
 251                                                                              ATTR_NON_NULL_PTR_ARG(2);
 252
 253                                 static uint8_t DCOMP_RNDIS_Host_NextRNDISControlInterface(void* const CurrentDescriptor)
 254                                                                                           ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 255                                 static uint8_t DCOMP_RNDIS_Host_NextRNDISDataInterface(void* const CurrentDescriptor)
 256                                                                                        ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 257                                 static uint8_t DCOMP_RNDIS_Host_NextRNDISInterfaceEndpoint(void* const CurrentDescriptor)
 258                                                                                            ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 259                         #endif
 260         #endif
 261
 262         /* Disable C linkage for C++ Compilers: */
 263                 #if defined(__cplusplus)
 264                         }
 265                 #endif
 266
 267 #endif
 268
 269 /** @} */
 270