Add FatFS library to the Webserver project, extend the HTTP server so that it now...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / MassStorage.h
index fc3bc66..6dda5c0 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
                        };\r
        \r
                /* Function Prototypes: */\r
-                       /** General management task for a given Mass Storage host class interface, required for the correct operation of\r
-                        *  the interface. This should be called frequently in the main program loop, before the master USB management task\r
-                        *  \ref USB_USBTask().\r
-                        *\r
-                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state\r
-                        */\r
-                       void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
-                       \r
                        /** Host interface configuration routine, to configure a given Mass Storage host interface instance using the\r
                         *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Mass\r
                         *  Storage Host instance's state values and configures the pipes required to communicate with the interface if it\r
                         *  UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage\r
                         *  Host mode Class driver to address a specific LUN within the device.\r
                         *\r
+                        *  \note Some devices do not support this request, and will STALL it when issued. To get around this,\r
+                        *        on unsupported devices the max LUN index will be reported as zero and no error will be returned\r
+                        *        if the device STALLs the request.\r
+                        *\r
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
                         *  \param[out] MaxLUNIndex  Pointer to a location where the highest LUN index value should be stored\r
                         *\r
                        /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and\r
                         *  properties.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
                         *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
                         *  \param[out] InquiryData  Location where the read inquiry data should be stored\r
 \r
                        /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
                         *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
                         *  \param[out] DeviceCapacity  Pointer to the location where the capacity information should be stored\r
                        /** Retrieves the device sense data, indicating the current device state and error codes for the previously\r
                         *  issued command.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
                         *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
                         *  \param[out] SenseData  Pointer to the location where the sense information should be stored\r
                        /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock\r
                         *  the device from removal so that blocks of data on the medium can be read or altered.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
                         *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
                         *  \param[in] PreventRemoval  Boolean true if the device should be locked from removal, false otherwise\r
                        \r
                        /** Reads blocks of data from the attached Mass Storage device's medium.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
                         *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
                         *  \param[in] BlockAddress  Starting block address within the device to read from\r
                \r
                        /** Writes blocks of data to the attached Mass Storage device's medium.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
                         *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
                         *  \param[in] BlockAddress  Starting block address within the device to write to\r
                                                          const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,\r
                                                          void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);\r
 \r
+               /* Inline Functions: */\r
+                       /** General management task for a given Mass Storage host class interface, required for the correct operation of\r
+                        *  the interface. This should be called frequently in the main program loop, before the master USB management task\r
+                        *  \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state\r
+                        */\r
+                       static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);\r
+                       static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo)\r
+                       {\r
+                               (void)MSInterfaceInfo;\r
+                       }\r
+\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
                        #define COMMAND_DIRECTION_DATA_OUT     (0 << 7)\r
                        #define COMMAND_DIRECTION_DATA_IN      (1 << 7)\r
                        \r
-                       #define COMMAND_DATA_TIMEOUT_MS        2000\r
+                       #define COMMAND_DATA_TIMEOUT_MS        10000\r
 \r
                        #define MS_FOUND_DATAPIPE_IN           (1 << 0)\r
                        #define MS_FOUND_DATAPIPE_OUT          (1 << 1)\r