LibrePilot/flight/PiOS/STM32F4xx/pios_usbhook.c

/**
 ******************************************************************************
 * @addtogroup PIOS PIOS Core hardware abstraction layer
 * @{
 * @addtogroup PIOS_USBHOOK USB glue code
 * @brief Glue between PiOS and STM32 libs
 * @{
 *
 * @file       pios_usbhook.c
 * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
 * @brief      Glue between PiOS and STM32 libs
 * @see        The GNU Public License (GPL) Version 3
 *
 *****************************************************************************/
/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#include "pios.h"
#include "pios_usb.h"		/* PIOS_USB_* */
#include "pios_usbhook.h"
#include "pios_usb_defs.h"	/* struct usb_* */
#include "pios_usb_cdc_priv.h"	/* PIOS_USB_CDC_* */
#include "pios_usb_board_data.h" /* PIOS_USB_BOARD_* */


/* STM32 USB Library Definitions */
#include "usb_core.h"		/* USBD_Class_cb_TypeDef */
#include "usbd_core.h"		/* USBD_Init USBD_OK*/
#include "usbd_ioreq.h"		/* USBD_CtlPrepareRx, USBD_CtlSendData */
#include "usbd_req.h"		/* USBD_CtlError */
#include "usb_dcd_int.h"	/* USBD_OTG_ISR_Handler */

/*
 * External API
 */
static struct pios_usbhook_descriptor Device_Descriptor;

void PIOS_USBHOOK_RegisterDevice(const uint8_t * desc, uint16_t length)
{
	Device_Descriptor.descriptor = desc;
	Device_Descriptor.length     = length;
}

static struct pios_usbhook_descriptor String_Descriptor[4];

void PIOS_USBHOOK_RegisterString(enum usb_string_desc string_id, const uint8_t * desc, uint16_t desc_size)
{
	if (string_id < NELEMENTS(String_Descriptor)) {
		String_Descriptor[string_id].descriptor = desc;
		String_Descriptor[string_id].length     = desc_size;
	}
}

static struct pios_usbhook_descriptor Config_Descriptor;

void PIOS_USBHOOK_RegisterConfig(uint8_t config_id, const uint8_t * desc, uint16_t desc_size)
{
	Config_Descriptor.descriptor = desc;
	Config_Descriptor.length     = desc_size;
}

static USB_OTG_CORE_HANDLE pios_usb_otg_core_handle;
static USBD_Class_cb_TypeDef class_callbacks;
static USBD_DEVICE device_callbacks;
static USBD_Usr_cb_TypeDef user_callbacks;

void PIOS_USBHOOK_Activate(void)
{
	USBD_Init(&pios_usb_otg_core_handle,
		USB_OTG_FS_CORE_ID,
		&device_callbacks,
		&class_callbacks,
		&user_callbacks);
}

void OTG_FS_IRQHandler(void)
{
	if(!USBD_OTG_ISR_Handler(&pios_usb_otg_core_handle)) {
		/* spurious interrupt, disable IRQ */
	  
	}
}

struct usb_if_entry {
  struct pios_usb_ifops *ifops;
  uint32_t context;
};
static struct usb_if_entry usb_if_table[3];
void PIOS_USBHOOK_RegisterIfOps(uint8_t ifnum, struct pios_usb_ifops * ifops, uint32_t context)
{
	PIOS_Assert(ifnum < NELEMENTS(usb_if_table));
	PIOS_Assert(ifops);

	usb_if_table[ifnum].ifops   = ifops;
	usb_if_table[ifnum].context = context;
}

struct usb_ep_entry {
	pios_usbhook_epcb cb;
	uint32_t context;
	uint16_t max_len;
};
static struct usb_ep_entry usb_epin_table[6];
void PIOS_USBHOOK_RegisterEpInCallback(uint8_t epnum, uint16_t max_len, pios_usbhook_epcb cb, uint32_t context)
{
	PIOS_Assert(epnum < NELEMENTS(usb_epin_table));
	PIOS_Assert(cb);

	usb_epin_table[epnum].cb      = cb;
	usb_epin_table[epnum].context = context;
	usb_epin_table[epnum].max_len = max_len;

	DCD_EP_Open(&pios_usb_otg_core_handle,
		epnum | 0x80,
		max_len,
		USB_OTG_EP_INT);
	/*
	 * FIXME do not hardcode endpoint type
	 */
}

extern void PIOS_USBHOOK_DeRegisterEpInCallback(uint8_t epnum)
{
	PIOS_Assert(epnum < NELEMENTS(usb_epin_table));

	usb_epin_table[epnum].cb = NULL;

	DCD_EP_Close(&pios_usb_otg_core_handle, epnum | 0x80);
}

static struct usb_ep_entry usb_epout_table[6];
void PIOS_USBHOOK_RegisterEpOutCallback(uint8_t epnum, uint16_t max_len, pios_usbhook_epcb cb, uint32_t context)
{
  PIOS_Assert(epnum < NELEMENTS(usb_epout_table));
  PIOS_Assert(cb);

  usb_epout_table[epnum].cb      = cb;
  usb_epout_table[epnum].context = context;
  usb_epout_table[epnum].max_len = max_len;

  DCD_EP_Open(&pios_usb_otg_core_handle,
	      epnum,
	      max_len,
	      USB_OTG_EP_INT);
	/*
	 * FIXME do not hardcode endpoint type
	 */
}

extern void PIOS_USBHOOK_DeRegisterEpOutCallback(uint8_t epnum)
{
	PIOS_Assert(epnum < NELEMENTS(usb_epout_table));

	usb_epout_table[epnum].cb = NULL;

	DCD_EP_Close(&pios_usb_otg_core_handle, epnum);
}

void PIOS_USBHOOK_CtrlTx(const uint8_t *buf, uint16_t len)
{
	USBD_CtlSendData(&pios_usb_otg_core_handle, buf, len);
}

void PIOS_USBHOOK_CtrlRx(uint8_t *buf, uint16_t len)
{
	USBD_CtlPrepareRx(&pios_usb_otg_core_handle, buf, len);
}

void PIOS_USBHOOK_EndpointTx(uint8_t epnum, const uint8_t *buf, uint16_t len)
{
	if (pios_usb_otg_core_handle.dev.device_status == USB_OTG_CONFIGURED) {
		DCD_EP_Tx(&pios_usb_otg_core_handle, epnum, buf, len);
	}
}

void PIOS_USBHOOK_EndpointRx(uint8_t epnum, uint8_t *buf, uint16_t len)
{
	DCD_EP_PrepareRx(&pios_usb_otg_core_handle, epnum, buf, len);
}

/*
 * Device level hooks into STM USB library
 */

static const uint8_t * PIOS_USBHOOK_DEV_GetDeviceDescriptor(uint8_t speed, uint16_t *length)
{
	*length = Device_Descriptor.length;
	return Device_Descriptor.descriptor;
}

static const uint8_t * PIOS_USBHOOK_DEV_GetLangIDStrDescriptor(uint8_t speed, uint16_t *length)
{
	*length = String_Descriptor[USB_STRING_DESC_LANG].length;
	return String_Descriptor[USB_STRING_DESC_LANG].descriptor;
}

static const uint8_t * PIOS_USBHOOK_DEV_GetManufacturerStrDescriptor(uint8_t speed, uint16_t *length)
{
	*length = String_Descriptor[USB_STRING_DESC_VENDOR].length;
	return String_Descriptor[USB_STRING_DESC_VENDOR].descriptor;
}

static const uint8_t * PIOS_USBHOOK_DEV_GetProductStrDescriptor(uint8_t speed, uint16_t *length)
{
	*length = String_Descriptor[USB_STRING_DESC_PRODUCT].length;
	return String_Descriptor[USB_STRING_DESC_PRODUCT].descriptor;
}

static const uint8_t * PIOS_USBHOOK_DEV_GetSerialStrDescriptor(uint8_t speed, uint16_t *length)
{
	*length = String_Descriptor[USB_STRING_DESC_SERIAL].length;
	return String_Descriptor[USB_STRING_DESC_SERIAL].descriptor;
}

static const uint8_t * PIOS_USBHOOK_DEV_GetConfigurationStrDescriptor(uint8_t speed, uint16_t *length)
{
	return NULL;
}

static const uint8_t * PIOS_USBHOOK_DEV_GetInterfaceStrDescriptor(uint8_t speed, uint16_t *length)
{
	return NULL;
}

static USBD_DEVICE device_callbacks = {
	.GetDeviceDescriptor           = PIOS_USBHOOK_DEV_GetDeviceDescriptor,
	.GetLangIDStrDescriptor        = PIOS_USBHOOK_DEV_GetLangIDStrDescriptor,
	.GetManufacturerStrDescriptor  = PIOS_USBHOOK_DEV_GetManufacturerStrDescriptor,
	.GetProductStrDescriptor       = PIOS_USBHOOK_DEV_GetProductStrDescriptor,
	.GetSerialStrDescriptor        = PIOS_USBHOOK_DEV_GetSerialStrDescriptor,
	.GetConfigurationStrDescriptor = PIOS_USBHOOK_DEV_GetConfigurationStrDescriptor,
	.GetInterfaceStrDescriptor     = PIOS_USBHOOK_DEV_GetInterfaceStrDescriptor,
};

static void PIOS_USBHOOK_USR_Init(void)
{
	PIOS_USB_ChangeConnectionState(false);

#if 1
	/* Force a physical disconnect/reconnect */
	DCD_DevDisconnect(&pios_usb_otg_core_handle);
	DCD_DevConnect(&pios_usb_otg_core_handle);
#endif
}

static void PIOS_USBHOOK_USR_DeviceReset(uint8_t speed)
{
	PIOS_USB_ChangeConnectionState(false);
}

static void PIOS_USBHOOK_USR_DeviceConfigured(void)
{
	PIOS_USB_ChangeConnectionState(true);
}

static void PIOS_USBHOOK_USR_DeviceSuspended(void)
{
	/* Unhandled */
}

static void PIOS_USBHOOK_USR_DeviceResumed(void)
{
	/* Unhandled */
}

static void PIOS_USBHOOK_USR_DeviceConnected(void)
{
	/* NOP */
}

static void PIOS_USBHOOK_USR_DeviceDisconnected(void)
{
	PIOS_USB_ChangeConnectionState(false);
}

static USBD_Usr_cb_TypeDef user_callbacks = {
	.Init               = PIOS_USBHOOK_USR_Init,
	.DeviceReset        = PIOS_USBHOOK_USR_DeviceReset,
	.DeviceConfigured   = PIOS_USBHOOK_USR_DeviceConfigured,
	.DeviceSuspended    = PIOS_USBHOOK_USR_DeviceSuspended,
	.DeviceResumed      = PIOS_USBHOOK_USR_DeviceResumed,
	.DeviceConnected    = PIOS_USBHOOK_USR_DeviceConnected,
	.DeviceDisconnected = PIOS_USBHOOK_USR_DeviceDisconnected,
};

static uint8_t PIOS_USBHOOK_CLASS_Init(void *pdev, uint8_t cfgidx)
{
  /* Call all of the registered init callbacks */
  for (uint8_t i = 0; i < NELEMENTS(usb_if_table); i++) {
    struct usb_if_entry * usb_if = &(usb_if_table[i]);
    if (usb_if->ifops && usb_if->ifops->init) {
      usb_if->ifops->init(usb_if->context);
    }
  }
  return USBD_OK;
}

static uint8_t PIOS_USBHOOK_CLASS_DeInit(void *pdev, uint8_t cfgidx)
{
  /* Call all of the registered deinit callbacks */
  for (uint8_t i = 0; i < NELEMENTS(usb_if_table); i++) {
    struct usb_if_entry * usb_if = &(usb_if_table[i]);
    if (usb_if->ifops && usb_if->ifops->deinit) {
      usb_if->ifops->deinit(usb_if->context);
    }
  }
  return USBD_OK;
}

static struct usb_setup_request usb_ep0_active_req;
static uint8_t PIOS_USBHOOK_CLASS_Setup(void *pdev, USB_SETUP_REQ *req)
{
	switch (req->bmRequest & (USB_REQ_TYPE_MASK | USB_REQ_RECIPIENT_MASK)) {
	case (USB_REQ_TYPE_STANDARD | USB_REQ_RECIPIENT_INTERFACE):
	case (USB_REQ_TYPE_CLASS    | USB_REQ_RECIPIENT_INTERFACE):
	{
		uint8_t ifnum = LOBYTE(req->wIndex);
		if ((ifnum < NELEMENTS(usb_if_table)) &&
		    (usb_if_table[ifnum].ifops && usb_if_table[ifnum].ifops->setup)) {
			usb_if_table[ifnum].ifops->setup(usb_if_table[ifnum].context, 
							 (struct usb_setup_request *)req);
			if (req->bmRequest & 0x80 && req->wLength > 0) {
				/* Request is a host-to-device data setup packet, keep track of the request details for the EP0_RxRead call */
				usb_ep0_active_req.bmRequestType = req->bmRequest;
				usb_ep0_active_req.bRequest      = req->bRequest;
				usb_ep0_active_req.wValue        = req->wValue;
				usb_ep0_active_req.wIndex        = req->wIndex;
				usb_ep0_active_req.wLength       = req->wLength;
			}
		} else {
			/* No Setup handler or Setup handler failed */
			USBD_CtlError (&pios_usb_otg_core_handle, req);
		}
		break;
	}
	default:
		/* Unhandled Setup */
		USBD_CtlError (&pios_usb_otg_core_handle, req);
 		break;
	}

	return USBD_OK;
}

static uint8_t PIOS_USBHOOK_CLASS_EP0_TxSent(void *pdev)
{
	return USBD_OK;
}

static uint8_t PIOS_USBHOOK_CLASS_EP0_RxReady(void *pdev)
{
	uint8_t ifnum = LOBYTE(usb_ep0_active_req.wIndex);

	if ((ifnum < NELEMENTS(usb_if_table)) &&
	    (usb_if_table[ifnum].ifops && usb_if_table[ifnum].ifops->ctrl_data_out)) {
		usb_if_table[ifnum].ifops->ctrl_data_out(usb_if_table[ifnum].context, 
							&usb_ep0_active_req);
	}

	return USBD_OK;
}

static uint8_t PIOS_USBHOOK_CLASS_DataIn(void *pdev, uint8_t epnum)
{
	/* Make sure the previous transfer has completed before starting a new one */
	DCD_EP_Flush(pdev, epnum);	/* NOT SURE IF THIS IS REQUIRED */

	/* Remove the direction bit so we can use this as an index */
	epnum = epnum & 0xF;

	if ((epnum < NELEMENTS(usb_epin_table)) && usb_epin_table[epnum].cb) {
		struct usb_ep_entry *ep = &(usb_epin_table[epnum]);
		ep->cb(ep->context, epnum, ep->max_len);
	}

	return USBD_OK;
}

static uint8_t PIOS_USBHOOK_CLASS_DataOut(void *pdev, uint8_t epnum)
{
	/* Remove the direction bit so we can use this as an index */
	epnum = epnum & 0xF;

	if ((epnum < NELEMENTS(usb_epout_table)) && usb_epout_table[epnum].cb) {
		struct usb_ep_entry *ep = &(usb_epout_table[epnum]);
		ep->cb(ep->context, epnum, ep->max_len);
	}

	return USBD_OK;
}

static uint8_t PIOS_USBHOOK_CLASS_SOF(void *pdev)
{
	return USBD_OK;
}

static uint8_t PIOS_USBHOOK_CLASS_IsoINIncomplete(void *pdev)
{
	return USBD_OK;
}

static uint8_t PIOS_USBHOOK_CLASS_IsoOUTIncomplete(void *pdev)
{
	return USBD_OK;
}

static const uint8_t * PIOS_USBHOOK_CLASS_GetConfigDescriptor(uint8_t speed, uint16_t *length)
{
	*length = Config_Descriptor.length;
	return Config_Descriptor.descriptor;
}

#ifdef USB_OTG_HS_CORE
static const uint8_t * PIOS_USBHOOK_CLASS_GetOtherConfigDescriptor(uint8_t speed, uint16_t *length)
{
	return PIOS_USBHOOK_CLASS_GetConfigDescriptor(speed, length);
}
#endif	/* USB_OTG_HS_CORE */

#ifdef USB_SUPPORT_USER_STRING_DESC
static const uint8_t * PIOS_USBHOOK_CLASS_GetUsrStrDescriptor(uint8_t speed, uint8_t index, uint16_t *length)
{
	return NULL;
}
#endif	/* USB_SUPPORT_USER_STRING_DESC */

static USBD_Class_cb_TypeDef class_callbacks = {
	.Init                     = PIOS_USBHOOK_CLASS_Init,
	.DeInit                   = PIOS_USBHOOK_CLASS_DeInit,
	.Setup                    = PIOS_USBHOOK_CLASS_Setup,
	.EP0_TxSent               = PIOS_USBHOOK_CLASS_EP0_TxSent,
	.EP0_RxReady              = PIOS_USBHOOK_CLASS_EP0_RxReady,
	.DataIn                   = PIOS_USBHOOK_CLASS_DataIn,
	.DataOut                  = PIOS_USBHOOK_CLASS_DataOut,
	.SOF                      = PIOS_USBHOOK_CLASS_SOF,
	.IsoINIncomplete          = PIOS_USBHOOK_CLASS_IsoINIncomplete,
	.IsoOUTIncomplete         = PIOS_USBHOOK_CLASS_IsoOUTIncomplete,
	.GetConfigDescriptor      = PIOS_USBHOOK_CLASS_GetConfigDescriptor,
#ifdef USB_OTG_HS_CORE
	.GetOtherConfigDescriptor = PIOS_USBHOOK_CLASS_GetOtherConfigDescriptor,
#endif	/* USB_OTG_HS_CORE */
#ifdef USB_SUPPORT_USER_STRING_DESC
	.GetUsrStrDescriptor      = PIOS_USBHOOK_CLASS_GetUsrStrDescriptor,
#endif	/* USB_SUPPORT_USER_STRING_DESC */
};

#if 0
#include "stm32f10x.h"		/* __IO */
__IO uint8_t EXTI_Enable;

uint32_t ProtocolValue;

DEVICE Device_Table = {
	PIOS_USB_BOARD_EP_NUM,
	1
};

static void PIOS_USBHOOK_Init(void);
static void PIOS_USBHOOK_Reset(void);
static void PIOS_USBHOOK_Status_In(void);
static void PIOS_USBHOOK_Status_Out(void);
static RESULT PIOS_USBHOOK_Data_Setup(uint8_t RequestNo);
static RESULT PIOS_USBHOOK_NoData_Setup(uint8_t RequestNo);
static RESULT PIOS_USBHOOK_Get_Interface_Setting(uint8_t Interface, uint8_t AlternateSetting);
static const uint8_t *PIOS_USBHOOK_GetDeviceDescriptor(uint16_t Length);
static const uint8_t *PIOS_USBHOOK_GetConfigDescriptor(uint16_t Length);
static const uint8_t *PIOS_USBHOOK_GetStringDescriptor(uint16_t Length);

DEVICE_PROP Device_Property = {
	.Init                        = PIOS_USBHOOK_Init,
	.Reset                       = PIOS_USBHOOK_Reset,
	.Process_Status_IN           = PIOS_USBHOOK_Status_In,
	.Process_Status_OUT          = PIOS_USBHOOK_Status_Out,
	.Class_Data_Setup            = PIOS_USBHOOK_Data_Setup,
	.Class_NoData_Setup          = PIOS_USBHOOK_NoData_Setup,
	.Class_Get_Interface_Setting = PIOS_USBHOOK_Get_Interface_Setting,
	.GetDeviceDescriptor         = PIOS_USBHOOK_GetDeviceDescriptor,
	.GetConfigDescriptor         = PIOS_USBHOOK_GetConfigDescriptor,
	.GetStringDescriptor         = PIOS_USBHOOK_GetStringDescriptor,
	.RxEP_buffer                 = 0,
	.MaxPacketSize               = 0x40,
};

static void PIOS_USBHOOK_SetConfiguration(void);
static void PIOS_USBHOOK_SetDeviceAddress(void);

USER_STANDARD_REQUESTS User_Standard_Requests = {
	.User_GetConfiguration   = NOP_Process,
	.User_SetConfiguration   = PIOS_USBHOOK_SetConfiguration,
	.User_GetInterface       = NOP_Process,
	.User_SetInterface       = NOP_Process,
	.User_GetStatus          = NOP_Process,
	.User_ClearFeature       = NOP_Process,
	.User_SetEndPointFeature = NOP_Process,
	.User_SetDeviceFeature   = NOP_Process,
	.User_SetDeviceAddress   = PIOS_USBHOOK_SetDeviceAddress
};

static RESULT PIOS_USBHOOK_SetProtocol(void);
static const uint8_t *PIOS_USBHOOK_GetProtocolValue(uint16_t Length);
static const uint8_t *PIOS_USBHOOK_GetReportDescriptor(uint16_t Length);
static const uint8_t *PIOS_USBHOOK_GetHIDDescriptor(uint16_t Length);

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_Init.
* Description    : Custom HID init routine.
* Input          : None.
* Output         : None.
* Return         : None.
*******************************************************************************/
static void PIOS_USBHOOK_Init(void)
{
	pInformation->Current_Configuration = 0;

	/* Connect the device */
	PowerOn();

	/* Perform basic device initialization operations */
	USB_SIL_Init();

	bDeviceState = UNCONNECTED;
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_Reset.
* Description    : Custom HID reset routine.
* Input          : None.
* Output         : None.
* Return         : None.
*******************************************************************************/
static void PIOS_USBHOOK_Reset(void)
{
	/* Set DEVICE as not configured */
	pInformation->Current_Configuration = 0;
	pInformation->Current_Interface = 0;	/*the default Interface */

	/* Current Feature initialization */
	pInformation->Current_Feature = 0;

#ifdef STM32F10X_CL
	/* EP0 is already configured in DFU_Init() by USB_SIL_Init() function */

	/* Init EP1 IN as Interrupt endpoint */
	OTG_DEV_EP_Init(EP1_IN, OTG_DEV_EP_TYPE_INT, 2);

	/* Init EP1 OUT as Interrupt endpoint */
	OTG_DEV_EP_Init(EP1_OUT, OTG_DEV_EP_TYPE_INT, 2);
#else
	SetBTABLE(BTABLE_ADDRESS);

	/* Initialize Endpoint 0 (Control) */
	SetEPType(ENDP0, EP_CONTROL);
	SetEPTxAddr(ENDP0, ENDP0_TXADDR);
	SetEPTxStatus(ENDP0, EP_TX_STALL);
	Clear_Status_Out(ENDP0);

	SetEPRxAddr(ENDP0, ENDP0_RXADDR);
	SetEPRxCount(ENDP0, Device_Property.MaxPacketSize);
	SetEPRxValid(ENDP0);

#if defined(PIOS_INCLUDE_USB_HID)
	/* Initialize Endpoint 1 (HID) */
	SetEPType(ENDP1, EP_INTERRUPT);
	SetEPTxAddr(ENDP1, ENDP1_TXADDR);
	SetEPTxCount(ENDP1, PIOS_USB_BOARD_HID_DATA_LENGTH);
	SetEPTxStatus(ENDP1, EP_TX_NAK);

	SetEPRxAddr(ENDP1, ENDP1_RXADDR);
	SetEPRxCount(ENDP1, PIOS_USB_BOARD_HID_DATA_LENGTH);
	SetEPRxStatus(ENDP1, EP_RX_VALID);
#endif	/* PIOS_INCLUDE_USB_HID */

#if defined(PIOS_INCLUDE_USB_CDC)
	/* Initialize Endpoint 2 (CDC Call Control) */
	SetEPType(ENDP2, EP_INTERRUPT);
	SetEPTxAddr(ENDP2, ENDP2_TXADDR);
	SetEPTxStatus(ENDP2, EP_TX_NAK);

	SetEPRxAddr(ENDP2, ENDP2_RXADDR);
	SetEPRxCount(ENDP2, PIOS_USB_BOARD_CDC_MGMT_LENGTH);
	SetEPRxStatus(ENDP2, EP_RX_DIS);

	/* Initialize Endpoint 3 (CDC Data) */
	SetEPType(ENDP3, EP_BULK);
	SetEPTxAddr(ENDP3, ENDP3_TXADDR);
	SetEPTxStatus(ENDP3, EP_TX_NAK);

	SetEPRxAddr(ENDP3, ENDP3_RXADDR);
	SetEPRxCount(ENDP3, PIOS_USB_BOARD_CDC_DATA_LENGTH);
	SetEPRxStatus(ENDP3, EP_RX_VALID);

#endif	/* PIOS_INCLUDE_USB_CDC */

	/* Set this device to response on default address */
	SetDeviceAddress(0);
#endif /* STM32F10X_CL */

	bDeviceState = ATTACHED;
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_SetConfiguration.
* Description    : Update the device state to configured
* Input          : None.
* Output         : None.
* Return         : None.
*******************************************************************************/
static void PIOS_USBHOOK_SetConfiguration(void)
{
	if (pInformation->Current_Configuration != 0) {
		/* Device configured */
		bDeviceState = CONFIGURED;
	}

	/* Enable transfers */
	PIOS_USB_ChangeConnectionState(pInformation->Current_Configuration != 0);
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_SetConfiguration.
* Description    : Update the device state to addressed.
* Input          : None.
* Output         : None.
* Return         : None.
*******************************************************************************/
static void PIOS_USBHOOK_SetDeviceAddress(void)
{
	bDeviceState = ADDRESSED;
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_Status_In.
* Description    : status IN routine.
* Input          : None.
* Output         : None.
* Return         : None.
*******************************************************************************/
static void PIOS_USBHOOK_Status_In(void)
{
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_Status_Out
* Description    : status OUT routine.
* Input          : None.
* Output         : None.
* Return         : None.
*******************************************************************************/
static void PIOS_USBHOOK_Status_Out(void)
{
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_Data_Setup
* Description    : Handle the data class specific requests.
* Input          : Request Nb.
* Output         : None.
* Return         : USB_UNSUPPORT or USB_SUCCESS.
*******************************************************************************/
static RESULT PIOS_USBHOOK_Data_Setup(uint8_t RequestNo)
{
	const uint8_t *(*CopyRoutine) (uint16_t);

	CopyRoutine = NULL;

	switch (Type_Recipient) {
	case (STANDARD_REQUEST | INTERFACE_RECIPIENT):
		switch (pInformation->USBwIndex0) {
		case 0:		/* HID Interface */
			switch (RequestNo) {
			case GET_DESCRIPTOR:
				switch (pInformation->USBwValue1) {
				case USB_DESC_TYPE_REPORT:
					CopyRoutine = PIOS_USBHOOK_GetReportDescriptor;
					break;
				case USB_DESC_TYPE_HID:
					CopyRoutine = PIOS_USBHOOK_GetHIDDescriptor;
					break;
				}
			}
		}
		break;

	case (CLASS_REQUEST | INTERFACE_RECIPIENT):
		switch (pInformation->USBwIndex0) {
		case 0:		/* HID Interface */
			switch (RequestNo) {
			case GET_PROTOCOL:
				CopyRoutine = PIOS_USBHOOK_GetProtocolValue;
				break;
			}

			break;
#if defined(PIOS_INCLUDE_USB_CDC)
		case 1:		/* CDC Call Control Interface */
			switch (RequestNo) {
			case GET_LINE_CODING:
				CopyRoutine = PIOS_USB_CDC_GetLineCoding;
				break;
			}

			break;

		case 2:		/* CDC Data Interface */
			switch (RequestNo) {
			case 0:
				break;
			}

			break;
#endif	/* PIOS_INCLUDE_USB_CDC */
		}
		break;
	}

	if (CopyRoutine == NULL) {
		return USB_UNSUPPORT;
	}

	pInformation->Ctrl_Info.CopyDataIn = CopyRoutine;
	pInformation->Ctrl_Info.Usb_wOffset = 0;
	(*CopyRoutine) (0);
	return USB_SUCCESS;
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_NoData_Setup
* Description    : handle the no data class specific requests
* Input          : Request Nb.
* Output         : None.
* Return         : USB_UNSUPPORT or USB_SUCCESS.
*******************************************************************************/
static RESULT PIOS_USBHOOK_NoData_Setup(uint8_t RequestNo)
{
	switch (Type_Recipient) {
	case (CLASS_REQUEST | INTERFACE_RECIPIENT):
		switch (pInformation->USBwIndex0) {
		case 0:		/* HID */
			switch (RequestNo) {
			case SET_PROTOCOL:
				return PIOS_USBHOOK_SetProtocol();
				break;
			}

			break;

#if defined(PIOS_INCLUDE_USB_CDC)
		case 1:		/* CDC Call Control Interface */
			switch (RequestNo) {
			case SET_LINE_CODING:
				return PIOS_USB_CDC_SetLineCoding();
				break;
			case SET_CONTROL_LINE_STATE:
				return PIOS_USB_CDC_SetControlLineState();
				break;
			}

			break;
#endif	/* PIOS_INCLUDE_USB_CDC */
		}

		break;
	}

	return USB_UNSUPPORT;
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_GetDeviceDescriptor.
* Description    : Gets the device descriptor.
* Input          : Length
* Output         : None.
* Return         : The address of the device descriptor.
*******************************************************************************/
static const uint8_t *PIOS_USBHOOK_GetDeviceDescriptor(uint16_t Length)
{
	return Standard_GetDescriptorData(Length, &Device_Descriptor);
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_GetConfigDescriptor.
* Description    : Gets the configuration descriptor.
* Input          : Length
* Output         : None.
* Return         : The address of the configuration descriptor.
*******************************************************************************/
static const uint8_t *PIOS_USBHOOK_GetConfigDescriptor(uint16_t Length)
{
	return Standard_GetDescriptorData(Length, &Config_Descriptor);
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_GetStringDescriptor
* Description    : Gets the string descriptors according to the needed index
* Input          : Length
* Output         : None.
* Return         : The address of the string descriptors.
*******************************************************************************/
static const uint8_t *PIOS_USBHOOK_GetStringDescriptor(uint16_t Length)
{
	uint8_t wValue0 = pInformation->USBwValue0;
	if (wValue0 > 4) {
		return NULL;
	} else {
		return Standard_GetDescriptorData(Length, &String_Descriptor[wValue0]);
	}
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_GetReportDescriptor.
* Description    : Gets the HID report descriptor.
* Input          : Length
* Output         : None.
* Return         : The address of the configuration descriptor.
*******************************************************************************/
static const uint8_t *PIOS_USBHOOK_GetReportDescriptor(uint16_t Length)
{
	return Standard_GetDescriptorData(Length, &Hid_Report_Descriptor);
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_GetHIDDescriptor.
* Description    : Gets the HID descriptor.
* Input          : Length
* Output         : None.
* Return         : The address of the configuration descriptor.
*******************************************************************************/
static const uint8_t *PIOS_USBHOOK_GetHIDDescriptor(uint16_t Length)
{
	return Standard_GetDescriptorData(Length, &Hid_Interface_Descriptor);
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_Get_Interface_Setting.
* Description    : tests the interface and the alternate setting according to the
*                  supported one.
* Input          : - Interface : interface number.
*                  - AlternateSetting : Alternate Setting number.
* Output         : None.
* Return         : USB_SUCCESS or USB_UNSUPPORT.
*******************************************************************************/
static RESULT PIOS_USBHOOK_Get_Interface_Setting(uint8_t Interface, uint8_t AlternateSetting)
{
	if (AlternateSetting > 0) {
		return USB_UNSUPPORT;
	} else if (Interface > 0) {
		return USB_UNSUPPORT;
	}
	return USB_SUCCESS;
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_SetProtocol
* Description    : Set Protocol request routine.
* Input          : None.
* Output         : None.
* Return         : USB SUCCESS.
*******************************************************************************/
static RESULT PIOS_USBHOOK_SetProtocol(void)
{
	uint8_t wValue0 = pInformation->USBwValue0;
	ProtocolValue = wValue0;
	return USB_SUCCESS;
}

/*******************************************************************************
* Function Name  : PIOS_USBHOOK_GetProtocolValue
* Description    : get the protocol value
* Input          : Length.
* Output         : None.
* Return         : address of the protcol value.
*******************************************************************************/
static const uint8_t *PIOS_USBHOOK_GetProtocolValue(uint16_t Length)
{
	if (Length == 0) {
		pInformation->Ctrl_Info.Usb_wLength = 1;
		return NULL;
	} else {
		return (uint8_t *) (&ProtocolValue);
	}
}

/******************* (C) COPYRIGHT 2010 STMicroelectronics *****END OF FILE****/
#endif