summaryrefslogtreecommitdiff
path: root/FreeRTOS/Test/CBMC/proofs/Task/TaskResumeAll/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'FreeRTOS/Test/CBMC/proofs/Task/TaskResumeAll/README.md')
-rw-r--r--FreeRTOS/Test/CBMC/proofs/Task/TaskResumeAll/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/FreeRTOS/Test/CBMC/proofs/Task/TaskResumeAll/README.md b/FreeRTOS/Test/CBMC/proofs/Task/TaskResumeAll/README.md
new file mode 100644
index 000000000..e4e0e17ae
--- /dev/null
+++ b/FreeRTOS/Test/CBMC/proofs/Task/TaskResumeAll/README.md
@@ -0,0 +1,19 @@
+This proof demonstrates the memory safety of the TaskResumeAll function. We
+assume that task lists are initialized and filled with a few list items. We
+also assume that some global variables are set to a nondeterministic value,
+except for `uxSchedulerSuspended` which cannot be 0 and `xPendedTicks` which
+is either `1` (to unwind a loop in a reasonable amount of time) or `0`.
+
+Configurations available:
+ * `default`: The default configuration.
+ * `useTickHook1`: The default configuration with `configUSE_TICK_HOOK=1`
+
+This proof is a work-in-progress. Proof assumptions are described in
+the harness. The proof also assumes the following functions are
+memory safe and have no side effects relevant to the memory safety of
+this function:
+
+* vApplicationTickHook
+* vPortEnterCritical
+* vPortExitCritical
+* vPortGenerateSimulatedInterrupt