usbd_core.h

Go to the documentation of this file.

/*
 * @brief Definition of functions exported by core layer of ROM based USB device stack
 *
 * @note
 * Copyright(C) NXP Semiconductors, 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.
 */

#ifndef __MW_USBD_CORE_H__
#define __MW_USBD_CORE_H__

#include "error.h"
#include "usbd.h"
#include "lpc_types.h"

/* function pointer types */

typedef ErrorCode_t (*USB_CB_T) (USBD_HANDLE_T hUsb);

typedef ErrorCode_t (*USB_PARAM_CB_T) (USBD_HANDLE_T hUsb, uint32_t param1);

typedef ErrorCode_t (*USB_EP_HANDLER_T)(USBD_HANDLE_T hUsb, void* data, uint32_t event);


typedef struct _USB_CORE_DESCS_T
{
  uint8_t *device_desc; 
  uint8_t *string_desc; 
  uint8_t *full_speed_desc; 
  uint8_t *high_speed_desc; 
  uint8_t *device_qualifier; 
} USB_CORE_DESCS_T;

typedef struct USBD_API_INIT_PARAM
{
  uint32_t usb_reg_base; 
  uint32_t mem_base;  
  uint32_t mem_size;  
  uint8_t max_num_ep; 
  /* USB Device Events Callback Functions */
  USB_CB_T USB_Reset_Event;

  USB_CB_T USB_Suspend_Event;

  USB_CB_T USB_Resume_Event;

  USB_CB_T reserved_sbz;

  USB_CB_T USB_SOF_Event;

  USB_PARAM_CB_T USB_WakeUpCfg;

  USB_PARAM_CB_T USB_Power_Event;

  USB_PARAM_CB_T USB_Error_Event;

  /* USB Core Events Callback Functions */
  USB_CB_T USB_Configure_Event;

  USB_CB_T USB_Interface_Event;

 USB_CB_T USB_Feature_Event;

  /* cache and mmu translation functions */
  uint32_t (* virt_to_phys)(void* vaddr);
  void (* cache_flush)(uint32_t* start_adr, uint32_t* end_adr);

} USBD_API_INIT_PARAM_T;


typedef struct USBD_CORE_API
{
  ErrorCode_t (*RegisterClassHandler)(USBD_HANDLE_T hUsb, USB_EP_HANDLER_T pfn, void* data);

  ErrorCode_t (*RegisterEpHandler)(USBD_HANDLE_T hUsb, uint32_t ep_index, USB_EP_HANDLER_T pfn, void* data);

  void (*SetupStage )(USBD_HANDLE_T hUsb);

  void (*DataInStage)(USBD_HANDLE_T hUsb);

  void (*DataOutStage)(USBD_HANDLE_T hUsb);

  void (*StatusInStage)(USBD_HANDLE_T hUsb);
  void (*StatusOutStage)(USBD_HANDLE_T hUsb);

  void (*StallEp0)(USBD_HANDLE_T hUsb);

} USBD_CORE_API_T;

/*-----------------------------------------------------------------------------
 *  Private functions & structures prototypes
 *-----------------------------------------------------------------------------*/

/* forward declaration */
struct _USB_CORE_CTRL_T;
typedef struct _USB_CORE_CTRL_T  USB_CORE_CTRL_T;

/* USB device Speed status defines */
#define USB_FULL_SPEED    0
#define USB_HIGH_SPEED    1

/* USB Endpoint Data Structure */
typedef struct _USB_EP_DATA
{
  uint8_t  *pData;
  uint16_t   Count;
} USB_EP_DATA;

#define USB_MAX_IF_NUM  8
#define USB_MAX_EP_NUM  6

/* USB core controller data structure */
struct _USB_CORE_CTRL_T
{
  /* overridable function pointers ~ c++ style virtual functions*/
  USB_CB_T USB_EvtSetupHandler;
  USB_CB_T USB_EvtOutHandler;
  USB_PARAM_CB_T USB_ReqVendor;
  USB_CB_T USB_ReqGetStatus;
  USB_CB_T USB_ReqGetDescriptor;
  USB_CB_T USB_ReqGetConfiguration;
  USB_CB_T USB_ReqSetConfiguration;
  USB_CB_T USB_ReqGetInterface;
  USB_CB_T USB_ReqSetInterface;
  USB_PARAM_CB_T USB_ReqSetClrFeature;

  /* USB Device Events Callback Functions */
  USB_CB_T USB_Reset_Event;
  USB_CB_T USB_Suspend_Event;
  USB_CB_T USB_Resume_Event;
  USB_CB_T USB_SOF_Event;
  USB_PARAM_CB_T USB_Power_Event;
  USB_PARAM_CB_T USB_Error_Event;
  USB_PARAM_CB_T USB_WakeUpCfg;

  /* USB Core Events Callback Functions */
  USB_CB_T USB_Configure_Event;
  USB_CB_T USB_Interface_Event;
  USB_CB_T USB_Feature_Event;

  /* cache and mmu translation functions */
  uint32_t (* virt_to_phys)(void* vaddr);
  void (* cache_flush)(uint32_t* start_adr, uint32_t* end_adr);

  /* event handlers for endpoints. */
  USB_EP_HANDLER_T  ep_event_hdlr[2 * USB_MAX_EP_NUM];
  void*  ep_hdlr_data[2 * USB_MAX_EP_NUM];

  /* USB class handlers */
  USB_EP_HANDLER_T  ep0_hdlr_cb[USB_MAX_IF_NUM];
  void*  ep0_cb_data[USB_MAX_IF_NUM];
  uint8_t num_ep0_hdlrs;
  /* USB Core data Variables */
  uint8_t max_num_ep; /* max number of endpoints supported by the HW */
  uint8_t device_speed;
  uint8_t  num_interfaces;
  uint8_t  device_addr;
  uint8_t  config_value;
  uint16_t device_status;
  uint8_t *device_desc;
  uint8_t *string_desc;
  uint8_t *full_speed_desc;
  uint8_t *high_speed_desc;
  uint8_t *device_qualifier;
  uint32_t ep_mask;
  uint32_t ep_halt;
  uint32_t ep_stall;
  uint8_t  alt_setting[USB_MAX_IF_NUM];
  /* HW driver data pointer */
  void* hw_data;

  /* USB Endpoint 0 Data Info */
  USB_EP_DATA EP0Data;

  /* USB Endpoint 0 Buffer */
  //ALIGNED(4)
  uint8_t  EP0Buf[64];

  /* USB Setup Packet */
  //ALIGNED(4)
  USB_SETUP_PACKET SetupPacket;

};


static INLINE void USB_SetSpeedMode(USB_CORE_CTRL_T* pCtrl, uint8_t mode)
{
  pCtrl->device_speed = mode;
}
#endif  /* __MW_USBD_CORE_H__ */