xref: /openbmc/linux/arch/arc/include/asm/cacheflush.h (revision 1f012283)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2004, 2007-2010, 2011-2012 Synopsys, Inc. (www.synopsys.com)
4  *
5  *  vineetg: May 2011: for Non-aliasing VIPT D-cache following can be NOPs
6  *   -flush_cache_dup_mm (fork)
7  *   -likewise for flush_cache_mm (exit/execve)
8  *   -likewise for flush_cache_{range,page} (munmap, exit, COW-break)
9  *
10  *  vineetg: April 2008
11  *   -Added a critical CacheLine flush to copy_to_user_page( ) which
12  *     was causing gdbserver to not setup breakpoints consistently
13  */
14 
15 #ifndef _ASM_CACHEFLUSH_H
16 #define _ASM_CACHEFLUSH_H
17 
18 #include <linux/mm.h>
19 #include <asm/shmparam.h>
20 
21 /*
22  * Semantically we need this because icache doesn't snoop dcache/dma.
23  * However ARC Cache flush requires paddr as well as vaddr, latter not available
24  * in the flush_icache_page() API. So we no-op it but do the equivalent work
25  * in update_mmu_cache()
26  */
27 #define flush_icache_page(vma, page)
28 
29 void flush_cache_all(void);
30 
31 void flush_icache_range(unsigned long kstart, unsigned long kend);
32 void __sync_icache_dcache(phys_addr_t paddr, unsigned long vaddr, int len);
33 void __inv_icache_page(phys_addr_t paddr, unsigned long vaddr);
34 void __flush_dcache_page(phys_addr_t paddr, unsigned long vaddr);
35 
36 #define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE 1
37 
38 void flush_dcache_page(struct page *page);
39 void flush_dcache_folio(struct folio *folio);
40 
41 void dma_cache_wback_inv(phys_addr_t start, unsigned long sz);
42 void dma_cache_inv(phys_addr_t start, unsigned long sz);
43 void dma_cache_wback(phys_addr_t start, unsigned long sz);
44 
45 #define flush_dcache_mmap_lock(mapping)		do { } while (0)
46 #define flush_dcache_mmap_unlock(mapping)	do { } while (0)
47 
48 /* TBD: optimize this */
49 #define flush_cache_vmap(start, end)		flush_cache_all()
50 #define flush_cache_vunmap(start, end)		flush_cache_all()
51 
52 #define flush_cache_dup_mm(mm)			/* called on fork (VIVT only) */
53 
54 #ifndef CONFIG_ARC_CACHE_VIPT_ALIASING
55 
56 #define flush_cache_mm(mm)			/* called on munmap/exit */
57 #define flush_cache_range(mm, u_vstart, u_vend)
58 #define flush_cache_page(vma, u_vaddr, pfn)	/* PF handling/COW-break */
59 
60 #else	/* VIPT aliasing dcache */
61 
62 /* To clear out stale userspace mappings */
63 void flush_cache_mm(struct mm_struct *mm);
64 void flush_cache_range(struct vm_area_struct *vma,
65 	unsigned long start,unsigned long end);
66 void flush_cache_page(struct vm_area_struct *vma,
67 	unsigned long user_addr, unsigned long page);
68 
69 /*
70  * To make sure that userspace mapping is flushed to memory before
71  * get_user_pages() uses a kernel mapping to access the page
72  */
73 #define ARCH_HAS_FLUSH_ANON_PAGE
74 void flush_anon_page(struct vm_area_struct *vma,
75 	struct page *page, unsigned long u_vaddr);
76 
77 #endif	/* CONFIG_ARC_CACHE_VIPT_ALIASING */
78 
79 /*
80  * A new pagecache page has PG_arch_1 clear - thus dcache dirty by default
81  * This works around some PIO based drivers which don't call flush_dcache_page
82  * to record that they dirtied the dcache
83  */
84 #define PG_dc_clean	PG_arch_1
85 
86 #define CACHE_COLORS_NUM	4
87 #define CACHE_COLORS_MSK	(CACHE_COLORS_NUM - 1)
88 #define CACHE_COLOR(addr)	(((unsigned long)(addr) >> (PAGE_SHIFT)) & CACHE_COLORS_MSK)
89 
90 /*
91  * Simple wrapper over config option
92  * Bootup code ensures that hardware matches kernel configuration
93  */
94 static inline int cache_is_vipt_aliasing(void)
95 {
96 	return IS_ENABLED(CONFIG_ARC_CACHE_VIPT_ALIASING);
97 }
98 
99 /*
100  * checks if two addresses (after page aligning) index into same cache set
101  */
102 #define addr_not_cache_congruent(addr1, addr2)				\
103 ({									\
104 	cache_is_vipt_aliasing() ? 					\
105 		(CACHE_COLOR(addr1) != CACHE_COLOR(addr2)) : 0;		\
106 })
107 
108 #define copy_to_user_page(vma, page, vaddr, dst, src, len)		\
109 do {									\
110 	memcpy(dst, src, len);						\
111 	if (vma->vm_flags & VM_EXEC)					\
112 		__sync_icache_dcache((unsigned long)(dst), vaddr, len);	\
113 } while (0)
114 
115 #define copy_from_user_page(vma, page, vaddr, dst, src, len)		\
116 	memcpy(dst, src, len);						\
117 
118 #endif
119