1 //***************************************************************************** 2 // 3 // usb.h - Prototypes for the USB Interface Driver. 4 // 5 // Copyright (c) 2007-2012 Texas Instruments Incorporated. All rights reserved. 6 // Software License Agreement 7 // 8 // Redistribution and use in source and binary forms, with or without 9 // modification, are permitted provided that the following conditions 10 // are met: 11 // 12 // Redistributions of source code must retain the above copyright 13 // notice, this list of conditions and the following disclaimer. 14 // 15 // Redistributions in binary form must reproduce the above copyright 16 // notice, this list of conditions and the following disclaimer in the 17 // documentation and/or other materials provided with the 18 // distribution. 19 // 20 // Neither the name of Texas Instruments Incorporated nor the names of 21 // its contributors may be used to endorse or promote products derived 22 // from this software without specific prior written permission. 23 // 24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 35 // 36 // This is part of revision 9453 of the Stellaris Peripheral Driver Library. 37 // 38 //***************************************************************************** 39 40 #ifndef __USB_H__ 41 #define __USB_H__ 42 43 //***************************************************************************** 44 // 45 // If building with a C++ compiler, make all of the definitions in this header 46 // have a C binding. 47 // 48 //***************************************************************************** 49 #ifdef __cplusplus 50 extern "C" 51 { 52 #endif 53 54 //***************************************************************************** 55 // 56 // The following are values that can be passed to USBIntEnableControl() and 57 // USBIntDisableControl() as the ulFlags parameter, and are returned from 58 // USBIntStatusControl(). 59 // 60 //***************************************************************************** 61 #define USB_INTCTRL_ALL 0x000003FF // All control interrupt sources 62 #define USB_INTCTRL_STATUS 0x000000FF // Status Interrupts 63 #define USB_INTCTRL_VBUS_ERR 0x00000080 // VBUS Error 64 #define USB_INTCTRL_SESSION 0x00000040 // Session Start Detected 65 #define USB_INTCTRL_SESSION_END 0x00000040 // Session End Detected 66 #define USB_INTCTRL_DISCONNECT 0x00000020 // Disconnect Detected 67 #define USB_INTCTRL_CONNECT 0x00000010 // Device Connect Detected 68 #define USB_INTCTRL_SOF 0x00000008 // Start of Frame Detected 69 #define USB_INTCTRL_BABBLE 0x00000004 // Babble signaled 70 #define USB_INTCTRL_RESET 0x00000004 // Reset signaled 71 #define USB_INTCTRL_RESUME 0x00000002 // Resume detected 72 #define USB_INTCTRL_SUSPEND 0x00000001 // Suspend detected 73 #define USB_INTCTRL_MODE_DETECT 0x00000200 // Mode value valid 74 #define USB_INTCTRL_POWER_FAULT 0x00000100 // Power Fault detected 75 76 //***************************************************************************** 77 // 78 // The following are values that can be passed to USBIntEnableEndpoint() and 79 // USBIntDisableEndpoint() as the ulFlags parameter, and are returned from 80 // USBIntStatusEndpoint(). 81 // 82 //***************************************************************************** 83 #define USB_INTEP_ALL 0xFFFFFFFF // Host IN Interrupts 84 #define USB_INTEP_HOST_IN 0xFFFE0000 // Host IN Interrupts 85 #define USB_INTEP_HOST_IN_15 0x80000000 // Endpoint 15 Host IN Interrupt 86 #define USB_INTEP_HOST_IN_14 0x40000000 // Endpoint 14 Host IN Interrupt 87 #define USB_INTEP_HOST_IN_13 0x20000000 // Endpoint 13 Host IN Interrupt 88 #define USB_INTEP_HOST_IN_12 0x10000000 // Endpoint 12 Host IN Interrupt 89 #define USB_INTEP_HOST_IN_11 0x08000000 // Endpoint 11 Host IN Interrupt 90 #define USB_INTEP_HOST_IN_10 0x04000000 // Endpoint 10 Host IN Interrupt 91 #define USB_INTEP_HOST_IN_9 0x02000000 // Endpoint 9 Host IN Interrupt 92 #define USB_INTEP_HOST_IN_8 0x01000000 // Endpoint 8 Host IN Interrupt 93 #define USB_INTEP_HOST_IN_7 0x00800000 // Endpoint 7 Host IN Interrupt 94 #define USB_INTEP_HOST_IN_6 0x00400000 // Endpoint 6 Host IN Interrupt 95 #define USB_INTEP_HOST_IN_5 0x00200000 // Endpoint 5 Host IN Interrupt 96 #define USB_INTEP_HOST_IN_4 0x00100000 // Endpoint 4 Host IN Interrupt 97 #define USB_INTEP_HOST_IN_3 0x00080000 // Endpoint 3 Host IN Interrupt 98 #define USB_INTEP_HOST_IN_2 0x00040000 // Endpoint 2 Host IN Interrupt 99 #define USB_INTEP_HOST_IN_1 0x00020000 // Endpoint 1 Host IN Interrupt 100 101 #define USB_INTEP_DEV_OUT 0xFFFE0000 // Device OUT Interrupts 102 #define USB_INTEP_DEV_OUT_15 0x80000000 // Endpoint 15 Device OUT Interrupt 103 #define USB_INTEP_DEV_OUT_14 0x40000000 // Endpoint 14 Device OUT Interrupt 104 #define USB_INTEP_DEV_OUT_13 0x20000000 // Endpoint 13 Device OUT Interrupt 105 #define USB_INTEP_DEV_OUT_12 0x10000000 // Endpoint 12 Device OUT Interrupt 106 #define USB_INTEP_DEV_OUT_11 0x08000000 // Endpoint 11 Device OUT Interrupt 107 #define USB_INTEP_DEV_OUT_10 0x04000000 // Endpoint 10 Device OUT Interrupt 108 #define USB_INTEP_DEV_OUT_9 0x02000000 // Endpoint 9 Device OUT Interrupt 109 #define USB_INTEP_DEV_OUT_8 0x01000000 // Endpoint 8 Device OUT Interrupt 110 #define USB_INTEP_DEV_OUT_7 0x00800000 // Endpoint 7 Device OUT Interrupt 111 #define USB_INTEP_DEV_OUT_6 0x00400000 // Endpoint 6 Device OUT Interrupt 112 #define USB_INTEP_DEV_OUT_5 0x00200000 // Endpoint 5 Device OUT Interrupt 113 #define USB_INTEP_DEV_OUT_4 0x00100000 // Endpoint 4 Device OUT Interrupt 114 #define USB_INTEP_DEV_OUT_3 0x00080000 // Endpoint 3 Device OUT Interrupt 115 #define USB_INTEP_DEV_OUT_2 0x00040000 // Endpoint 2 Device OUT Interrupt 116 #define USB_INTEP_DEV_OUT_1 0x00020000 // Endpoint 1 Device OUT Interrupt 117 118 #define USB_INTEP_HOST_OUT 0x0000FFFE // Host OUT Interrupts 119 #define USB_INTEP_HOST_OUT_15 0x00008000 // Endpoint 15 Host OUT Interrupt 120 #define USB_INTEP_HOST_OUT_14 0x00004000 // Endpoint 14 Host OUT Interrupt 121 #define USB_INTEP_HOST_OUT_13 0x00002000 // Endpoint 13 Host OUT Interrupt 122 #define USB_INTEP_HOST_OUT_12 0x00001000 // Endpoint 12 Host OUT Interrupt 123 #define USB_INTEP_HOST_OUT_11 0x00000800 // Endpoint 11 Host OUT Interrupt 124 #define USB_INTEP_HOST_OUT_10 0x00000400 // Endpoint 10 Host OUT Interrupt 125 #define USB_INTEP_HOST_OUT_9 0x00000200 // Endpoint 9 Host OUT Interrupt 126 #define USB_INTEP_HOST_OUT_8 0x00000100 // Endpoint 8 Host OUT Interrupt 127 #define USB_INTEP_HOST_OUT_7 0x00000080 // Endpoint 7 Host OUT Interrupt 128 #define USB_INTEP_HOST_OUT_6 0x00000040 // Endpoint 6 Host OUT Interrupt 129 #define USB_INTEP_HOST_OUT_5 0x00000020 // Endpoint 5 Host OUT Interrupt 130 #define USB_INTEP_HOST_OUT_4 0x00000010 // Endpoint 4 Host OUT Interrupt 131 #define USB_INTEP_HOST_OUT_3 0x00000008 // Endpoint 3 Host OUT Interrupt 132 #define USB_INTEP_HOST_OUT_2 0x00000004 // Endpoint 2 Host OUT Interrupt 133 #define USB_INTEP_HOST_OUT_1 0x00000002 // Endpoint 1 Host OUT Interrupt 134 135 #define USB_INTEP_DEV_IN 0x0000FFFE // Device IN Interrupts 136 #define USB_INTEP_DEV_IN_15 0x00008000 // Endpoint 15 Device IN Interrupt 137 #define USB_INTEP_DEV_IN_14 0x00004000 // Endpoint 14 Device IN Interrupt 138 #define USB_INTEP_DEV_IN_13 0x00002000 // Endpoint 13 Device IN Interrupt 139 #define USB_INTEP_DEV_IN_12 0x00001000 // Endpoint 12 Device IN Interrupt 140 #define USB_INTEP_DEV_IN_11 0x00000800 // Endpoint 11 Device IN Interrupt 141 #define USB_INTEP_DEV_IN_10 0x00000400 // Endpoint 10 Device IN Interrupt 142 #define USB_INTEP_DEV_IN_9 0x00000200 // Endpoint 9 Device IN Interrupt 143 #define USB_INTEP_DEV_IN_8 0x00000100 // Endpoint 8 Device IN Interrupt 144 #define USB_INTEP_DEV_IN_7 0x00000080 // Endpoint 7 Device IN Interrupt 145 #define USB_INTEP_DEV_IN_6 0x00000040 // Endpoint 6 Device IN Interrupt 146 #define USB_INTEP_DEV_IN_5 0x00000020 // Endpoint 5 Device IN Interrupt 147 #define USB_INTEP_DEV_IN_4 0x00000010 // Endpoint 4 Device IN Interrupt 148 #define USB_INTEP_DEV_IN_3 0x00000008 // Endpoint 3 Device IN Interrupt 149 #define USB_INTEP_DEV_IN_2 0x00000004 // Endpoint 2 Device IN Interrupt 150 #define USB_INTEP_DEV_IN_1 0x00000002 // Endpoint 1 Device IN Interrupt 151 152 #define USB_INTEP_0 0x00000001 // Endpoint 0 Interrupt 153 154 //***************************************************************************** 155 // 156 // The following are values that are returned from USBSpeedGet(). 157 // 158 //***************************************************************************** 159 #define USB_UNDEF_SPEED 0x80000000 // Current speed is undefined 160 #define USB_FULL_SPEED 0x00000001 // Current speed is Full Speed 161 #define USB_LOW_SPEED 0x00000000 // Current speed is Low Speed 162 163 //***************************************************************************** 164 // 165 // The following are values that are returned from USBEndpointStatus(). The 166 // USB_HOST_* values are used when the USB controller is in host mode and the 167 // USB_DEV_* values are used when the USB controller is in device mode. 168 // 169 //***************************************************************************** 170 #define USB_HOST_IN_STATUS 0xFFFF0000 // Mask of all host IN interrupts 171 #define USB_HOST_IN_PID_ERROR 0x01000000 // Stall on this endpoint received 172 #define USB_HOST_IN_NOT_COMP 0x00100000 // Device failed to respond 173 #define USB_HOST_IN_STALL 0x00400000 // Stall on this endpoint received 174 #define USB_HOST_IN_DATA_ERROR 0x00080000 // CRC or bit-stuff error 175 // (ISOC Mode) 176 #define USB_HOST_IN_NAK_TO 0x00080000 // NAK received for more than the 177 // specified timeout period 178 #define USB_HOST_IN_ERROR 0x00040000 // Failed to communicate with a 179 // device 180 #define USB_HOST_IN_FIFO_FULL 0x00020000 // RX FIFO full 181 #define USB_HOST_IN_PKTRDY 0x00010000 // Data packet ready 182 #define USB_HOST_OUT_STATUS 0x0000FFFF // Mask of all host OUT interrupts 183 #define USB_HOST_OUT_NAK_TO 0x00000080 // NAK received for more than the 184 // specified timeout period 185 #define USB_HOST_OUT_NOT_COMP 0x00000080 // No response from device 186 // (ISOC mode) 187 #define USB_HOST_OUT_STALL 0x00000020 // Stall on this endpoint received 188 #define USB_HOST_OUT_ERROR 0x00000004 // Failed to communicate with a 189 // device 190 #define USB_HOST_OUT_FIFO_NE 0x00000002 // TX FIFO is not empty 191 #define USB_HOST_OUT_PKTPEND 0x00000001 // Transmit still being transmitted 192 #define USB_HOST_EP0_NAK_TO 0x00000080 // NAK received for more than the 193 // specified timeout period 194 #define USB_HOST_EP0_STATUS 0x00000040 // This was a status packet 195 #define USB_HOST_EP0_ERROR 0x00000010 // Failed to communicate with a 196 // device 197 #define USB_HOST_EP0_RX_STALL 0x00000004 // Stall on this endpoint received 198 #define USB_HOST_EP0_RXPKTRDY 0x00000001 // Receive data packet ready 199 #define USB_DEV_RX_SENT_STALL 0x00400000 // Stall was sent on this endpoint 200 #define USB_DEV_RX_DATA_ERROR 0x00080000 // CRC error on the data 201 #define USB_DEV_RX_OVERRUN 0x00040000 // OUT packet was not loaded due to 202 // a full FIFO 203 #define USB_DEV_RX_FIFO_FULL 0x00020000 // RX FIFO full 204 #define USB_DEV_RX_PKT_RDY 0x00010000 // Data packet ready 205 #define USB_DEV_TX_NOT_COMP 0x00000080 // Large packet split up, more data 206 // to come 207 #define USB_DEV_TX_SENT_STALL 0x00000020 // Stall was sent on this endpoint 208 #define USB_DEV_TX_UNDERRUN 0x00000004 // IN received with no data ready 209 #define USB_DEV_TX_FIFO_NE 0x00000002 // The TX FIFO is not empty 210 #define USB_DEV_TX_TXPKTRDY 0x00000001 // Transmit still being transmitted 211 #define USB_DEV_EP0_SETUP_END 0x00000010 // Control transaction ended before 212 // Data End seen 213 #define USB_DEV_EP0_SENT_STALL 0x00000004 // Stall was sent on this endpoint 214 #define USB_DEV_EP0_IN_PKTPEND 0x00000002 // Transmit data packet pending 215 #define USB_DEV_EP0_OUT_PKTRDY 0x00000001 // Receive data packet ready 216 217 //***************************************************************************** 218 // 219 // The following are values that can be passed to USBHostEndpointConfig() and 220 // USBDevEndpointConfigSet() as the ulFlags parameter. 221 // 222 //***************************************************************************** 223 #define USB_EP_AUTO_SET 0x00000001 // Auto set feature enabled 224 #define USB_EP_AUTO_REQUEST 0x00000002 // Auto request feature enabled 225 #define USB_EP_AUTO_CLEAR 0x00000004 // Auto clear feature enabled 226 #define USB_EP_DMA_MODE_0 0x00000008 // Enable DMA access using mode 0 227 #define USB_EP_DMA_MODE_1 0x00000010 // Enable DMA access using mode 1 228 #define USB_EP_MODE_ISOC 0x00000000 // Isochronous endpoint 229 #define USB_EP_MODE_BULK 0x00000100 // Bulk endpoint 230 #define USB_EP_MODE_INT 0x00000200 // Interrupt endpoint 231 #define USB_EP_MODE_CTRL 0x00000300 // Control endpoint 232 #define USB_EP_MODE_MASK 0x00000300 // Mode Mask 233 #define USB_EP_SPEED_LOW 0x00000000 // Low Speed 234 #define USB_EP_SPEED_FULL 0x00001000 // Full Speed 235 #define USB_EP_HOST_IN 0x00000000 // Host IN endpoint 236 #define USB_EP_HOST_OUT 0x00002000 // Host OUT endpoint 237 #define USB_EP_DEV_IN 0x00002000 // Device IN endpoint 238 #define USB_EP_DEV_OUT 0x00000000 // Device OUT endpoint 239 240 //***************************************************************************** 241 // 242 // The following are values that can be passed to USBHostPwrConfig() as 243 // the ulFlags parameter. 244 // 245 //***************************************************************************** 246 #define USB_HOST_PWRFLT_LOW 0x00000010 247 #define USB_HOST_PWRFLT_HIGH 0x00000030 248 #define USB_HOST_PWRFLT_EP_NONE 0x00000000 249 #define USB_HOST_PWRFLT_EP_TRI 0x00000140 250 #define USB_HOST_PWRFLT_EP_LOW 0x00000240 251 #define USB_HOST_PWRFLT_EP_HIGH 0x00000340 252 #ifndef DEPRECATED 253 #define USB_HOST_PWREN_LOW 0x00000002 254 #define USB_HOST_PWREN_HIGH 0x00000003 255 #define USB_HOST_PWREN_VBLOW 0x00000002 256 #define USB_HOST_PWREN_VBHIGH 0x00000003 257 #endif 258 #define USB_HOST_PWREN_MAN_LOW 0x00000000 259 #define USB_HOST_PWREN_MAN_HIGH 0x00000001 260 #define USB_HOST_PWREN_AUTOLOW 0x00000002 261 #define USB_HOST_PWREN_AUTOHIGH 0x00000003 262 #define USB_HOST_PWREN_FILTER 0x00010000 263 264 //***************************************************************************** 265 // 266 // The following are special values that can be passed to 267 // USBHostEndpointConfig() as the ulNAKPollInterval parameter. 268 // 269 //***************************************************************************** 270 #define MAX_NAK_LIMIT 31 // Maximum NAK interval 271 #define DISABLE_NAK_LIMIT 0 // No NAK timeouts 272 273 //***************************************************************************** 274 // 275 // This value specifies the maximum size of transfers on endpoint 0 as 64 276 // bytes. This value is fixed in hardware as the FIFO size for endpoint 0. 277 // 278 //***************************************************************************** 279 #define MAX_PACKET_SIZE_EP0 64 280 281 //***************************************************************************** 282 // 283 // These values are used to indicate which endpoint to access. 284 // 285 //***************************************************************************** 286 #define USB_EP_0 0x00000000 // Endpoint 0 287 #define USB_EP_1 0x00000010 // Endpoint 1 288 #define USB_EP_2 0x00000020 // Endpoint 2 289 #define USB_EP_3 0x00000030 // Endpoint 3 290 #define USB_EP_4 0x00000040 // Endpoint 4 291 #define USB_EP_5 0x00000050 // Endpoint 5 292 #define USB_EP_6 0x00000060 // Endpoint 6 293 #define USB_EP_7 0x00000070 // Endpoint 7 294 #define USB_EP_8 0x00000080 // Endpoint 8 295 #define USB_EP_9 0x00000090 // Endpoint 9 296 #define USB_EP_10 0x000000A0 // Endpoint 10 297 #define USB_EP_11 0x000000B0 // Endpoint 11 298 #define USB_EP_12 0x000000C0 // Endpoint 12 299 #define USB_EP_13 0x000000D0 // Endpoint 13 300 #define USB_EP_14 0x000000E0 // Endpoint 14 301 #define USB_EP_15 0x000000F0 // Endpoint 15 302 #define NUM_USB_EP 16 // Number of supported endpoints 303 304 //***************************************************************************** 305 // 306 // These macros allow conversion between 0-based endpoint indices and the 307 // USB_EP_x values required when calling various USB APIs. 308 // 309 //***************************************************************************** 310 #define INDEX_TO_USB_EP(x) ((x) << 4) 311 #define USB_EP_TO_INDEX(x) ((x) >> 4) 312 313 //***************************************************************************** 314 // 315 // The following are values that can be passed to USBFIFOConfigSet() as the 316 // ulFIFOSize parameter. 317 // 318 //***************************************************************************** 319 #define USB_FIFO_SZ_8 0x00000000 // 8 byte FIFO 320 #define USB_FIFO_SZ_16 0x00000001 // 16 byte FIFO 321 #define USB_FIFO_SZ_32 0x00000002 // 32 byte FIFO 322 #define USB_FIFO_SZ_64 0x00000003 // 64 byte FIFO 323 #define USB_FIFO_SZ_128 0x00000004 // 128 byte FIFO 324 #define USB_FIFO_SZ_256 0x00000005 // 256 byte FIFO 325 #define USB_FIFO_SZ_512 0x00000006 // 512 byte FIFO 326 #define USB_FIFO_SZ_1024 0x00000007 // 1024 byte FIFO 327 #define USB_FIFO_SZ_2048 0x00000008 // 2048 byte FIFO 328 #define USB_FIFO_SZ_4096 0x00000009 // 4096 byte FIFO 329 #define USB_FIFO_SZ_8_DB 0x00000010 // 8 byte double buffered FIFO 330 // (occupying 16 bytes) 331 #define USB_FIFO_SZ_16_DB 0x00000011 // 16 byte double buffered FIFO 332 // (occupying 32 bytes) 333 #define USB_FIFO_SZ_32_DB 0x00000012 // 32 byte double buffered FIFO 334 // (occupying 64 bytes) 335 #define USB_FIFO_SZ_64_DB 0x00000013 // 64 byte double buffered FIFO 336 // (occupying 128 bytes) 337 #define USB_FIFO_SZ_128_DB 0x00000014 // 128 byte double buffered FIFO 338 // (occupying 256 bytes) 339 #define USB_FIFO_SZ_256_DB 0x00000015 // 256 byte double buffered FIFO 340 // (occupying 512 bytes) 341 #define USB_FIFO_SZ_512_DB 0x00000016 // 512 byte double buffered FIFO 342 // (occupying 1024 bytes) 343 #define USB_FIFO_SZ_1024_DB 0x00000017 // 1024 byte double buffered FIFO 344 // (occupying 2048 bytes) 345 #define USB_FIFO_SZ_2048_DB 0x00000018 // 2048 byte double buffered FIFO 346 // (occupying 4096 bytes) 347 348 //***************************************************************************** 349 // 350 // This macro allow conversion from a FIFO size label as defined above to 351 // a number of bytes 352 // 353 //***************************************************************************** 354 #define USB_FIFO_SIZE_DB_FLAG 0x00000010 355 #define USB_FIFO_SZ_TO_BYTES(x) ((8 << ((x) & ~ USB_FIFO_SIZE_DB_FLAG)) * \ 356 (((x) & USB_FIFO_SIZE_DB_FLAG) ? 2 : 1)) 357 358 //***************************************************************************** 359 // 360 // The following are values that can be passed to USBEndpointDataSend() as the 361 // ulTransType parameter. 362 // 363 //***************************************************************************** 364 #define USB_TRANS_OUT 0x00000102 // Normal OUT transaction 365 #define USB_TRANS_IN 0x00000102 // Normal IN transaction 366 #define USB_TRANS_IN_LAST 0x0000010a // Final IN transaction (for 367 // endpoint 0 in device mode) 368 #define USB_TRANS_SETUP 0x0000110a // Setup transaction (for endpoint 369 // 0) 370 #define USB_TRANS_STATUS 0x00000142 // Status transaction (for endpoint 371 // 0) 372 373 //***************************************************************************** 374 // 375 // The following are values are returned by the USBModeGet function. 376 // 377 //***************************************************************************** 378 #define USB_DUAL_MODE_HOST 0x00000001 // Dual mode controller is in Host 379 // mode. 380 #define USB_DUAL_MODE_DEVICE 0x00000081 // Dual mode controller is in 381 // Device mode. 382 #define USB_DUAL_MODE_NONE 0x00000080 // Dual mode controller mode is not 383 // set. 384 #define USB_OTG_MODE_ASIDE_HOST 0x0000001d // OTG controller on the A side of 385 // the cable. 386 #define USB_OTG_MODE_ASIDE_NPWR 0x00000001 // OTG controller on the A side of 387 // the cable. 388 #define USB_OTG_MODE_ASIDE_SESS 0x00000009 // OTG controller on the A side of 389 // the cable Session Valid. 390 #define USB_OTG_MODE_ASIDE_AVAL 0x00000011 // OTG controller on the A side of 391 // the cable A valid. 392 #define USB_OTG_MODE_ASIDE_DEV 0x00000019 // OTG controller on the A side of 393 // the cable. 394 #define USB_OTG_MODE_BSIDE_HOST 0x0000009d // OTG controller on the B side of 395 // the cable. 396 #define USB_OTG_MODE_BSIDE_DEV 0x00000099 // OTG controller on the B side of 397 // the cable. 398 #define USB_OTG_MODE_BSIDE_NPWR 0x00000081 // OTG controller on the B side of 399 // the cable. 400 #define USB_OTG_MODE_NONE 0x00000080 // OTG controller mode is not set. 401 402 //***************************************************************************** 403 // 404 // Prototypes for the APIs. 405 // 406 //***************************************************************************** 407 extern unsigned long USBDevAddrGet(unsigned long ulBase); 408 extern void USBDevAddrSet(unsigned long ulBase, unsigned long ulAddress); 409 extern void USBDevConnect(unsigned long ulBase); 410 extern void USBDevDisconnect(unsigned long ulBase); 411 extern void USBDevEndpointConfigSet(unsigned long ulBase, 412 unsigned long ulEndpoint, 413 unsigned long ulMaxPacketSize, 414 unsigned long ulFlags); 415 extern void USBDevEndpointConfigGet(unsigned long ulBase, 416 unsigned long ulEndpoint, 417 unsigned long *pulMaxPacketSize, 418 unsigned long *pulFlags); 419 extern void USBDevEndpointDataAck(unsigned long ulBase, 420 unsigned long ulEndpoint, 421 tBoolean bIsLastPacket); 422 extern void USBDevEndpointStall(unsigned long ulBase, unsigned long ulEndpoint, 423 unsigned long ulFlags); 424 extern void USBDevEndpointStallClear(unsigned long ulBase, 425 unsigned long ulEndpoint, 426 unsigned long ulFlags); 427 extern void USBDevEndpointStatusClear(unsigned long ulBase, 428 unsigned long ulEndpoint, 429 unsigned long ulFlags); 430 extern unsigned long USBEndpointDataAvail(unsigned long ulBase, 431 unsigned long ulEndpoint); 432 extern void USBEndpointDMAEnable(unsigned long ulBase, unsigned long ulEndpoint, 433 unsigned long ulFlags); 434 extern void USBEndpointDMADisable(unsigned long ulBase, 435 unsigned long ulEndpoint, 436 unsigned long ulFlags); 437 extern long USBEndpointDataGet(unsigned long ulBase, unsigned long ulEndpoint, 438 unsigned char *pucData, unsigned long *pulSize); 439 extern long USBEndpointDataPut(unsigned long ulBase, unsigned long ulEndpoint, 440 unsigned char *pucData, unsigned long ulSize); 441 extern long USBEndpointDataSend(unsigned long ulBase, unsigned long ulEndpoint, 442 unsigned long ulTransType); 443 extern void USBEndpointDataToggleClear(unsigned long ulBase, 444 unsigned long ulEndpoint, 445 unsigned long ulFlags); 446 extern unsigned long USBEndpointStatus(unsigned long ulBase, 447 unsigned long ulEndpoint); 448 extern unsigned long USBFIFOAddrGet(unsigned long ulBase, 449 unsigned long ulEndpoint); 450 extern void USBFIFOConfigGet(unsigned long ulBase, unsigned long ulEndpoint, 451 unsigned long *pulFIFOAddress, 452 unsigned long *pulFIFOSize, 453 unsigned long ulFlags); 454 extern void USBFIFOConfigSet(unsigned long ulBase, unsigned long ulEndpoint, 455 unsigned long ulFIFOAddress, 456 unsigned long ulFIFOSize, unsigned long ulFlags); 457 extern void USBFIFOFlush(unsigned long ulBase, unsigned long ulEndpoint, 458 unsigned long ulFlags); 459 extern unsigned long USBFrameNumberGet(unsigned long ulBase); 460 extern unsigned long USBHostAddrGet(unsigned long ulBase, 461 unsigned long ulEndpoint, 462 unsigned long ulFlags); 463 extern void USBHostAddrSet(unsigned long ulBase, unsigned long ulEndpoint, 464 unsigned long ulAddr, unsigned long ulFlags); 465 extern void USBHostEndpointConfig(unsigned long ulBase, 466 unsigned long ulEndpoint, 467 unsigned long ulMaxPacketSize, 468 unsigned long ulNAKPollInterval, 469 unsigned long ulTargetEndpoint, 470 unsigned long ulFlags); 471 extern void USBHostEndpointDataAck(unsigned long ulBase, 472 unsigned long ulEndpoint); 473 extern void USBHostEndpointDataToggle(unsigned long ulBase, 474 unsigned long ulEndpoint, 475 tBoolean bDataToggle, 476 unsigned long ulFlags); 477 extern void USBHostEndpointStatusClear(unsigned long ulBase, 478 unsigned long ulEndpoint, 479 unsigned long ulFlags); 480 extern unsigned long USBHostHubAddrGet(unsigned long ulBase, 481 unsigned long ulEndpoint, 482 unsigned long ulFlags); 483 extern void USBHostHubAddrSet(unsigned long ulBase, unsigned long ulEndpoint, 484 unsigned long ulAddr, unsigned long ulFlags); 485 extern void USBHostPwrDisable(unsigned long ulBase); 486 extern void USBHostPwrEnable(unsigned long ulBase); 487 extern void USBHostPwrConfig(unsigned long ulBase, unsigned long ulFlags); 488 #ifndef DEPRECATED 489 #define USBHostPwrFaultConfig USBHostPwrConfig 490 #endif 491 extern void USBHostPwrFaultDisable(unsigned long ulBase); 492 extern void USBHostPwrFaultEnable(unsigned long ulBase); 493 extern void USBHostRequestIN(unsigned long ulBase, unsigned long ulEndpoint); 494 extern void USBHostRequestINClear(unsigned long ulBase, 495 unsigned long ulEndpoint); 496 extern void USBHostRequestStatus(unsigned long ulBase); 497 extern void USBHostReset(unsigned long ulBase, tBoolean bStart); 498 extern void USBHostResume(unsigned long ulBase, tBoolean bStart); 499 extern unsigned long USBHostSpeedGet(unsigned long ulBase); 500 extern void USBHostSuspend(unsigned long ulBase); 501 extern void USBIntDisableControl(unsigned long ulBase, 502 unsigned long ulIntFlags); 503 extern void USBIntEnableControl(unsigned long ulBase, 504 unsigned long ulIntFlags); 505 extern unsigned long USBIntStatusControl(unsigned long ulBase); 506 extern void USBIntDisableEndpoint(unsigned long ulBase, 507 unsigned long ulIntFlags); 508 extern void USBIntEnableEndpoint(unsigned long ulBase, 509 unsigned long ulIntFlags); 510 extern unsigned long USBIntStatusEndpoint(unsigned long ulBase); 511 extern void USBIntRegister(unsigned long ulBase, void(*pfnHandler)(void)); 512 extern void USBIntUnregister(unsigned long ulBase); 513 extern void USBOTGSessionRequest(unsigned long ulBase, tBoolean bStart); 514 extern unsigned long USBModeGet(unsigned long ulBase); 515 extern void USBEndpointDMAChannel(unsigned long ulBase, 516 unsigned long ulEndpoint, 517 unsigned long ulChannel); 518 extern void USBHostMode(unsigned long ulBase); 519 extern void USBDevMode(unsigned long ulBase); 520 extern void USBOTGMode(unsigned long ulBase); 521 extern void USBPHYPowerOff(unsigned long ulBase); 522 extern void USBPHYPowerOn(unsigned long ulBase); 523 extern unsigned long USBNumEndpointsGet(unsigned long ulBase); 524 525 //***************************************************************************** 526 // 527 // Several USB APIs have been renamed, with the original function name being 528 // deprecated. These defines and function prototypes provide backward 529 // compatibility. 530 // 531 //***************************************************************************** 532 #ifndef DEPRECATED 533 //***************************************************************************** 534 // 535 // The following are values that can be passed to USBIntEnable() and 536 // USBIntDisable() as the ulIntFlags parameter, and are returned from 537 // USBIntStatus(). 538 // 539 //***************************************************************************** 540 #define USB_INT_ALL 0xFF030E0F // All Interrupt sources 541 #define USB_INT_STATUS 0xFF000000 // Status Interrupts 542 #define USB_INT_VBUS_ERR 0x80000000 // VBUS Error 543 #define USB_INT_SESSION_START 0x40000000 // Session Start Detected 544 #define USB_INT_SESSION_END 0x20000000 // Session End Detected 545 #define USB_INT_DISCONNECT 0x20000000 // Disconnect Detected 546 #define USB_INT_CONNECT 0x10000000 // Device Connect Detected 547 #define USB_INT_SOF 0x08000000 // Start of Frame Detected 548 #define USB_INT_BABBLE 0x04000000 // Babble signaled 549 #define USB_INT_RESET 0x04000000 // Reset signaled 550 #define USB_INT_RESUME 0x02000000 // Resume detected 551 #define USB_INT_SUSPEND 0x01000000 // Suspend detected 552 #define USB_INT_MODE_DETECT 0x00020000 // Mode value valid 553 #define USB_INT_POWER_FAULT 0x00010000 // Power Fault detected 554 #define USB_INT_HOST_IN 0x00000E00 // Host IN Interrupts 555 #define USB_INT_DEV_OUT 0x00000E00 // Device OUT Interrupts 556 #define USB_INT_HOST_IN_EP3 0x00000800 // Endpoint 3 Host IN Interrupt 557 #define USB_INT_HOST_IN_EP2 0x00000400 // Endpoint 2 Host IN Interrupt 558 #define USB_INT_HOST_IN_EP1 0x00000200 // Endpoint 1 Host IN Interrupt 559 #define USB_INT_DEV_OUT_EP3 0x00000800 // Endpoint 3 Device OUT Interrupt 560 #define USB_INT_DEV_OUT_EP2 0x00000400 // Endpoint 2 Device OUT Interrupt 561 #define USB_INT_DEV_OUT_EP1 0x00000200 // Endpoint 1 Device OUT Interrupt 562 #define USB_INT_HOST_OUT 0x0000000E // Host OUT Interrupts 563 #define USB_INT_DEV_IN 0x0000000E // Device IN Interrupts 564 #define USB_INT_HOST_OUT_EP3 0x00000008 // Endpoint 3 HOST_OUT Interrupt 565 #define USB_INT_HOST_OUT_EP2 0x00000004 // Endpoint 2 HOST_OUT Interrupt 566 #define USB_INT_HOST_OUT_EP1 0x00000002 // Endpoint 1 HOST_OUT Interrupt 567 #define USB_INT_DEV_IN_EP3 0x00000008 // Endpoint 3 DEV_IN Interrupt 568 #define USB_INT_DEV_IN_EP2 0x00000004 // Endpoint 2 DEV_IN Interrupt 569 #define USB_INT_DEV_IN_EP1 0x00000002 // Endpoint 1 DEV_IN Interrupt 570 #define USB_INT_EP0 0x00000001 // Endpoint 0 Interrupt 571 572 #define USBDevEndpointConfig USBDevEndpointConfigSet 573 extern void USBIntDisable(unsigned long ulBase, unsigned long ulIntFlags); 574 extern void USBIntEnable(unsigned long ulBase, unsigned long ulIntFlags); 575 extern unsigned long USBIntStatus(unsigned long ulBase); 576 #endif 577 578 //***************************************************************************** 579 // 580 // Mark the end of the C bindings section for C++ compilers. 581 // 582 //***************************************************************************** 583 #ifdef __cplusplus 584 } 585 #endif 586 587 #endif // __USB_H__ 588