From ebf5118a6b0e6dd0fba41c232f76a456dc37cbb6 Mon Sep 17 00:00:00 2001 From: ReservedField Date: Mon, 24 Oct 2016 21:17:12 +0200 Subject: [PATCH] Update readme for thread/ISR safety --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 58ab828..d67d65c 100644 --- a/README.md +++ b/README.md @@ -313,6 +313,14 @@ The following environment/make variables are available: FP bugs. Do *not* use this unless you fully understand what it means (no, it won't make you binaries smaller or faster, even if you don't use the FPU). +Thread/ISR safety +----------------- + +Unless otherwise specified by the documentation, SDK functions are thread-safe and ISR-safe. +A function is thread-safe when it can be used concurrently by multiple threads. ISR-safety, on +the other hand, is not strictly about interrupt concurrency: it means that the function can be +called from ISR/callback contexts. Don't call non ISR-safe functions from these contexts. + Reporting bugs --------------