[coreboot-gerrit] New patch to review for coreboot: aa45533 mainboard/jetway/nf81-t56n-lf: Documentation cosmetics

Edward O'Callaghan (eocallaghan@alterapraxis.com) gerrit at coreboot.org
Thu Apr 10 11:17:09 CEST 2014


Edward O'Callaghan (eocallaghan at alterapraxis.com) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/5481

-gerrit

commit aa455338c1a4c15177cf2b3b658abee4e1060b88
Author: Edward O'Callaghan <eocallaghan at alterapraxis.com>
Date:   Thu Apr 10 19:12:28 2014 +1000

    mainboard/jetway/nf81-t56n-lf: Documentation cosmetics
    
    Keep under 80 colums and Doxygen'ify inline documentation somewhat.
    Strip some whitespace bulk while here.
    
    Change-Id: Icb38f087724d3e3511df1d554a620eb637ce286a
    Signed-off-by: Edward O'Callaghan <eocallaghan at alterapraxis.com>
---
 src/mainboard/jetway/nf81-t56n-lf/BiosCallOuts.h |  2 +-
 src/mainboard/jetway/nf81-t56n-lf/acpi_tables.c  |  5 +--
 src/mainboard/jetway/nf81-t56n-lf/agesawrapper.c | 34 ++++++---------
 src/mainboard/jetway/nf81-t56n-lf/agesawrapper.h | 54 ++++++++++--------------
 src/mainboard/jetway/nf81-t56n-lf/irq_tables.c   | 12 ++----
 5 files changed, 43 insertions(+), 64 deletions(-)

diff --git a/src/mainboard/jetway/nf81-t56n-lf/BiosCallOuts.h b/src/mainboard/jetway/nf81-t56n-lf/BiosCallOuts.h
index c4f4f70..98cff3b 100644
--- a/src/mainboard/jetway/nf81-t56n-lf/BiosCallOuts.h
+++ b/src/mainboard/jetway/nf81-t56n-lf/BiosCallOuts.h
@@ -70,4 +70,4 @@ AGESA_STATUS BiosHookBeforeExitSelfRefresh (UINT32 Func, UINT32 Data, VOID *Conf
 /* PCIE slot reset control */
 AGESA_STATUS BiosGnbPcieSlotReset (UINT32 Func, UINT32 Data, VOID *ConfigPtr);
 
-#endif //_BIOS_CALLOUT_H_
+#endif /* _BIOS_CALLOUT_H_ */
diff --git a/src/mainboard/jetway/nf81-t56n-lf/acpi_tables.c b/src/mainboard/jetway/nf81-t56n-lf/acpi_tables.c
index e7772aa..a236090 100644
--- a/src/mainboard/jetway/nf81-t56n-lf/acpi_tables.c
+++ b/src/mainboard/jetway/nf81-t56n-lf/acpi_tables.c
@@ -31,7 +31,6 @@
 #define DUMP_ACPI_TABLES 0
 
 #if DUMP_ACPI_TABLES == 1
-
 static void dump_mem(u32 start, u32 end)
 {
 
@@ -45,7 +44,7 @@ static void dump_mem(u32 start, u32 end)
 	}
 	print_debug("\n");
 }
-#endif
+#endif /* DUMP_ACPI_TABLES */
 
 extern const unsigned char AmlCode[];
 
@@ -313,7 +312,7 @@ unsigned long write_acpi_tables(unsigned long start)
 
 	printk(BIOS_DEBUG, "hest\n");
 	dump_mem(hest, ((void *)hest) + hest->header.length);
-#endif
+#endif /* DUMP_ACPI_TABLES */
 
 	printk(BIOS_INFO, "ACPI: done.\n");
 	return current;
diff --git a/src/mainboard/jetway/nf81-t56n-lf/agesawrapper.c b/src/mainboard/jetway/nf81-t56n-lf/agesawrapper.c
index 1627f25..2944eae 100644
--- a/src/mainboard/jetway/nf81-t56n-lf/agesawrapper.c
+++ b/src/mainboard/jetway/nf81-t56n-lf/agesawrapper.c
@@ -17,11 +17,9 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-/*-----------------------------------------------------------------------------
- *						M O D U L E S		U S E D
- *-----------------------------------------------------------------------------
+/**
+ * Modules Used
  */
-
 #include "agesawrapper.h"
 #include "BiosCallOuts.h"
 #include "PlatformGnbPcieComplex.h"
@@ -39,12 +37,10 @@
 #include <cpu/amd/agesa/s3_resume.h>
 #include <vendorcode/amd/agesa/f14/Proc/CPU/heapManager.h>
 
-#define FILECODE UNASSIGNED_FILE_FILECODE
-
-/*------------------------------------------------------------------------------
- *					D E F I N I T I O N S		A N D		M A C R O S
- *------------------------------------------------------------------------------
+/**
+ * @brief Definitions and Macros
  */
+#define FILECODE UNASSIGNED_FILE_FILECODE
 
 #define MMCONF_ENABLE 1
 
@@ -58,24 +54,20 @@ VOID *AcpiWheaMce	= NULL;
 VOID *AcpiWheaCmc	= NULL;
 VOID *AcpiAlib		= NULL;
 
-/*------------------------------------------------------------------------------
- *				T Y P E D E F S		 A N D		 S T R U C T U R E S
- *------------------------------------------------------------------------------
+/**
+ * @brief Typedefs and Structures
  */
 
-/*------------------------------------------------------------------------------
- *	P R O T O T Y P E S		 O F		 L O C A L		 F U N C T I O N S
- *------------------------------------------------------------------------------
+/**
+ * @brief Prototypes of local functions
  */
 
-/*------------------------------------------------------------------------------
- *						E X P O R T E D		F U N C T I O N S
- *------------------------------------------------------------------------------
+/**
+ * @brief Exported functions
  */
 
-/*------------------------------------------------------------------------------
- *						L O C A L		F U N C T I O N S
- *------------------------------------------------------------------------------
+/**
+ * @brief Local functions
  */
 uint32_t agesawrapper_amdinitcpuio(void)
 {
diff --git a/src/mainboard/jetway/nf81-t56n-lf/agesawrapper.h b/src/mainboard/jetway/nf81-t56n-lf/agesawrapper.h
index 6af5e5f..a8437df 100644
--- a/src/mainboard/jetway/nf81-t56n-lf/agesawrapper.h
+++ b/src/mainboard/jetway/nf81-t56n-lf/agesawrapper.h
@@ -17,62 +17,54 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-/*----------------------------------------------------------------------------------------
- *						 M O D U L E S		U S E D
- *----------------------------------------------------------------------------------------
- */
-
 #ifndef _AGESAWRAPPER_H_
 #define _AGESAWRAPPER_H_
 
+/**
+ * Modules Used
+ */
 #include <stdint.h>
 #include <vendorcode/amd/agesa/f14/AGESA.h>
 
 
-/*----------------------------------------------------------------------------------------
- *					 D E F I N I T I O N S		A N D		M A C R O S
- *----------------------------------------------------------------------------------------
+/**
+ * @brief Definitions and Macros
+ *
+ * Define AMD Ontario APPU SSID/SVID
  */
-/* Define AMD Ontario APPU SSID/SVID */
 #define AMD_APU_SVID		0x1022
 #define AMD_APU_SSID		0x1234
 #define PCIE_BASE_ADDRESS	 CONFIG_MMCONF_BASE_ADDRESS
 
 enum {
-	PICK_DMI,		/* DMI Interface */
-	PICK_PSTATE,	/* Acpi Pstate SSDT Table */
-	PICK_SRAT,		/* SRAT Table */
-	PICK_SLIT,		/* SLIT Table */
-	PICK_WHEA_MCE,	/* WHEA MCE table */
-	PICK_WHEA_CMC,	/* WHEA CMV table */
-	PICK_ALIB,		/* SACPI SSDT table with ALIB implementation */
+	PICK_DMI,		/**< DMI Interface */
+	PICK_PSTATE,	/**< Acpi Pstate SSDT Table */
+	PICK_SRAT,		/**< SRAT Table */
+	PICK_SLIT,		/**< SLIT Table */
+	PICK_WHEA_MCE,	/**< WHEA MCE table */
+	PICK_WHEA_CMC,	/**< WHEA CMV table */
+	PICK_ALIB,		/**< SACPI SSDT table with ALIB implementation */
 };
 
-/*----------------------------------------------------------------------------------------
- *					T Y P E D E F S		 A N D		 S T R U C T U	R E S
- *----------------------------------------------------------------------------------------
+/**
+ * @brief Typedefs and Structures
  */
-
 typedef struct {
 	UINT32 CalloutName;
 	AGESA_STATUS (*CalloutPtr) (UINT32 Func, UINT32 Data, VOID* ConfigPtr);
 } BIOS_CALLOUT_STRUCT;
 
-/*----------------------------------------------------------------------------------------
- *		P R O T O T Y P E S		 O F		 L O C A L		 F U	N C T I O N S
- *----------------------------------------------------------------------------------------
+/**
+ * @brief Prototypes of local functions
  */
 
-/*----------------------------------------------------------------------------------------
- *						E X P O R T E D		F U N C T I O N S
- *----------------------------------------------------------------------------------------
+/**
+ * @brief Exported functions
  */
 
-/*---------------------------------------------------------------------------------------
- *						L O C A L		F U N C T I O N S
- *---------------------------------------------------------------------------------------
+/**
+ * @brief Local functions
  */
-
 UINT32 agesawrapper_amdinitreset (void);
 UINT32 agesawrapper_amdinitearly (void);
 UINT32 agesawrapper_amdinitenv (void);
@@ -92,4 +84,4 @@ void *agesawrapper_getlateinitptr (int pick);
 
 UINT32 GetHeapBase(AMD_CONFIG_PARAMS *StdHeader);
 
-#endif
+#endif /* _AGESAWRAPPER_H_ */
diff --git a/src/mainboard/jetway/nf81-t56n-lf/irq_tables.c b/src/mainboard/jetway/nf81-t56n-lf/irq_tables.c
index b77c375..89257c2 100644
--- a/src/mainboard/jetway/nf81-t56n-lf/irq_tables.c
+++ b/src/mainboard/jetway/nf81-t56n-lf/irq_tables.c
@@ -58,8 +58,10 @@ unsigned long write_pirq_routing_table(unsigned long addr)
 	u8 sum = 0;
 	int i;
 
-
-	get_bus_conf();		/* it will find out all bus num and apic that share with mptable.c and mptable.c and acpi_tables.c */
+	/* Find out all bus num and apic that are share with:
+	 * mptable.c and acpi_tables.c
+	 */
+	get_bus_conf();
 
 
 	/* Align the table to be 16 byte aligned. */
@@ -90,19 +92,14 @@ unsigned long write_pirq_routing_table(unsigned long addr)
 	pirq_info = (void *)(&pirq->checksum + 1);
 	slot_num = 0;
 
-
 	/* pci bridge */
 	write_pirq_info(pirq_info, bus_sb800[0], ((sbdn_sb800 + 0x14) << 3) | 4,
 			0x1, 0xdef8, 0x2, 0xdef8, 0x3, 0xdef8, 0x4, 0xdef8, 0,
 			0);
 	pirq_info++;
 
-
-
 	slot_num++;
 
-
-
 	pirq->size = 32 + 16 * slot_num;
 
 	for (i = 0; i < pirq->size; i++)
@@ -117,5 +114,4 @@ unsigned long write_pirq_routing_table(unsigned long addr)
 	printk(BIOS_INFO, "write_pirq_routing_table done.\n");
 
 	return (unsigned long)pirq_info;
-
 }



More information about the coreboot-gerrit mailing list