portmacro.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  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. /* *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 ( configUSE_16_BIT_TICKS == 1 )
  56. typedef uint16_t TickType_t;
  57. #define portMAX_DELAY ( TickType_t ) 0xffff
  58. #else
  59. typedef uint32_t TickType_t;
  60. #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
  61. /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  62. * not need to be guarded with a critical section. */
  63. #define portTICK_TYPE_IS_ATOMIC 1
  64. #endif
  65. /*-----------------------------------------------------------*/
  66. /* Architecture specifics. */
  67. #define portSTACK_GROWTH ( -1 )
  68. #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  69. #define portBYTE_ALIGNMENT 8
  70. /*-----------------------------------------------------------*/
  71. /* Scheduler utilities. */
  72. extern void vPortYield( void );
  73. #define portNVIC_INT_CTRL_REG ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
  74. #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
  75. #define portYIELD() vPortYield()
  76. #define portEND_SWITCHING_ISR( xSwitchRequired ) do { if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; } while( 0 )
  77. #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
  78. /*-----------------------------------------------------------*/
  79. /* Critical section management. */
  80. extern void vPortEnterCritical( void );
  81. extern void vPortExitCritical( void );
  82. extern uint32_t ulSetInterruptMaskFromISR( void );
  83. extern void vClearInterruptMaskFromISR( uint32_t ulMask );
  84. #define portSET_INTERRUPT_MASK_FROM_ISR() ulSetInterruptMaskFromISR()
  85. #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x ) vClearInterruptMaskFromISR( x )
  86. #define portDISABLE_INTERRUPTS() __disable_irq()
  87. #define portENABLE_INTERRUPTS() __enable_irq()
  88. #define portENTER_CRITICAL() vPortEnterCritical()
  89. #define portEXIT_CRITICAL() vPortExitCritical()
  90. /*-----------------------------------------------------------*/
  91. /* Tickless idle/low power functionality. */
  92. #ifndef portSUPPRESS_TICKS_AND_SLEEP
  93. extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
  94. #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )
  95. #endif
  96. /*-----------------------------------------------------------*/
  97. /* Task function macros as described on the FreeRTOS.org WEB site. */
  98. #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters )
  99. #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters )
  100. #define portNOP()
  101. /* *INDENT-OFF* */
  102. #ifdef __cplusplus
  103. }
  104. #endif
  105. /* *INDENT-ON* */
  106. #endif /* PORTMACRO_H */