Atsushi Hattori / Mbed 2 deprecated 20210627_Logger

hattori&ide

Dependencies:   mbed

ChaNFSUSB/USBHostLite/usbhost_lpc17xx.h@0:f77369cabd75, 21 months ago (annotated)

Committer:
hattori_atsushi
Date:
Sun Dec 18 08:16:01 2022 +0000
Revision:
0:f77369cabd75
hattori

Who changed what in which revision?

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