/*
 * @brief Device mode driver for the library USB Mass Storage Class driver
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * Copyright(C) Dean Camera, 2011, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

/** @ingroup Group_USBClassMS
 *  @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver
 *
 *  @section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
 *    - nxpUSBlib/Drivers/USB/Class/Device/MassStorage.c <i>(Makefile source module name: NXPUSBLIB_SRC_USBCLASS)</i>
 *
 *  @section Sec_ModDescription Module Description
 *  Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
 *
 * @{
 */

#ifndef _MS_CLASS_DEVICE_H_
#define _MS_CLASS_DEVICE_H_

/* Includes: */
		#include "../../USB.h"
		#include "../Common/MassStorageClassCommon.h"

/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
extern "C" {
		#endif

/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_MS_DRIVER)
			#error Do not include this file directly. Include LPCUSBlib/Drivers/USB.h instead.
		#endif

/* Public Interface - May be used in end-application: */
/* Type Defines: */
/**
 * @brief Mass Storage Class Device Mode Configuration and State Structure.
 *
 *  Class state structure. An instance of this structure should be made for each Mass Storage interface
 *  within the user application, and passed to each of the Mass Storage class driver functions as the
 *  \c MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information.
 */
typedef struct {
	const struct {
		uint8_t  InterfaceNumber;				/**< Interface number of the Mass Storage interface within the device. */

		uint8_t  DataINEndpointNumber;				/**< Endpoint number of the Mass Storage interface's IN data endpoint. */
		uint16_t DataINEndpointSize;			/**< Size in bytes of the Mass Storage interface's IN data endpoint. */
		bool     DataINEndpointDoubleBank;				/**< Indicates if the Mass Storage interface's IN data endpoint should use double banking. */

		uint8_t  DataOUTEndpointNumber;				/**< Endpoint number of the Mass Storage interface's OUT data endpoint. */
		uint16_t DataOUTEndpointSize;				/**< Size in bytes of the Mass Storage interface's OUT data endpoint. */
		bool     DataOUTEndpointDoubleBank;				/**< Indicates if the Mass Storage interface's OUT data endpoint should use double banking. */

		uint8_t  TotalLUNs;				/**< Total number of logical drives in the Mass Storage interface. */
		uint8_t  PortNumber;				/**< Port number that this interface is running.*/
	} Config;				/**< Config data for the USB class interface within the device. All elements in this section
							 *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
							 */

	struct {
		MS_CommandBlockWrapper_t  CommandBlock;				/**< Mass Storage class command block structure, stores the received SCSI
															 *   command from the host which is to be processed.
															 */
		MS_CommandStatusWrapper_t CommandStatus;			/**< Mass Storage class command status structure, set elements to indicate
															 *   the issued command's success or failure to the host.
															 */
		volatile bool IsMassStoreReset;				/**< Flag indicating that the host has requested that the Mass Storage interface be reset
													 *   and that all current Mass Storage operations should immediately abort.
													 */
	} State;			/**< State data for the USB class interface within the device. All elements in this section
						 *   are reset to their defaults when the interface is enumerated.
						 */

} USB_ClassInfo_MS_Device_t;

/* Function Prototypes: */
/**
 * @brief	Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library
 *  @ref EVENT_USB_Device_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 \c true if the endpoints were successfully configured, \c false otherwise.
 */
bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

/**
 * @brief	Processes incoming 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_Device_ControlRequest() event.
 *
 * @param	MSInterfaceInfo	: Pointer to a structure containing a Mass Storage Class configuration and state.
 * @return	Nothing
 */
void MS_Device_ProcessControlRequest(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

/**
 * @brief	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.
 * @return	Nothing
 */
void MS_Device_USBTask(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

/**
 * @brief	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 \c true if the SCSI command was successfully processed, \c false otherwise.
 */
bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
/* Function Prototypes: */
			#if defined(__INCLUDE_FROM_MASSSTORAGE_DEVICE_C)
static void MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

static bool MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t *const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

			#endif

	#endif

/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
}
		#endif

#endif

/** @} */

