LUFA/Drivers/USB/Class/Device/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 /** \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 class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/RNDIS.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 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                 #include <string.h>
  61
  62         /* Enable C linkage for C++ Compilers: */
  63                 #if defined(__cplusplus)
  64                         extern "C" {
  65                 #endif
  66
  67         /* Preprocessor Checks: */
  68                 #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)
  69                         #error Do not include this file directly. Include LUFA/Drivers/Class/RNDIS.h instead.
  70                 #endif
  71
  72         /* Public Interface - May be used in end-application: */
  73                 /* Type Defines: */
  74                         /** \brief RNDIS Class Device Mode Configuration and State Structure.
  75                          *
  76                          *  Class state structure. An instance of this structure should be made for each RNDIS interface
  77                          *  within the user application, and passed to each of the RNDIS class driver functions as the
  78                          *  RNDISInterfaceInfo parameter. This stores each RNDIS interface's configuration and state information.
  79                          */
  80                         typedef struct
  81                         {
  82                                 const struct
  83                                 {
  84                                         uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device. */
  85
  86                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint. */
  87                                         uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint. */
  88                                         bool     DataINEndpointDoubleBank; /**< Indicates if the RNDIS interface's IN data endpoint should use double banking. */
  89
  90                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint. */
  91                                         uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint. */
  92                                         bool     DataOUTEndpointDoubleBank; /**< Indicates if the RNDIS interface's OUT data endpoint should use double banking. */
  93
  94                                         uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used. */
  95                                         uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used. */
  96                                         bool     NotificationEndpointDoubleBank; /**< Indicates if the RNDIS interface's notification endpoint should use double banking. */
  97
  98                                         char*         AdapterVendorDescription; /**< String description of the adapter vendor. */
  99                                         MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter. */
 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                                         uint8_t  RNDISMessageBuffer[RNDIS_MESSAGE_BUFFER_SIZE]; /**< Buffer to hold RNDIS messages to and from the host,
 106                                                                                                                                                          *   managed by the class driver.
 107                                                                                                                                                          */
 108                                         bool     ResponseReady; /**< Internal flag indicating if a RNDIS message is waiting to be returned to the host. */
 109                                         uint8_t  CurrRNDISState; /**< Current RNDIS state of the adapter, a value from the RNDIS_States_t enum. */
 110                                         uint32_t CurrPacketFilter; /**< Current packet filter mode, used internally by the class driver. */
 111                                         Ethernet_Frame_Info_t FrameIN; /**< Structure holding the last received Ethernet frame from the host, for user
 112                                                                                                         *   processing.
 113                                                                                                         */
 114                                         Ethernet_Frame_Info_t FrameOUT; /**< Structure holding the next Ethernet frame to send to the host, populated by the
 115                                                                                                          *   user application.
 116                                                                                                          */
 117                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 118                                           *   are reset to their defaults when the interface is enumerated.
 119                                           */
 120                         } USB_ClassInfo_RNDIS_Device_t;
 121
 122                 /* Function Prototypes: */
 123                         /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library
 124                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
 125                          *  containing the given HID interface is selected.
 126                          *
 127                          *  \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
 128                          *        interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
 129                          *        within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
 130                          *
 131                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
 132                          *
 133                          *  \return Boolean true if the endpoints were successfully configured, false otherwise.
 134                          */
 135                         bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 136
 137                         /** Processes incoming control requests from the host, that are directed to the given RNDIS class interface. This should be
 138                          *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
 139                          *
 140                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
 141                          */
 142                         void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 143
 144                         /** General management task for a given HID class interface, required for the correct operation of the interface. This should
 145                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 146                          *
 147                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
 148                          */
 149                         void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 150
 151         /* Private Interface - For use in library only: */
 152         #if !defined(__DOXYGEN__)
 153                 /* Function Prototypes: */
 154                 #if defined(__INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)
 155                         static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo)
 156                                                                             ATTR_NON_NULL_PTR_ARG(1);
 157                         static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo,
 158                                                                   const uint32_t OId,
 159                                                       void* const QueryData,
 160                                                       const uint16_t QuerySize,
 161                                                                                               void* ResponseData,
 162                                                       uint16_t* const ResponseSize) ATTR_NON_NULL_PTR_ARG(1)
 163                                                                   ATTR_NON_NULL_PTR_ARG(5) ATTR_NON_NULL_PTR_ARG(6);
 164                         static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo,
 165                                                     const uint32_t OId,
 166                                                                 const void* SetData,
 167                                                     const uint16_t SetSize) ATTR_NON_NULL_PTR_ARG(1)
 168                                                                 ATTR_NON_NULL_PTR_ARG(3);
 169                 #endif
 170
 171         #endif
 172
 173         /* Disable C linkage for C++ Compilers: */
 174                 #if defined(__cplusplus)
 175                         }
 176                 #endif
 177
 178 #endif
 179
 180 /** @} */