aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2012-06-20 15:14:56 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2012-06-22 14:06:09 -0400
commit336b45c9954c8821e73e8f0e4a9b5011a4af28b6 (patch)
tree85a01d0ca0b0a5a1eaf2303fdb5ebbf5f7c5a3f3
parentc61a99d053d5ea230e41efe11772bac12ca2d51a (diff)
downloadlibrambutan-336b45c9954c8821e73e8f0e4a9b5011a4af28b6.tar.gz
librambutan-336b45c9954c8821e73e8f0e4a9b5011a4af28b6.zip
I2C: Fix Doxygen F1-isms.
I'm not sure these functions should even exist in their present form,, but I don't understand the code well enough to make a real fix. For now, just replace references to RM0008 with "chip reference manual". Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
-rw-r--r--libmaple/include/libmaple/i2c.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/libmaple/include/libmaple/i2c.h b/libmaple/include/libmaple/i2c.h
index 6d1fadf..ccce139 100644
--- a/libmaple/include/libmaple/i2c.h
+++ b/libmaple/include/libmaple/i2c.h
@@ -237,7 +237,10 @@ static inline void i2c_set_input_clk(i2c_dev *dev, uint32 freq) {
}
/**
- * @brief Set I2C clock control register. See RM008
+ * @brief Set I2C clock control register.
+ *
+ * See the chip reference manual for the details.
+ *
* @param dev I2C device
* @param val Value to use for clock control register (in
* Fast/Standard mode)
@@ -252,8 +255,8 @@ static inline void i2c_set_clk_control(i2c_dev *dev, uint32 val) {
/**
* @brief Set SCL rise time
* @param dev I2C device
- * @param trise Maximum rise time in fast/standard mode (see RM0008
- * for relevant formula).
+ * @param trise Maximum rise time in fast/standard mode (see chip
+ * reference manual for the relevant formulas).
*/
static inline void i2c_set_trise(i2c_dev *dev, uint32 trise) {
dev->regs->TRISE = trise;