summaryrefslogtreecommitdiffstats
path: root/watch-library/shared/watch/watch_spi.h
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/watch/watch_spi.h
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/watch/watch_spi.h')
-rw-r--r--watch-library/shared/watch/watch_spi.h5
1 files changed, 3 insertions, 2 deletions
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);