Make the RPP layer thread safe

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

diff --git a/rpp/include/rpp/adc.h b/rpp/include/rpp/adc.h
index 02e9c9c52bce1f14ccfed1f639ee68eb6eaa2fe6..0894aff849f39d90ea9678f59cc5fbb9a5b889ca 100644 (file)
--- a/rpp/include/rpp/adc.h
+++ b/rpp/include/rpp/adc.h
@@ -17,6 +17,8 @@
  *
  * Call this method before using this module.
  *
+ * This function is not thread safe. Do not call it from multiple threads.
+ *
  * @return SUCCESS if initialization successful.\n
  *         FAILURE if module already initialized.
  */
@@ -27,6 +29,8 @@ int8_t rpp_adc_init();
 /**
  * Get the current analog value on the given pin.
  *
+ * The function is thread thread safe.
+ *
  * @param[in] pin       The pin number to read [1-16].
  *
  * @return [0-4095] Value representing the analog value on given pin
@@ -37,6 +41,8 @@ int8_t rpp_adc_init();
 /**
  * Get the current analog value on the given pin.
  *
+ * The function is thread safe.
+ *
  * @param[in] pin       The pin number to read [1-12].
  *
  * @return [0-4095] Value representing the analog value on given pin
@@ -50,6 +56,8 @@ int16_t rpp_adc_get(uint8_t pin);
 /**
  * Read and update analog cached values.
  *
+ * The function is thread safe.
+ *
  * @return SUCCESS when transaction was successful.\n
  *         FAILURE if transaction could not be confirmed.
  */