portmacro.h 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /*
  2. * FreeRTOS Kernel <DEVELOPMENT BRANCH>
  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. /* *INDENT-OFF* */
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34. /* *INDENT-ON* */
  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. /* Type definitions. */
  45. #define portCHAR char
  46. #define portFLOAT float
  47. #define portDOUBLE double
  48. #define portLONG long
  49. #define portSHORT int
  50. #define portSTACK_TYPE uint16_t
  51. #define portBASE_TYPE short
  52. #define portPOINTER_SIZE_TYPE uint16_t
  53. typedef portSTACK_TYPE StackType_t;
  54. typedef short BaseType_t;
  55. typedef unsigned short UBaseType_t;
  56. #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
  57. typedef uint16_t TickType_t;
  58. #define portMAX_DELAY ( TickType_t ) 0xffff
  59. #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
  60. typedef uint32_t TickType_t;
  61. #define portMAX_DELAY ( TickType_t ) ( 0xFFFFFFFFUL )
  62. #else
  63. #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  64. #endif
  65. /*-----------------------------------------------------------*/
  66. /* Interrupt control macros. */
  67. #define portDISABLE_INTERRUPTS() asm volatile ( "DINT" ); asm volatile ( "NOP" )
  68. #define portENABLE_INTERRUPTS() asm volatile ( "EINT" ); asm volatile ( "NOP" )
  69. /*-----------------------------------------------------------*/
  70. /* Critical section control macros. */
  71. #define portNO_CRITICAL_SECTION_NESTING ( ( uint16_t ) 0 )
  72. #define portENTER_CRITICAL() \
  73. { \
  74. extern volatile uint16_t usCriticalNesting; \
  75. \
  76. portDISABLE_INTERRUPTS(); \
  77. \
  78. /* Now that interrupts are disabled, ulCriticalNesting can be accessed */ \
  79. /* directly. Increment ulCriticalNesting to keep a count of how many */ \
  80. /* times portENTER_CRITICAL() has been called. */ \
  81. usCriticalNesting++; \
  82. }
  83. #define portEXIT_CRITICAL() \
  84. { \
  85. extern volatile uint16_t usCriticalNesting; \
  86. \
  87. if( usCriticalNesting > portNO_CRITICAL_SECTION_NESTING ) \
  88. { \
  89. /* Decrement the nesting count as we are leaving a critical section. */ \
  90. usCriticalNesting--; \
  91. \
  92. /* If the nesting level has reached zero then interrupts should be */ \
  93. /* re-enabled. */ \
  94. if( usCriticalNesting == portNO_CRITICAL_SECTION_NESTING ) \
  95. { \
  96. portENABLE_INTERRUPTS(); \
  97. } \
  98. } \
  99. }
  100. /*-----------------------------------------------------------*/
  101. /* Task utilities. */
  102. extern void vPortYield( void ) __attribute__( ( naked ) );
  103. #define portYIELD() vPortYield()
  104. #define portNOP() asm volatile ( "NOP" )
  105. /*-----------------------------------------------------------*/
  106. /* Hardware specifics. */
  107. #define portBYTE_ALIGNMENT 2
  108. #define portSTACK_GROWTH ( -1 )
  109. #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  110. /* GCC used to define these but doesn't any more */
  111. #define interrupt(vector) __attribute__((__interrupt__(vector)))
  112. #define wakeup __attribute__((__wakeup__))
  113. /*-----------------------------------------------------------*/
  114. /* Task function macros as described on the FreeRTOS.org WEB site. */
  115. #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
  116. #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
  117. /* *INDENT-OFF* */
  118. #ifdef __cplusplus
  119. }
  120. #endif
  121. /* *INDENT-ON* */
  122. #endif /* PORTMACRO_H */