Convert some comments to proper Doxygen syntax.

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

diff --git a/src/superio/smsc/lpc47n217/superio.c b/src/superio/smsc/lpc47n217/superio.c
index 085331eaa7400852929f428bc0abc234d83f4d6a..95277cd42ca35d8011115bc93496a2838dd072b7 100644 (file)
--- a/src/superio/smsc/lpc47n217/superio.c
+++ b/src/superio/smsc/lpc47n217/superio.c
@@ -72,30 +72,23 @@ static struct pnp_info pnp_dev_info[] = {
        { &ops, LPC47N217_SP2,  PNP_IO0 | PNP_IRQ0, { 0x7f8, 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:           lpc47n217_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 allocate for it.
+/**
+ * Configure the specified Super I/O device with the resources (I/O space,
+ * etc.) that have been allocate for it.
+ *
+ * @param dev Pointer to structure describing a Super I/O device.
  */
 static void lpc47n217_pnp_set_resources(device_t dev)
 {
@@ -118,8 +111,9 @@ static void lpc47n217_pnp_enable_resources(device_t dev)
 {
        pnp_enter_conf_state(dev);
 
-       /* NOTE: Cannot use pnp_enable_resources() here because it assumes chip
-        * support for logical devices, which the LPC47N217 doesn't have
+       /*
+        * NOTE: Cannot use pnp_enable_resources() here because it assumes chip
+        * support for logical devices, which the LPC47N217 doesn't have.
         */
        lpc47n217_pnp_set_enable(dev, 1);
 
@@ -130,10 +124,10 @@ static void lpc47n217_pnp_enable(device_t dev)
 {
        pnp_enter_conf_state(dev);
 
-       /* NOTE: Cannot use pnp_set_enable() here because it assumes chip
-        * support for logical devices, which the LPC47N217 doesn't have
+       /*
+        * NOTE: Cannot use pnp_set_enable() here because it assumes chip
+        * support for logical devices, which the LPC47N217 doesn't have.
         */
-
        if(dev->enabled) {
                lpc47n217_pnp_set_enable(dev, 1);
        }
@@ -144,13 +138,13 @@ static void lpc47n217_pnp_enable(device_t dev)
        pnp_exit_conf_state(dev);
 }
 
-/*
- * Function:           lpc47n217_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 are ignored.
- *                     For COM ports, we configure the baud rate.
+/**
+ * Initialize the specified Super I/O device.
+ *
+ * Devices other than COM ports are ignored. For COM ports, we configure the
+ * baud rate.
+ *
+ * @param dev Pointer to structure describing a Super I/O device.
  */
 static void lpc47n217_init(device_t dev)
 {
@@ -173,10 +167,6 @@ static void lpc47n217_init(device_t dev)
        }
 }
 
-/**********************************************************************************/
-/*                             PRIVATE FUNCTIONS                                 */
-/**********************************************************************************/
-
 static void lpc47n217_pnp_set_resource(device_t dev, struct resource *resource)
 {
        if (!(resource->flags & IORESOURCE_ASSIGNED)) {
@@ -186,10 +176,10 @@ static void lpc47n217_pnp_set_resource(device_t dev, struct resource *resource)
        }
 
        /* Now store the resource */
-       /* NOTE: Cannot use pnp_set_XXX() here because they assume chip
-        * support for logical devices, which the LPC47N217 doesn't have
+       /*
+        * NOTE: Cannot use pnp_set_XXX() here because they assume chip
+        * support for logical devices, which the LPC47N217 doesn't have.
         */
-
        if (resource->flags & IORESOURCE_IO) {
                lpc47n217_pnp_set_iobase(dev, resource->base);
        }
@@ -327,36 +317,25 @@ static void lpc47n217_pnp_set_enable(device_t dev, int enable)
        pnp_write_config(dev, power_register, new_power);
 }
 
-/*
- * Function:           pnp_enter_conf_state
- * Parameters:         dev - pointer to structure describing a Super I/O device
- * Return Value:       None
- * Description:        Enable access to the LPC47N217's configuration registers.
- */
+/** Enable access to the LPC47N217'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 LPC47N217's configuration registers.
- */
+/** Disable access to the LPC47N217'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 LPC47N217's configuration registers.
- *                     NOTE: The LPC47N217 must be in configuration mode when this
- *                     function is called.
+/**
+ * Print the values of all of the LPC47N217's configuration registers.
+ *
+ * NOTE: The LPC47N217 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)
 {