More improvements to the incomplete BluetoothHost demo - add Disconnection Event...

[pub/USBasp.git] / 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 9b65596..4a5ccfa 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.h
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *  \brief Host mode driver for the library USB Still Image Class driver.\r
+ *\r
+ *  Host mode driver for the library USB Still Image Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/StillImage.h.\r
+ */\r
+\r
 /** \ingroup Group_USBClassSI\r
  *  @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver\r
  *\r
@@ -53,12 +62,23 @@
                        extern "C" {\r
                #endif\r
 \r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_SI_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/StillImage.h instead.\r
+               #endif\r
+               \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Error code for some Still Image Host functions, indicating a logical (and not hardware) error */\r
                        #define SI_ERROR_LOGICAL_CMD_FAILED              0x80\r
 \r
                /* Type Defines: */\r
+                       /** \brief Still Image Class Host Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made within the user application,\r
+                        *  and passed to each of the Still Image class driver functions as the SIInterfaceInfo parameter. This\r
+                        *  stores each Still Image interface's configuration and state information.\r
+                        */\r
                        typedef struct\r
                        {\r
                                const struct\r
@@ -108,15 +128,6 @@
                        };\r
 \r
                /* Function Prototypes: */\r
-                       /** General management task for a given Still Image host class interface, required for the correct operation of the\r
-                        *  interface. This should be called frequently in the main program loop, before the master USB management task\r
-                        *  \ref USB_USBTask().\r
-                        *\r
-                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
-                        */\r
-                       void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
-\r
                        /** Host interface configuration routine, to configure a given Still Image host interface instance using the\r
                         *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Still\r
                         *  Image Host instance's state values and configures the pipes required to communicate with the interface if it is\r
@@ -268,7 +279,20 @@
                         */\r
                        uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer,\r
                                                     const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
-                       \r
+               \r
+               /* Inline Functions: */\r
+                       /** General management task for a given Still Image host class interface, required for the correct operation of the\r
+                        *  interface. This should be called frequently in the main program loop, before the master USB management task\r
+                        *  \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        */\r
+                       static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo);\r
+                       static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)\r
+                       {\r
+                               (void)SIInterfaceInfo;\r
+                       }               \r
+\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
@@ -283,7 +307,7 @@
                        #define COMMAND_DATA_TIMEOUT_MS        10000\r
                \r
                /* Function Prototypes: */\r
-                       #if defined(INCLUDE_FROM_SI_CLASS_HOST_C)\r
+                       #if defined(__INCLUDE_FROM_SI_CLASS_HOST_C)\r
                                static uint8_t DComp_SI_Host_NextSIInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
                                static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
                        #endif\r