1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright (C) 2009 Chen Liqin <liqin.chen@sunplusct.com>
4 * Copyright (C) 2012 Regents of the University of California
5 * Copyright (C) 2017 SiFive
6 * Copyright (C) 2017 XiaojingZhu <zhuxiaoj@ict.ac.cn>
7 */
8
9#ifndef _ASM_RISCV_PAGE_H
10#define _ASM_RISCV_PAGE_H
11
12#include <linux/pfn.h>
13#include <linux/const.h>
14
15#define PAGE_SHIFT	CONFIG_PAGE_SHIFT
16#define PAGE_SIZE	(_AC(1, UL) << PAGE_SHIFT)
17#define PAGE_MASK	(~(PAGE_SIZE - 1))
18
19#define HPAGE_SHIFT		PMD_SHIFT
20#define HPAGE_SIZE		(_AC(1, UL) << HPAGE_SHIFT)
21#define HPAGE_MASK              (~(HPAGE_SIZE - 1))
22#define HUGETLB_PAGE_ORDER      (HPAGE_SHIFT - PAGE_SHIFT)
23
24/*
25 * PAGE_OFFSET -- the first address of the first page of memory.
26 * When not using MMU this corresponds to the first free page in
27 * physical memory (aligned on a page boundary).
28 */
29#ifdef CONFIG_64BIT
30#ifdef CONFIG_MMU
31#define PAGE_OFFSET		kernel_map.page_offset
32#else
33#define PAGE_OFFSET		_AC(CONFIG_PAGE_OFFSET, UL)
34#endif
35/*
36 * By default, CONFIG_PAGE_OFFSET value corresponds to SV57 address space so
37 * define the PAGE_OFFSET value for SV48 and SV39.
38 */
39#define PAGE_OFFSET_L4		_AC(0xffffaf8000000000, UL)
40#define PAGE_OFFSET_L3		_AC(0xffffffd800000000, UL)
41#else
42#define PAGE_OFFSET		_AC(CONFIG_PAGE_OFFSET, UL)
43#endif /* CONFIG_64BIT */
44
45#ifndef __ASSEMBLY__
46
47#ifdef CONFIG_RISCV_ISA_ZICBOZ
48void clear_page(void *page);
49#else
50#define clear_page(pgaddr)			memset((pgaddr), 0, PAGE_SIZE)
51#endif
52#define copy_page(to, from)			memcpy((to), (from), PAGE_SIZE)
53
54#define clear_user_page(pgaddr, vaddr, page)	clear_page(pgaddr)
55#define copy_user_page(vto, vfrom, vaddr, topg) \
56			memcpy((vto), (vfrom), PAGE_SIZE)
57
58/*
59 * Use struct definitions to apply C type checking
60 */
61
62/* Page Global Directory entry */
63typedef struct {
64	unsigned long pgd;
65} pgd_t;
66
67/* Page Table entry */
68typedef struct {
69	unsigned long pte;
70} pte_t;
71
72typedef struct {
73	unsigned long pgprot;
74} pgprot_t;
75
76typedef struct page *pgtable_t;
77
78#define pte_val(x)	((x).pte)
79#define pgd_val(x)	((x).pgd)
80#define pgprot_val(x)	((x).pgprot)
81
82#define __pte(x)	((pte_t) { (x) })
83#define __pgd(x)	((pgd_t) { (x) })
84#define __pgprot(x)	((pgprot_t) { (x) })
85
86#ifdef CONFIG_64BIT
87#define PTE_FMT "%016lx"
88#else
89#define PTE_FMT "%08lx"
90#endif
91
92#ifdef CONFIG_64BIT
93/*
94 * We override this value as its generic definition uses __pa too early in
95 * the boot process (before kernel_map.va_pa_offset is set).
96 */
97#define MIN_MEMBLOCK_ADDR      0
98#endif
99
100#ifdef CONFIG_MMU
101#define ARCH_PFN_OFFSET		(PFN_DOWN((unsigned long)phys_ram_base))
102#else
103#define ARCH_PFN_OFFSET		(PAGE_OFFSET >> PAGE_SHIFT)
104#endif /* CONFIG_MMU */
105
106struct kernel_mapping {
107	unsigned long page_offset;
108	unsigned long virt_addr;
109	unsigned long virt_offset;
110	uintptr_t phys_addr;
111	uintptr_t size;
112	/* Offset between linear mapping virtual address and kernel load address */
113	unsigned long va_pa_offset;
114	/* Offset between kernel mapping virtual address and kernel load address */
115	unsigned long va_kernel_pa_offset;
116	unsigned long va_kernel_xip_pa_offset;
117#ifdef CONFIG_XIP_KERNEL
118	uintptr_t xiprom;
119	uintptr_t xiprom_sz;
120#endif
121};
122
123extern struct kernel_mapping kernel_map;
124extern phys_addr_t phys_ram_base;
125
126#define is_kernel_mapping(x)	\
127	((x) >= kernel_map.virt_addr && (x) < (kernel_map.virt_addr + kernel_map.size))
128
129#define is_linear_mapping(x)	\
130	((x) >= PAGE_OFFSET && (!IS_ENABLED(CONFIG_64BIT) || (x) < PAGE_OFFSET + KERN_VIRT_SIZE))
131
132#ifndef CONFIG_DEBUG_VIRTUAL
133#define linear_mapping_pa_to_va(x)	((void *)((unsigned long)(x) + kernel_map.va_pa_offset))
134#else
135void *linear_mapping_pa_to_va(unsigned long x);
136#endif
137#define kernel_mapping_pa_to_va(y)	({					\
138	unsigned long _y = (unsigned long)(y);					\
139	(IS_ENABLED(CONFIG_XIP_KERNEL) && _y < phys_ram_base) ?			\
140		(void *)(_y + kernel_map.va_kernel_xip_pa_offset) :		\
141		(void *)(_y + kernel_map.va_kernel_pa_offset + XIP_OFFSET);	\
142	})
143#define __pa_to_va_nodebug(x)		linear_mapping_pa_to_va(x)
144
145#ifndef CONFIG_DEBUG_VIRTUAL
146#define linear_mapping_va_to_pa(x)	((unsigned long)(x) - kernel_map.va_pa_offset)
147#else
148phys_addr_t linear_mapping_va_to_pa(unsigned long x);
149#endif
150#define kernel_mapping_va_to_pa(y) ({						\
151	unsigned long _y = (unsigned long)(y);					\
152	(IS_ENABLED(CONFIG_XIP_KERNEL) && _y < kernel_map.virt_addr + XIP_OFFSET) ? \
153		(_y - kernel_map.va_kernel_xip_pa_offset) :			\
154		(_y - kernel_map.va_kernel_pa_offset - XIP_OFFSET);		\
155	})
156
157#define __va_to_pa_nodebug(x)	({						\
158	unsigned long _x = x;							\
159	is_linear_mapping(_x) ?							\
160		linear_mapping_va_to_pa(_x) : kernel_mapping_va_to_pa(_x);	\
161	})
162
163#ifdef CONFIG_DEBUG_VIRTUAL
164extern phys_addr_t __virt_to_phys(unsigned long x);
165extern phys_addr_t __phys_addr_symbol(unsigned long x);
166#else
167#define __virt_to_phys(x)	__va_to_pa_nodebug(x)
168#define __phys_addr_symbol(x)	__va_to_pa_nodebug(x)
169#endif /* CONFIG_DEBUG_VIRTUAL */
170
171#define __pa_symbol(x)	__phys_addr_symbol(RELOC_HIDE((unsigned long)(x), 0))
172#define __pa(x)		__virt_to_phys((unsigned long)(x))
173#define __va(x)		((void *)__pa_to_va_nodebug((phys_addr_t)(x)))
174
175#define phys_to_pfn(phys)	(PFN_DOWN(phys))
176#define pfn_to_phys(pfn)	(PFN_PHYS(pfn))
177
178#define virt_to_pfn(vaddr)	(phys_to_pfn(__pa(vaddr)))
179#define pfn_to_virt(pfn)	(__va(pfn_to_phys(pfn)))
180
181#define virt_to_page(vaddr)	(pfn_to_page(virt_to_pfn(vaddr)))
182#define page_to_virt(page)	(pfn_to_virt(page_to_pfn(page)))
183
184#define page_to_phys(page)	(pfn_to_phys(page_to_pfn(page)))
185#define phys_to_page(paddr)	(pfn_to_page(phys_to_pfn(paddr)))
186
187#define sym_to_pfn(x)           __phys_to_pfn(__pa_symbol(x))
188
189unsigned long kaslr_offset(void);
190
191#endif /* __ASSEMBLY__ */
192
193#define virt_addr_valid(vaddr)	({						\
194	unsigned long _addr = (unsigned long)vaddr;				\
195	(unsigned long)(_addr) >= PAGE_OFFSET && pfn_valid(virt_to_pfn(_addr));	\
196})
197
198#define VM_DATA_DEFAULT_FLAGS	VM_DATA_FLAGS_NON_EXEC
199
200#include <asm-generic/memory_model.h>
201#include <asm-generic/getorder.h>
202
203#endif /* _ASM_RISCV_PAGE_H */
204