From 8ecae4c488518df226a1847c3f27e9bf6e0c5e03 Mon Sep 17 00:00:00 2001 From: Jonatan Antoni Date: Fri, 11 Aug 2017 17:16:57 +0200 Subject: [PATCH] Updated documentation for release. --- docs/General/html/cm_revisionHistory.html | 27 ++- docs/General/html/cre_freertos_proj.html | 93 +++++++--- .../dir_46cf4373772806b8331687559c626178.html | 4 +- .../dir_4c727e77617e41be30cca75e10c711ee.html | 4 +- .../dir_6fbc6882f8daffdaafc25c2f1839223d.html | 4 +- .../dir_e7fa9f9ff84ec6f18f923fb2418bfd4b.html | 4 +- docs/General/html/examples.html | 4 +- .../html/freertos_config_h_cmsis_rtos.png | Bin 0 -> 14309 bytes .../General/html/freertos_config_h_native.png | Bin 0 -> 118681 bytes docs/General/html/functionOverview.html | 4 +- docs/General/html/group__freertos__evr.html | 4 +- .../group__freertos__evr__event__groups.html | 4 +- .../html/group__freertos__evr__heap.html | 4 +- .../html/group__freertos__evr__queue.html | 4 +- .../html/group__freertos__evr__tasks.html | 6 +- .../html/group__freertos__evr__timers.html | 4 +- .../html/group__freertos__specific.html | 4 +- docs/General/html/index.html | 5 +- docs/General/html/modules.html | 4 +- docs/General/html/navtree.js | 3 +- docs/General/html/navtreeindex0.js | 167 +++++++++--------- docs/General/html/pages.html | 7 +- docs/General/html/search/all_7.js | 3 +- docs/General/html/search/pages_5.js | 3 +- docs/General/html/tech_data.html | 5 +- docs/General/html/todo.html | 135 -------------- readme.txt | 2 +- 27 files changed, 221 insertions(+), 287 deletions(-) create mode 100644 docs/General/html/freertos_config_h_cmsis_rtos.png create mode 100644 docs/General/html/freertos_config_h_native.png delete mode 100644 docs/General/html/todo.html diff --git a/docs/General/html/cm_revisionHistory.html b/docs/General/html/cm_revisionHistory.html index 0f529f9a0..ed183030d 100644 --- a/docs/General/html/cm_revisionHistory.html +++ b/docs/General/html/cm_revisionHistory.html @@ -32,7 +32,7 @@ Logo
CMSIS-FreeRTOS -  Version 9.0.0 +  Version 9.1.0
CMSIS-RTOS2 compliant FreeRTOS Implementation
@@ -113,14 +113,35 @@
- + + +
1.0.0 Initial release
9.1.0

+

FreeRTOS 9.0.0

+

+

Maintenance release for CMSIS 5.1.0:

+
    +
  • +Added support for ARM Compiler 6 (Limitations: Not available for Cortex-M0!)
    • +
  • +Updated Cortex-A example to use IRQ Controller component
    • +
  • +Corrected stack size allocation in RTOS2 osThreadNew function
    • +
  • +Added support for OS Tick component
    • +
  • +Added documentation for configuration options (native/CMSIS-RTOS2)
    • +
  • +Debug event TaskIncrementTick level set to Detail
    • +
+

+
9.0.0 Initial release
-
Todo:
Do we add user code templates for the RTOS2 FreeRTOS implementation?\
- -
Todo:
Do we offer an SCVD file for the RTOS2 FreeRTOS implementation?
+

+Configure CMSIS-FreeRTOS

+

When you have created the CMSIS-FreeRTOS project, you can configure the real-time operating system using the FreeRTOSConfig.h file. It can be opened using the Configuration Wizard view:

+
+freertos_config_h_cmsis_rtos.png +
+

The following settings are available:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name #define Description
Minimal stack size [words] configMINIMAL_STACK_SIZE Stack for idle task and default task stack in words.
Total heap size [bytes] configTOTAL_HEAP_SIZE Heap memory size in bytes.
Kernel tick frequency [Hz] configTICK_RATE_HZ Kernel tick rate in Hz.
Timer task stack depth [words] configTIMER_TASK_STACK_DEPTH Stack for timer task in words.
Timer task priority configTIMER_TASK_PRIORITY Timer task priority.
Timer queue length configTIMER_QUEUE_LENGTH Timer command queue length.
Use time slicing configUSE_TIME_SLICING Enable setting to use time slicing.
Idle should yield configIDLE_SHOULD_YIELD Control Yield behavior of the idle task.
Check for stack overflow configCHECK_FOR_STACK_OVERFLOW Enable or disable stack overflow checking.
Use idle hook configUSE_IDLE_HOOK Enable callback function call on each idle task iteration.
Use tick hook configUSE_TICK_HOOK Enable callback function call during each tick interrupt.
Use daemon task startup hook configUSE_DAEMON_TASK_STARTUP_HOOK Enable callback function call when timer service starts.
Use malloc failed hook configUSE_MALLOC_FAILED_HOOK Enable callback function call when out of dynamic memory.

Add Event Recorder Visibility

Once the target application generates event information, it can be viewed in the µVision debugger using the Event Recorder.

@@ -187,7 +238,7 @@