summaryrefslogtreecommitdiff
path: root/src/drivers/ti/tps65090
diff options
context:
space:
mode:
authorMartin Roth <martin.roth@se-eng.com>2015-01-04 16:47:39 -0700
committerMartin Roth <gaumless@gmail.com>2015-01-06 06:33:25 +0100
commit5f066b29ce993c0fd67fc8b6ab156a0a0fa02c6c (patch)
treec5381d22bf4c0f3da053101bbaade1b6f5610f55 /src/drivers/ti/tps65090
parentd63dbe8ef9455c546571585f9dbfa82243fb81f0 (diff)
downloadcoreboot-5f066b29ce993c0fd67fc8b6ab156a0a0fa02c6c.tar.xz
doxygen fixes: change @var to @param var
These files were trying to document the parameters, but didn't have the syntax quite right. Change the comments from @varname to @param varname as required by doxygen. Change-Id: I63662094d3f1686e3e35b61925b580eb06e72e28 Signed-off-by: Martin Roth <martin.roth@se-eng.com> Reviewed-on: http://review.coreboot.org/8100 Reviewed-by: Edward O'Callaghan <eocallaghan@alterapraxis.com> Tested-by: build bot (Jenkins) Reviewed-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
Diffstat (limited to 'src/drivers/ti/tps65090')
-rw-r--r--src/drivers/ti/tps65090/tps65090.c5
-rw-r--r--src/drivers/ti/tps65090/tps65090.h20
2 files changed, 13 insertions, 12 deletions
diff --git a/src/drivers/ti/tps65090/tps65090.c b/src/drivers/ti/tps65090/tps65090.c
index 35a050f36f..58bb3ce95d 100644
--- a/src/drivers/ti/tps65090/tps65090.c
+++ b/src/drivers/ti/tps65090/tps65090.c
@@ -87,8 +87,9 @@ static int tps65090_i2c_read(unsigned int bus,
/**
* Set the power state for a FET
*
- * @fet_id Fet number to set (1..MAX_FET_NUM)
- * @set 1 to power on FET, 0 to power off
+ * @param bus
+ * @param fet_id Fet number to set (1..MAX_FET_NUM)
+ * @param set 1 to power on FET, 0 to power off
* @return FET_ERR_COMMS if we got a comms error, FET_ERR_NOT_READY if the
* FET failed to change state. If all is ok, returns 0.
*/
diff --git a/src/drivers/ti/tps65090/tps65090.h b/src/drivers/ti/tps65090/tps65090.h
index b38db59892..a79158b697 100644
--- a/src/drivers/ti/tps65090/tps65090.h
+++ b/src/drivers/ti/tps65090/tps65090.h
@@ -67,8 +67,8 @@ enum {
/**
* Enable FET
*
- * @bus I2C bus number the TPS65090 is on
- * @fet_id FET ID, value between 1 and 7
+ * @param bus I2C bus number the TPS65090 is on
+ * @param fet_id FET ID, value between 1 and 7
* return 0 on success, non-0 on failure
*/
int tps65090_fet_enable(unsigned int bus, enum fet_id fet_id);
@@ -76,8 +76,8 @@ int tps65090_fet_enable(unsigned int bus, enum fet_id fet_id);
/**
* Disable FET
*
- * @bus I2C bus number the TPS65090 is on
- * @fet_id FET ID, value between 1 and 7
+ * @param bus I2C bus number the TPS65090 is on
+ * @param fet_id FET ID, value between 1 and 7
* @return 0 on success, non-0 on failure
*/
int tps65090_fet_disable(unsigned int bus, enum fet_id fet_id);
@@ -85,8 +85,8 @@ int tps65090_fet_disable(unsigned int bus, enum fet_id fet_id);
/**
* Is FET enabled?
*
- * @bus I2C bus number the TPS65090 is on
- * @fet_id FET ID, value between 1 and 7
+ * @param bus I2C bus number the TPS65090 is on
+ * @param fet_id FET ID, value between 1 and 7
* @return 1 enabled, 0 disabled, negative value on failure
*/
int tps65090_fet_is_enabled(unsigned int bus, enum fet_id fet_id);
@@ -94,15 +94,15 @@ int tps65090_fet_is_enabled(unsigned int bus, enum fet_id fet_id);
/**
* Enable / disable the battery charger
*
- * @bus I2C bus number the TPS65090 is on
- * @enable 0 to disable charging, non-zero to enable
+ * @param bus I2C bus number the TPS65090 is on
+ * @param enable 0 to disable charging, non-zero to enable
*/
int tps65090_set_charge_enable(unsigned int bus, int enable);
/**
* Check whether we have enabled battery charging
*
- * @bus I2C bus number the TPS65090 is on
+ * @param bus I2C bus number the TPS65090 is on
* @return 1 if enabled, 0 if disabled
*/
int tps65090_is_charging(unsigned int bus);
@@ -110,7 +110,7 @@ int tps65090_is_charging(unsigned int bus);
/**
* Return the value of the status register
*
- * @bus I2C bus number the TPS65090 is on
+ * @param bus I2C bus number the TPS65090 is on
* @return status register value, or -1 on error
*/
int tps65090_get_status(unsigned int bus);