ohcireg.h Source File

Back to the index.

ohcireg.h
Go to the documentation of this file.
1 /* $NetBSD: ohcireg.h,v 1.19 2002/07/11 21:14:27 augustss Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/ohcireg.h,v 1.8 1999/11/17 22:33:40 n_hibma Exp $ */
3 
4 #ifndef OHCIREG_H
5 #define OHCIREG_H
6 
7 /*
8  * Copyright (c) 1998 The NetBSD Foundation, Inc.
9  * All rights reserved.
10  *
11  * This code is derived from software contributed to The NetBSD Foundation
12  * by Lennart Augustsson (lennart@augustsson.net) at
13  * Carlstedt Research & Technology.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  * notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in the
22  * documentation and/or other materials provided with the distribution.
23  * 3. All advertising materials mentioning features or use of this software
24  * must display the following acknowledgement:
25  * This product includes software developed by the NetBSD
26  * Foundation, Inc. and its contributors.
27  * 4. Neither the name of The NetBSD Foundation nor the names of its
28  * contributors may be used to endorse or promote products derived
29  * from this software without specific prior written permission.
30  *
31  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
32  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
33  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
34  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
35  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
39  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGE.
42  */
43 
44 /*** PCI config registers ***/
45 
46 #define PCI_CBMEM 0x10 /* configuration base memory */
47 
48 #define PCI_INTERFACE_OHCI 0x10
49 
50 /*** OHCI registers */
51 
52 #define OHCI_REVISION 0x00 /* OHCI revision # */
53 #define OHCI_REV_LO(rev) ((rev)&0xf)
54 #define OHCI_REV_HI(rev) (((rev)>>4)&0xf)
55 #define OHCI_REV_LEGACY(rev) ((rev) & 0x100)
56 
57 #define OHCI_CONTROL 0x04
58 #define OHCI_CBSR_MASK 0x00000003 /* Control/Bulk Service Ratio */
59 #define OHCI_RATIO_1_1 0x00000000
60 #define OHCI_RATIO_1_2 0x00000001
61 #define OHCI_RATIO_1_3 0x00000002
62 #define OHCI_RATIO_1_4 0x00000003
63 #define OHCI_PLE 0x00000004 /* Periodic List Enable */
64 #define OHCI_IE 0x00000008 /* Isochronous Enable */
65 #define OHCI_CLE 0x00000010 /* Control List Enable */
66 #define OHCI_BLE 0x00000020 /* Bulk List Enable */
67 #define OHCI_HCFS_MASK 0x000000c0 /* HostControllerFunctionalState */
68 #define OHCI_HCFS_RESET 0x00000000
69 #define OHCI_HCFS_RESUME 0x00000040
70 #define OHCI_HCFS_OPERATIONAL 0x00000080
71 #define OHCI_HCFS_SUSPEND 0x000000c0
72 #define OHCI_IR 0x00000100 /* Interrupt Routing */
73 #define OHCI_RWC 0x00000200 /* Remote Wakeup Connected */
74 #define OHCI_RWE 0x00000400 /* Remote Wakeup Enabled */
75 #define OHCI_COMMAND_STATUS 0x08
76 #define OHCI_HCR 0x00000001 /* Host Controller Reset */
77 #define OHCI_CLF 0x00000002 /* Control List Filled */
78 #define OHCI_BLF 0x00000004 /* Bulk List Filled */
79 #define OHCI_OCR 0x00000008 /* Ownership Change Request */
80 #define OHCI_SOC_MASK 0x00030000 /* Scheduling Overrun Count */
81 #define OHCI_INTERRUPT_STATUS 0x0c
82 #define OHCI_SO 0x00000001 /* Scheduling Overrun */
83 #define OHCI_WDH 0x00000002 /* Writeback Done Head */
84 #define OHCI_SF 0x00000004 /* Start of Frame */
85 #define OHCI_RD 0x00000008 /* Resume Detected */
86 #define OHCI_UE 0x00000010 /* Unrecoverable Error */
87 #define OHCI_FNO 0x00000020 /* Frame Number Overflow */
88 #define OHCI_RHSC 0x00000040 /* Root Hub Status Change */
89 #define OHCI_OC 0x40000000 /* Ownership Change */
90 #define OHCI_MIE 0x80000000 /* Master Interrupt Enable */
91 #define OHCI_INTERRUPT_ENABLE 0x10
92 #define OHCI_INTERRUPT_DISABLE 0x14
93 #define OHCI_HCCA 0x18
94 #define OHCI_PERIOD_CURRENT_ED 0x1c
95 #define OHCI_CONTROL_HEAD_ED 0x20
96 #define OHCI_CONTROL_CURRENT_ED 0x24
97 #define OHCI_BULK_HEAD_ED 0x28
98 #define OHCI_BULK_CURRENT_ED 0x2c
99 #define OHCI_DONE_HEAD 0x30
100 #define OHCI_FM_INTERVAL 0x34
101 #define OHCI_GET_IVAL(s) ((s) & 0x3fff)
102 #define OHCI_GET_FSMPS(s) (((s) >> 16) & 0x7fff)
103 #define OHCI_FIT 0x80000000
104 #define OHCI_FM_REMAINING 0x38
105 #define OHCI_FM_NUMBER 0x3c
106 #define OHCI_PERIODIC_START 0x40
107 #define OHCI_LS_THRESHOLD 0x44
108 #define OHCI_RH_DESCRIPTOR_A 0x48
109 #define OHCI_GET_NDP(s) ((s) & 0xff)
110 #define OHCI_PSM 0x0100 /* Power Switching Mode */
111 #define OHCI_NPS 0x0200 /* No Power Switching */
112 #define OHCI_DT 0x0400 /* Device Type */
113 #define OHCI_OCPM 0x0800 /* Overcurrent Protection Mode */
114 #define OHCI_NOCP 0x1000 /* No Overcurrent Protection */
115 #define OHCI_GET_POTPGT(s) ((s) >> 24)
116 #define OHCI_RH_DESCRIPTOR_B 0x4c
117 #define OHCI_RH_STATUS 0x50
118 #define OHCI_LPS 0x00000001 /* Local Power Status */
119 #define OHCI_OCI 0x00000002 /* OverCurrent Indicator */
120 #define OHCI_DRWE 0x00008000 /* Device Remote Wakeup Enable */
121 #define OHCI_LPSC 0x00010000 /* Local Power Status Change */
122 #define OHCI_CCIC 0x00020000 /* OverCurrent Indicator Change */
123 #define OHCI_CRWE 0x80000000 /* Clear Remote Wakeup Enable */
124 #define OHCI_RH_PORT_STATUS(n) (0x50 + (n)*4) /* 1 based indexing */
125 
126 #define OHCI_LES (OHCI_PLE | OHCI_IE | OHCI_CLE | OHCI_BLE)
127 #define OHCI_ALL_INTRS (OHCI_SO | OHCI_WDH | OHCI_SF | OHCI_RD | OHCI_UE | \
128  OHCI_FNO | OHCI_RHSC | OHCI_OC)
129 #define OHCI_NORMAL_INTRS (OHCI_SO | OHCI_WDH | OHCI_RD | OHCI_UE | OHCI_RHSC)
130 
131 #define OHCI_FSMPS(i) (((i-210)*6/7) << 16)
132 #define OHCI_PERIODIC(i) ((i)*9/10)
133 
134 typedef u_int32_t ohci_physaddr_t;
135 
136 #define OHCI_NO_INTRS 32
137 struct ohci_hcca {
139  u_int32_t hcca_frame_number;
141 #define OHCI_DONE_INTRS 1
142 };
143 #define OHCI_HCCA_SIZE 256
144 #define OHCI_HCCA_ALIGN 256
145 
146 #define OHCI_PAGE_SIZE 0x1000
147 #define OHCI_PAGE(x) ((x) &~ 0xfff)
148 #define OHCI_PAGE_OFFSET(x) ((x) & 0xfff)
149 
150 typedef struct {
151  u_int32_t ed_flags;
152 #define OHCI_ED_GET_FA(s) ((s) & 0x7f)
153 #define OHCI_ED_ADDRMASK 0x0000007f
154 #define OHCI_ED_SET_FA(s) (s)
155 #define OHCI_ED_GET_EN(s) (((s) >> 7) & 0xf)
156 #define OHCI_ED_SET_EN(s) ((s) << 7)
157 #define OHCI_ED_DIR_MASK 0x00001800
158 #define OHCI_ED_DIR_TD 0x00000000
159 #define OHCI_ED_DIR_OUT 0x00000800
160 #define OHCI_ED_DIR_IN 0x00001000
161 #define OHCI_ED_SPEED 0x00002000
162 #define OHCI_ED_SKIP 0x00004000
163 #define OHCI_ED_FORMAT_GEN 0x00000000
164 #define OHCI_ED_FORMAT_ISO 0x00008000
165 #define OHCI_ED_GET_MAXP(s) (((s) >> 16) & 0x07ff)
166 #define OHCI_ED_SET_MAXP(s) ((s) << 16)
167 #define OHCI_ED_MAXPMASK (0x7ff << 16)
170 #define OHCI_HALTED 0x00000001
171 #define OHCI_TOGGLECARRY 0x00000002
172 #define OHCI_HEADMASK 0xfffffffc
174 } ohci_ed_t;
175 /* #define OHCI_ED_SIZE 16 */
176 #define OHCI_ED_ALIGN 16
177 
178 typedef struct {
179  u_int32_t td_flags;
180 #define OHCI_TD_R 0x00040000 /* Buffer Rounding */
181 #define OHCI_TD_DP_MASK 0x00180000 /* Direction / PID */
182 #define OHCI_TD_SETUP 0x00000000
183 #define OHCI_TD_OUT 0x00080000
184 #define OHCI_TD_IN 0x00100000
185 #define OHCI_TD_GET_DI(x) (((x) >> 21) & 7) /* Delay Interrupt */
186 #define OHCI_TD_SET_DI(x) ((x) << 21)
187 #define OHCI_TD_NOINTR 0x00e00000
188 #define OHCI_TD_INTR_MASK 0x00e00000
189 #define OHCI_TD_TOGGLE_CARRY 0x00000000
190 #define OHCI_TD_TOGGLE_0 0x02000000
191 #define OHCI_TD_TOGGLE_1 0x03000000
192 #define OHCI_TD_TOGGLE_MASK 0x03000000
193 #define OHCI_TD_GET_EC(x) (((x) >> 26) & 3) /* Error Count */
194 #define OHCI_TD_GET_CC(x) ((x) >> 28) /* Condition Code */
195 #define OHCI_TD_NOCC 0xf0000000
196  ohci_physaddr_t td_cbp; /* Current Buffer Pointer */
197  ohci_physaddr_t td_nexttd; /* Next TD */
198  ohci_physaddr_t td_be; /* Buffer End */
199 } ohci_td_t;
200 /* #define OHCI_TD_SIZE 16 */
201 #define OHCI_TD_ALIGN 16
202 
203 #define OHCI_ITD_NOFFSET 8
204 typedef struct {
205  u_int32_t itd_flags;
206 #define OHCI_ITD_GET_SF(x) ((x) & 0x0000ffff)
207 #define OHCI_ITD_SET_SF(x) ((x) & 0xffff)
208 #define OHCI_ITD_GET_DI(x) (((x) >> 21) & 7) /* Delay Interrupt */
209 #define OHCI_ITD_SET_DI(x) ((x) << 21)
210 #define OHCI_ITD_NOINTR 0x00e00000
211 #define OHCI_ITD_GET_FC(x) ((((x) >> 24) & 7)+1) /* Frame Count */
212 #define OHCI_ITD_SET_FC(x) (((x)-1) << 24)
213 #define OHCI_ITD_GET_CC(x) ((x) >> 28) /* Condition Code */
214 #define OHCI_ITD_NOCC 0xf0000000
215  ohci_physaddr_t itd_bp0; /* Buffer Page 0 */
216  ohci_physaddr_t itd_nextitd; /* Next ITD */
217  ohci_physaddr_t itd_be; /* Buffer End */
218  u_int16_t itd_offset[OHCI_ITD_NOFFSET]; /* Buffer offsets */
219 #define itd_pswn itd_offset /* Packet Status Word*/
220 #define OHCI_ITD_PAGE_SELECT 0x00001000
221 #define OHCI_ITD_MK_OFFS(len) (0xe000 | ((len) & 0x1fff))
222 #define OHCI_ITD_PSW_LENGTH(x) ((x) & 0xfff) /* Transfer length */
223 #define OHCI_ITD_PSW_GET_CC(x) ((x) >> 12) /* Condition Code */
224 } ohci_itd_t;
225 /* #define OHCI_ITD_SIZE 32 */
226 #define OHCI_ITD_ALIGN 32
227 
228 
229 #define OHCI_CC_NO_ERROR 0
230 #define OHCI_CC_CRC 1
231 #define OHCI_CC_BIT_STUFFING 2
232 #define OHCI_CC_DATA_TOGGLE_MISMATCH 3
233 #define OHCI_CC_STALL 4
234 #define OHCI_CC_DEVICE_NOT_RESPONDING 5
235 #define OHCI_CC_PID_CHECK_FAILURE 6
236 #define OHCI_CC_UNEXPECTED_PID 7
237 #define OHCI_CC_DATA_OVERRUN 8
238 #define OHCI_CC_DATA_UNDERRUN 9
239 #define OHCI_CC_BUFFER_OVERRUN 12
240 #define OHCI_CC_BUFFER_UNDERRUN 13
241 #define OHCI_CC_NOT_ACCESSED 15
242 
243 /* Some delay needed when changing certain registers. */
244 #define OHCI_ENABLE_POWER_DELAY 5
245 #define OHCI_READ_DESC_DELAY 5
246 
247 #endif /* OHCIREG_H */
OHCI_NO_INTRS
#define OHCI_NO_INTRS
Definition: ohcireg.h:136
ohci_ed_t::ed_headp
ohci_physaddr_t ed_headp
Definition: ohcireg.h:169
OHCI_ITD_NOFFSET
#define OHCI_ITD_NOFFSET
Definition: ohcireg.h:203
ohci_td_t
Definition: ohcireg.h:178
ohci_itd_t::itd_flags
u_int32_t itd_flags
Definition: ohcireg.h:205
ohci_itd_t::itd_be
ohci_physaddr_t itd_be
Definition: ohcireg.h:217
ohci_ed_t
Definition: ohcireg.h:150
ohci_hcca::hcca_interrupt_table
ohci_physaddr_t hcca_interrupt_table[OHCI_NO_INTRS]
Definition: ohcireg.h:138
ohci_td_t::td_be
ohci_physaddr_t td_be
Definition: ohcireg.h:198
ohci_hcca
Definition: ohcireg.h:137
ohci_itd_t::itd_nextitd
ohci_physaddr_t itd_nextitd
Definition: ohcireg.h:216
ohci_itd_t
Definition: ohcireg.h:204
ohci_td_t::td_nexttd
ohci_physaddr_t td_nexttd
Definition: ohcireg.h:197
ohci_ed_t::ed_flags
u_int32_t ed_flags
Definition: ohcireg.h:151
ohci_itd_t::itd_bp0
ohci_physaddr_t itd_bp0
Definition: ohcireg.h:215
ohci_hcca::hcca_done_head
ohci_physaddr_t hcca_done_head
Definition: ohcireg.h:140
ohci_ed_t::ed_nexted
ohci_physaddr_t ed_nexted
Definition: ohcireg.h:173
ohci_td_t::td_flags
u_int32_t td_flags
Definition: ohcireg.h:179
ohci_ed_t::ed_tailp
ohci_physaddr_t ed_tailp
Definition: ohcireg.h:168
ohci_hcca::hcca_frame_number
u_int32_t hcca_frame_number
Definition: ohcireg.h:139
ohci_physaddr_t
u_int32_t ohci_physaddr_t
Definition: ohcireg.h:134
ohci_td_t::td_cbp
ohci_physaddr_t td_cbp
Definition: ohcireg.h:196

Generated on Tue Mar 24 2020 14:04:48 for GXemul by doxygen 1.8.17