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 /** \ingroup Group_USBClassRNDIS
  32  *  @defgroup Group_USBClassRNDISDevice RNDIS Class Device 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/Device/RNDIS.c
  37  *
  38  *  \section Module Description
  39  *  Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef _RNDIS_CLASS_DEVICE_H_
  45 #define _RNDIS_CLASS_DEVICE_H_
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/RNDIS.h"
  50
  51                 #include <string.h>
  52
  53         /* Enable C linkage for C++ Compilers: */
  54                 #if defined(__cplusplus)
  55                         extern "C" {
  56                 #endif
  57
  58         /* Preprocessor Checks: */
  59                 #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)
  60                         #error Do not include this file directly. Include LUFA/Drivers/Class/RNDIS.h instead.
  61                 #endif
  62
  63         /* Public Interface - May be used in end-application: */
  64                 /* Type Defines: */
  65                         /** Class state structure. An instance of this structure should be made for each RNDIS interface
  66                          *  within the user application, and passed to each of the RNDIS class driver functions as the
  67                          *  RNDISInterfaceInfo parameter. This stores each RNDIS interface's configuration and state information.
  68                          */
  69                         typedef struct
  70                         {
  71                                 const struct
  72                                 {
  73                                         uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */
  74
  75                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */
  76                                         uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */
  77                                         bool     DataINEndpointDoubleBank; /** Indicates if the RNDIS interface's IN data endpoint should use double banking */
  78
  79                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */
  80                                         uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */
  81                                         bool     DataOUTEndpointDoubleBank; /** Indicates if the RNDIS interface's OUT data endpoint should use double banking */
  82
  83                                         uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */
  84                                         uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
  85                                         bool     NotificationEndpointDoubleBank; /** Indicates if the RNDIS interface's notification endpoint should use double banking */
  86
  87                                         char*         AdapterVendorDescription; /**< String description of the adapter vendor */
  88                                         MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter */
  89                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  90                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  91                                            */
  92                                 struct
  93                                 {
  94                                         uint8_t  RNDISMessageBuffer[RNDIS_MESSAGE_BUFFER_SIZE]; /**< Buffer to hold RNDIS messages to and from the host,
  95                                                                                                                                                          *   managed by the class driver
  96                                                                                                                                                          */
  97                                         bool     ResponseReady; /**< Internal flag indicating if a RNDIS message is waiting to be returned to the host */
  98                                         uint8_t  CurrRNDISState; /**< Current RNDIS state of the adapter, a value from the RNDIS_States_t enum */
  99                                         uint32_t CurrPacketFilter; /**< Current packet filter mode, used internally by the class driver */
 100                                         Ethernet_Frame_Info_t FrameIN; /**< Structure holding the last received Ethernet frame from the host, for user
 101                                                                                                         *   processing
 102                                                                                                         */
 103                                         Ethernet_Frame_Info_t FrameOUT; /**< Structure holding the next Ethernet frame to send to the host, populated by the
 104                                                                                                          *   user application
 105                                                                                                          */
 106                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 107                                           *   are reset to their defaults when the interface is enumerated.
 108                                           */
 109                         } USB_ClassInfo_RNDIS_Device_t;
 110
 111                 /* Function Prototypes: */
 112                         /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library
 113                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
 114                          *  containing the given HID interface is selected.
 115                          *
 116                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state
 117                          *
 118                          *  \return Boolean true if the endpoints were successfully configured, false otherwise
 119                          */
 120                         bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 121
 122                         /** Processes incoming control requests from the host, that are directed to the given RNDIS class interface. This should be
 123                          *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
 124                          *
 125                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state
 126                          */
 127                         void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 128
 129                         /** General management task for a given HID class interface, required for the correct operation of the interface. This should
 130                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 131                          *
 132                          *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state
 133                          */
 134                         void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 135
 136         /* Private Interface - For use in library only: */
 137         #if !defined(__DOXYGEN__)
 138                 /* Function Prototypes: */
 139                 #if defined(__INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)
 140                         static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo)
 141                                                                             ATTR_NON_NULL_PTR_ARG(1);
 142                         static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo,
 143                                                                   const uint32_t OId, void* const QueryData, const uint16_t QuerySize,
 144                                                                                               void* ResponseData, uint16_t* const ResponseSize) ATTR_NON_NULL_PTR_ARG(1)
 145                                                                   ATTR_NON_NULL_PTR_ARG(5) ATTR_NON_NULL_PTR_ARG(6);
 146                         static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, const uint32_t OId,
 147                                                                 void* SetData, const uint16_t SetSize) ATTR_NON_NULL_PTR_ARG(1)
 148                                                                 ATTR_NON_NULL_PTR_ARG(3);
 149                 #endif
 150
 151         #endif
 152
 153         /* Disable C linkage for C++ Compilers: */
 154                 #if defined(__cplusplus)
 155                         }
 156                 #endif
 157
 158 #endif
 159
 160 /** @} */