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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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         /* Public Interface - May be used in end-application: */
  59                 /* Type Defines: */
  60                         /** Class state structure. An instance of this structure should be made for each Mass Storage interface
  61                          *  within the user application, and passed to each of the Mass Storage class driver functions as the
  62                          *  MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information.
  63                          */
  64                         typedef struct
  65                         {
  66                                 const struct
  67                                 {
  68                                         uint8_t  InterfaceNumber; /**< Interface number of the Mass Storage interface within the device */
  69
  70                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the Mass Storage interface's IN data endpoint */
  71                                         uint16_t DataINEndpointSize; /**< Size in bytes of the Mass Storage interface's IN data endpoint */
  72
  73                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the Mass Storage interface's OUT data endpoint */
  74                                         uint16_t DataOUTEndpointSize;  /**< Size in bytes of the Mass Storage interface's OUT data endpoint */
  75
  76                                         uint8_t  TotalLUNs; /**< Total number of logical drives in the Mass Storage interface */
  77                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  78                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  79                                            */
  80                                 struct
  81                                 {
  82                                         MS_CommandBlockWrapper_t  CommandBlock; /**< Mass Storage class command block structure, stores the received SCSI
  83                                                                                                                          *   command from the host which is to be processed
  84                                                                                                                          */
  85                                         MS_CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, set elements to indicate
  86                                                                                                                           *   the issued command's success or failure to the host
  87                                                                                                                           */
  88                                         bool IsMassStoreReset; /**< Flag indicating that the host has requested that the Mass Storage interface be reset
  89                                                                                         *   and that all current Mass Storage operations should immediately abort
  90                                                                                         */
  91                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  92                                           *   are reset to their defaults when the interface is enumerated.
  93                                           */
  94                         } USB_ClassInfo_MS_Device_t;
  95
  96                 /* Function Prototypes: */
  97                         /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library
  98                          *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration
  99                          *  containing the given Mass Storage interface is selected.
 100                          *
 101                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.
 102                          *
 103                          *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
 104                          */
 105                         bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
 106
 107                         /** Processes incomming control requests from the host, that are directed to the given Mass Storage class interface. This should be
 108                          *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
 109                          *
 110                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.
 111                          */
 112                         void MS_Device_ProcessControlPacket(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
 113
 114                         /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should
 115                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 116                          *
 117                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage configuration and state.
 118                          */
 119                         void MS_Device_USBTask(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
 120
 121                         /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the
 122                          *  host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible
 123                          *  for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure
 124                          *  inside the Mass Storage class state structure passed as a parameter to the callback function.
 125                          *
 126                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.
 127                          *
 128                          *  \return Boolean true if the SCSI command was successfully processed, false otherwise
 129                          */
 130                         bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
 131
 132         /* Private Interface - For use in library only: */
 133         #if !defined(__DOXYGEN__)
 134                 /* Function Prototypes: */
 135                         #if defined(INCLUDE_FROM_MS_CLASS_DEVICE_C)
 136                                 static void    MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
 137                                 static bool    MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
 138                                 static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);
 139                         #endif
 140
 141         #endif
 142
 143         /* Disable C linkage for C++ Compilers: */
 144                 #if defined(__cplusplus)
 145                         }
 146                 #endif
 147
 148 #endif
 149
 150 /** @} */