]> git.proxmox.com Git - mirror_edk2.git/commit - MdePkg/Include/Library/DebugLib.h
MdePkg/DebugLib.h: add ASSERT_RETURN_ERROR()
authorLaszlo Ersek <lersek@redhat.com>
Fri, 21 Oct 2016 11:01:44 +0000 (13:01 +0200)
committerLaszlo Ersek <lersek@redhat.com>
Tue, 25 Oct 2016 08:46:07 +0000 (10:46 +0200)
commit08bcaf20b1320845ff4b140423dc4023695fe0fd
treef0e856cf0bea4578270ce351bcf09fd077fe81b2
parent2a3263303b5131e9e2cdb7106e17fc4c28b5c4b3
MdePkg/DebugLib.h: add ASSERT_RETURN_ERROR()

ASSERT_EFI_ERROR() cannot be used in BASE type modules because
- the replacement text calls EFI_ERROR(),
- EFI_ERROR() is defined in "MdePkg/Include/Uefi/UefiBaseType.h",
- the inclusion of "UefiBaseType.h" is not required for BASE type modules.

While

  ASSERT (!RETURN_ERROR (StatusParameter))

would be a functional statement in BASE type modules, it would be less
convenient and less informative: ASSERT_EFI_ERROR() prints the actual
StatusParameter.

Hence add ASSERT_RETURN_ERROR(), paralleling ASSERT_EFI_ERROR(). Copy the
original macro definition and update it as follows:
- replace EFI with RETURN,
- wrap overlong lines in the comment block and in the code,
- EFI_D_ERROR is deprecated, so employ DEBUG_ERROR instead.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=166
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Michael Kinney <michael.d.kinney@intel.com>
Tested-by: Ard Biesheuvel <ard.biesheuvel@linaro.org> # RVCT
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
MdePkg/Include/Library/DebugLib.h