1/*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (lennart@augustsson.net) at 9 * Carlstedt Research & Technology. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33#ifndef _UHCI_H_ 34#define _UHCI_H_ 35 36#define UHCI_MAX_DEVICES MIN(USB_MAX_DEVICES, 128) 37 38#define UHCI_FRAMELIST_COUNT 1024 /* units */ 39#define UHCI_FRAMELIST_ALIGN 4096 /* bytes */ 40 41/* Structures alignment (bytes) */ 42#define UHCI_TD_ALIGN 16 43#define UHCI_QH_ALIGN 16 44 45#if ((USB_PAGE_SIZE < UHCI_TD_ALIGN) || (UHCI_TD_ALIGN == 0) || \ 46 (USB_PAGE_SIZE < UHCI_QH_ALIGN) || (UHCI_QH_ALIGN == 0)) 47#error "Invalid USB page size!" 48#endif 49 50typedef uint32_t uhci_physaddr_t; 51 52#define UHCI_PTR_T 0x00000001 53#define UHCI_PTR_TD 0x00000000 54#define UHCI_PTR_QH 0x00000002 55#define UHCI_PTR_VF 0x00000004 56 57/* 58 * The Queue Heads (QH) and Transfer Descriptors (TD) are accessed by 59 * both the CPU and the USB-controller which run concurrently. Great 60 * care must be taken. When the data-structures are linked into the 61 * USB controller's frame list, the USB-controller "owns" the 62 * td_status and qh_elink fields, which will not be written by the 63 * CPU. 64 * 65 */ 66 67struct uhci_td { 68/* 69 * Data used by the UHCI controller. 70 * volatile is used in order to mantain struct members ordering. 71 */ 72 volatile uint32_t td_next; 73 volatile uint32_t td_status; 74#define UHCI_TD_GET_ACTLEN(s) (((s) + 1) & 0x3ff) 75#define UHCI_TD_ZERO_ACTLEN(t) ((t) | 0x3ff) 76#define UHCI_TD_BITSTUFF 0x00020000 77#define UHCI_TD_CRCTO 0x00040000 78#define UHCI_TD_NAK 0x00080000 79#define UHCI_TD_BABBLE 0x00100000 80#define UHCI_TD_DBUFFER 0x00200000 81#define UHCI_TD_STALLED 0x00400000 82#define UHCI_TD_ACTIVE 0x00800000 83#define UHCI_TD_IOC 0x01000000 84#define UHCI_TD_IOS 0x02000000 85#define UHCI_TD_LS 0x04000000 86#define UHCI_TD_GET_ERRCNT(s) (((s) >> 27) & 3) 87#define UHCI_TD_SET_ERRCNT(n) ((n) << 27) 88#define UHCI_TD_SPD 0x20000000 89 volatile uint32_t td_token; 90#define UHCI_TD_PID 0x000000ff 91#define UHCI_TD_PID_IN 0x00000069 92#define UHCI_TD_PID_OUT 0x000000e1 93#define UHCI_TD_PID_SETUP 0x0000002d 94#define UHCI_TD_GET_PID(s) ((s) & 0xff) 95#define UHCI_TD_SET_DEVADDR(a) ((a) << 8) 96#define UHCI_TD_GET_DEVADDR(s) (((s) >> 8) & 0x7f) 97#define UHCI_TD_SET_ENDPT(e) (((e) & 0xf) << 15) 98#define UHCI_TD_GET_ENDPT(s) (((s) >> 15) & 0xf) 99#define UHCI_TD_SET_DT(t) ((t) << 19) 100#define UHCI_TD_GET_DT(s) (((s) >> 19) & 1) 101#define UHCI_TD_SET_MAXLEN(l) (((l)-1U) << 21) 102#define UHCI_TD_GET_MAXLEN(s) ((((s) >> 21) + 1) & 0x7ff) 103#define UHCI_TD_MAXLEN_MASK 0xffe00000 104 volatile uint32_t td_buffer; 105/* 106 * Extra information needed: 107 */ 108 struct uhci_td *next; 109 struct uhci_td *prev; 110 struct uhci_td *obj_next; 111 struct usb_page_cache *page_cache; 112 struct usb_page_cache *fix_pc; 113 uint32_t td_self; 114 uint16_t len; 115} __aligned(UHCI_TD_ALIGN); 116 117typedef struct uhci_td uhci_td_t; 118 119#define UHCI_TD_ERROR (UHCI_TD_BITSTUFF | UHCI_TD_CRCTO | \ 120 UHCI_TD_BABBLE | UHCI_TD_DBUFFER | UHCI_TD_STALLED) 121 122#define UHCI_TD_SETUP(len, endp, dev) (UHCI_TD_SET_MAXLEN(len) | \ 123 UHCI_TD_SET_ENDPT(endp) | \ 124 UHCI_TD_SET_DEVADDR(dev) | \ 125 UHCI_TD_PID_SETUP) 126 127#define UHCI_TD_OUT(len, endp, dev, dt) (UHCI_TD_SET_MAXLEN(len) | \ 128 UHCI_TD_SET_ENDPT(endp) | \ 129 UHCI_TD_SET_DEVADDR(dev) | \ 130 UHCI_TD_PID_OUT | UHCI_TD_SET_DT(dt)) 131 132#define UHCI_TD_IN(len, endp, dev, dt) (UHCI_TD_SET_MAXLEN(len) | \ 133 UHCI_TD_SET_ENDPT(endp) | \ 134 UHCI_TD_SET_DEVADDR(dev) | \ 135 UHCI_TD_PID_IN | UHCI_TD_SET_DT(dt)) 136 137struct uhci_qh { 138/* 139 * Data used by the UHCI controller. 140 */ 141 volatile uint32_t qh_h_next; 142 volatile uint32_t qh_e_next; 143/* 144 * Extra information needed: 145 */ 146 struct uhci_qh *h_next; 147 struct uhci_qh *h_prev; 148 struct uhci_qh *obj_next; 149 struct uhci_td *e_next; 150 struct usb_page_cache *page_cache; 151 uint32_t qh_self; 152 uint16_t intr_pos; 153} __aligned(UHCI_QH_ALIGN); 154 155typedef struct uhci_qh uhci_qh_t; 156 157/* Maximum number of isochronous TD's and QH's interrupt */ 158#define UHCI_VFRAMELIST_COUNT 128 159#define UHCI_IFRAMELIST_COUNT (2 * UHCI_VFRAMELIST_COUNT) 160 161#if (((UHCI_VFRAMELIST_COUNT & (UHCI_VFRAMELIST_COUNT-1)) != 0) || \ 162 (UHCI_VFRAMELIST_COUNT > UHCI_FRAMELIST_COUNT)) 163#error "UHCI_VFRAMELIST_COUNT is not power of two" 164#error "or UHCI_VFRAMELIST_COUNT > UHCI_FRAMELIST_COUNT" 165#endif 166 167#if (UHCI_VFRAMELIST_COUNT < USB_MAX_FS_ISOC_FRAMES_PER_XFER) 168#error "maximum number of full-speed isochronous frames is higher than supported!" 169#endif 170 171struct uhci_config_desc { 172 struct usb_config_descriptor confd; 173 struct usb_interface_descriptor ifcd; 174 struct usb_endpoint_descriptor endpd; 175} __packed; 176 177union uhci_hub_desc { 178 struct usb_status stat; 179 struct usb_port_status ps; 180 uint8_t temp[128]; 181}; 182 183struct uhci_hw_softc { 184 struct usb_page_cache pframes_pc; 185 struct usb_page_cache isoc_start_pc[UHCI_VFRAMELIST_COUNT]; 186 struct usb_page_cache intr_start_pc[UHCI_IFRAMELIST_COUNT]; 187 struct usb_page_cache ls_ctl_start_pc; 188 struct usb_page_cache fs_ctl_start_pc; 189 struct usb_page_cache bulk_start_pc; 190 struct usb_page_cache last_qh_pc; 191 struct usb_page_cache last_td_pc; 192 193 struct usb_page pframes_pg; 194 struct usb_page isoc_start_pg[UHCI_VFRAMELIST_COUNT]; 195 struct usb_page intr_start_pg[UHCI_IFRAMELIST_COUNT]; 196 struct usb_page ls_ctl_start_pg; 197 struct usb_page fs_ctl_start_pg; 198 struct usb_page bulk_start_pg; 199 struct usb_page last_qh_pg; 200 struct usb_page last_td_pg; 201}; 202 203typedef struct uhci_softc { 204 struct uhci_hw_softc sc_hw; 205 struct usb_bus sc_bus; /* base device */ 206 union uhci_hub_desc sc_hub_desc; 207 struct usb_callout sc_root_intr; 208 209 struct usb_device *sc_devices[UHCI_MAX_DEVICES]; 210 /* pointer to last TD for isochronous */ 211 struct uhci_td *sc_isoc_p_last[UHCI_VFRAMELIST_COUNT]; 212 /* pointer to last QH for interrupt */ 213 struct uhci_qh *sc_intr_p_last[UHCI_IFRAMELIST_COUNT]; 214 /* pointer to last QH for low speed control */ 215 struct uhci_qh *sc_ls_ctl_p_last; 216 /* pointer to last QH for full speed control */ 217 struct uhci_qh *sc_fs_ctl_p_last; 218 /* pointer to last QH for bulk */ 219 struct uhci_qh *sc_bulk_p_last; 220 struct uhci_qh *sc_reclaim_qh_p; 221 struct uhci_qh *sc_last_qh_p; 222 struct uhci_td *sc_last_td_p; 223 struct resource *sc_io_res; 224 struct resource *sc_irq_res; 225 void *sc_intr_hdl; 226 device_t sc_dev; 227 bus_size_t sc_io_size; 228 bus_space_tag_t sc_io_tag; 229 bus_space_handle_t sc_io_hdl; 230 231 uint32_t sc_loops; /* number of QHs that wants looping */ 232 233 uint16_t sc_intr_stat[UHCI_IFRAMELIST_COUNT]; 234 235 uint8_t sc_addr; /* device address */ 236 uint8_t sc_conf; /* device configuration */ 237 uint8_t sc_isreset; /* bits set if a root hub is reset */ 238 uint8_t sc_isresumed; /* bits set if a port was resumed */ 239 uint8_t sc_hub_idata[1]; 240 241 char sc_vendor[16]; /* vendor string for root hub */ 242} uhci_softc_t; 243 244usb_bus_mem_cb_t uhci_iterate_hw_softc; 245 246usb_error_t uhci_init(uhci_softc_t *sc); 247void uhci_reset(uhci_softc_t *sc); 248void uhci_interrupt(uhci_softc_t *sc); 249 250#endif /* _UHCI_H_ */ 251