LUFA/Drivers/USB/Class/Device/RNDIS.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 Module Description
  35  *  Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.
  36  *
  37  *  @{
  38  */
  39
  40 #ifndef _RNDIS_CLASS_DEVICE_H_
  41 #define _RNDIS_CLASS_DEVICE_H_
  42
  43         /* Includes: */
  44                 #include "../../USB.h"
  45                 #include "../Common/RNDIS.h"
  46                 #include "RNDISConstants.h"
  47
  48                 #include <string.h>
  49
  50         /* Enable C linkage for C++ Compilers: */
  51                 #if defined(__cplusplus)
  52                         extern "C" {
  53                 #endif
  54
  55         /* Public Interface - May be used in end-application: */
  56                 /* Function Prototypes: */
  57                         /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library
  58                          *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration
  59                          *  containing the given HID interface is selected.
  60                          *
  61                          *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
  62                          *
  63                          *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
  64                          */
  65                         bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);
  66
  67                         /** Processes incomming control requests from the host, that are directed to the given RNDIS class interface. This should be
  68                          *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
  69                          *
  70                          *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
  71                          */
  72                         void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);
  73
  74                         /** General management task for a given HID class interface, required for the correct operation of the interface. This should
  75                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
  76                          *
  77                          *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
  78                          */
  79                         void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);
  80
  81         /* Private Interface - For use in library only: */
  82         #if !defined(__DOXYGEN__)
  83                 /* Function Prototypes: */
  84                 #if defined(INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)
  85                         static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo);
  86                         static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo,
  87                                                                   uint32_t OId, void* QueryData, uint16_t QuerySize,
  88                                                                                               void* ResponseData, uint16_t* ResponseSize);
  89                         static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_t* RNDISInterfaceInfo, uint32_t OId,
  90                                                                 void* SetData, uint16_t SetSize);
  91                 #endif
  92
  93         #endif
  94
  95         /* Disable C linkage for C++ Compilers: */
  96                 #if defined(__cplusplus)
  97                         }
  98                 #endif
  99
 100 #endif
 101
 102 /** @} */