xref: /openbmc/linux/arch/arm/include/asm/memory.h (revision b627b4ed)
1 /*
2  *  arch/arm/include/asm/memory.h
3  *
4  *  Copyright (C) 2000-2002 Russell King
5  *  modification for nommu, Hyok S. Choi, 2004
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  *  Note: this file should not be included by non-asm/.h files
12  */
13 #ifndef __ASM_ARM_MEMORY_H
14 #define __ASM_ARM_MEMORY_H
15 
16 #include <linux/compiler.h>
17 #include <linux/const.h>
18 #include <mach/memory.h>
19 #include <asm/sizes.h>
20 
21 /*
22  * Allow for constants defined here to be used from assembly code
23  * by prepending the UL suffix only with actual C code compilation.
24  */
25 #define UL(x) _AC(x, UL)
26 
27 #ifdef CONFIG_MMU
28 
29 /*
30  * PAGE_OFFSET - the virtual address of the start of the kernel image
31  * TASK_SIZE - the maximum size of a user space task.
32  * TASK_UNMAPPED_BASE - the lower boundary of the mmap VM area
33  */
34 #define PAGE_OFFSET		UL(CONFIG_PAGE_OFFSET)
35 #define TASK_SIZE		(UL(CONFIG_PAGE_OFFSET) - UL(0x01000000))
36 #define TASK_UNMAPPED_BASE	(UL(CONFIG_PAGE_OFFSET) / 3)
37 
38 /*
39  * The maximum size of a 26-bit user space task.
40  */
41 #define TASK_SIZE_26		UL(0x04000000)
42 
43 /*
44  * The module space lives between the addresses given by TASK_SIZE
45  * and PAGE_OFFSET - it must be within 32MB of the kernel text.
46  */
47 #define MODULES_VADDR		(PAGE_OFFSET - 16*1024*1024)
48 #if TASK_SIZE > MODULES_VADDR
49 #error Top of user space clashes with start of module space
50 #endif
51 
52 /*
53  * The highmem pkmap virtual space shares the end of the module area.
54  */
55 #ifdef CONFIG_HIGHMEM
56 #define MODULES_END		(PAGE_OFFSET - PMD_SIZE)
57 #else
58 #define MODULES_END		(PAGE_OFFSET)
59 #endif
60 
61 /*
62  * The XIP kernel gets mapped at the bottom of the module vm area.
63  * Since we use sections to map it, this macro replaces the physical address
64  * with its virtual address while keeping offset from the base section.
65  */
66 #define XIP_VIRT_ADDR(physaddr)  (MODULES_VADDR + ((physaddr) & 0x000fffff))
67 
68 /*
69  * Allow 16MB-aligned ioremap pages
70  */
71 #define IOREMAP_MAX_ORDER	24
72 
73 #else /* CONFIG_MMU */
74 
75 /*
76  * The limitation of user task size can grow up to the end of free ram region.
77  * It is difficult to define and perhaps will never meet the original meaning
78  * of this define that was meant to.
79  * Fortunately, there is no reference for this in noMMU mode, for now.
80  */
81 #ifndef TASK_SIZE
82 #define TASK_SIZE		(CONFIG_DRAM_SIZE)
83 #endif
84 
85 #ifndef TASK_UNMAPPED_BASE
86 #define TASK_UNMAPPED_BASE	UL(0x00000000)
87 #endif
88 
89 #ifndef PHYS_OFFSET
90 #define PHYS_OFFSET 		(CONFIG_DRAM_BASE)
91 #endif
92 
93 #ifndef END_MEM
94 #define END_MEM     		(CONFIG_DRAM_BASE + CONFIG_DRAM_SIZE)
95 #endif
96 
97 #ifndef PAGE_OFFSET
98 #define PAGE_OFFSET		(PHYS_OFFSET)
99 #endif
100 
101 /*
102  * The module can be at any place in ram in nommu mode.
103  */
104 #define MODULES_END		(END_MEM)
105 #define MODULES_VADDR		(PHYS_OFFSET)
106 
107 #endif /* !CONFIG_MMU */
108 
109 /*
110  * Size of DMA-consistent memory region.  Must be multiple of 2M,
111  * between 2MB and 14MB inclusive.
112  */
113 #ifndef CONSISTENT_DMA_SIZE
114 #define CONSISTENT_DMA_SIZE SZ_2M
115 #endif
116 
117 /*
118  * Physical vs virtual RAM address space conversion.  These are
119  * private definitions which should NOT be used outside memory.h
120  * files.  Use virt_to_phys/phys_to_virt/__pa/__va instead.
121  */
122 #define __virt_to_phys(x)	((x) - PAGE_OFFSET + PHYS_OFFSET)
123 #define __phys_to_virt(x)	((x) - PHYS_OFFSET + PAGE_OFFSET)
124 
125 /*
126  * Convert a physical address to a Page Frame Number and back
127  */
128 #define	__phys_to_pfn(paddr)	((paddr) >> PAGE_SHIFT)
129 #define	__pfn_to_phys(pfn)	((pfn) << PAGE_SHIFT)
130 
131 #ifndef __ASSEMBLY__
132 
133 /*
134  * The DMA mask corresponding to the maximum bus address allocatable
135  * using GFP_DMA.  The default here places no restriction on DMA
136  * allocations.  This must be the smallest DMA mask in the system,
137  * so a successful GFP_DMA allocation will always satisfy this.
138  */
139 #ifndef ISA_DMA_THRESHOLD
140 #define ISA_DMA_THRESHOLD	(0xffffffffULL)
141 #endif
142 
143 #ifndef arch_adjust_zones
144 #define arch_adjust_zones(node,size,holes) do { } while (0)
145 #elif !defined(CONFIG_ZONE_DMA)
146 #error "custom arch_adjust_zones() requires CONFIG_ZONE_DMA"
147 #endif
148 
149 /*
150  * PFNs are used to describe any physical page; this means
151  * PFN 0 == physical address 0.
152  *
153  * This is the PFN of the first RAM page in the kernel
154  * direct-mapped view.  We assume this is the first page
155  * of RAM in the mem_map as well.
156  */
157 #define PHYS_PFN_OFFSET	(PHYS_OFFSET >> PAGE_SHIFT)
158 
159 /*
160  * These are *only* valid on the kernel direct mapped RAM memory.
161  * Note: Drivers should NOT use these.  They are the wrong
162  * translation for translating DMA addresses.  Use the driver
163  * DMA support - see dma-mapping.h.
164  */
165 static inline unsigned long virt_to_phys(void *x)
166 {
167 	return __virt_to_phys((unsigned long)(x));
168 }
169 
170 static inline void *phys_to_virt(unsigned long x)
171 {
172 	return (void *)(__phys_to_virt((unsigned long)(x)));
173 }
174 
175 /*
176  * Drivers should NOT use these either.
177  */
178 #define __pa(x)			__virt_to_phys((unsigned long)(x))
179 #define __va(x)			((void *)__phys_to_virt((unsigned long)(x)))
180 #define pfn_to_kaddr(pfn)	__va((pfn) << PAGE_SHIFT)
181 
182 /*
183  * Virtual <-> DMA view memory address translations
184  * Again, these are *only* valid on the kernel direct mapped RAM
185  * memory.  Use of these is *deprecated* (and that doesn't mean
186  * use the __ prefixed forms instead.)  See dma-mapping.h.
187  */
188 #ifndef __virt_to_bus
189 #define __virt_to_bus	__virt_to_phys
190 #define __bus_to_virt	__phys_to_virt
191 #define __pfn_to_bus(x)	((x) << PAGE_SHIFT)
192 #endif
193 
194 static inline __deprecated unsigned long virt_to_bus(void *x)
195 {
196 	return __virt_to_bus((unsigned long)x);
197 }
198 
199 static inline __deprecated void *bus_to_virt(unsigned long x)
200 {
201 	return (void *)__bus_to_virt(x);
202 }
203 
204 /*
205  * Conversion between a struct page and a physical address.
206  *
207  * Note: when converting an unknown physical address to a
208  * struct page, the resulting pointer must be validated
209  * using VALID_PAGE().  It must return an invalid struct page
210  * for any physical address not corresponding to a system
211  * RAM address.
212  *
213  *  page_to_pfn(page)	convert a struct page * to a PFN number
214  *  pfn_to_page(pfn)	convert a _valid_ PFN number to struct page *
215  *  pfn_valid(pfn)	indicates whether a PFN number is valid
216  *
217  *  virt_to_page(k)	convert a _valid_ virtual address to struct page *
218  *  virt_addr_valid(k)	indicates whether a virtual address is valid
219  */
220 #ifndef CONFIG_DISCONTIGMEM
221 
222 #define ARCH_PFN_OFFSET		PHYS_PFN_OFFSET
223 
224 #ifndef CONFIG_SPARSEMEM
225 #define pfn_valid(pfn)		((pfn) >= PHYS_PFN_OFFSET && (pfn) < (PHYS_PFN_OFFSET + max_mapnr))
226 #endif
227 
228 #define virt_to_page(kaddr)	pfn_to_page(__pa(kaddr) >> PAGE_SHIFT)
229 #define virt_addr_valid(kaddr)	((unsigned long)(kaddr) >= PAGE_OFFSET && (unsigned long)(kaddr) < (unsigned long)high_memory)
230 
231 #define PHYS_TO_NID(addr)	(0)
232 
233 #else /* CONFIG_DISCONTIGMEM */
234 
235 /*
236  * This is more complex.  We have a set of mem_map arrays spread
237  * around in memory.
238  */
239 #include <linux/numa.h>
240 
241 #define arch_pfn_to_nid(pfn)	PFN_TO_NID(pfn)
242 #define arch_local_page_offset(pfn, nid) LOCAL_MAP_NR((pfn) << PAGE_SHIFT)
243 
244 #define pfn_valid(pfn)						\
245 	({							\
246 		unsigned int nid = PFN_TO_NID(pfn);		\
247 		int valid = nid < MAX_NUMNODES;			\
248 		if (valid) {					\
249 			pg_data_t *node = NODE_DATA(nid);	\
250 			valid = (pfn - node->node_start_pfn) <	\
251 				node->node_spanned_pages;	\
252 		}						\
253 		valid;						\
254 	})
255 
256 #define virt_to_page(kaddr)					\
257 	(ADDR_TO_MAPBASE(kaddr) + LOCAL_MAP_NR(kaddr))
258 
259 #define virt_addr_valid(kaddr)	(KVADDR_TO_NID(kaddr) < MAX_NUMNODES)
260 
261 /*
262  * Common discontigmem stuff.
263  *  PHYS_TO_NID is used by the ARM kernel/setup.c
264  */
265 #define PHYS_TO_NID(addr)	PFN_TO_NID((addr) >> PAGE_SHIFT)
266 
267 /*
268  * Given a kaddr, ADDR_TO_MAPBASE finds the owning node of the memory
269  * and returns the mem_map of that node.
270  */
271 #define ADDR_TO_MAPBASE(kaddr)	NODE_MEM_MAP(KVADDR_TO_NID(kaddr))
272 
273 /*
274  * Given a page frame number, find the owning node of the memory
275  * and returns the mem_map of that node.
276  */
277 #define PFN_TO_MAPBASE(pfn)	NODE_MEM_MAP(PFN_TO_NID(pfn))
278 
279 #ifdef NODE_MEM_SIZE_BITS
280 #define NODE_MEM_SIZE_MASK	((1 << NODE_MEM_SIZE_BITS) - 1)
281 
282 /*
283  * Given a kernel address, find the home node of the underlying memory.
284  */
285 #define KVADDR_TO_NID(addr) \
286 	(((unsigned long)(addr) - PAGE_OFFSET) >> NODE_MEM_SIZE_BITS)
287 
288 /*
289  * Given a page frame number, convert it to a node id.
290  */
291 #define PFN_TO_NID(pfn) \
292 	(((pfn) - PHYS_PFN_OFFSET) >> (NODE_MEM_SIZE_BITS - PAGE_SHIFT))
293 
294 /*
295  * Given a kaddr, LOCAL_MEM_MAP finds the owning node of the memory
296  * and returns the index corresponding to the appropriate page in the
297  * node's mem_map.
298  */
299 #define LOCAL_MAP_NR(addr) \
300 	(((unsigned long)(addr) & NODE_MEM_SIZE_MASK) >> PAGE_SHIFT)
301 
302 #endif /* NODE_MEM_SIZE_BITS */
303 
304 #endif /* !CONFIG_DISCONTIGMEM */
305 
306 /*
307  * For BIO.  "will die".  Kill me when bio_to_phys() and bvec_to_phys() die.
308  */
309 #define page_to_phys(page)	(page_to_pfn(page) << PAGE_SHIFT)
310 
311 /*
312  * Optional coherency support.  Currently used only by selected
313  * Intel XSC3-based systems.
314  */
315 #ifndef arch_is_coherent
316 #define arch_is_coherent()		0
317 #endif
318 
319 #endif
320 
321 #include <asm-generic/memory_model.h>
322 
323 #endif
324