summaryrefslogtreecommitdiff
path: root/FreeRTOS/Test/CBMC/proofs/Queue/QueueGetMutexHolder/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'FreeRTOS/Test/CBMC/proofs/Queue/QueueGetMutexHolder/README.md')
-rw-r--r--FreeRTOS/Test/CBMC/proofs/Queue/QueueGetMutexHolder/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/FreeRTOS/Test/CBMC/proofs/Queue/QueueGetMutexHolder/README.md b/FreeRTOS/Test/CBMC/proofs/Queue/QueueGetMutexHolder/README.md
new file mode 100644
index 000000000..d028ea9e7
--- /dev/null
+++ b/FreeRTOS/Test/CBMC/proofs/Queue/QueueGetMutexHolder/README.md
@@ -0,0 +1,10 @@
+This harness proves the memory safety of QueueGetMutexHolder assuming the passed
+semaphore is not null.
+
+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:
+
+* vPortEnterCritical
+* vPortExitCritical