add SPI to the index

This commit is contained in:
Joey Castillo 2022-01-27 10:51:15 -05:00
parent 29fa605283
commit 14e4562b7a
3 changed files with 6 additions and 4 deletions

View File

@ -46,7 +46,8 @@
- @ref gpio - This section covers functions related to general-purpose input and output signals. - @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 - @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. 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 - @ref deepsleep - This section covers functions related to preparing for and entering BACKUP mode, the
deepest sleep mode available on the SAM L22. deepest sleep mode available on the SAM L22.
*/ */

View File

@ -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); bool watch_spi_read(uint8_t *buf, uint16_t length);
/** @brief Reads a series of values from a device on the SPI bus. /** @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 data_out Storage for outgoing bytes.
* @param length The number of bytes that you wish to receive. * @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). * @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); bool watch_spi_transfer(const uint8_t *data_out, uint8_t *data_in, uint16_t length);

View File

@ -27,7 +27,7 @@
#include "watch.h" #include "watch.h"
/** @addtogroup debug UART /** @addtogroup uart UART
* @brief This section covers functions related to the UART peripheral. * @brief This section covers functions related to the UART peripheral.
**/ **/
/// @{ /// @{