/*
 * @brief Device mode driver for the library USB RNDIS 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_USBClassRNDIS
 *  @defgroup Group_USBClassRNDISDevice RNDIS 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/RNDIS.c <i>(Makefile source module name: NXPUSBLIB_SRC_USBCLASS)</i>
 *
 *  @section Sec_ModDescription Module Description
 *  Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.
 *
 *  @{
 */

#ifndef _RNDIS_CLASS_DEVICE_H_
#define _RNDIS_CLASS_DEVICE_H_

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

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

/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_RNDIS_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	RNDIS Class Device Mode Configuration and State Structure.
 *
 *  Class state structure. An instance of this structure should be made for each RNDIS interface
 *  within the user application, and passed to each of the RNDIS class driver functions as the
 *  \c RNDISInterfaceInfo parameter. This stores each RNDIS interface's configuration and state information.
 */
typedef struct {
	const struct {
		uint8_t  ControlInterfaceNumber;			/**< Interface number of the RNDIS control interface within the device. */

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

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

		uint8_t  NotificationEndpointNumber;			/**< Endpoint number of the RNDIS interface's IN notification endpoint, if used. */
		uint16_t NotificationEndpointSize;				/**< Size in bytes of the RNDIS interface's IN notification endpoint, if used. */
		bool     NotificationEndpointDoubleBank;			/**< Indicates if the RNDIS interface's notification endpoint should use double banking. */

		char *AdapterVendorDescription;						/**< String description of the adapter vendor. */
		MAC_Address_t AdapterMACAddress;			/**< MAC address of the adapter. */
		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 {
		uint8_t  RNDISMessageBuffer[RNDIS_MESSAGE_BUFFER_SIZE];				/**< Buffer to hold RNDIS messages to and from the host,
																			 *   managed by the class driver.
																			 */
		bool     ResponseReady;				/**< Internal flag indicating if a RNDIS message is waiting to be returned to the host. */
		uint8_t  CurrRNDISState;			/**< Current RNDIS state of the adapter, a value from the @ref RNDIS_States_t enum. */
		uint32_t CurrPacketFilter;				/**< Current packet filter mode, used internally by the class driver. */
	} 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_RNDIS_Device_t;

/* Function Prototypes: */
/**
 * @brief	Configures the endpoints of a given RNDIS 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 RNDIS interface is selected.
 *
 *  @param	RNDISInterfaceInfo	: Pointer to a structure containing a RNDIS Class configuration and state.
 *
 *  @return	 Boolean \c true if the endpoints were successfully configured, \c false otherwise.
 */
bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

/**
 * @brief	Processes incoming control requests from the host, that are directed to the given RNDIS class interface. This should be
 *  linked to the library @ref EVENT_USB_Device_ControlRequest() event.
 *
 *  @param	RNDISInterfaceInfo	: Pointer to a structure containing a RNDIS Class configuration and state.
  * @return	Nothing
 */
void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

/** 
 * @brief	General management task for a given RNDIS 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	RNDISInterfaceInfo	: Pointer to a structure containing a RNDIS Class configuration and state.
 * @return	Nothing
 */
void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

/**
 * @brief	Determines if a packet is currently waiting for the device to read in and process.
 *
 *  @pre This function must only be called when the Device state machine is in the @ref DEVICE_STATE_Configured state or the
 *       call will fail.
 *
 *  @param	RNDISInterfaceInfo	: Pointer to a structure containing an RNDIS Class configuration and state.
 *
 *  @return	 Boolean \c true if a packet is waiting to be read in by the host, \c false otherwise.
 */
bool RNDIS_Device_IsPacketReceived(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo);

/**
 * @brief	Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave
 *  only the packet contents for processing by the device in the nominated buffer.
 *
 *  @pre This function must only be called when the Device state machine is in the @ref DEVICE_STATE_Configured state or the
 *       call will fail.
 *
 *  @param	RNDISInterfaceInfo	: Pointer to a structure containing an RNDIS Class configuration and state.
 *  @param	Buffer	: Pointer to a buffer where the packer data is to be written to.
 *  @param	PacketLength	: Pointer to where the length in bytes of the read packet is to be stored.
 *
 *  @return	 A value from the @ref Endpoint_Stream_RW_ErrorCodes_t enum.
 */
uint8_t RNDIS_Device_ReadPacket(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo,
								void *Buffer,
								uint16_t *const PacketLength);

/**
 * @brief	Sends the given packet to the attached RNDIS device, after adding a RNDIS packet message header.
 *
 *  @pre This function must only be called when the Device state machine is in the @ref DEVICE_STATE_Configured state or the
 *       call will fail.
 *
 *  @param	RNDISInterfaceInfo	: Pointer to a structure containing an RNDIS Class configuration and state.
 *  @param	Buffer	: Pointer to a buffer where the packer data is to be read from.
 *  @param	PacketLength	: Length in bytes of the packet to send.
 *
 *  @return	 A value from the @ref Endpoint_Stream_RW_ErrorCodes_t enum.
 */
uint8_t RNDIS_Device_SendPacket(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo,
								void *Buffer,
								const uint16_t PacketLength);

/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
/* Function Prototypes: */
		#if defined(__INCLUDE_FROM_RNDIS_DEVICE_C)
static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo)
ATTR_NON_NULL_PTR_ARG(1);

static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo,
										  const uint32_t OId,
										  void *const QueryData,
										  const uint16_t QuerySize,
										  void *ResponseData,
										  uint16_t *const ResponseSize) ATTR_NON_NULL_PTR_ARG(1)
ATTR_NON_NULL_PTR_ARG(5) ATTR_NON_NULL_PTR_ARG(6);

static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo,
										const uint32_t OId,
										const void *SetData,
										const uint16_t SetSize) ATTR_NON_NULL_PTR_ARG(1)
ATTR_NON_NULL_PTR_ARG(3);

		#endif

	#endif

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

#endif

/** @} */

