LUFA/Drivers/USB/Class/Device/MassStorageClassDevice.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Device mode driver for the library USB Mass Storage Class driver.
  33  *
  34  *  Device mode driver for the library USB Mass Storage Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.h.
  38  */
  39
  40 /** \ingroup Group_USBClassMS
  41  *  \defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver
  42  *
  43  *  \section Sec_Dependencies Module Source Dependencies
  44  *  The following files must be built with any user project that uses this module:
  45  *    - LUFA/Drivers/USB/Class/Device/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_ModDescription Module Description
  48  *  Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef _MS_CLASS_DEVICE_H_
  54 #define _MS_CLASS_DEVICE_H_
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/MassStorageClassCommon.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_MS_DRIVER)
  67                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  68                 #endif
  69
  70         /* Public Interface - May be used in end-application: */
  71                 /* Type Defines: */
  72                         /** \brief Mass Storage Class Device Mode Configuration and State Structure.
  73                          *
  74                          *  Class state structure. An instance of this structure should be made for each Mass Storage interface
  75                          *  within the user application, and passed to each of the Mass Storage class driver functions as the
  76                          *  \c MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information.
  77                          */
  78                         typedef struct
  79                         {
  80                                 const struct
  81                                 {
  82                                         uint8_t  InterfaceNumber; /**< Interface number of the Mass Storage interface within the device. */
  83
  84                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the Mass Storage interface's IN data endpoint. */
  85                                         uint16_t DataINEndpointSize; /**< Size in bytes of the Mass Storage interface's IN data endpoint. */
  86                                         bool     DataINEndpointDoubleBank; /**< Indicates if the Mass Storage interface's IN data endpoint should use double banking. */
  87
  88                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the Mass Storage interface's OUT data endpoint. */
  89                                         uint16_t DataOUTEndpointSize;  /**< Size in bytes of the Mass Storage interface's OUT data endpoint. */
  90                                         bool     DataOUTEndpointDoubleBank; /**< Indicates if the Mass Storage interface's OUT data endpoint should use double banking. */
  91
  92                                         uint8_t  TotalLUNs; /**< Total number of logical drives in the Mass Storage interface. */
  93                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  94                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  95                                            */
  96                                 struct
  97                                 {
  98                                         MS_CommandBlockWrapper_t  CommandBlock; /**< Mass Storage class command block structure, stores the received SCSI
  99                                                                                                                          *   command from the host which is to be processed.
 100                                                                                                                          */
 101                                         MS_CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, set elements to indicate
 102                                                                                                                           *   the issued command's success or failure to the host.
 103                                                                                                                           */
 104                                         volatile bool IsMassStoreReset; /**< Flag indicating that the host has requested that the Mass Storage interface be reset
 105                                                                                                  *   and that all current Mass Storage operations should immediately abort.
 106                                                                                                  */
 107                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 108                                           *   are reset to their defaults when the interface is enumerated.
 109                                           */
 110                         } USB_ClassInfo_MS_Device_t;
 111
 112                 /* Function Prototypes: */
 113                         /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library
 114                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
 115                          *  containing the given Mass Storage interface is selected.
 116                          *
 117                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.
 118                          *
 119                          *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
 120                          */
 121                         bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 122
 123                         /** Processes incoming control requests from the host, that are directed to the given Mass Storage class interface. This should be
 124                          *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
 125                          *
 126                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.
 127                          */
 128                         void MS_Device_ProcessControlRequest(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 129
 130                         /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should
 131                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 132                          *
 133                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage configuration and state.
 134                          */
 135                         void MS_Device_USBTask(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 136
 137                         /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the
 138                          *  host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible
 139                          *  for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure
 140                          *  inside the Mass Storage class state structure passed as a parameter to the callback function.
 141                          *
 142                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.
 143                          *
 144                          *  \return Boolean \c true if the SCSI command was successfully processed, \c false otherwise.
 145                          */
 146                         bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 147
 148         /* Private Interface - For use in library only: */
 149         #if !defined(__DOXYGEN__)
 150                 /* Function Prototypes: */
 151                         #if defined(__INCLUDE_FROM_MASSSTORAGE_DEVICE_C)
 152                                 static void MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 153                                 static bool MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 154                         #endif
 155
 156         #endif
 157
 158         /* Disable C linkage for C++ Compilers: */
 159                 #if defined(__cplusplus)
 160                         }
 161                 #endif
 162
 163 #endif
 164
 165 /** @} */
 166