portmacro.h File Reference

This graph shows which files directly or indirectly include this file:

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 ) 0xffff
#define	portSTACK_GROWTH   ( -1 )
#define	portTICK_PERIOD_MS   ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
#define	portBYTE_ALIGNMENT   8
#define	portDONT_DISCARD   __attribute__( ( used ) )
#define	portYIELD()
#define	portNVIC_INT_CTRL_REG   ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
#define	portNVIC_PENDSVSET_BIT   ( 1UL << 28UL )
#define	portEND_SWITCHING_ISR(xSwitchRequired)
#define	portYIELD_FROM_ISR(x)
#define	portSET_INTERRUPT_MASK_FROM_ISR()
#define	portCLEAR_INTERRUPT_MASK_FROM_ISR(x)
#define	portDISABLE_INTERRUPTS()
#define	portENABLE_INTERRUPTS()
#define	portENTER_CRITICAL()
#define	portEXIT_CRITICAL()
#define	portTASK_FUNCTION_PROTO(vFunction, pvParameters)
#define	portTASK_FUNCTION(vFunction, pvParameters)
#define	portSUPPRESS_TICKS_AND_SLEEP(xExpectedIdleTime)
#define	configUSE_PORT_OPTIMISED_TASK_SELECTION   1
#define	portNOP()
#define	portINLINE   __inline
#define	portFORCE_INLINE   inline __attribute__( ( always_inline ) )
#define	portMEMORY_BARRIER()

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

Functions
void	vPortEnterCritical (void)
void	vPortExitCritical (void)
void	vPortSuppressTicksAndSleep (TickType_t xExpectedIdleTime)
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

configUSE_PORT_OPTIMISED_TASK_SELECTION

#define configUSE_PORT_OPTIMISED_TASK_SELECTION   1

portBASE_TYPE

#define portBASE_TYPE   long

portBYTE_ALIGNMENT

#define portBYTE_ALIGNMENT   8

portCHAR

#define portCHAR   char

portCLEAR_INTERRUPT_MASK_FROM_ISR

#define portCLEAR_INTERRUPT_MASK_FROM_ISR

(

x

)

Value:

vPortSetBASEPRI( x )

portDISABLE_INTERRUPTS

#define portDISABLE_INTERRUPTS

(

)

Value:

vPortRaiseBASEPRI()

portDONT_DISCARD

#define portDONT_DISCARD   __attribute__( ( used ) )

portDOUBLE

#define portDOUBLE   double

portENABLE_INTERRUPTS

#define portENABLE_INTERRUPTS

(

)

Value:

vPortSetBASEPRI( 0 )

portEND_SWITCHING_ISR

#define portEND_SWITCHING_ISR

(

xSwitchRequired

)

Value:

    do                                           \
    {                                            \
        if( xSwitchRequired != pdFALSE )         \
        {                                        \
            traceISR_EXIT_TO_SCHEDULER();        \
            portYIELD();                         \
        }                                        \
        else                                     \
        {                                        \
            traceISR_EXIT();                     \
        }                                        \
    } while( 0 )

portENTER_CRITICAL

#define portENTER_CRITICAL

(

)

Value:

vPortEnterCritical()

portEXIT_CRITICAL

#define portEXIT_CRITICAL

(

)

Value:

vPortExitCritical()

portFLOAT

#define portFLOAT   float

portFORCE_INLINE

#define portFORCE_INLINE   inline __attribute__( ( always_inline ) )

portINLINE

#define portINLINE   __inline

portLONG

#define portLONG   long

portMAX_DELAY

#define portMAX_DELAY   ( TickType_t ) 0xffff

portMEMORY_BARRIER

#define portMEMORY_BARRIER

(

)

Value:

__asm volatile ( "" ::: "memory" )

portNOP

#define portNOP

(

)

portNVIC_INT_CTRL_REG

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

portNVIC_PENDSVSET_BIT

#define portNVIC_PENDSVSET_BIT   ( 1UL << 28UL )

portSET_INTERRUPT_MASK_FROM_ISR

#define portSET_INTERRUPT_MASK_FROM_ISR

(

)

Value:

ulPortRaiseBASEPRI()

portSHORT

#define portSHORT   short

portSTACK_GROWTH

#define portSTACK_GROWTH   ( -1 )

portSTACK_TYPE

#define portSTACK_TYPE   uint32_t

portSUPPRESS_TICKS_AND_SLEEP

#define portSUPPRESS_TICKS_AND_SLEEP

(

xExpectedIdleTime

)

Value:

vPortSuppressTicksAndSleep( xExpectedIdleTime )

portTASK_FUNCTION

#define portTASK_FUNCTION	(		vFunction,
			pvParameters )

Value:

void vFunction( void * pvParameters )

portTASK_FUNCTION_PROTO

#define portTASK_FUNCTION_PROTO	(		vFunction,
			pvParameters )

Value:

void vFunction( void * pvParameters )

portTICK_PERIOD_MS

#define portTICK_PERIOD_MS   ( ( TickType_t ) 1000 / configTICK_RATE_HZ )

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" ::: "memory" );                     \
        __asm volatile ( "isb" );                                  \
    }

portYIELD_FROM_ISR

#define portYIELD_FROM_ISR

(

x

)

Value:

portEND_SWITCHING_ISR( x )

Typedef Documentation

BaseType_t

typedef long BaseType_t

StackType_t

typedef portSTACK_TYPE StackType_t

TickType_t

typedef uint16_t TickType_t

UBaseType_t

typedef unsigned long UBaseType_t

Function Documentation

ulPortRaiseBASEPRI()

portFORCE_INLINE uint32_t ulPortRaiseBASEPRI ( void )

static

vPortEnterCritical()

void vPortEnterCritical ( void )

extern

vPortExitCritical()

void vPortExitCritical ( void )

extern

vPortRaiseBASEPRI()

portFORCE_INLINE void vPortRaiseBASEPRI ( void )

static

vPortSetBASEPRI()

portFORCE_INLINE void vPortSetBASEPRI ( uint32_t ulNewMaskValue )

static

vPortSuppressTicksAndSleep()

void vPortSuppressTicksAndSleep ( TickType_t xExpectedIdleTime )

extern

xPortIsInsideInterrupt()

portFORCE_INLINE BaseType_t xPortIsInsideInterrupt ( void )

static