Martin Roth (gaumless(a)gmail.com) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/8173
-gerrit
commit c1f6fafbe5641fa3d65b5ab0f7ec50219faeed6e
Author: Martin Roth <gaumless(a)gmail.com>
Date: Tue Jan 6 21:02:52 2015 -0700
src/device: Doxygen fixes
- Add missing parameters
- add missing @param commands
Change-Id: I029b5dafde94bd250800b06c0e9bd2118f10ef48
Signed-off-by: Martin Roth <gaumless(a)gmail.com>
---
src/device/dram/ddr3.c | 11 ++++++++++-
src/device/pci_device.c | 4 ++--
2 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/src/device/dram/ddr3.c b/src/device/dram/ddr3.c
index 86abea8..8170ae1 100644
--- a/src/device/dram/ddr3.c
+++ b/src/device/dram/ddr3.c
@@ -18,7 +18,7 @@
*/
/**
- * @file ddr3_util.h
+ * @file ddr3.c
*
* \brief Utilities for decoding DDR3 SPDs
*/
@@ -452,8 +452,13 @@ static u16 ddr3_cas_to_mr0_map(u8 cas)
* write_recovery and cas are given in clock cycles. For example, a CAS of 7T
* should be given as 7.
*
+ * @param precharge_pd
* @param write_recovery Write recovery latency, tWR in clock cycles.
+ * @param dll_reset
+ * @param mode
* @param cas CAS latency in clock cycles.
+ * @param burst_type
+ * @param burst_length
*/
mrs_cmd_t ddr3_get_mr0(enum ddr3_mr0_precharge precharge_pd,
u8 write_recovery,
@@ -555,8 +560,12 @@ mrs_cmd_t ddr3_get_mr1(enum ddr3_mr1_qoff qoff,
* cas_cwl is given in clock cycles. For example, a cas_cwl of 7T should be
* given as 7.
*
+ * @param rtt_wr
+ * @param extended_temp
+ * @param self_refresh
* @param cas_cwl CAS write latency in clock cycles.
*/
+
mrs_cmd_t ddr3_get_mr2(enum ddr3_mr2_rttwr rtt_wr,
enum ddr3_mr2_srt_range extended_temp,
enum ddr3_mr2_asr self_refresh, u8 cas_cwl)
diff --git a/src/device/pci_device.c b/src/device/pci_device.c
index 22454d6..862ed0e 100644
--- a/src/device/pci_device.c
+++ b/src/device/pci_device.c
@@ -818,8 +818,8 @@ static struct device_operations *get_pci_bridge_ops(device_t dev)
* The driver entry can either point at a zero terminated array of acceptable
* device IDs, or include a single device ID.
*
- * @driver pointer to the PCI driver entry being checked
- * @device_id PCI device ID of the device being matched
+ * @param driver pointer to the PCI driver entry being checked
+ * @param device_id PCI device ID of the device being matched
*/
static int device_id_match(struct pci_driver *driver, unsigned short device_id)
{
the following patch was just integrated into master:
commit 543888d5820ce28cbf1e03d53da9e7f75001c4c7
Author: Martin Roth <gaumless(a)gmail.com>
Date: Tue Jan 6 10:20:42 2015 -0700
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(a)gmail.com>
Reviewed-on: http://review.coreboot.org/8154
Tested-by: build bot (Jenkins)
Reviewed-by: Edward O'Callaghan <eocallaghan(a)alterapraxis.com>
See http://review.coreboot.org/8154 for details.
-gerrit
the following patch was just integrated into master:
commit d7689e4ad588ee1affee1d4edb3e5b0bd8098b0a
Author: Martin Roth <gaumless(a)gmail.com>
Date: Mon Dec 29 14:56:19 2014 -0700
Doxygen: add a "simple" output config and make target
This is a doxygen target I'm using for cleaning up the coreboot doxygen
output. It runs in about a minute instead of.... a lot longer, and
only generates documentation for the coreboot/src directory, excluding
vendorcode.
It was requested that the comments be stripped to make it easier to
read. This was done through the following command (split for gerrit):
head -n 1 Doxyfile.coreboot_simple > Doxyfile.tmp ;
cat Doxyfile.coreboot_simple | sed 's|^\s*#.*$||' | sed '/^$/d' | sed 's|[[:space:]]\+$||' >> Doxyfile.tmp ;
mv Doxyfile.tmp Doxyfile.coreboot_simple
I'm including the command here because any time the file is updated
with the doxygen wizard, it will need to be run again. It might be
desirable to turn this into a script in the documentation directory.
Change-Id: Ic0cbbcd21aa647e80a037481546bdcd2aab8949e
Signed-off-by: Martin Roth <gaumless(a)gmail.com>
Reviewed-on: http://review.coreboot.org/8068
Tested-by: build bot (Jenkins)
Reviewed-by: Alexandru Gagniuc <mr.nuke.me(a)gmail.com>
See http://review.coreboot.org/8068 for details.
-gerrit
the following patch was just integrated into master:
commit f4cb4128adea4b8ebdd92ae05d7d8e733e35eb1c
Author: Martin Roth <gaumless(a)gmail.com>
Date: Tue Jan 6 10:27:39 2015 -0700
northbridge/amd: Doxygen fixes
- Add missing parameter names in several files
- remove parameter types in several files
- remove lines from doxygen documentation. These should be outside the
doxygen comments.
- Some of the comments shouldn't have been doxygen style. Turn these
into regular non-doxygen comments.
Change-Id: Ieccfe237385efee007b48308d58eb0a6a12f5bfa
Signed-off-by: Martin Roth <gaumless(a)gmail.com>
Reviewed-on: http://review.coreboot.org/8153
Tested-by: build bot (Jenkins)
Reviewed-by: Edward O'Callaghan <eocallaghan(a)alterapraxis.com>
See http://review.coreboot.org/8153 for details.
-gerrit
the following patch was just integrated into master:
commit aa3dd5d5db2bb3a9825a3c5104f28699f7b43f87
Author: Alexander Couzens <lynxis(a)fe80.eu>
Date: Sat Jan 3 02:52:10 2015 +0100
inteltool: add `-s` to dump spi bar and bios_cntl registers
Change-Id: I3bb5dc23885af8c992456ee5e4bd374cd4b813bf
Signed-off-by: Alexander Couzens <lynxis(a)fe80.eu>
Reviewed-on: http://review.coreboot.org/8049
Reviewed-by: Philipp Deppenwiese <zaolin(a)das-labor.org>
Tested-by: build bot (Jenkins)
Reviewed-by: Patrick Georgi <pgeorgi(a)google.com>
See http://review.coreboot.org/8049 for details.
-gerrit