diff options
author | Uwe Hermann <uwe@hermann-uwe.de> | 2010-10-26 22:46:43 +0000 |
---|---|---|
committer | Uwe Hermann <uwe@hermann-uwe.de> | 2010-10-26 22:46:43 +0000 |
commit | b69cb5a31058c0295f2d810c852cc5b52d77225c (patch) | |
tree | 9f462e829279fbc1a892a70898ac2ee9da4c79e1 /src/superio/smsc/lpc47b272/superio.c | |
parent | b907d321a5d0957f5cbb03d8f9c8d0ff0c23523b (diff) |
Convert some comments to proper Doxygen syntax.
Also, make them all fit in 80chars/column, fix some whitespace issues
and also some typos I noticed.
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@5993 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
Diffstat (limited to 'src/superio/smsc/lpc47b272/superio.c')
-rw-r--r-- | src/superio/smsc/lpc47b272/superio.c | 74 |
1 files changed, 26 insertions, 48 deletions
diff --git a/src/superio/smsc/lpc47b272/superio.c b/src/superio/smsc/lpc47b272/superio.c index 6222a3d3fb..77fadd8a85 100644 --- 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) { |