aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2012-01-04 10:36:13 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2012-01-04 10:36:13 +0000
commit354a341507f6b174a576a8023f3f4bb2715b5b16 (patch)
tree6a9f01fa39787e5a9d2dee03e81e0555124d2ebe
parentdfbe833d08e60a98b7edfe924b9cf9d1a60fd6fb (diff)
downloadChibiOS-354a341507f6b174a576a8023f3f4bb2715b5b16.tar.gz
ChibiOS-354a341507f6b174a576a8023f3f4bb2715b5b16.tar.bz2
ChibiOS-354a341507f6b174a576a8023f3f4bb2715b5b16.zip
Fixed some documentation errors.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3725 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--os/hal/platforms/STM32/i2c_lld.c14
-rw-r--r--os/hal/platforms/STM32/i2c_lld.h7
-rw-r--r--os/hal/src/i2c.c6
3 files changed, 19 insertions, 8 deletions
diff --git a/os/hal/platforms/STM32/i2c_lld.c b/os/hal/platforms/STM32/i2c_lld.c
index 44271f322..84e678698 100644
--- a/os/hal/platforms/STM32/i2c_lld.c
+++ b/os/hal/platforms/STM32/i2c_lld.c
@@ -641,6 +641,8 @@ void i2c_lld_stop(I2CDriver *i2cp) {
/**
* @brief Resets the interface via RCC.
*
+ * @param[in] i2cp pointer to the @p I2CDriver object
+ *
* @notapi
*/
void i2c_lld_reset(I2CDriver *i2cp) {
@@ -670,9 +672,12 @@ void i2c_lld_reset(I2CDriver *i2cp) {
*
* @param[in] i2cp pointer to the @p I2CDriver object
* @param[in] addr slave device address
- * @param[in] rxbuf pointer to the receive buffer
+ * @param[out] rxbuf pointer to the receive buffer
* @param[in] rxbytes number of bytes to be received
- *
+ * @param[in] timeout the number of ticks before the operation timeouts,
+ * the following special values are allowed:
+ * - @a TIME_INFINITE no timeout.
+ * .
* @return The operation status.
* @retval RDY_OK if the function succeeded.
* @retval RDY_RESET if one or more I2C errors occurred, the errors can
@@ -684,7 +689,6 @@ void i2c_lld_reset(I2CDriver *i2cp) {
msg_t i2c_lld_master_receive_timeout(I2CDriver *i2cp, i2caddr_t addr,
uint8_t *rxbuf, size_t rxbytes,
systime_t timeout) {
-
msg_t rdymsg;
/* Releases the lock from high level driver.*/
@@ -739,7 +743,7 @@ msg_t i2c_lld_master_receive_timeout(I2CDriver *i2cp, i2caddr_t addr,
* @param[in] addr slave device address
* @param[in] txbuf pointer to the transmit buffer
* @param[in] txbytes number of bytes to be transmitted
- * @param[in] rxbuf pointer to the receive buffer
+ * @param[out] rxbuf pointer to the receive buffer
* @param[in] rxbytes number of bytes to be received
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
@@ -804,3 +808,5 @@ msg_t i2c_lld_master_transmit_timeout(I2CDriver *i2cp, i2caddr_t addr,
}
#endif /* HAL_USE_I2C */
+
+/** @} */
diff --git a/os/hal/platforms/STM32/i2c_lld.h b/os/hal/platforms/STM32/i2c_lld.h
index 264fb0f80..dc21731b0 100644
--- a/os/hal/platforms/STM32/i2c_lld.h
+++ b/os/hal/platforms/STM32/i2c_lld.h
@@ -384,6 +384,11 @@ struct I2CDriver{
* this function.
*
* @param[in] i2cp pointer to the @p I2CDriver object
+ * @param[in] timeout the number of ticks before the operation timeouts,
+ * the following special values are allowed:
+ * - @a TIME_INFINITE no timeout.
+ * .
+ * @param[out] rdymsg received message on wakeup
*
* @notapi
*/
@@ -499,3 +504,5 @@ msg_t i2c_lld_master_receive_timeout(I2CDriver *i2cp, i2caddr_t addr,
#endif /* HAL_USE_I2C */
#endif /* _I2C_LLD_H_ */
+
+/** @} */
diff --git a/os/hal/src/i2c.c b/os/hal/src/i2c.c
index fb45ce6a5..42481a2fd 100644
--- a/os/hal/src/i2c.c
+++ b/os/hal/src/i2c.c
@@ -160,7 +160,7 @@ i2cflags_t i2cGetErrors(I2CDriver *i2cp) {
* @param[in] addr slave device address (7 bits) without R/W bit
* @param[in] txbuf pointer to transmit buffer
* @param[in] txbytes number of bytes to be transmitted
- * @param[in] rxbuf pointer to receive buffer
+ * @param[out] rxbuf pointer to receive buffer
* @param[in] rxbytes number of bytes to be received, set it to 0 if
* you want transmit only
* @param[in] timeout the number of ticks before the operation timeouts,
@@ -209,10 +209,8 @@ msg_t i2cMasterTransmitTimeout(I2CDriver *i2cp,
*
* @param[in] i2cp pointer to the @p I2CDriver object
* @param[in] addr slave device address (7 bits) without R/W bit
+ * @param[out] rxbuf pointer to receive buffer
* @param[in] rxbytes number of bytes to be received
- * @param[in] rxbuf pointer to receive buffer
- * @param[in] errors pointer to variable to store error code, zero means
- * no error.
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_INFINITE no timeout.