X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/60e96412220b62a614348c287354c56f282fcc70..fd96b288824caaa3ee4e5e03887f016de9df80cf:/LUFA/Drivers/USB/Class/Host/StillImage.h diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h index b6a24757c..4a5ccfabd 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.h +++ b/LUFA/Drivers/USB/Class/Host/StillImage.h @@ -28,6 +28,15 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB Still Image Class driver. + * + * Host mode driver for the library USB Still Image 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/StillImage.h. + */ + /** \ingroup Group_USBClassSI * @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver * @@ -53,12 +62,23 @@ extern "C" { #endif + /* Preprocessor Checks: */ + #if !defined(__INCLUDE_FROM_SI_DRIVER) + #error Do not include this file directly. Include LUFA/Drivers/Class/StillImage.h instead. + #endif + /* Public Interface - May be used in end-application: */ /* Macros: */ /** Error code for some Still Image Host functions, indicating a logical (and not hardware) error */ #define SI_ERROR_LOGICAL_CMD_FAILED 0x80 /* Type Defines: */ + /** \brief Still Image 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 Still Image class driver functions as the SIInterfaceInfo parameter. This + * stores each Still Image interface's configuration and state information. + */ typedef struct { const struct @@ -287,7 +307,7 @@ #define COMMAND_DATA_TIMEOUT_MS 10000 /* Function Prototypes: */ - #if defined(INCLUDE_FROM_SI_CLASS_HOST_C) + #if defined(__INCLUDE_FROM_SI_CLASS_HOST_C) static uint8_t DComp_SI_Host_NextSIInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1); static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1); #endif