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, 18 insertions, 0 deletions

diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h
index c6ca67c3f..7c304097b 100644
--- a/LUFA/Drivers/USB/Class/Host/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h
@@ -164,6 +164,9 @@
 			/** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and

 			 *  properties.

 			 *

+			 *  \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] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state

 			 *  \param[in] LUNIndex  LUN index within the device the command is being issued to

 			 *  \param[out] InquiryData  Location where the read inquiry data should be stored

@@ -186,6 +189,9 @@
 

 			/** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.

 			 *

+			 *  \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] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state

 			 *  \param[in] LUNIndex  LUN index within the device the command is being issued to

 			 *  \param[out] DeviceCapacity  Pointer to the location where the capacity information should be stored

@@ -199,6 +205,9 @@
 			/** Retrieves the device sense data, indicating the current device state and error codes for the previously

 			 *  issued command.

 			 *

+			 *  \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] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state

 			 *  \param[in] LUNIndex  LUN index within the device the command is being issued to

 			 *  \param[out] SenseData  Pointer to the location where the sense information should be stored

@@ -212,6 +221,9 @@
 			/** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock

 			 *  the device from removal so that blocks of data on the medium can be read or altered.

 			 *

+			 *  \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] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state

 			 *  \param[in] LUNIndex  LUN index within the device the command is being issued to

 			 *  \param[in] PreventRemoval  Boolean true if the device should be locked from removal, false otherwise

@@ -223,6 +235,9 @@
 			

 			/** Reads blocks of data from the attached Mass Storage device's medium.

 			 *

+			 *  \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] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state

 			 *  \param[in] LUNIndex  LUN index within the device the command is being issued to

 			 *  \param[in] BlockAddress  Starting block address within the device to read from

@@ -238,6 +253,9 @@
 		

 			/** Writes blocks of data to the attached Mass Storage device's medium.

 			 *

+			 *  \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] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state

 			 *  \param[in] LUNIndex  LUN index within the device the command is being issued to

 			 *  \param[in] BlockAddress  Starting block address within the device to write to