usbd_hw.h

Go to the documentation of this file.

/***********************************************************************
* $Id: mw_usbd_hw.h.rca 1.4 Tue Nov  1 11:45:07 2011 nlv09221 Experimental $
*
* Project: USB device ROM Stack
*
* Description:
*     USB Hardware Function prototypes.
*
***********************************************************************
*   Copyright(C) 2011, NXP Semiconductor
*   All rights reserved.
*
* Software that is described herein is for illustrative purposes only
* which provides customers with programming information regarding the
* products. This software is supplied "AS IS" without any warranties.
* NXP Semiconductors assumes no responsibility or liability for the
* use of the software, conveys no license or title under any patent,
* copyright, or mask work right to the product. NXP Semiconductors
* reserves the right to make changes in the software without
* notification. NXP Semiconductors also make no representation or
* warranty that such application will be suitable for the specified
* use without further testing or modification.
**********************************************************************/
#ifndef __USBHW_H__
#define __USBHW_H__

#include "error.h"
#include "usbd.h"
#include "usbd_core.h"

enum USBD_EVENT_T {
  USB_EVT_SETUP =1,    
  USB_EVT_OUT,         
  USB_EVT_IN,          
  USB_EVT_OUT_NAK,     
  USB_EVT_IN_NAK,      
  USB_EVT_OUT_STALL,   
  USB_EVT_IN_STALL,    
  USB_EVT_OUT_DMA_EOT, 
  USB_EVT_IN_DMA_EOT,  
  USB_EVT_OUT_DMA_NDR, 
  USB_EVT_IN_DMA_NDR,  
  USB_EVT_OUT_DMA_ERR, 
  USB_EVT_IN_DMA_ERR,  
  USB_EVT_RESET,       
  USB_EVT_SOF,         
  USB_EVT_DEV_STATE,   
  USB_EVT_DEV_ERROR   
};

typedef struct USBD_HW_API
{
  uint32_t (*GetMemSize)(USBD_API_INIT_PARAM_T* param);
  
  ErrorCode_t (*Init)(USBD_HANDLE_T* phUsb, USB_CORE_DESCS_T* pDesc, USBD_API_INIT_PARAM_T* param);
  
  void (*Connect)(USBD_HANDLE_T hUsb, uint32_t con);
  
  void (*ISR)(USBD_HANDLE_T hUsb);

  void  (*Reset)(USBD_HANDLE_T hUsb);
  
  void  (*ForceFullSpeed )(USBD_HANDLE_T hUsb, uint32_t cfg);
  
  void  (*WakeUpCfg)(USBD_HANDLE_T hUsb, uint32_t  cfg);
  
  void  (*SetAddress)(USBD_HANDLE_T hUsb, uint32_t adr);

  void  (*Configure)(USBD_HANDLE_T hUsb, uint32_t  cfg);

  void  (*ConfigEP)(USBD_HANDLE_T hUsb, USB_ENDPOINT_DESCRIPTOR *pEPD);

  void  (*DirCtrlEP)(USBD_HANDLE_T hUsb, uint32_t dir);

  void  (*EnableEP)(USBD_HANDLE_T hUsb, uint32_t EPNum);

  void  (*DisableEP)(USBD_HANDLE_T hUsb, uint32_t EPNum);

  void  (*ResetEP)(USBD_HANDLE_T hUsb, uint32_t EPNum);

  void  (*SetStallEP)(USBD_HANDLE_T hUsb, uint32_t EPNum);

  void  (*ClrStallEP)(USBD_HANDLE_T hUsb, uint32_t EPNum);

  ErrorCode_t (*SetTestMode)(USBD_HANDLE_T hUsb, uint8_t mode); 

  uint32_t (*ReadEP)(USBD_HANDLE_T hUsb, uint32_t EPNum, uint8_t *pData);

  uint32_t (*ReadReqEP)(USBD_HANDLE_T hUsb, uint32_t EPNum, uint8_t *pData, uint32_t len);

  uint32_t (*ReadSetupPkt)(USBD_HANDLE_T hUsb, uint32_t EPNum, uint32_t *pData);

  uint32_t (*WriteEP)(USBD_HANDLE_T hUsb, uint32_t EPNum, uint8_t *pData, uint32_t cnt);

  void  (*WakeUp)(USBD_HANDLE_T hUsb);

  ErrorCode_t  (*EnableEvent)(USBD_HANDLE_T hUsb, uint32_t EPNum, uint32_t event_type, 
    uint32_t enable);

} USBD_HW_API_T;

/*-----------------------------------------------------------------------------
 *  Private functions & structures prototypes used by stack internally
 *-----------------------------------------------------------------------------*/
/* Driver functions */
uint32_t hwUSB_GetMemSize(USBD_API_INIT_PARAM_T* param);
ErrorCode_t hwUSB_Init(USBD_HANDLE_T* phUsb, USB_CORE_DESCS_T* pDesc, USBD_API_INIT_PARAM_T* param);
void hwUSB_Connect(USBD_HANDLE_T hUsb, uint32_t con);
void hwUSB_ISR(USBD_HANDLE_T hUsb);

/* USB Hardware Functions */
extern void  hwUSB_Reset(USBD_HANDLE_T hUsb);
extern void  hwUSB_ForceFullSpeed (USBD_HANDLE_T hUsb, uint32_t con);
extern void  hwUSB_WakeUpCfg(USBD_HANDLE_T hUsb, uint32_t  cfg);
extern void  hwUSB_SetAddress(USBD_HANDLE_T hUsb, uint32_t adr);
extern void  hwUSB_Configure(USBD_HANDLE_T hUsb, uint32_t  cfg);
extern void  hwUSB_ConfigEP(USBD_HANDLE_T hUsb, USB_ENDPOINT_DESCRIPTOR *pEPD);
extern void  hwUSB_DirCtrlEP(USBD_HANDLE_T hUsb, uint32_t dir);
extern void  hwUSB_EnableEP(USBD_HANDLE_T hUsb, uint32_t EPNum);
extern void  hwUSB_DisableEP(USBD_HANDLE_T hUsb, uint32_t EPNum);
extern void  hwUSB_ResetEP(USBD_HANDLE_T hUsb, uint32_t EPNum);
extern void  hwUSB_SetStallEP(USBD_HANDLE_T hUsb, uint32_t EPNum);
extern void  hwUSB_ClrStallEP(USBD_HANDLE_T hUsb, uint32_t EPNum);
extern ErrorCode_t hwUSB_SetTestMode(USBD_HANDLE_T hUsb, uint8_t mode); /* for FS only devices return ERR_USBD_INVALID_REQ */
extern uint32_t hwUSB_ReadEP(USBD_HANDLE_T hUsb, uint32_t EPNum, uint8_t *pData);
extern uint32_t hwUSB_ReadReqEP(USBD_HANDLE_T hUsb, uint32_t EPNum, uint8_t *pData, uint32_t len);
extern uint32_t hwUSB_ReadSetupPkt(USBD_HANDLE_T hUsb, uint32_t, uint32_t *);
extern uint32_t hwUSB_WriteEP(USBD_HANDLE_T hUsb, uint32_t EPNum, uint8_t *pData, uint32_t cnt);

/* generate resume signalling on the bus */
extern void  hwUSB_WakeUp(USBD_HANDLE_T hUsb);
extern ErrorCode_t  hwUSB_EnableEvent(USBD_HANDLE_T hUsb, uint32_t EPNum, uint32_t event_type, uint32_t enable);
/* TODO implement following routines
- function to program TD and queue them to ep Qh
*/

#endif  /* __USBHW_H__ */