st_readme.txt 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. @verbatim
  2. ******************************************************************************
  3. *
  4. * Portions Copyright © 2019 STMicroelectronics International N.V. All rights reserved.
  5. * Portions Copyright (C) 2016 Real Time Engineers Ltd, All rights reserved
  6. *
  7. * @file st_readme.txt
  8. * @author MCD Application Team
  9. * @brief This file lists the main modification done by STMicroelectronics on
  10. * FreeRTOS for integration with STM32Cube solution.
  11. * For more details on FreeRTOS implementation on STM32Cube, please refer
  12. * to UM1722 "Developing Applications on STM32Cube with FreeRTOS"
  13. ******************************************************************************
  14. *
  15. * Copyright (c) 2019 STMicroelectronics. All rights reserved.
  16. *
  17. * This software component is licensed by ST under BSD 3-Clause license,
  18. * the "License"; You may not use this file except in compliance with the
  19. * License. You may obtain a copy of the License at:
  20. * opensource.org/licenses/BSD-3-Clause
  21. *
  22. ******************************************************************************
  23. @endverbatim
  24. =======
  25. ### 29-Mars-2019 ###
  26. =========================
  27. + cmsis_os.c : Fix bug in osPoolAlloc(): memory blocks can't be reused after being free'd
  28. + Source/CMSIS_RTOS_V2/cmsis_os, Source/CMSIS_RTOS_V2/cmsis_os1.c, Source/CMSIS_RTOS_V2/cmsis_os2.c, Source/CMSIS_RTOS_V2/cmsis_os2.h: restore original Apache license terms
  29. + st_readme.txt: update license terms to BSD-3-Clause
  30. ### 13-August-2018 ###
  31. =========================
  32. + Add empty implementation for the missing function osThreadGetStackSize()
  33. to avoid link errors when using CMSIS-RTOS V2.
  34. + Update the FreeRTOSConfig_template.h with specific defines for the
  35. CMSIS-RTOS V2.
  36. + Rename the "RTE_RTOS_FreeRTOS_XXXX" macros to "USE_FreeRTOS_XXXX" in
  37. cmsis_os2.c.
  38. ### 30-July-2018 ###
  39. =========================
  40. + Update License.txt file to MIT license instead of GPLv2
  41. ### 23-July-2018 ###
  42. =========================
  43. + Fix compiler warnings thrown by IAR compiler 8.20
  44. + Add MPU support for the CM7/r0p1:
  45. - GCC/ARM_CM7_MPU/r0p1/port.c
  46. - GCC/ARM_CM7_MPU/r0p1/portmacro.h
  47. - IAR/ARM_CM7_MPU/r0p1/port.c
  48. - IAR/ARM_CM7_MPU/r0p1/portasm.s
  49. - IAR/ARM_CM7_MPU/r0p1/portmacro.h
  50. - RVDS/ARM_CM7_MPU/r0p1/port.c
  51. - RVDS/ARM_CM7_MPU/r0p1/portmacro.h
  52. ### 09-April-2018 ###
  53. =========================
  54. Update the FreeRTOS against the latest release 10.0.1
  55. more details are available in: https://www.freertos.org/History.txt
  56. + Integrate support for tickless mode for ARM_CM0 core:
  57. - GCC/ARM_CM0/port.c
  58. - GCC/ARM_CM0/portmacro.h
  59. - IAR/ARM_CM0/port.c
  60. - IAR/ARM_CM0/portmacro.h
  61. - RVDS/ARM_CM0/port.c
  62. Integrate CMSIS-RTOSv2 wrapper based on: https://github.com/ARM-software/CMSIS-FreeRTOS/releases/tag/10.0.1
  63. + Add new files:
  64. - CMSIS_RTOS_V2/cmsis_os.h
  65. - CMSIS_RTOS_V2/cmsis_os1.c
  66. - CMSIS_RTOS_V2/cmsis_os2.c
  67. - CMSIS_RTOS_V2/cmsis_os2.h
  68. "cmsis_os1.c" and "cmsis_os1.h" contains the reference implementation of
  69. CMSIS-RTOSv1,i.e as released by ARM, using the CMSIS-RTOSV2 API.
  70. + The ST customized CMSIS-RTOSv1 is maintained under:
  71. - CMSIS_RTOS/cmsis_os.c
  72. - CMSIS_RTOS/cmsis_os.h
  73. + When using CMSIS-RTOSv2 APIs, the following FreeRTOS defines are required:
  74. - #define configMAX_PRIORITIES 56
  75. - #define configSUPPORT_STATIC_ALLOCATION 0
  76. - #define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
  77. ### 10-August-2017 ###
  78. =========================
  79. Update FreeRTOS to support MPU feature with IAR compiler.
  80. + Add the following ports:
  81. - IAR/ARM_CM4_MPU
  82. - IAR/ARM_CM7_MPU
  83. - RVDS/ARM_CM7_MPU
  84. ### 03-March-2017 ###
  85. =========================
  86. Update CMSIS-RTOS drivers to support both CMSIS Core V4.x and V5.x
  87. Bug fixes:
  88. + CMSIS-RTOS: Wrong return value for osSignalWait()
  89. + CMSIS-RTOS: Not all queue size is 0 initialized with osMailCAlloc()
  90. Limitation:
  91. + CMSIS-RTOS: osSignalWAit() function is not fully compliant with the specification
  92. ### 30-September-2016 ###
  93. =========================
  94. The purpose of this release is to Upgrade to use FreeRTOS V9.0.0, this version
  95. is a drop-in compatible replacement for FreeRTOS V8.2.3.
  96. For more details please refer to http://www.freertos.org/History.txt
  97. + Add support to tickless mode for MPU ports:
  98. - GCC/ARM_CM3_MPU/port.c
  99. - GCC/ARM_CM4_MPU/port.c
  100. - RVDS/ARM_CM4_MPU/port.c
  101. + Update CM0 ports, add possibility to use a timebase different than Systick:
  102. - IAR/ARM_CM0/port.c
  103. - RVDS/ARM_CM0/port.c
  104. - GCC/ARM_CM0/port.c
  105. + Fix compilation error in CM3_MPU and CM4_MPU ports:
  106. - GCC/ARM_CM3_MPU/portmacro.h
  107. - GCC/ARM_CM4_MPU/portmacro.h
  108. - RVDS/ARM_CM4_MPU/portmacro.h
  109. - Add "Source\portable\Common\" directory
  110. + cmsis_os.c
  111. - Add support of Statically Allocated Systems introduced with FreeRTOS V9.0.0
  112. - Add new wrappers CMSIS-RTOS APIs
  113. FreeRTOS APIs | CMSIS-RTOS APIs | Description
  114. ==================================================================================================================
  115. uxQueueMessagesWaiting() | osMessageWaiting() | Return the number of messages stored in a queue
  116. ------------------------------------------------------------------------------------------------------------------
  117. xTaskAbortDelay() | osAbortDelay() | Force a thread to get out the blocked state immediately
  118. ------------------------------------------------------------------------------------------------------------------
  119. uxSemaphoreGetCount() | osSemaphoreGetCount() | Return the current count of a semaphore
  120. ------------------------------------------------------------------------------------------------------------------
  121. uxQueueSpacesAvailable() | osMessageAvailableSpace() | Return the available space in a message queue
  122. ------------------------------------------------------------------------------------------------------------------
  123. vQueueDelete() | osMessageDelete() | Delete a message Queue
  124. ------------------------------------------------------------------------------------------------------------------
  125. ### 22-January-2016 ###
  126. =======================
  127. The purpose of this release is to Upgrade to use FreeRTOS V8.2.3.
  128. It also provides fixes for minor issues.
  129. + cmsis_os.c
  130. - Implementation of functions "osSignalSet" and "osSignalWait" are now delimited by
  131. #define configUSE_TASK_NOTIFICATIONS.
  132. - Function "osTimerStart" : fix for an assert issue when called from an ISR.
  133. - Function "osMailCreate" : internal variables initialization.
  134. - Function "osSignalWait" : signals value is now compared versus integer zero for error checking.
  135. + freeRTOS sources
  136. - FreeRTOS.h file : Add configuration sanity check in case of configUSE_RECURSIVE_MUTEXES set
  137. and configUSE_MUTEXES not set.
  138. + STMicroelectronics license simplifications, see license disclaimer within this file's header
  139. ### 27-March-2015 ###
  140. =====================
  141. The purpose of this release is to Upgrade to use FreeRTOS V8.2.1.
  142. + Major change of the version 8.2.1 is the support of CM7 core.
  143. For STM32F746xx/STM32F756xx devices, need to use port files under Source/Portable/XXX/ARM_CM7/r0p1,
  144. where XXX refers to the compiler used.
  145. + It also provides implementation of osSignal management APIs, osSignalSet() and osSignalWait(),
  146. fixes osMassage queue size, osMailQDef macro and osDelayUntil parameters.
  147. + In this release an alignment has been done in ARM_CM4 and ARM_CM3 port.c versus ARM_CM0 port.c
  148. regarding the use of macros configPRE_SLEEP_PROCESSING and configPOST_SLEEP_PROCESSING, these tow macros
  149. are now taking as parameter as pointer to TickType_t.
  150. + cmsis_os.c
  151. - Add implementation of osSignalSet() and osSignalWait() APIs
  152. - Fix massage queue size in osMessageCreate API
  153. - osDelayUntil: parameter PreviousWakeTime is now passed as a pointer.
  154. - Enabling Mail queue management APIs (temporary removed in previous version).
  155. - Function "osThreadGetPriority" uses now uxTaskPriorityGetFromISR if called from an interrupt handler, if not use uxTaskPriorityGet.
  156. + cmsis_os.h
  157. - osFeature_Wait is defined to 0 to indicate that osWait function is not available (as specified by cmsis_os template by ARM)
  158. - Fix compilation issue with osMailQDef macro.
  159. - Enabling Mail queue management APIs (temporary removed in previous version)
  160. + freeRTOS sources
  161. - ARM_CM3 port.c and ARM_CM4 port.c:
  162. function vPortSuppressTicksAndSleep : configPRE_SLEEP_PROCESSING and configPOST_SLEEP_PROCESSING are now taking
  163. as parameter as pointer to TickType_t.
  164. The purpose of this change is to align the CM3 and CM4 implementation with CM0 one.
  165. + Note
  166. - osSignalSet returns an int32_t value which is a a status (osOK or osError)
  167. instead of the previous signal value as specified in cmsis_os template by ARM.
  168. This is mainly due to freeRTOS implementation, the return value will be aligned (with the cmsis os template by ARM) as soon as the freeRTOS next version will allow it.
  169. - osThreadDef() macro is defined in the freeRTOS cmsis_os.h wrapper as follow :
  170. osThreadDef(name, thread, priority, instances, stacksz)
  171. the macro osThreadDef() as defined in ARM cmsis_os.h is defined with 4 parameters :
  172. name : name of the thread function.
  173. priority : initial priority of the thread function.
  174. instances : number of possible thread instances.
  175. stacksz : stack size (in bytes) requirements for the thread function.
  176. - osThreadDef as defined in the ARM template file cmsis_os.h assumes that the thread name is the same as the thread function name.
  177. where the freeRTOS implementation gives separate parameters for the thread name and the thread function name.
  178. care must be taken when porting an application from/to another OS to/from freeRTOS cmsis_os regarding this macro.
  179. the macro osThreadDef() as defined in ARM cmsis_os.h template is defined with 4 parameters :
  180. name : name of the thread function.
  181. priority : initial priority of the thread function.
  182. instances : number of possible thread instances.
  183. stacksz : stack size (in bytes) requirements for the thread function.
  184. the macro osThreadDef() as defined in freeRTOS cmsis_os.h is defined with 5 parameters :
  185. name : name of the thread (used for debugging and trace).
  186. thread : name of the thread function
  187. priority : initial priority of the thread function.
  188. instances : number of possible thread instances.
  189. stacksz : stack size (in bytes) requirements for the thread function.
  190. ### 25-December-2014 ###
  191. ========================
  192. The purpose of this release is to remove compilation errors and warning. It also reintroduces
  193. the function osThreadIsSuspended() which has been removed in the version V1.2.0.
  194. + cmsis_os.c
  195. - osThreadGetPriority() and makeCmsisPriority(): replace INCLUDE_vTaskPriorityGet by the correct
  196. freeRTOS constant uxTaskPriorityGet.
  197. The version 1.2.2 is using a wrong constant INCLUDE_vTaskPriorityGet, while the correct freeRTOS
  198. constant is uxTaskPriorityGet.
  199. This fix ensure a safe use of osThreadGetPriority() function.
  200. - osThreadIsSuspended(): this function has been removed in version V1.2.0, it is now available gain.
  201. User can either use this function to check if a Thread is suspended either use function osThreadGetState,
  202. which is more generic, to check the exact state of a thread.
  203. - osThreadList(): this function is now taking as argument a pointer to uint8_t instead of a pointer to int8_t.
  204. The change is made to remove a compilation warning.
  205. - osRecursiveMutexCreate(): the prototype has been changed to osMutexId osRecursiveMutexCreate (const osMutexDef_t *mutex_def)
  206. This change is made to make osRecursiveMutexCreate() compatible with function MutexCreate().
  207. It also allow the better use of the function in conjunction with the macro osMutex, note that osMutex return a
  208. "const osMutexDef_t *mutex_def".
  209. example : osMutex1Id = osRecursiveMutexCreate (osMutex(Mutex1));
  210. - Fix implementation of functions osSemaphoreWait(), osMutexRelease() and osMutexWait() by using the appropriate
  211. freeRTOS “FromISR” APIs when called from an interrupt.
  212. - Fix compilation warning when the constant INCLUDE_eTaskGetState is not defined
  213. + cmsis_os.h
  214. - osThreadIsSuspended(): add function prototype.
  215. - osThreadList(): function prototype modified as described in cmsis_os.c section.
  216. - osRecursiveMutexCreate(): function modified as described in cmsis_os.c section.
  217. + Important note:
  218. Mail Queue Management Functions are not supported in this cmsis_os version, will be added in the next release.
  219. ### 04-December-2014 ###
  220. ========================
  221. + cmsis_os.c, osSemaphoreCreate(): use vSemaphoreCreateBinary() instead of xSemaphoreCreateBinary(),
  222. to keep compatibility with application code developed on FreeRTOS V7.6.0.
  223. ### 07-November-2014 ###
  224. ========================
  225. + cmsis_os.h: modify the osThreadState enum to fix warning generated by ARMCC compiler
  226. + task.c: add preprocessor compilation condition for prvTaskIsTaskSuspended() function
  227. (it's build only when INCLUDE_vTaskSuspend option is enabled in FreeRTOSConfig.h file)
  228. ### 04-November-2014 ###
  229. ========================
  230. + Upgrade to use FreeRTOS V8.1.2 and CMSIS-RTOS V1.02.
  231. + cmsis_os.c
  232. - Almost of CMSIS-RTOS APIs are implemented for FreeRTOS
  233. - Additional wrapper APIs created for FreeRTOS
  234. + Important note:
  235. When upgrading existing application code to use this last version, the following
  236. update should be considered:
  237. - osThreadIsSuspended() is no longer public API in FreeRTOS and it should
  238. be replaced by the wrapping of eTaskGetState()
  239. - osKernelStart() API changed, must be updated
  240. - update FreeRTOSConfig.h file, taking FreeRTOSConfig_template.h file as reference
  241. ### 13-June-2014 ###
  242. ====================
  243. + FreeRTOSConfig_template.h: add this definition #define INCLUDE_xTaskGetSchedulerState 1
  244. to enable the use of xTaskGetSchedulerState() API in the
  245. application code.
  246. ### 30-April-2014 ###
  247. =====================
  248. + cmsis_os.c: add preprocessor compilation condition when calling some FreeRTOS APIs, to avoid link
  249. errors with MDK-ARM when some FreeRTOS features are not enabled in FreeRTOSConfig.h
  250. ### 22-April-2014 ###
  251. =====================
  252. + Add Tickles mode for CM0 port (IAR, GCC, RVDS).
  253. ### 18-February-2014 ###
  254. ========================
  255. + FreeRTOS V7.6.0 customized version for STM32Cube solution.
  256. * <h3><center>&copy; COPYRIGHT STMicroelectronics</center></h3>
  257. */