/* ********************************************************************************************************* * uC/CPU * CPU CONFIGURATION & PORT LAYER * * Copyright 2004-2020 Silicon Laboratories Inc. www.silabs.com * * SPDX-License-Identifier: APACHE-2.0 * * This software is subject to an open source license and is distributed by * Silicon Laboratories Inc. pursuant to the terms of the Apache License, * Version 2.0 available at www.apache.org/licenses/LICENSE-2.0. * ********************************************************************************************************* */ /* ********************************************************************************************************* * * CPU PORT FILE * * Linux i86pc & amd64 * GNU Toolchain * * Filename : cpu.h * Version : v1.32.00 ********************************************************************************************************* */ /* ********************************************************************************************************* * MODULE * * Note(s) : (1) This CPU header file is protected from multiple pre-processor inclusion through use of * the CPU module present pre-processor macro definition. ********************************************************************************************************* */ #ifndef CPU_MODULE_PRESENT /* See Note #1. */ #define CPU_MODULE_PRESENT /* ********************************************************************************************************* * CPU INCLUDE FILES * * Note(s) : (1) The following CPU files are located in the following directories : * * (a) \\cpu_cfg.h * * (b) (1) \\cpu_def.h * (2) \\\\cpu*.* * * where * directory path for Your Product's Application * directory path for common CPU-compiler software * directory name for specific CPU * directory name for specific compiler * * (2) Compiler MUST be configured to include as additional include path directories : * * (a) '\\' directory See Note #1a * * (b) (1) '\\' directory See Note #1b1 * (2) '\\\\' directory See Note #1b2 * * (3) Since NO custom library modules are included, 'cpu.h' may ONLY use configurations from * CPU configuration file 'cpu_cfg.h' that do NOT reference any custom library definitions. * * In other words, 'cpu.h' may use 'cpu_cfg.h' configurations that are #define'd to numeric * constants or to NULL (i.e. NULL-valued #define's); but may NOT use configurations to * custom library #define's (e.g. DEF_DISABLED or DEF_ENABLED). ********************************************************************************************************* */ #include #include #include #include #include /* See Note #3. */ #ifdef __cplusplus extern "C" { #endif /* ********************************************************************************************************* * CONFIGURE STANDARD DATA TYPES * * Note(s) : (1) Configure standard data types according to CPU-/compiler-specifications. * * (2) (a) (1) 'CPU_FNCT_VOID' data type defined to replace the commonly-used function pointer * data type of a pointer to a function which returns void & has no arguments. * * (2) Example function pointer usage : * * CPU_FNCT_VOID FnctName; * * FnctName(); * * (b) (1) 'CPU_FNCT_PTR' data type defined to replace the commonly-used function pointer * data type of a pointer to a function which returns void & has a single void * pointer argument. * * (2) Example function pointer usage : * * CPU_FNCT_PTR FnctName; * void *p_obj * * FnctName(p_obj); ********************************************************************************************************* */ typedef void CPU_VOID; typedef char CPU_CHAR; /* 8-bit character */ typedef uint8_t CPU_BOOLEAN; /* 8-bit boolean or logical */ typedef uint8_t CPU_INT08U; /* 8-bit unsigned integer */ typedef int8_t CPU_INT08S; /* 8-bit signed integer */ typedef uint16_t CPU_INT16U; /* 16-bit unsigned integer */ typedef int16_t CPU_INT16S; /* 16-bit signed integer */ typedef uint32_t CPU_INT32U; /* 32-bit unsigned integer */ typedef int32_t CPU_INT32S; /* 32-bit signed integer */ typedef uint64_t CPU_INT64U; /* 64-bit unsigned integer */ typedef int64_t CPU_INT64S; /* 64-bit signed integer */ typedef float CPU_FP32; /* 32-bit floating point */ typedef double CPU_FP64; /* 64-bit floating point */ typedef volatile CPU_INT08U CPU_REG08; /* 8-bit register */ typedef volatile CPU_INT16U CPU_REG16; /* 16-bit register */ typedef volatile CPU_INT32U CPU_REG32; /* 32-bit register */ typedef volatile CPU_INT64U CPU_REG64; /* 64-bit register */ typedef void (*CPU_FNCT_VOID)(void); /* See Note #2a. */ typedef void (*CPU_FNCT_PTR )(void *p_obj); /* See Note #2b. */ typedef struct CPU_Interrupt CPU_INTERRUPT; struct CPU_Interrupt { void (*ISR_Fnct)(void); CPU_INT08U Prio; CPU_BOOLEAN En; CPU_CHAR *NamePtr; CPU_BOOLEAN TraceEn; }; typedef struct CPU_Tmr_Interrupt CPU_TMR_INTERRUPT; struct CPU_Tmr_Interrupt { CPU_INTERRUPT Interrupt; CPU_BOOLEAN OneShot; CPU_INT32U PeriodSec; CPU_INT32U PeriodMuSec; }; /* ********************************************************************************************************* * CPU WORD CONFIGURATION * * Note(s) : (1) Configure CPU_CFG_ADDR_SIZE, CPU_CFG_DATA_SIZE, & CPU_CFG_DATA_SIZE_MAX with CPU's &/or * compiler's word sizes : * * CPU_WORD_SIZE_08 8-bit word size * CPU_WORD_SIZE_16 16-bit word size * CPU_WORD_SIZE_32 32-bit word size * CPU_WORD_SIZE_64 64-bit word size * * (2) Configure CPU_CFG_ENDIAN_TYPE with CPU's data-word-memory order : * * (a) CPU_ENDIAN_TYPE_BIG Big- endian word order (CPU words' most significant * octet @ lowest memory address) * (b) CPU_ENDIAN_TYPE_LITTLE Little-endian word order (CPU words' least significant * octet @ lowest memory address) ********************************************************************************************************* */ /* Define CPU word sizes (see Note #1) : */ #ifdef _LP64 #define CPU_CFG_ADDR_SIZE CPU_WORD_SIZE_64 /* Defines CPU address word size (in octets). */ #define CPU_CFG_DATA_SIZE CPU_WORD_SIZE_64 /* Defines CPU data word size (in octets). */ #else #define CPU_CFG_ADDR_SIZE CPU_WORD_SIZE_32 /* Defines CPU address word size (in octets). */ #define CPU_CFG_DATA_SIZE CPU_WORD_SIZE_32 /* Defines CPU data word size (in octets). */ #endif #define CPU_CFG_DATA_SIZE_MAX CPU_WORD_SIZE_64 /* Defines CPU maximum word size (in octets). */ #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ #define CPU_CFG_ENDIAN_TYPE CPU_ENDIAN_TYPE_LITTLE /* Defines CPU data word-memory order (see Note #2). */ #else #define CPU_CFG_ENDIAN_TYPE CPU_ENDIAN_TYPE_BIG /* Defines CPU data word-memory order (see Note #2). */ #endif /* ********************************************************************************************************* * CONFIGURE CPU ADDRESS & DATA TYPES ********************************************************************************************************* */ /* CPU address type based on address bus size. */ #if (CPU_CFG_ADDR_SIZE == CPU_WORD_SIZE_64) typedef CPU_INT64U CPU_ADDR; #elif (CPU_CFG_ADDR_SIZE == CPU_WORD_SIZE_32) typedef CPU_INT32U CPU_ADDR; #elif (CPU_CFG_ADDR_SIZE == CPU_WORD_SIZE_16) typedef CPU_INT16U CPU_ADDR; #else typedef CPU_INT08U CPU_ADDR; #endif /* CPU data type based on data bus size. */ #if (CPU_CFG_DATA_SIZE == CPU_WORD_SIZE_64) typedef CPU_INT64U CPU_DATA; #elif (CPU_CFG_DATA_SIZE == CPU_WORD_SIZE_32) typedef CPU_INT32U CPU_DATA; #elif (CPU_CFG_DATA_SIZE == CPU_WORD_SIZE_16) typedef CPU_INT16U CPU_DATA; #else typedef CPU_INT08U CPU_DATA; #endif typedef CPU_DATA CPU_ALIGN; /* Defines CPU data-word-alignment size. */ typedef size_t CPU_SIZE_T; /* Defines CPU standard 'size_t' size. */ /* ********************************************************************************************************* * CPU STACK CONFIGURATION * * Note(s) : (1) Configure CPU_CFG_STK_GROWTH in 'cpu.h' with CPU's stack growth order : * * (a) CPU_STK_GROWTH_LO_TO_HI CPU stack pointer increments to the next higher stack * memory address after data is pushed onto the stack * (b) CPU_STK_GROWTH_HI_TO_LO CPU stack pointer decrements to the next lower stack * memory address after data is pushed onto the stack * * (2) Configure CPU_CFG_STK_ALIGN_BYTES with the highest minimum alignement required for * cpu stacks. ********************************************************************************************************* */ #define CPU_CFG_STK_GROWTH CPU_STK_GROWTH_HI_TO_LO /* Defines CPU stack growth order (see Note #1). */ #define CPU_CFG_STK_ALIGN_BYTES (sizeof(CPU_ALIGN)) /* Defines CPU stack alignment in bytes. (see Note #2). */ typedef CPU_INT32U CPU_STK; /* Defines CPU stack data type. */ typedef CPU_ADDR CPU_STK_SIZE; /* Defines CPU stack size data type. */ /* ********************************************************************************************************* * CRITICAL SECTION CONFIGURATION * * Note(s) : (1) Configure CPU_CFG_CRITICAL_METHOD with CPU's/compiler's critical section method : * * Enter/Exit critical sections by ... * * CPU_CRITICAL_METHOD_INT_DIS_EN Disable/Enable interrupts * CPU_CRITICAL_METHOD_STATUS_STK Push/Pop interrupt status onto stack * CPU_CRITICAL_METHOD_STATUS_LOCAL Save/Restore interrupt status to local variable * * (a) CPU_CRITICAL_METHOD_INT_DIS_EN is NOT a preferred method since it does NOT support * multiple levels of interrupts. However, with some CPUs/compilers, this is the only * available method. * * (b) CPU_CRITICAL_METHOD_STATUS_STK is one preferred method since it supports multiple * levels of interrupts. However, this method assumes that the compiler provides C-level * &/or assembly-level functionality for the following : * * ENTER CRITICAL SECTION : * (1) Push/save interrupt status onto a local stack * (2) Disable interrupts * * EXIT CRITICAL SECTION : * (3) Pop/restore interrupt status from a local stack * * (c) CPU_CRITICAL_METHOD_STATUS_LOCAL is one preferred method since it supports multiple * levels of interrupts. However, this method assumes that the compiler provides C-level * &/or assembly-level functionality for the following : * * ENTER CRITICAL SECTION : * (1) Save interrupt status into a local variable * (2) Disable interrupts * * EXIT CRITICAL SECTION : * (3) Restore interrupt status from a local variable * * (2) Critical section macro's most likely require inline assembly. If the compiler does NOT * allow inline assembly in C source files, critical section macro's MUST call an assembly * subroutine defined in a 'cpu_a.asm' file located in the following software directory : * * \\\\ * * where * directory path for common CPU-compiler software * directory name for specific CPU * directory name for specific compiler * * (3) (a) To save/restore interrupt status, a local variable 'cpu_sr' of type 'CPU_SR' MAY need * to be declared (e.g. if 'CPU_CRITICAL_METHOD_STATUS_LOCAL' method is configured). * * (1) 'cpu_sr' local variable SHOULD be declared via the CPU_SR_ALLOC() macro which, if * used, MUST be declared following ALL other local variables. * * Example : * * void Fnct (void) * { * CPU_INT08U val_08; * CPU_INT16U val_16; * CPU_INT32U val_32; * CPU_SR_ALLOC(); MUST be declared after ALL other local variables * : * : * } * * (b) Configure 'CPU_SR' data type with the appropriate-sized CPU data type large enough to * completely store the CPU's/compiler's status word. ********************************************************************************************************* */ /* Configure CPU critical method (see Note #1) : */ #define CPU_CFG_CRITICAL_METHOD CPU_CRITICAL_METHOD_INT_DIS_EN typedef CPU_BOOLEAN CPU_SR; /* Defines CPU status register size (see Note #3b). */ /* Allocates CPU status register word (see Note #3a). */ #if (CPU_CFG_CRITICAL_METHOD == CPU_CRITICAL_METHOD_STATUS_LOCAL) #define CPU_SR_ALLOC() CPU_SR cpu_sr = (CPU_SR)0 #else #define CPU_SR_ALLOC() #endif #define CPU_INT_DIS() do { CPU_IntDis(); } while (0) /* Disable interrupts. */ #define CPU_INT_EN() do { CPU_IntEn(); } while (0) /* Enable interrupts. */ #ifdef CPU_CFG_INT_DIS_MEAS_EN /* Disable interrupts, ... */ /* & start interrupts disabled time measurement.*/ #define CPU_CRITICAL_ENTER() do { CPU_INT_DIS(); \ CPU_IntDisMeasStart(); } while (0) /* Stop & measure interrupts disabled time, */ /* ... & re-enable interrupts. */ #define CPU_CRITICAL_EXIT() do { CPU_IntDisMeasStop(); \ CPU_INT_EN(); } while (0) #else #define CPU_CRITICAL_ENTER() do { CPU_INT_DIS(); } while (0) /* Disable interrupts. */ #define CPU_CRITICAL_EXIT() do { CPU_INT_EN(); } while (0) /* Re-enable interrupts. */ #endif /* ********************************************************************************************************* * MEMORY BARRIERS CONFIGURATION * * Note(s) : (1) (a) Configure memory barriers if required by the architecture. * * CPU_MB Full memory barrier. * CPU_RMB Read (Loads) memory barrier. * CPU_WMB Write (Stores) memory barrier. * ********************************************************************************************************* */ #define CPU_MB() #define CPU_RMB() #define CPU_WMB() /* ********************************************************************************************************* * FUNCTION PROTOTYPES ********************************************************************************************************* */ void CPU_IntInit (void); void CPU_IntEnd (void); void CPU_IntDis (void); void CPU_IntEn (void); void CPU_ISR_End (void); void CPU_TmrInterruptCreate (CPU_TMR_INTERRUPT *p_tmr_interrupt); void CPU_InterruptTrigger (CPU_INTERRUPT *p_interrupt); /* ********************************************************************************************************* * CONFIGURATION ERRORS ********************************************************************************************************* */ #ifndef CPU_CFG_ADDR_SIZE #error "CPU_CFG_ADDR_SIZE not #define'd in 'cpu.h' " #error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]" #error " [ || CPU_WORD_SIZE_16 16-bit alignment]" #error " [ || CPU_WORD_SIZE_32 32-bit alignment]" #error " [ || CPU_WORD_SIZE_64 64-bit alignment]" #elif ((CPU_CFG_ADDR_SIZE != CPU_WORD_SIZE_08) && \ (CPU_CFG_ADDR_SIZE != CPU_WORD_SIZE_16) && \ (CPU_CFG_ADDR_SIZE != CPU_WORD_SIZE_32) && \ (CPU_CFG_ADDR_SIZE != CPU_WORD_SIZE_64)) #error "CPU_CFG_ADDR_SIZE illegally #define'd in 'cpu.h' " #error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]" #error " [ || CPU_WORD_SIZE_16 16-bit alignment]" #error " [ || CPU_WORD_SIZE_32 32-bit alignment]" #error " [ || CPU_WORD_SIZE_64 64-bit alignment]" #endif #ifndef CPU_CFG_DATA_SIZE #error "CPU_CFG_DATA_SIZE not #define'd in 'cpu.h' " #error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]" #error " [ || CPU_WORD_SIZE_16 16-bit alignment]" #error " [ || CPU_WORD_SIZE_32 32-bit alignment]" #error " [ || CPU_WORD_SIZE_64 64-bit alignment]" #elif ((CPU_CFG_DATA_SIZE != CPU_WORD_SIZE_08) && \ (CPU_CFG_DATA_SIZE != CPU_WORD_SIZE_16) && \ (CPU_CFG_DATA_SIZE != CPU_WORD_SIZE_32) && \ (CPU_CFG_DATA_SIZE != CPU_WORD_SIZE_64)) #error "CPU_CFG_DATA_SIZE illegally #define'd in 'cpu.h' " #error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]" #error " [ || CPU_WORD_SIZE_16 16-bit alignment]" #error " [ || CPU_WORD_SIZE_32 32-bit alignment]" #error " [ || CPU_WORD_SIZE_64 64-bit alignment]" #endif #ifndef CPU_CFG_DATA_SIZE_MAX #error "CPU_CFG_DATA_SIZE_MAX not #define'd in 'cpu.h' " #error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]" #error " [ || CPU_WORD_SIZE_16 16-bit alignment]" #error " [ || CPU_WORD_SIZE_32 32-bit alignment]" #error " [ || CPU_WORD_SIZE_64 64-bit alignment]" #elif ((CPU_CFG_DATA_SIZE_MAX != CPU_WORD_SIZE_08) && \ (CPU_CFG_DATA_SIZE_MAX != CPU_WORD_SIZE_16) && \ (CPU_CFG_DATA_SIZE_MAX != CPU_WORD_SIZE_32) && \ (CPU_CFG_DATA_SIZE_MAX != CPU_WORD_SIZE_64)) #error "CPU_CFG_DATA_SIZE_MAX illegally #define'd in 'cpu.h' " #error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]" #error " [ || CPU_WORD_SIZE_16 16-bit alignment]" #error " [ || CPU_WORD_SIZE_32 32-bit alignment]" #error " [ || CPU_WORD_SIZE_64 64-bit alignment]" #endif #if (CPU_CFG_DATA_SIZE_MAX < CPU_CFG_DATA_SIZE) #error "CPU_CFG_DATA_SIZE_MAX illegally #define'd in 'cpu.h' " #error " [MUST be >= CPU_CFG_DATA_SIZE]" #endif #ifndef CPU_CFG_ENDIAN_TYPE #error "CPU_CFG_ENDIAN_TYPE not #define'd in 'cpu.h' " #error " [MUST be CPU_ENDIAN_TYPE_BIG ]" #error " [ || CPU_ENDIAN_TYPE_LITTLE]" #elif ((CPU_CFG_ENDIAN_TYPE != CPU_ENDIAN_TYPE_BIG ) && \ (CPU_CFG_ENDIAN_TYPE != CPU_ENDIAN_TYPE_LITTLE)) #error "CPU_CFG_ENDIAN_TYPE illegally #define'd in 'cpu.h' " #error " [MUST be CPU_ENDIAN_TYPE_BIG ]" #error " [ || CPU_ENDIAN_TYPE_LITTLE]" #endif #ifndef CPU_CFG_STK_GROWTH #error "CPU_CFG_STK_GROWTH not #define'd in 'cpu.h' " #error " [MUST be CPU_STK_GROWTH_LO_TO_HI]" #error " [ || CPU_STK_GROWTH_HI_TO_LO]" #elif ((CPU_CFG_STK_GROWTH != CPU_STK_GROWTH_LO_TO_HI) && \ (CPU_CFG_STK_GROWTH != CPU_STK_GROWTH_HI_TO_LO)) #error "CPU_CFG_STK_GROWTH illegally #define'd in 'cpu.h' " #error " [MUST be CPU_STK_GROWTH_LO_TO_HI]" #error " [ || CPU_STK_GROWTH_HI_TO_LO]" #endif #ifndef CPU_CFG_CRITICAL_METHOD #error "CPU_CFG_CRITICAL_METHOD not #define'd in 'cpu.h' " #error " [MUST be CPU_CRITICAL_METHOD_INT_DIS_EN ]" #error " [ || CPU_CRITICAL_METHOD_STATUS_STK ]" #error " [ || CPU_CRITICAL_METHOD_STATUS_LOCAL]" #elif ((CPU_CFG_CRITICAL_METHOD != CPU_CRITICAL_METHOD_INT_DIS_EN ) && \ (CPU_CFG_CRITICAL_METHOD != CPU_CRITICAL_METHOD_STATUS_STK ) && \ (CPU_CFG_CRITICAL_METHOD != CPU_CRITICAL_METHOD_STATUS_LOCAL)) #error "CPU_CFG_CRITICAL_METHOD illegally #define'd in 'cpu.h' " #error " [MUST be CPU_CRITICAL_METHOD_INT_DIS_EN ]" #error " [ || CPU_CRITICAL_METHOD_STATUS_STK ]" #error " [ || CPU_CRITICAL_METHOD_STATUS_LOCAL]" #endif /* ********************************************************************************************************* * MODULE END * * Note(s) : (1) See 'cpu.h MODULE'. ********************************************************************************************************* */ #ifdef __cplusplus } #endif #endif /* End of CPU module include. */