2006-05-02 17:39:15 +08:00
/*
2021-05-26 12:44:10 +08:00
* FreeRTOS Kernel < DEVELOPMENT BRANCH >
2021-05-26 12:46:15 +08:00
* Copyright ( C ) 2021 Amazon . com , Inc . or its affiliates . All Rights Reserved .
2017-11-30 00:53:26 +08:00
*
2021-06-02 03:01:32 +08:00
* SPDX - License - Identifier : MIT
*
2017-11-30 00:53:26 +08:00
* Permission is hereby granted , free of charge , to any person obtaining a copy of
* this software and associated documentation files ( the " Software " ) , to deal in
* the Software without restriction , including without limitation the rights to
* use , copy , modify , merge , publish , distribute , sublicense , and / or sell copies of
* the Software , and to permit persons to whom the Software is furnished to do so ,
* subject to the following conditions :
*
* The above copyright notice and this permission notice shall be included in all
2017-12-19 06:54:18 +08:00
* copies or substantial portions of the Software .
2017-11-30 00:53:26 +08:00
*
* THE SOFTWARE IS PROVIDED " AS IS " , WITHOUT WARRANTY OF ANY KIND , EXPRESS OR
* IMPLIED , INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY , FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT . IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM , DAMAGES OR OTHER LIABILITY , WHETHER
* IN AN ACTION OF CONTRACT , TORT OR OTHERWISE , ARISING FROM , OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE .
*
2020-08-21 05:59:28 +08:00
* https : //www.FreeRTOS.org
* https : //github.com/FreeRTOS
2017-11-30 00:53:26 +08:00
*
*/
2006-05-02 17:39:15 +08:00
# ifndef PORTMACRO_H
2020-08-25 06:32:02 +08:00
# define PORTMACRO_H
2006-05-02 17:39:15 +08:00
2020-08-25 06:32:02 +08:00
/* *INDENT-OFF* */
# ifdef __cplusplus
extern " C " {
# endif
/* *INDENT-ON* */
2007-11-06 00:44:39 +08:00
2006-05-02 17:39:15 +08:00
/*-----------------------------------------------------------
2012-10-16 15:55:40 +08:00
* Port specific definitions .
2006-05-02 17:39:15 +08:00
*
* The settings in this file configure FreeRTOS correctly for the
* given hardware and compiler .
*
* These settings should not be altered .
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*/
/* Type definitions. */
2020-07-02 13:27:40 +08:00
# define portCHAR char
# define portFLOAT float
# define portDOUBLE double
# define portLONG long
# define portSHORT short
# define portSTACK_TYPE uint32_t
# define portBASE_TYPE long
typedef portSTACK_TYPE StackType_t ;
typedef long BaseType_t ;
typedef unsigned long UBaseType_t ;
# if ( configUSE_16_BIT_TICKS == 1 )
typedef uint16_t TickType_t ;
# define portMAX_DELAY ( TickType_t ) 0xffff
# else
typedef uint32_t TickType_t ;
# define portMAX_DELAY ( TickType_t ) 0xffffffffUL
/* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
* not need to be guarded with a critical section . */
# define portTICK_TYPE_IS_ATOMIC 1
# endif
2012-10-16 15:55:40 +08:00
/*-----------------------------------------------------------*/
2006-05-02 17:39:15 +08:00
/* Architecture specifics. */
2020-07-02 13:27:40 +08:00
# define portSTACK_GROWTH ( -1 )
# define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
# define portBYTE_ALIGNMENT 8
2016-02-19 01:11:14 +08:00
/* Constants used with memory barrier intrinsics. */
2020-07-02 13:27:40 +08:00
# define portSY_FULL_READ_WRITE ( 15 )
2016-02-19 01:11:14 +08:00
2012-10-16 15:55:40 +08:00
/*-----------------------------------------------------------*/
2006-05-02 17:39:15 +08:00
/* Scheduler utilities. */
2020-07-02 13:27:40 +08:00
# define portYIELD() \
{ \
/* Set a PendSV to request a context switch. */ \
portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT ; \
\
/* Barriers are normally not required but do ensure the code is completely \
2020-07-02 13:55:52 +08:00
* within the specified behaviour for the architecture . */ \
__dsb ( portSY_FULL_READ_WRITE ) ; \
__isb ( portSY_FULL_READ_WRITE ) ; \
2020-07-02 13:27:40 +08:00
}
2016-02-19 01:11:14 +08:00
/*-----------------------------------------------------------*/
2020-07-02 13:27:40 +08:00
# define portNVIC_INT_CTRL_REG ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
# define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
2021-05-25 05:41:58 +08:00
# define portEND_SWITCHING_ISR( xSwitchRequired ) do { if( xSwitchRequired != pdFALSE ) portYIELD(); } while( 0 )
2020-07-02 13:27:40 +08:00
# define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
2006-05-02 17:39:15 +08:00
/*-----------------------------------------------------------*/
/* Critical section management. */
2020-07-02 13:27:40 +08:00
extern void vPortEnterCritical ( void ) ;
extern void vPortExitCritical ( void ) ;
2006-05-02 17:39:15 +08:00
2020-07-02 13:27:40 +08:00
# define portDISABLE_INTERRUPTS() vPortRaiseBASEPRI()
# define portENABLE_INTERRUPTS() vPortSetBASEPRI( 0 )
# define portENTER_CRITICAL() vPortEnterCritical()
# define portEXIT_CRITICAL() vPortExitCritical()
# define portSET_INTERRUPT_MASK_FROM_ISR() ulPortRaiseBASEPRI()
# define portCLEAR_INTERRUPT_MASK_FROM_ISR( x ) vPortSetBASEPRI( x )
2016-02-19 01:11:14 +08:00
2006-05-02 17:39:15 +08:00
/*-----------------------------------------------------------*/
2012-10-23 00:40:45 +08:00
/* Tickless idle/low power functionality. */
2020-07-02 13:27:40 +08:00
# ifndef portSUPPRESS_TICKS_AND_SLEEP
extern void vPortSuppressTicksAndSleep ( TickType_t xExpectedIdleTime ) ;
# define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )
# endif
2012-10-16 15:55:40 +08:00
/*-----------------------------------------------------------*/
2012-09-24 19:01:17 +08:00
2012-10-16 15:55:40 +08:00
/* Port specific optimisations. */
2020-07-02 13:27:40 +08:00
# ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
# define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
# endif
2014-09-03 06:39:54 +08:00
2020-07-02 13:27:40 +08:00
# if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
2012-09-24 19:01:17 +08:00
2020-07-02 13:27:40 +08:00
/* Check the configuration. */
# if ( configMAX_PRIORITIES > 32 )
# error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32. It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.
# endif
2012-09-24 19:01:17 +08:00
2020-07-02 13:27:40 +08:00
/* Store/clear the ready priorities in a bit map. */
# define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
# define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
2012-09-24 19:01:17 +08:00
2020-07-02 13:27:40 +08:00
/*-----------------------------------------------------------*/
2012-10-16 15:55:40 +08:00
2020-07-08 08:42:07 +08:00
# define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( uint32_t ) __clz( ( uxReadyPriorities ) ) )
2012-09-24 19:01:17 +08:00
2020-07-02 13:27:40 +08:00
# endif /* taskRECORD_READY_PRIORITY */
2012-10-16 15:55:40 +08:00
/*-----------------------------------------------------------*/
/* Task function macros as described on the FreeRTOS.org WEB site. These are
2020-07-02 13:27:40 +08:00
* not necessary for to use this port . They are defined so the common demo files
* ( which build with all the ports ) will build . */
# define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
# define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
2012-10-16 15:55:40 +08:00
/*-----------------------------------------------------------*/
2012-09-24 19:01:17 +08:00
2020-07-02 13:27:40 +08:00
# ifdef configASSERT
void vPortValidateInterruptPriority ( void ) ;
# define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() vPortValidateInterruptPriority()
# endif
2013-07-04 19:20:28 +08:00
2012-10-16 15:55:40 +08:00
/* portNOP() is not required by this port. */
2020-07-02 13:27:40 +08:00
# define portNOP()
2012-09-24 19:01:17 +08:00
2020-07-02 13:27:40 +08:00
# define portINLINE __inline
2015-11-20 22:11:11 +08:00
2020-07-02 13:27:40 +08:00
# ifndef portFORCE_INLINE
# define portFORCE_INLINE __forceinline
# endif
2016-02-19 01:11:14 +08:00
/*-----------------------------------------------------------*/
2020-07-02 13:27:40 +08:00
static portFORCE_INLINE void vPortSetBASEPRI ( uint32_t ulBASEPRI )
{
__asm
{
/* Barrier instructions are not used as this function is only used to
* lower the BASEPRI value . */
2020-08-25 06:32:02 +08:00
/* *INDENT-OFF* */
2020-07-02 13:27:40 +08:00
msr basepri , ulBASEPRI
2020-08-25 06:32:02 +08:00
/* *INDENT-ON* */
2020-07-02 13:27:40 +08:00
}
}
2016-02-19 01:11:14 +08:00
/*-----------------------------------------------------------*/
2020-07-02 13:27:40 +08:00
static portFORCE_INLINE void vPortRaiseBASEPRI ( void )
{
uint32_t ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY ;
__asm
{
/* Set BASEPRI to the max syscall priority to effect a critical
* section . */
2020-08-25 06:32:02 +08:00
/* *INDENT-OFF* */
2020-07-02 13:27:40 +08:00
msr basepri , ulNewBASEPRI
dsb
2020-08-25 06:32:02 +08:00
isb
/* *INDENT-ON* */
2020-07-02 13:27:40 +08:00
}
}
2016-02-19 01:11:14 +08:00
/*-----------------------------------------------------------*/
2020-07-02 13:27:40 +08:00
static portFORCE_INLINE void vPortClearBASEPRIFromISR ( void )
{
__asm
{
/* Set BASEPRI to 0 so no interrupts are masked. This function is only
* used to lower the mask in an interrupt , so memory barriers are not
* used . */
2020-08-25 06:32:02 +08:00
/* *INDENT-OFF* */
2020-07-02 13:27:40 +08:00
msr basepri , # 0
2020-08-25 06:32:02 +08:00
/* *INDENT-ON* */
2020-07-02 13:27:40 +08:00
}
}
2016-02-19 01:11:14 +08:00
/*-----------------------------------------------------------*/
2020-07-02 13:27:40 +08:00
static portFORCE_INLINE uint32_t ulPortRaiseBASEPRI ( void )
{
uint32_t ulReturn , ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY ;
__asm
{
/* Set BASEPRI to the max syscall priority to effect a critical
* section . */
2020-08-25 06:32:02 +08:00
/* *INDENT-OFF* */
2020-07-02 13:27:40 +08:00
mrs ulReturn , basepri
msr basepri , ulNewBASEPRI
dsb
2020-08-25 06:32:02 +08:00
isb
/* *INDENT-ON* */
2020-07-02 13:27:40 +08:00
}
return ulReturn ;
}
2016-02-19 01:11:14 +08:00
/*-----------------------------------------------------------*/
2020-07-02 13:27:40 +08:00
static portFORCE_INLINE BaseType_t xPortIsInsideInterrupt ( void )
{
2020-07-08 08:42:07 +08:00
uint32_t ulCurrentInterrupt ;
2020-07-02 13:27:40 +08:00
BaseType_t xReturn ;
2016-02-19 01:11:14 +08:00
2020-07-02 13:27:40 +08:00
/* Obtain the number of the currently executing interrupt. */
__asm
{
2020-08-25 06:32:02 +08:00
/* *INDENT-OFF* */
2020-07-02 13:27:40 +08:00
mrs ulCurrentInterrupt , ipsr
2020-08-25 06:32:02 +08:00
/* *INDENT-ON* */
2020-07-02 13:27:40 +08:00
}
2016-02-19 01:11:14 +08:00
2020-07-02 13:27:40 +08:00
if ( ulCurrentInterrupt = = 0 )
{
xReturn = pdFALSE ;
}
else
{
xReturn = pdTRUE ;
}
2016-02-19 01:11:14 +08:00
2020-07-02 13:27:40 +08:00
return xReturn ;
}
2016-02-19 01:11:14 +08:00
2020-08-25 06:32:02 +08:00
/* *INDENT-OFF* */
# ifdef __cplusplus
}
# endif
/* *INDENT-ON* */
2007-11-06 00:44:39 +08:00
2006-05-02 17:39:15 +08:00
# endif /* PORTMACRO_H */