LUFA/Drivers/USB/Class/Device/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 Device mode driver for the library USB RNDIS Class driver.
  33  *
  34  *  Device 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_USBClassRNDISDevice RNDIS Class Device 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/Device/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_ModDescription Module Description
  48  *  Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef _RNDIS_CLASS_DEVICE_H_
  54 #define _RNDIS_CLASS_DEVICE_H_
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/RNDIS.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)
  67                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  68                 #endif
  69
  70         /* Public Interface - May be used in end-application: */
  71                 /* Type Defines: */
  72                         /** \brief RNDIS Class Device Mode Configuration and State Structure.
  73                          *
  74                          *  Class state structure. An instance of this structure should be made for each RNDIS interface
  75                          *  within the user application, and passed to each of the RNDIS class driver functions as the
  76                          *  \c RNDISInterfaceInfo parameter. This stores each RNDIS interface's configuration and state information.
  77                          */
  78                         typedef struct
  79                         {
  80                                 const struct
  81                                 {
  82                                         uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device. */
  83
  84                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint. */
  85                                         uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint. */
  86                                         bool     DataINEndpointDoubleBank; /**< Indicates if the RNDIS interface's IN data endpoint should use double banking. */
  87
  88                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint. */
  89                                         uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint. */
  90                                         bool     DataOUTEndpointDoubleBank; /**< Indicates if the RNDIS interface's OUT data endpoint should use double banking. */
  91
  92                                         uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used. */
  93                                         uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used. */
  94                                         bool     NotificationEndpointDoubleBank; /**< Indicates if the RNDIS interface's notification endpoint should use double banking. */
  95
  96                                         char*         AdapterVendorDescription; /**< String description of the adapter vendor. */
  97                                         MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter. */
  98                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section.
  99                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
 100                                            */
 101                                 struct
 102                                 {
 103                                         uint8_t  RNDISMessageBuffer[RNDIS_MESSAGE_BUFFER_SIZE]; /**< Buffer to hold RNDIS messages to and from the host,
 104                                                                                                                                                          *   managed by the class driver.
 105                                                                                                                                                          */
 106                                         bool     ResponseReady; /**< Internal flag indicating if a RNDIS message is waiting to be returned to the host. */
 107                                         uint8_t  CurrRNDISState; /**< Current RNDIS state of the adapter, a value from the \ref RNDIS_States_t enum. */
 108                                         uint32_t CurrPacketFilter; /**< Current packet filter mode, used internally by the class driver. */
 109                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 110                                           *   are reset to their defaults when the interface is enumerated.
 111                                           */
 112                         } USB_ClassInfo_RNDIS_Device_t;
 113
 114                 /* Function Prototypes: */
 115                         /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library
 116                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
 117                          *  containing the given HID interface is selected.
 118                          *
 119                          *  \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
 120                          *        interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
 121                          *        within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
 122                          *
 123                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
 124                          *
 125                          *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
 126                          */
 127                         bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 128
 129                         /** Processes incoming control requests from the host, that are directed to the given RNDIS class interface. This should be
 130                          *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
 131                          *
 132                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
 133                          */
 134                         void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 135
 136                         /** General management task for a given HID class interface, required for the correct operation of the interface. This should
 137                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 138                          *
 139                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
 140                          */
 141                         void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 142
 143                         /** Determines if a packet is currently waiting for the device to read in and process.
 144                          *
 145                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or the
 146                          *       call will fail.
 147                          *
 148                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class configuration and state.
 149                          *
 150                          *  \return Boolean \c true if a packet is waiting to be read in by the host, \c false otherwise.
 151                          */
 152                         bool RNDIS_Device_IsPacketReceived(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo);
 153
 154                         /** Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave
 155                          *  only the packet contents for processing by the device in the nominated buffer.
 156                          *
 157                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or the
 158                          *       call will fail.
 159                          *
 160                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class configuration and state.
 161                          *  \param[out]    Buffer              Pointer to a buffer where the packer data is to be written to.
 162                          *  \param[out]    PacketLength        Pointer to where the length in bytes of the read packet is to be stored.
 163                          *
 164                          *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
 165                          */
 166                         uint8_t RNDIS_Device_ReadPacket(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo,
 167                                                                                         void* Buffer,
 168                                                                                         uint16_t* const PacketLength);
 169
 170                         /** Sends the given packet to the attached RNDIS device, after adding a RNDIS packet message header.
 171                          *
 172                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or the
 173                          *       call will fail.
 174                          *
 175                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class configuration and state.
 176                          *  \param[in]     Buffer              Pointer to a buffer where the packer data is to be read from.
 177                          *  \param[in]     PacketLength        Length in bytes of the packet to send.
 178                          *
 179                          *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
 180                          */
 181                         uint8_t RNDIS_Device_SendPacket(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo,
 182                                                                                         void* Buffer,
 183                                                                                         const uint16_t PacketLength);
 184
 185         /* Private Interface - For use in library only: */
 186         #if !defined(__DOXYGEN__)
 187                 /* Function Prototypes: */
 188                 #if defined(__INCLUDE_FROM_RNDIS_DEVICE_C)
 189                         static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo)
 190                                                                             ATTR_NON_NULL_PTR_ARG(1);
 191                         static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo,
 192                                                                   const uint32_t OId,
 193                                                       void* const QueryData,
 194                                                       const uint16_t QuerySize,
 195                                                                                               void* ResponseData,
 196                                                       uint16_t* const ResponseSize) ATTR_NON_NULL_PTR_ARG(1)
 197                                                                   ATTR_NON_NULL_PTR_ARG(5) ATTR_NON_NULL_PTR_ARG(6);
 198                         static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo,
 199                                                     const uint32_t OId,
 200                                                                 const void* SetData,
 201                                                     const uint16_t SetSize) ATTR_NON_NULL_PTR_ARG(1)
 202                                                                 ATTR_NON_NULL_PTR_ARG(3);
 203                 #endif
 204
 205         #endif
 206
 207         /* Disable C linkage for C++ Compilers: */
 208                 #if defined(__cplusplus)
 209                         }
 210                 #endif
 211
 212 #endif
 213
 214 /** @} */
 215