Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/drv/usb/UsbInc.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Michael J. Spencer 1:f5ac63519541 1
Michael J. Spencer 1:f5ac63519541 2 /*
Michael J. Spencer 1:f5ac63519541 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
Michael J. Spencer 1:f5ac63519541 4
Michael J. Spencer 1:f5ac63519541 5 Permission is hereby granted, free of charge, to any person obtaining a copy
Michael J. Spencer 1:f5ac63519541 6 of this software and associated documentation files (the "Software"), to deal
Michael J. Spencer 1:f5ac63519541 7 in the Software without restriction, including without limitation the rights
Michael J. Spencer 1:f5ac63519541 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Michael J. Spencer 1:f5ac63519541 9 copies of the Software, and to permit persons to whom the Software is
Michael J. Spencer 1:f5ac63519541 10 furnished to do so, subject to the following conditions:
Michael J. Spencer 1:f5ac63519541 11
Michael J. Spencer 1:f5ac63519541 12 The above copyright notice and this permission notice shall be included in
Michael J. Spencer 1:f5ac63519541 13 all copies or substantial portions of the Software.
Michael J. Spencer 1:f5ac63519541 14
Michael J. Spencer 1:f5ac63519541 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Michael J. Spencer 1:f5ac63519541 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Michael J. Spencer 1:f5ac63519541 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Michael J. Spencer 1:f5ac63519541 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Michael J. Spencer 1:f5ac63519541 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Michael J. Spencer 1:f5ac63519541 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Michael J. Spencer 1:f5ac63519541 21 THE SOFTWARE.
Michael J. Spencer 1:f5ac63519541 22 */
Michael J. Spencer 1:f5ac63519541 23
Michael J. Spencer 1:f5ac63519541 24 #ifndef USB_INC_H
Michael J. Spencer 1:f5ac63519541 25 #define USB_INC_H
Michael J. Spencer 1:f5ac63519541 26
Michael J. Spencer 1:f5ac63519541 27 #include "mbed.h"
Michael J. Spencer 1:f5ac63519541 28
Michael J. Spencer 1:f5ac63519541 29 #define MIN(a,b) ((a)<(b)?(a):(b))
Michael J. Spencer 1:f5ac63519541 30 #define MAX(a,b) ((a)>(b)?(a):(b))
Michael J. Spencer 1:f5ac63519541 31
Michael J. Spencer 1:f5ac63519541 32 //typedef int32_t RC;
Michael J. Spencer 1:f5ac63519541 33
Michael J. Spencer 1:f5ac63519541 34 typedef uint8_t byte;
Michael J. Spencer 1:f5ac63519541 35 typedef uint16_t word;
Michael J. Spencer 1:f5ac63519541 36
Michael J. Spencer 1:f5ac63519541 37 enum UsbErr
Michael J. Spencer 1:f5ac63519541 38 {
Michael J. Spencer 1:f5ac63519541 39 __USBERR_MIN = -0xFFFF,
Michael J. Spencer 1:f5ac63519541 40 USBERR_DISCONNECTED,
Michael J. Spencer 1:f5ac63519541 41 USBERR_NOTFOUND,
Michael J. Spencer 1:f5ac63519541 42 USBERR_BADCONFIG,
Michael J. Spencer 1:f5ac63519541 43 USBERR_PROCESSING,
Michael J. Spencer 1:f5ac63519541 44 USBERR_HALTED, //Transfer on an ep is stalled
Michael J. Spencer 1:f5ac63519541 45 USBERR_BUSY,
Michael J. Spencer 1:f5ac63519541 46 USBERR_TDFAIL,
Michael J. Spencer 1:f5ac63519541 47 USBERR_ERROR,
Michael J. Spencer 1:f5ac63519541 48 USBERR_OK = 0
Michael J. Spencer 1:f5ac63519541 49 };
Michael J. Spencer 1:f5ac63519541 50
Michael J. Spencer 1:f5ac63519541 51
Michael J. Spencer 1:f5ac63519541 52 /* From NXP's USBHostLite stack's usbhost_lpc17xx.h */
Michael J. Spencer 1:f5ac63519541 53 /* Only the types names have been changed to avoid unecessary typedefs */
Michael J. Spencer 1:f5ac63519541 54
Michael J. Spencer 1:f5ac63519541 55
Michael J. Spencer 1:f5ac63519541 56 /*
Michael J. Spencer 1:f5ac63519541 57 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 58 * NXP USB Host Stack
Michael J. Spencer 1:f5ac63519541 59 *
Michael J. Spencer 1:f5ac63519541 60 * (c) Copyright 2008, NXP SemiConductors
Michael J. Spencer 1:f5ac63519541 61 * (c) Copyright 2008, OnChip Technologies LLC
Michael J. Spencer 1:f5ac63519541 62 * All Rights Reserved
Michael J. Spencer 1:f5ac63519541 63 *
Michael J. Spencer 1:f5ac63519541 64 * www.nxp.com
Michael J. Spencer 1:f5ac63519541 65 * www.onchiptech.com
Michael J. Spencer 1:f5ac63519541 66 *
Michael J. Spencer 1:f5ac63519541 67 * File : usbhost_lpc17xx.h
Michael J. Spencer 1:f5ac63519541 68 * Programmer(s) : Ravikanth.P
Michael J. Spencer 1:f5ac63519541 69 * Version :
Michael J. Spencer 1:f5ac63519541 70 *
Michael J. Spencer 1:f5ac63519541 71 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 72 */
Michael J. Spencer 1:f5ac63519541 73
Michael J. Spencer 1:f5ac63519541 74
Michael J. Spencer 1:f5ac63519541 75
Michael J. Spencer 1:f5ac63519541 76 /*
Michael J. Spencer 1:f5ac63519541 77 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 78 * OHCI OPERATIONAL REGISTER FIELD DEFINITIONS
Michael J. Spencer 1:f5ac63519541 79 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 80 */
Michael J. Spencer 1:f5ac63519541 81
Michael J. Spencer 1:f5ac63519541 82 /* ------------------ HcControl Register --------------------- */
Michael J. Spencer 1:f5ac63519541 83 #define OR_CONTROL_CLE 0x00000010
Michael J. Spencer 1:f5ac63519541 84 #define OR_CONTROL_BLE 0x00000020
Michael J. Spencer 1:f5ac63519541 85 #define OR_CONTROL_HCFS 0x000000C0
Michael J. Spencer 1:f5ac63519541 86 #define OR_CONTROL_HC_OPER 0x00000080
Michael J. Spencer 1:f5ac63519541 87 /* ----------------- HcCommandStatus Register ----------------- */
Michael J. Spencer 1:f5ac63519541 88 #define OR_CMD_STATUS_HCR 0x00000001
Michael J. Spencer 1:f5ac63519541 89 #define OR_CMD_STATUS_CLF 0x00000002
Michael J. Spencer 1:f5ac63519541 90 #define OR_CMD_STATUS_BLF 0x00000004
Michael J. Spencer 1:f5ac63519541 91 /* --------------- HcInterruptStatus Register ----------------- */
Michael J. Spencer 1:f5ac63519541 92 #define OR_INTR_STATUS_WDH 0x00000002
Michael J. Spencer 1:f5ac63519541 93 #define OR_INTR_STATUS_RHSC 0x00000040
Michael J. Spencer 1:f5ac63519541 94 #define OR_INTR_STATUS_UE 0x00000010
Michael J. Spencer 1:f5ac63519541 95 /* --------------- HcInterruptEnable Register ----------------- */
Michael J. Spencer 1:f5ac63519541 96 #define OR_INTR_ENABLE_WDH 0x00000002
Michael J. Spencer 1:f5ac63519541 97 #define OR_INTR_ENABLE_RHSC 0x00000040
Michael J. Spencer 1:f5ac63519541 98 #define OR_INTR_ENABLE_MIE 0x80000000
Michael J. Spencer 1:f5ac63519541 99 /* ---------------- HcRhDescriptorA Register ------------------ */
Michael J. Spencer 1:f5ac63519541 100 #define OR_RH_STATUS_LPSC 0x00010000
Michael J. Spencer 1:f5ac63519541 101 #define OR_RH_STATUS_DRWE 0x00008000
Michael J. Spencer 1:f5ac63519541 102 /* -------------- HcRhPortStatus[1:NDP] Register -------------- */
Michael J. Spencer 1:f5ac63519541 103 #define OR_RH_PORT_CCS 0x00000001
Michael J. Spencer 1:f5ac63519541 104 #define OR_RH_PORT_PRS 0x00000010
Michael J. Spencer 1:f5ac63519541 105 #define OR_RH_PORT_CSC 0x00010000
Michael J. Spencer 1:f5ac63519541 106 #define OR_RH_PORT_PRSC 0x00100000
Michael J. Spencer 1:f5ac63519541 107
Michael J. Spencer 1:f5ac63519541 108
Michael J. Spencer 1:f5ac63519541 109 /*
Michael J. Spencer 1:f5ac63519541 110 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 111 * FRAME INTERVAL
Michael J. Spencer 1:f5ac63519541 112 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 113 */
Michael J. Spencer 1:f5ac63519541 114
Michael J. Spencer 1:f5ac63519541 115 #define FI 0x2EDF /* 12000 bits per frame (-1) */
Michael J. Spencer 1:f5ac63519541 116 #define DEFAULT_FMINTERVAL ((((6 * (FI - 210)) / 7) << 16) | FI)
Michael J. Spencer 1:f5ac63519541 117
Michael J. Spencer 1:f5ac63519541 118 /*
Michael J. Spencer 1:f5ac63519541 119 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 120 * ENDPOINT DESCRIPTOR CONTROL FIELDS
Michael J. Spencer 1:f5ac63519541 121 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 122 */
Michael J. Spencer 1:f5ac63519541 123
Michael J. Spencer 1:f5ac63519541 124 #define ED_SKIP (uint32_t) (0x00001000) /* Skip this ep in queue */
Michael J. Spencer 1:f5ac63519541 125
Michael J. Spencer 1:f5ac63519541 126 /*
Michael J. Spencer 1:f5ac63519541 127 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 128 * TRANSFER DESCRIPTOR CONTROL FIELDS
Michael J. Spencer 1:f5ac63519541 129 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 130 */
Michael J. Spencer 1:f5ac63519541 131
Michael J. Spencer 1:f5ac63519541 132 #define TD_ROUNDING (uint32_t) (0x00040000) /* Buffer Rounding */
Michael J. Spencer 1:f5ac63519541 133 #define TD_SETUP (uint32_t)(0) /* Direction of Setup Packet */
Michael J. Spencer 1:f5ac63519541 134 #define TD_IN (uint32_t)(0x00100000) /* Direction In */
Michael J. Spencer 1:f5ac63519541 135 #define TD_OUT (uint32_t)(0x00080000) /* Direction Out */
Michael J. Spencer 1:f5ac63519541 136 #define TD_DELAY_INT(x) (uint32_t)((x) << 21) /* Delay Interrupt */
Michael J. Spencer 1:f5ac63519541 137 #define TD_TOGGLE_0 (uint32_t)(0x02000000) /* Toggle 0 */
Michael J. Spencer 1:f5ac63519541 138 #define TD_TOGGLE_1 (uint32_t)(0x03000000) /* Toggle 1 */
Michael J. Spencer 1:f5ac63519541 139 #define TD_CC (uint32_t)(0xF0000000) /* Completion Code */
Michael J. Spencer 1:f5ac63519541 140
Michael J. Spencer 1:f5ac63519541 141 /*
Michael J. Spencer 1:f5ac63519541 142 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 143 * USB STANDARD REQUEST DEFINITIONS
Michael J. Spencer 1:f5ac63519541 144 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 145 */
Michael J. Spencer 1:f5ac63519541 146
Michael J. Spencer 1:f5ac63519541 147 #define USB_DESCRIPTOR_TYPE_DEVICE 1
Michael J. Spencer 1:f5ac63519541 148 #define USB_DESCRIPTOR_TYPE_CONFIGURATION 2
Michael J. Spencer 1:f5ac63519541 149 #define USB_DESCRIPTOR_TYPE_INTERFACE 4
Michael J. Spencer 1:f5ac63519541 150 #define USB_DESCRIPTOR_TYPE_ENDPOINT 5
Michael J. Spencer 1:f5ac63519541 151 /* ----------- Control RequestType Fields ----------- */
Michael J. Spencer 1:f5ac63519541 152 #define USB_DEVICE_TO_HOST 0x80
Michael J. Spencer 1:f5ac63519541 153 #define USB_HOST_TO_DEVICE 0x00
Michael J. Spencer 1:f5ac63519541 154 #define USB_REQUEST_TYPE_CLASS 0x20
Michael J. Spencer 1:f5ac63519541 155 #define USB_RECIPIENT_DEVICE 0x00
Michael J. Spencer 1:f5ac63519541 156 #define USB_RECIPIENT_INTERFACE 0x01
Michael J. Spencer 1:f5ac63519541 157 /* -------------- USB Standard Requests -------------- */
Michael J. Spencer 1:f5ac63519541 158 #define SET_ADDRESS 5
Michael J. Spencer 1:f5ac63519541 159 #define GET_DESCRIPTOR 6
Michael J. Spencer 1:f5ac63519541 160 #define SET_CONFIGURATION 9
Michael J. Spencer 1:f5ac63519541 161 #define SET_INTERFACE 11
Michael J. Spencer 1:f5ac63519541 162
Michael J. Spencer 1:f5ac63519541 163 /*
Michael J. Spencer 1:f5ac63519541 164 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 165 * TYPE DEFINITIONS
Michael J. Spencer 1:f5ac63519541 166 **************************************************************************************************************
Michael J. Spencer 1:f5ac63519541 167 */
Michael J. Spencer 1:f5ac63519541 168
Michael J. Spencer 1:f5ac63519541 169 typedef struct hcEd { /* ----------- HostController EndPoint Descriptor ------------- */
Michael J. Spencer 1:f5ac63519541 170 volatile uint32_t Control; /* Endpoint descriptor control */
Michael J. Spencer 1:f5ac63519541 171 volatile uint32_t TailTd; /* Physical address of tail in Transfer descriptor list */
Michael J. Spencer 1:f5ac63519541 172 volatile uint32_t HeadTd; /* Physcial address of head in Transfer descriptor list */
Michael J. Spencer 1:f5ac63519541 173 volatile uint32_t Next; /* Physical address of next Endpoint descriptor */
Michael J. Spencer 1:f5ac63519541 174 } HCED;
Michael J. Spencer 1:f5ac63519541 175
Michael J. Spencer 1:f5ac63519541 176 typedef struct hcTd { /* ------------ HostController Transfer Descriptor ------------ */
Michael J. Spencer 1:f5ac63519541 177 volatile uint32_t Control; /* Transfer descriptor control */
Michael J. Spencer 1:f5ac63519541 178 volatile uint32_t CurrBufPtr; /* Physical address of current buffer pointer */
Michael J. Spencer 1:f5ac63519541 179 volatile uint32_t Next; /* Physical pointer to next Transfer Descriptor */
Michael J. Spencer 1:f5ac63519541 180 volatile uint32_t BufEnd; /* Physical address of end of buffer */
Michael J. Spencer 1:f5ac63519541 181 } HCTD;
Michael J. Spencer 1:f5ac63519541 182
Michael J. Spencer 1:f5ac63519541 183 typedef struct hcca { /* ----------- Host Controller Communication Area ------------ */
Michael J. Spencer 1:f5ac63519541 184 volatile uint32_t IntTable[32]; /* Interrupt Table */
Michael J. Spencer 1:f5ac63519541 185 volatile uint32_t FrameNumber; /* Frame Number */
Michael J. Spencer 1:f5ac63519541 186 volatile uint32_t DoneHead; /* Done Head */
Michael J. Spencer 1:f5ac63519541 187 volatile uint8_t Reserved[116]; /* Reserved for future use */
Michael J. Spencer 1:f5ac63519541 188 volatile uint8_t Unknown[4]; /* Unused */
Michael J. Spencer 1:f5ac63519541 189 } HCCA;
Michael J. Spencer 1:f5ac63519541 190
Michael J. Spencer 1:f5ac63519541 191
Michael J. Spencer 1:f5ac63519541 192
Michael J. Spencer 1:f5ac63519541 193 #endif