public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "PierreGondois" <pierre.gondois@arm.com>
To: devel@edk2.groups.io, Sami Mujawar <sami.mujawar@arm.com>,
	Alexei.Fedorov@arm.com, Joey Gouly <joey.gouly@arm.com>
Subject: [PATCH v2 03/10] DynamicTablesPkg: Rename single char input parameter
Date: Thu, 30 Sep 2021 08:48:14 +0100	[thread overview]
Message-ID: <20210930074821.12546-4-Pierre.Gondois@arm.com> (raw)
In-Reply-To: <20210930074821.12546-1-Pierre.Gondois@arm.com>

From: Pierre Gondois <Pierre.Gondois@arm.com>

The Ecc tool forbids the usage of one char variable: Ecc error 8007:
"There should be no use of short (single character) variable names"

To follow this policy, rename this one letter parameter.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
---

Notes:
    v2:
    -Document returned error code. [Sami]

 DynamicTablesPkg/Include/Library/AcpiHelperLib.h  |  7 ++++---
 .../Library/Common/AcpiHelperLib/AcpiHelper.c     | 15 ++++++++-------
 2 files changed, 12 insertions(+), 10 deletions(-)

diff --git a/DynamicTablesPkg/Include/Library/AcpiHelperLib.h b/DynamicTablesPkg/Include/Library/AcpiHelperLib.h
index 2731a2e4fb27..53ab19b1d139 100644
--- a/DynamicTablesPkg/Include/Library/AcpiHelperLib.h
+++ b/DynamicTablesPkg/Include/Library/AcpiHelperLib.h
@@ -22,15 +22,16 @@
 
 /** Convert a hex number to its ASCII code.
 
- @param [in]  x   Hex number to convert.
-                  Must be 0 <= x < 16.
+ @param [in]  Hex   Hex number to convert.
+                    Must be 0 <= x < 16.
 
  @return The ASCII code corresponding to x.
+         -1 if error.
 **/
 UINT8
 EFIAPI
 AsciiFromHex (
-  IN  UINT8   x
+  IN  UINT8   Hex
   );
 
 /** Check if a HID is a valid PNP ID.
diff --git a/DynamicTablesPkg/Library/Common/AcpiHelperLib/AcpiHelper.c b/DynamicTablesPkg/Library/Common/AcpiHelperLib/AcpiHelper.c
index 85a32269aae5..434b472cbb14 100644
--- a/DynamicTablesPkg/Library/Common/AcpiHelperLib/AcpiHelper.c
+++ b/DynamicTablesPkg/Library/Common/AcpiHelperLib/AcpiHelper.c
@@ -14,23 +14,24 @@
 
 /** Convert a hex number to its ASCII code.
 
- @param [in]  x   Hex number to convert.
-                  Must be 0 <= x < 16.
+ @param [in]  Hex   Hex number to convert.
+                    Must be 0 <= x < 16.
 
  @return The ASCII code corresponding to x.
+         -1 if error.
 **/
 UINT8
 EFIAPI
 AsciiFromHex (
-  IN  UINT8   x
+  IN  UINT8   Hex
   )
 {
-  if (x < 10) {
-    return (UINT8)(x + '0');
+  if (Hex < 10) {
+    return (UINT8)(Hex + '0');
   }
 
-  if (x < 16) {
-    return (UINT8)(x - 10 + 'A');
+  if (Hex < 16) {
+    return (UINT8)(Hex - 10 + 'A');
   }
 
   ASSERT (FALSE);
-- 
2.17.1


  parent reply	other threads:[~2021-09-30  7:48 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-30  7:48 [PATCH v2 00/10] Various DynamicTablesPkg modifications PierreGondois
2021-09-30  7:48 ` [PATCH v2 01/10] DynamicTablesPkg: Extract AcpiHelperLib from TableHelperLib PierreGondois
2021-09-30  7:48 ` [PATCH v2 02/10] DynamicTablesPkg: Update TableHelperLib.inf PierreGondois
2021-09-30  7:48 ` PierreGondois [this message]
2021-09-30  7:48 ` [PATCH v2 04/10] DynamicTablesPkg: Add HexFromAscii() to AcpiHelperLib PierreGondois
2021-09-30  7:48 ` [PATCH v2 05/10] DynamicTablesPkg: Add AmlGetEisaIdFromString() " PierreGondois
2021-09-30  7:48 ` [PATCH v2 06/10] DynamicTablesPkg: Add Configuration Manager Object parser PierreGondois
2021-09-30  7:48 ` [PATCH v2 07/10] DynamicTablesPkg: Use %a formatter in AmlDbgPrint PierreGondois
2021-09-30  7:48 ` [PATCH v2 08/10] DynamicTablesPkg: Update DynamicTablesPkg.ci.yaml PierreGondois
2021-09-30  7:48 ` [PATCH v2 09/10] DynamicTablesPkg: Deprecate Crs specific methods in AmlLib PierreGondois
2021-09-30  7:48 ` [PATCH v2 10/10] DynamicTablesPkg: Rework AmlResourceDataCodegen.c/h PierreGondois
2021-10-01 12:04 ` [PATCH v2 00/10] Various DynamicTablesPkg modifications Sami Mujawar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210930074821.12546-4-Pierre.Gondois@arm.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox