Add a documentation note about the concurrency errors over SPI and UART

zehortigoza · zehortigoza · commit ece20c7fde9c · 2015-08-11T19:43:20.000-03:00
In future we add support to several users use the same SPI and UART but
for now it will cause several errors.

Signed-off-by: José Roberto de Souza &lt;jose.souza@intel.com&gt;
diff --git a/src/lib/io/include/sol-spi.h b/src/lib/io/include/sol-spi.h
@@ -105,6 +105,9 @@ void sol_spi_close(struct sol_spi *spi);
  * @param bus The SPI bus number to open
  * @param config The SPI bus configuration
  * @return A new SPI bus handle
+ *
+ * @note For now it only supports one user of the bus at time, 2 or mode devices
+ * with different chip select on the same bus will cause concurrency errors.
  */
 struct sol_spi *sol_spi_open(unsigned int bus, const struct sol_spi_config *config);
 
diff --git a/src/lib/io/include/sol-uart.h b/src/lib/io/include/sol-uart.h
@@ -98,6 +98,9 @@ struct sol_uart_config {
  * ttyACM0 in small OSes it should be a id number.
  * @param config The UART bus configuration
  * @return A new UART bus handle
+ *
+ * @note For now it only supports one user of each port at time, 2 or more users
+ * on the same port will cause several concurrency errors.
  */
 struct sol_uart *sol_uart_open(const char *port_name, const struct sol_uart_config *config);
 
