1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Based on arch/arm/include/asm/assembler.h, arch/arm/mm/proc-macros.S
5 * Copyright (C) 1996-2000 Russell King
6 * Copyright (C) 2012 ARM Ltd.
9 #error "Only include this from assembly code"
12 #ifndef __ASM_ASSEMBLER_H
13 #define __ASM_ASSEMBLER_H
15 #include <linux/export.h>
17 #include <asm/alternative.h>
18 #include <asm/asm-bug.h>
19 #include <asm/asm-extable.h>
20 #include <asm/asm-offsets.h>
21 #include <asm/cpufeature.h>
22 #include <asm/cputype.h>
23 #include <asm/debug-monitors.h>
25 #include <asm/pgtable-hwdef.h>
26 #include <asm/ptrace.h>
27 #include <asm/thread_info.h>
30 * Provide a wxN alias for each wN register so what we can paste a xN
31 * reference after a 'w' to obtain the 32-bit version.
33 .irp n,0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30
42 * Save/restore interrupts.
44 .macro save_and_disable_irq, flags
49 .macro restore_irq, flags
57 .macro disable_step_tsk, flgs, tmp
58 tbz \flgs, #TIF_SINGLESTEP, 9990f
60 bic \tmp, \tmp, #DBG_MDSCR_SS
62 isb // Synchronise with enable_dbg
66 /* call with daif masked */
67 .macro enable_step_tsk, flgs, tmp
68 tbz \flgs, #TIF_SINGLESTEP, 9990f
70 orr \tmp, \tmp, #DBG_MDSCR_SS
76 * RAS Error Synchronization barrier
79 #ifdef CONFIG_ARM64_RAS_EXTN
87 * Value prediction barrier
94 * Clear Branch History instruction
101 * Speculation barrier
104 alternative_if_not ARM64_HAS_SB
125 lr .req x30 // link register
136 * Select code when configured for BE.
138 #ifdef CONFIG_CPU_BIG_ENDIAN
139 #define CPU_BE(code...) code
141 #define CPU_BE(code...)
145 * Select code when configured for LE.
147 #ifdef CONFIG_CPU_BIG_ENDIAN
148 #define CPU_LE(code...)
150 #define CPU_LE(code...) code
154 * Define a macro that constructs a 64-bit value by concatenating two
155 * 32-bit registers. Note that on big endian systems the order of the
156 * registers is swapped.
158 #ifndef CONFIG_CPU_BIG_ENDIAN
159 .macro regs_to_64, rd, lbits, hbits
161 .macro regs_to_64, rd, hbits, lbits
163 orr \rd, \lbits, \hbits, lsl #32
167 * Pseudo-ops for PC-relative adr/ldr/str <reg>, <symbol> where
168 * <symbol> is within the range +/- 4 GB of the PC.
171 * @dst: destination register (64 bit wide)
172 * @sym: name of the symbol
174 .macro adr_l, dst, sym
176 add \dst, \dst, :lo12:\sym
180 * @dst: destination register (32 or 64 bit wide)
181 * @sym: name of the symbol
182 * @tmp: optional 64-bit scratch register to be used if <dst> is a
183 * 32-bit wide register, in which case it cannot be used to hold
186 .macro ldr_l, dst, sym, tmp=
189 ldr \dst, [\dst, :lo12:\sym]
192 ldr \dst, [\tmp, :lo12:\sym]
197 * @src: source register (32 or 64 bit wide)
198 * @sym: name of the symbol
199 * @tmp: mandatory 64-bit scratch register to calculate the address
200 * while <src> needs to be preserved.
202 .macro str_l, src, sym, tmp
204 str \src, [\tmp, :lo12:\sym]
208 * @dst: destination register
210 #if defined(__KVM_NVHE_HYPERVISOR__) || defined(__KVM_VHE_HYPERVISOR__)
211 .macro get_this_cpu_offset, dst
215 .macro get_this_cpu_offset, dst
216 alternative_if_not ARM64_HAS_VIRT_HOST_EXTN
223 .macro set_this_cpu_offset, src
224 alternative_if_not ARM64_HAS_VIRT_HOST_EXTN
233 * @dst: Result of per_cpu(sym, smp_processor_id()) (can be SP)
234 * @sym: The name of the per-cpu variable
235 * @tmp: scratch register
237 .macro adr_this_cpu, dst, sym, tmp
239 add \dst, \tmp, #:lo12:\sym
240 get_this_cpu_offset \tmp
245 * @dst: Result of READ_ONCE(per_cpu(sym, smp_processor_id()))
246 * @sym: The name of the per-cpu variable
247 * @tmp: scratch register
249 .macro ldr_this_cpu dst, sym, tmp
251 get_this_cpu_offset \tmp
252 ldr \dst, [\dst, \tmp]
256 * vma_vm_mm - get mm pointer from vma pointer (vma->vm_mm)
258 .macro vma_vm_mm, rd, rn
259 ldr \rd, [\rn, #VMA_VM_MM]
263 * read_ctr - read CTR_EL0. If the system has mismatched register fields,
264 * provide the system wide safe value from arm64_ftr_reg_ctrel0.sys_val
267 #ifndef __KVM_NVHE_HYPERVISOR__
268 alternative_if_not ARM64_MISMATCHED_CACHE_TYPE
269 mrs \reg, ctr_el0 // read CTR
272 ldr_l \reg, arm64_ftr_reg_ctrel0 + ARM64_FTR_SYSVAL
275 alternative_if_not ARM64_KVM_PROTECTED_MODE
277 alternative_else_nop_endif
278 alternative_cb ARM64_ALWAYS_SYSTEM, kvm_compute_final_ctr_el0
280 movk \reg, #0, lsl #16
281 movk \reg, #0, lsl #32
282 movk \reg, #0, lsl #48
289 * raw_dcache_line_size - get the minimum D-cache line size on this CPU
290 * from the CTR register.
292 .macro raw_dcache_line_size, reg, tmp
293 mrs \tmp, ctr_el0 // read CTR
294 ubfm \tmp, \tmp, #16, #19 // cache line size encoding
295 mov \reg, #4 // bytes per word
296 lsl \reg, \reg, \tmp // actual cache line size
300 * dcache_line_size - get the safe D-cache line size across all CPUs
302 .macro dcache_line_size, reg, tmp
304 ubfm \tmp, \tmp, #16, #19 // cache line size encoding
305 mov \reg, #4 // bytes per word
306 lsl \reg, \reg, \tmp // actual cache line size
310 * raw_icache_line_size - get the minimum I-cache line size on this CPU
311 * from the CTR register.
313 .macro raw_icache_line_size, reg, tmp
314 mrs \tmp, ctr_el0 // read CTR
315 and \tmp, \tmp, #0xf // cache line size encoding
316 mov \reg, #4 // bytes per word
317 lsl \reg, \reg, \tmp // actual cache line size
321 * icache_line_size - get the safe I-cache line size across all CPUs
323 .macro icache_line_size, reg, tmp
325 and \tmp, \tmp, #0xf // cache line size encoding
326 mov \reg, #4 // bytes per word
327 lsl \reg, \reg, \tmp // actual cache line size
331 * tcr_set_t0sz - update TCR.T0SZ so that we can load the ID map
333 .macro tcr_set_t0sz, valreg, t0sz
334 bfi \valreg, \t0sz, #TCR_T0SZ_OFFSET, #TCR_TxSZ_WIDTH
338 * tcr_set_t1sz - update TCR.T1SZ
340 .macro tcr_set_t1sz, valreg, t1sz
341 bfi \valreg, \t1sz, #TCR_T1SZ_OFFSET, #TCR_TxSZ_WIDTH
345 * tcr_compute_pa_size - set TCR.(I)PS to the highest supported
346 * ID_AA64MMFR0_EL1.PARange value
348 * tcr: register with the TCR_ELx value to be updated
349 * pos: IPS or PS bitfield position
350 * tmp{0,1}: temporary registers
352 .macro tcr_compute_pa_size, tcr, pos, tmp0, tmp1
353 mrs \tmp0, ID_AA64MMFR0_EL1
354 // Narrow PARange to fit the PS field in TCR_ELx
355 ubfx \tmp0, \tmp0, #ID_AA64MMFR0_EL1_PARANGE_SHIFT, #3
356 mov \tmp1, #ID_AA64MMFR0_EL1_PARANGE_MAX
358 csel \tmp0, \tmp1, \tmp0, hi
359 bfi \tcr, \tmp0, \pos, #3
362 .macro __dcache_op_workaround_clean_cache, op, addr
363 alternative_if_not ARM64_WORKAROUND_CLEAN_CACHE
371 * Macro to perform a data cache maintenance for the interval
372 * [start, end) with dcache line size explicitly provided.
374 * op: operation passed to dc instruction
375 * domain: domain used in dsb instruciton
376 * start: starting virtual address of the region
377 * end: end virtual address of the region
378 * linesz: dcache line size
379 * fixup: optional label to branch to on user fault
380 * Corrupts: start, end, tmp
382 .macro dcache_by_myline_op op, domain, start, end, linesz, tmp, fixup
383 sub \tmp, \linesz, #1
384 bic \start, \start, \tmp
387 __dcache_op_workaround_clean_cache \op, \start
390 __dcache_op_workaround_clean_cache \op, \start
393 sys 3, c7, c12, 1, \start // dc cvap
396 sys 3, c7, c13, 1, \start // dc cvadp
403 add \start, \start, \linesz
408 _cond_uaccess_extable .Ldcache_op\@, \fixup
412 * Macro to perform a data cache maintenance for the interval
415 * op: operation passed to dc instruction
416 * domain: domain used in dsb instruciton
417 * start: starting virtual address of the region
418 * end: end virtual address of the region
419 * fixup: optional label to branch to on user fault
420 * Corrupts: start, end, tmp1, tmp2
422 .macro dcache_by_line_op op, domain, start, end, tmp1, tmp2, fixup
423 dcache_line_size \tmp1, \tmp2
424 dcache_by_myline_op \op, \domain, \start, \end, \tmp1, \tmp2, \fixup
428 * Macro to perform an instruction cache maintenance for the interval
431 * start, end: virtual addresses describing the region
432 * fixup: optional label to branch to on user fault
433 * Corrupts: tmp1, tmp2
435 .macro invalidate_icache_by_line start, end, tmp1, tmp2, fixup
436 icache_line_size \tmp1, \tmp2
438 bic \tmp2, \start, \tmp2
440 ic ivau, \tmp2 // invalidate I line PoU
441 add \tmp2, \tmp2, \tmp1
447 _cond_uaccess_extable .Licache_op\@, \fixup
451 * load_ttbr1 - install @pgtbl as a TTBR1 page table
453 * tmp1/tmp2 clobbered, either may overlap with pgtbl
455 .macro load_ttbr1, pgtbl, tmp1, tmp2
456 phys_to_ttbr \tmp1, \pgtbl
457 offset_ttbr1 \tmp1, \tmp2
463 * To prevent the possibility of old and new partial table walks being visible
464 * in the tlb, switch the ttbr to a zero page when we invalidate the old
465 * records. D4.7.1 'General TLB maintenance requirements' in ARM DDI 0487A.i
466 * Even switching to our copied tables will cause a changed output address at
467 * each stage of the walk.
469 .macro break_before_make_ttbr_switch zero_page, page_table, tmp, tmp2
470 phys_to_ttbr \tmp, \zero_page
475 load_ttbr1 \page_table, \tmp, \tmp2
479 * reset_pmuserenr_el0 - reset PMUSERENR_EL0 if PMUv3 present
481 .macro reset_pmuserenr_el0, tmpreg
482 mrs \tmpreg, id_aa64dfr0_el1
483 sbfx \tmpreg, \tmpreg, #ID_AA64DFR0_EL1_PMUVer_SHIFT, #4
484 cmp \tmpreg, #1 // Skip if no PMU present
486 msr pmuserenr_el0, xzr // Disable PMU access from EL0
491 * reset_amuserenr_el0 - reset AMUSERENR_EL0 if AMUv1 present
493 .macro reset_amuserenr_el0, tmpreg
494 mrs \tmpreg, id_aa64pfr0_el1 // Check ID_AA64PFR0_EL1
495 ubfx \tmpreg, \tmpreg, #ID_AA64PFR0_EL1_AMU_SHIFT, #4
496 cbz \tmpreg, .Lskip_\@ // Skip if no AMU present
497 msr_s SYS_AMUSERENR_EL0, xzr // Disable AMU access from EL0
501 * copy_page - copy src to dest using temp registers t1-t8
503 .macro copy_page dest:req src:req t1:req t2:req t3:req t4:req t5:req t6:req t7:req t8:req
504 9998: ldp \t1, \t2, [\src]
505 ldp \t3, \t4, [\src, #16]
506 ldp \t5, \t6, [\src, #32]
507 ldp \t7, \t8, [\src, #48]
509 stnp \t1, \t2, [\dest]
510 stnp \t3, \t4, [\dest, #16]
511 stnp \t5, \t6, [\dest, #32]
512 stnp \t7, \t8, [\dest, #48]
513 add \dest, \dest, #64
514 tst \src, #(PAGE_SIZE - 1)
519 * Annotate a function as being unsuitable for kprobes.
521 #ifdef CONFIG_KPROBES
522 #define NOKPROBE(x) \
523 .pushsection "_kprobe_blacklist", "aw"; \
530 #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
531 #define EXPORT_SYMBOL_NOKASAN(name)
533 #define EXPORT_SYMBOL_NOKASAN(name) EXPORT_SYMBOL(name)
537 * Emit a 64-bit absolute little endian symbol reference in a way that
538 * ensures that it will be resolved at build time, even when building a
539 * PIE binary. This requires cooperation from the linker script, which
540 * must emit the lo32/hi32 halves individually.
548 * mov_q - move an immediate constant into a 64-bit register using
549 * between 2 and 4 movz/movk instructions (depending on the
550 * magnitude and sign of the operand)
552 .macro mov_q, reg, val
553 .if (((\val) >> 31) == 0 || ((\val) >> 31) == 0x1ffffffff)
554 movz \reg, :abs_g1_s:\val
556 .if (((\val) >> 47) == 0 || ((\val) >> 47) == 0x1ffff)
557 movz \reg, :abs_g2_s:\val
559 movz \reg, :abs_g3:\val
560 movk \reg, :abs_g2_nc:\val
562 movk \reg, :abs_g1_nc:\val
564 movk \reg, :abs_g0_nc:\val
568 * Return the current task_struct.
570 .macro get_current_task, rd
575 * If the kernel is built for 52-bit virtual addressing but the hardware only
576 * supports 48 bits, we cannot program the pgdir address into TTBR1 directly,
577 * but we have to add an offset so that the TTBR1 address corresponds with the
578 * pgdir entry that covers the lowest 48-bit addressable VA.
580 * Note that this trick is only used for LVA/64k pages - LPA2/4k pages uses an
581 * additional paging level, and on LPA2/16k pages, we would end up with a root
582 * level table with only 2 entries, which is suboptimal in terms of TLB
583 * utilization, so there we fall back to 47 bits of translation if LPA2 is not
586 * orr is used as it can cover the immediate value (and is idempotent).
587 * ttbr: Value of ttbr to set, modified.
589 .macro offset_ttbr1, ttbr, tmp
590 #if defined(CONFIG_ARM64_VA_BITS_52) && !defined(CONFIG_ARM64_LPA2)
592 and \tmp, \tmp, #TCR_T1SZ_MASK
593 cmp \tmp, #TCR_T1SZ(VA_BITS_MIN)
594 orr \tmp, \ttbr, #TTBR1_BADDR_4852_OFFSET
595 csel \ttbr, \tmp, \ttbr, eq
600 * Arrange a physical address in a TTBR register, taking care of 52-bit
603 * phys: physical address, preserved
604 * ttbr: returns the TTBR value
606 .macro phys_to_ttbr, ttbr, phys
607 #ifdef CONFIG_ARM64_PA_BITS_52
608 orr \ttbr, \phys, \phys, lsr #46
609 and \ttbr, \ttbr, #TTBR_BADDR_MASK_52
615 .macro phys_to_pte, pte, phys
616 #ifdef CONFIG_ARM64_PA_BITS_52
617 orr \pte, \phys, \phys, lsr #PTE_ADDR_HIGH_SHIFT
618 and \pte, \pte, #PHYS_TO_PTE_ADDR_MASK
625 * tcr_clear_errata_bits - Clear TCR bits that trigger an errata on this CPU.
627 .macro tcr_clear_errata_bits, tcr, tmp1, tmp2
628 #ifdef CONFIG_FUJITSU_ERRATUM_010001
631 mov_q \tmp2, MIDR_FUJITSU_ERRATUM_010001_MASK
632 and \tmp1, \tmp1, \tmp2
633 mov_q \tmp2, MIDR_FUJITSU_ERRATUM_010001
637 mov_q \tmp2, TCR_CLEAR_FUJITSU_ERRATUM_010001
638 bic \tcr, \tcr, \tmp2
640 #endif /* CONFIG_FUJITSU_ERRATUM_010001 */
644 * Errata workaround prior to disable MMU. Insert an ISB immediately prior
645 * to executing the MSR that will change SCTLR_ELn[M] from a value of 1 to 0.
647 .macro pre_disable_mmu_workaround
648 #ifdef CONFIG_QCOM_FALKOR_ERRATUM_E1041
654 * frame_push - Push @regcount callee saved registers to the stack,
655 * starting at x19, as well as x29/x30, and set x29 to
656 * the new value of sp. Add @extra bytes of stack space
659 .macro frame_push, regcount:req, extra
660 __frame st, \regcount, \extra
664 * frame_pop - Pop the callee saved registers from the stack that were
665 * pushed in the most recent call to frame_push, as well
666 * as x29/x30 and any extra stack space that may have been
673 .macro __frame_regs, reg1, reg2, op, num
674 .if .Lframe_regcount == \num
675 \op\()r \reg1, [sp, #(\num + 1) * 8]
676 .elseif .Lframe_regcount > \num
677 \op\()p \reg1, \reg2, [sp, #(\num + 1) * 8]
681 .macro __frame, op, regcount, extra=0
683 .if (\regcount) < 0 || (\regcount) > 10
684 .error "regcount should be in the range [0 ... 10]"
686 .if ((\extra) % 16) != 0
687 .error "extra should be a multiple of 16 bytes"
689 .ifdef .Lframe_regcount
690 .if .Lframe_regcount != -1
691 .error "frame_push/frame_pop may not be nested"
694 .set .Lframe_regcount, \regcount
695 .set .Lframe_extra, \extra
696 .set .Lframe_local_offset, ((\regcount + 3) / 2) * 16
697 stp x29, x30, [sp, #-.Lframe_local_offset - .Lframe_extra]!
701 __frame_regs x19, x20, \op, 1
702 __frame_regs x21, x22, \op, 3
703 __frame_regs x23, x24, \op, 5
704 __frame_regs x25, x26, \op, 7
705 __frame_regs x27, x28, \op, 9
708 .if .Lframe_regcount == -1
709 .error "frame_push/frame_pop may not be nested"
711 ldp x29, x30, [sp], #.Lframe_local_offset + .Lframe_extra
712 .set .Lframe_regcount, -1
717 * Set SCTLR_ELx to the @reg value, and invalidate the local icache
718 * in the process. This is called when setting the MMU on.
720 .macro set_sctlr, sreg, reg
724 * Invalidate the local I-cache so that any instructions fetched
725 * speculatively from the PoC are discarded, since they may have
726 * been dynamically patched at the PoU.
733 .macro set_sctlr_el1, reg
734 set_sctlr sctlr_el1, \reg
737 .macro set_sctlr_el2, reg
738 set_sctlr sctlr_el2, \reg
742 * Check whether asm code should yield as soon as it is able. This is
743 * the case if we are currently running in task context, and the
744 * TIF_NEED_RESCHED flag is set. (Note that the TIF_NEED_RESCHED flag
745 * is stored negated in the top word of the thread_info::preempt_count
748 .macro cond_yield, lbl:req, tmp:req, tmp2
749 #ifdef CONFIG_PREEMPT_VOLUNTARY
750 get_current_task \tmp
751 ldr \tmp, [\tmp, #TSK_TI_PREEMPT]
753 * If we are serving a softirq, there is no point in yielding: the
754 * softirq will not be preempted no matter what we do, so we should
755 * run to completion as quickly as we can. The preempt_count field will
756 * have BIT(SOFTIRQ_SHIFT) set in this case, so the zero check will
757 * catch this case too.
764 * Branch Target Identifier (BTI)
767 .equ .L__bti_targets_c, 34
768 .equ .L__bti_targets_j, 36
769 .equ .L__bti_targets_jc,38
770 hint #.L__bti_targets_\targets
774 * This macro emits a program property note section identifying
775 * architecture features which require special handling, mainly for
776 * use in assembly files included in the VDSO.
779 #define NT_GNU_PROPERTY_TYPE_0 5
780 #define GNU_PROPERTY_AARCH64_FEATURE_1_AND 0xc0000000
782 #define GNU_PROPERTY_AARCH64_FEATURE_1_BTI (1U << 0)
783 #define GNU_PROPERTY_AARCH64_FEATURE_1_PAC (1U << 1)
785 #ifdef CONFIG_ARM64_BTI_KERNEL
786 #define GNU_PROPERTY_AARCH64_FEATURE_1_DEFAULT \
787 ((GNU_PROPERTY_AARCH64_FEATURE_1_BTI | \
788 GNU_PROPERTY_AARCH64_FEATURE_1_PAC))
791 #ifdef GNU_PROPERTY_AARCH64_FEATURE_1_DEFAULT
792 .macro emit_aarch64_feature_1_and, feat=GNU_PROPERTY_AARCH64_FEATURE_1_DEFAULT
793 .pushsection .note.gnu.property, "a"
797 .long NT_GNU_PROPERTY_TYPE_0
801 3: .long GNU_PROPERTY_AARCH64_FEATURE_1_AND
805 * This is described with an array of char in the Linux API
806 * spec but the text and all other usage (including binutils,
807 * clang and GCC) treat this as a 32 bit value so no swizzling
808 * is required for big endian.
818 .macro emit_aarch64_feature_1_and, feat=0
821 #endif /* GNU_PROPERTY_AARCH64_FEATURE_1_DEFAULT */
823 .macro __mitigate_spectre_bhb_loop tmp
824 #ifdef CONFIG_MITIGATE_SPECTRE_BRANCH_HISTORY
825 alternative_cb ARM64_ALWAYS_SYSTEM, spectre_bhb_patch_loop_iter
826 mov \tmp, #32 // Patched to correct the immediate
828 .Lspectre_bhb_loop\@:
831 b.ne .Lspectre_bhb_loop\@
833 #endif /* CONFIG_MITIGATE_SPECTRE_BRANCH_HISTORY */
836 .macro mitigate_spectre_bhb_loop tmp
837 #ifdef CONFIG_MITIGATE_SPECTRE_BRANCH_HISTORY
838 alternative_cb ARM64_ALWAYS_SYSTEM, spectre_bhb_patch_loop_mitigation_enable
839 b .L_spectre_bhb_loop_done\@ // Patched to NOP
841 __mitigate_spectre_bhb_loop \tmp
842 .L_spectre_bhb_loop_done\@:
843 #endif /* CONFIG_MITIGATE_SPECTRE_BRANCH_HISTORY */
846 /* Save/restores x0-x3 to the stack */
847 .macro __mitigate_spectre_bhb_fw
848 #ifdef CONFIG_MITIGATE_SPECTRE_BRANCH_HISTORY
849 stp x0, x1, [sp, #-16]!
850 stp x2, x3, [sp, #-16]!
851 mov w0, #ARM_SMCCC_ARCH_WORKAROUND_3
852 alternative_cb ARM64_ALWAYS_SYSTEM, smccc_patch_fw_mitigation_conduit
853 nop // Patched to SMC/HVC #0
855 ldp x2, x3, [sp], #16
856 ldp x0, x1, [sp], #16
857 #endif /* CONFIG_MITIGATE_SPECTRE_BRANCH_HISTORY */
860 .macro mitigate_spectre_bhb_clear_insn
861 #ifdef CONFIG_MITIGATE_SPECTRE_BRANCH_HISTORY
862 alternative_cb ARM64_ALWAYS_SYSTEM, spectre_bhb_patch_clearbhb
863 /* Patched to NOP when not supported */
867 #endif /* CONFIG_MITIGATE_SPECTRE_BRANCH_HISTORY */
869 #endif /* __ASM_ASSEMBLER_H */