2 * Copyright 2014 Svatopluk Kraus <onwahe@gmail.com>
3 * Copyright 2014 Michal Meloun <meloun@miracle.cz>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifndef MACHINE_CPU_V6_H
30 #define MACHINE_CPU_V6_H
32 /* There are no user serviceable parts here, they may change without notice */
34 #error Only include this file in the kernel
37 #include <machine/atomic.h>
38 #include <machine/cpufunc.h>
39 #include <machine/cpuinfo.h>
40 #include <machine/sysreg.h>
43 #error Only include this file for ARMv6
46 #define CPU_ASID_KERNEL 0
48 void dcache_wbinv_poc_all(void); /* !!! NOT SMP coherent function !!! */
49 vm_offset_t dcache_wb_pou_checked(vm_offset_t, vm_size_t);
50 vm_offset_t icache_inv_pou_checked(vm_offset_t, vm_size_t);
54 #define PMU_OVSR_C 0x80000000 /* Cycle Counter */
55 extern uint32_t ccnt_hi[MAXCPU];
56 extern int pmu_attched;
61 * Macros to generate CP15 (system control processor) read/write functions.
65 #define _RF0(fname, aname...) \
66 static __inline register_t \
70 __asm __volatile("mrc\t" _FX(aname): "=r" (reg)); \
74 #define _R64F0(fname, aname) \
75 static __inline uint64_t \
79 __asm __volatile("mrrc\t" _FX(aname): "=r" (reg)); \
83 #define _WF0(fname, aname...) \
84 static __inline void \
87 __asm __volatile("mcr\t" _FX(aname)); \
90 #define _WF1(fname, aname...) \
91 static __inline void \
92 fname(register_t reg) \
94 __asm __volatile("mcr\t" _FX(aname):: "r" (reg)); \
97 #define _W64F1(fname, aname...) \
98 static __inline void \
101 __asm __volatile("mcrr\t" _FX(aname):: "r" (reg)); \
105 * Raw CP15 maintenance operations
106 * !!! not for external use !!!
111 _WF0(_CP15_TLBIALL, CP15_TLBIALL) /* Invalidate entire unified TLB */
112 #if __ARM_ARCH >= 7 && defined SMP
113 _WF0(_CP15_TLBIALLIS, CP15_TLBIALLIS) /* Invalidate entire unified TLB IS */
115 _WF1(_CP15_TLBIASID, CP15_TLBIASID(%0)) /* Invalidate unified TLB by ASID */
116 #if __ARM_ARCH >= 7 && defined SMP
117 _WF1(_CP15_TLBIASIDIS, CP15_TLBIASIDIS(%0)) /* Invalidate unified TLB by ASID IS */
119 _WF1(_CP15_TLBIMVAA, CP15_TLBIMVAA(%0)) /* Invalidate unified TLB by MVA, all ASID */
120 #if __ARM_ARCH >= 7 && defined SMP
121 _WF1(_CP15_TLBIMVAAIS, CP15_TLBIMVAAIS(%0)) /* Invalidate unified TLB by MVA, all ASID IS */
123 _WF1(_CP15_TLBIMVA, CP15_TLBIMVA(%0)) /* Invalidate unified TLB by MVA */
125 _WF1(_CP15_TTB_SET, CP15_TTBR0(%0))
127 /* Cache and Branch predictor */
129 _WF0(_CP15_BPIALL, CP15_BPIALL) /* Branch predictor invalidate all */
130 #if __ARM_ARCH >= 7 && defined SMP
131 _WF0(_CP15_BPIALLIS, CP15_BPIALLIS) /* Branch predictor invalidate all IS */
133 _WF1(_CP15_BPIMVA, CP15_BPIMVA(%0)) /* Branch predictor invalidate by MVA */
134 _WF1(_CP15_DCCIMVAC, CP15_DCCIMVAC(%0)) /* Data cache clean and invalidate by MVA PoC */
135 _WF1(_CP15_DCCISW, CP15_DCCISW(%0)) /* Data cache clean and invalidate by set/way */
136 _WF1(_CP15_DCCMVAC, CP15_DCCMVAC(%0)) /* Data cache clean by MVA PoC */
138 _WF1(_CP15_DCCMVAU, CP15_DCCMVAU(%0)) /* Data cache clean by MVA PoU */
140 _WF1(_CP15_DCCSW, CP15_DCCSW(%0)) /* Data cache clean by set/way */
141 _WF1(_CP15_DCIMVAC, CP15_DCIMVAC(%0)) /* Data cache invalidate by MVA PoC */
142 _WF1(_CP15_DCISW, CP15_DCISW(%0)) /* Data cache invalidate by set/way */
143 _WF0(_CP15_ICIALLU, CP15_ICIALLU) /* Instruction cache invalidate all PoU */
144 #if __ARM_ARCH >= 7 && defined SMP
145 _WF0(_CP15_ICIALLUIS, CP15_ICIALLUIS) /* Instruction cache invalidate all PoU IS */
147 _WF1(_CP15_ICIMVAU, CP15_ICIMVAU(%0)) /* Instruction cache invalidate */
150 * Publicly accessible functions
153 /* CP14 Debug Registers */
154 _RF0(cp14_dbgdidr_get, CP14_DBGDIDR(%0))
155 _RF0(cp14_dbgprsr_get, CP14_DBGPRSR(%0))
156 _RF0(cp14_dbgoslsr_get, CP14_DBGOSLSR(%0))
157 _RF0(cp14_dbgosdlr_get, CP14_DBGOSDLR(%0))
158 _RF0(cp14_dbgdscrint_get, CP14_DBGDSCRint(%0))
160 _WF1(cp14_dbgdscr_v6_set, CP14_DBGDSCRext_V6(%0))
161 _WF1(cp14_dbgdscr_v7_set, CP14_DBGDSCRext_V7(%0))
162 _WF1(cp14_dbgvcr_set, CP14_DBGVCR(%0))
163 _WF1(cp14_dbgoslar_set, CP14_DBGOSLAR(%0))
165 /* Various control registers */
167 _RF0(cp15_cpacr_get, CP15_CPACR(%0))
168 _WF1(cp15_cpacr_set, CP15_CPACR(%0))
169 _RF0(cp15_dfsr_get, CP15_DFSR(%0))
170 _RF0(cp15_ifsr_get, CP15_IFSR(%0))
171 _WF1(cp15_prrr_set, CP15_PRRR(%0))
172 _WF1(cp15_nmrr_set, CP15_NMRR(%0))
173 _RF0(cp15_ttbr_get, CP15_TTBR0(%0))
174 _RF0(cp15_dfar_get, CP15_DFAR(%0))
176 _RF0(cp15_ifar_get, CP15_IFAR(%0))
177 _RF0(cp15_l2ctlr_get, CP15_L2CTLR(%0))
179 _RF0(cp15_actlr_get, CP15_ACTLR(%0))
180 _WF1(cp15_actlr_set, CP15_ACTLR(%0))
181 _WF1(cp15_ats1cpr_set, CP15_ATS1CPR(%0))
182 _WF1(cp15_ats1cpw_set, CP15_ATS1CPW(%0))
183 _WF1(cp15_ats1cur_set, CP15_ATS1CUR(%0))
184 _WF1(cp15_ats1cuw_set, CP15_ATS1CUW(%0))
185 _RF0(cp15_par_get, CP15_PAR(%0))
186 _RF0(cp15_sctlr_get, CP15_SCTLR(%0))
188 /*CPU id registers */
189 _RF0(cp15_midr_get, CP15_MIDR(%0))
190 _RF0(cp15_ctr_get, CP15_CTR(%0))
191 _RF0(cp15_tcmtr_get, CP15_TCMTR(%0))
192 _RF0(cp15_tlbtr_get, CP15_TLBTR(%0))
193 _RF0(cp15_mpidr_get, CP15_MPIDR(%0))
194 _RF0(cp15_revidr_get, CP15_REVIDR(%0))
195 _RF0(cp15_ccsidr_get, CP15_CCSIDR(%0))
196 _RF0(cp15_clidr_get, CP15_CLIDR(%0))
197 _RF0(cp15_aidr_get, CP15_AIDR(%0))
198 _WF1(cp15_csselr_set, CP15_CSSELR(%0))
199 _RF0(cp15_id_pfr0_get, CP15_ID_PFR0(%0))
200 _RF0(cp15_id_pfr1_get, CP15_ID_PFR1(%0))
201 _RF0(cp15_id_dfr0_get, CP15_ID_DFR0(%0))
202 _RF0(cp15_id_afr0_get, CP15_ID_AFR0(%0))
203 _RF0(cp15_id_mmfr0_get, CP15_ID_MMFR0(%0))
204 _RF0(cp15_id_mmfr1_get, CP15_ID_MMFR1(%0))
205 _RF0(cp15_id_mmfr2_get, CP15_ID_MMFR2(%0))
206 _RF0(cp15_id_mmfr3_get, CP15_ID_MMFR3(%0))
207 _RF0(cp15_id_isar0_get, CP15_ID_ISAR0(%0))
208 _RF0(cp15_id_isar1_get, CP15_ID_ISAR1(%0))
209 _RF0(cp15_id_isar2_get, CP15_ID_ISAR2(%0))
210 _RF0(cp15_id_isar3_get, CP15_ID_ISAR3(%0))
211 _RF0(cp15_id_isar4_get, CP15_ID_ISAR4(%0))
212 _RF0(cp15_id_isar5_get, CP15_ID_ISAR5(%0))
213 _RF0(cp15_cbar_get, CP15_CBAR(%0))
215 /* Performance Monitor registers */
217 #if __ARM_ARCH == 6 && defined(CPU_ARM1176)
218 _RF0(cp15_pmuserenr_get, CP15_PMUSERENR(%0))
219 _WF1(cp15_pmuserenr_set, CP15_PMUSERENR(%0))
220 _RF0(cp15_pmcr_get, CP15_PMCR(%0))
221 _WF1(cp15_pmcr_set, CP15_PMCR(%0))
222 _RF0(cp15_pmccntr_get, CP15_PMCCNTR(%0))
223 _WF1(cp15_pmccntr_set, CP15_PMCCNTR(%0))
225 _RF0(cp15_pmcr_get, CP15_PMCR(%0))
226 _WF1(cp15_pmcr_set, CP15_PMCR(%0))
227 _RF0(cp15_pmcnten_get, CP15_PMCNTENSET(%0))
228 _WF1(cp15_pmcnten_set, CP15_PMCNTENSET(%0))
229 _WF1(cp15_pmcnten_clr, CP15_PMCNTENCLR(%0))
230 _RF0(cp15_pmovsr_get, CP15_PMOVSR(%0))
231 _WF1(cp15_pmovsr_set, CP15_PMOVSR(%0))
232 _WF1(cp15_pmswinc_set, CP15_PMSWINC(%0))
233 _RF0(cp15_pmselr_get, CP15_PMSELR(%0))
234 _WF1(cp15_pmselr_set, CP15_PMSELR(%0))
235 _RF0(cp15_pmccntr_get, CP15_PMCCNTR(%0))
236 _WF1(cp15_pmccntr_set, CP15_PMCCNTR(%0))
237 _RF0(cp15_pmxevtyper_get, CP15_PMXEVTYPER(%0))
238 _WF1(cp15_pmxevtyper_set, CP15_PMXEVTYPER(%0))
239 _RF0(cp15_pmxevcntr_get, CP15_PMXEVCNTRR(%0))
240 _WF1(cp15_pmxevcntr_set, CP15_PMXEVCNTRR(%0))
241 _RF0(cp15_pmuserenr_get, CP15_PMUSERENR(%0))
242 _WF1(cp15_pmuserenr_set, CP15_PMUSERENR(%0))
243 _RF0(cp15_pminten_get, CP15_PMINTENSET(%0))
244 _WF1(cp15_pminten_set, CP15_PMINTENSET(%0))
245 _WF1(cp15_pminten_clr, CP15_PMINTENCLR(%0))
248 _RF0(cp15_tpidrurw_get, CP15_TPIDRURW(%0))
249 _WF1(cp15_tpidrurw_set, CP15_TPIDRURW(%0))
250 _RF0(cp15_tpidruro_get, CP15_TPIDRURO(%0))
251 _WF1(cp15_tpidruro_set, CP15_TPIDRURO(%0))
252 _RF0(cp15_tpidrpwr_get, CP15_TPIDRPRW(%0))
253 _WF1(cp15_tpidrpwr_set, CP15_TPIDRPRW(%0))
255 /* Generic Timer registers - only use when you know the hardware is available */
256 _RF0(cp15_cntfrq_get, CP15_CNTFRQ(%0))
257 _WF1(cp15_cntfrq_set, CP15_CNTFRQ(%0))
258 _RF0(cp15_cntkctl_get, CP15_CNTKCTL(%0))
259 _WF1(cp15_cntkctl_set, CP15_CNTKCTL(%0))
260 _RF0(cp15_cntp_tval_get, CP15_CNTP_TVAL(%0))
261 _WF1(cp15_cntp_tval_set, CP15_CNTP_TVAL(%0))
262 _RF0(cp15_cntp_ctl_get, CP15_CNTP_CTL(%0))
263 _WF1(cp15_cntp_ctl_set, CP15_CNTP_CTL(%0))
264 _RF0(cp15_cntv_tval_get, CP15_CNTV_TVAL(%0))
265 _WF1(cp15_cntv_tval_set, CP15_CNTV_TVAL(%0))
266 _RF0(cp15_cntv_ctl_get, CP15_CNTV_CTL(%0))
267 _WF1(cp15_cntv_ctl_set, CP15_CNTV_CTL(%0))
268 _RF0(cp15_cnthctl_get, CP15_CNTHCTL(%0))
269 _WF1(cp15_cnthctl_set, CP15_CNTHCTL(%0))
270 _RF0(cp15_cnthp_tval_get, CP15_CNTHP_TVAL(%0))
271 _WF1(cp15_cnthp_tval_set, CP15_CNTHP_TVAL(%0))
272 _RF0(cp15_cnthp_ctl_get, CP15_CNTHP_CTL(%0))
273 _WF1(cp15_cnthp_ctl_set, CP15_CNTHP_CTL(%0))
275 _R64F0(cp15_cntpct_get, CP15_CNTPCT(%Q0, %R0))
276 _R64F0(cp15_cntvct_get, CP15_CNTVCT(%Q0, %R0))
277 _R64F0(cp15_cntp_cval_get, CP15_CNTP_CVAL(%Q0, %R0))
278 _W64F1(cp15_cntp_cval_set, CP15_CNTP_CVAL(%Q0, %R0))
279 _R64F0(cp15_cntv_cval_get, CP15_CNTV_CVAL(%Q0, %R0))
280 _W64F1(cp15_cntv_cval_set, CP15_CNTV_CVAL(%Q0, %R0))
281 _R64F0(cp15_cntvoff_get, CP15_CNTVOFF(%Q0, %R0))
282 _W64F1(cp15_cntvoff_set, CP15_CNTVOFF(%Q0, %R0))
283 _R64F0(cp15_cnthp_cval_get, CP15_CNTHP_CVAL(%Q0, %R0))
284 _W64F1(cp15_cnthp_cval_set, CP15_CNTHP_CVAL(%Q0, %R0))
292 * TLB maintenance operations.
295 /* Local (i.e. not broadcasting ) operations. */
297 /* Flush all TLB entries (even global). */
299 tlb_flush_all_local(void)
307 /* Flush all not global TLB entries. */
309 tlb_flush_all_ng_local(void)
313 _CP15_TLBIASID(CPU_ASID_KERNEL);
317 /* Flush single TLB entry (even global). */
319 tlb_flush_local(vm_offset_t va)
322 KASSERT((va & PAGE_MASK) == 0, ("%s: va %#x not aligned", __func__, va));
325 _CP15_TLBIMVA(va | CPU_ASID_KERNEL);
329 /* Flush range of TLB entries (even global). */
331 tlb_flush_range_local(vm_offset_t va, vm_size_t size)
333 vm_offset_t eva = va + size;
335 KASSERT((va & PAGE_MASK) == 0, ("%s: va %#x not aligned", __func__, va));
336 KASSERT((size & PAGE_MASK) == 0, ("%s: size %#x not aligned", __func__,
340 for (; va < eva; va += PAGE_SIZE)
341 _CP15_TLBIMVA(va | CPU_ASID_KERNEL);
345 /* Broadcasting operations. */
346 #if __ARM_ARCH >= 7 && defined SMP
358 tlb_flush_all_ng(void)
362 _CP15_TLBIASIDIS(CPU_ASID_KERNEL);
367 tlb_flush(vm_offset_t va)
370 KASSERT((va & PAGE_MASK) == 0, ("%s: va %#x not aligned", __func__, va));
373 _CP15_TLBIMVAAIS(va);
378 tlb_flush_range(vm_offset_t va, vm_size_t size)
380 vm_offset_t eva = va + size;
382 KASSERT((va & PAGE_MASK) == 0, ("%s: va %#x not aligned", __func__, va));
383 KASSERT((size & PAGE_MASK) == 0, ("%s: size %#x not aligned", __func__,
387 for (; va < eva; va += PAGE_SIZE)
388 _CP15_TLBIMVAAIS(va);
393 #define tlb_flush_all() tlb_flush_all_local()
394 #define tlb_flush_all_ng() tlb_flush_all_ng_local()
395 #define tlb_flush(va) tlb_flush_local(va)
396 #define tlb_flush_range(va, size) tlb_flush_range_local(va, size)
401 * Cache maintenance operations.
404 /* Sync I and D caches to PoU */
406 icache_sync(vm_offset_t va, vm_size_t size)
408 vm_offset_t eva = va + size;
411 va &= ~cpuinfo.dcache_line_mask;
412 for ( ; va < eva; va += cpuinfo.dcache_line_size) {
413 #if __ARM_ARCH >= 7 && defined SMP
420 #if __ARM_ARCH >= 7 && defined SMP
429 /* Invalidate I cache */
433 #if __ARM_ARCH >= 7 && defined SMP
442 /* Invalidate branch predictor buffer */
446 #if __ARM_ARCH >= 7 && defined SMP
455 /* Write back D-cache to PoU */
457 dcache_wb_pou(vm_offset_t va, vm_size_t size)
459 vm_offset_t eva = va + size;
462 va &= ~cpuinfo.dcache_line_mask;
463 for ( ; va < eva; va += cpuinfo.dcache_line_size) {
464 #if __ARM_ARCH >= 7 && defined SMP
474 * Invalidate D-cache to PoC
476 * Caches are invalidated from outermost to innermost as fresh cachelines
477 * flow in this direction. In given range, if there was no dirty cacheline
478 * in any cache before, no stale cacheline should remain in them after this
479 * operation finishes.
482 dcache_inv_poc(vm_offset_t va, vm_paddr_t pa, vm_size_t size)
484 vm_offset_t eva = va + size;
487 /* invalidate L2 first */
488 cpu_l2cache_inv_range(pa, size);
491 va &= ~cpuinfo.dcache_line_mask;
492 for ( ; va < eva; va += cpuinfo.dcache_line_size) {
499 * Discard D-cache lines to PoC, prior to overwrite by DMA engine.
501 * Normal invalidation does L2 then L1 to ensure that stale data from L2 doesn't
502 * flow into L1 while invalidating. This routine is intended to be used only
503 * when invalidating a buffer before a DMA operation loads new data into memory.
504 * The concern in this case is that dirty lines are not evicted to main memory,
505 * overwriting the DMA data. For that reason, the L1 is done first to ensure
506 * that an evicted L1 line doesn't flow to L2 after the L2 has been cleaned.
509 dcache_inv_poc_dma(vm_offset_t va, vm_paddr_t pa, vm_size_t size)
511 vm_offset_t eva = va + size;
513 /* invalidate L1 first */
515 va &= ~cpuinfo.dcache_line_mask;
516 for ( ; va < eva; va += cpuinfo.dcache_line_size) {
522 cpu_l2cache_inv_range(pa, size);
526 * Write back D-cache to PoC
528 * Caches are written back from innermost to outermost as dirty cachelines
529 * flow in this direction. In given range, no dirty cacheline should remain
530 * in any cache after this operation finishes.
533 dcache_wb_poc(vm_offset_t va, vm_paddr_t pa, vm_size_t size)
535 vm_offset_t eva = va + size;
538 va &= ~cpuinfo.dcache_line_mask;
539 for ( ; va < eva; va += cpuinfo.dcache_line_size) {
544 cpu_l2cache_wb_range(pa, size);
547 /* Write back and invalidate D-cache to PoC */
549 dcache_wbinv_poc(vm_offset_t sva, vm_paddr_t pa, vm_size_t size)
552 vm_offset_t eva = sva + size;
555 /* write back L1 first */
556 va = sva & ~cpuinfo.dcache_line_mask;
557 for ( ; va < eva; va += cpuinfo.dcache_line_size) {
562 /* then write back and invalidate L2 */
563 cpu_l2cache_wbinv_range(pa, size);
565 /* then invalidate L1 */
566 va = sva & ~cpuinfo.dcache_line_mask;
567 for ( ; va < eva; va += cpuinfo.dcache_line_size) {
573 /* Set TTB0 register */
575 cp15_ttbr_set(uint32_t reg)
583 tlb_flush_all_ng_local();
587 * Functions for address checking:
589 * cp15_ats1cpr_check() ... check stage 1 privileged (PL1) read access
590 * cp15_ats1cpw_check() ... check stage 1 privileged (PL1) write access
591 * cp15_ats1cur_check() ... check stage 1 unprivileged (PL0) read access
592 * cp15_ats1cuw_check() ... check stage 1 unprivileged (PL0) write access
594 * They must be called while interrupts are disabled to get consistent result.
597 cp15_ats1cpr_check(vm_offset_t addr)
600 cp15_ats1cpr_set(addr);
602 return (cp15_par_get() & 0x01 ? EFAULT : 0);
606 cp15_ats1cpw_check(vm_offset_t addr)
609 cp15_ats1cpw_set(addr);
611 return (cp15_par_get() & 0x01 ? EFAULT : 0);
615 cp15_ats1cur_check(vm_offset_t addr)
618 cp15_ats1cur_set(addr);
620 return (cp15_par_get() & 0x01 ? EFAULT : 0);
624 cp15_ats1cuw_check(vm_offset_t addr)
627 cp15_ats1cuw_set(addr);
629 return (cp15_par_get() & 0x01 ? EFAULT : 0);
631 #endif /* !__ARM_ARCH < 6 */
633 #endif /* !MACHINE_CPU_V6_H */