YongChing Tee / Mbed 2 deprecated Lab3

Publish code

Dependencies:   FatFileSystem RPG TextLCD mbed wave_player

USBHostLite/usbhost_lpc17xx.h@1:ebb980d204ae, 2013-03-06 (annotated)

Committer:
YongChingTee
Date:
Wed Mar 06 00:21:35 2013 +0000
Revision:
1:ebb980d204ae
Parent:
0:ad48675db853 
publish

Who changed what in which revision?

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