GPS USB dongle host

Dependencies:   mbed

Committer:
va009039
Date:
Fri May 04 06:58:31 2012 +0000
Revision:
1:82eaa5761719
Parent:
0:1c6af92fdc79

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
va009039 0:1c6af92fdc79 1 /*
va009039 0:1c6af92fdc79 2 **************************************************************************************************************
va009039 0:1c6af92fdc79 3 * NXP USB Host Stack
va009039 0:1c6af92fdc79 4 *
va009039 0:1c6af92fdc79 5 * (c) Copyright 2008, NXP SemiConductors
va009039 0:1c6af92fdc79 6 * (c) Copyright 2008, OnChip Technologies LLC
va009039 0:1c6af92fdc79 7 * All Rights Reserved
va009039 0:1c6af92fdc79 8 *
va009039 0:1c6af92fdc79 9 * www.nxp.com
va009039 0:1c6af92fdc79 10 * www.onchiptech.com
va009039 0:1c6af92fdc79 11 *
va009039 0:1c6af92fdc79 12 * File : usbhost_lpc17xx.h
va009039 0:1c6af92fdc79 13 * Programmer(s) : Ravikanth.P
va009039 0:1c6af92fdc79 14 * Version :
va009039 0:1c6af92fdc79 15 *
va009039 0:1c6af92fdc79 16 **************************************************************************************************************
va009039 0:1c6af92fdc79 17 */
va009039 0:1c6af92fdc79 18
va009039 0:1c6af92fdc79 19 #ifndef USBHOST_LPC17xx_H
va009039 0:1c6af92fdc79 20 #define USBHOST_LPC17xx_H
va009039 0:1c6af92fdc79 21
va009039 0:1c6af92fdc79 22 /*
va009039 0:1c6af92fdc79 23 **************************************************************************************************************
va009039 0:1c6af92fdc79 24 * INCLUDE HEADER FILES
va009039 0:1c6af92fdc79 25 **************************************************************************************************************
va009039 0:1c6af92fdc79 26 */
va009039 0:1c6af92fdc79 27
va009039 0:1c6af92fdc79 28 #include "usbhost_inc.h"
va009039 0:1c6af92fdc79 29
va009039 0:1c6af92fdc79 30 /*
va009039 0:1c6af92fdc79 31 **************************************************************************************************************
va009039 0:1c6af92fdc79 32 * PRINT CONFIGURATION
va009039 0:1c6af92fdc79 33 **************************************************************************************************************
va009039 0:1c6af92fdc79 34 */
va009039 0:1c6af92fdc79 35
va009039 0:1c6af92fdc79 36 #define PRINT_ENABLE 1
va009039 0:1c6af92fdc79 37
va009039 0:1c6af92fdc79 38 #if PRINT_ENABLE
va009039 0:1c6af92fdc79 39 #define PRINT_Log(...) fprintf(stderr,__VA_ARGS__)
va009039 0:1c6af92fdc79 40 #define PRINT_Err(rc) fprintf(stderr,"ERROR: In %s at Line %u - rc = %d\n", __FUNCTION__, __LINE__, rc)
va009039 0:1c6af92fdc79 41
va009039 0:1c6af92fdc79 42 #else
va009039 0:1c6af92fdc79 43 #define PRINT_Log(...) do {} while(0)
va009039 0:1c6af92fdc79 44 #define PRINT_Err(rc) do {} while(0)
va009039 0:1c6af92fdc79 45
va009039 0:1c6af92fdc79 46 #endif
va009039 0:1c6af92fdc79 47
va009039 0:1c6af92fdc79 48 /*
va009039 0:1c6af92fdc79 49 **************************************************************************************************************
va009039 0:1c6af92fdc79 50 * GENERAL DEFINITIONS
va009039 0:1c6af92fdc79 51 **************************************************************************************************************
va009039 0:1c6af92fdc79 52 */
va009039 0:1c6af92fdc79 53
va009039 0:1c6af92fdc79 54 #define DESC_LENGTH(x) x[0]
va009039 0:1c6af92fdc79 55 #define DESC_TYPE(x) x[1]
va009039 0:1c6af92fdc79 56
va009039 0:1c6af92fdc79 57
va009039 0:1c6af92fdc79 58 #define HOST_GET_DESCRIPTOR(descType, descIndex, data, length) \
va009039 0:1c6af92fdc79 59 Host_CtrlRecv(USB_DEVICE_TO_HOST | USB_RECIPIENT_DEVICE, GET_DESCRIPTOR, \
va009039 0:1c6af92fdc79 60 (descType << 8)|(descIndex), 0, length, data)
va009039 0:1c6af92fdc79 61
va009039 0:1c6af92fdc79 62 #define HOST_SET_ADDRESS(new_addr) \
va009039 0:1c6af92fdc79 63 Host_CtrlSend(USB_HOST_TO_DEVICE | USB_RECIPIENT_DEVICE, SET_ADDRESS, \
va009039 0:1c6af92fdc79 64 new_addr, 0, 0, NULL)
va009039 0:1c6af92fdc79 65
va009039 0:1c6af92fdc79 66 #define USBH_SET_CONFIGURATION(configNum) \
va009039 0:1c6af92fdc79 67 Host_CtrlSend(USB_HOST_TO_DEVICE | USB_RECIPIENT_DEVICE, SET_CONFIGURATION, \
va009039 0:1c6af92fdc79 68 configNum, 0, 0, NULL)
va009039 0:1c6af92fdc79 69
va009039 0:1c6af92fdc79 70 #define USBH_SET_INTERFACE(ifNum, altNum) \
va009039 0:1c6af92fdc79 71 Host_CtrlSend(USB_HOST_TO_DEVICE | USB_RECIPIENT_INTERFACE, SET_INTERFACE, \
va009039 0:1c6af92fdc79 72 altNum, ifNum, 0, NULL)
va009039 0:1c6af92fdc79 73
va009039 0:1c6af92fdc79 74 /*
va009039 0:1c6af92fdc79 75 **************************************************************************************************************
va009039 0:1c6af92fdc79 76 * OHCI OPERATIONAL REGISTER FIELD DEFINITIONS
va009039 0:1c6af92fdc79 77 **************************************************************************************************************
va009039 0:1c6af92fdc79 78 */
va009039 0:1c6af92fdc79 79
va009039 0:1c6af92fdc79 80 /* ------------------ HcControl Register --------------------- */
va009039 0:1c6af92fdc79 81 #define OR_CONTROL_CLE 0x00000010
va009039 0:1c6af92fdc79 82 #define OR_CONTROL_BLE 0x00000020
va009039 0:1c6af92fdc79 83 #define OR_CONTROL_HCFS 0x000000C0
va009039 0:1c6af92fdc79 84 #define OR_CONTROL_HC_OPER 0x00000080
va009039 0:1c6af92fdc79 85 /* ----------------- HcCommandStatus Register ----------------- */
va009039 0:1c6af92fdc79 86 #define OR_CMD_STATUS_HCR 0x00000001
va009039 0:1c6af92fdc79 87 #define OR_CMD_STATUS_CLF 0x00000002
va009039 0:1c6af92fdc79 88 #define OR_CMD_STATUS_BLF 0x00000004
va009039 0:1c6af92fdc79 89 /* --------------- HcInterruptStatus Register ----------------- */
va009039 0:1c6af92fdc79 90 #define OR_INTR_STATUS_WDH 0x00000002
va009039 0:1c6af92fdc79 91 #define OR_INTR_STATUS_RHSC 0x00000040
va009039 0:1c6af92fdc79 92 /* --------------- HcInterruptEnable Register ----------------- */
va009039 0:1c6af92fdc79 93 #define OR_INTR_ENABLE_WDH 0x00000002
va009039 0:1c6af92fdc79 94 #define OR_INTR_ENABLE_RHSC 0x00000040
va009039 0:1c6af92fdc79 95 #define OR_INTR_ENABLE_MIE 0x80000000
va009039 0:1c6af92fdc79 96 /* ---------------- HcRhDescriptorA Register ------------------ */
va009039 0:1c6af92fdc79 97 #define OR_RH_STATUS_LPSC 0x00010000
va009039 0:1c6af92fdc79 98 #define OR_RH_STATUS_DRWE 0x00008000
va009039 0:1c6af92fdc79 99 /* -------------- HcRhPortStatus[1:NDP] Register -------------- */
va009039 0:1c6af92fdc79 100 #define OR_RH_PORT_CCS 0x00000001
va009039 0:1c6af92fdc79 101 #define OR_RH_PORT_PRS 0x00000010
va009039 0:1c6af92fdc79 102 #define OR_RH_PORT_CSC 0x00010000
va009039 0:1c6af92fdc79 103 #define OR_RH_PORT_PRSC 0x00100000
va009039 0:1c6af92fdc79 104
va009039 0:1c6af92fdc79 105
va009039 0:1c6af92fdc79 106 /*
va009039 0:1c6af92fdc79 107 **************************************************************************************************************
va009039 0:1c6af92fdc79 108 * FRAME INTERVAL
va009039 0:1c6af92fdc79 109 **************************************************************************************************************
va009039 0:1c6af92fdc79 110 */
va009039 0:1c6af92fdc79 111
va009039 0:1c6af92fdc79 112 #define FI 0x2EDF /* 12000 bits per frame (-1) */
va009039 0:1c6af92fdc79 113 #define DEFAULT_FMINTERVAL ((((6 * (FI - 210)) / 7) << 16) | FI)
va009039 0:1c6af92fdc79 114
va009039 0:1c6af92fdc79 115 /*
va009039 0:1c6af92fdc79 116 **************************************************************************************************************
va009039 0:1c6af92fdc79 117 * TRANSFER DESCRIPTOR CONTROL FIELDS
va009039 0:1c6af92fdc79 118 **************************************************************************************************************
va009039 0:1c6af92fdc79 119 */
va009039 0:1c6af92fdc79 120
va009039 0:1c6af92fdc79 121 #define TD_ROUNDING (USB_INT32U) (0x00040000) /* Buffer Rounding */
va009039 0:1c6af92fdc79 122 #define TD_SETUP (USB_INT32U)(0) /* Direction of Setup Packet */
va009039 0:1c6af92fdc79 123 #define TD_IN (USB_INT32U)(0x00100000) /* Direction In */
va009039 0:1c6af92fdc79 124 #define TD_OUT (USB_INT32U)(0x00080000) /* Direction Out */
va009039 0:1c6af92fdc79 125 #define TD_DELAY_INT(x) (USB_INT32U)((x) << 21) /* Delay Interrupt */
va009039 0:1c6af92fdc79 126 #define TD_TOGGLE_0 (USB_INT32U)(0x02000000) /* Toggle 0 */
va009039 0:1c6af92fdc79 127 #define TD_TOGGLE_1 (USB_INT32U)(0x03000000) /* Toggle 1 */
va009039 0:1c6af92fdc79 128 #define TD_CC (USB_INT32U)(0xF0000000) /* Completion Code */
va009039 0:1c6af92fdc79 129
va009039 0:1c6af92fdc79 130 /*
va009039 0:1c6af92fdc79 131 **************************************************************************************************************
va009039 0:1c6af92fdc79 132 * USB STANDARD REQUEST DEFINITIONS
va009039 0:1c6af92fdc79 133 **************************************************************************************************************
va009039 0:1c6af92fdc79 134 */
va009039 0:1c6af92fdc79 135
va009039 0:1c6af92fdc79 136 #define USB_DESCRIPTOR_TYPE_DEVICE 1
va009039 0:1c6af92fdc79 137 #define USB_DESCRIPTOR_TYPE_CONFIGURATION 2
va009039 0:1c6af92fdc79 138 #define USB_DESCRIPTOR_TYPE_INTERFACE 4
va009039 0:1c6af92fdc79 139 #define USB_DESCRIPTOR_TYPE_ENDPOINT 5
va009039 0:1c6af92fdc79 140 /* ----------- Control RequestType Fields ----------- */
va009039 0:1c6af92fdc79 141 #define USB_DEVICE_TO_HOST 0x80
va009039 0:1c6af92fdc79 142 #define USB_HOST_TO_DEVICE 0x00
va009039 0:1c6af92fdc79 143 #define USB_REQUEST_TYPE_CLASS 0x20
va009039 0:1c6af92fdc79 144 #define USB_RECIPIENT_DEVICE 0x00
va009039 0:1c6af92fdc79 145 #define USB_RECIPIENT_INTERFACE 0x01
va009039 0:1c6af92fdc79 146 /* -------------- USB Standard Requests -------------- */
va009039 0:1c6af92fdc79 147 #define SET_ADDRESS 5
va009039 0:1c6af92fdc79 148 #define GET_DESCRIPTOR 6
va009039 0:1c6af92fdc79 149 #define SET_CONFIGURATION 9
va009039 0:1c6af92fdc79 150 #define SET_INTERFACE 11
va009039 0:1c6af92fdc79 151
va009039 0:1c6af92fdc79 152 /*
va009039 0:1c6af92fdc79 153 **************************************************************************************************************
va009039 0:1c6af92fdc79 154 * TYPE DEFINITIONS
va009039 0:1c6af92fdc79 155 **************************************************************************************************************
va009039 0:1c6af92fdc79 156 */
va009039 0:1c6af92fdc79 157
va009039 0:1c6af92fdc79 158 typedef struct hcEd { /* ----------- HostController EndPoint Descriptor ------------- */
va009039 0:1c6af92fdc79 159 volatile USB_INT32U Control; /* Endpoint descriptor control */
va009039 0:1c6af92fdc79 160 volatile USB_INT32U TailTd; /* Physical address of tail in Transfer descriptor list */
va009039 0:1c6af92fdc79 161 volatile USB_INT32U HeadTd; /* Physcial address of head in Transfer descriptor list */
va009039 0:1c6af92fdc79 162 volatile USB_INT32U Next; /* Physical address of next Endpoint descriptor */
va009039 0:1c6af92fdc79 163 } HCED;
va009039 0:1c6af92fdc79 164
va009039 0:1c6af92fdc79 165 typedef struct hcTd { /* ------------ HostController Transfer Descriptor ------------ */
va009039 0:1c6af92fdc79 166 volatile USB_INT32U Control; /* Transfer descriptor control */
va009039 0:1c6af92fdc79 167 volatile USB_INT32U CurrBufPtr; /* Physical address of current buffer pointer */
va009039 0:1c6af92fdc79 168 volatile USB_INT32U Next; /* Physical pointer to next Transfer Descriptor */
va009039 0:1c6af92fdc79 169 volatile USB_INT32U BufEnd; /* Physical address of end of buffer */
va009039 0:1c6af92fdc79 170 } HCTD;
va009039 0:1c6af92fdc79 171
va009039 0:1c6af92fdc79 172 typedef struct hcca { /* ----------- Host Controller Communication Area ------------ */
va009039 0:1c6af92fdc79 173 volatile USB_INT32U IntTable[32]; /* Interrupt Table */
va009039 0:1c6af92fdc79 174 volatile USB_INT32U FrameNumber; /* Frame Number */
va009039 0:1c6af92fdc79 175 volatile USB_INT32U DoneHead; /* Done Head */
va009039 0:1c6af92fdc79 176 volatile USB_INT08U Reserved[116]; /* Reserved for future use */
va009039 0:1c6af92fdc79 177 volatile USB_INT08U Unknown[4]; /* Unused */
va009039 0:1c6af92fdc79 178 } HCCA;
va009039 0:1c6af92fdc79 179
va009039 0:1c6af92fdc79 180 /*
va009039 0:1c6af92fdc79 181 **************************************************************************************************************
va009039 0:1c6af92fdc79 182 * EXTERN DECLARATIONS
va009039 0:1c6af92fdc79 183 **************************************************************************************************************
va009039 0:1c6af92fdc79 184 */
va009039 0:1c6af92fdc79 185
va009039 0:1c6af92fdc79 186 extern volatile HCED *EDBulkIn; /* BulkIn endpoint descriptor structure */
va009039 0:1c6af92fdc79 187 extern volatile HCED *EDBulkOut; /* BulkOut endpoint descriptor structure */
va009039 0:1c6af92fdc79 188 extern volatile HCTD *TDHead; /* Head transfer descriptor structure */
va009039 0:1c6af92fdc79 189 extern volatile HCTD *TDTail; /* Tail transfer descriptor structure */
va009039 0:1c6af92fdc79 190 extern volatile USB_INT08U *TDBuffer; /* Current Buffer Pointer of transfer descriptor */
va009039 0:1c6af92fdc79 191
va009039 0:1c6af92fdc79 192 /*
va009039 0:1c6af92fdc79 193 **************************************************************************************************************
va009039 0:1c6af92fdc79 194 * FUNCTION PROTOTYPES
va009039 0:1c6af92fdc79 195 **************************************************************************************************************
va009039 0:1c6af92fdc79 196 */
va009039 0:1c6af92fdc79 197
va009039 0:1c6af92fdc79 198 void Host_Init (void);
va009039 0:1c6af92fdc79 199
va009039 0:1c6af92fdc79 200 extern "C" void USB_IRQHandler(void) __irq;
va009039 0:1c6af92fdc79 201
va009039 0:1c6af92fdc79 202 USB_INT32S Host_EnumDev (void);
va009039 0:1c6af92fdc79 203
va009039 0:1c6af92fdc79 204 USB_INT32S Host_ProcessTD(volatile HCED *ed,
va009039 0:1c6af92fdc79 205 volatile USB_INT32U token,
va009039 0:1c6af92fdc79 206 volatile USB_INT08U *buffer,
va009039 0:1c6af92fdc79 207 USB_INT32U buffer_len);
va009039 0:1c6af92fdc79 208
va009039 0:1c6af92fdc79 209 void Host_DelayUS ( USB_INT32U delay);
va009039 0:1c6af92fdc79 210 void Host_DelayMS ( USB_INT32U delay);
va009039 0:1c6af92fdc79 211
va009039 0:1c6af92fdc79 212
va009039 0:1c6af92fdc79 213 void Host_TDInit (volatile HCTD *td);
va009039 0:1c6af92fdc79 214 void Host_EDInit (volatile HCED *ed);
va009039 0:1c6af92fdc79 215 void Host_HCCAInit (volatile HCCA *hcca);
va009039 0:1c6af92fdc79 216
va009039 0:1c6af92fdc79 217 USB_INT32S Host_CtrlRecv ( USB_INT08U bm_request_type,
va009039 0:1c6af92fdc79 218 USB_INT08U b_request,
va009039 0:1c6af92fdc79 219 USB_INT16U w_value,
va009039 0:1c6af92fdc79 220 USB_INT16U w_index,
va009039 0:1c6af92fdc79 221 USB_INT16U w_length,
va009039 0:1c6af92fdc79 222 volatile USB_INT08U *buffer);
va009039 0:1c6af92fdc79 223
va009039 0:1c6af92fdc79 224 USB_INT32S Host_CtrlSend ( USB_INT08U bm_request_type,
va009039 0:1c6af92fdc79 225 USB_INT08U b_request,
va009039 0:1c6af92fdc79 226 USB_INT16U w_value,
va009039 0:1c6af92fdc79 227 USB_INT16U w_index,
va009039 0:1c6af92fdc79 228 USB_INT16U w_length,
va009039 0:1c6af92fdc79 229 volatile USB_INT08U *buffer);
va009039 0:1c6af92fdc79 230
va009039 0:1c6af92fdc79 231 void Host_FillSetup( USB_INT08U bm_request_type,
va009039 0:1c6af92fdc79 232 USB_INT08U b_request,
va009039 0:1c6af92fdc79 233 USB_INT16U w_value,
va009039 0:1c6af92fdc79 234 USB_INT16U w_index,
va009039 0:1c6af92fdc79 235 USB_INT16U w_length);
va009039 0:1c6af92fdc79 236
va009039 0:1c6af92fdc79 237
va009039 0:1c6af92fdc79 238 void Host_WDHWait (void);
va009039 0:1c6af92fdc79 239
va009039 0:1c6af92fdc79 240
va009039 0:1c6af92fdc79 241 USB_INT32U ReadLE32U (volatile USB_INT08U *pmem);
va009039 0:1c6af92fdc79 242 void WriteLE32U (volatile USB_INT08U *pmem,
va009039 0:1c6af92fdc79 243 USB_INT32U val);
va009039 0:1c6af92fdc79 244 USB_INT16U ReadLE16U (volatile USB_INT08U *pmem);
va009039 0:1c6af92fdc79 245 void WriteLE16U (volatile USB_INT08U *pmem,
va009039 0:1c6af92fdc79 246 USB_INT16U val);
va009039 0:1c6af92fdc79 247 USB_INT32U ReadBE32U (volatile USB_INT08U *pmem);
va009039 0:1c6af92fdc79 248 void WriteBE32U (volatile USB_INT08U *pmem,
va009039 0:1c6af92fdc79 249 USB_INT32U val);
va009039 0:1c6af92fdc79 250 USB_INT16U ReadBE16U (volatile USB_INT08U *pmem);
va009039 0:1c6af92fdc79 251 void WriteBE16U (volatile USB_INT08U *pmem,
va009039 0:1c6af92fdc79 252 USB_INT16U val);
va009039 0:1c6af92fdc79 253
va009039 0:1c6af92fdc79 254 #endif