Remove unneeded #include of Device.h in StdDescriptors.h breaking compilation for...

[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 4a9450e..6f0539e 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -33,18 +33,18 @@
  *
  *  Device mode driver for the library USB Mass Storage Class driver.
  *
  *
  *  Device mode driver for the library USB Mass Storage Class driver.
  *

- *  \note This file should not be included directly. It is automatically included as needed by the class driver
- *        dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.
+ *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ *        dispatch header located in LUFA/Drivers/USB.h.

  */
 
 /** \ingroup Group_USBClassMS
  */
 
 /** \ingroup Group_USBClassMS

- *  @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver
+ *  \defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver

  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:

- *    - LUFA/Drivers/USB/Class/Device/MassStorage.c
+ *    - LUFA/Drivers/USB/Class/Device/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>

  *
  *

- *  \section Module Description
+ *  \section Sec_ModDescription Module Description

  *  Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
  *
  *  @{
  *  Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
  *
  *  @{


@@ -56,8 +56,6 @@
        /* Includes: */
                #include "../../USB.h"
                #include "../Common/MassStorage.h"
        /* Includes: */
                #include "../../USB.h"
                #include "../Common/MassStorage.h"

-               
-               #include <string.h>

 
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
 
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)


@@ -66,16 +64,16 @@
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_MS_DRIVER)
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_MS_DRIVER)

-                       #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
+                       #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.

                #endif
 
        /* Public Interface - May be used in end-application: */
                #endif
 
        /* Public Interface - May be used in end-application: */

-               /* Type Defines: */                                                                             
+               /* Type Defines: */

                        /** \brief Mass Storage Class Device Mode Configuration and State Structure.
                         *
                         *  Class state structure. An instance of this structure should be made for each Mass Storage interface
                         *  within the user application, and passed to each of the Mass Storage class driver functions as the
                        /** \brief Mass Storage Class Device Mode Configuration and State Structure.
                         *
                         *  Class state structure. An instance of this structure should be made for each Mass Storage interface
                         *  within the user application, and passed to each of the Mass Storage class driver functions as the

-                        *  MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information.
+                        *  \c MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information.

                         */
                        typedef struct
                        {
                         */
                        typedef struct
                        {


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

-                        *  \return Boolean true if the endpoints were successfully configured, false otherwise.
+                        *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.

                         */
                        bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
                         */
                        bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

-                       
+

                        /** Processes incoming control requests from the host, that are directed to the given Mass Storage class interface. This should be
                        /** Processes incoming control requests from the host, that are directed to the given Mass Storage class interface. This should be

-                        *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
+                        *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.

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

-                        */             
+                        */

                        void MS_Device_ProcessControlRequest(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should
                        void MS_Device_ProcessControlRequest(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should


@@ -135,7 +133,7 @@
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage configuration and state.
                         */
                        void MS_Device_USBTask(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage configuration and state.
                         */
                        void MS_Device_USBTask(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

-                       
+

                        /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the
                         *  host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible
                         *  for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure
                        /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the
                         *  host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible
                         *  for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure


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

-                        *  \return Boolean true if the SCSI command was successfully processed, false otherwise.
+                        *  \return Boolean \c true if the SCSI command was successfully processed, \c false otherwise.

                         */
                        bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
                         */
                        bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

-               
+

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

-                       #if defined(__INCLUDE_FROM_MS_CLASS_DEVICE_C)
-                               static void    MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
-                               static bool    MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
-                               static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);
+                       #if defined(__INCLUDE_FROM_MASSSTORAGE_DEVICE_C)
+                               static void MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+                               static bool MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

                        #endif
                        #endif

-               
+

        #endif
        #endif

-               
+

        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif

-               
+

 #endif
 
 /** @} */
 #endif
 
 /** @} */

+