summaryrefslogtreecommitdiffstats
path: root/watch-library/shared
diff options
context:
space:
mode:
authorJoey Castillo <joeycastillo@utexas.edu>2022-01-27 10:51:15 -0500
committerJoey Castillo <joeycastillo@utexas.edu>2022-01-27 10:51:15 -0500
commit14e4562b7a44ab6882180b69145665d4920769ac (patch)
tree89506572890224a498383b748d620e80839208c3 /watch-library/shared
parent29fa6052831f8d26815405d4652b5799e3c74147 (diff)
downloadSensor-Watch-14e4562b7a44ab6882180b69145665d4920769ac.tar.gz
Sensor-Watch-14e4562b7a44ab6882180b69145665d4920769ac.tar.bz2
Sensor-Watch-14e4562b7a44ab6882180b69145665d4920769ac.zip
add SPI to the index
Diffstat (limited to 'watch-library/shared')
-rw-r--r--watch-library/shared/watch/watch.h3
-rw-r--r--watch-library/shared/watch/watch_spi.h5
-rw-r--r--watch-library/shared/watch/watch_uart.h2
3 files changed, 6 insertions, 4 deletions
diff --git a/watch-library/shared/watch/watch.h b/watch-library/shared/watch/watch.h
index 8e47594c..3fbad812 100644
--- a/watch-library/shared/watch/watch.h
+++ b/watch-library/shared/watch/watch.h
@@ -46,7 +46,8 @@
- @ref gpio - This section covers functions related to general-purpose input and output signals.
- @ref i2c - This section covers functions related to the SAM L22's built-I2C driver, including configuring
the I2C bus, putting values directly on the bus and reading data from registers on I2C devices.
- - @ref debug - This section covers functions related to the debug UART, available on pin D1 of the 9-pin connector.
+ - @ref spi - This section covers functions related to the SAM L22's built-in SPI driver.
+ - @ref uart - This section covers functions related to the UART peripheral.
- @ref deepsleep - This section covers functions related to preparing for and entering BACKUP mode, the
deepest sleep mode available on the SAM L22.
*/
diff --git a/watch-library/shared/watch/watch_spi.h b/watch-library/shared/watch/watch_spi.h
index b72b0e0b..ae0554b6 100644
--- a/watch-library/shared/watch/watch_spi.h
+++ b/watch-library/shared/watch/watch_spi.h
@@ -56,8 +56,9 @@ bool watch_spi_write(const uint8_t *buf, uint16_t length);
bool watch_spi_read(uint8_t *buf, uint16_t length);
/** @brief Reads a series of values from a device on the SPI bus.
- * @param buf Storage for the incoming bytes; on return, it will contain the received data.
- * @param length The number of bytes that you wish to receive.
+ * @param data_out Storage for outgoing bytes.
+ * @param data_in Storage for incoming bytes.
+ * @param length The number of bytes to transfer.
* @note This function does not manage the chip select pin (usually A3).
*/
bool watch_spi_transfer(const uint8_t *data_out, uint8_t *data_in, uint16_t length);
diff --git a/watch-library/shared/watch/watch_uart.h b/watch-library/shared/watch/watch_uart.h
index 04a53e4e..79fcd53a 100644
--- a/watch-library/shared/watch/watch_uart.h
+++ b/watch-library/shared/watch/watch_uart.h
@@ -27,7 +27,7 @@
#include "watch.h"
-/** @addtogroup debug UART
+/** @addtogroup uart UART
* @brief This section covers functions related to the UART peripheral.
**/
/// @{