Fix MassStorageKeyboard demo USE_INTERNAL_SERIAL check being performed before the...
[pub/lufa.git] / LUFA / Drivers / USB / Class / Host / StillImage.h
index 5dec6f0..9b65596 100644 (file)
 \r
                        /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands\r
                         *  are issued to the device. Only one session can be open at the one time.\r
-                        *                       \r
+                        *      \r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device\r
 \r
                        /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated\r
                         *  PIMA commands have been issued to the device.\r
-                        *                       \r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device\r
                        /** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send\r
                         *  arbitrary PIMA blocks to the device with or without parameters.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         *  \param[in] PIMAHeader  Pointer to a PIMA container structure that is to be sent\r
                         *\r
                        /** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with\r
                         *  or without parameters.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the received block is to be stored\r
                         *\r
                        uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);\r
 \r
                        /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.\r
-                        *                       \r
+                        *      \r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         *  \param[in] Operation  PIMA operation code to issue to the device\r
                         *  \param[in] TotalParams  Total number of 32-bit parameters to send to the device in the issued command block\r
 \r
                        /** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data\r
                         *  associated with the command has been transferred.\r
-                        *                       \r
+                        *      \r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device\r
 \r
                        /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         *\r
                         *  \return Boolean true if an event is waiting to be read, false otherwise\r
 \r
                        /** Receives an asynchronous event block from the device via the asynchronous events pipe.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the event should be stored\r
                         *\r
                        /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data\r
                         *  transfer beyond the regular PIMA command block parameters.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         *  \param[in] Buffer  Pointer to a buffer where the data to send has been stored\r
                         *  \param[in] Bytes  Length in bytes of the data in the buffer to send to the attached device\r
                        /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data\r
                         *  transfer beyond the regular PIMA command block parameters.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         *  \param[out] Buffer  Pointer to a buffer where the received data is to be stored\r
                         *  \param[in] Bytes  Length in bytes of the data to read\r