Convert some comments to proper Doxygen syntax.
[coreboot.git] / src / superio / smsc / lpc47b272 / superio.c
index 91b63094ac079b0b37084e2284065dfcbf7afa3c..77fadd8a85a1090b40ac960073ce5d6496ff1261 100644 (file)
@@ -1,30 +1,27 @@
-/*\r
- * $Header$\r
- *\r
- * superio.c: RAM driver for SMSC LPC47B272 Super I/O chip\r
- *\r
- * Copyright 2000  AG Electronics Ltd.
- * Copyright 2003-2004 Linux Networx
- * Copyright 2004 Tyan 
- * Copyright (C) 2005 Digital Design Corporation\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
- *\r
- * $Log$\r
- *\r
- */\r
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2000 AG Electronics Ltd.
+ * Copyright (C) 2003-2004 Linux Networx
+ * Copyright (C) 2004 Tyan
+ * Copyright (C) 2005 Digital Design Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+/* RAM driver for SMSC LPC47B272 Super I/O chip. */
 
 #include <arch/io.h>
 #include <device/device.h>
 #include <bitops.h>
 #include <uart8250.h>
 #include <pc80/keyboard.h>
+#include <stdlib.h>
 #include "chip.h"
 #include "lpc47b272.h"
 
-// Forward declarations\r
-static void enable_dev(device_t dev);\r
-void lpc47b272_pnp_set_resources(device_t dev);
-void lpc47b272_pnp_set_resources(device_t dev);
-void lpc47b272_pnp_enable_resources(device_t dev);
-void lpc47b272_pnp_enable(device_t dev);
+/* Forward declarations */
+static void enable_dev(device_t dev);
+static void lpc47b272_pnp_set_resources(device_t dev);
+static void lpc47b272_pnp_enable_resources(device_t dev);
+static void lpc47b272_pnp_enable(device_t dev);
 static void lpc47b272_init(device_t dev);
 
-static void pnp_enter_conf_state(device_t dev);\r
-static void pnp_exit_conf_state(device_t dev);\r
-static void dump_pnp_device(device_t dev);
-
+static void pnp_enter_conf_state(device_t dev);
+static void pnp_exit_conf_state(device_t dev);
+//static void dump_pnp_device(device_t dev);
 
 struct chip_operations superio_smsc_lpc47b272_ops = {
-       CHIP_NAME("smsc lpc47b272")
+       CHIP_NAME("SMSC LPC47B272 Super I/O")
        .enable_dev = enable_dev
 };
 
@@ -65,56 +61,49 @@ static struct device_operations ops = {
 };
 
 static struct pnp_info pnp_dev_info[] = {
-        { &ops, LPC47B272_FDC,  PNP_IO0 | PNP_IRQ0 | PNP_DRQ0, { 0x07f8, 0}, },
-        { &ops, LPC47B272_PP,   PNP_IO0 | PNP_IRQ0 | PNP_DRQ0, { 0x07f8, 0}, },
-        { &ops, LPC47B272_SP1,  PNP_IO0 | PNP_IRQ0, { 0x7f8, 0 }, },
-        { &ops, LPC47B272_SP2,  PNP_IO0 | PNP_IRQ0, { 0x7f8, 0 }, },
-        { &ops, LPC47B272_KBC,  PNP_IO0 | PNP_IO1 | PNP_IRQ0 | PNP_IRQ1, { 0x7ff, 0 }, { 0x7ff, 0x4}, },
-        { &ops, LPC47B272_RT,   PNP_IO0, { 0x780, 0 }, },
+       { &ops, LPC47B272_FDC,  PNP_IO0 | PNP_IRQ0 | PNP_DRQ0, { 0x07f8, 0}, },
+       { &ops, LPC47B272_PP,   PNP_IO0 | PNP_IRQ0 | PNP_DRQ0, { 0x07f8, 0}, },
+       { &ops, LPC47B272_SP1,  PNP_IO0 | PNP_IRQ0, { 0x7f8, 0 }, },
+       { &ops, LPC47B272_SP2,  PNP_IO0 | PNP_IRQ0, { 0x7f8, 0 }, },
+       { &ops, LPC47B272_KBC,  PNP_IO0 | PNP_IO1 | PNP_IRQ0 | PNP_IRQ1, { 0x7ff, 0 }, { 0x7ff, 0x4}, },
+       { &ops, LPC47B272_RT,   PNP_IO0, { 0x780, 0 }, },
 };
 
-/**********************************************************************************/\r
-/*                                                             PUBLIC INTERFACE                                                                  */\r
-/**********************************************************************************/\r
-\r
-//----------------------------------------------------------------------------------\r
-// Function:           enable_dev\r
-// Parameters:         dev - pointer to structure describing a Super I/O device \r
-// Return Value:       None\r
-// Description:        Create device structures and allocate resources to devices \r
-//                                     specified in the pnp_dev_info array (above).\r
-//\r
-static void enable_dev(device_t dev)\r
-{\r
-       pnp_enable_devices(dev, &pnp_ops, \r
-                                          sizeof(pnp_dev_info)/sizeof(pnp_dev_info[0]), \r
-                                          pnp_dev_info);\r
-}\r
-
-//----------------------------------------------------------------------------------\r
-// Function:           lpc47b272_pnp_set_resources\r
-// Parameters:         dev - pointer to structure describing a Super I/O device \r
-// Return Value:       None\r
-// Description:        Configure the specified Super I/O device with the resources\r
-//                                     (I/O space, etc.) that have been allocated for it.\r
-//
-void lpc47b272_pnp_set_resources(device_t dev)
+/**
+ * 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_enter_conf_state(dev);  
+       pnp_enable_devices(dev, &pnp_ops, ARRAY_SIZE(pnp_dev_info),
+                          pnp_dev_info);
+}
+
+/**
+ * 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)
+{
+       pnp_enter_conf_state(dev);
        pnp_set_resources(dev);
-    pnp_exit_conf_state(dev);  
-}       
+       pnp_exit_conf_state(dev);
+}
 
-void lpc47b272_pnp_enable_resources(device_t dev)
-{       
+static void lpc47b272_pnp_enable_resources(device_t dev)
+{
        pnp_enter_conf_state(dev);
-    pnp_enable_resources(dev);
-    pnp_exit_conf_state(dev);
+       pnp_enable_resources(dev);
+       pnp_exit_conf_state(dev);
 }
 
-void lpc47b272_pnp_enable(device_t dev)
+static void lpc47b272_pnp_enable(device_t dev)
 {
-       pnp_enter_conf_state(dev);   
+       pnp_enter_conf_state(dev);
        pnp_set_logical_device(dev);
 
        if(dev->enabled) {
@@ -123,17 +112,17 @@ void lpc47b272_pnp_enable(device_t dev)
        else {
                pnp_set_enable(dev, 0);
        }
-       pnp_exit_conf_state(dev);  
+       pnp_exit_conf_state(dev);
 }
 
-//----------------------------------------------------------------------------------\r
-// Function:           lpc47b272_init\r
-// Parameters:         dev - pointer to structure describing a Super I/O device \r
-// Return Value:       None\r
-// Description:        Initialize the specified Super I/O device.\r
-//                                     Devices other than COM ports and the keyboard controller are 
-//                                     ignored. For COM ports, we configure the baud rate. \r
-//\r
+/**
+ * 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)
 {
        struct superio_smsc_lpc47b272_config *conf = dev->chip_info;
@@ -141,87 +130,72 @@ static void lpc47b272_init(device_t dev)
 
        if (!dev->enabled)
                return;
-       
-       switch(dev->path.u.pnp.device) {
-       case LPC47B272_SP1: 
+
+       switch(dev->path.pnp.device) {
+       case LPC47B272_SP1:
                res0 = find_resource(dev, PNP_IDX_IO0);
                init_uart8250(res0->base, &conf->com1);
                break;
-               
+
        case LPC47B272_SP2:
                res0 = find_resource(dev, PNP_IDX_IO0);
                init_uart8250(res0->base, &conf->com2);
                break;
-               
+
        case LPC47B272_KBC:
                res0 = find_resource(dev, PNP_IDX_IO0);
                res1 = find_resource(dev, PNP_IDX_IO1);
-               init_pc_keyboard(res0->base, res1->base, &conf->keyboard);
+               pc_keyboard_init(&conf->keyboard);
                break;
        }
 }
-\r
-/**********************************************************************************/\r
-/*                                                             PRIVATE FUNCTIONS                                                             */\r
-/**********************************************************************************/\r
-
-//----------------------------------------------------------------------------------\r
-// Function:           pnp_enter_conf_state\r
-// Parameters:         dev - pointer to structure describing a Super I/O device \r
-// Return Value:       None\r
-// Description:        Enable access to the LPC47B272's configuration registers.\r
-//\r
-static void pnp_enter_conf_state(device_t dev) \r
+
+/** Enable access to the LPC47B272's configuration registers. */
+static void pnp_enter_conf_state(device_t dev)
 {
-       outb(0x55, dev->path.u.pnp.port);
-}\r
-
-//----------------------------------------------------------------------------------\r
-// Function:           pnp_exit_conf_state\r
-// Parameters:         dev - pointer to structure describing a Super I/O device \r
-// Return Value:       None\r
-// Description:        Disable access to the LPC47B272's configuration registers.\r
-//\r
-static void pnp_exit_conf_state(device_t dev) \r
+       outb(0x55, dev->path.pnp.port);
+}
+
+/** Disable access to the LPC47B272's configuration registers. */
+static void pnp_exit_conf_state(device_t dev)
 {
-    outb(0xaa, dev->path.u.pnp.port);
+       outb(0xaa, dev->path.pnp.port);
 }
 
 #if 0
-//----------------------------------------------------------------------------------\r
-// Function:           dump_pnp_device\r
-// Parameters:         dev - pointer to structure describing a Super I/O device \r
-// Return Value:       None\r
-// Description:        Print the values of all of the LPC47B272's configuration registers.\r
-//                                     NOTE: The LPC47B272 must be in configuration mode when this\r
-//                                               function is called.\r
-//\r
+/**
+ * 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)
 {
-    int register_index;
-    print_debug("\r\n");
-
-    for(register_index = 0; register_index <= LPC47B272_MAX_CONFIG_REGISTER; register_index++) {
-        uint8_t register_value;\r
-
-        if ((register_index & 0x0f) == 0) {
-                print_debug_hex8(register_index);
-                print_debug_char(':');
-        }\r
-\r
-               // Skip over 'register' that would cause exit from configuration mode
-           if (register_index == 0xaa)
-                       register_value = 0xaa;\r
+       int register_index;
+       print_debug("\n");
+
+       for(register_index = 0; register_index <= LPC47B272_MAX_CONFIG_REGISTER; register_index++) {
+               uint8_t register_value;
+
+               if ((register_index & 0x0f) == 0) {
+                       print_debug_hex8(register_index);
+                       print_debug_char(':');
+               }
+
+               /* Skip over 'register' that would cause exit from configuration mode */
+               if (register_index == 0xaa)
+                       register_value = 0xaa;
                else
-               register_value = pnp_read_config(dev, register_index);\r
-\r
-        print_debug_char(' ');
-        print_debug_hex8(register_value);
-        if ((register_index & 0x0f) == 0x0f) {
-               print_debug("\r\n");
-        }
-    }\r
-\r
-       print_debug("\r\n");\r
+                       register_value = pnp_read_config(dev, register_index);
+
+               print_debug_char(' ');
+               print_debug_hex8(register_value);
+               if ((register_index & 0x0f) == 0x0f) {
+                       print_debug("\n");
+               }
+       }
+
+       print_debug("\n");
 }
 #endif