summaryrefslogtreecommitdiff
path: root/src/devices/smbus_ops.c
diff options
context:
space:
mode:
authorUwe Hermann <uwe@hermann-uwe.de>2010-10-17 19:01:48 +0000
committerUwe Hermann <uwe@hermann-uwe.de>2010-10-17 19:01:48 +0000
commitc1ee42913534ea2ef1747cfc6bfd1ec687a0f9a3 (patch)
treeb93d2b8a11698cc83df0246be11b4e49b479fbeb /src/devices/smbus_ops.c
parentb14fb6abd6cc04ea9f06e4dedd5f13c183e9450e (diff)
downloadcoreboot-c1ee42913534ea2ef1747cfc6bfd1ec687a0f9a3.tar.xz
Various Doxygen comment fixes, typo fixes, etc.
- Fix incorrect argument names for @param entries. - Add missing @param and @return entries, partly as TODOs. - s/@returns/@return/, that's a typo. - Small whitespace fixes while I'm at it. - Drop useless @brief commands, they just clutter the comments and make them harder to read. Doxygen has an option to always use the first sentence of a Doxygen-comment as @brief automatically (should be on per default). Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de> Acked-by: Uwe Hermann <uwe@hermann-uwe.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@5955 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
Diffstat (limited to 'src/devices/smbus_ops.c')
-rw-r--r--src/devices/smbus_ops.c16
1 files changed, 9 insertions, 7 deletions
diff --git a/src/devices/smbus_ops.c b/src/devices/smbus_ops.c
index 4a61e87a98..9d134619b8 100644
--- a/src/devices/smbus_ops.c
+++ b/src/devices/smbus_ops.c
@@ -38,11 +38,15 @@ struct bus *get_pbus_smbus(device_t dev)
return pbus;
}
-/*multi level i2c MUX??? may need to find the first i2c device and then set link
- * down to current dev
- 1 store get_pbus_smbus list link
- 2 reverse the link and call set link */
-
+/*
+ * Multi-level I2C MUX? may need to find the first i2c device and then set link
+ * down to current dev.
+ *
+ * 1 store get_pbus_smbus list link
+ * 2 reverse the link and call set link.
+ *
+ * @param dev TODO.
+ */
int smbus_set_link(device_t dev)
{
struct bus *pbus_a[4]; // 4 level mux only. Enough?
@@ -110,5 +114,3 @@ int smbus_block_write(device_t dev, uint8_t cmd, uint8_t bytes, const uint8_t *b
{
return ops_smbus_bus(get_pbus_smbus(dev))->block_write(dev, cmd, bytes, buffer);
}
-
-