Samir Bouaziz / USBHostLite

is just added to File System Lib used by our students

Dependents:   FileSystem_POPS

usbhost_lpc17xx.h@0:7c305139fb85, 2013-11-10 (annotated)

Committer:
bouaziz
Date:
Sun Nov 10 20:59:07 2013 +0000
Revision:
0:7c305139fb85
Very difficult to find lib for USB mass storage access.; This one works fine after few modif.; This is identified POPS because is used by our undergraduate students Polytech Paris Sud Orsay  engineer School;

Who changed what in which revision?

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