root/sys/dev/usb/controller/ehcireg.h
/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2001 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Lennart Augustsson (lennart@augustsson.net).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _EHCIREG_H_
#define _EHCIREG_H_

/* PCI config registers  */
#define PCI_CBMEM               0x10    /* configuration base MEM */
#define PCI_INTERFACE_EHCI      0x20
#define PCI_USBREV              0x60    /* RO USB protocol revision */
#define PCI_USB_REV_MASK        0xff
#define PCI_USB_REV_PRE_1_0     0x00
#define PCI_USB_REV_1_0         0x10
#define PCI_USB_REV_1_1         0x11
#define PCI_USB_REV_2_0         0x20
#define PCI_EHCI_FLADJ          0x61    /* RW Frame len adj, SOF=59488+6*fladj */
#define PCI_EHCI_PORTWAKECAP    0x62    /* RW Port wake caps (opt)  */

/* EHCI Extended Capabilities */
#define EHCI_EC_LEGSUP          0x01
#define EHCI_EECP_NEXT(x)       (((x) >> 8) & 0xff)
#define EHCI_EECP_ID(x)         ((x) & 0xff)

/* Legacy support extended capability */
#define EHCI_LEGSUP_BIOS_SEM            0x02
#define EHCI_LEGSUP_OS_SEM              0x03
#define EHCI_LEGSUP_USBLEGCTLSTS        0x04

/* EHCI capability registers */
#define EHCI_CAPLEN_HCIVERSION  0x00    /* RO Capability register length
                                         * (least-significant byte) and 
                                         * interface version number (two
                                         * most significant)
                                         */
#define EHCI_CAPLENGTH(x)       ((x) & 0xff)
#define EHCI_HCIVERSION(x)      (((x) >> 16) & 0xffff)
#define EHCI_HCSPARAMS          0x04    /* RO Structural parameters */
#define EHCI_HCS_DEBUGPORT(x)   (((x) >> 20) & 0xf)
#define EHCI_HCS_P_INDICATOR(x) ((x) & 0x10000)
#define EHCI_HCS_N_CC(x)        (((x) >> 12) & 0xf)     /* # of companion ctlrs */
#define EHCI_HCS_N_PCC(x)       (((x) >> 8) & 0xf)      /* # of ports per comp. */
#define EHCI_HCS_PPC(x)         ((x) & 0x10)    /* port power control */
#define EHCI_HCS_N_PORTS(x)     ((x) & 0xf)     /* # of ports */
#define EHCI_HCCPARAMS          0x08    /* RO Capability parameters */
#define EHCI_HCC_EECP(x)        (((x) >> 8) & 0xff)     /* extended ports caps */
#define EHCI_HCC_IST(x)         (((x) >> 4) & 0xf)      /* isoc sched threshold */
#define EHCI_HCC_ASPC(x)        ((x) & 0x4)     /* async sched park cap */
#define EHCI_HCC_PFLF(x)        ((x) & 0x2)     /* prog frame list flag */
#define EHCI_HCC_64BIT(x)       ((x) & 0x1)     /* 64 bit address cap */
#define EHCI_HCSP_PORTROUTE     0x0c    /* RO Companion port route description */

/* EHCI operational registers.  Offset given by EHCI_CAPLENGTH register */
#define EHCI_USBCMD             0x00    /* RO, RW, WO Command register */
#define EHCI_CMD_ITC_M          0x00ff0000      /* RW interrupt threshold ctrl */
#define EHCI_CMD_ITC_1          0x00010000
#define EHCI_CMD_ITC_2          0x00020000
#define EHCI_CMD_ITC_4          0x00040000
#define EHCI_CMD_ITC_8          0x00080000
#define EHCI_CMD_ITC_16         0x00100000
#define EHCI_CMD_ITC_32         0x00200000
#define EHCI_CMD_ITC_64         0x00400000
#define EHCI_CMD_ASPME          0x00000800      /* RW/RO async park enable */
#define EHCI_CMD_ASPMC          0x00000300      /* RW/RO async park count */
#define EHCI_CMD_LHCR           0x00000080      /* RW light host ctrl reset */
#define EHCI_CMD_IAAD           0x00000040      /* RW intr on async adv door
                                                 * bell */
#define EHCI_CMD_ASE            0x00000020      /* RW async sched enable */
#define EHCI_CMD_PSE            0x00000010      /* RW periodic sched enable */
#define EHCI_CMD_FLS_M          0x0000000c      /* RW/RO frame list size */
#define EHCI_CMD_FLS(x)         (((x) >> 2) & 3)        /* RW/RO frame list size */
#define EHCI_CMD_HCRESET        0x00000002      /* RW reset */
#define EHCI_CMD_RS             0x00000001      /* RW run/stop */
#define EHCI_USBSTS             0x04    /* RO, RW, RWC Status register */
#define EHCI_STS_ASS            0x00008000      /* RO async sched status */
#define EHCI_STS_PSS            0x00004000      /* RO periodic sched status */
#define EHCI_STS_REC            0x00002000      /* RO reclamation */
#define EHCI_STS_HCH            0x00001000      /* RO host controller halted */
#define EHCI_STS_IAA            0x00000020      /* RWC interrupt on async adv */
#define EHCI_STS_HSE            0x00000010      /* RWC host system error */
#define EHCI_STS_FLR            0x00000008      /* RWC frame list rollover */
#define EHCI_STS_PCD            0x00000004      /* RWC port change detect */
#define EHCI_STS_ERRINT         0x00000002      /* RWC error interrupt */
#define EHCI_STS_INT            0x00000001      /* RWC interrupt */
#define EHCI_STS_INTRS(x)       ((x) & 0x3f)

/*
 * NOTE: the doorbell interrupt is enabled, but the doorbell is never
 * used! SiS chipsets require this.
 */
#define EHCI_NORMAL_INTRS       (EHCI_STS_IAA | EHCI_STS_HSE |  \
                                EHCI_STS_PCD | EHCI_STS_ERRINT | EHCI_STS_INT)

#define EHCI_USBINTR            0x08    /* RW Interrupt register */
#define EHCI_INTR_IAAE          0x00000020      /* interrupt on async advance
                                                 * ena */
#define EHCI_INTR_HSEE          0x00000010      /* host system error ena */
#define EHCI_INTR_FLRE          0x00000008      /* frame list rollover ena */
#define EHCI_INTR_PCIE          0x00000004      /* port change ena */
#define EHCI_INTR_UEIE          0x00000002      /* USB error intr ena */
#define EHCI_INTR_UIE           0x00000001      /* USB intr ena */

#define EHCI_FRINDEX            0x0c    /* RW Frame Index register */

#define EHCI_CTRLDSSEGMENT      0x10    /* RW Control Data Structure Segment */

#define EHCI_PERIODICLISTBASE   0x14    /* RW Periodic List Base */
#define EHCI_ASYNCLISTADDR      0x18    /* RW Async List Base */

#define EHCI_CONFIGFLAG         0x40    /* RW Configure Flag register */
#define EHCI_CONF_CF            0x00000001      /* RW configure flag */

#define EHCI_PORTSC(n)          (0x40+(4*(n)))  /* RO, RW, RWC Port Status reg */
#define EHCI_PS_WKOC_E          0x00400000      /* RW wake on over current ena */
#define EHCI_PS_WKDSCNNT_E      0x00200000      /* RW wake on disconnect ena */
#define EHCI_PS_WKCNNT_E        0x00100000      /* RW wake on connect ena */
#define EHCI_PS_PTC             0x000f0000      /* RW port test control */
#define EHCI_PS_PIC             0x0000c000      /* RW port indicator control */
#define EHCI_PS_PO              0x00002000      /* RW port owner */
#define EHCI_PS_PP              0x00001000      /* RW,RO port power */
#define EHCI_PS_LS              0x00000c00      /* RO line status */
#define EHCI_PS_IS_LOWSPEED(x)  (((x) & EHCI_PS_LS) == 0x00000400)
#define EHCI_PS_PR              0x00000100      /* RW port reset */
#define EHCI_PS_SUSP            0x00000080      /* RW suspend */
#define EHCI_PS_FPR             0x00000040      /* RW force port resume */
#define EHCI_PS_OCC             0x00000020      /* RWC over current change */
#define EHCI_PS_OCA             0x00000010      /* RO over current active */
#define EHCI_PS_PEC             0x00000008      /* RWC port enable change */
#define EHCI_PS_PE              0x00000004      /* RW port enable */
#define EHCI_PS_CSC             0x00000002      /* RWC connect status change */
#define EHCI_PS_CS              0x00000001      /* RO connect status */
#define EHCI_PS_CLEAR           (EHCI_PS_OCC | EHCI_PS_PEC | EHCI_PS_CSC)

#define EHCI_PORT_RESET_COMPLETE        2       /* ms */

/*
 * Registers not covered by EHCI specification
 *
 *
 * EHCI_USBMODE register offset is different for cores with LPM support,
 * bits are equal
 */
#define EHCI_USBMODE_NOLPM      0x68    /* RW USB Device mode reg (no LPM) */
#define EHCI_USBMODE_LPM        0xC8    /* RW USB Device mode reg (LPM) */
#define EHCI_UM_CM              0x00000003      /* R/WO Controller Mode */
#define EHCI_UM_CM_IDLE         0x0     /* Idle */
#define EHCI_UM_CM_HOST         0x3     /* Host Controller */
#define EHCI_UM_ES              0x00000004      /* R/WO Endian Select */
#define EHCI_UM_ES_LE           0x0     /* Little-endian byte alignment */
#define EHCI_UM_ES_BE           0x4     /* Big-endian byte alignment */
#define EHCI_UM_SDIS            0x00000010      /* R/WO Stream Disable Mode */

/*
 * Actual port speed bits depends on EHCI_HOSTC(n) registers presence,
 * speed encoding is equal
 */
#define EHCI_HOSTC(n)           (0x80+(4*(n)))  /* RO, RW Host mode control reg */
#define EHCI_HOSTC_PSPD_SHIFT   25
#define EHCI_HOSTC_PSPD_MASK    0x3

#define EHCI_PORTSC_PSPD_SHIFT  26
#define EHCI_PORTSC_PSPD_MASK   0x3

#define EHCI_PORT_SPEED_FULL    0
#define EHCI_PORT_SPEED_LOW     1
#define EHCI_PORT_SPEED_HIGH    2
#endif  /* _EHCIREG_H_ */