Finished basic documentation of all device mode class drivers.

[pub/lufa.git] / LUFA / Drivers / USB / Class / Device / MassStorage.h

diff --git a/LUFA/Drivers/USB/Class/Device/MassStorage.h b/LUFA/Drivers/USB/Class/Device/MassStorage.h
index d8da15c..0ecc4aa 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h
@@ -106,8 +106,10 @@
                };\r
                \r
        /* Type Defines: */\r
                };\r
                \r
        /* Type Defines: */\r

-               /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration\r
-                *  as set by the host via a class specific request.\r
+               /** Class state structure. An instance of this structure should be made for each Mass Storage interface\r
+                *  within the user application, and passed to each of the Mass Storage class driver functions as the\r
+                *  MSInterfaceInfo parameter. The contents of this structure should be set to their correct\r
+                *  values when used, or ommitted to force the library to use default values.\r

                 */\r
                typedef struct\r
                {\r
                 */\r
                typedef struct\r
                {\r


@@ -119,12 +121,18 @@
                        uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the Mass Storage interface's OUT data endpoint */\r
                        uint16_t DataOUTEndpointSize;  /**< Size in bytes of the Mass Storage interface's OUT data endpoint */\r
 \r
                        uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the Mass Storage interface's OUT data endpoint */\r
                        uint16_t DataOUTEndpointSize;  /**< Size in bytes of the Mass Storage interface's OUT data endpoint */\r
 \r

-                       uint8_t  TotalLUNs;\r
+                       uint8_t  TotalLUNs; /**< Total number of logical drives in the Mass Storage interface */\r

 \r
 \r

-                       CommandBlockWrapper_t  CommandBlock;\r
-                       CommandStatusWrapper_t CommandStatus;\r
+                       CommandBlockWrapper_t  CommandBlock; /**< Mass Storage class command block structure, used internally\r
+                                                             *   by the class driver\r
+                                                             */\r
+                       CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, used internally\r
+                                                             *   by the class driver\r
+                                                             */\r

 \r
 \r

-                       bool IsMassStoreReset;\r
+                       bool IsMassStoreReset; /**< Flag indicating that the host has requested that the Mass Storage interface be reset\r
+                                               *   and that all current Mass Storage operations should immediately abort\r
+                                                                       */\r

                } USB_ClassInfo_MS_t;\r
                \r
        /* Function Prototypes: */\r
                } USB_ClassInfo_MS_t;\r
                \r
        /* Function Prototypes: */\r


@@ -134,10 +142,39 @@
                        static uint8_t StreamCallback_AbortOnMassStoreReset(void);\r
                #endif\r
        \r
                        static uint8_t StreamCallback_AbortOnMassStoreReset(void);\r
                #endif\r
        \r

+               /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library\r
+                *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+                *  containing the given Mass Storage interface is selected.\r
+                *\r
+                *  \param MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.\r
+                *\r
+                *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+                */\r

                bool USB_MS_ConfigureEndpoints(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
                bool USB_MS_ConfigureEndpoints(USB_ClassInfo_MS_t* MSInterfaceInfo);\r

+               \r
+               /** Processes incomming control requests from the host, that are directed to the given Mass Storage class interface. This should be\r
+                *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+                *\r
+                *  \param MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.\r
+                */             \r

                void USB_MS_ProcessControlPacket(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
                void USB_MS_ProcessControlPacket(USB_ClassInfo_MS_t* MSInterfaceInfo);\r

+\r
+               /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should\r
+                *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+                *\r
+                *  \param MSInterfaceInfo  Pointer to a structure containing a Mass Storage configuration and state.\r
+                */\r

                void USB_MS_USBTask(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
                \r
                void USB_MS_USBTask(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
                \r

+               /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the\r
+                *  host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible\r
+                *  for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure\r
+                *  inside the Mass Storage class state structure passed as a parameter to the callback function.\r
+                *\r
+                *  \param MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.\r
+                *\r
+                *  \return Boolean true if the SCSI command was successfully processed, false otherwise\r
+                */\r

                bool CALLBACK_USB_MS_SCSICommandReceived(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
                \r
        /* Disable C linkage for C++ Compilers: */\r
                bool CALLBACK_USB_MS_SCSICommandReceived(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
                \r
        /* Disable C linkage for C++ Compilers: */\r