xref: /netbsd/sys/arch/sparc64/dev/iommureg.h (revision 0fcb63b5)
1 /*	$NetBSD: iommureg.h,v 1.21 2016/08/24 06:34:24 mrg Exp $	*/
2 
3 /*
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This software was developed by the Computer Systems Engineering group
8  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
9  * contributed to Berkeley.
10  *
11  * All advertising materials mentioning features or use of this software
12  * must display the following acknowledgement:
13  *	This product includes software developed by the University of
14  *	California, Lawrence Berkeley Laboratory.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  *
40  *	@(#)sbusreg.h	8.1 (Berkeley) 6/11/93
41  */
42 
43 #ifndef _SPARC64_DEV_IOMMUREG_H_
44 #define _SPARC64_DEV_IOMMUREG_H_
45 
46 /*
47  * UltraSPARC IOMMU registers, common to both the sbus and PCI
48  * controllers.
49  */
50 
51 /*
52  * iommu registers - keep iommureg2 aligned with iommureg, so we can always
53  * use offsetof on iommureg2, regardless of the controller.
54  */
55 struct iommureg {
56 	volatile uint64_t	iommu_cr;	/* IOMMU control register */
57 	volatile uint64_t	iommu_tsb;	/* IOMMU TSB base register */
58 	volatile uint64_t	iommu_flush;	/* IOMMU flush register */
59 };
60 
61 /* iommu registers for schizo and newer controllers.  */
62 struct iommureg2 {
63 	volatile uint64_t	iommu_cr;	/* IOMMU control register */
64 	volatile uint64_t	iommu_tsb;	/* IOMMU TSB base register */
65 	volatile uint64_t	iommu_flush;	/* IOMMU flush register */
66 	volatile uint64_t	iommu_ctxflush;
67 	volatile uint64_t	iommu_reserved[28];
68 	volatile uint64_t	iommu_cache_flush;
69 	volatile uint64_t	iommu_cache_invalidate;
70 	volatile uint64_t	iommu_reserved2[30];
71 };
72 
73 /* streaming buffer registers */
74 struct iommu_strbuf {
75 	uint64_t	strbuf_ctl;	/* streaming buffer control reg */
76 	uint64_t	strbuf_pgflush;	/* streaming buffer page flush */
77 	uint64_t	strbuf_flushsync;/* streaming buffer flush sync */
78 };
79 
80 #define	IOMMUREG(x)	(offsetof(struct iommureg2, x))
81 #define	STRBUFREG(x)	(offsetof(struct iommu_strbuf, x))
82 
83 #define IOMMUREG_READ(is, reg)				\
84 	bus_space_read_8((is)->is_bustag,		\
85 		(is)->is_iommu,				\
86 		IOMMUREG(reg))
87 
88 #define IOMMUREG_WRITE(is, reg, v)			\
89 	bus_space_write_8((is)->is_bustag,		\
90 		(is)->is_iommu,				\
91 		IOMMUREG(reg),				\
92 		(v))
93 
94 /* streaming buffer control register */
95 #define STRBUF_EN	0x000000000000000001LL
96 #define STRBUF_D	0x000000000000000002LL
97 
98 /* control register bits */
99 #define IOMMUCR_TSB1K		0x000000000000000000LL	/* Nummber of entries in IOTSB */
100 #define IOMMUCR_TSB2K		0x000000000000010000LL
101 #define IOMMUCR_TSB4K		0x000000000000020000LL
102 #define IOMMUCR_TSB8K		0x000000000000030000LL
103 #define IOMMUCR_TSB16K		0x000000000000040000LL
104 #define IOMMUCR_TSB32K		0x000000000000050000LL
105 #define IOMMUCR_TSB64K		0x000000000000060000LL
106 #define IOMMUCR_TSB128K		0x000000000000070000LL
107 #define IOMMUCR_TSBMASK		0xfffffffffffff8ffffLL	/* Mask for above */
108 #define IOMMUCR_8KPG		0x000000000000000000LL	/* 8K iommu page size */
109 #define IOMMUCR_64KPG		0x000000000000000004LL	/* 64K iommu page size */
110 #define IOMMUCR_DE		0x000000000000000002LL	/* Diag enable */
111 #define IOMMUCR_EN		0x000000000000000001LL	/* Enable IOMMU */
112 
113 #define IOMMUCR_FIRE_SE		0x000000000000000400LL	/* Snoop enable */
114 #define IOMMUCR_FIRE_CM_EN	0x000000000000000300LL  /* Cache mode enable */
115 #define IOMMUCR_FIRE_BE		0x000000000000000002LL	/* Bypass enable */
116 #define IOMMUCR_FIRE_TE		0x000000000000000001LL	/* Translation enabled */
117 
118 /*
119  * IOMMU stuff
120  */
121 #define	IOTTE_V		0x8000000000000000LL	/* Entry valid */
122 #define IOTTE_64K	0x2000000000000000LL	/* 8K or 64K page? */
123 #define IOTTE_8K	0x0000000000000000LL
124 #define IOTTE_STREAM	0x1000000000000000LL	/* Is page streamable? */
125 #define	IOTTE_LOCAL	0x0800000000000000LL	/* Accesses to same bus segment? */
126 #define IOTTE_PAMASK	0x000001ffffffe000LL	/* Let's assume this is correct */
127 #define IOTTE_C		0x0000000000000010LL	/* Accesses to cacheable space */
128 #define IOTTE_W		0x0000000000000002LL	/* Writable */
129 
130 /*
131  * On sun4u each bus controller has a separate IOMMU.  The IOMMU has
132  * a TSB which must be page aligned and physically contiguous.  Mappings
133  * can be of 8K IOMMU pages or 64K IOMMU pages.  We use 8K for compatibility
134  * with the CPU's MMU.
135  *
136  * On sysio, psycho, and psycho+, IOMMU TSBs using 8K pages can map the
137  * following size segments:
138  *
139  *	VA size		VA base		TSB size	tsbsize
140  *	--------	--------	---------	-------
141  *	8MB		ff800000	8K		0
142  *	16MB		ff000000	16K		1
143  *	32MB		fe000000	32K		2
144  *	64MB		fc000000	64K		3
145  *	128MB		f8000000	128K		4
146  *	256MB		f0000000	256K		5
147  *	512MB		e0000000	512K		6
148  *	1GB		c0000000	1MB		7
149  *
150  * Unfortunately, sabres on UltraSPARC IIi and IIe processors does not use
151  * this scheme to determine the IOVA base address.  Instead, bits 31-29 are
152  * used to check against the Target Address Space register in the IIi and
153  * the IOMMU is used if they hit.  God knows what goes on in the IIe.
154  *
155  */
156 
157 
158 #define IOTSB_VEND		(u_int)(0xffffffffffffffffLL<<PGSHIFT)
159 #define IOTSB_VSTART(sz)	(u_int)(IOTSB_VEND << ((sz)+10))
160 #define	IOTSB_VSIZE(sz)		(u_int)(1 << ((sz)+10+PGSHIFT))
161 
162 #define MAKEIOTTE(pa,w,c,s)	(((pa)&IOTTE_PAMASK)|((w)?IOTTE_W:0)|((c)?IOTTE_C:0)|((s)?IOTTE_STREAM:0)|(IOTTE_V|IOTTE_8K))
163 #define IOTSBSLOT(va,sz)	((u_int)(((vaddr_t)(va))-(is->is_dvmabase))>>PGSHIFT)
164 
165 /*
166  * interrupt map stuff.  this belongs elsewhere.
167  */
168 
169 #define INTMAP_V	0x080000000LL	/* Interrupt valid (enabled) */
170 #define INTMAP_TID	0x07c000000LL	/* UPA target ID mask */
171 #define INTMAP_TID_SHIFT 26
172 #define INTMAP_IGN	0x0000007c0LL	/* Interrupt group no (sbus only). */
173 #define INTMAP_IGN_SHIFT 6
174 #define INTMAP_INO	0x00000003fLL	/* Interrupt number */
175 #define INTMAP_INR	(INTMAP_IGN|INTMAP_INO)
176 #define INTMAP_SBUSSLOT	0x000000018LL	/* SBUS slot # */
177 #define INTMAP_PCIBUS	0x000000010LL	/* PCI bus number (A or B) */
178 #define INTMAP_PCISLOT	0x00000000cLL	/* PCI slot # */
179 #define INTMAP_PCIINT	0x000000003LL	/* PCI interrupt #A,#B,#C,#D */
180 #define INTMAP_OBIO	0x000000020LL	/* Onboard device */
181 #define INTMAP_LSHIFT	11		/* Encode level in vector */
182 #define	INTLEVENCODE(x)	(((x)&0x0f)<<INTMAP_LSHIFT)
183 #define INTLEV(x)	(((x)>>INTMAP_LSHIFT)&0x0f)
184 #define INTVEC(x)	((x)&INTMAP_INR)
185 #define INTSLOT(x)	(((x)>>3)&0x7)
186 #define	INTPRI(x)	((x)&0x7)
187 #define	INTINO(x)	((x)&INTMAP_INO)
188 #define INTIGN(x)       ((x)&INTMAP_IGN)
189 
190 #define	INTPCI_MAXOBINO	0x16		/* maximum OBIO INO value for PCI */
191 #define	INTPCIOBINOX(x)	((x)&0x1f)	/* OBIO ino index (for PCI machines) */
192 #define	INTPCIINOX(x)	(((x)&0x1c)>>2)	/* PCI ino index */
193 
194 #endif /* _SPARC64_DEV_IOMMUREG_H_ */
195