portmacro.h 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  1. /*
  2. FreeRTOS V8.2.3 - Copyright (C) 2015 Real Time Engineers Ltd.
  3. All rights reserved
  4. VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
  5. This file is part of the FreeRTOS distribution.
  6. FreeRTOS is free software; you can redistribute it and/or modify it under
  7. the terms of the GNU General Public License (version 2) as published by the
  8. Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.
  9. ***************************************************************************
  10. >>! NOTE: The modification to the GPL is included to allow you to !<<
  11. >>! distribute a combined work that includes FreeRTOS without being !<<
  12. >>! obliged to provide the source code for proprietary components !<<
  13. >>! outside of the FreeRTOS kernel. !<<
  14. ***************************************************************************
  15. FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
  16. WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17. FOR A PARTICULAR PURPOSE. Full license text is available on the following
  18. link: http://www.freertos.org/a00114.html
  19. ***************************************************************************
  20. * *
  21. * FreeRTOS provides completely free yet professionally developed, *
  22. * robust, strictly quality controlled, supported, and cross *
  23. * platform software that is more than just the market leader, it *
  24. * is the industry's de facto standard. *
  25. * *
  26. * Help yourself get started quickly while simultaneously helping *
  27. * to support the FreeRTOS project by purchasing a FreeRTOS *
  28. * tutorial book, reference manual, or both: *
  29. * http://www.FreeRTOS.org/Documentation *
  30. * *
  31. ***************************************************************************
  32. http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
  33. the FAQ page "My application does not run, what could be wrong?". Have you
  34. defined configASSERT()?
  35. http://www.FreeRTOS.org/support - In return for receiving this top quality
  36. embedded software for free we request you assist our global community by
  37. participating in the support forum.
  38. http://www.FreeRTOS.org/training - Investing in training allows your team to
  39. be as productive as possible as early as possible. Now you can receive
  40. FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
  41. Ltd, and the world's leading authority on the world's leading RTOS.
  42. http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
  43. including FreeRTOS+Trace - an indispensable productivity tool, a DOS
  44. compatible FAT file system, and our tiny thread aware UDP/IP stack.
  45. http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
  46. Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
  47. http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
  48. Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
  49. licenses offer ticketed support, indemnification and commercial middleware.
  50. http://www.SafeRTOS.com - High Integrity Systems also provide a safety
  51. engineered and independently SIL3 certified version for use in safety and
  52. mission critical applications that require provable dependability.
  53. 1 tab == 4 spaces!
  54. */
  55. #ifndef PORTMACRO_H
  56. #define PORTMACRO_H
  57. #ifdef __cplusplus
  58. extern "C" {
  59. #endif
  60. /*-----------------------------------------------------------
  61. * Port specific definitions.
  62. *
  63. * The settings in this file configure FreeRTOS correctly for the
  64. * given hardware and compiler.
  65. *
  66. * These settings should not be altered.
  67. *-----------------------------------------------------------
  68. */
  69. /* Type definitions. */
  70. #define portCHAR char
  71. #define portFLOAT float
  72. #define portDOUBLE double
  73. #define portLONG long
  74. #define portSHORT short
  75. #define portSTACK_TYPE uint32_t
  76. #define portBASE_TYPE long
  77. typedef portSTACK_TYPE StackType_t;
  78. typedef long BaseType_t;
  79. typedef unsigned long UBaseType_t;
  80. #if( configUSE_16_BIT_TICKS == 1 )
  81. typedef uint16_t TickType_t;
  82. #define portMAX_DELAY ( TickType_t ) 0xffff
  83. #else
  84. typedef uint32_t TickType_t;
  85. #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
  86. /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  87. not need to be guarded with a critical section. */
  88. #define portTICK_TYPE_IS_ATOMIC 1
  89. #endif
  90. /*-----------------------------------------------------------*/
  91. /* Architecture specifics. */
  92. #define portSTACK_GROWTH ( -1 )
  93. #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  94. #define portBYTE_ALIGNMENT 8
  95. /* Constants used with memory barrier intrinsics. */
  96. #define portSY_FULL_READ_WRITE ( 15 )
  97. /*-----------------------------------------------------------*/
  98. /* Scheduler utilities. */
  99. #define portYIELD() \
  100. { \
  101. /* Set a PendSV to request a context switch. */ \
  102. portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \
  103. \
  104. /* Barriers are normally not required but do ensure the code is completely \
  105. within the specified behaviour for the architecture. */ \
  106. __dsb( portSY_FULL_READ_WRITE ); \
  107. __isb( portSY_FULL_READ_WRITE ); \
  108. }
  109. /*-----------------------------------------------------------*/
  110. #define portNVIC_INT_CTRL_REG ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )
  111. #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
  112. #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired != pdFALSE ) portYIELD()
  113. #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
  114. /*-----------------------------------------------------------*/
  115. /* Critical section management. */
  116. extern void vPortEnterCritical( void );
  117. extern void vPortExitCritical( void );
  118. #define portDISABLE_INTERRUPTS() vPortRaiseBASEPRI()
  119. #define portENABLE_INTERRUPTS() vPortSetBASEPRI( 0 )
  120. #define portENTER_CRITICAL() vPortEnterCritical()
  121. #define portEXIT_CRITICAL() vPortExitCritical()
  122. #define portSET_INTERRUPT_MASK_FROM_ISR() ulPortRaiseBASEPRI()
  123. #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x) vPortSetBASEPRI(x)
  124. /*-----------------------------------------------------------*/
  125. /* Tickless idle/low power functionality. */
  126. #ifndef portSUPPRESS_TICKS_AND_SLEEP
  127. extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
  128. #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )
  129. #endif
  130. /*-----------------------------------------------------------*/
  131. /* Port specific optimisations. */
  132. #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
  133. #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
  134. #endif
  135. #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
  136. /* Check the configuration. */
  137. #if( configMAX_PRIORITIES > 32 )
  138. #error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32. It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.
  139. #endif
  140. /* Store/clear the ready priorities in a bit map. */
  141. #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
  142. #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
  143. /*-----------------------------------------------------------*/
  144. #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __clz( ( uxReadyPriorities ) ) )
  145. #endif /* taskRECORD_READY_PRIORITY */
  146. /*-----------------------------------------------------------*/
  147. /* Task function macros as described on the FreeRTOS.org WEB site. These are
  148. not necessary for to use this port. They are defined so the common demo files
  149. (which build with all the ports) will build. */
  150. #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
  151. #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
  152. /*-----------------------------------------------------------*/
  153. #ifdef configASSERT
  154. void vPortValidateInterruptPriority( void );
  155. #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() vPortValidateInterruptPriority()
  156. #endif
  157. /* portNOP() is not required by this port. */
  158. #define portNOP()
  159. #ifndef portFORCE_INLINE
  160. #define portFORCE_INLINE __forceinline
  161. #endif
  162. /*-----------------------------------------------------------*/
  163. static portFORCE_INLINE void vPortSetBASEPRI( uint32_t ulBASEPRI )
  164. {
  165. __asm
  166. {
  167. /* Barrier instructions are not used as this function is only used to
  168. lower the BASEPRI value. */
  169. msr basepri, ulBASEPRI
  170. }
  171. }
  172. /*-----------------------------------------------------------*/
  173. static portFORCE_INLINE void vPortRaiseBASEPRI( void )
  174. {
  175. uint32_t ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;
  176. __asm
  177. {
  178. /* Set BASEPRI to the max syscall priority to effect a critical
  179. section. */
  180. msr basepri, ulNewBASEPRI
  181. dsb
  182. isb
  183. }
  184. }
  185. /*-----------------------------------------------------------*/
  186. static portFORCE_INLINE uint32_t ulPortRaiseBASEPRI( void )
  187. {
  188. uint32_t ulReturn, ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;
  189. __asm
  190. {
  191. /* Set BASEPRI to the max syscall priority to effect a critical
  192. section. */
  193. mrs ulReturn, basepri
  194. msr basepri, ulNewBASEPRI
  195. dsb
  196. isb
  197. }
  198. return ulReturn;
  199. }
  200. /*-----------------------------------------------------------*/
  201. #ifdef __cplusplus
  202. }
  203. #endif
  204. #endif /* PORTMACRO_H */