[patch] MdePkg: Fix incorrect check for DisplayOnly text format in AcpiEx

[patch] MdePkg: Fix incorrect check for DisplayOnly text format in AcpiEx

[Dandan Bi]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1312

Text format for AcpiEx device path in UEFI Spec:
AcpiEx(HID,CID,UID,HIDSTR,CIDSTR,UIDSTR)
AcpiEx(HID|HIDSTR,(CID|CIDSTR,UID|UIDSTR))(Display Only)

When convert device path to text for ACPI device path,
current code check AllowShortcuts parameter to convert
the device path to DisplayOnly text format(shorter text
representation) by mistake.
It should check DisplayOnly parameter.

This commit is to fix this issue.

Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
 MdePkg/Library/UefiDevicePathLib/DevicePathToText.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c b/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
index cdcdb3623a..97d279eeb2 100644
--- a/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
+++ b/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
@@ -495,11 +495,11 @@ DevPathToTextAcpiEx (
         CIDText,
         UIDStr
        );
     }
   } else {
-    if (AllowShortcuts) {
+    if (DisplayOnly) {
       //
       // display only
       //
       if (AcpiEx->HID == 0) {
         UefiDevicePathLibCatPrint (Str, L"AcpiEx(%a,", HIDStr);
-- 
2.18.0.windows.1

Re: [patch] MdePkg: Fix incorrect check for DisplayOnly text format in AcpiEx

[Gao, Liming]

Reviewed-by: Liming Gao <liming.gao@intel.com>

> -----Original Message-----
> From: Bi, Dandan
> Sent: Thursday, November 8, 2018 9:50 PM
> To: edk2-devel@lists.01.org
> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>; Gao, Liming <liming.gao@intel.com>
> Subject: [patch] MdePkg: Fix incorrect check for DisplayOnly text format in AcpiEx
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1312
> 
> Text format for AcpiEx device path in UEFI Spec:
> AcpiEx(HID,CID,UID,HIDSTR,CIDSTR,UIDSTR)
> AcpiEx(HID|HIDSTR,(CID|CIDSTR,UID|UIDSTR))(Display Only)
> 
> When convert device path to text for ACPI device path,
> current code check AllowShortcuts parameter to convert
> the device path to DisplayOnly text format(shorter text
> representation) by mistake.
> It should check DisplayOnly parameter.
> 
> This commit is to fix this issue.
> 
> Cc: Ruiyu Ni <ruiyu.ni@intel.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
>  MdePkg/Library/UefiDevicePathLib/DevicePathToText.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c b/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
> index cdcdb3623a..97d279eeb2 100644
> --- a/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
> +++ b/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
> @@ -495,11 +495,11 @@ DevPathToTextAcpiEx (
>          CIDText,
>          UIDStr
>         );
>      }
>    } else {
> -    if (AllowShortcuts) {
> +    if (DisplayOnly) {
>        //
>        // display only
>        //
>        if (AcpiEx->HID == 0) {
>          UefiDevicePathLibCatPrint (Str, L"AcpiEx(%a,", HIDStr);
> --
> 2.18.0.windows.1

Re: [patch] MdePkg: Fix incorrect check for DisplayOnly text format in AcpiEx

[Bi, Dandan]

Hi Stewards and package maintainers:

Since this is a clear bug.  And the risk for this release is small.
So I plan to push this patch before edk2-stable201811 tag is created.

If you have any concern, please raise here. 


Thanks,
Dandan

> -----Original Message-----
> From: Gao, Liming
> Sent: Thursday, November 8, 2018 9:56 PM
> To: Bi, Dandan <dandan.bi@intel.com>; edk2-devel@lists.01.org
> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>
> Subject: RE: [patch] MdePkg: Fix incorrect check for DisplayOnly text format
> in AcpiEx
> 
> Reviewed-by: Liming Gao <liming.gao@intel.com>
> 
> > -----Original Message-----
> > From: Bi, Dandan
> > Sent: Thursday, November 8, 2018 9:50 PM
> > To: edk2-devel@lists.01.org
> > Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Kinney, Michael D
> > <michael.d.kinney@intel.com>; Gao, Liming <liming.gao@intel.com>
> > Subject: [patch] MdePkg: Fix incorrect check for DisplayOnly text
> > format in AcpiEx
> >
> > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1312
> >
> > Text format for AcpiEx device path in UEFI Spec:
> > AcpiEx(HID,CID,UID,HIDSTR,CIDSTR,UIDSTR)
> > AcpiEx(HID|HIDSTR,(CID|CIDSTR,UID|UIDSTR))(Display Only)
> >
> > When convert device path to text for ACPI device path, current code
> > check AllowShortcuts parameter to convert the device path to
> > DisplayOnly text format(shorter text
> > representation) by mistake.
> > It should check DisplayOnly parameter.
> >
> > This commit is to fix this issue.
> >
> > Cc: Ruiyu Ni <ruiyu.ni@intel.com>
> > Cc: Michael D Kinney <michael.d.kinney@intel.com>
> > Cc: Liming Gao <liming.gao@intel.com>
> > Contributed-under: TianoCore Contribution Agreement 1.1
> > Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> > ---
> >  MdePkg/Library/UefiDevicePathLib/DevicePathToText.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
> > b/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
> > index cdcdb3623a..97d279eeb2 100644
> > --- a/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
> > +++ b/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
> > @@ -495,11 +495,11 @@ DevPathToTextAcpiEx (
> >          CIDText,
> >          UIDStr
> >         );
> >      }
> >    } else {
> > -    if (AllowShortcuts) {
> > +    if (DisplayOnly) {
> >        //
> >        // display only
> >        //
> >        if (AcpiEx->HID == 0) {
> >          UefiDevicePathLibCatPrint (Str, L"AcpiEx(%a,", HIDStr);
> > --
> > 2.18.0.windows.1

Re: [patch] MdePkg: Fix incorrect check for DisplayOnly text format in AcpiEx

[Laszlo Ersek]

On 11/09/18 04:34, Bi, Dandan wrote:
> Hi Stewards and package maintainers:
> 
> Since this is a clear bug.  And the risk for this release is small.
> So I plan to push this patch before edk2-stable201811 tag is created.

I agree, this is a bugfix, not a feature patch.

Thanks,
Laszlo

> If you have any concern, please raise here. 
> 
> 
> Thanks,
> Dandan
> 
>> -----Original Message-----
>> From: Gao, Liming
>> Sent: Thursday, November 8, 2018 9:56 PM
>> To: Bi, Dandan <dandan.bi@intel.com>; edk2-devel@lists.01.org
>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Kinney, Michael D
>> <michael.d.kinney@intel.com>
>> Subject: RE: [patch] MdePkg: Fix incorrect check for DisplayOnly text format
>> in AcpiEx
>>
>> Reviewed-by: Liming Gao <liming.gao@intel.com>
>>
>>> -----Original Message-----
>>> From: Bi, Dandan
>>> Sent: Thursday, November 8, 2018 9:50 PM
>>> To: edk2-devel@lists.01.org
>>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Kinney, Michael D
>>> <michael.d.kinney@intel.com>; Gao, Liming <liming.gao@intel.com>
>>> Subject: [patch] MdePkg: Fix incorrect check for DisplayOnly text
>>> format in AcpiEx
>>>
>>> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1312
>>>
>>> Text format for AcpiEx device path in UEFI Spec:
>>> AcpiEx(HID,CID,UID,HIDSTR,CIDSTR,UIDSTR)
>>> AcpiEx(HID|HIDSTR,(CID|CIDSTR,UID|UIDSTR))(Display Only)
>>>
>>> When convert device path to text for ACPI device path, current code
>>> check AllowShortcuts parameter to convert the device path to
>>> DisplayOnly text format(shorter text
>>> representation) by mistake.
>>> It should check DisplayOnly parameter.
>>>
>>> This commit is to fix this issue.
>>>
>>> Cc: Ruiyu Ni <ruiyu.ni@intel.com>
>>> Cc: Michael D Kinney <michael.d.kinney@intel.com>
>>> Cc: Liming Gao <liming.gao@intel.com>
>>> Contributed-under: TianoCore Contribution Agreement 1.1
>>> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
>>> ---
>>>  MdePkg/Library/UefiDevicePathLib/DevicePathToText.c | 2 +-
>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
>>> b/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
>>> index cdcdb3623a..97d279eeb2 100644
>>> --- a/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
>>> +++ b/MdePkg/Library/UefiDevicePathLib/DevicePathToText.c
>>> @@ -495,11 +495,11 @@ DevPathToTextAcpiEx (
>>>          CIDText,
>>>          UIDStr
>>>         );
>>>      }
>>>    } else {
>>> -    if (AllowShortcuts) {
>>> +    if (DisplayOnly) {
>>>        //
>>>        // display only
>>>        //
>>>        if (AcpiEx->HID == 0) {
>>>          UefiDevicePathLibCatPrint (Str, L"AcpiEx(%a,", HIDStr);
>>> --
>>> 2.18.0.windows.1
>