armv8-m: Guard portasm.h and FreeRTOS.h declarations

Some declarations in portasm.h and FreeRTOS.h will cause build errors if it's not understood by the assembler. For example the 'extern' keyword. To avoid these errors guard any such code inside a #ifdef #endif block so the code is included in C files but excluded by the preprocessor in assembly files. Signed-off-by: Ahmed Ismail <Ahmed.Ismail@arm.com>
FreeRTOS · Nov 19, 2024 · 744dc52 · 744dc52
1 parent 7e419c2
commit 744dc52
Show file tree

Hide file tree

Showing 22 changed files with 1,739 additions and 1,623 deletions.
diff --git a/include/FreeRTOS.h b/include/FreeRTOS.h
diff --git a/portable/ARMv8M/non_secure/portasm.h b/portable/ARMv8M/non_secure/portasm.h
@@ -1,6 +1,8 @@
 /*
  * FreeRTOS Kernel <DEVELOPMENT BRANCH>
  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2024 Arm Limited and/or its affiliates
+ * <open-source-office@arm.com>
  *
  * SPDX-License-Identifier: MIT
  *
@@ -35,80 +37,83 @@
 /* MPU wrappers includes. */
 #include "mpu_wrappers.h"
 
-/**
- * @brief Restore the context of the first task so that the first task starts
- * executing.
- */
-void vRestoreContextOfFirstTask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+/* Ensure that typedefs are only used by the compiler, and not by the assembler. */
+#if defined(__ICCARM__) || defined(__CC_ARM) || defined(__GNUC__)
+    /**
+     * @brief Restore the context of the first task so that the first task starts
+     * executing.
+     */
+    void vRestoreContextOfFirstTask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief Checks whether or not the processor is privileged.
- *
- * @return 1 if the processor is already privileged, 0 otherwise.
- */
-BaseType_t xIsPrivileged( void ) __attribute__( ( naked ) );
+    /**
+     * @brief Checks whether or not the processor is privileged.
+     *
+     * @return 1 if the processor is already privileged, 0 otherwise.
+     */
+    BaseType_t xIsPrivileged( void ) __attribute__( ( naked ) );
 
-/**
- * @brief Raises the privilege level by clearing the bit 0 of the CONTROL
- * register.
- *
- * @note This is a privileged function and should only be called from the kernel
- * code.
- *
- * Bit 0 of the CONTROL register defines the privilege level of Thread Mode.
- *  Bit[0] = 0 --> The processor is running privileged
- *  Bit[0] = 1 --> The processor is running unprivileged.
- */
-void vRaisePrivilege( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief Raises the privilege level by clearing the bit 0 of the CONTROL
+     * register.
+     *
+     * @note This is a privileged function and should only be called from the kernel
+     * code.
+     *
+     * Bit 0 of the CONTROL register defines the privilege level of Thread Mode.
+     *  Bit[0] = 0 --> The processor is running privileged
+     *  Bit[0] = 1 --> The processor is running unprivileged.
+     */
+    void vRaisePrivilege( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief Lowers the privilege level by setting the bit 0 of the CONTROL
- * register.
- *
- * Bit 0 of the CONTROL register defines the privilege level of Thread Mode.
- *  Bit[0] = 0 --> The processor is running privileged
- *  Bit[0] = 1 --> The processor is running unprivileged.
- */
-void vResetPrivilege( void ) __attribute__( ( naked ) );
+    /**
+     * @brief Lowers the privilege level by setting the bit 0 of the CONTROL
+     * register.
+     *
+     * Bit 0 of the CONTROL register defines the privilege level of Thread Mode.
+     *  Bit[0] = 0 --> The processor is running privileged
+     *  Bit[0] = 1 --> The processor is running unprivileged.
+     */
+    void vResetPrivilege( void ) __attribute__( ( naked ) );
 
-/**
- * @brief Starts the first task.
- */
-void vStartFirstTask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief Starts the first task.
+     */
+    void vStartFirstTask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief Disables interrupts.
- */
-uint32_t ulSetInterruptMask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief Disables interrupts.
+     */
+    uint32_t ulSetInterruptMask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief Enables interrupts.
- */
-void vClearInterruptMask( uint32_t ulMask ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief Enables interrupts.
+     */
+    void vClearInterruptMask( uint32_t ulMask ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief PendSV Exception handler.
- */
-void PendSV_Handler( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief PendSV Exception handler.
+     */
+    void PendSV_Handler( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief SVC Handler.
- */
-void SVC_Handler( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief SVC Handler.
+     */
+    void SVC_Handler( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief Allocate a Secure context for the calling task.
- *
- * @param[in] ulSecureStackSize The size of the stack to be allocated on the
- * secure side for the calling task.
- */
-void vPortAllocateSecureContext( uint32_t ulSecureStackSize ) __attribute__( ( naked ) );
+    /**
+     * @brief Allocate a Secure context for the calling task.
+     *
+     * @param[in] ulSecureStackSize The size of the stack to be allocated on the
+     * secure side for the calling task.
+     */
+    void vPortAllocateSecureContext( uint32_t ulSecureStackSize ) __attribute__( ( naked ) );
 
-/**
- * @brief Free the task's secure context.
- *
- * @param[in] pulTCB Pointer to the Task Control Block (TCB) of the task.
- */
-void vPortFreeSecureContext( uint32_t * pulTCB ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief Free the task's secure context.
+     *
+     * @param[in] pulTCB Pointer to the Task Control Block (TCB) of the task.
+     */
+    void vPortFreeSecureContext( uint32_t * pulTCB ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+#endif /* defined(__ICCARM__) || defined(__CC_ARM) || defined(__GNUC__) */
 
 #endif /* __PORT_ASM_H__ */
diff --git a/portable/GCC/ARM_CM23/non_secure/portasm.h b/portable/GCC/ARM_CM23/non_secure/portasm.h
@@ -1,6 +1,8 @@
 /*
  * FreeRTOS Kernel <DEVELOPMENT BRANCH>
  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2024 Arm Limited and/or its affiliates
+ * <open-source-office@arm.com>
  *
  * SPDX-License-Identifier: MIT
  *
@@ -35,80 +37,83 @@
 /* MPU wrappers includes. */
 #include "mpu_wrappers.h"
 
-/**
- * @brief Restore the context of the first task so that the first task starts
- * executing.
- */
-void vRestoreContextOfFirstTask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+/* Ensure that typedefs are only used by the compiler, and not by the assembler. */
+#if defined(__ICCARM__) || defined(__CC_ARM) || defined(__GNUC__)
+    /**
+     * @brief Restore the context of the first task so that the first task starts
+     * executing.
+     */
+    void vRestoreContextOfFirstTask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief Checks whether or not the processor is privileged.
- *
- * @return 1 if the processor is already privileged, 0 otherwise.
- */
-BaseType_t xIsPrivileged( void ) __attribute__( ( naked ) );
+    /**
+     * @brief Checks whether or not the processor is privileged.
+     *
+     * @return 1 if the processor is already privileged, 0 otherwise.
+     */
+    BaseType_t xIsPrivileged( void ) __attribute__( ( naked ) );
 
-/**
- * @brief Raises the privilege level by clearing the bit 0 of the CONTROL
- * register.
- *
- * @note This is a privileged function and should only be called from the kernel
- * code.
- *
- * Bit 0 of the CONTROL register defines the privilege level of Thread Mode.
- *  Bit[0] = 0 --> The processor is running privileged
- *  Bit[0] = 1 --> The processor is running unprivileged.
- */
-void vRaisePrivilege( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief Raises the privilege level by clearing the bit 0 of the CONTROL
+     * register.
+     *
+     * @note This is a privileged function and should only be called from the kernel
+     * code.
+     *
+     * Bit 0 of the CONTROL register defines the privilege level of Thread Mode.
+     *  Bit[0] = 0 --> The processor is running privileged
+     *  Bit[0] = 1 --> The processor is running unprivileged.
+     */
+    void vRaisePrivilege( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief Lowers the privilege level by setting the bit 0 of the CONTROL
- * register.
- *
- * Bit 0 of the CONTROL register defines the privilege level of Thread Mode.
- *  Bit[0] = 0 --> The processor is running privileged
- *  Bit[0] = 1 --> The processor is running unprivileged.
- */
-void vResetPrivilege( void ) __attribute__( ( naked ) );
+    /**
+     * @brief Lowers the privilege level by setting the bit 0 of the CONTROL
+     * register.
+     *
+     * Bit 0 of the CONTROL register defines the privilege level of Thread Mode.
+     *  Bit[0] = 0 --> The processor is running privileged
+     *  Bit[0] = 1 --> The processor is running unprivileged.
+     */
+    void vResetPrivilege( void ) __attribute__( ( naked ) );
 
-/**
- * @brief Starts the first task.
- */
-void vStartFirstTask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief Starts the first task.
+     */
+    void vStartFirstTask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief Disables interrupts.
- */
-uint32_t ulSetInterruptMask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief Disables interrupts.
+     */
+    uint32_t ulSetInterruptMask( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief Enables interrupts.
- */
-void vClearInterruptMask( uint32_t ulMask ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief Enables interrupts.
+     */
+    void vClearInterruptMask( uint32_t ulMask ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief PendSV Exception handler.
- */
-void PendSV_Handler( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief PendSV Exception handler.
+     */
+    void PendSV_Handler( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief SVC Handler.
- */
-void SVC_Handler( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief SVC Handler.
+     */
+    void SVC_Handler( void ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
 
-/**
- * @brief Allocate a Secure context for the calling task.
- *
- * @param[in] ulSecureStackSize The size of the stack to be allocated on the
- * secure side for the calling task.
- */
-void vPortAllocateSecureContext( uint32_t ulSecureStackSize ) __attribute__( ( naked ) );
+    /**
+     * @brief Allocate a Secure context for the calling task.
+     *
+     * @param[in] ulSecureStackSize The size of the stack to be allocated on the
+     * secure side for the calling task.
+     */
+    void vPortAllocateSecureContext( uint32_t ulSecureStackSize ) __attribute__( ( naked ) );
 
-/**
- * @brief Free the task's secure context.
- *
- * @param[in] pulTCB Pointer to the Task Control Block (TCB) of the task.
- */
-void vPortFreeSecureContext( uint32_t * pulTCB ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+    /**
+     * @brief Free the task's secure context.
+     *
+     * @param[in] pulTCB Pointer to the Task Control Block (TCB) of the task.
+     */
+    void vPortFreeSecureContext( uint32_t * pulTCB ) __attribute__( ( naked ) ) PRIVILEGED_FUNCTION;
+#endif /* defined(__ICCARM__) || defined(__CC_ARM) || defined(__GNUC__) */
 
 #endif /* __PORT_ASM_H__ */