Renato Grottesi / Mbed 2 deprecated SuspendedPlotterIoT

Suspended plotter for the skaperfest

Dependencies:   mbed HTTPServer EthernetNetIf FatFileSystemCpp

USBHostLite/usbhost_lpc17xx.h@0:602ff2b2d41c, 2022-08-22 (annotated)

Committer:
rengro01
Date:
Mon Aug 22 10:24:23 2022 +0000
Revision:
0:602ff2b2d41c
skaperfest

Who changed what in which revision?

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