sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ShellPkg/UefiShellAcpiViewCommandLib: Fix ECC issues

Browse Source 
Make the function comments follow EDK2 coding style.

Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Evan Lloyd <evan.lloyd@arm.com>
Cc: Jaben Carsey <jaben.carsey@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
This commit is contained in:
Dandan Bi
2018-06-04 09:14:51 +08:00
committed by Eric Dong
parent 64285f1526
commit a6eaba4d7f
22 changed files with 645 additions and 447 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h
View File

@ -1,4 +1,4 @@
/**
/** @file
Header file for AcpiView
Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.
@ -14,20 +14,24 @@
#ifndef ACPIVIEW_H_
#define ACPIVIEW_H_
/** A macro to define the max file name length
*/
/**
A macro to define the max file name length
**/
#define MAX_FILE_NAME_LEN 128
/** Offset to the RSDP revision from the start of the RSDP
*/
/**
Offset to the RSDP revision from the start of the RSDP
**/
#define RSDP_REVISION_OFFSET 15
/** Offset to the RSDP length from the start of the RSDP
*/
/**
Offset to the RSDP length from the start of the RSDP
**/
#define RSDP_LENGTH_OFFSET 20
/** The EREPORT_OPTION enum describes ACPI table Reporting options.
*/
/**
The EREPORT_OPTION enum describes ACPI table Reporting options.
**/
typedef enum ReportOption {
EREPORT_ALL, ///< Report All tables.
EREPORT_SELECTED, ///< Report Selected table.
@ -36,63 +40,72 @@ typedef enum ReportOption {
EREPORT_MAX
} EREPORT_OPTION;
/** This function resets the ACPI table error counter to Zero.
*/
/**
This function resets the ACPI table error counter to Zero.
**/
VOID
ResetErrorCount (
VOID
);
/** This function returns the ACPI table error count.
/**
This function returns the ACPI table error count.
@retval Returns the count of errors detected in the ACPI tables.
*/
**/
UINT32
GetErrorCount (
VOID
);
/** This function resets the ACPI table warning counter to Zero.
*/
/**
This function resets the ACPI table warning counter to Zero.
**/
VOID
ResetWarningCount (
VOID
);
/** This function returns the ACPI table warning count.
/**
This function returns the ACPI table warning count.
@retval Returns the count of warning detected in the ACPI tables.
*/
**/
UINT32
GetWarningCount (
VOID
);
/** This function returns the colour highlighting status.
/**
This function returns the colour highlighting status.
@retval TRUE if colour highlighting is enabled.
*/
**/
BOOLEAN
GetColourHighlighting (
VOID
);
/** This function sets the colour highlighting status.
/**
This function sets the colour highlighting status.
*/
@param Highlight The Highlight status.
**/
VOID
SetColourHighlighting (
BOOLEAN Highlight
);
/** This function processes the table reporting options for the ACPI table.
/**
This function processes the table reporting options for the ACPI table.
@param [in] Signature The ACPI table Signature.
@param [in] TablePtr Pointer to the ACPI table data.
@param [in] Length The length fo the ACPI table.
@retval Returns TRUE if the ACPI table should be traced.
*/
**/
BOOLEAN
ProcessTableReportOptions (
IN CONST UINT32 Signature,