1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (C) 2009 Nathan Whitehorn
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * $FreeBSD$
28 */
29
30#ifndef _MACHINE_SLB_H_
31#define	_MACHINE_SLB_H_
32
33/*
34 * Bit definitions for segment lookaside buffer entries.
35 *
36 * PowerPC Microprocessor Family: The Programming Environments for 64-bit
37 * Microprocessors, section 7.4.2.1
38 *
39 * Note that these bitmasks are relative to the values for one of the two
40 * values for slbmte, slbmfee, and slbmfev, not the internal SLB
41 * representation.
42 */
43
44#define	SLBV_KS		0x0000000000000800UL /* Supervisor-state prot key */
45#define	SLBV_KP		0x0000000000000400UL /* User-state prot key */
46#define	SLBV_N		0x0000000000000200UL /* No-execute protection */
47#define	SLBV_L		0x0000000000000100UL /* Large page selector */
48#define	SLBV_CLASS	0x0000000000000080UL /* Class selector */
49#define	SLBV_VSID_MASK	0xfffffffffffff000UL /* Virtual segment ID mask */
50#define	SLBV_VSID_SHIFT	12
51
52/*
53 * Make a predictable 1:1 map from ESIDs to VSIDs for the kernel. Hash table
54 * coverage is increased by swizzling the ESID and multiplying by a prime
55 * number (0x13bb).
56 */
57#define	KERNEL_VSID_BIT	0x0000001000000000UL /* Bit set in all kernel VSIDs */
58#define KERNEL_VSID(esid) ((((((uint64_t)esid << 8) | ((uint64_t)esid >> 28)) \
59				* 0x13bbUL) & (KERNEL_VSID_BIT - 1)) | \
60				KERNEL_VSID_BIT)
61
62#define	SLBE_VALID	0x0000000008000000UL /* SLB entry valid */
63#define	SLBE_INDEX_MASK	0x0000000000000fffUL /* SLB index mask*/
64#define	SLBE_ESID_MASK	0xfffffffff0000000UL /* Effective segment ID mask */
65#define	SLBE_ESID_SHIFT	28
66
67/* Virtual real-mode VSID in LPARs */
68#define VSID_VRMA	0x1ffffff
69
70/*
71 * User segment for copyin/out
72 */
73#define USER_SLB_SLOT 0
74#define USER_SLB_SLBE (((USER_ADDR >> ADDR_SR_SHFT) << SLBE_ESID_SHIFT) | \
75			SLBE_VALID | USER_SLB_SLOT)
76
77struct slb {
78	uint64_t	slbv;
79	uint64_t	slbe;
80};
81
82#endif /* !_MACHINE_SLB_H_ */
83