mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-06 04:51:56 +00:00
2d7460482d
This commit refactors kernel and arch headers to establish a boundary
between private and public interface headers.
The refactoring strategy used in this commit is detailed in the issue
This commit introduces the following major changes:
1. Establish a clear boundary between private and public headers by
removing "kernel/include" and "arch/*/include" from the global
include paths. Ideally, only kernel/ and arch/*/ source files should
reference the headers in these directories. If these headers must be
used by a component, these include paths shall be manually added to
the CMakeLists.txt file of the component. This is intended to
discourage applications from including private kernel and arch
headers either knowingly and unknowingly.
- kernel/include/ (PRIVATE)
This directory contains the private headers that provide private
kernel definitions which should not be visible outside the kernel
and arch source code. All public kernel definitions must be added
to an appropriate header located under include/.
- arch/*/include/ (PRIVATE)
This directory contains the private headers that provide private
architecture-specific definitions which should not be visible
outside the arch and kernel source code. All public architecture-
specific definitions must be added to an appropriate header located
under include/arch/*/.
- include/ AND include/sys/ (PUBLIC)
This directory contains the public headers that provide public
kernel definitions which can be referenced by both kernel and
application code.
- include/arch/*/ (PUBLIC)
This directory contains the public headers that provide public
architecture-specific definitions which can be referenced by both
kernel and application code.
2. Split arch_interface.h into "kernel-to-arch interface" and "public
arch interface" divisions.
- kernel/include/kernel_arch_interface.h
* provides private "kernel-to-arch interface" definition.
* includes arch/*/include/kernel_arch_func.h to ensure that the
interface function implementations are always available.
* includes sys/arch_interface.h so that public arch interface
definitions are automatically included when including this file.
- arch/*/include/kernel_arch_func.h
* provides architecture-specific "kernel-to-arch interface"
implementation.
* only the functions that will be used in kernel and arch source
files are defined here.
- include/sys/arch_interface.h
* provides "public arch interface" definition.
* includes include/arch/arch_inlines.h to ensure that the
architecture-specific public inline interface function
implementations are always available.
- include/arch/arch_inlines.h
* includes architecture-specific arch_inlines.h in
include/arch/*/arch_inline.h.
- include/arch/*/arch_inline.h
* provides architecture-specific "public arch interface" inline
function implementation.
* supersedes include/sys/arch_inline.h.
3. Refactor kernel and the existing architecture implementations.
- Remove circular dependency of kernel and arch headers. The
following general rules should be observed:
* Never include any private headers from public headers
* Never include kernel_internal.h in kernel_arch_data.h
* Always include kernel_arch_data.h from kernel_arch_func.h
* Never include kernel.h from kernel_struct.h either directly or
indirectly. Only add the kernel structures that must be referenced
from public arch headers in this file.
- Relocate syscall_handler.h to include/ so it can be used in the
public code. This is necessary because many user-mode public codes
reference the functions defined in this header.
- Relocate kernel_arch_thread.h to include/arch/*/thread.h. This is
necessary to provide architecture-specific thread definition for
'struct k_thread' in kernel.h.
- Remove any private header dependencies from public headers using
the following methods:
* If dependency is not required, simply omit
* If dependency is required,
- Relocate a portion of the required dependencies from the
private header to an appropriate public header OR
- Relocate the required private header to make it public.
This commit supersedes #20047, addresses #19666, and fixes #3056.
Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
180 lines
3.2 KiB
C
180 lines
3.2 KiB
C
/*
|
|
* Copyright (c) 2014-2016 Wind River Systems, Inc.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @brief Private kernel definitions
|
|
*
|
|
* This file contains private kernel structures definitions and various
|
|
* other definitions for the ARCv2 processor architecture.
|
|
*
|
|
* This file is also included by assembly language files which must #define
|
|
* _ASMLANGUAGE before including this header file. Note that kernel
|
|
* assembly source files obtains structure offset values via "absolute
|
|
* symbols" in the offsets.o module.
|
|
*/
|
|
|
|
#ifndef ZEPHYR_ARCH_ARC_INCLUDE_KERNEL_ARCH_DATA_H_
|
|
#define ZEPHYR_ARCH_ARC_INCLUDE_KERNEL_ARCH_DATA_H_
|
|
|
|
#include <toolchain.h>
|
|
#include <linker/sections.h>
|
|
#include <arch/cpu.h>
|
|
#include <vector_table.h>
|
|
|
|
#ifndef _ASMLANGUAGE
|
|
#include <kernel.h>
|
|
#include <zephyr/types.h>
|
|
#include <sys/util.h>
|
|
#include <sys/dlist.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifdef CONFIG_ARC_HAS_SECURE
|
|
struct _irq_stack_frame {
|
|
u32_t lp_end;
|
|
u32_t lp_start;
|
|
u32_t lp_count;
|
|
#ifdef CONFIG_CODE_DENSITY
|
|
/*
|
|
* Currently unsupported. This is where those registers are
|
|
* automatically pushed on the stack by the CPU when taking a regular
|
|
* IRQ.
|
|
*/
|
|
u32_t ei_base;
|
|
u32_t ldi_base;
|
|
u32_t jli_base;
|
|
#endif
|
|
u32_t r0;
|
|
u32_t r1;
|
|
u32_t r2;
|
|
u32_t r3;
|
|
u32_t r4;
|
|
u32_t r5;
|
|
u32_t r6;
|
|
u32_t r7;
|
|
u32_t r8;
|
|
u32_t r9;
|
|
u32_t r10;
|
|
u32_t r11;
|
|
u32_t r12;
|
|
u32_t r13;
|
|
u32_t blink;
|
|
u32_t pc;
|
|
u32_t sec_stat;
|
|
u32_t status32;
|
|
};
|
|
#else
|
|
struct _irq_stack_frame {
|
|
u32_t r0;
|
|
u32_t r1;
|
|
u32_t r2;
|
|
u32_t r3;
|
|
u32_t r4;
|
|
u32_t r5;
|
|
u32_t r6;
|
|
u32_t r7;
|
|
u32_t r8;
|
|
u32_t r9;
|
|
u32_t r10;
|
|
u32_t r11;
|
|
u32_t r12;
|
|
u32_t r13;
|
|
u32_t blink;
|
|
u32_t lp_end;
|
|
u32_t lp_start;
|
|
u32_t lp_count;
|
|
#ifdef CONFIG_CODE_DENSITY
|
|
/*
|
|
* Currently unsupported. This is where those registers are
|
|
* automatically pushed on the stack by the CPU when taking a regular
|
|
* IRQ.
|
|
*/
|
|
u32_t ei_base;
|
|
u32_t ldi_base;
|
|
u32_t jli_base;
|
|
#endif
|
|
u32_t pc;
|
|
u32_t status32;
|
|
};
|
|
#endif
|
|
|
|
typedef struct _irq_stack_frame _isf_t;
|
|
|
|
|
|
|
|
/* callee-saved registers pushed on the stack, not in k_thread */
|
|
struct _callee_saved_stack {
|
|
u32_t r13;
|
|
u32_t r14;
|
|
u32_t r15;
|
|
u32_t r16;
|
|
u32_t r17;
|
|
u32_t r18;
|
|
u32_t r19;
|
|
u32_t r20;
|
|
u32_t r21;
|
|
u32_t r22;
|
|
u32_t r23;
|
|
u32_t r24;
|
|
u32_t r25;
|
|
u32_t r26;
|
|
u32_t fp; /* r27 */
|
|
|
|
#ifdef CONFIG_USERSPACE
|
|
#ifdef CONFIG_ARC_HAS_SECURE
|
|
u32_t user_sp;
|
|
u32_t kernel_sp;
|
|
#else
|
|
u32_t user_sp;
|
|
#endif
|
|
#endif
|
|
/* r28 is the stack pointer and saved separately */
|
|
/* r29 is ILINK and does not need to be saved */
|
|
u32_t r30;
|
|
|
|
#ifdef CONFIG_ARC_HAS_ACCL_REGS
|
|
u32_t r58;
|
|
u32_t r59;
|
|
#endif
|
|
|
|
#ifdef CONFIG_FP_SHARING
|
|
u32_t fpu_status;
|
|
u32_t fpu_ctrl;
|
|
#ifdef CONFIG_FP_FPU_DA
|
|
u32_t dpfp2h;
|
|
u32_t dpfp2l;
|
|
u32_t dpfp1h;
|
|
u32_t dpfp1l;
|
|
#endif
|
|
|
|
#endif
|
|
/*
|
|
* No need to save r31 (blink), it's either alread pushed as the pc or
|
|
* blink on an irq stack frame.
|
|
*/
|
|
};
|
|
|
|
typedef struct _callee_saved_stack _callee_saved_stack_t;
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ASMLANGUAGE */
|
|
|
|
/* stacks */
|
|
|
|
#define STACK_ALIGN_SIZE 4
|
|
|
|
#define STACK_ROUND_UP(x) ROUND_UP(x, STACK_ALIGN_SIZE)
|
|
#define STACK_ROUND_DOWN(x) ROUND_DOWN(x, STACK_ALIGN_SIZE)
|
|
|
|
|
|
#endif /* ZEPHYR_ARCH_ARC_INCLUDE_KERNEL_ARCH_DATA_H_ */
|