portmacro.h 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  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 short
  50. #define portSTACK_TYPE uint32_t
  51. #define portBASE_TYPE long
  52. typedef portSTACK_TYPE StackType_t;
  53. typedef long BaseType_t;
  54. typedef unsigned long UBaseType_t;
  55. #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
  56. typedef uint16_t TickType_t;
  57. #define portMAX_DELAY ( TickType_t ) 0xffff
  58. #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
  59. typedef uint32_t TickType_t;
  60. #define portMAX_DELAY ( TickType_t ) ( 0xFFFFFFFFUL )
  61. #else
  62. #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  63. #endif
  64. /*-----------------------------------------------------------*/
  65. /* Hardware specifics. */
  66. #define portSTACK_GROWTH ( -1 )
  67. #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  68. #define portBYTE_ALIGNMENT 8
  69. #define portYIELD() asm volatile ( "SWI 0" )
  70. #define portNOP() asm volatile ( "NOP" )
  71. /*-----------------------------------------------------------*/
  72. /* Critical section handling. */
  73. /*
  74. * The interrupt management utilities can only be called from ARM mode. When
  75. * THUMB_INTERWORK is defined the utilities are defined as functions in
  76. * portISR.c to ensure a switch to ARM mode. When THUMB_INTERWORK is not
  77. * defined then the utilities are defined as macros here - as per other ports.
  78. */
  79. #ifdef THUMB_INTERWORK
  80. extern void vPortDisableInterruptsFromThumb( void ) __attribute__( ( naked ) );
  81. extern void vPortEnableInterruptsFromThumb( void ) __attribute__( ( naked ) );
  82. #define portDISABLE_INTERRUPTS() vPortDisableInterruptsFromThumb()
  83. #define portENABLE_INTERRUPTS() vPortEnableInterruptsFromThumb()
  84. #else
  85. #define portDISABLE_INTERRUPTS() \
  86. asm volatile ( \
  87. "STMDB SP!, {R0} \n\t" /* Push R0. */ \
  88. "MRS R0, CPSR \n\t" /* Get CPSR. */ \
  89. "ORR R0, R0, #0xC0 \n\t" /* Disable IRQ, FIQ. */ \
  90. "MSR CPSR, R0 \n\t" /* Write back modified value. */ \
  91. "LDMIA SP!, {R0} " ) /* Pop R0. */
  92. #define portENABLE_INTERRUPTS() \
  93. asm volatile ( \
  94. "STMDB SP!, {R0} \n\t" /* Push R0. */ \
  95. "MRS R0, CPSR \n\t" /* Get CPSR. */ \
  96. "BIC R0, R0, #0xC0 \n\t" /* Enable IRQ, FIQ. */ \
  97. "MSR CPSR, R0 \n\t" /* Write back modified value. */ \
  98. "LDMIA SP!, {R0} " ) /* Pop R0. */
  99. #endif /* THUMB_INTERWORK */
  100. extern void vPortEnterCritical( void );
  101. extern void vPortExitCritical( void );
  102. #define portENTER_CRITICAL() vPortEnterCritical();
  103. #define portEXIT_CRITICAL() vPortExitCritical();
  104. /*-----------------------------------------------------------*/
  105. /* Task utilities. */
  106. #define portEND_SWITCHING_ISR( xSwitchRequired ) \
  107. { \
  108. extern void vTaskSwitchContext( void ); \
  109. \
  110. if( xSwitchRequired ) \
  111. { \
  112. traceISR_EXIT_TO_SCHEDULER(); \
  113. vTaskSwitchContext(); \
  114. } \
  115. else \
  116. { \
  117. traceISR_EXIT(); \
  118. } \
  119. }
  120. /*-----------------------------------------------------------*/
  121. /* Task function macros as described on the FreeRTOS.org WEB site. */
  122. #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
  123. #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
  124. /* *INDENT-OFF* */
  125. #ifdef __cplusplus
  126. }
  127. #endif
  128. /* *INDENT-ON* */
  129. #endif /* PORTMACRO_H */