ahmed ahmed / Mbed 2 deprecated samir2_alti_logger

dd

Dependencies:   C12832 mbed

FileSystem/USBHostLite/usbhost_lpc17xx.h@0:caecb0d1e7d3, 2015-04-08 (annotated)

Committer:
pfe
Date:
Wed Apr 08 08:27:55 2015 +0000
Revision:
0:caecb0d1e7d3
ddd

Who changed what in which revision?

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