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