/*
**************************************************************************************************************
*                                                 NXP USB Host Stack
*
*                                     (c) Copyright 2008, NXP SemiConductors
*                                     (c) Copyright 2008, OnChip  Technologies LLC
*                                                 All Rights Reserved
*
*                                                  www.nxp.com
*                                               www.onchiptech.com
*
* File           : usbhost_lpc2388.h
* Programmer(s)  : Ravikanth.P
* Version        :
*
**************************************************************************************************************
*/

#ifndef USBHOST_LPC2468_H
#define USBHOST_LPC2468_H

/*
**************************************************************************************************************
*                                       INCLUDE HEADER FILES
**************************************************************************************************************
*/

#include    "usbhost_inc.h"

/*
**************************************************************************************************************
*                                        PRINT CONFIGURATION
**************************************************************************************************************
*/

#define  PRINT_ENABLE         1

#if PRINT_ENABLE
#define  PRINT_Log(...)       cons_printf(__VA_ARGS__)
#define  PRINT_Err(rc)        cons_printf("ERROR: In %s at Line %u - rc = %d\n\r", __FUNCTION__, __LINE__, rc)

#else
#define  PRINT_Log(...)
#define  PRINT_Err(rc)

#endif

/*
**************************************************************************************************************
*                                        GENERAL DEFINITIONS
**************************************************************************************************************
*/

#define  DESC_LENGTH(x)  x[0]
#define  DESC_TYPE(x)    x[1]


#define  HOST_GET_DESCRIPTOR(descType, descIndex, data, length)                      \
         Host_CtrlRecv(USB_DEVICE_TO_HOST | USB_RECIPIENT_DEVICE, GET_DESCRIPTOR,    \
         (descType << 8)|(descIndex), 0, length, data)

#define  HOST_SET_ADDRESS(new_addr)                                                  \
         Host_CtrlSend(USB_HOST_TO_DEVICE | USB_RECIPIENT_DEVICE, SET_ADDRESS,       \
         new_addr, 0, 0, NULL)

#define  USBH_SET_CONFIGURATION(configNum)                                           \
         Host_CtrlSend(USB_HOST_TO_DEVICE | USB_RECIPIENT_DEVICE, SET_CONFIGURATION, \
         configNum, 0, 0, NULL)

#define  USBH_SET_INTERFACE(ifNum, altNum)                                           \
         Host_CtrlSend(USB_HOST_TO_DEVICE | USB_RECIPIENT_INTERFACE, SET_INTERFACE,  \
         altNum, ifNum, 0, NULL)

/*
**************************************************************************************************************
*                                    OHCI OPERATIONAL REGISTER DEFINITIONS
**************************************************************************************************************
*/

#define  HcControl            *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C004))
#define  HcCommandStatus      *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C008))
#define  HcInterruptStatus    *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C00C))
#define  HcInterruptEnable    *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C010))
#define  HcHCCA               *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C018))
#define  HcPeriodCurrentED    *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C01C))
#define  HcControlHeadED      *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C020))
#define  HcBulkHeadED         *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C028))
#define  HcFmInterval         *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C034))
#define  HcFmRemaining        *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C038))
#define  HcFmNumber	      *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C03C))
#define  HcPeriodicStart      *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C040))
#define  HcRhStatus           *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C050))
#define  HcRhPortStatus1       *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C054))
#define  HcRhPortStatus2       *((volatile USB_INT32U*)((USB_INT32U)0xFFE0C058))

/*
**************************************************************************************************************
*                                  OHCI OPERATIONAL REGISTER FIELD DEFINITIONS
**************************************************************************************************************
*/

/* ------------------ HcControl Register ---------------------  */
#define  OR_CONTROL_PLE                 0x00000004
#define  OR_CONTROL_IE                  0x00000008
#define  OR_CONTROL_CLE                 0x00000010
#define  OR_CONTROL_BLE                 0x00000020
#define  OR_CONTROL_HCFS                0x000000C0
#define  OR_CONTROL_HC_OPER             0x00000080
/* ----------------- HcCommandStatus Register ----------------- */
#define  OR_CMD_STATUS_HCR              0x00000001
#define  OR_CMD_STATUS_CLF              0x00000002
#define  OR_CMD_STATUS_BLF              0x00000004
/* --------------- HcInterruptStatus Register ----------------- */
#define  OR_INTR_STATUS_WDH             0x00000002
#define  OR_INTR_STATUS_RHSC            0x00000040
/* --------------- HcInterruptEnable Register ----------------- */
#define  OR_INTR_ENABLE_WDH             0x00000002
#define  OR_INTR_ENABLE_RHSC            0x00000040
#define  OR_INTR_ENABLE_MIE             0x80000000
/* ---------------- HcRhDescriptorA Register ------------------ */
#define  OR_RH_STATUS_LPSC              0x00010000
/* -------------- HcRhPortStatus[1:NDP] Register -------------- */
#define  OR_RH_PORT_CCS                 0x00000001
#define  OR_RH_PORT_PRS                 0x00000010
#define  OR_RH_PORT_CSC                 0x00010000
#define  OR_RH_PORT_PRSC                0x00100000


/*
**************************************************************************************************************
*                                               FRAME INTERVAL
**************************************************************************************************************
*/

#define  FI            0x2EDF           /* 12000 bits per frame (-1) */
#define  DEFAULT_FMINTERVAL     ((((6 * (FI - 210)) / 7) << 16) | FI)

/*
**************************************************************************************************************
*                                       TRANSFER DESCRIPTOR CONTROL FIELDS
**************************************************************************************************************
*/

#define  TD_ROUNDING        (USB_INT32U) (0x00040000)        /* Buffer Rounding                             */
#define  TD_SETUP           (USB_INT32U)(0)                  /* Direction of Setup Packet                   */
#define  TD_IN              (USB_INT32U)(0x00100000)         /* Direction In                                */
#define  TD_OUT             (USB_INT32U)(0x00080000)         /* Direction Out                               */
#define  TD_DELAY_INT(x)    (USB_INT32U)((x) << 21)          /* Delay Interrupt                             */
#define  TD_TOGGLE_0        (USB_INT32U)(0x02000000)         /* Toggle 0                                    */
#define  TD_TOGGLE_1        (USB_INT32U)(0x03000000)         /* Toggle 1                                    */
#define  TD_CC              (USB_INT32U)(0xF0000000)         /* Completion Code                             */

/*
**************************************************************************************************************
*                                       USB STANDARD REQUEST DEFINITIONS
**************************************************************************************************************
*/

#define  USB_DESCRIPTOR_TYPE_DEVICE                     1
#define  USB_DESCRIPTOR_TYPE_CONFIGURATION              2
#define  USB_DESCRIPTOR_TYPE_INTERFACE                  4
#define  USB_DESCRIPTOR_TYPE_ENDPOINT                   5
#define  USB_DESCRIPTOR_TYPE_REPORT                  0x22

#define  USB_DESCRIPTOR_TYPE_AUDIO_DEVICE            0x21
#define  USB_DESCRIPTOR_TYPE_AUDIO_INTERFACE         0x24
#define  USB_DESCRIPTOR_TYPE_AUDIO_ENDPOINT          0x25
/*  ----------- Control RequestType Fields  ----------- */
#define  USB_DEVICE_TO_HOST         0x80
#define  USB_HOST_TO_DEVICE         0x00
#define  USB_REQUEST_TYPE_CLASS     0x20
#define  USB_RECIPIENT_DEVICE       0x00
#define  USB_RECIPIENT_INTERFACE    0x01
/* -------------- USB Standard Requests  -------------- */
#define  SET_ADDRESS                 5
#define  GET_DESCRIPTOR              6
#define  SET_CONFIGURATION           9
#define  GET_INTERFACE              10
#define  SET_INTERFACE              11

#define	SET_FEATURE_UNIT	    0x21
#define	GET_FEATURE_UNIT	    0xa1

#define	SET_ENDPOINT_CONTROL	    0x22
#define	GET_ENDPOINT_CONTROL	    0xa2

/*
**************************************************************************************************************
*                                       TYPE DEFINITIONS
**************************************************************************************************************
*/

typedef struct hcEd {                      /* ----------- HostController EndPoint Descriptor ------------- */
    volatile  USB_INT32U  Control;     /* Endpoint descriptor control */
    volatile  USB_INT32U  TailTd;      /* Physical address of tail in Transfer descriptor list */
    volatile  USB_INT32U  HeadTd;      /* Physcial address of head in Transfer descriptor list */
    volatile  USB_INT32U  Next;        /* Physical address of next Endpoint descriptor */
} HCED;

typedef struct hcTd {                       /* ------------ HostController Transfer Descriptor ------------ */
    volatile  USB_INT32U  Control;     /* Transfer descriptor control */
    volatile  USB_INT32U  CurrBufPtr;  /* Physical address of current buffer pointer */
    volatile  USB_INT32U  Next;        /* Physical pointer to next Transfer Descriptor  */
    volatile  USB_INT32U  BufEnd;      /* Physical address of end of buffer  */
} HCTD;

typedef struct hcIsoTd {
    volatile  USB_INT32U  Control;     /* Transfer descriptor control */
    volatile  USB_INT32U  BP0;
    volatile  USB_INT32U  Next;        /* Physical pointer to next Transfer Descriptor  */
    volatile  USB_INT32U  BufEnd;      /* Physical address of end of buffer  */
    volatile  USB_INT16U  Offset[8];
} HCISOTD;

typedef struct hcca {                       /* ----------- Host Controller Communication Area ------------  */
    volatile  USB_INT32U  IntTable[32];     /* Interrupt Table */
    volatile  USB_INT32U  FrameNumber;      /* Frame Number */
    volatile  USB_INT32U  DoneHead;         /* Done Head */
    volatile  USB_INT08U  Reserved[116];    /* Reserved for future use */
    volatile  USB_INT08U  Unknown[4];       /* Unused  */
} HCCA;

/*
**************************************************************************************************************
*                                     EXTERN DECLARATIONS
**************************************************************************************************************
*/

extern  volatile  HCED        *EDBulkIn;        /* BulkIn endpoint descriptor  structure                    */
extern  volatile  HCED        *EDBulkOut;       /* BulkOut endpoint descriptor structure                    */
extern  volatile  HCED        *EDIsoOut;        /* IsoOut endpoint descriptor structure                    */
extern  volatile  HCTD        *TDHead;          /* Head transfer descriptor structure                       */
extern  volatile  HCTD        *TDTail;          /* Tail transfer descriptor structure                       */
extern  volatile  USB_INT08U  *TDBuffer;        /* Current Buffer Pointer of transfer descriptor            */
extern  volatile  USB_INT08U  *ParamBuffer;       /* Buffer used by FAT file system                           */
extern  volatile  USB_INT08U  *UserBuffer;      /* Buffer used by application                               */

/*
**************************************************************************************************************
*                                       FUNCTION PROTOTYPES
**************************************************************************************************************
*/

void        Host_Init     (void);

void        Host_Isr      (void);

USB_INT32S  Host_EnumDev  (int debug);

USB_INT32S  Host_ProcessTD(volatile  HCED       *ed,
                           volatile  USB_INT32U  token,
                           volatile  USB_INT08U *buffer,
                                     USB_INT32U  buffer_len);

void        Host_DelayUS  (          USB_INT32U    delay);
void        Host_DelayMS  (          USB_INT32U    delay);


void        Host_TDInit   (volatile  HCTD *td);
void        Host_IsoTDInit(volatile  HCISOTD *td, int fn);
void        Host_EDInit   (volatile  HCED *ed);
void	    Host_IsoEDInit (volatile HCED *ed, volatile HCISOTD *td);
void        Host_HCCAInit (volatile  HCCA  *hcca);

USB_INT32S  Host_CtrlRecv (          USB_INT08U   bm_request_type,
                                     USB_INT08U   b_request,
                                     USB_INT16U   w_value,
                                     USB_INT16U   w_index,
                                     USB_INT16U   w_length,
                           volatile  USB_INT08U  *buffer);

USB_INT32S  Host_CtrlSend (          USB_INT08U   bm_request_type,
                                     USB_INT08U   b_request,
                                     USB_INT16U   w_value,
                                     USB_INT16U   w_index,
                                     USB_INT16U   w_length,
                           volatile  USB_INT08U  *buffer);

void        Host_FillSetup(          USB_INT08U   bm_request_type,
                                     USB_INT08U   b_request,
                                     USB_INT16U   w_value,
                                     USB_INT16U   w_index,
                                     USB_INT16U   w_length);


void        Host_WDHWait  (void);


USB_INT32U  ReadLE32U     (volatile  USB_INT08U  *pmem);
void        WriteLE32U    (volatile  USB_INT08U  *pmem,
                                     USB_INT32U   val);
USB_INT16U  ReadLE16U     (volatile  USB_INT08U  *pmem);
void        WriteLE16U    (volatile  USB_INT08U  *pmem,
                                     USB_INT16U   val);
USB_INT32U  ReadBE32U     (volatile  USB_INT08U  *pmem);
void        WriteBE32U    (volatile  USB_INT08U  *pmem,
                                     USB_INT32U   val);
USB_INT16U  ReadBE16U     (volatile  USB_INT08U  *pmem);
void        WriteBE16U    (volatile  USB_INT08U  *pmem,
                                     USB_INT16U   val);

USB_INT08U  GetPlugStatus();

#endif
