2 * linux/include/asm-arm/cacheflush.h
4 * Copyright (C) 1999-2002 Russell King
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 #ifndef _ASMARM_CACHEFLUSH_H
11 #define _ASMARM_CACHEFLUSH_H
13 #include <linux/sched.h>
17 #include <asm/shmparam.h>
19 #define CACHE_COLOUR(vaddr) ((vaddr & (SHMLBA - 1)) >> PAGE_SHIFT)
28 #if defined(CONFIG_CPU_ARM610) || defined(CONFIG_CPU_ARM710)
30 # define MULTI_CACHE 1
36 #if defined(CONFIG_CPU_ARM720T)
38 # define MULTI_CACHE 1
44 #if defined(CONFIG_CPU_ARM920T) || defined(CONFIG_CPU_ARM922T) || \
45 defined(CONFIG_CPU_ARM925T) || defined(CONFIG_CPU_ARM1020)
46 # define MULTI_CACHE 1
49 #if defined(CONFIG_CPU_ARM926T)
51 # define MULTI_CACHE 1
53 # define _CACHE arm926
57 #if defined(CONFIG_CPU_SA110) || defined(CONFIG_CPU_SA1100)
59 # define MULTI_CACHE 1
65 #if defined(CONFIG_CPU_XSCALE)
67 # define MULTI_CACHE 1
69 # define _CACHE xscale
73 #if defined(CONFIG_CPU_XSC3)
75 # define MULTI_CACHE 1
81 #if defined(CONFIG_CPU_V6)
83 # define MULTI_CACHE 1
89 #if !defined(_CACHE) && !defined(MULTI_CACHE)
90 #error Unknown cache maintainence model
94 * This flag is used to indicate that the page pointed to by a pte
95 * is dirty and requires cleaning before returning it to the user.
97 #define PG_dcache_dirty PG_arch_1
100 * MM Cache Management
101 * ===================
103 * The arch/arm/mm/cache-*.S and arch/arm/mm/proc-*.S files
104 * implement these methods.
106 * Start addresses are inclusive and end addresses are exclusive;
107 * start addresses should be rounded down, end addresses up.
109 * See Documentation/cachetlb.txt for more information.
110 * Please note that the implementation of these, and the required
111 * effects are cache-type (VIVT/VIPT/PIPT) specific.
113 * flush_cache_kern_all()
115 * Unconditionally clean and invalidate the entire cache.
117 * flush_cache_user_mm(mm)
119 * Clean and invalidate all user space cache entries
120 * before a change of page tables.
122 * flush_cache_user_range(start, end, flags)
124 * Clean and invalidate a range of cache entries in the
125 * specified address space before a change of page tables.
126 * - start - user start address (inclusive, page aligned)
127 * - end - user end address (exclusive, page aligned)
128 * - flags - vma->vm_flags field
130 * coherent_kern_range(start, end)
132 * Ensure coherency between the Icache and the Dcache in the
133 * region described by start, end. If you have non-snooping
134 * Harvard caches, you need to implement this function.
135 * - start - virtual start address
136 * - end - virtual end address
138 * DMA Cache Coherency
139 * ===================
141 * dma_inv_range(start, end)
143 * Invalidate (discard) the specified virtual address range.
144 * May not write back any entries. If 'start' or 'end'
145 * are not cache line aligned, those lines must be written
147 * - start - virtual start address
148 * - end - virtual end address
150 * dma_clean_range(start, end)
152 * Clean (write back) the specified virtual address range.
153 * - start - virtual start address
154 * - end - virtual end address
156 * dma_flush_range(start, end)
158 * Clean and invalidate the specified virtual address range.
159 * - start - virtual start address
160 * - end - virtual end address
163 struct cpu_cache_fns {
164 void (*flush_kern_all)(void);
165 void (*flush_user_all)(void);
166 void (*flush_user_range)(unsigned long, unsigned long, unsigned int);
168 void (*coherent_kern_range)(unsigned long, unsigned long);
169 void (*coherent_user_range)(unsigned long, unsigned long);
170 void (*flush_kern_dcache_page)(void *);
172 void (*dma_inv_range)(unsigned long, unsigned long);
173 void (*dma_clean_range)(unsigned long, unsigned long);
174 void (*dma_flush_range)(unsigned long, unsigned long);
178 * Select the calling method
182 extern struct cpu_cache_fns cpu_cache;
184 #define __cpuc_flush_kern_all cpu_cache.flush_kern_all
185 #define __cpuc_flush_user_all cpu_cache.flush_user_all
186 #define __cpuc_flush_user_range cpu_cache.flush_user_range
187 #define __cpuc_coherent_kern_range cpu_cache.coherent_kern_range
188 #define __cpuc_coherent_user_range cpu_cache.coherent_user_range
189 #define __cpuc_flush_dcache_page cpu_cache.flush_kern_dcache_page
192 * These are private to the dma-mapping API. Do not use directly.
193 * Their sole purpose is to ensure that data held in the cache
194 * is visible to DMA, or data written by DMA to system memory is
195 * visible to the CPU.
197 #define dmac_inv_range cpu_cache.dma_inv_range
198 #define dmac_clean_range cpu_cache.dma_clean_range
199 #define dmac_flush_range cpu_cache.dma_flush_range
203 #define __cpuc_flush_kern_all __glue(_CACHE,_flush_kern_cache_all)
204 #define __cpuc_flush_user_all __glue(_CACHE,_flush_user_cache_all)
205 #define __cpuc_flush_user_range __glue(_CACHE,_flush_user_cache_range)
206 #define __cpuc_coherent_kern_range __glue(_CACHE,_coherent_kern_range)
207 #define __cpuc_coherent_user_range __glue(_CACHE,_coherent_user_range)
208 #define __cpuc_flush_dcache_page __glue(_CACHE,_flush_kern_dcache_page)
210 extern void __cpuc_flush_kern_all(void);
211 extern void __cpuc_flush_user_all(void);
212 extern void __cpuc_flush_user_range(unsigned long, unsigned long, unsigned int);
213 extern void __cpuc_coherent_kern_range(unsigned long, unsigned long);
214 extern void __cpuc_coherent_user_range(unsigned long, unsigned long);
215 extern void __cpuc_flush_dcache_page(void *);
218 * These are private to the dma-mapping API. Do not use directly.
219 * Their sole purpose is to ensure that data held in the cache
220 * is visible to DMA, or data written by DMA to system memory is
221 * visible to the CPU.
223 #define dmac_inv_range __glue(_CACHE,_dma_inv_range)
224 #define dmac_clean_range __glue(_CACHE,_dma_clean_range)
225 #define dmac_flush_range __glue(_CACHE,_dma_flush_range)
227 extern void dmac_inv_range(unsigned long, unsigned long);
228 extern void dmac_clean_range(unsigned long, unsigned long);
229 extern void dmac_flush_range(unsigned long, unsigned long);
234 * flush_cache_vmap() is used when creating mappings (eg, via vmap,
235 * vmalloc, ioremap etc) in kernel space for pages. Since the
236 * direct-mappings of these pages may contain cached data, we need
237 * to do a full cache flush to ensure that writebacks don't corrupt
238 * data placed into these pages via the new mappings.
240 #define flush_cache_vmap(start, end) flush_cache_all()
241 #define flush_cache_vunmap(start, end) flush_cache_all()
244 * Copy user data from/to a page which is mapped into a different
245 * processes address space. Really, we want to allow our "user
246 * space" model to handle this.
248 #define copy_to_user_page(vma, page, vaddr, dst, src, len) \
250 flush_cache_page(vma, vaddr, page_to_pfn(page));\
251 memcpy(dst, src, len); \
252 flush_dcache_page(page); \
255 #define copy_from_user_page(vma, page, vaddr, dst, src, len) \
257 flush_cache_page(vma, vaddr, page_to_pfn(page));\
258 memcpy(dst, src, len); \
262 * Convert calls to our calling convention.
264 #define flush_cache_all() __cpuc_flush_kern_all()
265 #ifndef CONFIG_CPU_CACHE_VIPT
266 static inline void flush_cache_mm(struct mm_struct *mm)
268 if (cpu_isset(smp_processor_id(), mm->cpu_vm_mask))
269 __cpuc_flush_user_all();
273 flush_cache_range(struct vm_area_struct *vma, unsigned long start, unsigned long end)
275 if (cpu_isset(smp_processor_id(), vma->vm_mm->cpu_vm_mask))
276 __cpuc_flush_user_range(start & PAGE_MASK, PAGE_ALIGN(end),
281 flush_cache_page(struct vm_area_struct *vma, unsigned long user_addr, unsigned long pfn)
283 if (cpu_isset(smp_processor_id(), vma->vm_mm->cpu_vm_mask)) {
284 unsigned long addr = user_addr & PAGE_MASK;
285 __cpuc_flush_user_range(addr, addr + PAGE_SIZE, vma->vm_flags);
289 extern void flush_cache_mm(struct mm_struct *mm);
290 extern void flush_cache_range(struct vm_area_struct *vma, unsigned long start, unsigned long end);
291 extern void flush_cache_page(struct vm_area_struct *vma, unsigned long user_addr, unsigned long pfn);
295 * flush_cache_user_range is used when we want to ensure that the
296 * Harvard caches are synchronised for the user space address range.
297 * This is used for the ARM private sys_cacheflush system call.
299 #define flush_cache_user_range(vma,start,end) \
300 __cpuc_coherent_user_range((start) & PAGE_MASK, PAGE_ALIGN(end))
303 * Perform necessary cache operations to ensure that data previously
304 * stored within this range of addresses can be executed by the CPU.
306 #define flush_icache_range(s,e) __cpuc_coherent_kern_range(s,e)
309 * Perform necessary cache operations to ensure that the TLB will
310 * see data written in the specified area.
312 #define clean_dcache_area(start,size) cpu_dcache_clean_area(start, size)
315 * flush_dcache_page is used when the kernel has written to the page
316 * cache page at virtual address page->virtual.
318 * If this page isn't mapped (ie, page_mapping == NULL), or it might
319 * have userspace mappings, then we _must_ always clean + invalidate
320 * the dcache entries associated with the kernel mapping.
322 * Otherwise we can defer the operation, and clean the cache when we are
323 * about to change to user space. This is the same method as used on SPARC64.
324 * See update_mmu_cache for the user space part.
326 extern void flush_dcache_page(struct page *);
328 #define flush_dcache_mmap_lock(mapping) \
329 write_lock_irq(&(mapping)->tree_lock)
330 #define flush_dcache_mmap_unlock(mapping) \
331 write_unlock_irq(&(mapping)->tree_lock)
333 #define flush_icache_user_range(vma,page,addr,len) \
334 flush_dcache_page(page)
337 * We don't appear to need to do anything here. In fact, if we did, we'd
338 * duplicate cache flushing elsewhere performed by flush_dcache_page().
340 #define flush_icache_page(vma,page) do { } while (0)
342 #define __cacheid_present(val) (val != read_cpuid(CPUID_ID))
343 #define __cacheid_vivt(val) ((val & (15 << 25)) != (14 << 25))
344 #define __cacheid_vipt(val) ((val & (15 << 25)) == (14 << 25))
345 #define __cacheid_vipt_nonaliasing(val) ((val & (15 << 25 | 1 << 23)) == (14 << 25))
346 #define __cacheid_vipt_aliasing(val) ((val & (15 << 25 | 1 << 23)) == (14 << 25 | 1 << 23))
348 #if defined(CONFIG_CPU_CACHE_VIVT) && !defined(CONFIG_CPU_CACHE_VIPT)
350 #define cache_is_vivt() 1
351 #define cache_is_vipt() 0
352 #define cache_is_vipt_nonaliasing() 0
353 #define cache_is_vipt_aliasing() 0
355 #elif defined(CONFIG_CPU_CACHE_VIPT)
357 #define cache_is_vivt() 0
358 #define cache_is_vipt() 1
359 #define cache_is_vipt_nonaliasing() \
361 unsigned int __val = read_cpuid(CPUID_CACHETYPE); \
362 __cacheid_vipt_nonaliasing(__val); \
365 #define cache_is_vipt_aliasing() \
367 unsigned int __val = read_cpuid(CPUID_CACHETYPE); \
368 __cacheid_vipt_aliasing(__val); \
373 #define cache_is_vivt() \
375 unsigned int __val = read_cpuid(CPUID_CACHETYPE); \
376 (!__cacheid_present(__val)) || __cacheid_vivt(__val); \
379 #define cache_is_vipt() \
381 unsigned int __val = read_cpuid(CPUID_CACHETYPE); \
382 __cacheid_present(__val) && __cacheid_vipt(__val); \
385 #define cache_is_vipt_nonaliasing() \
387 unsigned int __val = read_cpuid(CPUID_CACHETYPE); \
388 __cacheid_present(__val) && \
389 __cacheid_vipt_nonaliasing(__val); \
392 #define cache_is_vipt_aliasing() \
394 unsigned int __val = read_cpuid(CPUID_CACHETYPE); \
395 __cacheid_present(__val) && \
396 __cacheid_vipt_aliasing(__val); \