X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/afe6ae14023c7040befe73e49d00077d3425c564..dbb5f249bd057c7b292645463c52067c1da58efa:/LUFA/Drivers/USB/Class/Host/MassStorage.h

diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h
index 4a694f38c..18b2cf4ae 100644
--- a/LUFA/Drivers/USB/Class/Host/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h
@@ -28,9 +28,13 @@
   this software.
 */
 
-/** \ingroup Group_USBClassMassStorage
+/** \ingroup Group_USBClassMS
  *  @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver
  *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/USB/Class/Host/MassStorage.c
+ *
  *  \section Module Description
  *  Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
  *
@@ -49,8 +53,68 @@
 			extern "C" {
 		#endif
 
-	/* Function Prototypes: */
+	/* Public Interface - May be used in end-application: */
+		/* Type Defines: */
+			/** Class state structure. An instance of this structure should be made within the user application,
+			 *  and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This
+			 *  stores each HID interface's configuration and state information.
+			 */
+			typedef struct
+			{
+				const struct
+				{
+					uint8_t  DataINPipeNumber; /**< Pipe number of the MS interface's IN data pipe */
+					uint8_t  DataOUTPipeNumber; /**< Pipe number of the MS interface's OUT data pipe */
+				} Config; /**< Config data for the USB class interface within the device. All elements in this section
+				           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
+				           */
+				struct
+				{
+					bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid
+					              *   after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the
+					              *   Configured state
+					              */
+					uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device */
+
+					uint16_t DataINPipeSize; /**< Size in bytes of the MS interface's IN data pipe */
+					uint16_t DataOUTPipeSize;  /**< Size in bytes of the MS interface's OUT data pipe */
+				} State; /**< State data for the USB class interface within the device. All elements in this section
+						  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
+						  *   the interface is enumerated.
+						  */
+			} USB_ClassInfo_MS_Host_t;
+
+		/* Enums: */
+			enum
+			{
+				MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
+				MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
+				MS_ENUMERROR_NoMSInterfaceFound        = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */
+				MS_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */
+			} MSHost_EnumerationFailure_ErrorCodes_t;
+	
+		/* Function Prototypes: */
+			void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* MSInterfaceInfo);
+			uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint16_t ConfigDescriptorLength,
+			                               uint8_t* DeviceConfigDescriptor);
 		
+	/* Private Interface - For use in library only: */
+	#if !defined(__DOXYGEN__)
+		/* Macros: */
+			#define MASS_STORE_CLASS               0x08
+			#define MASS_STORE_SUBCLASS            0x06
+			#define MASS_STORE_PROTOCOL            0x50
+
+			#define MS_FOUND_DATAPIPE_IN           (1 << 0)
+			#define MS_FOUND_DATAPIPE_OUT          (1 << 1)
+			
+		/* Function Prototypes: */
+			#if defined(INCLUDE_FROM_MS_CLASS_HOST_C)		
+				static uint8_t DComp_NextMassStorageInterface(void* CurrentDescriptor);
+				static uint8_t DComp_NextInterfaceBulkDataEndpoint(void* CurrentDescriptor);
+			#endif
+	#endif
+	
 	/* Disable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)
 			}