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