[freertos] /

/*\r
 * @brief Device mode driver for the library USB Mass Storage Class driver\r
 *\r
 * @note\r
 * Copyright(C) NXP Semiconductors, 2012\r
 * Copyright(C) Dean Camera, 2011, 2012\r
 * All rights reserved.\r
 *\r
 * @par\r
 * Software that is described herein is for illustrative purposes only\r
 * which provides customers with programming information regarding the\r
 * LPC products.  This software is supplied "AS IS" without any warranties of\r
 * any kind, and NXP Semiconductors and its licensor disclaim any and\r
 * all warranties, express or implied, including all implied warranties of\r
 * merchantability, fitness for a particular purpose and non-infringement of\r
 * intellectual property rights.  NXP Semiconductors assumes no responsibility\r
 * or liability for the use of the software, conveys no license or rights under any\r
 * patent, copyright, mask work right, or any other intellectual property rights in\r
 * or to any products. NXP Semiconductors reserves the right to make changes\r
 * in the software without notification. NXP Semiconductors also makes no\r
 * representation or warranty that such application will be suitable for the\r
 * specified use without further testing or modification.\r
 *\r
 * @par\r
 * Permission to use, copy, modify, and distribute this software and its\r
 * documentation is hereby granted, under NXP Semiconductors' and its\r
 * licensor's relevant copyrights in the software, without fee, provided that it\r
 * is used in conjunction with NXP Semiconductors microcontrollers.  This\r
 * copyright, permission, and disclaimer notice must appear in all copies of\r
 * this code.\r
 */\r
\r
/** @ingroup Group_USBClassMS\r
 *  @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver\r
 *\r
 *  @section Sec_Dependencies Module Source Dependencies\r
 *  The following files must be built with any user project that uses this module:\r
 *    - nxpUSBlib/Drivers/USB/Class/Device/MassStorage.c <i>(Makefile source module name: NXPUSBLIB_SRC_USBCLASS)</i>\r
 *\r
 *  @section Sec_ModDescription Module Description\r
 *  Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.\r
 *\r
 * @{\r
 */\r
\r
#ifndef _MS_CLASS_DEVICE_H_\r
#define _MS_CLASS_DEVICE_H_\r
\r
/* Includes: */\r
                #include "../../USB.h"\r
                #include "../Common/MassStorageClassCommon.h"\r
\r
/* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
extern "C" {\r
                #endif\r
\r
/* Preprocessor Checks: */\r
                #if !defined(__INCLUDE_FROM_MS_DRIVER)\r
                        #error Do not include this file directly. Include LPCUSBlib/Drivers/USB.h instead.\r
                #endif\r
\r
/* Public Interface - May be used in end-application: */\r
/* Type Defines: */\r
/**\r
 * @brief Mass Storage Class Device Mode Configuration and State Structure.\r
 *\r
 *  Class state structure. An instance of this structure should be made for each Mass Storage interface\r
 *  within the user application, and passed to each of the Mass Storage class driver functions as the\r
 *  \c MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information.\r
 */\r
typedef struct {\r
        const struct {\r
                uint8_t  InterfaceNumber;                               /**< Interface number of the Mass Storage interface within the device. */\r
\r
                uint8_t  DataINEndpointNumber;                          /**< Endpoint number of the Mass Storage interface's IN data endpoint. */\r
                uint16_t DataINEndpointSize;                    /**< Size in bytes of the Mass Storage interface's IN data endpoint. */\r
                bool     DataINEndpointDoubleBank;                              /**< Indicates if the Mass Storage interface's IN data endpoint should use double banking. */\r
\r
                uint8_t  DataOUTEndpointNumber;                         /**< Endpoint number of the Mass Storage interface's OUT data endpoint. */\r
                uint16_t DataOUTEndpointSize;                           /**< Size in bytes of the Mass Storage interface's OUT data endpoint. */\r
                bool     DataOUTEndpointDoubleBank;                             /**< Indicates if the Mass Storage interface's OUT data endpoint should use double banking. */\r
\r
                uint8_t  TotalLUNs;                             /**< Total number of logical drives in the Mass Storage interface. */\r
                uint8_t  PortNumber;                            /**< Port number that this interface is running.*/\r
        } Config;                               /**< Config data for the USB class interface within the device. All elements in this section\r
                                                         *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
                                                         */\r
\r
        struct {\r
                MS_CommandBlockWrapper_t  CommandBlock;                         /**< Mass Storage class command block structure, stores the received SCSI\r
                                                                                                                         *   command from the host which is to be processed.\r
                                                                                                                         */\r
                MS_CommandStatusWrapper_t CommandStatus;                        /**< Mass Storage class command status structure, set elements to indicate\r
                                                                                                                         *   the issued command's success or failure to the host.\r
                                                                                                                         */\r
                volatile bool IsMassStoreReset;                         /**< Flag indicating that the host has requested that the Mass Storage interface be reset\r
                                                                                                         *   and that all current Mass Storage operations should immediately abort.\r
                                                                                                         */\r
        } State;                        /**< State data for the USB class interface within the device. All elements in this section\r
                                                 *   are reset to their defaults when the interface is enumerated.\r
                                                 */\r
\r
} USB_ClassInfo_MS_Device_t;\r
\r
/* Function Prototypes: */\r
/**\r
 * @brief       Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library\r
 *  @ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
 *  containing the given Mass Storage interface is selected.\r
 *\r
 * @param       MSInterfaceInfo : Pointer to a structure containing a Mass Storage Class configuration and state.\r
 *\r
 * @return      Boolean \c true if the endpoints were successfully configured, \c false otherwise.\r
 */\r
bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/**\r
 * @brief       Processes incoming control requests from the host, that are directed to the given Mass Storage class interface. This should be\r
 *  linked to the library @ref EVENT_USB_Device_ControlRequest() event.\r
 *\r
 * @param       MSInterfaceInfo : Pointer to a structure containing a Mass Storage Class configuration and state.\r
 * @return      Nothing\r
 */\r
void MS_Device_ProcessControlRequest(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/**\r
 * @brief       General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should\r
 *  be called frequently in the main program loop, before the master USB management task @ref USB_USBTask().\r
 *\r
 * @param       MSInterfaceInfo : Pointer to a structure containing a Mass Storage configuration and state.\r
 * @return      Nothing\r
 */\r
void MS_Device_USBTask(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/**\r
 * @brief       Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the\r
 *  host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible\r
 *  for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure\r
 *  inside the Mass Storage class state structure passed as a parameter to the callback function.\r
 *\r
 * @param       MSInterfaceInfo : Pointer to a structure containing a Mass Storage Class configuration and state.\r
 *\r
 * @return      Boolean \c true if the SCSI command was successfully processed, \c false otherwise.\r
 */\r
bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
/* Function Prototypes: */\r
                        #if defined(__INCLUDE_FROM_MASSSTORAGE_DEVICE_C)\r
static void MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
static bool MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
                        #endif\r
\r
        #endif\r
\r
/* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
}\r
                #endif\r
\r
#endif\r
\r
/** @} */\r
\r