arch/arm/include/asm/cacheflush.h

   1 /*
   2  *  arch/arm/include/asm/cacheflush.h
   3  *
   4  *  Copyright (C) 1999-2002 Russell King
   5  *
   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.
   9  */
  10 #ifndef _ASMARM_CACHEFLUSH_H
  11 #define _ASMARM_CACHEFLUSH_H
  12
  13 #include <linux/mm.h>
  14
  15 #include <asm/glue.h>
  16 #include <asm/shmparam.h>
  17 #include <asm/cachetype.h>
  18
  19 #define CACHE_COLOUR(vaddr)     ((vaddr & (SHMLBA - 1)) >> PAGE_SHIFT)
  20
  21 /*
  22  *      Cache Model
  23  *      ===========
  24  */
  25 #undef _CACHE
  26 #undef MULTI_CACHE
  27
  28 #if defined(CONFIG_CPU_CACHE_V3)
  29 # ifdef _CACHE
  30 #  define MULTI_CACHE 1
  31 # else
  32 #  define _CACHE v3
  33 # endif
  34 #endif
  35
  36 #if defined(CONFIG_CPU_CACHE_V4)
  37 # ifdef _CACHE
  38 #  define MULTI_CACHE 1
  39 # else
  40 #  define _CACHE v4
  41 # endif
  42 #endif
  43
  44 #if defined(CONFIG_CPU_ARM920T) || defined(CONFIG_CPU_ARM922T) || \
  45     defined(CONFIG_CPU_ARM925T) || defined(CONFIG_CPU_ARM1020)
  46 # define MULTI_CACHE 1
  47 #endif
  48
  49 #if defined(CONFIG_CPU_FA526)
  50 # ifdef _CACHE
  51 #  define MULTI_CACHE 1
  52 # else
  53 #  define _CACHE fa
  54 # endif
  55 #endif
  56
  57 #if defined(CONFIG_CPU_ARM926T)
  58 # ifdef _CACHE
  59 #  define MULTI_CACHE 1
  60 # else
  61 #  define _CACHE arm926
  62 # endif
  63 #endif
  64
  65 #if defined(CONFIG_CPU_ARM940T)
  66 # ifdef _CACHE
  67 #  define MULTI_CACHE 1
  68 # else
  69 #  define _CACHE arm940
  70 # endif
  71 #endif
  72
  73 #if defined(CONFIG_CPU_ARM946E)
  74 # ifdef _CACHE
  75 #  define MULTI_CACHE 1
  76 # else
  77 #  define _CACHE arm946
  78 # endif
  79 #endif
  80
  81 #if defined(CONFIG_CPU_CACHE_V4WB)
  82 # ifdef _CACHE
  83 #  define MULTI_CACHE 1
  84 # else
  85 #  define _CACHE v4wb
  86 # endif
  87 #endif
  88
  89 #if defined(CONFIG_CPU_XSCALE)
  90 # ifdef _CACHE
  91 #  define MULTI_CACHE 1
  92 # else
  93 #  define _CACHE xscale
  94 # endif
  95 #endif
  96
  97 #if defined(CONFIG_CPU_XSC3)
  98 # ifdef _CACHE
  99 #  define MULTI_CACHE 1
 100 # else
 101 #  define _CACHE xsc3
 102 # endif
 103 #endif
 104
 105 #if defined(CONFIG_CPU_MOHAWK)
 106 # ifdef _CACHE
 107 #  define MULTI_CACHE 1
 108 # else
 109 #  define _CACHE mohawk
 110 # endif
 111 #endif
 112
 113 #if defined(CONFIG_CPU_FEROCEON)
 114 # define MULTI_CACHE 1
 115 #endif
 116
 117 #if defined(CONFIG_CPU_V6)
 118 //# ifdef _CACHE
 119 #  define MULTI_CACHE 1
 120 //# else
 121 //#  define _CACHE v6
 122 //# endif
 123 #endif
 124
 125 #if defined(CONFIG_CPU_V7)
 126 //# ifdef _CACHE
 127 #  define MULTI_CACHE 1
 128 //# else
 129 //#  define _CACHE v7
 130 //# endif
 131 #endif
 132
 133 #if !defined(_CACHE) && !defined(MULTI_CACHE)
 134 #error Unknown cache maintainence model
 135 #endif
 136
 137 /*
 138  * This flag is used to indicate that the page pointed to by a pte
 139  * is dirty and requires cleaning before returning it to the user.
 140  */
 141 #define PG_dcache_dirty PG_arch_1
 142
 143 /*
 144  *      MM Cache Management
 145  *      ===================
 146  *
 147  *      The arch/arm/mm/cache-*.S and arch/arm/mm/proc-*.S files
 148  *      implement these methods.
 149  *
 150  *      Start addresses are inclusive and end addresses are exclusive;
 151  *      start addresses should be rounded down, end addresses up.
 152  *
 153  *      See Documentation/cachetlb.txt for more information.
 154  *      Please note that the implementation of these, and the required
 155  *      effects are cache-type (VIVT/VIPT/PIPT) specific.
 156  *
 157  *      flush_cache_kern_all()
 158  *
 159  *              Unconditionally clean and invalidate the entire cache.
 160  *
 161  *      flush_cache_user_mm(mm)
 162  *
 163  *              Clean and invalidate all user space cache entries
 164  *              before a change of page tables.
 165  *
 166  *      flush_cache_user_range(start, end, flags)
 167  *
 168  *              Clean and invalidate a range of cache entries in the
 169  *              specified address space before a change of page tables.
 170  *              - start - user start address (inclusive, page aligned)
 171  *              - end   - user end address   (exclusive, page aligned)
 172  *              - flags - vma->vm_flags field
 173  *
 174  *      coherent_kern_range(start, end)
 175  *
 176  *              Ensure coherency between the Icache and the Dcache in the
 177  *              region described by start, end.  If you have non-snooping
 178  *              Harvard caches, you need to implement this function.
 179  *              - start  - virtual start address
 180  *              - end    - virtual end address
 181  *
 182  *      DMA Cache Coherency
 183  *      ===================
 184  *
 185  *      dma_flush_range(start, end)
 186  *
 187  *              Clean and invalidate the specified virtual address range.
 188  *              - start  - virtual start address
 189  *              - end    - virtual end address
 190  */
 191
 192 struct cpu_cache_fns {
 193         void (*flush_kern_all)(void);
 194         void (*flush_user_all)(void);
 195         void (*flush_user_range)(unsigned long, unsigned long, unsigned int);
 196
 197         void (*coherent_kern_range)(unsigned long, unsigned long);
 198         void (*coherent_user_range)(unsigned long, unsigned long);
 199         void (*flush_kern_dcache_area)(void *, size_t);
 200
 201         void (*dma_map_area)(const void *, size_t, int);
 202         void (*dma_unmap_area)(const void *, size_t, int);
 203
 204         void (*dma_flush_range)(const void *, const void *);
 205 };
 206
 207 struct outer_cache_fns {
 208         void (*inv_range)(unsigned long, unsigned long);
 209         void (*clean_range)(unsigned long, unsigned long);
 210         void (*flush_range)(unsigned long, unsigned long);
 211 };
 212
 213 /*
 214  * Select the calling method
 215  */
 216 #ifdef MULTI_CACHE
 217
 218 extern struct cpu_cache_fns cpu_cache;
 219
 220 #define __cpuc_flush_kern_all           cpu_cache.flush_kern_all
 221 #define __cpuc_flush_user_all           cpu_cache.flush_user_all
 222 #define __cpuc_flush_user_range         cpu_cache.flush_user_range
 223 #define __cpuc_coherent_kern_range      cpu_cache.coherent_kern_range
 224 #define __cpuc_coherent_user_range      cpu_cache.coherent_user_range
 225 #define __cpuc_flush_dcache_area        cpu_cache.flush_kern_dcache_area
 226
 227 /*
 228  * These are private to the dma-mapping API.  Do not use directly.
 229  * Their sole purpose is to ensure that data held in the cache
 230  * is visible to DMA, or data written by DMA to system memory is
 231  * visible to the CPU.
 232  */
 233 #define dmac_map_area                   cpu_cache.dma_map_area
 234 #define dmac_unmap_area         cpu_cache.dma_unmap_area
 235 #define dmac_flush_range                cpu_cache.dma_flush_range
 236
 237 #else
 238
 239 #define __cpuc_flush_kern_all           __glue(_CACHE,_flush_kern_cache_all)
 240 #define __cpuc_flush_user_all           __glue(_CACHE,_flush_user_cache_all)
 241 #define __cpuc_flush_user_range         __glue(_CACHE,_flush_user_cache_range)
 242 #define __cpuc_coherent_kern_range      __glue(_CACHE,_coherent_kern_range)
 243 #define __cpuc_coherent_user_range      __glue(_CACHE,_coherent_user_range)
 244 #define __cpuc_flush_dcache_area        __glue(_CACHE,_flush_kern_dcache_area)
 245
 246 extern void __cpuc_flush_kern_all(void);
 247 extern void __cpuc_flush_user_all(void);
 248 extern void __cpuc_flush_user_range(unsigned long, unsigned long, unsigned int);
 249 extern void __cpuc_coherent_kern_range(unsigned long, unsigned long);
 250 extern void __cpuc_coherent_user_range(unsigned long, unsigned long);
 251 extern void __cpuc_flush_dcache_area(void *, size_t);
 252
 253 /*
 254  * These are private to the dma-mapping API.  Do not use directly.
 255  * Their sole purpose is to ensure that data held in the cache
 256  * is visible to DMA, or data written by DMA to system memory is
 257  * visible to the CPU.
 258  */
 259 #define dmac_map_area                   __glue(_CACHE,_dma_map_area)
 260 #define dmac_unmap_area         __glue(_CACHE,_dma_unmap_area)
 261 #define dmac_flush_range                __glue(_CACHE,_dma_flush_range)
 262
 263 extern void dmac_map_area(const void *, size_t, int);
 264 extern void dmac_unmap_area(const void *, size_t, int);
 265 extern void dmac_flush_range(const void *, const void *);
 266
 267 #endif
 268
 269 #ifdef CONFIG_OUTER_CACHE
 270
 271 extern struct outer_cache_fns outer_cache;
 272
 273 static inline void outer_inv_range(unsigned long start, unsigned long end)
 274 {
 275         if (outer_cache.inv_range)
 276                 outer_cache.inv_range(start, end);
 277 }
 278 static inline void outer_clean_range(unsigned long start, unsigned long end)
 279 {
 280         if (outer_cache.clean_range)
 281                 outer_cache.clean_range(start, end);
 282 }
 283 static inline void outer_flush_range(unsigned long start, unsigned long end)
 284 {
 285         if (outer_cache.flush_range)
 286                 outer_cache.flush_range(start, end);
 287 }
 288
 289 #else
 290
 291 static inline void outer_inv_range(unsigned long start, unsigned long end)
 292 { }
 293 static inline void outer_clean_range(unsigned long start, unsigned long end)
 294 { }
 295 static inline void outer_flush_range(unsigned long start, unsigned long end)
 296 { }
 297
 298 #endif
 299
 300 /*
 301  * Copy user data from/to a page which is mapped into a different
 302  * processes address space.  Really, we want to allow our "user
 303  * space" model to handle this.
 304  */
 305 extern void copy_to_user_page(struct vm_area_struct *, struct page *,
 306         unsigned long, void *, const void *, unsigned long);
 307 #define copy_from_user_page(vma, page, vaddr, dst, src, len) \
 308         do {                                                    \
 309                 memcpy(dst, src, len);                          \
 310         } while (0)
 311
 312 /*
 313  * Convert calls to our calling convention.
 314  */
 315 #define flush_cache_all()               __cpuc_flush_kern_all()
 316
 317 static inline void vivt_flush_cache_mm(struct mm_struct *mm)
 318 {
 319         if (cpumask_test_cpu(smp_processor_id(), mm_cpumask(mm)))
 320                 __cpuc_flush_user_all();
 321 }
 322
 323 static inline void
 324 vivt_flush_cache_range(struct vm_area_struct *vma, unsigned long start, unsigned long end)
 325 {
 326         if (cpumask_test_cpu(smp_processor_id(), mm_cpumask(vma->vm_mm)))
 327                 __cpuc_flush_user_range(start & PAGE_MASK, PAGE_ALIGN(end),
 328                                         vma->vm_flags);
 329 }
 330
 331 static inline void
 332 vivt_flush_cache_page(struct vm_area_struct *vma, unsigned long user_addr, unsigned long pfn)
 333 {
 334         if (cpumask_test_cpu(smp_processor_id(), mm_cpumask(vma->vm_mm))) {
 335                 unsigned long addr = user_addr & PAGE_MASK;
 336                 __cpuc_flush_user_range(addr, addr + PAGE_SIZE, vma->vm_flags);
 337         }
 338 }
 339
 340 #ifndef CONFIG_CPU_CACHE_VIPT
 341 #define flush_cache_mm(mm) \
 342                 vivt_flush_cache_mm(mm)
 343 #define flush_cache_range(vma,start,end) \
 344                 vivt_flush_cache_range(vma,start,end)
 345 #define flush_cache_page(vma,addr,pfn) \
 346                 vivt_flush_cache_page(vma,addr,pfn)
 347 #else
 348 extern void flush_cache_mm(struct mm_struct *mm);
 349 extern void flush_cache_range(struct vm_area_struct *vma, unsigned long start, unsigned long end);
 350 extern void flush_cache_page(struct vm_area_struct *vma, unsigned long user_addr, unsigned long pfn);
 351 #endif
 352
 353 #define flush_cache_dup_mm(mm) flush_cache_mm(mm)
 354
 355 /*
 356  * flush_cache_user_range is used when we want to ensure that the
 357  * Harvard caches are synchronised for the user space address range.
 358  * This is used for the ARM private sys_cacheflush system call.
 359  */
 360 #define flush_cache_user_range(vma,start,end) \
 361         __cpuc_coherent_user_range((start) & PAGE_MASK, PAGE_ALIGN(end))
 362
 363 /*
 364  * Perform necessary cache operations to ensure that data previously
 365  * stored within this range of addresses can be executed by the CPU.
 366  */
 367 #define flush_icache_range(s,e)         __cpuc_coherent_kern_range(s,e)
 368
 369 /*
 370  * Perform necessary cache operations to ensure that the TLB will
 371  * see data written in the specified area.
 372  */
 373 #define clean_dcache_area(start,size)   cpu_dcache_clean_area(start, size)
 374
 375 /*
 376  * flush_dcache_page is used when the kernel has written to the page
 377  * cache page at virtual address page->virtual.
 378  *
 379  * If this page isn't mapped (ie, page_mapping == NULL), or it might
 380  * have userspace mappings, then we _must_ always clean + invalidate
 381  * the dcache entries associated with the kernel mapping.
 382  *
 383  * Otherwise we can defer the operation, and clean the cache when we are
 384  * about to change to user space.  This is the same method as used on SPARC64.
 385  * See update_mmu_cache for the user space part.
 386  */
 387 #define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE 1
 388 extern void flush_dcache_page(struct page *);
 389
 390 static inline void __flush_icache_all(void)
 391 {
 392 #ifdef CONFIG_ARM_ERRATA_411920
 393         extern void v6_icache_inval_all(void);
 394         v6_icache_inval_all();
 395 #else
 396         asm("mcr        p15, 0, %0, c7, c5, 0   @ invalidate I-cache\n"
 397             :
 398             : "r" (0));
 399 #endif
 400 }
 401
 402 #define ARCH_HAS_FLUSH_ANON_PAGE
 403 static inline void flush_anon_page(struct vm_area_struct *vma,
 404                          struct page *page, unsigned long vmaddr)
 405 {
 406         extern void __flush_anon_page(struct vm_area_struct *vma,
 407                                 struct page *, unsigned long);
 408         if (PageAnon(page))
 409                 __flush_anon_page(vma, page, vmaddr);
 410 }
 411
 412 #define ARCH_HAS_FLUSH_KERNEL_DCACHE_PAGE
 413 static inline void flush_kernel_dcache_page(struct page *page)
 414 {
 415         /* highmem pages are always flushed upon kunmap already */
 416         if ((cache_is_vivt() || cache_is_vipt_aliasing()) && !PageHighMem(page))
 417                 __cpuc_flush_dcache_area(page_address(page), PAGE_SIZE);
 418 }
 419
 420 #define flush_dcache_mmap_lock(mapping) \
 421         spin_lock_irq(&(mapping)->tree_lock)
 422 #define flush_dcache_mmap_unlock(mapping) \
 423         spin_unlock_irq(&(mapping)->tree_lock)
 424
 425 #define flush_icache_user_range(vma,page,addr,len) \
 426         flush_dcache_page(page)
 427
 428 /*
 429  * We don't appear to need to do anything here.  In fact, if we did, we'd
 430  * duplicate cache flushing elsewhere performed by flush_dcache_page().
 431  */
 432 #define flush_icache_page(vma,page)     do { } while (0)
 433
 434 /*
 435  * flush_cache_vmap() is used when creating mappings (eg, via vmap,
 436  * vmalloc, ioremap etc) in kernel space for pages.  On non-VIPT
 437  * caches, since the direct-mappings of these pages may contain cached
 438  * data, we need to do a full cache flush to ensure that writebacks
 439  * don't corrupt data placed into these pages via the new mappings.
 440  */
 441 static inline void flush_cache_vmap(unsigned long start, unsigned long end)
 442 {
 443         if (!cache_is_vipt_nonaliasing())
 444                 flush_cache_all();
 445         else
 446                 /*
 447                  * set_pte_at() called from vmap_pte_range() does not
 448                  * have a DSB after cleaning the cache line.
 449                  */
 450                 dsb();
 451 }
 452
 453 static inline void flush_cache_vunmap(unsigned long start, unsigned long end)
 454 {
 455         if (!cache_is_vipt_nonaliasing())
 456                 flush_cache_all();
 457 }
 458
 459 #endif