portmacro.h File Reference

Go to the source code of this file.

Macros
#define	portCHAR   char
#define	portFLOAT   float
#define	portDOUBLE   double
#define	portLONG   long
#define	portSHORT   short
#define	portSTACK_TYPE   uint32_t
#define	portBASE_TYPE   long
#define	portMAX_DELAY   ( TickType_t ) 0xffffffffUL
#define	portTICK_TYPE_IS_ATOMIC   1
#define	portSTACK_GROWTH   ( -1 )
#define	portTICK_PERIOD_MS   ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
#define	portBYTE_ALIGNMENT   8
#define	portYIELD()
#define	portNVIC_INT_CTRL_REG   ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )
#define	portNVIC_PENDSVSET_BIT   ( 1UL << 28UL )
#define	portEND_SWITCHING_ISR(xSwitchRequired)   if( xSwitchRequired != pdFALSE ) portYIELD()
#define	portYIELD_FROM_ISR(x)   portEND_SWITCHING_ISR( x )
#define	portSET_INTERRUPT_MASK_FROM_ISR()   ulPortRaiseBASEPRI()
#define	portCLEAR_INTERRUPT_MASK_FROM_ISR(x)   vPortSetBASEPRI(x)
#define	portDISABLE_INTERRUPTS()   vPortRaiseBASEPRI()
#define	portENABLE_INTERRUPTS()   vPortSetBASEPRI(0)
#define	portENTER_CRITICAL()   vPortEnterCritical()
#define	portEXIT_CRITICAL()   vPortExitCritical()
#define	portTASK_FUNCTION_PROTO(vFunction, pvParameters)   void vFunction( void *pvParameters )
#define	portTASK_FUNCTION(vFunction, pvParameters)   void vFunction( void *pvParameters )
#define	portSUPPRESS_TICKS_AND_SLEEP(xExpectedIdleTime)   vPortSuppressTicksAndSleep( xExpectedIdleTime )
#define	configUSE_PORT_OPTIMISED_TASK_SELECTION   1
#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 ) ) )
#define	portNOP()
#define	portINLINE   __inline
#define	portFORCE_INLINE   inline __attribute__(( always_inline))

Typedefs
typedef portSTACK_TYPE	StackType_t
typedef long	BaseType_t
typedef unsigned long	UBaseType_t
typedef uint32_t	TickType_t

Functions
void	vPortEnterCritical (void)
void	vPortExitCritical (void)
void	vPortSuppressTicksAndSleep (TickType_t xExpectedIdleTime)
	__attribute__ ((always_inline)) static inline uint8_t ucPortCountLeadingZeros(uint32_t ulBitmap)
static portFORCE_INLINE BaseType_t	xPortIsInsideInterrupt (void)
static portFORCE_INLINE void	vPortRaiseBASEPRI (void)
static portFORCE_INLINE uint32_t	ulPortRaiseBASEPRI (void)
static portFORCE_INLINE void	vPortSetBASEPRI (uint32_t ulNewMaskValue)

Macro Definition Documentation

portCHAR

#define portCHAR   char

portFLOAT

#define portFLOAT   float

portDOUBLE

#define portDOUBLE   double

portLONG

#define portLONG   long

portSHORT

#define portSHORT   short

portSTACK_TYPE

#define portSTACK_TYPE   uint32_t

portBASE_TYPE

#define portBASE_TYPE   long

portMAX_DELAY

#define portMAX_DELAY   ( TickType_t ) 0xffffffffUL

portTICK_TYPE_IS_ATOMIC

#define portTICK_TYPE_IS_ATOMIC   1

portSTACK_GROWTH

#define portSTACK_GROWTH   ( -1 )

portTICK_PERIOD_MS

#define portTICK_PERIOD_MS   ( ( TickType_t ) 1000 / configTICK_RATE_HZ )

portBYTE_ALIGNMENT

#define portBYTE_ALIGNMENT   8

portYIELD

#define portYIELD

(

)

Value:

{                                                                               \
    /* 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 volatile( "dsb" );                                                    \
    __asm volatile( "isb" );                                                    \
}

portNVIC_INT_CTRL_REG

#define portNVIC_INT_CTRL_REG   ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )

portNVIC_PENDSVSET_BIT

#define portNVIC_PENDSVSET_BIT   ( 1UL << 28UL )

portEND_SWITCHING_ISR

#define portEND_SWITCHING_ISR

(

xSwitchRequired

)

if( xSwitchRequired != pdFALSE ) portYIELD()

portYIELD_FROM_ISR

#define portYIELD_FROM_ISR

(

x

)

portEND_SWITCHING_ISR( x )

portSET_INTERRUPT_MASK_FROM_ISR

#define portSET_INTERRUPT_MASK_FROM_ISR

(

)

ulPortRaiseBASEPRI()

portCLEAR_INTERRUPT_MASK_FROM_ISR

#define portCLEAR_INTERRUPT_MASK_FROM_ISR

(

x

)

vPortSetBASEPRI(x)

portDISABLE_INTERRUPTS

#define portDISABLE_INTERRUPTS

(

)

vPortRaiseBASEPRI()

portENABLE_INTERRUPTS

#define portENABLE_INTERRUPTS

(

)

vPortSetBASEPRI(0)

portENTER_CRITICAL

#define portENTER_CRITICAL

(

)

vPortEnterCritical()

portEXIT_CRITICAL

#define portEXIT_CRITICAL

(

)

vPortExitCritical()

portTASK_FUNCTION_PROTO

#define portTASK_FUNCTION_PROTO	(		vFunction,
			pvParameters
	)		void vFunction( void *pvParameters )

portTASK_FUNCTION

#define portTASK_FUNCTION	(		vFunction,
			pvParameters
	)		void vFunction( void *pvParameters )

portSUPPRESS_TICKS_AND_SLEEP

#define portSUPPRESS_TICKS_AND_SLEEP

(

xExpectedIdleTime

)

vPortSuppressTicksAndSleep( xExpectedIdleTime )

configUSE_PORT_OPTIMISED_TASK_SELECTION

#define configUSE_PORT_OPTIMISED_TASK_SELECTION   1

portRECORD_READY_PRIORITY

#define portRECORD_READY_PRIORITY	(		uxPriority,
			uxReadyPriorities
	)		( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )

portRESET_READY_PRIORITY

#define portRESET_READY_PRIORITY	(		uxPriority,
			uxReadyPriorities
	)		( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )

portGET_HIGHEST_PRIORITY

#define portGET_HIGHEST_PRIORITY	(		uxTopPriority,
			uxReadyPriorities
	)		uxTopPriority = ( 31UL - ( uint32_t ) ucPortCountLeadingZeros( ( uxReadyPriorities ) ) )

portNOP

#define portNOP

(

)

portINLINE

#define portINLINE   __inline

portFORCE_INLINE

#define portFORCE_INLINE   inline __attribute__(( always_inline))

Typedef Documentation

StackType_t

typedef portSTACK_TYPE StackType_t

BaseType_t

typedef long BaseType_t

UBaseType_t

typedef unsigned long UBaseType_t

TickType_t

typedef uint32_t TickType_t

Function Documentation

vPortEnterCritical()

void vPortEnterCritical

(

void

)

{
    portDISABLE_INTERRUPTS();
    uxCriticalNesting++;
 
    /* This is not the interrupt safe version of the enter critical function so
    assert() if it is being called from an interrupt context.  Only API
    functions that end in "FromISR" can be used in an interrupt.  Only assert if
    the critical nesting count is 1 to protect against recursive calls if the
    assert function also uses a critical section. */
    if( uxCriticalNesting == 1 )
    {
        configASSERT( ( portNVIC_INT_CTRL_REG & portVECTACTIVE_MASK ) == 0 );
    }
}

Here is the caller graph for this function:

vPortExitCritical()

void vPortExitCritical

(

void

)

{
    configASSERT( uxCriticalNesting );
    uxCriticalNesting--;
    if( uxCriticalNesting == 0 )
    {
        portENABLE_INTERRUPTS();
    }
}

Here is the caller graph for this function:

vPortSuppressTicksAndSleep()

void vPortSuppressTicksAndSleep

(

TickType_t

xExpectedIdleTime

)

__attribute__()

__attribute__

(

(always_inline)

)

    {
    uint8_t ucReturn;
 
        __asm volatile ( "clz %0, %1" : "=r" ( ucReturn ) : "r" ( ulBitmap ) );
        return ucReturn;
    }

xPortIsInsideInterrupt()

static portFORCE_INLINE BaseType_t xPortIsInsideInterrupt ( void  )

static

{
uint32_t ulCurrentInterrupt;
BaseType_t xReturn;
 
    /* Obtain the number of the currently executing interrupt. */
    __asm volatile( "mrs %0, ipsr" : "=r"( ulCurrentInterrupt ) );
 
    if( ulCurrentInterrupt == 0 )
    {
        xReturn = pdFALSE;
    }
    else
    {
        xReturn = pdTRUE;
    }
 
    return xReturn;
}

vPortRaiseBASEPRI()

static portFORCE_INLINE void vPortRaiseBASEPRI ( void  )

static

{
uint32_t ulNewBASEPRI;
 
    __asm volatile
    (
        "   mov %0, %1                                              \n" \
        "   msr basepri, %0                                         \n" \
        "   isb                                                     \n" \
        "   dsb                                                     \n" \
        :"=r" (ulNewBASEPRI) : "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY )
    );
}

ulPortRaiseBASEPRI()

static portFORCE_INLINE uint32_t ulPortRaiseBASEPRI ( void  )

static

{
uint32_t ulOriginalBASEPRI, ulNewBASEPRI;
 
    __asm volatile
    (
        "   mrs %0, basepri                                         \n" \
        "   mov %1, %2                                              \n" \
        "   msr basepri, %1                                         \n" \
        "   isb                                                     \n" \
        "   dsb                                                     \n" \
        :"=r" (ulOriginalBASEPRI), "=r" (ulNewBASEPRI) : "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY )
    );
 
    /* This return will not be reached but is necessary to prevent compiler
    warnings. */
    return ulOriginalBASEPRI;
}

vPortSetBASEPRI()

static portFORCE_INLINE void vPortSetBASEPRI ( uint32_t  ulNewMaskValue )

static

{
    __asm volatile
    (
        "   msr basepri, %0 " :: "r" ( ulNewMaskValue )
    );
}