diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-11 11:48:03 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-11 11:48:03 +0000 |
| commit | 7c2a8e13d969029fb675e67c57349c1deaa09284 (patch) | |
| tree | b5ac48d0272cccf258c22f658f9589bcf0f6cc1c /os/hal/templates/spi_lld.c | |
| parent | 8cbeb405b96f12df958a75bcbc1af072ceb0e26e (diff) | |
| download | ChibiOS-7c2a8e13d969029fb675e67c57349c1deaa09284.tar.gz ChibiOS-7c2a8e13d969029fb675e67c57349c1deaa09284.tar.bz2 ChibiOS-7c2a8e13d969029fb675e67c57349c1deaa09284.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2246 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/templates/spi_lld.c')
| -rw-r--r-- | os/hal/templates/spi_lld.c | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/os/hal/templates/spi_lld.c b/os/hal/templates/spi_lld.c index 19af51488..d2a9f9557 100644 --- a/os/hal/templates/spi_lld.c +++ b/os/hal/templates/spi_lld.c @@ -110,9 +110,9 @@ void spi_lld_unselect(SPIDriver *spip) { /**
* @brief Ignores data on the SPI bus.
- * @details This function transmits a series of idle words on the SPI bus and
- * ignores the received data. This function can be invoked even
- * when a slave select signal has not been yet asserted.
+ * @details This asynchronous function starts the transmission of a series of
+ * idle words on the SPI bus and ignores the received data.
+ * @post At the end of the operation the configured callback is invoked.
*
* @param[in] spip pointer to the @p SPIDriver object
* @param[in] n number of words to be ignored
@@ -125,7 +125,9 @@ void spi_lld_ignore(SPIDriver *spip, size_t n) { /**
* @brief Exchanges data on the SPI bus.
- * @details This function performs a simultaneous transmit/receive operation.
+ * @details This asynchronous function starts a simultaneous transmit/receive
+ * operation.
+ * @post At the end of the operation the configured callback is invoked.
* @note The buffers are organized as uint8_t arrays for data sizes below or
* equal to 8 bits else it is organized as uint16_t arrays.
*
@@ -142,7 +144,9 @@ void spi_lld_exchange(SPIDriver *spip, size_t n, }
/**
- * @brief Sends data ever the SPI bus.
+ * @brief Sends data over the SPI bus.
+ * @details This asynchronous function starts a transmit operation.
+ * @post At the end of the operation the configured callback is invoked.
* @note The buffers are organized as uint8_t arrays for data sizes below or
* equal to 8 bits else it is organized as uint16_t arrays.
*
@@ -158,6 +162,8 @@ void spi_lld_send(SPIDriver *spip, size_t n, const void *txbuf) { /**
* @brief Receives data from the SPI bus.
+ * @details This asynchronous function starts a receive operation.
+ * @post At the end of the operation the configured callback is invoked.
* @note The buffers are organized as uint8_t arrays for data sizes below or
* equal to 8 bits else it is organized as uint16_t arrays.
*
|