[mirror_ubuntu-jammy-kernel.git] / arch / arm64 / include / asm / memory.h

/*
 * Based on arch/arm/include/asm/memory.h
 *
 * Copyright (C) 2000-2002 Russell King
 * Copyright (C) 2012 ARM Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Note: this file should not be included by non-asm/.h files
 */
#ifndef __ASM_MEMORY_H
#define __ASM_MEMORY_H

#include <linux/compiler.h>
#include <linux/const.h>
#include <linux/types.h>
#include <asm/sizes.h>

/*
 * Allow for constants defined here to be used from assembly code
 * by prepending the UL suffix only with actual C code compilation.
 */
#define UL(x) _AC(x, UL)

/*
 * PAGE_OFFSET - the virtual address of the start of the kernel image (top
 *		 (VA_BITS - 1))
 * VA_BITS - the maximum number of bits for virtual addresses.
 * TASK_SIZE - the maximum size of a user space task.
 * TASK_UNMAPPED_BASE - the lower boundary of the mmap VM area.
 * The module space lives between the addresses given by TASK_SIZE
 * and PAGE_OFFSET - it must be within 128MB of the kernel text.
 */
#ifdef CONFIG_ARM64_64K_PAGES
#define VA_BITS			(42)
#else
#define VA_BITS			(39)
#endif
#define PAGE_OFFSET		(UL(0xffffffffffffffff) << (VA_BITS - 1))
#define MODULES_END		(PAGE_OFFSET)
#define MODULES_VADDR		(MODULES_END - SZ_64M)
#define FIXADDR_TOP		(MODULES_VADDR - SZ_2M - PAGE_SIZE)
#define TASK_SIZE_64		(UL(1) << VA_BITS)

#ifdef CONFIG_COMPAT
#define TASK_SIZE_32		UL(0x100000000)
#define TASK_SIZE		(test_thread_flag(TIF_32BIT) ? \
				TASK_SIZE_32 : TASK_SIZE_64)
#else
#define TASK_SIZE		TASK_SIZE_64
#endif /* CONFIG_COMPAT */

#define TASK_UNMAPPED_BASE	(PAGE_ALIGN(TASK_SIZE / 4))

#if TASK_SIZE_64 > MODULES_VADDR
#error Top of 64-bit user space clashes with start of module space
#endif

/*
 * Physical vs virtual RAM address space conversion.  These are
 * private definitions which should NOT be used outside memory.h
 * files.  Use virt_to_phys/phys_to_virt/__pa/__va instead.
 */
#define __virt_to_phys(x)	(((phys_addr_t)(x) - PAGE_OFFSET + PHYS_OFFSET))
#define __phys_to_virt(x)	((unsigned long)((x) - PHYS_OFFSET + PAGE_OFFSET))

/*
 * Convert a physical address to a Page Frame Number and back
 */
#define	__phys_to_pfn(paddr)	((unsigned long)((paddr) >> PAGE_SHIFT))
#define	__pfn_to_phys(pfn)	((phys_addr_t)(pfn) << PAGE_SHIFT)

/*
 * Convert a page to/from a physical address
 */
#define page_to_phys(page)	(__pfn_to_phys(page_to_pfn(page)))
#define phys_to_page(phys)	(pfn_to_page(__phys_to_pfn(phys)))

/*
 * Memory types available.
 */
#define MT_DEVICE_nGnRnE	0
#define MT_DEVICE_nGnRE		1
#define MT_DEVICE_GRE		2
#define MT_NORMAL_NC		3
#define MT_NORMAL		4

/*
 * Memory types for Stage-2 translation
 */
#define MT_S2_NORMAL		0xf
#define MT_S2_DEVICE_nGnRE	0x1

#ifndef __ASSEMBLY__

extern phys_addr_t		memstart_addr;
/* PHYS_OFFSET - the physical address of the start of memory. */
#define PHYS_OFFSET		({ memstart_addr; })

/*
 * PFNs are used to describe any physical page; this means
 * PFN 0 == physical address 0.
 *
 * This is the PFN of the first RAM page in the kernel
 * direct-mapped view.  We assume this is the first page
 * of RAM in the mem_map as well.
 */
#define PHYS_PFN_OFFSET	(PHYS_OFFSET >> PAGE_SHIFT)

/*
 * Note: Drivers should NOT use these.  They are the wrong
 * translation for translating DMA addresses.  Use the driver
 * DMA support - see dma-mapping.h.
 */
static inline phys_addr_t virt_to_phys(const volatile void *x)
{
	return __virt_to_phys((unsigned long)(x));
}

static inline void *phys_to_virt(phys_addr_t x)
{
	return (void *)(__phys_to_virt(x));
}

/*
 * Drivers should NOT use these either.
 */
#define __pa(x)			__virt_to_phys((unsigned long)(x))
#define __va(x)			((void *)__phys_to_virt((phys_addr_t)(x)))
#define pfn_to_kaddr(pfn)	__va((pfn) << PAGE_SHIFT)
#define virt_to_pfn(x)      __phys_to_pfn(__virt_to_phys(x))

/*
 *  virt_to_page(k)	convert a _valid_ virtual address to struct page *
 *  virt_addr_valid(k)	indicates whether a virtual address is valid
 */
#define ARCH_PFN_OFFSET		PHYS_PFN_OFFSET

#define virt_to_page(kaddr)	pfn_to_page(__pa(kaddr) >> PAGE_SHIFT)
#define	virt_addr_valid(kaddr)	pfn_valid(__pa(kaddr) >> PAGE_SHIFT)

#endif

#include <asm-generic/memory_model.h>

#endif
Commit	Line	Data
4f04d8f0 CM	1	/*
	2	* Based on arch/arm/include/asm/memory.h
	3	*
	4	* Copyright (C) 2000-2002 Russell King
	5	* Copyright (C) 2012 ARM Ltd.
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*
	19	* Note: this file should not be included by non-asm/.h files
	20	*/
	21	#ifndef __ASM_MEMORY_H
	22	#define __ASM_MEMORY_H
	23
	24	#include <linux/compiler.h>
	25	#include <linux/const.h>
	26	#include <linux/types.h>
	27	#include <asm/sizes.h>
	28
	29	/*
	30	* Allow for constants defined here to be used from assembly code
	31	* by prepending the UL suffix only with actual C code compilation.
	32	*/
	33	#define UL(x) _AC(x, UL)
	34
	35	/*
847264fb CM	36	* PAGE_OFFSET - the virtual address of the start of the kernel image (top
847264fb CM	37	* (VA_BITS - 1))
4f04d8f0 CM	38	* VA_BITS - the maximum number of bits for virtual addresses.
	39	* TASK_SIZE - the maximum size of a user space task.
	40	* TASK_UNMAPPED_BASE - the lower boundary of the mmap VM area.
	41	* The module space lives between the addresses given by TASK_SIZE
	42	* and PAGE_OFFSET - it must be within 128MB of the kernel text.
	43	*/
847264fb CM	44	#ifdef CONFIG_ARM64_64K_PAGES
	45	#define VA_BITS (42)
	46	#else
	47	#define VA_BITS (39)
	48	#endif
	49	#define PAGE_OFFSET (UL(0xffffffffffffffff) << (VA_BITS - 1))
4f04d8f0 CM	50	#define MODULES_END (PAGE_OFFSET)
4f04d8f0 CM	51	#define MODULES_VADDR (MODULES_END - SZ_64M)
bf4b558e	52	#define FIXADDR_TOP (MODULES_VADDR - SZ_2M - PAGE_SIZE)
4f04d8f0 CM	53	#define TASK_SIZE_64 (UL(1) << VA_BITS)
	54
	55	#ifdef CONFIG_COMPAT
	56	#define TASK_SIZE_32 UL(0x100000000)
	57	#define TASK_SIZE (test_thread_flag(TIF_32BIT) ? \
	58	TASK_SIZE_32 : TASK_SIZE_64)
	59	#else
	60	#define TASK_SIZE TASK_SIZE_64
	61	#endif /* CONFIG_COMPAT */
	62
	63	#define TASK_UNMAPPED_BASE (PAGE_ALIGN(TASK_SIZE / 4))
	64
	65	#if TASK_SIZE_64 > MODULES_VADDR
	66	#error Top of 64-bit user space clashes with start of module space
	67	#endif
	68
	69	/*
	70	* Physical vs virtual RAM address space conversion. These are
	71	* private definitions which should NOT be used outside memory.h
	72	* files. Use virt_to_phys/phys_to_virt/__pa/__va instead.
	73	*/
	74	#define __virt_to_phys(x) (((phys_addr_t)(x) - PAGE_OFFSET + PHYS_OFFSET))
	75	#define __phys_to_virt(x) ((unsigned long)((x) - PHYS_OFFSET + PAGE_OFFSET))
	76
	77	/*
	78	* Convert a physical address to a Page Frame Number and back
	79	*/
	80	#define __phys_to_pfn(paddr) ((unsigned long)((paddr) >> PAGE_SHIFT))
	81	#define __pfn_to_phys(pfn) ((phys_addr_t)(pfn) << PAGE_SHIFT)
	82
	83	/*
	84	* Convert a page to/from a physical address
	85	*/
	86	#define page_to_phys(page) (__pfn_to_phys(page_to_pfn(page)))
	87	#define phys_to_page(phys) (pfn_to_page(__phys_to_pfn(phys)))
	88
	89	/*
	90	* Memory types available.
	91	*/
	92	#define MT_DEVICE_nGnRnE 0
	93	#define MT_DEVICE_nGnRE 1
	94	#define MT_DEVICE_GRE 2
	95	#define MT_NORMAL_NC 3
	96	#define MT_NORMAL 4
	97
36311607 MZ	98	/*
	99	* Memory types for Stage-2 translation
	100	*/
	101	#define MT_S2_NORMAL 0xf
	102	#define MT_S2_DEVICE_nGnRE 0x1
	103
4f04d8f0 CM	104	#ifndef __ASSEMBLY__
	105
	106	extern phys_addr_t memstart_addr;
	107	/* PHYS_OFFSET - the physical address of the start of memory. */
	108	#define PHYS_OFFSET ({ memstart_addr; })
	109
	110	/*
	111	* PFNs are used to describe any physical page; this means
	112	* PFN 0 == physical address 0.
	113	*
	114	* This is the PFN of the first RAM page in the kernel
	115	* direct-mapped view. We assume this is the first page
	116	* of RAM in the mem_map as well.
	117	*/
	118	#define PHYS_PFN_OFFSET (PHYS_OFFSET >> PAGE_SHIFT)
	119
	120	/*
	121	* Note: Drivers should NOT use these. They are the wrong
	122	* translation for translating DMA addresses. Use the driver
	123	* DMA support - see dma-mapping.h.
	124	*/
	125	static inline phys_addr_t virt_to_phys(const volatile void *x)
	126	{
	127	return __virt_to_phys((unsigned long)(x));
	128	}
	129
	130	static inline void *phys_to_virt(phys_addr_t x)
	131	{
	132	return (void *)(__phys_to_virt(x));
	133	}
	134
	135	/*
	136	* Drivers should NOT use these either.
	137	*/
	138	#define __pa(x) __virt_to_phys((unsigned long)(x))
	139	#define __va(x) ((void *)__phys_to_virt((phys_addr_t)(x)))
	140	#define pfn_to_kaddr(pfn) __va((pfn) << PAGE_SHIFT)
1f53ba6e	141	#define virt_to_pfn(x) __phys_to_pfn(__virt_to_phys(x))
4f04d8f0 CM	142
	143	/*
	144	* virt_to_page(k) convert a _valid_ virtual address to struct page *
	145	* virt_addr_valid(k) indicates whether a virtual address is valid
	146	*/
	147	#define ARCH_PFN_OFFSET PHYS_PFN_OFFSET
	148
	149	#define virt_to_page(kaddr) pfn_to_page(__pa(kaddr) >> PAGE_SHIFT)
e26db3f3	150	#define virt_addr_valid(kaddr) pfn_valid(__pa(kaddr) >> PAGE_SHIFT)
4f04d8f0 CM	151
	152	#endif
	153
	154	#include <asm-generic/memory_model.h>
	155
	156	#endif