MassStorage.h 4.34 KB
 Dean Camera committed Jun 01, 2009 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 /* LUFA Library Copyright (C) Dean Camera, 2009. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that the copyright notice and this permission notice and warranty disclaimer appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */  Dean Camera committed Jun 14, 2009 31 32 /** \ingroup Group_USBClassMS * @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver  Dean Camera committed Jun 04, 2009 33 34  * * \section Module Description  Dean Camera committed Jun 14, 2009 35  * Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.  Dean Camera committed Jun 04, 2009 36 37 38 39  * * @{ */  Dean Camera committed Jun 14, 2009 40 41 #ifndef _MS_CLASS_DEVICE_H_ #define _MS_CLASS_DEVICE_H_  Dean Camera committed Jun 01, 2009 42 43 44  /* Includes: */ #include "../../USB.h"  Dean Camera committed Jun 14, 2009 45  #include "../Common/MassStorage.h"  Dean Camera committed Jun 01, 2009 46 47 48  #include  Dean Camera committed Jun 04, 2009 49 50 51 52 53  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif  Dean Camera committed Jun 01, 2009 54  /* Function Prototypes: */  Dean Camera committed Jun 14, 2009 55  #if defined(INCLUDE_FROM_MS_CLASS_DEVICE_C)  Dean Camera committed Jun 11, 2009 56 57 58  static void MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_t* MSInterfaceInfo); static bool MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_t* MSInterfaceInfo); static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);  Dean Camera committed Jun 01, 2009 59 60  #endif  Dean Camera committed Jun 08, 2009 61 62 63 64 65 66 67 68  /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration * containing the given Mass Storage interface is selected. * * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state. * * \return Boolean true if the endpoints were sucessfully configured, false otherwise */  Dean Camera committed Jun 11, 2009 69  bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_t* MSInterfaceInfo);  Dean Camera committed Jun 08, 2009 70 71 72 73 74 75  /** Processes incomming control requests from the host, that are directed to the given Mass Storage class interface. This should be * linked to the library \ref EVENT_USB_UnhandledControlPacket() event. * * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state. */  Dean Camera committed Jun 11, 2009 76  void MS_Device_ProcessControlPacket(USB_ClassInfo_MS_t* MSInterfaceInfo);  Dean Camera committed Jun 08, 2009 77 78 79 80 81 82  /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask(). * * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage configuration and state. */  Dean Camera committed Jun 11, 2009 83  void MS_Device_USBTask(USB_ClassInfo_MS_t* MSInterfaceInfo);  Dean Camera committed Jun 01, 2009 84   Dean Camera committed Jun 08, 2009 85 86 87 88 89 90 91 92 93  /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the * host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible * for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure * inside the Mass Storage class state structure passed as a parameter to the callback function. * * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state. * * \return Boolean true if the SCSI command was successfully processed, false otherwise */  Dean Camera committed Jun 11, 2009 94  bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_t* MSInterfaceInfo);  Dean Camera committed Jun 01, 2009 95   Dean Camera committed Jun 04, 2009 96 97 98 99 100  /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif  Dean Camera committed Jun 01, 2009 101 #endif  Dean Camera committed Jun 04, 2009 102 103  /** @} */