Make the RPP layer thread safe

[pes-rpp/rpp-lib.git] / rpp / include / rpp / irc.h

diff --git a/rpp/include/rpp/irc.h b/rpp/include/rpp/irc.h
index 0af093217b513c2208433d39d7b5a7655bfed8be..8b1a000b292d280826cb210befb80f84a4c94ddb 100644 (file)
--- a/rpp/include/rpp/irc.h
+++ b/rpp/include/rpp/irc.h
@@ -24,7 +24,9 @@
 /**
  * IRC module initialization.
  *
- * Call this fuction before using this module.
+ * This function is not thread safe. Do not call it from multiple threads.
+ *
+ * Call this function before using this module.
  *
  * @return SUCCESS    if initialization successful.\n
  *         FAILURE    if module already initialized.
@@ -34,6 +36,8 @@ int8_t rpp_irc_init();
 /**
  * IRC enable
  *
+ * The function is thread safe, unless compiled with -DRPP_THREADSAFE=0.
+ *
  * Call this function to enable IRC.
  * Reconfigures PINMUX register and enables N2HET program for specified IRC.
  * After calling this method corresponding pins are not usable as DIN.
@@ -51,6 +55,8 @@ int8_t rpp_irc_enable(uint8_t irc);
 /**
  * Check IRC status.
  *
+ * The function is thread safe, unless compiled with -DRPP_THREADSAFE=0.
+ *
  * @param[in] irc IRC sensor connection number.\n
  *                RPP_IRC_1 IRC connected to DIN10, DIN11\n
  *                RPP_IRC_2 IRC connected to DIN14, DIN15\n
@@ -65,6 +71,8 @@ int8_t rpp_irc_status(uint8_t irc);
 /**
  * Get the current value.
  *
+ * The function is thread safe, unless compiled with -DRPP_THREADSAFE=0.
+ *
  * @param[in] irc IRC sensor connection number.\n
  *                RPP_IRC_1 IRC connected to DIN10, DIN11\n
  *                RPP_IRC_2 IRC connected to DIN14, DIN15\n
@@ -76,6 +84,8 @@ int32_t rpp_irc_get(uint8_t irc);
 /**
  * IRC disable
  *
+ * The function is thread safe, unless compiled with -DRPP_THREADSAFE=0.
+ *
  * Call this function to disable IRC.
  * This function reenables the DIN functionality.
  *