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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/MassStorage.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 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/MassStorage.h"
  59
  60                 #include <string.h>
  61
  62         /* Enable C linkage for C++ Compilers: */
  63                 #if defined(__cplusplus)
  64                         extern "C" {
  65                 #endif
  66
  67         /* Preprocessor Checks: */
  68                 #if !defined(__INCLUDE_FROM_MS_DRIVER)
  69                         #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
  70                 #endif
  71
  72         /* Public Interface - May be used in end-application: */
  73                 /* Type Defines: */
  74                         /** \brief Mass Storage Class Device Mode Configuration and State Structure.
  75                          *
  76                          *  Class state structure. An instance of this structure should be made for each Mass Storage interface
  77                          *  within the user application, and passed to each of the Mass Storage class driver functions as the
  78                          *  MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information.
  79                          */
  80                         typedef struct
  81                         {
  82                                 const struct
  83                                 {
  84                                         uint8_t  InterfaceNumber; /**< Interface number of the Mass Storage interface within the device. */
  85
  86                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the Mass Storage interface's IN data endpoint. */
  87                                         uint16_t DataINEndpointSize; /**< Size in bytes of the Mass Storage interface's IN data endpoint. */
  88                                         bool     DataINEndpointDoubleBank; /**< Indicates if the Mass Storage interface's IN data endpoint should use double banking. */
  89
  90                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the Mass Storage interface's OUT data endpoint. */
  91                                         uint16_t DataOUTEndpointSize;  /**< Size in bytes of the Mass Storage interface's OUT data endpoint. */
  92                                         bool     DataOUTEndpointDoubleBank; /**< Indicates if the Mass Storage interface's OUT data endpoint should use double banking. */
  93
  94                                         uint8_t  TotalLUNs; /**< Total number of logical drives in the Mass Storage interface. */
  95                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  96                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  97                                            */
  98                                 struct
  99                                 {
 100                                         MS_CommandBlockWrapper_t  CommandBlock; /**< Mass Storage class command block structure, stores the received SCSI
 101                                                                                                                          *   command from the host which is to be processed.
 102                                                                                                                          */
 103                                         MS_CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, set elements to indicate
 104                                                                                                                           *   the issued command's success or failure to the host.
 105                                                                                                                           */
 106                                         volatile bool IsMassStoreReset; /**< Flag indicating that the host has requested that the Mass Storage interface be reset
 107                                                                                                  *   and that all current Mass Storage operations should immediately abort.
 108                                                                                                  */
 109                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 110                                           *   are reset to their defaults when the interface is enumerated.
 111                                           */
 112                         } USB_ClassInfo_MS_Device_t;
 113
 114                 /* Function Prototypes: */
 115                         /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library
 116                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
 117                          *  containing the given Mass Storage interface is selected.
 118                          *
 119                          *  \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
 120                          *        interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
 121                          *        within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
 122                          *
 123                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.
 124                          *
 125                          *  \return Boolean true if the endpoints were successfully configured, false otherwise.
 126                          */
 127                         bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 128
 129                         /** Processes incoming control requests from the host, that are directed to the given Mass Storage class interface. This should be
 130                          *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
 131                          *
 132                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.
 133                          */
 134                         void MS_Device_ProcessControlRequest(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 135
 136                         /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should
 137                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 138                          *
 139                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage configuration and state.
 140                          */
 141                         void MS_Device_USBTask(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 142
 143                         /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the
 144                          *  host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible
 145                          *  for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure
 146                          *  inside the Mass Storage class state structure passed as a parameter to the callback function.
 147                          *
 148                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.
 149                          *
 150                          *  \return Boolean true if the SCSI command was successfully processed, false otherwise.
 151                          */
 152                         bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 153
 154         /* Private Interface - For use in library only: */
 155         #if !defined(__DOXYGEN__)
 156                 /* Function Prototypes: */
 157                         #if defined(__INCLUDE_FROM_MS_CLASS_DEVICE_C)
 158                                 static void    MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 159                                 static bool    MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 160                                 static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);
 161                         #endif
 162
 163         #endif
 164
 165         /* Disable C linkage for C++ Compilers: */
 166                 #if defined(__cplusplus)
 167                         }
 168                 #endif
 169
 170 #endif
 171
 172 /** @} */
 173