diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2014-11-02 16:38:13 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2014-11-02 16:38:13 +0000 |
| commit | 69f211ae2c3f7a42d65e9f3bdb4e192016a53d94 (patch) | |
| tree | 2241b536eb349dd81abb7ce17781980df72dca94 /os/hal/ports/STM32/LLD | |
| parent | a94bfc5f713ee3b7659c53458b61f40ff39dc660 (diff) | |
| download | ChibiOS-69f211ae2c3f7a42d65e9f3bdb4e192016a53d94.tar.gz ChibiOS-69f211ae2c3f7a42d65e9f3bdb4e192016a53d94.tar.bz2 ChibiOS-69f211ae2c3f7a42d65e9f3bdb4e192016a53d94.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7462 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/ports/STM32/LLD')
| -rw-r--r-- | os/hal/ports/STM32/LLD/I2Cv1/i2c_lld.h | 9 | ||||
| -rw-r--r-- | os/hal/ports/STM32/LLD/I2Cv2/i2c_lld.c | 2 | ||||
| -rw-r--r-- | os/hal/ports/STM32/LLD/I2Cv2/i2c_lld.h | 10 | ||||
| -rw-r--r-- | os/hal/ports/STM32/LLD/mac_lld.c | 8 |
4 files changed, 15 insertions, 14 deletions
diff --git a/os/hal/ports/STM32/LLD/I2Cv1/i2c_lld.h b/os/hal/ports/STM32/LLD/I2Cv1/i2c_lld.h index e2f41d41d..a62efcaa6 100644 --- a/os/hal/ports/STM32/LLD/I2Cv1/i2c_lld.h +++ b/os/hal/ports/STM32/LLD/I2Cv1/i2c_lld.h @@ -357,12 +357,12 @@ /*===========================================================================*/
/**
- * @brief Type representing I2C address.
+ * @brief Type representing an I2C address.
*/
typedef uint16_t i2caddr_t;
/**
- * @brief I2C Driver condition flags type.
+ * @brief Type of I2C driver condition flags.
*/
typedef uint32_t i2cflags_t;
@@ -385,9 +385,10 @@ typedef enum { } i2cdutycycle_t;
/**
- * @brief Driver configuration structure.
+ * @brief Type of I2C driver configuration structure.
*/
typedef struct {
+ /* End of the mandatory fields.*/
i2copmode_t op_mode; /**< @brief Specifies the I2C mode. */
uint32_t clock_speed; /**< @brief Specifies the clock frequency.
@note Must be set to a value lower
@@ -402,7 +403,7 @@ typedef struct { typedef struct I2CDriver I2CDriver;
/**
- * @brief Structure representing an I2C driver.
+ * @brief Structure representing an I2C driver.
*/
struct I2CDriver {
/**
diff --git a/os/hal/ports/STM32/LLD/I2Cv2/i2c_lld.c b/os/hal/ports/STM32/LLD/I2Cv2/i2c_lld.c index 18c5e9abd..7e0624bc3 100644 --- a/os/hal/ports/STM32/LLD/I2Cv2/i2c_lld.c +++ b/os/hal/ports/STM32/LLD/I2Cv2/i2c_lld.c @@ -81,7 +81,7 @@ I2CDriver I2CD2; #endif
/*===========================================================================*/
-/* Driver local variables. */
+/* Driver local variables and types. */
/*===========================================================================*/
/*===========================================================================*/
diff --git a/os/hal/ports/STM32/LLD/I2Cv2/i2c_lld.h b/os/hal/ports/STM32/LLD/I2Cv2/i2c_lld.h index 0b9d0cfd3..a95c2c33c 100644 --- a/os/hal/ports/STM32/LLD/I2Cv2/i2c_lld.h +++ b/os/hal/ports/STM32/LLD/I2Cv2/i2c_lld.h @@ -216,17 +216,17 @@ /*===========================================================================*/
/**
- * @brief Type representing I2C address.
+ * @brief Type representing an I2C address.
*/
typedef uint16_t i2caddr_t;
/**
- * @brief I2C Driver condition flags type.
+ * @brief Type of I2C driver condition flags.
*/
typedef uint32_t i2cflags_t;
/**
- * @brief Driver configuration structure.
+ * @brief Type of I2C driver configuration structure.
*/
typedef struct {
/**
@@ -253,9 +253,9 @@ typedef struct { typedef struct I2CDriver I2CDriver;
/**
- * @brief Structure representing an I2C driver.
+ * @brief Structure representing an I2C driver.
*/
-struct I2CDriver{
+struct I2CDriver {
/**
* @brief Driver state.
*/
diff --git a/os/hal/ports/STM32/LLD/mac_lld.c b/os/hal/ports/STM32/LLD/mac_lld.c index 59742572e..36cdd96ae 100644 --- a/os/hal/ports/STM32/LLD/mac_lld.c +++ b/os/hal/ports/STM32/LLD/mac_lld.c @@ -396,8 +396,8 @@ void mac_lld_stop(MACDriver *macp) { * @param[in] macp pointer to the @p MACDriver object
* @param[out] tdp pointer to a @p MACTransmitDescriptor structure
* @return The operation status.
- * @retval RDY_OK the descriptor has been obtained.
- * @retval RDY_TIMEOUT descriptor not available.
+ * @retval MSG_OK the descriptor has been obtained.
+ * @retval MSG_TIMEOUT descriptor not available.
*
* @notapi
*/
@@ -472,8 +472,8 @@ void mac_lld_release_transmit_descriptor(MACTransmitDescriptor *tdp) { * @param[in] macp pointer to the @p MACDriver object
* @param[out] rdp pointer to a @p MACReceiveDescriptor structure
* @return The operation status.
- * @retval RDY_OK the descriptor has been obtained.
- * @retval RDY_TIMEOUT descriptor not available.
+ * @retval MSG_OK the descriptor has been obtained.
+ * @retval MSG_TIMEOUT descriptor not available.
*
* @notapi
*/
|