iommureg.h revision 108802
1/*
2 * Copyright (c) 1992, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * This software was developed by the Computer Systems Engineering group
6 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
7 * contributed to Berkeley.
8 *
9 * All advertising materials mentioning features or use of this software
10 * must display the following acknowledgement:
11 *	This product includes software developed by the University of
12 *	California, Lawrence Berkeley Laboratory.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
16 * are met:
17 * 1. Redistributions of source code must retain the above copyright
18 *    notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 *    notice, this list of conditions and the following disclaimer in the
21 *    documentation and/or other materials provided with the distribution.
22 * 3. All advertising materials mentioning features or use of this software
23 *    must display the following acknowledgement:
24 *	This product includes software developed by the University of
25 *	California, Berkeley and its contributors.
26 * 4. Neither the name of the University nor the names of its contributors
27 *    may be used to endorse or promote products derived from this software
28 *    without specific prior written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
31 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
34 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 * SUCH DAMAGE.
41 *
42 *	from: @(#)sbusreg.h	8.1 (Berkeley) 6/11/93
43 *	from: NetBSD: iommureg.h,v 1.6 2001/07/20 00:07:13 eeh Exp
44 *
45 * $FreeBSD: head/sys/sparc64/include/iommureg.h 108802 2003-01-06 17:10:07Z tmm $
46 */
47
48#ifndef _MACHINE_IOMMUREG_H_
49#define _MACHINE_IOMMUREG_H_
50
51/*
52 * UltraSPARC IOMMU registers, common to both the sbus and PCI
53 * controllers.
54 */
55
56/* iommmu registers */
57#define	IMR_CTL		0x0000	/* IOMMU control register */
58#define	IMR_TSB		0x0008	/* IOMMU TSB base register */
59#define	IMR_FLUSH	0x0010	/* IOMMU flush register */
60
61/* streaming buffer registers */
62#define	ISR_CTL		0x0000	/* streaming buffer control reg */
63#define	ISR_PGFLUSH	0x0008	/* streaming buffer page flush */
64#define	ISR_FLUSHSYNC	0x0010	/* streaming buffer flush sync */
65
66/* streaming buffer diagnostics registers. */
67#define	ISD_DATA_DIAG	0x0000	/* streaming buffer data RAM diag 0..127 */
68#define	ISD_ERROR_DIAG	0x0400	/* streaming buffer error status diag 0..127 */
69#define	ISD_PG_TAG_DIAG	0x0800	/* streaming buffer page tag diag 0..15 */
70#define	ISD_LN_TAG_DIAG	0x0900	/* streaming buffer line tag diag 0..15 */
71
72/* streaming buffer control register */
73#define STRBUF_EN		0x0000000000000001UL
74#define STRBUF_D		0x0000000000000002UL
75
76#define	IOMMU_BITS		34
77#define	IOMMU_MAXADDR		(1UL << IOMMU_BITS)
78
79/*
80 * control register bits
81 */
82/* Nummber of entries in IOTSB */
83#define	IOMMUCR_TSBSZ_SHIFT	16
84#define IOMMUCR_TSB1K		0x0000000000000000UL
85#define IOMMUCR_TSB2K		0x0000000000010000UL
86#define IOMMUCR_TSB4K		0x0000000000020000UL
87#define IOMMUCR_TSB8K		0x0000000000030000UL
88#define IOMMUCR_TSB16K		0x0000000000040000UL
89#define IOMMUCR_TSB32K		0x0000000000050000UL
90#define IOMMUCR_TSB64K		0x0000000000060000UL
91#define IOMMUCR_TSB128K		0x0000000000070000UL
92/* Mask for above */
93#define IOMMUCR_TSBMASK		0xfffffffffff8ffffUL
94/* 8K iommu page size */
95#define IOMMUCR_8KPG		0x0000000000000000UL
96/* 64K iommu page size */
97#define IOMMUCR_64KPG		0x0000000000000004UL
98/* Diag enable */
99#define IOMMUCR_DE		0x0000000000000002UL
100/* Enable IOMMU */
101#define IOMMUCR_EN		0x0000000000000001UL
102
103/*
104 * Diagnostic register definitions.
105 */
106#define	IOMMU_DTAG_VPNBITS	19
107#define	IOMMU_DTAG_VPNMASK	((1 << IOMMU_DTAG_VPNBITS) - 1)
108#define	IOMMU_DTAG_VPNSHIFT	13
109#define IOMMU_DTAG_ERRBITS	3
110#define	IOMMU_DTAG_ERRSHIFT	22
111#define	IOMMU_DTAG_ERRMASK \
112	(((1 << IOMMU_DTAG_ERRBITS) - 1) << IOMMU_DTAG_ERRSHIFT)
113
114#define	IOMMU_DDATA_PGBITS	21
115#define	IOMMU_DDATA_PGMASK	((1 << IOMMU_DDATA_PGBITS) - 1)
116#define	IOMMU_DDATA_PGSHIFT	13
117#define	IOMMU_DDATA_C		(1 << 28)
118#define	IOMMU_DDATA_V		(1 << 30)
119
120/*
121 * IOMMU stuff
122 */
123/* Entry valid */
124#define	IOTTE_V			0x8000000000000000UL
125/* 8K or 64K page? */
126#define IOTTE_64K		0x2000000000000000UL
127#define IOTTE_8K		0x0000000000000000UL
128/* Is page streamable? */
129#define IOTTE_STREAM		0x1000000000000000UL
130/* Accesses to same bus segment? */
131#define	IOTTE_LOCAL		0x0800000000000000UL
132/* Let's assume this is correct */
133#define IOTTE_PAMASK		0x000001ffffffe000UL
134/* Accesses to cacheable space */
135#define IOTTE_C			0x0000000000000010UL
136/* Writeable */
137#define IOTTE_W			0x0000000000000002UL
138
139/* log2 of the IOMMU TTE size. */
140#define	IOTTE_SHIFT		3
141
142/* Streaming buffer line size. */
143#define	STRBUF_LINESZ		64
144
145/*
146 * Number of bytes written by a stream buffer flushsync operation to indicate
147 * completion.
148 */
149#define	STRBUF_FLUSHSYNC_NBYTES	STRBUF_LINESZ
150
151/*
152 * On sun4u each bus controller has a separate IOMMU.  The IOMMU has
153 * a TSB which must be page aligned and physically contiguous.  Mappings
154 * can be of 8K IOMMU pages or 64K IOMMU pages.  We use 8K for compatibility
155 * with the CPU's MMU.
156 *
157 * On sysio, psycho, and psycho+, IOMMU TSBs using 8K pages can map the
158 * following size segments:
159 *
160 *	VA size		VA base		TSB size	tsbsize
161 *	--------	--------	---------	-------
162 *	8MB		ff800000	8K		0
163 *	16MB		ff000000	16K		1
164 *	32MB		fe000000	32K		2
165 *	64MB		fc000000	64K		3
166 *	128MB		f8000000	128K		4
167 *	256MB		f0000000	256K		5
168 *	512MB		e0000000	512K		6
169 *	1GB		c0000000	1MB		7
170 *
171 * Unfortunately, sabres on UltraSPARC IIi and IIe processors does not use
172 * this scheme to determine the IOVA base address.  Instead, bits 31-29 are
173 * used to check against the Target Address Space register in the IIi and
174 * the the IOMMU is used if they hit.  God knows what goes on in the IIe.
175 *
176 */
177
178#define	IOTSB_BASESZ		(1024 << IOTTE_SHIFT)
179#define IOTSB_VEND		(~IO_PAGE_MASK)
180#define IOTSB_VSTART(sz)	(u_int)(IOTSB_VEND << ((sz) + 10))
181
182#define MAKEIOTTE(pa,w,c,s)						\
183	(((pa) & IOTTE_PAMASK) | ((w) ? IOTTE_W : 0) |			\
184	((c) ? IOTTE_C : 0) | ((s) ? IOTTE_STREAM : 0) |		\
185	(IOTTE_V | IOTTE_8K))
186#define IOTSBSLOT(va)						\
187	((u_int)(((vm_offset_t)(va)) - (is->is_dvmabase)) >> IO_PAGE_SHIFT)
188
189#endif /* !_MACHINE_IOMMUREG_H_ */
190