xref: /openbsd/sys/dev/pci/pccbbreg.h (revision b66b5efe)
1 /*	$OpenBSD: pccbbreg.h,v 1.4 2004/07/14 21:54:19 mickey Exp $ */
2 /*	$NetBSD: pccbbreg.h,v 1.5 2000/06/07 09:02:47 haya Exp $	*/
3 /*
4  * Copyright (c) 1999 HAYAKAWA Koichi.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *	This product includes software developed by HAYAKAWA Koichi.
17  * 4. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 
33 #ifndef _DEV_PCI_PCCBBREG_H_
34 #define	_DEV_PCI_PCCBBREG_H_
35 
36 
37 
38 
39 #define PCI_SOCKBASE 0x10	/* Socket Base Address Register */
40 #define PCI_BUSNUM   0x18	/* latency timer, Subordinate bus number */
41 #define PCI_BCR_INTR 0x3C	/* intr line, intr pin, bridge control regs */
42 #define PCI_LEGACY 0x44		/* legacy IO register address (32 bits) */
43 #define PCI_SYSCTRL 0x80	/* System control */
44 #define PCI_CBCTRL 0x90		/* Retry status, Card ctrl, Device ctrl */
45 
46 #define PCI_CLASS_INTERFACE_MASK  0xffffff00
47 #define PCI_CLASS_INTERFACE_YENTA 0x06070000
48 
49 #define CB_SOCKET_EVENT 0x00	/* offset of cardbus socket event reg */
50 #define CB_SOCKET_MASK  0x04	/* offset of cardbus socket mask register */
51 #define CB_SOCKET_STAT  0x08	/* offset of cardbus socket present-state */
52 #define CB_SOCKET_FORCE 0x0c	/* offset of cardbus socket force event */
53 #define CB_SOCKET_CTRL  0x10	/* offset of cardbus socket control reg */
54 
55 #define PCCBB_SOCKEVENT_BITS "\020\001CSTS\002CD1\003CD2\004PWR"
56 #define PCCBB_SOCKSTATE_BITS "\020\001CSTS\002CD1\003CD3\004PWR" \
57           "\00516BIT\006CB\007CINT\010NOTA\011DLOST\012BADVCC" \
58           "\0135v\0143v\015Xv\016Yv\0355vS\0363vS\037XvS\040YvS"
59 
60 /* CardBus latency timer, Subordinate bus no, CardBus bus no and PCI bus no */
61 #define PCI_CB_LSCP_REG  0x18
62 /* CardBus memory and io windows */
63 #define PCI_CB_MEMBASE0  0x1c
64 #define PCI_CB_MEMLIMIT0 0x20
65 #define PCI_CB_MEMBASE1  0x24
66 #define PCI_CB_MEMLIMIT1 0x28
67 #define PCI_CB_IOBASE0   0x2c
68 #define PCI_CB_IOLIMIT0  0x30
69 #define PCI_CB_IOBASE1   0x34
70 #define PCI_CB_IOLIMIT1  0x38
71 
72 /* PCI_CB_LSCP_REG */
73 #define PCI_CB_LATENCY_SHIFT 24
74 #define PCI_CB_LATENCY_MASK  0xff
75 #define PCI_CB_LATENCY(x) (((x) >> PCI_CB_LATENCY_SHIFT) & PCI_CB_LATENCY_MASK)
76 
77 
78 
79 /* PCI_BCR_INTR bits for generic PCI-CardBus bridge */
80 #define CB_BCR_RESET_ENABLE	0x00400000
81 #define CB_BCR_INTR_IREQ_ENABLE 0x00800000
82 #define CB_BCR_PREFETCH_MEMWIN0 0x01000000
83 #define CB_BCR_PREFETCH_MEMWIN1 0x02000000
84 #define CB_BCR_WRITE_POST_ENABLE 0x04000000
85 
86 /* TI [14][245]xx */
87 #define PCI12XX_MMCTRL			0x84
88 
89 /* TI 12xx/14xx/15xx (except 1250, 1251, 1251B/1450) */
90 #define PCI12XX_MFUNC			0x8c
91 #define PCI12XX_MFUNC_PIN0		0x0000000f
92 #define PCI12XX_MFUNC_PIN0_INTA		0x02
93 #define PCI12XX_MFUNC_PIN1		0x000000f0
94 #define PCI12XX_MFUNC_PIN1_INTB		0x20
95 #define PCI12XX_MFUNC_PIN2		0x00000f00
96 #define PCI12XX_MFUNC_PIN3		0x0000f000
97 #define PCI12XX_MFUNC_PIN4		0x000f0000
98 #define PCI12XX_MFUNC_PIN5		0x00f00000
99 #define PCI12XX_MFUNC_PIN6		0x0f000000
100 
101 /*  PCI_CBCTRL bits for TI PCI113X */
102 #define PCI113X_CBCTRL_INT_SERIAL 0x040000
103 #define PCI113X_CBCTRL_INT_ISA    0x020000
104 #define PCI113X_CBCTRL_INT_MASK   0x060000
105 #define PCI113X_CBCTRL_RIENB 0x8000 /* Ring indicate output enable */
106 #define PCI113X_CBCTRL_ZVENAB 0x4000 /* ZV mode enable */
107 #define PCI113X_CBCTRL_PCI_IRQ_ENA 0x2000 /* PCI intr enable (funct and CSC) */
108 #define PCI113X_CBCTRL_PCI_INTR 0x1000 /* PCI functional intr req */
109 #define PCI113X_CBCTRL_PCI_CSC 0x0800 /* CSC intr route to PCI */
110 #define PCI113X_CBCTRL_PCI_CSC_D 0x0400 /* unknown */
111 #define PCI113X_CBCTRL_SPK_ENA 0x0200 /* Speaker enable */
112 #define PCI113X_CBCTRL_INTR_DET 0x0100 /* functional interrupt detect */
113 
114 /*  PCI_CBCTRL bits for TI PCI12XX */
115 #define PCI12XX_SYSCTRL_INTRTIE		0x20000000u
116 #define PCI12XX_SYSCTRL_VCCPROT		0x200000
117 #define PCI12XX_SYSCTRL_PWRSAVE		0x000040
118 #define PCI12XX_SYSCTRL_SUBSYSRW	0x000020
119 #define PCI12XX_SYSCTRL_CB_DPAR		0x000010
120 #define PCI12XX_SYSCTRL_CDMA_EN		0x000008
121 #define PCI12XX_SYSCTRL_KEEPCLK		0x000002
122 #define PCI12XX_SYSCTRL_RIMUX		0x000001
123 #define PCI12XX_CBCTRL_CSC		0x20000000u
124 #define PCI12XX_CBCTRL_ASYNC_CSC	0x01000000u
125 #define PCI12XX_CBCTRL_INT_SERIAL	0x060000
126 #define PCI12XX_CBCTRL_INT_PCI_SERIAL	0x040000
127 #define PCI12XX_CBCTRL_INT_ISA    0x020000
128 #define PCI12XX_CBCTRL_INT_PCI    0x000000
129 #define PCI12XX_CBCTRL_INT_MASK   0x060000
130 #define PCI12XX_CBCTRL_RIENB 0x8000 /* Ring indicate output enable */
131 #define PCI12XX_CBCTRL_ZVENAB 0x4000 /* ZV mode enable */
132 #define PCI12XX_CBCTRL_AUD2MUX 0x0400 /* unknown */
133 #define PCI12XX_CBCTRL_SPK_ENA 0x0200 /* Speaker enable */
134 #define PCI12XX_CBCTRL_INTR_DET 0x0100 /* functional interrupt detect */
135 
136 
137 /* PCI_BCR_INTR additional bit for Rx5C46[567] */
138 #define CB_BCRI_RL_3E0_ENA 0x08000000
139 #define CB_BCRI_RL_3E2_ENA 0x10000000
140 
141 /*
142  * Special resister definition for Toshiba ToPIC95/97
143  * These values are borrowed from pcmcia-cs/Linux.
144  */
145 #define TOPIC_SOCKET_CTRL  0x90
146 # define TOPIC_SOCKET_CTRL_SCR_IRQSEL 0x00000001 /* PCI intr */
147 
148 #define TOPIC_SLOT_CTRL    0xa0
149 # define TOPIC_SLOT_CTRL_SLOTON       0x00000080
150 # define TOPIC_SLOT_CTRL_SLOTEN       0x00000040
151 # define TOPIC_SLOT_CTRL_ID_LOCK      0x00000020
152 # define TOPIC_SLOT_CTRL_ID_WP        0x00000010
153 # define TOPIC_SLOT_CTRL_PORT_MASK    0x0000000c
154 # define TOPIC_SLOT_CTRL_PORT_SHIFT            2
155 # define TOPIC_SLOT_CTRL_OSF_MASK     0x00000003
156 # define TOPIC_SLOT_CTRL_OSF_SHIFT             0
157 
158 # define TOPIC_SLOT_CTRL_INTB         0x00002000
159 # define TOPIC_SLOT_CTRL_INTA         0x00001000
160 # define TOPIC_SLOT_CTRL_INT_MASK     0x00003000
161 # define TOPIC_SLOT_CTRL_CLOCK_MASK   0x00000c00
162 # define TOPIC_SLOT_CTRL_CLOCK_2      0x00000800 /* PCI Clock/2 */
163 # define TOPIC_SLOT_CTRL_CLOCK_1      0x00000400 /* PCI Clock */
164 # define TOPIC_SLOT_CTRL_CLOCK_0      0x00000000 /* no clock */
165 # define TOPIC97_SLOT_CTRL_STSIRQP    0x00000400 /* status change intr pulse */
166 # define TOPIC97_SLOT_CTRL_IRQP       0x00000200 /* function intr pulse */
167 # define TOPIC97_SLOT_CTRL_PCIINT     0x00000100 /* intr routing to PCI INT */
168 
169 # define TOPIC_SLOT_CTRL_CARDBUS      0x80000000
170 # define TOPIC_SLOT_CTRL_VS1          0x04000000
171 # define TOPIC_SLOT_CTRL_VS2          0x02000000
172 # define TOPIC_SLOT_CTRL_SWDETECT     0x01000000
173 
174 #define TOPIC_REG_CTRL     0x00a4
175 # define TOPIC_REG_CTRL_RESUME_RESET  0x80000000
176 # define TOPIC_REG_CTRL_REMOVE_RESET  0x40000000
177 # define TOPIC97_REG_CTRL_CLKRUN_ENA  0x20000000
178 # define TOPIC97_REG_CTRL_TESTMODE    0x10000000
179 # define TOPIC97_REG_CTRL_IOPLUP      0x08000000
180 # define TOPIC_REG_CTRL_BUFOFF_PWROFF 0x02000000
181 # define TOPIC_REG_CTRL_BUFOFF_SIGOFF 0x01000000
182 # define TOPIC97_REG_CTRL_CB_DEV_MASK 0x0000f800
183 # define TOPIC97_REG_CTRL_CB_DEV_SHIFT 11
184 # define TOPIC97_REG_CTRL_RI_DISABLE  0x00000004
185 # define TOPIC97_REG_CTRL_CAUDIO_OFF  0x00000002
186 # define TOPIC_REG_CTRL_CAUDIO_INVERT 0x00000001
187 
188 /*
189  * Additional (subset of) Topic100 registers from
190  * Toshiba datasheet (Draft Rev. 01.4) 98/10/07
191  */
192 
193 #define TOPIC100_PMCSR		0x84	/* Power mgmt ctrl/stat register */
194 # define TOPIC100_PMCSR_MASK		0x00000003
195 # define TOPIC100_PMCSR_D0		0x0
196 
197 /* socket event register (CB_SOCKET_EVENT) elements */
198 #define CB_SOCKET_EVENT_CSTS 0x01 /* CARDSTS event occurs */
199 #define CB_SOCKET_EVENT_CD   0x06 /* CD event occurs */
200 #define CB_SOCKET_EVENT_CD1  0x02 /* CD1 event occurs */
201 #define CB_SOCKET_EVENT_CD2  0x04 /* CD2 event occurs */
202 #define CB_SOCKET_EVENT_POWER 0x08 /* Power cycle event occurs */
203 
204 
205 /* socket mask register (CB_SOCKET_MASK) elements */
206 #define CB_SOCKET_MASK_CSTS 0x01 /* CARDSTS event mask */
207 #define CB_SOCKET_MASK_CD   0x06 /* CD event mask */
208 #define CB_SOCKET_MASK_POWER 0x08 /* Power cycle event mask */
209 
210 /* socket present-state register (CB_SOCKET_STAT) elements */
211 #define CB_SOCKET_STAT_CARDSTS 0x01 /* card status change bit */
212 #define CB_SOCKET_STAT_CD1 0x02     /* card detect 1 */
213 #define CB_SOCKET_STAT_CD2 0x04	    /* card detect 2 */
214 #define CB_SOCKET_STAT_CD  0x06	    /* card detect 1 and 2 */
215 #define CB_SOCKET_STAT_PWRCYCLE 0x08 /* power cycle */
216 #define CB_SOCKET_STAT_16BIT 0x010 /* 16-bit card */
217 #define CB_SOCKET_STAT_CB    0x020 /* cardbus card */
218 #define CB_SOCKET_STAT_IREQ  0x040 /* READY(~IREQ)//(~CINT) bit */
219 #define CB_SOCKET_STAT_NOTCARD 0x080 /* Inserted card is unrecognisable */
220 #define CB_SOCKET_STAT_DATALOST 0x0100 /* data lost */
221 #define CB_SOCKET_STAT_BADVCC 0x0200 /* Bad Vcc Request */
222 #define CB_SOCKET_STAT_5VCARD 0x0400 /* 5 V Card */
223 #define CB_SOCKET_STAT_3VCARD 0x0800 /* 3.3 V Card */
224 #define CB_SOCKET_STAT_XVCARD 0x01000 /* X.X V Card */
225 #define CB_SOCKET_STAT_YVCARD 0x02000 /* Y.Y V Card */
226 #define CB_SOCKET_STAT_5VSOCK 0x10000000 /* 5 V Socket */
227 #define CB_SOCKET_STAT_3VSOCK 0x20000000 /* 3.3 V Socket */
228 #define CB_SOCKET_STAT_XVSOCK 0x20000000 /* X.X V Socket */
229 #define CB_SOCKET_STAT_YVSOCK 0x20000000 /* Y.Y V Socket */
230 
231 /* socket force event register (CB_SOCKET_FORCE) elements */
232 #define CB_SOCKET_FORCE_BADVCC 0x0200 /* Bad Vcc Request */
233 
234 
235 /* socket control register (CB_SOCKET_CTRL) elements */
236 #define CB_SOCKET_CTRL_VPPMASK 0x07
237 #define CB_SOCKET_CTRL_VPP_OFF 0x00
238 #define CB_SOCKET_CTRL_VPP_12V 0x01
239 #define CB_SOCKET_CTRL_VPP_5V  0x02
240 #define CB_SOCKET_CTRL_VPP_3V  0x03
241 #define CB_SOCKET_CTRL_VPP_XV  0x04
242 #define CB_SOCKET_CTRL_VPP_YV  0x05
243 
244 #define CB_SOCKET_CTRL_VCCMASK 0x070
245 #define CB_SOCKET_CTRL_VCC_OFF 0x000
246 #define CB_SOCKET_CTRL_VCC_5V  0x020
247 #define CB_SOCKET_CTRL_VCC_3V  0x030
248 #define CB_SOCKET_CTRL_VCC_XV  0x040
249 #define CB_SOCKET_CTRL_VCC_YV  0x050
250 
251 #define CB_SOCKET_CTRL_STOPCLK 0x080
252 
253 
254 
255 /* PCCARD VOLTAGE */
256 #define PCCARD_VCC_UKN 0x00	/* unknown */
257 #define PCCARD_VCC_5V 0x01
258 #define PCCARD_VCC_3V 0x02
259 #define PCCARD_VCC_XV 0x04
260 #define PCCARD_VCC_YV 0x08
261 
262 
263 #endif /* _DEV_PCI_PCCBBREG_H_ */
264