xref: /freebsd-12.1/sys/sparc64/include/cache.h (revision df57947f)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 1996
5  *	The President and Fellows of Harvard College. All rights reserved.
6  * Copyright (c) 1992, 1993
7  *	The Regents of the University of California.  All rights reserved.
8  *
9  * This software was developed by the Computer Systems Engineering group
10  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
11  * contributed to Berkeley.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. All advertising materials mentioning features or use of this software
22  *    must display the following acknowledgement:
23  *	This product includes software developed by Aaron Brown and
24  *	Harvard University.
25  * 4. Neither the name of the University nor the names of its contributors
26  *    may be used to endorse or promote products derived from this software
27  *    without specific prior written permission.
28  *
29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39  * SUCH DAMAGE.
40  *
41  *	from: @(#)cache.h	8.1 (Berkeley) 6/11/93
42  *	from: NetBSD: cache.h,v 1.3 2000/08/01 00:28:02 eeh Exp
43  *
44  * $FreeBSD$
45  */
46 
47 #ifndef _MACHINE_CACHE_H_
48 #define	_MACHINE_CACHE_H_
49 
50 #define	DCACHE_COLOR_BITS	(1)
51 #define	DCACHE_COLORS		(1 << DCACHE_COLOR_BITS)
52 #define	DCACHE_COLOR_MASK	(DCACHE_COLORS - 1)
53 #define	DCACHE_COLOR(va)	(((va) >> PAGE_SHIFT) & DCACHE_COLOR_MASK)
54 #define	DCACHE_OTHER_COLOR(color)					\
55 	((color) ^ DCACHE_COLOR_BITS)
56 
57 #define	DC_TAG_SHIFT	2
58 #define	DC_VALID_SHIFT	0
59 
60 #define	DC_TAG_BITS	28
61 #define	DC_VALID_BITS	2
62 
63 #define	DC_TAG_MASK	((1 << DC_TAG_BITS) - 1)
64 #define	DC_VALID_MASK	((1 << DC_VALID_BITS) - 1)
65 
66 #define	IC_TAG_SHIFT	7
67 #define	IC_VALID_SHIFT	36
68 
69 #define	IC_TAG_BITS	28
70 #define	IC_VALID_BITS	1
71 
72 #define	IC_TAG_MASK	((1 << IC_TAG_BITS) - 1)
73 #define	IC_VALID_MASK	((1 << IC_VALID_BITS) - 1)
74 
75 #ifndef LOCORE
76 
77 /*
78  * Cache control information
79  */
80 struct cacheinfo {
81 	u_int	ic_size;		/* instruction cache */
82 	u_int	ic_assoc;
83 	u_int	ic_linesize;
84 	u_int	dc_size;		/* data cache */
85 	u_int	dc_assoc;
86 	u_int	dc_linesize;
87 	u_int	ec_size;		/* external cache info */
88 	u_int	ec_assoc;
89 	u_int	ec_linesize;
90 };
91 
92 #ifdef _KERNEL
93 
94 extern u_int dcache_color_ignore;
95 
96 struct pcpu;
97 
98 typedef void cache_enable_t(u_int cpu_impl);
99 typedef void cache_flush_t(void);
100 typedef void dcache_page_inval_t(vm_paddr_t pa);
101 typedef void icache_page_inval_t(vm_paddr_t pa);
102 
103 void cache_init(struct pcpu *pcpu);
104 
105 cache_enable_t cheetah_cache_enable;
106 cache_flush_t cheetah_cache_flush;
107 dcache_page_inval_t cheetah_dcache_page_inval;
108 icache_page_inval_t cheetah_icache_page_inval;
109 
110 cache_enable_t spitfire_cache_enable;
111 cache_flush_t spitfire_cache_flush;
112 dcache_page_inval_t spitfire_dcache_page_inval;
113 icache_page_inval_t spitfire_icache_page_inval;
114 
115 cache_enable_t zeus_cache_enable;
116 cache_flush_t zeus_cache_flush;
117 dcache_page_inval_t zeus_dcache_page_inval;
118 icache_page_inval_t zeus_icache_page_inval;
119 
120 extern cache_enable_t *cache_enable;
121 extern cache_flush_t *cache_flush;
122 extern dcache_page_inval_t *dcache_page_inval;
123 extern icache_page_inval_t *icache_page_inval;
124 
125 #endif /* KERNEL */
126 
127 #endif /* !LOCORE */
128 
129 #endif /* !_MACHINE_CACHE_H_ */
130