northbridg/via/vx900: Doxygen fixes

- @todo has to be lowercase for doxygen
- Fix some parameters that had changed in the code.
- The @file entries needed to be more specific.

Change-Id: Icdce08735f581609cd25cce41e986c71435368a4
Signed-off-by: Martin Roth <gaumless@gmail.com>
Reviewed-on: http://review.coreboot.org/8154
Tested-by: build bot (Jenkins)
Reviewed-by: Edward O'Callaghan <eocallaghan@alterapraxis.com>
This commit is contained in:
Martin Roth 2015-01-06 10:20:42 -07:00
parent d7689e4ad5
commit 543888d582
7 changed files with 8 additions and 7 deletions

View File

@ -53,7 +53,7 @@
* the IGP is able to use it. GRUB2 and linux are capable of getting a usable * the IGP is able to use it. GRUB2 and linux are capable of getting a usable
* text console, which uses the monitor's native resolution (even 1920x1080). * text console, which uses the monitor's native resolution (even 1920x1080).
* The graphical console (linux) does not work properly. * The graphical console (linux) does not work properly.
* @TODO * @todo
* 1. Figure out what sequence we need to do to get the VGA BIOS running * 1. Figure out what sequence we need to do to get the VGA BIOS running
* properly. Use the code provided by VIA and compare their sequence to ours, * properly. Use the code provided by VIA and compare their sequence to ours,
* fill in any missing steps, etc. * fill in any missing steps, etc.

View File

@ -48,7 +48,8 @@ static void smbus_delays(int delays)
/** /**
* Read a byte from the SMBus. * Read a byte from the SMBus.
* *
* @param dimm The address location of the DIMM on the SMBus. * @param smbus_dev The PCI address of the SMBus device .
* @param addr The address location of the DIMM on the SMBus.
* @param offset The offset the data is located at. * @param offset The offset the data is located at.
*/ */
u8 smbus_read_byte(u32 smbus_dev, u8 addr, u8 offset) u8 smbus_read_byte(u32 smbus_dev, u8 addr, u8 offset)

View File

@ -30,7 +30,7 @@
#include "chip.h" #include "chip.h"
/** /**
* @file lpc.c * @file vx900/lpc.c
* *
* STATUS: * STATUS:
* We do a fair bit of setup, and most of it seems to work fairly well. There * We do a fair bit of setup, and most of it seems to work fairly well. There

View File

@ -36,7 +36,7 @@ static uint64_t uma_memory_base = 0;
static uint64_t uma_memory_size = 0; static uint64_t uma_memory_size = 0;
/** /**
* @file northbridge.c * @file vx900/northbridge.c
* *
* STATUS: Pretty good * STATUS: Pretty good
* One thing that needs to be thoroughly tested is the remap above 4G logic. * One thing that needs to be thoroughly tested is the remap above 4G logic.

View File

@ -26,7 +26,7 @@
#include "vx900.h" #include "vx900.h"
/** /**
* @file pcie.c * @file vx900/pcie.c
* *
* STATUS: * STATUS:
* We do part of the sequence to initialize the PCIE link. The problem is that * We do part of the sequence to initialize the PCIE link. The problem is that

View File

@ -24,7 +24,7 @@
#include "vx900.h" #include "vx900.h"
/** /**
* @file sata.c * @file vx900/sata.c
* *
* STATUS: Pretty good * STATUS: Pretty good
* The only issue is the SATA EPHY configuration. We do not know if it is board * The only issue is the SATA EPHY configuration. We do not know if it is board

View File

@ -28,7 +28,7 @@
#include "chip.h" #include "chip.h"
/** /**
* @file traf_ctrl.c * @file vx900/traf_ctrl.c
* *
* STATUS: * STATUS:
* The same issues with the IOAPIC pointe in lpc.c also apply here. * The same issues with the IOAPIC pointe in lpc.c also apply here.