portmacro.h 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. /*
  2. * FreeRTOS Kernel V10.4.6
  3. * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  4. *
  5. * SPDX-License-Identifier: MIT
  6. *
  7. * Permission is hereby granted, free of charge, to any person obtaining a copy of
  8. * this software and associated documentation files (the "Software"), to deal in
  9. * the Software without restriction, including without limitation the rights to
  10. * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
  11. * the Software, and to permit persons to whom the Software is furnished to do so,
  12. * subject to the following conditions:
  13. *
  14. * The above copyright notice and this permission notice shall be included in all
  15. * copies or substantial portions of the Software.
  16. *
  17. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  19. * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  20. * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  21. * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23. *
  24. * https://www.FreeRTOS.org
  25. * https://github.com/FreeRTOS
  26. *
  27. */
  28. #ifndef PORTMACRO_H
  29. #define PORTMACRO_H
  30. /* Hardware specifics. */
  31. #include <intrinsics.h>
  32. #ifdef __cplusplus
  33. extern "C" {
  34. #endif
  35. /*-----------------------------------------------------------
  36. * Port specific definitions.
  37. *
  38. * The settings in this file configure FreeRTOS correctly for the
  39. * given hardware and compiler.
  40. *
  41. * These settings should not be altered.
  42. *-----------------------------------------------------------
  43. */
  44. /* When the FIT configurator or the Smart Configurator is used, platform.h has to be
  45. * used. */
  46. #ifndef configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H
  47. #define configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H 0
  48. #endif
  49. /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or undefined) then each task will
  50. * be created without a DPFPU context, and a task must call vTaskUsesDPFPU() before
  51. * making use of any DPFPU registers. If configUSE_TASK_DPFPU_SUPPORT is set to 2 then
  52. * tasks are created with a DPFPU context by default, and calling vTaskUsesDPFPU() has
  53. * no effect. If configUSE_TASK_DPFPU_SUPPORT is set to 0 then tasks never take care
  54. * of any DPFPU context (even if DPFPU registers are used). */
  55. #ifndef configUSE_TASK_DPFPU_SUPPORT
  56. #define configUSE_TASK_DPFPU_SUPPORT 1
  57. #endif
  58. /*-----------------------------------------------------------*/
  59. /* Type definitions - these are a bit legacy and not really used now, other than
  60. * portSTACK_TYPE and portBASE_TYPE. */
  61. #define portCHAR char
  62. #define portFLOAT float
  63. #define portDOUBLE double
  64. #define portLONG long
  65. #define portSHORT short
  66. #define portSTACK_TYPE uint32_t
  67. #define portBASE_TYPE long
  68. typedef portSTACK_TYPE StackType_t;
  69. typedef long BaseType_t;
  70. typedef unsigned long UBaseType_t;
  71. #if ( configUSE_16_BIT_TICKS == 1 )
  72. typedef uint16_t TickType_t;
  73. #define portMAX_DELAY ( TickType_t ) 0xffff
  74. #else
  75. typedef uint32_t TickType_t;
  76. #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
  77. /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  78. * not need to be guarded with a critical section. */
  79. #define portTICK_TYPE_IS_ATOMIC 1
  80. #endif
  81. /*-----------------------------------------------------------*/
  82. /* Hardware specifics. */
  83. #define portBYTE_ALIGNMENT 8 /* Could make four, according to manual. */
  84. #define portSTACK_GROWTH -1
  85. #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  86. #define portNOP() __no_operation()
  87. /* Yield equivalent to "*portITU_SWINTR = 0x01; ( void ) *portITU_SWINTR;"
  88. * where portITU_SWINTR is the location of the software interrupt register
  89. * (0x000872E0). Don't rely on the assembler to select a register, so instead
  90. * save and restore clobbered registers manually. */
  91. #define portYIELD() \
  92. __asm volatile \
  93. ( \
  94. "PUSH.L R10 \n"\
  95. "MOV.L #0x872E0, R10 \n"\
  96. "MOV.B #0x1, [R10] \n"\
  97. "CMP [R10].UB, R10 \n"\
  98. "POP R10 \n"\
  99. portCDT_NO_PARSE( ::: ) "cc"\
  100. )
  101. #define portYIELD_FROM_ISR( x ) do { if( ( x ) != pdFALSE ) portYIELD(); } while( 0 )
  102. /* Workaround to reduce errors/warnings caused by e2 studio CDT's INDEXER and CODAN. */
  103. #ifdef __CDT_PARSER__
  104. #ifndef __asm
  105. #define __asm asm
  106. #endif
  107. #ifndef __attribute__
  108. #define __attribute__( ... )
  109. #endif
  110. #define portCDT_NO_PARSE( token )
  111. #else
  112. #define portCDT_NO_PARSE( token ) token
  113. #endif
  114. /* These macros should not be called directly, but through the
  115. * taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros. An extra check is
  116. * performed if configASSERT() is defined to ensure an assertion handler does not
  117. * inadvertently attempt to lower the IPL when the call to assert was triggered
  118. * because the IPL value was found to be above configMAX_SYSCALL_INTERRUPT_PRIORITY
  119. * when an ISR safe FreeRTOS API function was executed. ISR safe FreeRTOS API
  120. * functions are those that end in FromISR. FreeRTOS maintains a separate
  121. * interrupt API to ensure API function and interrupt entry is as fast and as
  122. * simple as possible. */
  123. #define portENABLE_INTERRUPTS() __set_interrupt_level( ( uint8_t ) 0 )
  124. #ifdef configASSERT
  125. #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( ( __get_interrupt_level() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )
  126. #define portDISABLE_INTERRUPTS() if( __get_interrupt_level() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) __set_interrupt_level( ( uint8_t ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
  127. #else
  128. #define portDISABLE_INTERRUPTS() __set_interrupt_level( ( uint8_t ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
  129. #endif
  130. /* Critical nesting counts are stored in the TCB. */
  131. #define portCRITICAL_NESTING_IN_TCB ( 1 )
  132. /* The critical nesting functions defined within tasks.c. */
  133. extern void vTaskEnterCritical( void );
  134. extern void vTaskExitCritical( void );
  135. #define portENTER_CRITICAL() vTaskEnterCritical()
  136. #define portEXIT_CRITICAL() vTaskExitCritical()
  137. /* As this port allows interrupt nesting... */
  138. #define portSET_INTERRUPT_MASK_FROM_ISR() __get_interrupt_level(); portDISABLE_INTERRUPTS()
  139. #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ) __set_interrupt_level( ( uint8_t ) ( uxSavedInterruptStatus ) )
  140. /*-----------------------------------------------------------*/
  141. /* Task function macros as described on the FreeRTOS.org WEB site. */
  142. #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
  143. #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
  144. /*-----------------------------------------------------------*/
  145. /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or left undefined) then tasks are
  146. * created without a DPFPU context and must call vPortTaskUsesDPFPU() to give
  147. * themselves a DPFPU context before using any DPFPU instructions. If
  148. * configUSE_TASK_DPFPU_SUPPORT is set to 2 then all tasks will have a DPFPU context
  149. * by default. */
  150. #if( configUSE_TASK_DPFPU_SUPPORT == 1 )
  151. void vPortTaskUsesDPFPU( void );
  152. #else
  153. /* Each task has a DPFPU context already, so define this function away to
  154. * nothing to prevent it being called accidentally. */
  155. #define vPortTaskUsesDPFPU()
  156. #endif
  157. #define portTASK_USES_DPFPU() vPortTaskUsesDPFPU()
  158. /* Definition to allow compatibility with existing FreeRTOS Demo using flop.c. */
  159. #define portTASK_USES_FLOATING_POINT() vPortTaskUsesDPFPU()
  160. /* Prevent warnings of undefined behaviour: the order of volatile accesses is
  161. * undefined - all warnings have been manually checked and are not an issue, and
  162. * the warnings cannot be prevent by code changes without undesirable effects. */
  163. #pragma diag_suppress=Pa082
  164. #ifdef __cplusplus
  165. }
  166. #endif
  167. #endif /* PORTMACRO_H */