FreeRTOS/Source/portable/IAR/ARM_CA9/portmacro.h - third_party/github/FreeRTOS/FreeRTOS-Kernel - Git at Google

 /*
     FreeRTOS V8.0.0:rc1 - Copyright (C) 2014 Real Time Engineers Ltd.
     All rights reserved

     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.

     ***************************************************************************
      *                                                                       *
      *    FreeRTOS provides completely free yet professionally developed,    *
      *    robust, strictly quality controlled, supported, and cross          *
      *    platform software that has become a de facto standard.             *
      *                                                                       *
      *    Help yourself get started quickly and support the FreeRTOS         *
      *    project by purchasing a FreeRTOS tutorial book, reference          *
      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *
      *                                                                       *
      *    Thank you!                                                         *
      *                                                                       *
     ***************************************************************************

     This file is part of the FreeRTOS distribution.

     FreeRTOS is free software; you can redistribute it and/or modify it under
     the terms of the GNU General Public License (version 2) as published by the
     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.

     >>! NOTE: The modification to the GPL is included to allow you to distribute
     >>! a combined work that includes FreeRTOS without being obliged to provide
     >>! the source code for proprietary components outside of the FreeRTOS
     >>! kernel.

     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
     FOR A PARTICULAR PURPOSE.  Full license text is available from the following
     link: http://www.freertos.org/a00114.html

     1 tab == 4 spaces!

     ***************************************************************************
      *                                                                       *
      *    Having a problem?  Start by reading the FAQ "My application does   *
      *    not run, what could be wrong?"                                     *
      *                                                                       *
      *    http://www.FreeRTOS.org/FAQHelp.html                               *
      *                                                                       *
     ***************************************************************************

     http://www.FreeRTOS.org - Documentation, books, training, latest versions,
     license and Real Time Engineers Ltd. contact details.

     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
     including FreeRTOS+Trace - an indispensable productivity tool, a DOS
     compatible FAT file system, and our tiny thread aware UDP/IP stack.

     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS
     licenses offer ticketed support, indemnification and middleware.

     http://www.SafeRTOS.com - High Integrity Systems also provide a safety
     engineered and independently SIL3 certified version for use in safety and
     mission critical applications that require provable dependability.

     1 tab == 4 spaces!
 */

 #ifndef PORTMACRO_H
 #define PORTMACRO_H

 /* IAR includes. */
 #ifdef __ICCARM__

 	#include <intrinsics.h>

 	#ifdef __cplusplus
 		extern "C" {
 	#endif

 	/*-----------------------------------------------------------
 	 * Port specific definitions.
 	 *
 	 * The settings in this file configure FreeRTOS correctly for the given hardware
 	 * and compiler.
 	 *
 	 * These settings should not be altered.
 	 *-----------------------------------------------------------
 	 */

 	/* 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;

 	typedef uint32_t TickType_t;
 	#define portMAX_DELAY ( TickType_t ) 0xffffffffUL

 	/*-----------------------------------------------------------*/

 	/* Hardware specifics. */
 	#define portSTACK_GROWTH			( -1 )
 	#define portTICK_RATE_MS			( ( TickType_t ) 1000 / configTICK_RATE_HZ )
 	#define portBYTE_ALIGNMENT			8

 	/*-----------------------------------------------------------*/

 	/* Task utilities. */

 	/* Called at the end of an ISR that can cause a context switch. */
 	#define portEND_SWITCHING_ISR( xSwitchRequired )\
 	{												\
 	extern uint32_t ulPortYieldRequired;		\
 													\
 		if( xSwitchRequired != pdFALSE )			\
 		{											\
 			ulPortYieldRequired = pdTRUE;			\
 		}											\
 	}

 	#define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
 	#define portYIELD() __asm( "SWI 0" );


 	/*-----------------------------------------------------------
 	 * Critical section control
 	 *----------------------------------------------------------*/

 	extern void vPortEnterCritical( void );
 	extern void vPortExitCritical( void );
 	extern uint32_t ulPortSetInterruptMask( void );
 	extern void vPortClearInterruptMask( uint32_t ulNewMaskValue );

 	/* These macros do not globally disable/enable interrupts.  They do mask off
 	interrupts that have a priority below configMAX_API_CALL_INTERRUPT_PRIORITY. */
 	#define portENTER_CRITICAL()		vPortEnterCritical();
 	#define portEXIT_CRITICAL()			vPortExitCritical();
 	#define portDISABLE_INTERRUPTS()	ulPortSetInterruptMask()
 	#define portENABLE_INTERRUPTS()		vPortClearInterruptMask( 0 )
 	#define portSET_INTERRUPT_MASK_FROM_ISR()		ulPortSetInterruptMask()
 	#define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)	vPortClearInterruptMask(x)

 	/*-----------------------------------------------------------*/

 	/* Task function macros as described on the FreeRTOS.org WEB site.  These are
 	not required for this port but included in case common demo code that uses these
 	macros is used. */
 	#define portTASK_FUNCTION_PROTO( vFunction, pvParameters )	void vFunction( void *pvParameters )
 	#define portTASK_FUNCTION( vFunction, pvParameters )	void vFunction( void *pvParameters )

 	/* Prototype of the FreeRTOS tick handler.  This must be installed as the
 	handler for whichever peripheral is used to generate the RTOS tick. */
 	void FreeRTOS_Tick_Handler( void );

 	/* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()
 	before any floating point instructions are executed. */
 	void vPortTaskUsesFPU( void );
 	#define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()

 	#define portLOWEST_INTERRUPT_PRIORITY ( ( ( uint32_t ) configUNIQUE_INTERRUPT_PRIORITIES ) - 1UL )
 	#define portLOWEST_USABLE_INTERRUPT_PRIORITY ( portLOWEST_INTERRUPT_PRIORITY - 1UL )

 	/* Architecture specific optimisations. */
 	#if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1

 		/* 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 = ( 31 - __CLZ( uxReadyPriorities ) )

 	#endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */

 	#ifdef configASSERT
 		void vPortValidateInterruptPriority( void );
 		#define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() 	vPortValidateInterruptPriority()
 	#endif /* configASSERT */

 	#define portNOP() __asm volatile( "NOP" )


 	#ifdef __cplusplus
 		} /* extern C */
 	#endif

 	/* Suppress warnings that are generated by the IAR tools, but cannot be
 	fixed in the source code because to do so would cause other compilers to
 	generate warnings. */
 	#pragma diag_suppress=Pe191
 	#pragma diag_suppress=Pa082

 #endif /* __ICCARM__ */


 /* The number of bits to shift for an interrupt priority is dependent on the
 number of bits implemented by the interrupt controller. */
 #if configUNIQUE_INTERRUPT_PRIORITIES == 16
 	#define portPRIORITY_SHIFT 4
 	#define portMAX_BINARY_POINT_VALUE	3
 #elif configUNIQUE_INTERRUPT_PRIORITIES == 32
 	#define portPRIORITY_SHIFT 3
 	#define portMAX_BINARY_POINT_VALUE	2
 #elif configUNIQUE_INTERRUPT_PRIORITIES == 64
 	#define portPRIORITY_SHIFT 2
 	#define portMAX_BINARY_POINT_VALUE	1
 #elif configUNIQUE_INTERRUPT_PRIORITIES == 128
 	#define portPRIORITY_SHIFT 1
 	#define portMAX_BINARY_POINT_VALUE	0
 #elif configUNIQUE_INTERRUPT_PRIORITIES == 256
 	#define portPRIORITY_SHIFT 0
 	#define portMAX_BINARY_POINT_VALUE	0
 #else
 	#error Invalid configUNIQUE_INTERRUPT_PRIORITIES setting.  configUNIQUE_INTERRUPT_PRIORITIES must be set to the number of unique priorities implemented by the target hardware
 #endif

 /* Interrupt controller access addresses. */
 #define portICCPMR_PRIORITY_MASK_OFFSET  						( 0x04 )
 #define portICCIAR_INTERRUPT_ACKNOWLEDGE_OFFSET 				( 0x0C )
 #define portICCEOIR_END_OF_INTERRUPT_OFFSET 					( 0x10 )
 #define portICCBPR_BINARY_POINT_OFFSET							( 0x08 )
 #define portICCRPR_RUNNING_PRIORITY_OFFSET						( 0x14 )

 #define portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS 		( configINTERRUPT_CONTROLLER_BASE_ADDRESS + configINTERRUPT_CONTROLLER_CPU_INTERFACE_OFFSET )
 #define portICCPMR_PRIORITY_MASK_REGISTER 					( *( ( volatile uint8_t * ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCPMR_PRIORITY_MASK_OFFSET ) ) )
 #define portICCIAR_INTERRUPT_ACKNOWLEDGE_REGISTER_ADDRESS 	( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCIAR_INTERRUPT_ACKNOWLEDGE_OFFSET )
 #define portICCEOIR_END_OF_INTERRUPT_REGISTER_ADDRESS 		( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCEOIR_END_OF_INTERRUPT_OFFSET )
 #define portICCPMR_PRIORITY_MASK_REGISTER_ADDRESS 			( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCPMR_PRIORITY_MASK_OFFSET )
 #define portICCBPR_BINARY_POINT_REGISTER 					( *( ( const volatile uint32_t * ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCBPR_BINARY_POINT_OFFSET ) ) )
 #define portICCRPR_RUNNING_PRIORITY_REGISTER 				( *( ( const volatile uint8_t * ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCRPR_RUNNING_PRIORITY_OFFSET ) ) )

 #endif /* PORTMACRO_H */
	/*
	FreeRTOS V8.0.0:rc1 - Copyright (C) 2014 Real Time Engineers Ltd.
	All rights reserved

	VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.

	***************************************************************************
	* *
	* FreeRTOS provides completely free yet professionally developed, *
	* robust, strictly quality controlled, supported, and cross *
	* platform software that has become a de facto standard. *
	* *
	* Help yourself get started quickly and support the FreeRTOS *
	* project by purchasing a FreeRTOS tutorial book, reference *
	* manual, or both from: http://www.FreeRTOS.org/Documentation *
	* *
	* Thank you! *
	* *
	***************************************************************************

	This file is part of the FreeRTOS distribution.

	FreeRTOS is free software; you can redistribute it and/or modify it under
	the terms of the GNU General Public License (version 2) as published by the
	Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.

	>>! NOTE: The modification to the GPL is included to allow you to distribute
	>>! a combined work that includes FreeRTOS without being obliged to provide
	>>! the source code for proprietary components outside of the FreeRTOS
	>>! kernel.

	FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
	WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
	FOR A PARTICULAR PURPOSE. Full license text is available from the following
	link: http://www.freertos.org/a00114.html

	1 tab == 4 spaces!

	***************************************************************************
	* *
	* Having a problem? Start by reading the FAQ "My application does *
	* not run, what could be wrong?" *
	* *
	* http://www.FreeRTOS.org/FAQHelp.html *
	* *
	***************************************************************************

	http://www.FreeRTOS.org - Documentation, books, training, latest versions,
	license and Real Time Engineers Ltd. contact details.

	http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
	including FreeRTOS+Trace - an indispensable productivity tool, a DOS
	compatible FAT file system, and our tiny thread aware UDP/IP stack.

	http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
	Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
	licenses offer ticketed support, indemnification and middleware.

	http://www.SafeRTOS.com - High Integrity Systems also provide a safety
	engineered and independently SIL3 certified version for use in safety and
	mission critical applications that require provable dependability.

	1 tab == 4 spaces!
	*/

	#ifndef PORTMACRO_H
	#define PORTMACRO_H

	/* IAR includes. */
	#ifdef __ICCARM__

	#include <intrinsics.h>

	#ifdef __cplusplus
	extern "C" {
	#endif

	/*-----------------------------------------------------------
	* Port specific definitions.
	*
	* The settings in this file configure FreeRTOS correctly for the given hardware
	* and compiler.
	*
	* These settings should not be altered.
	*-----------------------------------------------------------
	*/

	/* 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;

	typedef uint32_t TickType_t;
	#define portMAX_DELAY ( TickType_t ) 0xffffffffUL

	/-----------------------------------------------------------/

	/* Hardware specifics. */
	#define portSTACK_GROWTH ( -1 )
	#define portTICK_RATE_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
	#define portBYTE_ALIGNMENT 8

	/-----------------------------------------------------------/

	/* Task utilities. */

	/* Called at the end of an ISR that can cause a context switch. */
	#define portEND_SWITCHING_ISR( xSwitchRequired )\
	{ \
	extern uint32_t ulPortYieldRequired; \
	\
	if( xSwitchRequired != pdFALSE ) \
	{ \
	ulPortYieldRequired = pdTRUE; \
	} \
	}

	#define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
	#define portYIELD() __asm( "SWI 0" );


	/*-----------------------------------------------------------
	* Critical section control
	----------------------------------------------------------/

	extern void vPortEnterCritical( void );
	extern void vPortExitCritical( void );
	extern uint32_t ulPortSetInterruptMask( void );
	extern void vPortClearInterruptMask( uint32_t ulNewMaskValue );

	/* These macros do not globally disable/enable interrupts. They do mask off
	interrupts that have a priority below configMAX_API_CALL_INTERRUPT_PRIORITY. */
	#define portENTER_CRITICAL() vPortEnterCritical();
	#define portEXIT_CRITICAL() vPortExitCritical();
	#define portDISABLE_INTERRUPTS() ulPortSetInterruptMask()
	#define portENABLE_INTERRUPTS() vPortClearInterruptMask( 0 )
	#define portSET_INTERRUPT_MASK_FROM_ISR() ulPortSetInterruptMask()
	#define portCLEAR_INTERRUPT_MASK_FROM_ISR(x) vPortClearInterruptMask(x)

	/-----------------------------------------------------------/

	/* Task function macros as described on the FreeRTOS.org WEB site. These are
	not required for this port but included in case common demo code that uses these
	macros is used. */
	#define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
	#define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )

	/* Prototype of the FreeRTOS tick handler. This must be installed as the
	handler for whichever peripheral is used to generate the RTOS tick. */
	void FreeRTOS_Tick_Handler( void );

	/* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()
	before any floating point instructions are executed. */
	void vPortTaskUsesFPU( void );
	#define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()

	#define portLOWEST_INTERRUPT_PRIORITY ( ( ( uint32_t ) configUNIQUE_INTERRUPT_PRIORITIES ) - 1UL )
	#define portLOWEST_USABLE_INTERRUPT_PRIORITY ( portLOWEST_INTERRUPT_PRIORITY - 1UL )

	/* Architecture specific optimisations. */
	#if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1

	/* 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 = ( 31 - __CLZ( uxReadyPriorities ) )

	#endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */

	#ifdef configASSERT
	void vPortValidateInterruptPriority( void );
	#define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() vPortValidateInterruptPriority()
	#endif /* configASSERT */

	#define portNOP() __asm volatile( "NOP" )


	#ifdef __cplusplus
	} /* extern C */
	#endif

	/* Suppress warnings that are generated by the IAR tools, but cannot be
	fixed in the source code because to do so would cause other compilers to
	generate warnings. */
	#pragma diag_suppress=Pe191
	#pragma diag_suppress=Pa082

	#endif /* __ICCARM__ */


	/* The number of bits to shift for an interrupt priority is dependent on the
	number of bits implemented by the interrupt controller. */
	#if configUNIQUE_INTERRUPT_PRIORITIES == 16
	#define portPRIORITY_SHIFT 4
	#define portMAX_BINARY_POINT_VALUE 3
	#elif configUNIQUE_INTERRUPT_PRIORITIES == 32
	#define portPRIORITY_SHIFT 3
	#define portMAX_BINARY_POINT_VALUE 2
	#elif configUNIQUE_INTERRUPT_PRIORITIES == 64
	#define portPRIORITY_SHIFT 2
	#define portMAX_BINARY_POINT_VALUE 1
	#elif configUNIQUE_INTERRUPT_PRIORITIES == 128
	#define portPRIORITY_SHIFT 1
	#define portMAX_BINARY_POINT_VALUE 0
	#elif configUNIQUE_INTERRUPT_PRIORITIES == 256
	#define portPRIORITY_SHIFT 0
	#define portMAX_BINARY_POINT_VALUE 0
	#else
	#error Invalid configUNIQUE_INTERRUPT_PRIORITIES setting. configUNIQUE_INTERRUPT_PRIORITIES must be set to the number of unique priorities implemented by the target hardware
	#endif

	/* Interrupt controller access addresses. */
	#define portICCPMR_PRIORITY_MASK_OFFSET ( 0x04 )
	#define portICCIAR_INTERRUPT_ACKNOWLEDGE_OFFSET ( 0x0C )
	#define portICCEOIR_END_OF_INTERRUPT_OFFSET ( 0x10 )
	#define portICCBPR_BINARY_POINT_OFFSET ( 0x08 )
	#define portICCRPR_RUNNING_PRIORITY_OFFSET ( 0x14 )

	#define portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS ( configINTERRUPT_CONTROLLER_BASE_ADDRESS + configINTERRUPT_CONTROLLER_CPU_INTERFACE_OFFSET )
	#define portICCPMR_PRIORITY_MASK_REGISTER ( ( ( volatile uint8_t ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCPMR_PRIORITY_MASK_OFFSET ) ) )
	#define portICCIAR_INTERRUPT_ACKNOWLEDGE_REGISTER_ADDRESS ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCIAR_INTERRUPT_ACKNOWLEDGE_OFFSET )
	#define portICCEOIR_END_OF_INTERRUPT_REGISTER_ADDRESS ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCEOIR_END_OF_INTERRUPT_OFFSET )
	#define portICCPMR_PRIORITY_MASK_REGISTER_ADDRESS ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCPMR_PRIORITY_MASK_OFFSET )
	#define portICCBPR_BINARY_POINT_REGISTER ( ( ( const volatile uint32_t ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCBPR_BINARY_POINT_OFFSET ) ) )
	#define portICCRPR_RUNNING_PRIORITY_REGISTER ( ( ( const volatile uint8_t ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCRPR_RUNNING_PRIORITY_OFFSET ) ) )

	#endif /* PORTMACRO_H */