/*      $NetBSD: ehcireg.h,v 1.41 2024/09/23 10:07:26 skrll Exp $       */

/*
* Copyright (c) 2001, 2004 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Lennart Augustsson ([email protected]).
*
* 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.
*/

/*
* The EHCI 0.96 spec can be found at
* http://developer.intel.com/technology/usb/download/ehci-r096.pdf
* and the USB 2.0 spec at
* http://www.usb.org/developers/data/usb_20.zip
*/

#ifndef _DEV_USB_EHCIREG_H_
#define _DEV_USB_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_USBREV_MASK        0xff
#define  PCI_USBREV_PRE_1_0     0x00
#define  PCI_USBREV_1_0         0x10
#define  PCI_USBREV_1_1         0x11
#define  PCI_USBREV_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)  */

/* Regs at EECP + offset */
#define PCI_EHCI_USBLEGSUP      0x00
#define  EHCI_LEG_HC_OS_OWNED           0x01000000
#define  EHCI_LEG_HC_BIOS_OWNED         0x00010000
#define PCI_EHCI_USBLEGCTLSTS   0x04
#define  EHCI_LEG_EXT_SMI_BAR           0x80000000
#define  EHCI_LEG_EXT_SMI_PCICMD        0x40000000
#define  EHCI_LEG_EXT_SMI_OS_CHANGE     0x20000000

#define EHCI_CAP_GET_ID(cap) ((cap) & 0xff)
#define EHCI_CAP_GET_NEXT(cap) (((cap) >> 8) & 0xff)
#define EHCI_CAP_ID_LEGACY 1

/*** EHCI capability registers ***/

#define EHCI_CAPLENGTH          0x00    /*RO Capability register length field */
/* reserved                     0x01 */
#define EHCI_HCIVERSION         0x02    /* RO Interface version number */

#define EHCI_HCSPARAMS          0x04    /* RO Structural parameters */
#define  EHCI_HCS_N_TT(x)       (((x) >> 20) & 0xf) /* # of xacts xlater ETTF */
#define  EHCI_HCS_N_PTT(x)      (((x) >> 20) & 0xf) /* ports per xlater ETTF */
#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_FULLFRAME         __BIT(7)
#define  EHCI_HCC_IST_THRESHOLD_MASK    __BITS(6,4)     /* isoc sched threshold */
#define  EHCI_HCC_GET_IST_THRESHOLD(x)  __SHIFTOUT((x), EHCI_HCC_IST_THRESHOLD_MASK)
#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)

#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_PSPD           0x0C000000 /* RO port speed (ETTF) */
#define  EHCI_PS_PSPD_FS        0x00000000 /* Full speed (ETTF) */
#define  EHCI_PS_PSPD_LS        0x04000000 /* Low speed (ETTF) */
#define  EHCI_PS_PSPD_HS        0x08000000 /* High speed (ETTF) */
#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 */

#define EHCI_FLALIGN_ALIGN      0x1000
#define EHCI_MAX_PORTS          16 /* only 4 bits available in EHCI_HCS_N_PORTS */

/* No data structure may cross a page boundary. */
#define EHCI_PAGE_SHIFT         12
#define EHCI_PAGE_SIZE          (1 << EHCI_PAGE_SHIFT)
#define EHCI_PAGE_MASK          (EHCI_PAGE_SIZE - 1)
#define EHCI_PAGE(x)            ((x) & ~EHCI_PAGE_MASK)
#define EHCI_PAGE_OFFSET(x)     ((x) & EHCI_PAGE_MASK)
#define EHCI_NPAGES(x)          (((x) + EHCI_PAGE_MASK) >> EHCI_PAGE_SHIFT)

typedef uint32_t ehci_link_t;
#define EHCI_LINK_TERMINATE     __BIT(0)
#define EHCI_LINK_TYPE(x)       ((x) & 0x00000006)
#define  EHCI_LINK_ITD          0x0
#define  EHCI_LINK_QH           0x2
#define  EHCI_LINK_SITD         0x4
#define  EHCI_LINK_FSTN         0x6
#define EHCI_LINK_ADDR(x)       ((x) &~ 0x1f)

typedef uint32_t ehci_physaddr_t;

typedef uint32_t ehci_isoc_trans_t;
typedef uint32_t ehci_isoc_bufr_ptr_t;

/* Isochronous Transfer Descriptor */
#define EHCI_ITD_ALIGN 32
#define EHCI_ITD_NUFRAMES USB_UFRAMES_PER_FRAME
#define EHCI_ITD_NBUFFERS 7
typedef struct ehci_itd_t {
       volatile ehci_link_t            itd_next;
       volatile ehci_isoc_trans_t      itd_ctl[EHCI_ITD_NUFRAMES];
#define EHCI_ITD_STATUS_MASK    __BITS(31,28)
#define EHCI_ITD_GET_STATUS(x)  __SHIFTOUT((x), EHCI_ITD_STATUS_MASK)
#define EHCI_ITD_SET_STATUS(x)  __SHIFTIN((x), EHCI_ITD_STATUS_MASK)
#define EHCI_ITD_ACTIVE         __BIT(31)
#define EHCI_ITD_BUF_ERR        __BIT(30)
#define EHCI_ITD_BABBLE         __BIT(29)
#define EHCI_ITD_ERROR          __BIT(28)
#define EHCI_ITD_LEN_MASK       __BITS(27,16)
#define EHCI_ITD_GET_LEN(x)     __SHIFTOUT((x), EHCI_ITD_LEN_MASK)
#define EHCI_ITD_SET_LEN(x)     __SHIFTIN((x), EHCI_ITD_LEN_MASK)
#define EHCI_ITD_IOC            __BIT(15)
#define EHCI_ITD_GET_IOC(x)     __SHIFTOUT((x), EHCI_ITD_IOC)
#define EHCI_ITD_SET_IOC(x)     __SHIFTIN((x), EHCI_ITD_IOC)
#define EHCI_ITD_PG_MASK        __BITS(14,12)
#define EHCI_ITD_GET_PG(x)      __SHIFTOUT((x), EHCI_ITD_PG_MASK)
#define EHCI_ITD_SET_PG(x)      __SHIFTIN((x), EHCI_ITD_PG_MASK)
#define EHCI_ITD_OFFSET_MASK    __BITS(11,0)
#define EHCI_ITD_GET_OFFS(x)    __SHIFTOUT((x), EHCI_ITD_OFFSET_MASK)
#define EHCI_ITD_SET_OFFS(x)    __SHIFTIN((x), EHCI_ITD_OFFSET_MASK)
       volatile ehci_isoc_bufr_ptr_t   itd_bufr[EHCI_ITD_NBUFFERS];
#define EHCI_ITD_BPTR_MASK      __BITS(31,12)
#define EHCI_ITD_GET_BPTR(x)    ((x) & EHCI_ITD_BPTR_MASK)
#define EHCI_ITD_SET_BPTR(x)    ((x) & EHCI_ITD_BPTR_MASK)
#define EHCI_ITD_EP_MASK        __BITS(11,8)
#define EHCI_ITD_GET_EP(x)      __SHIFTOUT((x), EHCI_ITD_EP_MASK)
#define EHCI_ITD_SET_EP(x)      __SHIFTIN((x), EHCI_ITD_EP_MASK)
#define EHCI_ITD_DADDR_MASK     __BITS(6,0)
#define EHCI_ITD_GET_DADDR(x)   __SHIFTOUT((x), EHCI_ITD_DADDR_MASK)
#define EHCI_ITD_SET_DADDR(x)   __SHIFTIN((x), EHCI_ITD_DADDR_MASK)
#define EHCI_ITD_DIR_MASK       __BIT(11)
#define EHCI_ITD_GET_DIR(x)     __SHIFTOUT((x), EHCI_ITD_DIR_MASK)
#define EHCI_ITD_SET_DIR(x)     __SHIFTIN((x), EHCI_ITD_DIR_MASK)
#define EHCI_ITD_MAXPKT_MASK    __BITS(10,0)
#define EHCI_ITD_GET_MAXPKT(x)  __SHIFTOUT((x), EHCI_ITD_MAXPKT_MASK)
#define EHCI_ITD_SET_MAXPKT(x)  __SHIFTIN((x), EHCI_ITD_MAXPKT_MASK)
#define EHCI_ITD_MULTI_MASK     __BITS(1,0)
#define EHCI_ITD_GET_MULTI(x)   __SHIFTOUT((x), EHCI_ITD_MULTI_MASK)
#define EHCI_ITD_SET_MULTI(x)   __SHIFTIN((x), EHCI_ITD_MULTI_MASK)
       volatile ehci_isoc_bufr_ptr_t   itd_bufr_hi[EHCI_ITD_NBUFFERS];
} ehci_itd_t;
#define EHCI_ITD_ALLOC_ALIGN    MAX(EHCI_ITD_ALIGN, CACHE_LINE_SIZE)
#define EHCI_ITD_SIZE           (roundup(sizeof(ehci_itd_t), EHCI_ITD_ALLOC_ALIGN))
#define EHCI_ITD_CHUNK          (EHCI_PAGE_SIZE / EHCI_ITD_SIZE)

/* Split Transaction Isochronous Transfer Descriptor */
#define EHCI_SITD_ALIGN 32
typedef struct ehci_sitd_t {
       volatile ehci_link_t    sitd_next;
       volatile uint32_t       sitd_endp;
#define EHCI_SITD_DIR_MASK      __BIT(31)
#define EHCI_SITD_PORT_MASK     __BITS(30,24)
#define EHCI_SITD_HUBA_MASK     __BITS(22,16)
#define EHCI_SITD_ENDPT_MASK    __BITS(11,8)
#define EHCI_SITD_DADDR_MASK    __BITS(6,0)
#define EHCI_SITD_SET_DIR(x)    __SHIFTIN((x), EHCI_SITD_DIR_MASK)
#define EHCI_SITD_SET_PORT(x)   __SHIFTIN((x), EHCI_SITD_PORT_MASK)
#define EHCI_SITD_SET_HUBA(x)   __SHIFTIN((x), EHCI_SITD_HUBA_MASK)
#define EHCI_SITD_SET_ENDPT(x)  __SHIFTIN((x), EHCI_SITD_ENDPT_MASK)
#define EHCI_SITD_SET_DADDR(x)  __SHIFTIN((x), EHCI_SITD_DADDR_MASK)
       volatile uint32_t       sitd_sched;
#define EHCI_SITD_SMASK_MASK    __BITS(7,0)
#define EHCI_SITD_CMASK_MASK    __BITS(15,8)
#define EHCI_SITD_SET_SMASK(x)  __SHIFTIN((x), EHCI_SITD_SMASK_MASK)
#define EHCI_SITD_SET_CMASK(x)  __SHIFTIN((x), EHCI_SITD_CMASK_MASK)
       volatile uint32_t       sitd_trans;
#define EHCI_SITD_IOC           __BIT(31)
#define EHCI_SITD_P             __BIT(30)
#define EHCI_SITD_LENGTH_MASK   __BITS(25,16)
#define EHCI_SITD_GET_LEN(x)    __SHIFTOUT((x), EHCI_SITD_LENGTH_MASK)
#define EHCI_SITD_SET_LEN(x)    __SHIFTIN((x), EHCI_SITD_LENGTH_MASK)
#define EHCI_SITD_STATUS_MASK   __BITS(7,0)
#define EHCI_SITD_ACTIVE        0x00000080
#define EHCI_SITD_ERR           0x00000040
#define EHCI_SITD_BUFERR        0x00000020
#define EHCI_SITD_BABBLE        0x00000010
#define EHCI_SITD_XACTERR       0x00000008
#define EHCI_SITD_MISS          0x00000004
#define EHCI_SITD_SPLITXSTATE   0x00000002

#define EHCI_SITD_BUFFERS       2

       volatile uint32_t       sitd_buffer[EHCI_SITD_BUFFERS];
#define EHCI_SITD_SET_BPTR(x)   ((x) & 0xfffff000)
#define EHCI_SITD_SET_OFFS(x)   ((x) & 0xfff)
#define EHCI_SITD_TP_MASK       __BITS(4,3)
#define EHCI_SITD_TCOUNT_MASK   __BITS(2,0)

       volatile ehci_link_t    sitd_back;
       volatile uint32_t       sitd_buffer_hi[EHCI_SITD_BUFFERS];
} ehci_sitd_t;

/* Queue Element Transfer Descriptor */
#define EHCI_QTD_NBUFFERS       5
#define EHCI_QTD_MAXTRANSFER    (EHCI_QTD_NBUFFERS * EHCI_PAGE_SIZE)
#define EHCI_QTD_ALIGN 32
typedef struct ehci_qtd_t {
       volatile ehci_link_t    qtd_next;
       volatile ehci_link_t    qtd_altnext;
       volatile uint32_t       qtd_status;
#define EHCI_QTD_STATUS_MASK    __BITS(7,0)
#define EHCI_QTD_GET_STATUS(x)  __SHIFTOUT((x), EHCI_QTD_STATUS_MASK)
#define EHCI_QTD_SET_STATUS(x)  __SHIFTIN((x), EHCI_QTD_STATUS_MASK)
#define  EHCI_QTD_ACTIVE        0x80
#define  EHCI_QTD_HALTED        0x40
#define  EHCI_QTD_BUFERR        0x20
#define  EHCI_QTD_BABBLE        0x10
#define  EHCI_QTD_XACTERR       0x08
#define  EHCI_QTD_MISSEDMICRO   0x04
#define  EHCI_QTD_SPLITXSTATE   0x02
#define  EHCI_QTD_PINGSTATE     0x01
#define  EHCI_QTD_STATERRS      0x3c
#define EHCI_QTD_PID_MASK       __BITS(9,8)
#define EHCI_QTD_GET_PID(x)     __SHIFTOUT((x), EHCI_QTD_PID_MASK)
#define EHCI_QTD_SET_PID(x)     __SHIFTIN((x), EHCI_QTD_PID_MASK)
#define  EHCI_QTD_PID_OUT       0x0
#define  EHCI_QTD_PID_IN        0x1
#define  EHCI_QTD_PID_SETUP     0x2
#define EHCI_QTD_CERR_MASK      __BITS(11,10)
#define EHCI_QTD_GET_CERR(x)    __SHIFTOUT((x), EHCI_QTD_CERR_MASK)
#define EHCI_QTD_SET_CERR(x)    __SHIFTIN((x), EHCI_QTD_CERR_MASK)
#define EHCI_QTD_C_PAGE_MASK    __BITS(14,12)
#define EHCI_QTD_GET_C_PAGE(x)  __SHIFTOUT((x), EHCI_QTD_C_PAGE_MASK)
#define EHCI_QTD_SET_C_PAGE(x)  __SHIFTIN((x), EHCI_QTD_C_PAGE_MASK)
#define EHCI_QTD_IOC            __BIT(15)
#define EHCI_QTD_GET_IOC(x)     __SHIFTOUT((x), EHCI_QTD_IOC)
#define EHCI_QTD_BYTES_MASK     __BITS(30,16)
#define EHCI_QTD_GET_BYTES(x)   __SHIFTOUT((x), EHCI_QTD_BYTES_MASK)
#define EHCI_QTD_SET_BYTES(x)   __SHIFTIN((x), EHCI_QTD_BYTES_MASK)
#define EHCI_QTD_TOGGLE_MASK    __BIT(31)
#define EHCI_QTD_GET_TOGGLE(x)  __SHIFTOUT((x), EHCI_QTD_TOGGLE_MASK)
#define EHCI_QTD_SET_TOGGLE(x)  __SHIFTIN((x), EHCI_QTD_TOGGLE_MASK)
       volatile ehci_physaddr_t qtd_buffer[EHCI_QTD_NBUFFERS];
       volatile ehci_physaddr_t qtd_buffer_hi[EHCI_QTD_NBUFFERS];
} ehci_qtd_t;
#define EHCI_QTD_ALLOC_ALIGN    MAX(EHCI_QTD_ALIGN, CACHE_LINE_SIZE)
#define EHCI_QTD_SIZE           (roundup(sizeof(ehci_qtd_t), EHCI_QTD_ALLOC_ALIGN))
#define EHCI_QTD_CHUNK          (EHCI_PAGE_SIZE / EHCI_QTD_SIZE)

/* Queue Head */
#define EHCI_QH_ALIGN 32
typedef struct ehci_qh_t {
       volatile ehci_link_t    qh_link;
       volatile uint32_t       qh_endp;
#define EHCI_QH_ADDR_MASK       __BITS(6,0)     /* endpoint addr */
#define EHCI_QH_GET_ADDR(x)     __SHIFTOUT((x), EHCI_QH_ADDR_MASK)
#define EHCI_QH_SET_ADDR(x)     __SHIFTIN((x), EHCI_QH_ADDR_MASK)
#define EHCI_QH_INACT           __BIT(7)        /* inactivate on next */
#define EHCI_QH_GET_INACT(x)    __SHIFTOUT((x), EHCI_QH_INACT)
#define EHCI_QH_ENDPT_MASK      __BITS(11,8)     /* endpoint no */
#define EHCI_QH_GET_ENDPT(x)    __SHIFTOUT((x), EHCI_QH_ENDPT_MASK)
#define EHCI_QH_SET_ENDPT(x)    __SHIFTIN((x), EHCI_QH_ENDPT_MASK)
#define EHCI_QH_EPS_MASK        __BITS(13,12)   /* endpoint speed */
#define EHCI_QH_GET_EPS(x)      __SHIFTOUT((x), EHCI_QH_EPS_MASK)
#define EHCI_QH_SET_EPS(x)      __SHIFTIN((x), EHCI_QH_EPS_MASK)
#define  EHCI_QH_SPEED_FULL     0x0
#define  EHCI_QH_SPEED_LOW      0x1
#define  EHCI_QH_SPEED_HIGH     0x2
#define EHCI_QH_DTC             __BIT(14)        /* data toggle control */
#define EHCI_QH_GET_DTC(x)      __SHIFTOUT((x), EHCI_QH_DTC)
#define EHCI_QH_HRECL           __BIT(15)       /* head of reclamation */
#define EHCI_QH_GET_HRECL(x)    __SHIFTOUT((x), EHCI_QH_HRECL)
#define EHCI_QH_MPL_MASK        __BITS(26,16)   /* max packet len */
#define EHCI_QH_GET_MPL(x)      __SHIFTOUT((x), EHCI_QH_MPL_MASK)
#define EHCI_QH_SET_MPL(x)      __SHIFTIN((x), EHCI_QH_MPL_MASK)
#define EHCI_QH_CTL             __BIT(27)       /* control endpoint */
#define EHCI_QH_GET_CTL(x)      __SHIFTOUT((x), EHCI_QH_CTL)
#define EHCI_QH_NRL_MASK        __BITS(31,28)   /* NAK reload */
#define EHCI_QH_GET_NRL(x)      __SHIFTOUT((x), EHCI_QH_NRL_MASK)
#define EHCI_QH_SET_NRL(x)      __SHIFTIN((x), EHCI_QH_NRL_MASK)
       volatile uint32_t       qh_endphub;
#define EHCI_QH_SMASK_MASK      __BITS(7,0)      /* intr sched mask */
#define EHCI_QH_GET_SMASK(x)    __SHIFTOUT((x), EHCI_QH_SMASK_MASK)
#define EHCI_QH_SET_SMASK(x)    __SHIFTIN((x), EHCI_QH_SMASK_MASK)
#define EHCI_QH_CMASK_MASK      __BITS(15,8)     /* split completion mask */
#define EHCI_QH_GET_CMASK(x)    __SHIFTOUT((x), EHCI_QH_CMASK_MASK)
#define EHCI_QH_SET_CMASK(x)    __SHIFTIN((x), EHCI_QH_CMASK_MASK)
#define EHCI_QH_HUBA_MASK       __BITS(22,16)   /* hub address */
#define EHCI_QH_GET_HUBA(x)     __SHIFTOUT((x), EHCI_QH_HUBA_MASK)
#define EHCI_QH_SET_HUBA(x)     __SHIFTIN((x), EHCI_QH_HUBA_MASK)
#define EHCI_QH_PORT_MASK       __BITS(29,23)    /* hub port */
#define EHCI_QH_GET_PORT(x)     __SHIFTOUT((x), EHCI_QH_PORT_MASK)
#define EHCI_QH_SET_PORT(x)     __SHIFTIN((x), EHCI_QH_PORT_MASK)
#define EHCI_QH_MULTI_MASK      __BITS(31,30)   /* pipe multiplier */
#define EHCI_QH_GET_MULT(x)     __SHIFTOUT((x), EHCI_QH_MULTI_MASK)
#define EHCI_QH_SET_MULT(x)     __SHIFTIN((x), EHCI_QH_MULTI_MASK)
       volatile ehci_link_t    qh_curqtd;
       ehci_qtd_t              qh_qtd;
} ehci_qh_t;
#define EHCI_QH_ALLOC_ALIGN     MAX(EHCI_QH_ALIGN, CACHE_LINE_SIZE)
#define EHCI_QH_SIZE            (roundup(sizeof(ehci_qh_t), EHCI_QH_ALLOC_ALIGN))
#define EHCI_QH_CHUNK           (EHCI_PAGE_SIZE / EHCI_QH_SIZE)

/* Periodic Frame Span Traversal Node */
#define EHCI_FSTN_ALIGN 32
typedef struct ehci_fstn_t {
       volatile ehci_link_t    fstn_link;
       volatile ehci_link_t    fstn_back;
} ehci_fstn_t;

/* Debug Port */
#define PCI_CAP_DEBUGPORT_OFFSET __BITS(28,16)
#define PCI_CAP_DEBUGPORT_BAR   __BITS(31,29)
/* Debug Port Registers, offset into DEBUGPORT_BAR at DEBUGPORT_OFFSET */
#define EHCI_DEBUG_SC           0x00
/* Status/Control Register */
#define  EHCI_DSC_DATA_LENGTH   __BITS(3,0)
#define  EHCI_DSC_WRITE         __BIT(4)
#define  EHCI_DSC_GO            __BIT(5)
#define  EHCI_DSC_ERROR         __BIT(6)
#define  EHCI_DSC_EXCEPTION     __BITS(9,7)
#define   EHCI_DSC_EXCEPTION_NONE       0
#define   EHCI_DSC_EXCEPTION_XACT       1
#define   EHCI_DSC_EXCEPTION_HW         2
#define  EHCI_DSC_IN_USE        __BIT(10)
#define  EHCI_DSC_DONE          __BIT(16)
#define  EHCI_DSC_ENABLED       __BIT(28)
#define  EHCI_DSC_OWNER         __BIT(30)
#define EHCI_DEBUG_UPR          0x04
/* USB PIDs Register */
#define  EHCI_DPR_TOKEN         __BITS(7,0)
#define  EHCI_DPR_SEND          __BITS(15,8)
#define  EHCI_DPR_RECEIVED      __BITS(23,16)
/* Data Registers */
#define EHCI_DEBUG_DATA0123     0x08
#define EHCI_DEBUG_DATA4567     0x0c
#define EHCI_DEBUG_DAR          0x10
/* Device Address Register */
#define  EHCI_DAR_ENDPOINT      __BITS(3,0)
#define  EHCI_DAR_ADDRESS       __BITS(14,8)

#endif /* _DEV_USB_EHCIREG_H_ */

You are viewing proxied material from ftp.icm.edu.pl. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.