ECE 4180 Labs / Mbed 2 deprecated 4180_Lab2_USB

CodeShare

Dependencies:   FatFileSystem mbed

Fork of 4180_Lab2_USB by Jeremy Cai

USBHostLite/usbhost_lpc17xx.h@1:fca955be2a5b, 2016-09-25 (annotated)

Committer:
jeremycai3721
Date:
Sun Sep 25 19:04:39 2016 +0000
Revision:
1:fca955be2a5b
Parent:
0:4e756c4c88a7 
CodeShare

Who changed what in which revision?

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