X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/431db89b00408197976d653d89d15eeef8172e1b..e55f33866334615e705ff68c0f3bea8e5b1b9b8b:/LUFA/Drivers/USB/Class/Host/RNDIS.h diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h index 0110b5a0d..f64710d5b 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h @@ -28,6 +28,15 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB RNDIS Class driver. + * + * Host mode driver for the library USB RNDIS Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h. + */ + /** \ingroup Group_USBClassRNDIS * @defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver * @@ -57,9 +66,16 @@ extern "C" { #endif + /* Preprocessor Checks: */ + #if !defined(__INCLUDE_FROM_RNDIS_DRIVER) + #error Do not include this file directly. Include LUFA/Drivers/Class/RNDIS.h instead. + #endif + /* Public Interface - May be used in end-application: */ /* Type Defines: */ - /** Class state structure. An instance of this structure should be made within the user application, + /** \brief RNDIS Class Host Mode Configuration and State Structure. + * + * Class state structure. An instance of this structure should be made within the user application, * and passed to each of the RNDIS class driver functions as the RNDISInterfaceInfo parameter. This * stores each RNDIS interface's configuration and state information. */ @@ -245,7 +261,7 @@ #define RNDIS_FOUND_NOTIFICATION_IN (1 << 2) /* Function Prototypes: */ - #if defined(INCLUDE_FROM_RNDIS_CLASS_HOST_C) + #if defined(__INCLUDE_FROM_RNDIS_CLASS_HOST_C) static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,