arch.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Cadence Design Systems, Inc.
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_ARCH_XTENSA_ARCH_H_
#define ZEPHYR_INCLUDE_ARCH_XTENSA_ARCH_H_
 
#include <zephyr/irq.h>
 
#include <zephyr/devicetree.h>
#if !defined(_ASMLANGUAGE) && !defined(__ASSEMBLER__)
#include <zephyr/types.h>
#include <zephyr/toolchain.h>
#include <zephyr/arch/common/sys_bitops.h>
#include <zephyr/arch/common/sys_io.h>
#include <zephyr/arch/common/ffs.h>
#include <zephyr/sw_isr_table.h>
#include <zephyr/arch/xtensa/syscall.h>
#include <zephyr/arch/xtensa/thread.h>
#include <zephyr/arch/xtensa/irq.h>
#include <xtensa/config/core.h>
#include <zephyr/arch/common/addr_types.h>
#include <zephyr/arch/xtensa/gdbstub.h>
#include <zephyr/debug/sparse.h>
#include <zephyr/arch/xtensa/thread_stack.h>
#include <zephyr/sys/slist.h>
 
#ifdef CONFIG_XTENSA_MMU
#include <zephyr/arch/xtensa/xtensa_mmu.h>
#endif
 
#ifdef CONFIG_XTENSA_MPU
#include <zephyr/arch/xtensa/mpu.h>
#endif

 
#include <zephyr/arch/exception.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct arch_mem_domain {
#ifdef CONFIG_XTENSA_MMU
        uint32_t *ptables;
        uint8_t asid;
        bool dirty;
 
        /* Following are used to program registers when changing page tables. */
        uint32_t reg_asid;
        uint32_t reg_ptevaddr;
        uint32_t reg_ptepin_as;
        uint32_t reg_ptepin_at;
        uint32_t reg_vecpin_as;
        uint32_t reg_vecpin_at;
#endif
#ifdef CONFIG_XTENSA_MPU
        struct xtensa_mpu_map mpu_map;
#endif
        sys_snode_t node;
};
 
typedef struct arch_mem_domain arch_mem_domain_t;

void xtensa_arch_except(int reason_p);

void xtensa_arch_kernel_oops(int reason_p, void *ssf);
 
#ifdef CONFIG_USERSPACE
 
#define ARCH_EXCEPT(reason_p) do { \
        if (k_is_user_context()) { \
                arch_syscall_invoke1(reason_p, \
                        K_SYSCALL_XTENSA_USER_FAULT); \
        } else { \
                compiler_barrier(); \
                xtensa_arch_except(reason_p); \
        } \
        CODE_UNREACHABLE; \
} while (false)
 
#else
 
#define ARCH_EXCEPT(reason_p) do { \
                xtensa_arch_except(reason_p); \
                CODE_UNREACHABLE; \
        } while (false)
 
#endif
 
__syscall void xtensa_user_fault(unsigned int reason);
 
#include <zephyr/syscalls/arch.h>
 
/* internal routine documented in C file, needed by IRQ_CONNECT() macro */
void z_irq_priority_set(uint32_t irq, uint32_t prio, uint32_t flags);
 
#define ARCH_IRQ_CONNECT(irq_p, priority_p, isr_p, isr_param_p, flags_p) \
        { \
                Z_ISR_DECLARE(irq_p, flags_p, isr_p, isr_param_p); \
        }

extern uint32_t sys_clock_cycle_get_32(void);
extern uint64_t sys_clock_cycle_get_64(void);

static inline uint32_t arch_k_cycle_get_32(void)
{
        return sys_clock_cycle_get_32();
}

static inline uint64_t arch_k_cycle_get_64(void)
{
        return sys_clock_cycle_get_64();
}

static ALWAYS_INLINE void arch_nop(void)
{
        __asm__ volatile("nop");
}

static ALWAYS_INLINE void xtensa_vecbase_lock(void)
{
        int vecbase;
 
        __asm__ volatile("rsr.vecbase %0" : "=r" (vecbase));
        __asm__ volatile("wsr.vecbase %0; rsync" : : "r" (vecbase | 1));
}
 
#if defined(CONFIG_XTENSA_MMU) || defined(__DOXYGEN__)
void arch_xtensa_mmu_post_init(bool is_core0);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* !defined(_ASMLANGUAGE) && !defined(__ASSEMBLER__)  */
 
#endif /* ZEPHYR_INCLUDE_ARCH_XTENSA_ARCH_H_ */