mirror of
				https://github.com/FreeRTOS/FreeRTOS-Kernel.git
				synced 2025-11-04 11:09:01 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			209 lines
		
	
	
		
			8.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			209 lines
		
	
	
		
			8.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
 * FreeRTOS Kernel <DEVELOPMENT BRANCH>
 | 
						|
 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 | 
						|
 *
 | 
						|
 * SPDX-License-Identifier: MIT
 | 
						|
 *
 | 
						|
 * 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
 | 
						|
 * copies or substantial portions of the Software.
 | 
						|
 *
 | 
						|
 * 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.
 | 
						|
 *
 | 
						|
 * https://www.FreeRTOS.org
 | 
						|
 * https://github.com/FreeRTOS
 | 
						|
 *
 | 
						|
 */
 | 
						|
 | 
						|
#ifndef PORTMACRO_H
 | 
						|
    #define PORTMACRO_H
 | 
						|
 | 
						|
/* *INDENT-OFF* */
 | 
						|
#ifdef __cplusplus
 | 
						|
    extern "C" {
 | 
						|
#endif
 | 
						|
/* *INDENT-ON* */
 | 
						|
 | 
						|
/*-----------------------------------------------------------
 | 
						|
 * Port specific definitions.
 | 
						|
 *
 | 
						|
 * The settings in this file configure FreeRTOS correctly for the
 | 
						|
 * given hardware and compiler.
 | 
						|
 *
 | 
						|
 * These settings should not be altered.
 | 
						|
 *-----------------------------------------------------------
 | 
						|
 */
 | 
						|
 | 
						|
/* The compiler needs to be told functions that are only referenced by pointer
 | 
						|
 * are to be included in the build.  NOTE:  Omitting these lines will result in a
 | 
						|
 * run-time crash, not a linker error! */
 | 
						|
    #pragma funcall vTaskStartScheduler prvIdleTask
 | 
						|
    #pragma funcall xTimerCreateTimerTask prvTimerTask
 | 
						|
 | 
						|
/* Type definitions. */
 | 
						|
    #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 ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
 | 
						|
        typedef uint16_t     TickType_t;
 | 
						|
        #define portMAX_DELAY              ( TickType_t ) 0xffff
 | 
						|
    #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
 | 
						|
        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
 | 
						|
    #else
 | 
						|
        #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
 | 
						|
    #endif
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
/* Architecture specifics. */
 | 
						|
    #define portSTACK_GROWTH      ( -1 )
 | 
						|
    #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
 | 
						|
    #define portBYTE_ALIGNMENT    8
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
/* Scheduler utilities. */
 | 
						|
    #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 \
 | 
						|
         * within the specified behaviour for the architecture. */ \
 | 
						|
        __asm{ dsb };                                              \
 | 
						|
        __asm{ isb };                                              \
 | 
						|
    }
 | 
						|
 | 
						|
#define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
 | 
						|
#define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )
 | 
						|
#define portEND_SWITCHING_ISR( xSwitchRequired ) \
 | 
						|
    do                                           \
 | 
						|
    {                                            \
 | 
						|
        if( xSwitchRequired != pdFALSE )         \
 | 
						|
        {                                        \
 | 
						|
            traceISR_EXIT_TO_SCHEDULER();        \
 | 
						|
            portYIELD();                         \
 | 
						|
        }                                        \
 | 
						|
        else                                     \
 | 
						|
        {                                        \
 | 
						|
            traceISR_EXIT();                     \
 | 
						|
        }                                        \
 | 
						|
    } while( 0 )
 | 
						|
#define portYIELD_FROM_ISR( x )    portEND_SWITCHING_ISR( x )
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
/* Critical section management. */
 | 
						|
    extern void vPortEnterCritical( void );
 | 
						|
    extern void vPortExitCritical( void );
 | 
						|
    #define portDISABLE_INTERRUPTS()                  CPU_REG_SET( CPU_BASEPRI, configMAX_SYSCALL_INTERRUPT_PRIORITY ); __asm{ dsb }; __asm{ isb }
 | 
						|
    #define portENABLE_INTERRUPTS()                   CPU_REG_SET( CPU_BASEPRI, 0 );
 | 
						|
    #define portENTER_CRITICAL()                      vPortEnterCritical()
 | 
						|
    #define portEXIT_CRITICAL()                       vPortExitCritical()
 | 
						|
    #define portSET_INTERRUPT_MASK_FROM_ISR()         ulPortRaiseBASEPRI()
 | 
						|
    #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    CPU_REG_SET( CPU_BASEPRI, x ); /* Barrier instructions not used as this is only used to lower the basepri. */
 | 
						|
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
/* Task function macros as described on the FreeRTOS.org WEB site.  These are
 | 
						|
 * 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 )
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
/* Tickless idle/low power functionality. */
 | 
						|
    #ifndef portSUPPRESS_TICKS_AND_SLEEP
 | 
						|
        extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
 | 
						|
        #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )
 | 
						|
    #endif
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
/* Architecture specific optimisations. */
 | 
						|
    #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
 | 
						|
        #define configUSE_PORT_OPTIMISED_TASK_SELECTION    1
 | 
						|
    #endif
 | 
						|
 | 
						|
    #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
 | 
						|
 | 
						|
/* Generic helper function. */
 | 
						|
        __attribute__( ( always_inline ) ) static inline uint8_t ucPortCountLeadingZeros( uint32_t ulBitmap )
 | 
						|
        {
 | 
						|
            uint8_t ucReturn;
 | 
						|
 | 
						|
            __asm volatile ( "clz %0, %1" : "=r" ( ucReturn ) : "r" ( ulBitmap ) );
 | 
						|
 | 
						|
            return ucReturn;
 | 
						|
        }
 | 
						|
 | 
						|
/* 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
 | 
						|
 | 
						|
/* 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 ) )
 | 
						|
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
        #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    uxTopPriority = ( 31UL - ( uint32_t ) ucPortCountLeadingZeros( ( uxReadyPriorities ) ) )
 | 
						|
 | 
						|
    #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
 | 
						|
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
    #if ( configASSERT_DEFINED == 1 )
 | 
						|
        void vPortValidateInterruptPriority( void );
 | 
						|
        #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    vPortValidateInterruptPriority()
 | 
						|
    #endif
 | 
						|
 | 
						|
/* portNOP() is not required by this port. */
 | 
						|
    #define portNOP()
 | 
						|
 | 
						|
    BaseType_t xPortIsInsideInterrupt( void );
 | 
						|
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
    static inline uint32_t ulPortRaiseBASEPRI( void )
 | 
						|
    {
 | 
						|
        uint32_t ulOriginalBASEPRI;
 | 
						|
 | 
						|
        ulOriginalBASEPRI = CPU_REG_GET( CPU_BASEPRI );
 | 
						|
        CPU_REG_SET( CPU_BASEPRI, configMAX_SYSCALL_INTERRUPT_PRIORITY );
 | 
						|
        __asm{ dsb };
 | 
						|
        __asm{ isb };
 | 
						|
        return ulOriginalBASEPRI;
 | 
						|
    }
 | 
						|
/*-----------------------------------------------------------*/
 | 
						|
 | 
						|
/* *INDENT-OFF* */
 | 
						|
#ifdef __cplusplus
 | 
						|
    }
 | 
						|
#endif
 | 
						|
/* *INDENT-ON* */
 | 
						|
 | 
						|
#endif /* PORTMACRO_H */
 |