Convert some comments to proper Doxygen syntax.

[coreboot.git] / src / superio / smsc / lpc47b272 / superio.c

diff --git a/src/superio/smsc/lpc47b272/superio.c b/src/superio/smsc/lpc47b272/superio.c
index 6222a3d3fbc9374999df576bb68011e4a9d44d57..77fadd8a85a1090b40ac960073ce5d6496ff1261 100644 (file)
--- a/src/superio/smsc/lpc47b272/superio.c
+++ b/src/superio/smsc/lpc47b272/superio.c
@@ -69,30 +69,23 @@ static struct pnp_info pnp_dev_info[] = {
        { &ops, LPC47B272_RT,   PNP_IO0, { 0x780, 0 }, },
 };
 
-/**********************************************************************************/
-/*                             PUBLIC INTERFACE                                  */
-/**********************************************************************************/
-
-/*
- * Function:           enable_dev
- * Parameters:         dev - pointer to structure describing a Super I/O device
- * Return Value:       None
- * Description:        Create device structures and allocate resources to devices
- *                     specified in the pnp_dev_info array (above).
+/**
+ * Create device structures and allocate resources to devices specified in the
+ * pnp_dev_info array (above).
+ *
+ * @param dev Pointer to structure describing a Super I/O device.
  */
 static void enable_dev(device_t dev)
 {
-       pnp_enable_devices(dev, &pnp_ops,
-                          ARRAY_SIZE(pnp_dev_info),
+       pnp_enable_devices(dev, &pnp_ops, ARRAY_SIZE(pnp_dev_info),
                           pnp_dev_info);
 }
 
-/*
- * Function:           lpc47b272_pnp_set_resources
- * Parameters:         dev - pointer to structure describing a Super I/O device
- * Return Value:       None
- * Description:        Configure the specified Super I/O device with the resources
- *                     (I/O space, etc.) that have been allocated for it.
+/**
+ * Configure the specified Super I/O device with the resources (I/O space,
+ * etc.) that have been allocated for it.
+ *
+ * @param dev Pointer to structure describing a Super I/O device.
  */
 static void lpc47b272_pnp_set_resources(device_t dev)
 {
@@ -122,13 +115,13 @@ static void lpc47b272_pnp_enable(device_t dev)
        pnp_exit_conf_state(dev);
 }
 
-/*
- * Function:           lpc47b272_init
- * Parameters:         dev - pointer to structure describing a Super I/O device
- * Return Value:       None
- * Description:        Initialize the specified Super I/O device.
- *                     Devices other than COM ports and the keyboard controller are
- *                     ignored. For COM ports, we configure the baud rate.
+/**
+ * Initialize the specified Super I/O device.
+ *
+ * Devices other than COM ports and the keyboard controller are ignored.
+ * For COM ports, we configure the baud rate.
+ *
+ * @param dev Pointer to structure describing a Super I/O device.
  */
 static void lpc47b272_init(device_t dev)
 {
@@ -157,40 +150,25 @@ static void lpc47b272_init(device_t dev)
        }
 }
 
-/**********************************************************************************/
-/*                             PRIVATE FUNCTIONS                                 */
-/**********************************************************************************/
-
-/*
- * Function:           pnp_enter_conf_state
- * Parameters:         dev - pointer to structure describing a Super I/O device
- * Return Value:       None
- * Description:        Enable access to the LPC47B272's configuration registers.
- */
+/** Enable access to the LPC47B272's configuration registers. */
 static void pnp_enter_conf_state(device_t dev)
 {
        outb(0x55, dev->path.pnp.port);
 }
 
-/*
- * Function:           pnp_exit_conf_state
- * Parameters:         dev - pointer to structure describing a Super I/O device
- * Return Value:       None
- * Description:        Disable access to the LPC47B272's configuration registers.
- */
+/** Disable access to the LPC47B272's configuration registers. */
 static void pnp_exit_conf_state(device_t dev)
 {
        outb(0xaa, dev->path.pnp.port);
 }
 
 #if 0
-/*
- * Function:           dump_pnp_device
- * Parameters:         dev - pointer to structure describing a Super I/O device
- * Return Value:       None
- * Description:        Print the values of all of the LPC47B272's configuration registers.
- *                     NOTE: The LPC47B272 must be in configuration mode when this
- *                     function is called.
+/**
+ * Print the values of all of the LPC47B272's configuration registers.
+ *
+ * NOTE: The LPC47B272 must be in config mode when this function is called.
+ *
+ * @param dev Pointer to structure describing a Super I/O device.
  */
 static void dump_pnp_device(device_t dev)
 {