LUFA/Drivers/USB/Class/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_USBClassDrivers
  32  *  @defgroup Group_USBClassRNDIS RNDIS Device Class Driver - LUFA/Drivers/Class/RNDIS.h
  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  *  RNDIS Class Driver module. This module contains an internal implementation of the Microsoft USB RNDIS Networking
  40  *  Class, for Device USB mode only. User applications can use this class driver instead of implementing the RNDIS
  41  *  class manually via the low-level LUFA APIs.
  42  *
  43  *  This module is designed to simplify the user code by exposing only the required interface needed to interace with
  44  *  Hosts using the USB RNDIS Class.
  45  *
  46  *  @{
  47  */
  48
  49 #ifndef _RNDIS_CLASS_H_
  50 #define _RNDIS_CLASS_H_
  51
  52         /* Includes: */
  53                 #include "../HighLevel/USBMode.h"
  54
  55                 #if defined(USB_CAN_BE_DEVICE)
  56                         #include "Device/RNDIS.h"
  57                 #endif
  58
  59 #endif
  60
  61 /** @} */