xref: /dragonfly/sys/bus/u4b/controller/ohcireg.h (revision 56fe6b68029ecfe026662660f3193f380d822be3)
1 /* $FreeBSD$ */
2 /*-
3  * Copyright (c) 1998 The NetBSD Foundation, Inc.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to The NetBSD Foundation
7  * by Lennart Augustsson (lennart@augustsson.net) at
8  * Carlstedt Research & Technology.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. 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 distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef _OHCIREG_H_
33 #define   _OHCIREG_H_
34 
35 /* PCI config registers  */
36 #define   PCI_CBMEM           0x10      /* configuration base memory */
37 #define   PCI_INTERFACE_OHCI  0x10
38 
39 /* OHCI registers */
40 #define   OHCI_REVISION                 0x00      /* OHCI revision */
41 #define   OHCI_REV_LO(rev)    ((rev) & 0xf)
42 #define   OHCI_REV_HI(rev)    (((rev)>>4) & 0xf)
43 #define   OHCI_REV_LEGACY(rev)          ((rev) & 0x100)
44 #define   OHCI_CONTROL                  0x04
45 #define   OHCI_CBSR_MASK                0x00000003          /* Control/Bulk Service Ratio */
46 #define   OHCI_RATIO_1_1                0x00000000
47 #define   OHCI_RATIO_1_2                0x00000001
48 #define   OHCI_RATIO_1_3                0x00000002
49 #define   OHCI_RATIO_1_4                0x00000003
50 #define   OHCI_PLE            0x00000004          /* Periodic List Enable */
51 #define   OHCI_IE                       0x00000008          /* Isochronous Enable */
52 #define   OHCI_CLE            0x00000010          /* Control List Enable */
53 #define   OHCI_BLE            0x00000020          /* Bulk List Enable */
54 #define   OHCI_HCFS_MASK                0x000000c0          /* HostControllerFunctionalStat
55                                                              * e */
56 #define   OHCI_HCFS_RESET               0x00000000
57 #define   OHCI_HCFS_RESUME    0x00000040
58 #define   OHCI_HCFS_OPERATIONAL         0x00000080
59 #define   OHCI_HCFS_SUSPEND   0x000000c0
60 #define   OHCI_IR                       0x00000100          /* Interrupt Routing */
61 #define   OHCI_RWC            0x00000200          /* Remote Wakeup Connected */
62 #define   OHCI_RWE            0x00000400          /* Remote Wakeup Enabled */
63 #define   OHCI_COMMAND_STATUS 0x08
64 #define   OHCI_HCR            0x00000001          /* Host Controller Reset */
65 #define   OHCI_CLF            0x00000002          /* Control List Filled */
66 #define   OHCI_BLF            0x00000004          /* Bulk List Filled */
67 #define   OHCI_OCR            0x00000008          /* Ownership Change Request */
68 #define   OHCI_SOC_MASK                 0x00030000          /* Scheduling Overrun Count */
69 #define   OHCI_INTERRUPT_STATUS         0x0c
70 #define   OHCI_SO                       0x00000001          /* Scheduling Overrun */
71 #define   OHCI_WDH            0x00000002          /* Writeback Done Head */
72 #define   OHCI_SF                       0x00000004          /* Start of Frame */
73 #define   OHCI_RD                       0x00000008          /* Resume Detected */
74 #define   OHCI_UE                       0x00000010          /* Unrecoverable Error */
75 #define   OHCI_FNO            0x00000020          /* Frame Number Overflow */
76 #define   OHCI_RHSC           0x00000040          /* Root Hub Status Change */
77 #define   OHCI_OC                       0x40000000          /* Ownership Change */
78 #define   OHCI_MIE            0x80000000          /* Master Interrupt Enable */
79 #define   OHCI_INTERRUPT_ENABLE         0x10
80 #define   OHCI_INTERRUPT_DISABLE        0x14
81 #define   OHCI_HCCA           0x18
82 #define   OHCI_PERIOD_CURRENT_ED        0x1c
83 #define   OHCI_CONTROL_HEAD_ED          0x20
84 #define   OHCI_CONTROL_CURRENT_ED       0x24
85 #define   OHCI_BULK_HEAD_ED   0x28
86 #define   OHCI_BULK_CURRENT_ED          0x2c
87 #define   OHCI_DONE_HEAD                0x30
88 #define   OHCI_FM_INTERVAL    0x34
89 #define   OHCI_GET_IVAL(s)    ((s) & 0x3fff)
90 #define   OHCI_GET_FSMPS(s)   (((s) >> 16) & 0x7fff)
91 #define   OHCI_FIT            0x80000000
92 #define   OHCI_FM_REMAINING   0x38
93 #define   OHCI_FM_NUMBER                0x3c
94 #define   OHCI_PERIODIC_START 0x40
95 #define   OHCI_LS_THRESHOLD   0x44
96 #define   OHCI_RH_DESCRIPTOR_A          0x48
97 #define   OHCI_GET_NDP(s)               ((s) & 0xff)
98 #define   OHCI_PSM            0x0100    /* Power Switching Mode */
99 #define   OHCI_NPS            0x0200    /* No Power Switching */
100 #define   OHCI_DT                       0x0400    /* Device Type */
101 #define   OHCI_OCPM           0x0800    /* Overcurrent Protection Mode */
102 #define   OHCI_NOCP           0x1000    /* No Overcurrent Protection */
103 #define   OHCI_GET_POTPGT(s)  ((s) >> 24)
104 #define   OHCI_RH_DESCRIPTOR_B          0x4c
105 #define   OHCI_RH_STATUS                0x50
106 #define   OHCI_LPS            0x00000001          /* Local Power Status */
107 #define   OHCI_OCI            0x00000002          /* OverCurrent Indicator */
108 #define   OHCI_DRWE           0x00008000          /* Device Remote Wakeup Enable */
109 #define   OHCI_LPSC           0x00010000          /* Local Power Status Change */
110 #define   OHCI_CCIC           0x00020000          /* OverCurrent Indicator
111                                                              * Change */
112 #define   OHCI_CRWE           0x80000000          /* Clear Remote Wakeup Enable */
113 #define   OHCI_RH_PORT_STATUS(n)        (0x50 + ((n)*4))    /* 1 based indexing */
114 
115 #define   OHCI_LES            (OHCI_PLE | OHCI_IE | OHCI_CLE | OHCI_BLE)
116 #define   OHCI_ALL_INTRS                (OHCI_SO | OHCI_WDH | OHCI_SF |                   \
117                                         OHCI_RD | OHCI_UE | OHCI_FNO |                    \
118                                         OHCI_RHSC | OHCI_OC)
119 #define   OHCI_NORMAL_INTRS   (OHCI_WDH | OHCI_RD | OHCI_UE | OHCI_RHSC)
120 
121 #define   OHCI_FSMPS(i)                 (((i-210)*6/7) << 16)
122 #define   OHCI_PERIODIC(i)    ((i)*9/10)
123 
124 #endif    /* _OHCIREG_H_ */
125