portmacro.h 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  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. #ifdef __cplusplus
  31. extern "C" {
  32. #endif
  33. /*-----------------------------------------------------------
  34. * Port specific definitions.
  35. *
  36. * The settings in this file configure FreeRTOS correctly for the
  37. * given hardware and compiler.
  38. *
  39. * These settings should not be altered.
  40. *-----------------------------------------------------------
  41. */
  42. /* When the FIT configurator or the Smart Configurator is used, platform.h has to be
  43. * used. */
  44. #ifndef configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H
  45. #define configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H 0
  46. #endif
  47. /* Type definitions - these are a bit legacy and not really used now, other than
  48. portSTACK_TYPE and portBASE_TYPE. */
  49. #define portCHAR char
  50. #define portFLOAT float
  51. #define portDOUBLE double
  52. #define portLONG long
  53. #define portSHORT short
  54. #define portSTACK_TYPE uint32_t
  55. #define portBASE_TYPE long
  56. typedef portSTACK_TYPE StackType_t;
  57. typedef long BaseType_t;
  58. typedef unsigned long UBaseType_t;
  59. #if( configUSE_16_BIT_TICKS == 1 )
  60. typedef uint16_t TickType_t;
  61. #define portMAX_DELAY ( TickType_t ) 0xffff
  62. #else
  63. typedef uint32_t TickType_t;
  64. #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
  65. /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  66. not need to be guarded with a critical section. */
  67. #define portTICK_TYPE_IS_ATOMIC 1
  68. #endif
  69. /*-----------------------------------------------------------*/
  70. /* Hardware specifics. */
  71. #define portBYTE_ALIGNMENT 8 /* Could make four, according to manual. */
  72. #define portSTACK_GROWTH -1
  73. #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  74. #define portNOP() __asm volatile( "NOP" )
  75. /* Yield equivalent to "*portITU_SWINTR = 0x01; ( void ) *portITU_SWINTR;"
  76. where portITU_SWINTR is the location of the software interrupt register
  77. (0x000872E0). Don't rely on the assembler to select a register, so instead
  78. save and restore clobbered registers manually. */
  79. #define portYIELD() \
  80. __asm volatile \
  81. ( \
  82. "PUSH.L R10 \n" \
  83. "MOV.L #0x872E0, R10 \n" \
  84. "MOV.B #0x1, [R10] \n" \
  85. "MOV.L [R10], R10 \n" \
  86. "POP R10 \n" \
  87. )
  88. #define portYIELD_FROM_ISR( x ) if( x != pdFALSE ) portYIELD()
  89. /* These macros should not be called directly, but through the
  90. taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros. An extra check is
  91. performed if configASSERT() is defined to ensure an assertion handler does not
  92. inadvertently attempt to lower the IPL when the call to assert was triggered
  93. because the IPL value was found to be above configMAX_SYSCALL_INTERRUPT_PRIORITY
  94. when an ISR safe FreeRTOS API function was executed. ISR safe FreeRTOS API
  95. functions are those that end in FromISR. FreeRTOS maintains a separate
  96. interrupt API to ensure API function and interrupt entry is as fast and as
  97. simple as possible. */
  98. #define portENABLE_INTERRUPTS() __asm volatile ( "MVTIPL #0" )
  99. #ifdef configASSERT
  100. #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( ( ulPortGetIPL() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )
  101. #define portDISABLE_INTERRUPTS() if( ulPortGetIPL() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) __asm volatile ( "MVTIPL %0" ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY) )
  102. #else
  103. #define portDISABLE_INTERRUPTS() __asm volatile ( "MVTIPL %0" ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY) )
  104. #endif
  105. /* Critical nesting counts are stored in the TCB. */
  106. #define portCRITICAL_NESTING_IN_TCB ( 1 )
  107. /* The critical nesting functions defined within tasks.c. */
  108. extern void vTaskEnterCritical( void );
  109. extern void vTaskExitCritical( void );
  110. #define portENTER_CRITICAL() vTaskEnterCritical()
  111. #define portEXIT_CRITICAL() vTaskExitCritical()
  112. /* As this port allows interrupt nesting... */
  113. uint32_t ulPortGetIPL( void ) __attribute__((naked));
  114. void vPortSetIPL( uint32_t ulNewIPL ) __attribute__((naked));
  115. #define portSET_INTERRUPT_MASK_FROM_ISR() ulPortGetIPL(); portDISABLE_INTERRUPTS()
  116. #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ) vPortSetIPL( uxSavedInterruptStatus )
  117. /*-----------------------------------------------------------*/
  118. /* Task function macros as described on the FreeRTOS.org WEB site. */
  119. #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
  120. #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
  121. #ifdef __cplusplus
  122. }
  123. #endif
  124. #endif /* PORTMACRO_H */