/*************************************************************************** * Copyright (c) 2024 Microsoft Corporation * Copyright (c) 2026-present Eclipse ThreadX contributors * * This program and the accompanying materials are made available under the * terms of the MIT License which is available at * https://opensource.org/licenses/MIT. * * SPDX-License-Identifier: MIT **************************************************************************/ // Some portions generated by Gemini (Gemini 2.0 Flash). /**************************************************************************/ /**************************************************************************/ /** */ /** ThreadX Component */ /** */ /** Port Specific */ /** */ /**************************************************************************/ /**************************************************************************/ /**************************************************************************/ /* */ /* PORT SPECIFIC C INFORMATION RELEASE */ /* */ /* tx_port.h Cortex-M0/GNU */ /* 6.1.11 */ /* */ /* AUTHOR */ /* */ /* William E. Lamie, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This file contains data type definitions that make the ThreadX */ /* real-time kernel function identically on a variety of different */ /* processor architectures. For example, the size or number of bits */ /* in an "int" data type vary between microprocessor architectures and */ /* even C compilers for the same microprocessor. ThreadX does not */ /* directly use native C data types. Instead, ThreadX creates its */ /* own special types that can be mapped to actual data types by this */ /* file to guarantee consistency in the interface and functionality. */ /* */ /**************************************************************************/ #ifndef TX_PORT_H #define TX_PORT_H /* Determine if the optional ThreadX user define file should be used. */ #ifdef TX_INCLUDE_USER_DEFINE_FILE /* Yes, include the user defines in tx_user.h. The defines in this file may alternately be defined on the command line. */ #include "tx_user.h" #endif /* Define compiler library include files. */ #include #include /* Define ThreadX basic types for this port. */ #define VOID void typedef char CHAR; typedef unsigned char UCHAR; typedef int INT; typedef unsigned int UINT; typedef long LONG; typedef unsigned long ULONG; typedef short SHORT; typedef unsigned short USHORT; /* Define the TX_MEMSET macro to remove library reference. */ #define TX_MEMSET(a,b,c) { \ UCHAR *ptr; \ UCHAR value; \ UINT i, size; \ ptr = (UCHAR *) ((VOID *) a); \ value = (UCHAR) b; \ size = (UINT) c; \ for (i = 0; i < size; i++) \ { \ *ptr++ = value; \ } \ } /* Define the priority levels for ThreadX. Legal values range from 32 to 1024 and MUST be evenly divisible by 32. */ #ifndef TX_MAX_PRIORITIES #define TX_MAX_PRIORITIES 32 #endif /* Define the minimum stack for a ThreadX thread on this processor. If the size supplied during thread creation is less than this value, the thread create call will return an error. */ #ifndef TX_MINIMUM_STACK #define TX_MINIMUM_STACK 200 /* Minimum stack size for this port */ #endif /* Define the system timer thread's default stack size and priority. These are only applicable if TX_TIMER_PROCESS_IN_ISR is not defined. */ #ifndef TX_TIMER_THREAD_STACK_SIZE #define TX_TIMER_THREAD_STACK_SIZE 1024 /* Default timer thread stack size */ #endif #ifndef TX_TIMER_THREAD_PRIORITY #define TX_TIMER_THREAD_PRIORITY 0 /* Default timer thread priority */ #endif /* Define various constants for the ThreadX Cortex-M0 port. */ #define TX_INT_DISABLE 1 /* Disable interrupts */ #define TX_INT_ENABLE 0 /* Enable interrupts */ /* Define the clock source for trace event entry time stamp. The following two item are port specific. For example, if the time source is at the address 0x0a800024 and is 16-bits in size, the clock source constants would be: #define TX_TRACE_TIME_SOURCE *((volatile ULONG *) 0x0a800024) #define TX_TRACE_TIME_MASK 0x0000FFFFUL */ #ifndef TX_MISRA_ENABLE #ifndef TX_TRACE_TIME_SOURCE #define TX_TRACE_TIME_SOURCE *((volatile ULONG *) 0xE0001004) #endif #else ULONG _tx_misra_time_stamp_get(VOID); #define TX_TRACE_TIME_SOURCE _tx_misra_time_stamp_get() #endif #ifndef TX_TRACE_TIME_MASK #define TX_TRACE_TIME_MASK 0xFFFFFFFFUL #endif /* Define the port specific options for the _tx_build_options variable. This variable indicates how the ThreadX library was built. */ #define TX_PORT_SPECIFIC_BUILD_OPTIONS (0) /* Define the in-line initialization constant so that modules with in-line initialization capabilities can prevent their initialization from being a function call. */ #ifdef TX_MISRA_ENABLE #define TX_DISABLE_INLINE #else #define TX_INLINE_INITIALIZATION #endif /* Determine whether or not stack checking is enabled. By default, ThreadX stack checking is disabled. When the following is defined, ThreadX thread stack checking is enabled. If stack checking is enabled (TX_ENABLE_STACK_CHECKING is defined), the TX_DISABLE_STACK_FILLING define is negated, thereby forcing the stack fill which is necessary for the stack checking logic. */ #ifndef TX_MISRA_ENABLE #ifdef TX_ENABLE_STACK_CHECKING #undef TX_DISABLE_STACK_FILLING #endif #endif /* Define the TX_THREAD control block extensions for this port. The main reason for the multiple macros is so that backward compatibility can be maintained with existing ThreadX kernel awareness modules. */ #define TX_THREAD_EXTENSION_0 #define TX_THREAD_EXTENSION_1 #define TX_THREAD_EXTENSION_2 #define TX_THREAD_EXTENSION_3 /* Define the port extensions of the remaining ThreadX objects. */ #define TX_BLOCK_POOL_EXTENSION #define TX_BYTE_POOL_EXTENSION #define TX_EVENT_FLAGS_GROUP_EXTENSION #define TX_MUTEX_EXTENSION #define TX_QUEUE_EXTENSION #define TX_SEMAPHORE_EXTENSION #define TX_TIMER_EXTENSION /* Define the user extension field of the thread control block. Nothing additional is needed for this port so it is defined as white space. */ #ifndef TX_THREAD_USER_EXTENSION #define TX_THREAD_USER_EXTENSION #endif /* Define the macros for processing extensions in tx_thread_create, tx_thread_delete, tx_thread_shell_entry, and tx_thread_terminate. */ #define TX_THREAD_CREATE_EXTENSION(thread_ptr) #define TX_THREAD_DELETE_EXTENSION(thread_ptr) #define TX_THREAD_COMPLETED_EXTENSION(thread_ptr) #define TX_THREAD_TERMINATED_EXTENSION(thread_ptr) /* Define the ThreadX object creation extensions for the remaining objects. */ #define TX_BLOCK_POOL_CREATE_EXTENSION(pool_ptr) #define TX_BYTE_POOL_CREATE_EXTENSION(pool_ptr) #define TX_EVENT_FLAGS_GROUP_CREATE_EXTENSION(group_ptr) #define TX_MUTEX_CREATE_EXTENSION(mutex_ptr) #define TX_QUEUE_CREATE_EXTENSION(queue_ptr) #define TX_SEMAPHORE_CREATE_EXTENSION(semaphore_ptr) #define TX_TIMER_CREATE_EXTENSION(timer_ptr) /* Define the ThreadX object deletion extensions for the remaining objects. */ #define TX_BLOCK_POOL_DELETE_EXTENSION(pool_ptr) #define TX_BYTE_POOL_DELETE_EXTENSION(pool_ptr) #define TX_EVENT_FLAGS_GROUP_DELETE_EXTENSION(group_ptr) #define TX_MUTEX_DELETE_EXTENSION(mutex_ptr) #define TX_QUEUE_DELETE_EXTENSION(queue_ptr) #define TX_SEMAPHORE_DELETE_EXTENSION(semaphore_ptr) #define TX_TIMER_DELETE_EXTENSION(timer_ptr) /* Define the get system state macro. */ #ifndef TX_THREAD_GET_SYSTEM_STATE #ifndef TX_MISRA_ENABLE __attribute__( ( always_inline ) ) static inline unsigned int __get_ipsr_value(void) { unsigned int ipsr_value; __asm__ volatile (" MRS %0,IPSR ": "=r" (ipsr_value) ); return(ipsr_value); } #define TX_THREAD_GET_SYSTEM_STATE() (_tx_thread_system_state | __get_ipsr_value()) #else ULONG _tx_misra_ipsr_get(VOID); #define TX_THREAD_GET_SYSTEM_STATE() (_tx_thread_system_state | _tx_misra_ipsr_get()) #endif #endif /* Define the check for whether or not to call the _tx_thread_system_return function. A non-zero value indicates that _tx_thread_system_return should not be called. */ #ifndef TX_THREAD_SYSTEM_RETURN_CHECK #define TX_THREAD_SYSTEM_RETURN_CHECK(c) (c) = ((ULONG) _tx_thread_preempt_disable); #endif /* Define the macro to ensure _tx_thread_preempt_disable is set early in initialization in order to prevent early scheduling on Cortex-M parts. */ #define TX_PORT_SPECIFIC_POST_INITIALIZATION _tx_thread_preempt_disable++; #ifndef TX_DISABLE_INLINE /* Define GNU specific macros, with in-line assembly for performance. */ __attribute__( ( always_inline ) ) static inline unsigned int __disable_interrupts(void) { unsigned int primask_value; __asm__ volatile (" MRS %0,PRIMASK ": "=r" (primask_value) ); __asm__ volatile (" CPSID i" : : : "memory" ); return(primask_value); } __attribute__( ( always_inline ) ) static inline void __restore_interrupts(unsigned int primask_value) { __asm__ volatile (" MSR PRIMASK,%0": : "r" (primask_value): "memory" ); } __attribute__( ( always_inline ) ) static inline unsigned int __get_primask_value(void) { unsigned int primask_value; __asm__ volatile (" MRS %0,PRIMASK ": "=r" (primask_value) ); return(primask_value); } __attribute__( ( always_inline ) ) static inline void __enable_interrupts(void) { __asm__ volatile (" CPSIE i": : : "memory" ); } __attribute__( ( always_inline ) ) static inline void _tx_thread_system_return_inline(void) { unsigned int interrupt_save; /* Set PendSV to invoke ThreadX scheduler. */ *((volatile ULONG *) 0xE000ED04) = ((ULONG) 0x10000000); __asm__ volatile ("dsb 0xF \n isb 0xF " : : : "memory"); if (__get_ipsr_value() == 0) { interrupt_save = __get_primask_value(); __enable_interrupts(); __restore_interrupts(interrupt_save); __asm__ volatile ("isb 0xF " : : : "memory"); } } #define TX_INTERRUPT_SAVE_AREA UINT interrupt_save; #define TX_DISABLE interrupt_save = __disable_interrupts(); #define TX_RESTORE __restore_interrupts(interrupt_save); /* Redefine _tx_thread_system_return for improved performance. */ #define _tx_thread_system_return _tx_thread_system_return_inline #else #define TX_INTERRUPT_SAVE_AREA UINT interrupt_save; #define TX_DISABLE interrupt_save = _tx_thread_interrupt_control(TX_INT_DISABLE); #define TX_RESTORE _tx_thread_interrupt_control(interrupt_save); #endif /* Define the version ID of ThreadX. This may be utilized by the application. */ #ifdef TX_THREAD_INIT CHAR _tx_version_id[] = "(c) 2024 Microsoft Corp. (c) 2026-present Eclipse ThreadX contributors. * ThreadX Cortex-M0/GNU Version 6.5.1.202602a *"; #else extern CHAR _tx_version_id[]; #endif #endif