Fix MassStorageKeyboard demo USE_INTERNAL_SERIAL check being performed before the required library headers were included, causing a compilation error.

Added notes to the class driver functions indicating which functions require what Device/Host state machine states to function.

1 files changed, 34 insertions, 4 deletions

diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h
index 5dec6f06b..9b655967f 100644
--- a/LUFA/Drivers/USB/Class/Host/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.h
@@ -134,7 +134,10 @@
 

 			/** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands

 			 *  are issued to the device. Only one session can be open at the one time.

-			 *			 

+			 *	

+			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the

+			 *        call will fail.

+			 *

 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state

 			 *

 			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device

@@ -144,7 +147,10 @@
 

 			/** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated

 			 *  PIMA commands have been issued to the device.

-			 *			 

+			 *

+			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the

+			 *        call will fail.

+			 *

 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state

 			 *

 			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device

@@ -155,6 +161,9 @@
 			/** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send

 			 *  arbitrary PIMA blocks to the device with or without parameters.

 			 *

+			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the

+			 *        call will fail.

+			 *

 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state

 			 *  \param[in] PIMAHeader  Pointer to a PIMA container structure that is to be sent

 			 *

@@ -165,6 +174,9 @@
 			/** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with

 			 *  or without parameters.

 			 *

+			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the

+			 *        call will fail.

+			 *

 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state

 			 *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the received block is to be stored

 			 *

@@ -173,7 +185,10 @@
 			uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);

 

 			/** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.

-			 *			 

+			 *	

+			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the

+			 *        call will fail.

+			 *

 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state

 			 *  \param[in] Operation  PIMA operation code to issue to the device

 			 *  \param[in] TotalParams  Total number of 32-bit parameters to send to the device in the issued command block

@@ -187,7 +202,10 @@
 

 			/** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data

 			 *  associated with the command has been transferred.

-			 *			 

+			 *	

+			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the

+			 *        call will fail.

+			 *

 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state

 			 *

 			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device

@@ -197,6 +215,9 @@
 

 			/** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.

 			 *

+			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the

+			 *        call will fail.

+			 *

 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state

 			 *

 			 *  \return Boolean true if an event is waiting to be read, false otherwise

@@ -205,6 +226,9 @@
 

 			/** Receives an asynchronous event block from the device via the asynchronous events pipe.

 			 *

+			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the

+			 *        call will fail.

+			 *

 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state

 			 *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the event should be stored

 			 *

@@ -218,6 +242,9 @@
 			/** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data

 			 *  transfer beyond the regular PIMA command block parameters.

 			 *

+			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the

+			 *        call will fail.

+			 *

 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state

 			 *  \param[in] Buffer  Pointer to a buffer where the data to send has been stored

 			 *  \param[in] Bytes  Length in bytes of the data in the buffer to send to the attached device

@@ -230,6 +257,9 @@
 			/** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data

 			 *  transfer beyond the regular PIMA command block parameters.

 			 *

+			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the

+			 *        call will fail.

+			 *

 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state

 			 *  \param[out] Buffer  Pointer to a buffer where the received data is to be stored

 			 *  \param[in] Bytes  Length in bytes of the data to read