Remove deleted source files from the LUFA library makefile.

[pub/USBasp.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 53eb7ab..16e09dc 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h
@@ -31,6 +31,10 @@
 /** \ingroup Group_USBClassMS\r
  *  @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver\r
  *\r
 /** \ingroup Group_USBClassMS\r
  *  @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver\r
  *\r

+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/USB/Class/Device/MassStorage.c\r
+ *\r

  *  \section Module Description\r
  *  Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.\r
  *\r
  *  \section Module Description\r
  *  Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.\r
  *\r


@@ -43,7 +47,7 @@
        /* Includes: */\r
                #include "../../USB.h"\r
                #include "../Common/MassStorage.h"\r
        /* Includes: */\r
                #include "../../USB.h"\r
                #include "../Common/MassStorage.h"\r

-\r
+               \r

                #include <string.h>\r
 \r
        /* Enable C linkage for C++ Compilers: */\r
                #include <string.h>\r
 \r
        /* Enable C linkage for C++ Compilers: */\r


@@ -52,98 +56,85 @@
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r

-               /* Type Defines: */\r
-                       /** Configuration information structure for \ref USB_ClassInfo_MS_Device_t Mass Storage device interface structures. */\r
-                       typedef struct\r
-                       {\r
-                               uint8_t  InterfaceNumber; /**< Interface number of the Mass Storage interface within the device */\r
-\r
-                               uint8_t  DataINEndpointNumber; /**< Endpoint number of the Mass Storage interface's IN data endpoint */\r
-                               uint16_t DataINEndpointSize; /**< Size in bytes of the Mass Storage interface's IN 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; /**< Total number of logical drives in the Mass Storage interface */\r
-                       } USB_ClassInfo_MS_Device_Config_t;\r
-                       \r
-                       /** Current State information structure for \ref USB_ClassInfo_MS_Device_t Mass Storage device interface structures. */\r
-                       typedef struct\r
-                       {\r
-                               CommandBlockWrapper_t  CommandBlock; /**< Mass Storage class command block structure, stores the received SCSI\r
-                                                                     *   command from the host which is to be processed\r
-                                                                                                         */\r
-                               CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, set elements to indicate\r
-                                                                                                          *   the issued command's success or failure to the host\r
-                                                                                                          */\r
-\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_Device_State_t;\r
-                                                                               \r
+               /* Type Defines: */                                                                             \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. This stores each Mass Storage interface's configuration and state information.\r
                         */\r
                        typedef struct\r
                        {\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. This stores each Mass Storage interface's configuration and state information.\r
                         */\r
                        typedef struct\r
                        {\r

-                               const USB_ClassInfo_MS_Device_Config_t Config; /**< Config data for the USB class interface within\r
-                                                                               *   the device. All elements in this section\r
-                                                                               *   <b>must</b> be set or the interface will fail\r
-                                                                               *   to enumerate and operate correctly.\r
-                                                                               */\r
-                                                                                                                        \r
-                               USB_ClassInfo_MS_Device_State_t State; /**< State data for the USB class interface within\r
-                                                                       *   the device. All elements in this section\r
-                                                                       *   <b>may</b> be set to initial values, but may\r
-                                                                       *   also be ignored to default to sane values when\r
-                                                                       *   the interface is enumerated.\r
-                                                                       */\r
+                               const struct\r
+                               {\r
+                                       uint8_t  InterfaceNumber; /**< Interface number of the Mass Storage interface within the device */\r
+\r
+                                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the Mass Storage interface's IN data endpoint */\r
+                                       uint16_t DataINEndpointSize; /**< Size in bytes of the Mass Storage interface's IN 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; /**< Total number of logical drives in the Mass Storage interface */\r
+                               } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
+                                          *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
+                                          */\r
+                               struct\r
+                               {\r
+                                       MS_CommandBlockWrapper_t  CommandBlock; /**< Mass Storage class command block structure, stores the received SCSI\r
+                                                                                                                        *   command from the host which is to be processed\r
+                                                                                                                        */\r
+                                       MS_CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, set elements to indicate\r
+                                                                                                                         *   the issued command's success or failure to the host\r
+                                                                                                                         */\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
+                               } State; /**< State data for the USB class interface within the device. All elements in this section\r
+                                         *   are reset to their defaults when the interface is enumerated.\r
+                                         */\r

                        } USB_ClassInfo_MS_Device_t;\r
 \r
                /* Function Prototypes: */\r
                        /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library\r
                        } USB_ClassInfo_MS_Device_t;\r
 \r
                /* Function Prototypes: */\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
+                        *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration\r

                         *  containing the given Mass Storage interface is selected.\r
                         *\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
+                        *  \param[in,out] 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
                         *\r
                         *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                         */\r

-                       bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);\r
+                       bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                        \r
                        /** Processes incomming control requests from the host, that are directed to the given Mass Storage class interface. This should be\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
+                        *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r

                         *\r
                         *\r

-                        *  \param MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.\r

                         */             \r
                         */             \r

-                       void MS_Device_ProcessControlPacket(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);\r
+                       void MS_Device_ProcessControlRequest(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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
 \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
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage configuration and state.\r

                         */\r
                         */\r

-                       void MS_Device_USBTask(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);\r
+                       void MS_Device_USBTask(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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
                        \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
+                        *  \param[in,out] 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
                         *\r
                         *  \return Boolean true if the SCSI command was successfully processed, false otherwise\r
                         */\r

-                       bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);\r
+                       bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_MS_CLASS_DEVICE_C)\r
                \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_MS_CLASS_DEVICE_C)\r

-                               static void    MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);\r
-                               static bool    MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);\r
+                               static void    MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static bool    MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                                static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);\r
                        #endif\r
                \r
                                static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);\r
                        #endif\r
                \r