/* * This file is part of the coreboot project. * * Copyright 2014 Google Inc. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. The name of the author may not be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * lib_helpers.h: All library function prototypes and macros are defined in this * file. */ #ifndef __ARCH_LIB_HELPERS_H__ #define __ARCH_LIB_HELPERS_H__ #ifdef __ASSEMBLY__ /* Macro to switch to label based on current el */ .macro switch_el xreg label1 label2 label3 mrs \xreg, CurrentEL /* Currently at EL1 */ cmp \xreg, 0x4 b.eq \label1 /* Currently at EL2 */ cmp \xreg, 0x8 b.eq \label2 /* Currently at EL3 */ cmp \xreg, 0xc b.eq \label3 .endm /* Macro to read sysreg at current EL xreg - reg in which read value needs to be stored sysreg - system reg that is to be read */ .macro read_current xreg sysreg switch_el \xreg, 101f, 102f, 103f 101: mrs \xreg, \sysreg\()_el1 b 104f 102: mrs \xreg, \sysreg\()_el2 b 104f 103: mrs \xreg, \sysreg\()_el3 b 104f 104: .endm /* Macro to write sysreg at current EL xreg - reg from which value needs to be written sysreg - system reg that is to be written temp - temp reg that can be used to read current EL */ .macro write_current sysreg xreg temp switch_el \temp, 101f, 102f, 103f 101: msr \sysreg\()_el1, \xreg b 104f 102: msr \sysreg\()_el2, \xreg b 104f 103: msr \sysreg\()_el3, \xreg b 104f 104: .endm #else #define EL0 0 #define EL1 1 #define EL2 2 #define EL3 3 #define CURRENT_EL_MASK 0x3 #define CURRENT_EL_SHIFT 2 #include #define DAIF_DBG_BIT (1<<3) #define DAIF_ABT_BIT (1<<2) #define DAIF_IRQ_BIT (1<<1) #define DAIF_FIQ_BIT (1<<0) #define SWITCH_CASE_READ(func, var, type, el) do { \ type var = -1; \ switch (el) { \ case EL1: \ var = func##_el1(); \ break; \ case EL2: \ var = func##_el2(); \ break; \ case EL3: \ var = func##_el3(); \ break; \ } \ return var; \ } while (0) #define SWITCH_CASE_WRITE(func, var, el) do { \ switch (el) { \ case EL1: \ func##_el1(var); \ break; \ case EL2: \ func##_el2(var); \ break; \ case EL3: \ func##_el3(var); \ break; \ } \ } while (0) #define SWITCH_CASE_TLBI(func, el) do { \ switch (el) { \ case EL1: \ func##_el1(); \ break; \ case EL2: \ func##_el2(); \ break; \ case EL3: \ func##_el3(); \ break; \ } \ } while (0) /* PSTATE and special purpose register access functions */ uint32_t raw_read_current_el(void); uint32_t get_current_el(void); uint32_t raw_read_daif(void); void raw_write_daif(uint32_t daif); void enable_debug_exceptions(void); void enable_serror_exceptions(void); void enable_irq(void); void enable_fiq(void); void disable_debug_exceptions(void); void disable_serror_exceptions(void); void disable_irq(void); void disable_fiq(void); uint64_t raw_read_dlr_el0(void); void raw_write_dlr_el0(uint64_t dlr_el0); uint64_t raw_read_dspsr_el0(void); void raw_write_dspsr_el0(uint64_t dspsr_el0); uint64_t raw_read_elr_el1(void); void raw_write_elr_el1(uint64_t elr_el1); uint64_t raw_read_elr_el2(void); void raw_write_elr_el2(uint64_t elr_el2); uint64_t raw_read_elr_el3(void); void raw_write_elr_el3(uint64_t elr_el3); uint64_t raw_read_elr_current(void); void raw_write_elr_current(uint64_t elr); uint64_t raw_read_elr(uint32_t el); void raw_write_elr(uint64_t elr, uint32_t el); uint32_t raw_read_fpcr(void); void raw_write_fpcr(uint32_t fpcr); uint32_t raw_read_fpsr(void); void raw_write_fpsr(uint32_t fpsr); uint32_t raw_read_nzcv(void); void raw_write_nzcv(uint32_t nzcv); uint64_t raw_read_sp_el0(void); void raw_write_sp_el0(uint64_t sp_el0); uint64_t raw_read_sp_el1(void); void raw_write_sp_el1(uint64_t sp_el1); uint64_t raw_read_sp_el2(void); void raw_write_sp_el2(uint64_t sp_el2); uint32_t raw_read_spsel(void); void raw_write_spsel(uint32_t spsel); uint64_t raw_read_sp_el3(void); void raw_write_sp_el3(uint64_t sp_el3); uint32_t raw_read_spsr_abt(void); void raw_write_spsr_abt(uint32_t spsr_abt); uint32_t raw_read_spsr_el1(void); void raw_write_spsr_el1(uint32_t spsr_el1); uint32_t raw_read_spsr_el2(void); void raw_write_spsr_el2(uint32_t spsr_el2); uint32_t raw_read_spsr_el3(void); void raw_write_spsr_el3(uint32_t spsr_el3); uint32_t raw_read_spsr_current(void); void raw_write_spsr_current(uint32_t spsr); uint32_t raw_read_spsr(uint32_t el); void raw_write_spsr(uint32_t spsr, uint32_t el); uint32_t raw_read_spsr_fiq(void); void raw_write_spsr_fiq(uint32_t spsr_fiq); uint32_t raw_read_spsr_irq(void); void raw_write_spsr_irq(uint32_t spsr_irq); uint32_t raw_read_spsr_und(void); void raw_write_spsr_und(uint32_t spsr_und); /* System control register access */ uint32_t raw_read_actlr_el1(void); void raw_write_actlr_el1(uint32_t actlr_el1); uint32_t raw_read_actlr_el2(void); void raw_write_actlr_el2(uint32_t actlr_el2); uint32_t raw_read_actlr_el3(void); void raw_write_actlr_el3(uint32_t actlr_el3); uint32_t raw_read_actlr_current(void); void raw_write_actlr_current(uint32_t actlr); uint32_t raw_read_actlr(uint32_t el); void raw_write_actlr(uint32_t actlr, uint32_t el); uint32_t raw_read_afsr0_el1(void); void raw_write_afsr0_el1(uint32_t afsr0_el1); uint32_t raw_read_afsr0_el2(void); void raw_write_afsr0_el2(uint32_t afsr0_el2); uint32_t raw_read_afsr0_el3(void); void raw_write_afsr0_el3(uint32_t afsr0_el3); uint32_t raw_read_afsr0_current(void); void raw_write_afsr0_current(uint32_t afsr0); uint32_t raw_read_afsr0(uint32_t el); void raw_write_afsr0(uint32_t afsr0, uint32_t el); uint32_t raw_read_afsr1_el1(void); void raw_write_afsr1_el1(uint32_t afsr1_el1); uint32_t raw_read_afsr1_el2(void); void raw_write_afsr1_el2(uint32_t afsr1_el2); uint32_t raw_read_afsr1_el3(void); void raw_write_afsr1_el3(uint32_t afsr1_el3); uint32_t raw_read_afsr1_current(void); void raw_write_afsr1_current(uint32_t afsr1); uint32_t raw_read_afsr1(uint32_t el); void raw_write_afsr1(uint32_t afsr1, uint32_t el); uint32_t raw_read_aidr_el1(void); uint64_t raw_read_amair_el1(void); void raw_write_amair_el1(uint64_t amair_el1); uint64_t raw_read_amair_el2(void); void raw_write_amair_el2(uint64_t amair_el2); uint64_t raw_read_amair_el3(void); void raw_write_amair_el3(uint64_t amair_el3); uint64_t raw_read_amair_current(void); void raw_write_amair_current(uint64_t amair); uint64_t raw_read_amair(uint32_t el); void raw_write_amair(uint64_t amair, uint32_t el); uint32_t raw_read_ccsidr_el1(void); uint32_t raw_read_clidr_el1(void); uint32_t raw_read_cpacr_el1(void); void raw_write_cpacr_el1(uint32_t cpacr_el1); uint32_t raw_read_cptr_el2(void); void raw_write_cptr_el2(uint32_t cptr_el2); uint32_t raw_read_cptr_el3(void); void raw_write_cptr_el3(uint32_t cptr_el3); uint32_t raw_read_csselr_el1(void); void raw_write_csselr_el1(uint32_t csselr_el1); uint32_t raw_read_ctr_el0(void); uint32_t raw_read_esr_el1(void); void raw_write_esr_el1(uint32_t esr_el1); uint32_t raw_read_esr_el2(void); void raw_write_esr_el2(uint32_t esr_el2); uint32_t raw_read_esr_el3(void); void raw_write_esr_el3(uint32_t esr_el3); uint32_t raw_read_esr_current(void); void raw_write_esr_current(uint32_t esr); uint32_t raw_read_esr(uint32_t el); void raw_write_esr(uint32_t esr, uint32_t el); uint64_t raw_read_far_el1(void); void raw_write_far_el1(uint64_t far_el1); uint64_t raw_read_far_el2(void); void raw_write_far_el2(uint64_t far_el2); uint64_t raw_read_far_el3(void); void raw_write_far_el3(uint64_t far_el3); uint64_t raw_read_far_current(void); void raw_write_far_current(uint64_t far); uint64_t raw_read_far(uint32_t el); void raw_write_far(uint64_t far, uint32_t el); uint64_t raw_read_hcr_el2(void); void raw_write_hcr_el2(uint64_t hcr_el2); uint64_t raw_read_aa64pfr0_el1(void); uint64_t raw_read_mair_el1(void); void raw_write_mair_el1(uint64_t mair_el1); uint64_t raw_read_mair_el2(void); void raw_write_mair_el2(uint64_t mair_el2); uint64_t raw_read_mair_el3(void); void raw_write_mair_el3(uint64_t mair_el3); uint64_t raw_read_mair_current(void); void raw_write_mair_current(uint64_t mair); uint64_t raw_read_mair(uint32_t el); void raw_write_mair(uint64_t mair, uint32_t el); uint64_t raw_read_mpidr_el1(void); uint32_t raw_read_rmr_el1(void); void raw_write_rmr_el1(uint32_t rmr_el1); uint32_t raw_read_rmr_el2(void); void raw_write_rmr_el2(uint32_t rmr_el2); uint32_t raw_read_rmr_el3(void); void raw_write_rmr_el3(uint32_t rmr_el3); uint32_t raw_read_rmr_current(void); void raw_write_rmr_current(uint32_t rmr); uint32_t raw_read_rmr(uint32_t el); void raw_write_rmr(uint32_t rmr, uint32_t el); uint64_t raw_read_rvbar_el1(void); void raw_write_rvbar_el1(uint64_t rvbar_el1); uint64_t raw_read_rvbar_el2(void); void raw_write_rvbar_el2(uint64_t rvbar_el2); uint64_t raw_read_rvbar_el3(void); void raw_write_rvbar_el3(uint64_t rvbar_el3); uint64_t raw_read_rvbar_current(void); void raw_write_rvbar_current(uint64_t rvbar); uint64_t raw_read_rvbar(uint32_t el); void raw_write_rvbar(uint64_t rvbar, uint32_t el); uint32_t raw_read_scr_el3(void); void raw_write_scr_el3(uint32_t scr_el3); uint32_t raw_read_sctlr_el1(void); void raw_write_sctlr_el1(uint32_t sctlr_el1); uint32_t raw_read_sctlr_el2(void); void raw_write_sctlr_el2(uint32_t sctlr_el2); uint32_t raw_read_sctlr_el3(void); void raw_write_sctlr_el3(uint32_t sctlr_el3); uint32_t raw_read_sctlr_current(void); void raw_write_sctlr_current(uint32_t sctlr); uint32_t raw_read_sctlr(uint32_t el); void raw_write_sctlr(uint32_t sctlr, uint32_t el); uint64_t raw_read_tcr_el1(void); void raw_write_tcr_el1(uint64_t tcr_el1); uint32_t raw_read_tcr_el2(void); void raw_write_tcr_el2(uint32_t tcr_el2); uint32_t raw_read_tcr_el3(void); void raw_write_tcr_el3(uint32_t tcr_el3); uint64_t raw_read_tcr_current(void); void raw_write_tcr_current(uint64_t tcr); uint64_t raw_read_tcr(uint32_t el); void raw_write_tcr(uint64_t tcr, uint32_t el); uint64_t raw_read_ttbr0_el1(void); void raw_write_ttbr0_el1(uint64_t ttbr0_el1); uint64_t raw_read_ttbr0_el2(void); void raw_write_ttbr0_el2(uint64_t ttbr0_el2); uint64_t raw_read_ttbr0_el3(void); void raw_write_ttbr0_el3(uint64_t ttbr0_el3); uint64_t raw_read_ttbr0_current(void); void raw_write_ttbr0_current(uint64_t ttbr0); uint64_t raw_read_ttbr0(uint32_t el); void raw_write_ttbr0(uint64_t ttbr0, uint32_t el); uint64_t raw_read_ttbr1_el1(void); void raw_write_ttbr1_el1(uint64_t ttbr1_el1); uint64_t raw_read_vbar_el1(void); void raw_write_vbar_el1(uint64_t vbar_el1); uint64_t raw_read_vbar_el2(void); void raw_write_vbar_el2(uint64_t vbar_el2); uint64_t raw_read_vbar_el3(void); void raw_write_vbar_el3(uint64_t vbar_el3); uint64_t raw_read_vbar_current(void); void raw_write_vbar_current(uint64_t vbar); uint64_t raw_read_vbar(uint32_t el); void raw_write_vbar(uint64_t vbar, uint32_t el); /* Cache maintenance system instructions */ void dccisw(uint64_t cisw); void dccivac(uint64_t civac); void dccsw(uint64_t csw); void dccvac(uint64_t cvac); void dccvau(uint64_t cvau); void dcisw(uint64_t isw); void dcivac(uint64_t ivac); void dczva(uint64_t zva); void iciallu(void); void icialluis(void); void icivau(uint64_t ivau); /* TLB maintenance instructions */ void tlbiall_el1(void); void tlbiall_el2(void); void tlbiall_el3(void); void tlbiall_current(void); void tlbiall(uint32_t el); void tlbiallis_el1(void); void tlbiallis_el2(void); void tlbiallis_el3(void); void tlbiallis_current(void); void tlbiallis(uint32_t el); void tlbivaa_el1(uint64_t va); /* Memory barrier */ /* data memory barrier */ #define dmb_opt(opt) asm volatile ("dmb " #opt : : : "memory") /* data sync barrier */ #define dsb_opt(opt) asm volatile ("dsb " #opt : : : "memory") /* instruction sync barrier */ #define isb_opt(opt) asm volatile ("isb " #opt : : : "memory") #define dmb() dmb_opt(sy) #define dsb() dsb_opt(sy) #define isb() isb_opt() /* Clock */ void set_cntfrq(uint32_t freq); #endif // __ASSEMBLY__ #endif //__ARCH_LIB_HELPERS_H__