diff options
| author |   Randy Dunlap <randy.dunlap@oracle.com> | 2007-03-06 02:41:48 -0800 |
|---|---|---|
| committer |   Jeff Garzik <jeff@garzik.org> | 2007-04-28 11:00:57 -0400 |
| commit | b3df0da886ffdb3e70c3197f589e959e5f8c9c04 (patch) | |
| tree | 7a1f564d31835f31ebab9da370dace187b0aefc6 /drivers/net/phy/mdio_bus.c | |
| parent | user of the jiffies rounding code: e1000 (diff) | |
| download | linux-dev-b3df0da886ffdb3e70c3197f589e959e5f8c9c04.tar.xz linux-dev-b3df0da886ffdb3e70c3197f589e959e5f8c9c04.zip | |
phy layer: add kernel-doc + DocBook
Convert function documentation in drivers/net/phy/ to kernel-doc
and add it to DocBook.
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Jeff Garzik <jeff@garzik.org>
Diffstat (limited to 'drivers/net/phy/mdio_bus.c')
| -rw-r--r-- | drivers/net/phy/mdio_bus.c | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/drivers/net/phy/mdio_bus.c b/drivers/net/phy/mdio_bus.c index b31ce278bf35..fc4aee96cdfd 100644 --- a/drivers/net/phy/mdio_bus.c +++ b/drivers/net/phy/mdio_bus.c @@ -35,10 +35,14 @@ #include <asm/irq.h> #include <asm/uaccess.h> -/* mdiobus_register +/** + * mdiobus_register - bring up all the PHYs on a given bus and attach them to bus + * @bus: target mii_bus * - * description: Called by a bus driver to bring up all the PHYs - * on a given bus, and attach them to the bus + * Description: Called by a bus driver to bring up all the PHYs + * on a given bus, and attach them to the bus. + * + * Returns 0 on success or < 0 on error. */ int mdiobus_register(struct mii_bus *bus) { @@ -114,10 +118,13 @@ void mdiobus_unregister(struct mii_bus *bus) } EXPORT_SYMBOL(mdiobus_unregister); -/* mdio_bus_match +/** + * mdio_bus_match - determine if given PHY driver supports the given PHY device + * @dev: target PHY device + * @drv: given PHY driver * - * description: Given a PHY device, and a PHY driver, return 1 if - * the driver supports the device. Otherwise, return 0 + * Description: Given a PHY device, and a PHY driver, return 1 if + * the driver supports the device. Otherwise, return 0. */ static int mdio_bus_match(struct device *dev, struct device_driver *drv) { |