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 /** \ingroup Group_USBClassMS
  32  *  @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver
  33  *
  34  *  \section Sec_Dependencies Module Source Dependencies
  35  *  The following files must be built with any user project that uses this module:
  36  *    - LUFA/Drivers/USB/Class/Device/MassStorage.c
  37  *
  38  *  \section Module Description
  39  *  Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef _MS_CLASS_DEVICE_H_
  45 #define _MS_CLASS_DEVICE_H_
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/MassStorage.h"
  50
  51                 #include <string.h>
  52
  53         /* Enable C linkage for C++ Compilers: */
  54                 #if defined(__cplusplus)
  55                         extern "C" {
  56                 #endif
  57
  58         /* Preprocessor Checks: */
  59                 #if !defined(__INCLUDE_FROM_MS_DRIVER)
  60                         #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
  61                 #endif
  62
  63         /* Public Interface - May be used in end-application: */
  64                 /* Type Defines: */
  65                         /** Class state structure. An instance of this structure should be made for each Mass Storage interface
  66                          *  within the user application, and passed to each of the Mass Storage class driver functions as the
  67                          *  MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information.
  68                          */
  69                         typedef struct
  70                         {
  71                                 const struct
  72                                 {
  73                                         uint8_t  InterfaceNumber; /**< Interface number of the Mass Storage interface within the device */
  74
  75                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the Mass Storage interface's IN data endpoint */
  76                                         uint16_t DataINEndpointSize; /**< Size in bytes of the Mass Storage interface's IN data endpoint */
  77                                         bool     DataINEndpointDoubleBank; /** Indicates if the Mass Storage interface's IN data endpoint should use double banking */
  78
  79                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the Mass Storage interface's OUT data endpoint */
  80                                         uint16_t DataOUTEndpointSize;  /**< Size in bytes of the Mass Storage interface's OUT data endpoint */
  81                                         bool     DataOUTEndpointDoubleBank; /** Indicates if the Mass Storage interface's OUT data endpoint should use double banking */
  82
  83                                         uint8_t  TotalLUNs; /**< Total number of logical drives in the Mass Storage interface */
  84                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  85                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  86                                            */
  87                                 struct
  88                                 {
  89                                         MS_CommandBlockWrapper_t  CommandBlock; /**< Mass Storage class command block structure, stores the received SCSI
  90                                                                                                                          *   command from the host which is to be processed
  91                                                                                                                          */
  92                                         MS_CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, set elements to indicate
  93                                                                                                                           *   the issued command's success or failure to the host
  94                                                                                                                           */
  95                                         volatile bool IsMassStoreReset; /**< Flag indicating that the host has requested that the Mass Storage interface be reset
  96                                                                                                  *   and that all current Mass Storage operations should immediately abort
  97                                                                                                  */
  98                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  99                                           *   are reset to their defaults when the interface is enumerated.
 100                                           */
 101                         } USB_ClassInfo_MS_Device_t;
 102
 103                 /* Function Prototypes: */
 104                         /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library
 105                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
 106                          *  containing the given Mass Storage interface is selected.
 107                          *
 108                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state
 109                          *
 110                          *  \return Boolean true if the endpoints were successfully configured, false otherwise
 111                          */
 112                         bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 113
 114                         /** Processes incoming control requests from the host, that are directed to the given Mass Storage class interface. This should be
 115                          *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
 116                          *
 117                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state
 118                          */
 119                         void MS_Device_ProcessControlRequest(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 120
 121                         /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should
 122                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 123                          *
 124                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage configuration and state
 125                          */
 126                         void MS_Device_USBTask(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 127
 128                         /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the
 129                          *  host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible
 130                          *  for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure
 131                          *  inside the Mass Storage class state structure passed as a parameter to the callback function.
 132                          *
 133                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state
 134                          *
 135                          *  \return Boolean true if the SCSI command was successfully processed, false otherwise
 136                          */
 137                         bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 138
 139         /* Private Interface - For use in library only: */
 140         #if !defined(__DOXYGEN__)
 141                 /* Function Prototypes: */
 142                         #if defined(__INCLUDE_FROM_MS_CLASS_DEVICE_C)
 143                                 static void    MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 144                                 static bool    MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 145                                 static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);
 146                         #endif
 147
 148         #endif
 149
 150         /* Disable C linkage for C++ Compilers: */
 151                 #if defined(__cplusplus)
 152                         }
 153                 #endif
 154
 155 #endif
 156
 157 /** @} */