KIT Solar Car Project / Mbed 2 deprecated Motacon2020_ver5

20200823_Motacon2020_ver5_kikkawa

Dependencies:   mbed FatFileSystemCpp INA226_abc BLDCmotorDriver_20200821_motacon_ver4

USBHostLite/usbhost_lpc17xx.h@1:47c28ece54ea, 2020-08-21 (annotated)

Committer:
MPPT51
Date:
Fri Aug 21 08:30:26 2020 +0000
Revision:
1:47c28ece54ea
Parent:
0:3e0c71851fee 
20200821_motacon_ver4

Who changed what in which revision?

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