public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Kubacki, Michael A" <michael.a.kubacki@intel.com>
To: devel@edk2.groups.io
Cc: Sai Chaganty <rangasai.v.chaganty@intel.com>, Ray Ni <ray.ni@intel.com>
Subject: [edk2-platforms][PATCH V1 1/1] IntelSiliconPkg/BootMediaLib: Reduce library API
Date: Mon, 14 Oct 2019 14:26:16 -0700	[thread overview]
Message-ID: <20191014212616.18376-1-michael.a.kubacki@intel.com> (raw)

Removes the following functions from FirmwareBootMediaLib.h:
 * FirmwareBootMediaIsSpi ()
 * FirmwareBootMediaIsUfs ()
 * FirmwareBootMediaIsEmmc ()
 * FirmwareBootMediaIsNvme ()

It is preferred to have a single method to retrieve the firmware
boot media. To reduce overall maintenance effort over time, the
FirmwareBootMediaIsXxx () pattern is removed in favor of returning
the firmware boot media type via GetFirmwareBootMediaType ().

Cc: Sai Chaganty <rangasai.v.chaganty@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Signed-off-by: Michael Kubacki <michael.a.kubacki@intel.com>
---
 Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/DxeSmmFirmwareBootMediaLib.inf |   1 -
 Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/PeiFirmwareBootMediaLib.inf    |   1 -
 Silicon/Intel/IntelSiliconPkg/Include/Library/FirmwareBootMediaLib.h                       |  48 ---------
 Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/FirmwareBootMediaLib.c         | 109 --------------------
 4 files changed, 159 deletions(-)

diff --git a/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/DxeSmmFirmwareBootMediaLib.inf b/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/DxeSmmFirmwareBootMediaLib.inf
index 83ed5f04af..7e10b5f7a7 100644
--- a/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/DxeSmmFirmwareBootMediaLib.inf
+++ b/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/DxeSmmFirmwareBootMediaLib.inf
@@ -27,7 +27,6 @@
 #
 
 [Sources]
-  FirmwareBootMediaLib.c
   DxeSmmFirmwareBootMediaLib.c
 
 [Packages]
diff --git a/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/PeiFirmwareBootMediaLib.inf b/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/PeiFirmwareBootMediaLib.inf
index 063c4027d3..ff1da31387 100644
--- a/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/PeiFirmwareBootMediaLib.inf
+++ b/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/PeiFirmwareBootMediaLib.inf
@@ -22,7 +22,6 @@
   LIBRARY_CLASS        = FirmwareBootMediaLib
 
 [Sources]
-  FirmwareBootMediaLib.c
   PeiFirmwareBootMediaLib.c
 
 [Packages]
diff --git a/Silicon/Intel/IntelSiliconPkg/Include/Library/FirmwareBootMediaLib.h b/Silicon/Intel/IntelSiliconPkg/Include/Library/FirmwareBootMediaLib.h
index aca9593a84..b36ebacf30 100644
--- a/Silicon/Intel/IntelSiliconPkg/Include/Library/FirmwareBootMediaLib.h
+++ b/Silicon/Intel/IntelSiliconPkg/Include/Library/FirmwareBootMediaLib.h
@@ -55,52 +55,4 @@ FirmwareBootMediaIsKnown (
   VOID
   );
 
-/**
-  Determines if the platform firmware is booting from SPI.
-
-  @retval TRUE        Platform firmware is booting from SPI
-  @retval FALSE       Platform firmware is booting from a non-SPI device or the boot media is unknown
-**/
-BOOLEAN
-EFIAPI
-FirmwareBootMediaIsSpi (
-  VOID
-  );
-
-/**
-  Determines if the platform firmware is booting from UFS.
-
-  @retval TRUE        Platform firmware is booting from UFS
-  @retval FALSE       Platform firmware is booting from a non-UFS device or the boot media is unknown
-**/
-BOOLEAN
-EFIAPI
-FirmwareBootMediaIsUfs (
-  VOID
-  );
-
-/**
-  Determines if the platform firmware is booting from eMMC.
-
-  @retval TRUE        Platform firmware is booting from eMMC
-  @retval FALSE       Platform firmware is booting from a non-eMMC device or the boot media is unknown
-**/
-BOOLEAN
-EFIAPI
-FirmwareBootMediaIsEmmc (
-  VOID
-  );
-
-/**
-  Determines if the platform firmware is booting from NVMe.
-
-  @retval TRUE        Platform firmware is booting from NVMe.
-  @retval FALSE       Platform firmware is booting from a non-NVMe device or the boot media is unknown
-**/
-BOOLEAN
-EFIAPI
-FirmwareBootMediaIsNvme (
-  VOID
-  );
-
 #endif
diff --git a/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/FirmwareBootMediaLib.c b/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/FirmwareBootMediaLib.c
deleted file mode 100644
index 11a14d172d..0000000000
--- a/Silicon/Intel/IntelSiliconPkg/Library/PeiDxeSmmBootMediaLib/FirmwareBootMediaLib.c
+++ /dev/null
@@ -1,109 +0,0 @@
-/** @file
-  This library identifies the firmware boot media device.
-
-  The firmware boot media device is used to make system initialization decisions in the boot flow dependent
-  upon firmware boot media. Note that the firmware boot media is the storage media that the boot firmware is stored on.
-  It is not the OS storage media which may be stored upon a different non-volatile storage device.
-
-  This file contains library implementation common to all boot phases.
-
-Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
-SPDX-License-Identifier: BSD-2-Clause-Patent
-
-**/
-
-#include <Library/BaseLib.h>
-#include <Library/DebugLib.h>
-#include <Library/FirmwareBootMediaLib.h>
-
-/**
-  Determines if the platform firmware is booting from SPI.
-
-  @retval TRUE        Platform firmware is booting from SPI
-  @retval FALSE       Platform firmware is booting from a non-SPI device or the boot media is unknown
-**/
-BOOLEAN
-EFIAPI
-FirmwareBootMediaIsSpi (
-  VOID
-  )
-{
-  EFI_STATUS          Status;
-  FW_BOOT_MEDIA_TYPE  BootMedia;
-
-  Status = GetFirmwareBootMediaType (&BootMedia);
-  if (EFI_ERROR (Status) || BootMedia != FwBootMediaSpi) {
-    return FALSE;
-  } else {
-    return TRUE;
-  }
-}
-
-/**
-  Determines if the platform firmware is booting from UFS.
-
-  @retval TRUE        Platform firmware is booting from UFS
-  @retval FALSE       Platform firmware is booting from a non-UFS device or the boot media is unknown
-**/
-BOOLEAN
-EFIAPI
-FirmwareBootMediaIsUfs (
-  VOID
-  )
-{
-  EFI_STATUS          Status;
-  FW_BOOT_MEDIA_TYPE  BootMedia;
-
-  Status = GetFirmwareBootMediaType (&BootMedia);
-  if (EFI_ERROR (Status) || BootMedia != FwBootMediaUfs) {
-    return FALSE;
-  } else {
-    return TRUE;
-  }
-}
-
-/**
-  Determines if the platform firmware is booting from eMMC.
-
-  @retval TRUE        Platform firmware is booting from eMMC
-  @retval FALSE       Platform firmware is booting from a non-eMMC device or the boot media is unknown
-**/
-BOOLEAN
-EFIAPI
-FirmwareBootMediaIsEmmc (
-  VOID
-  )
-{
-  EFI_STATUS          Status;
-  FW_BOOT_MEDIA_TYPE  BootMedia;
-
-  Status = GetFirmwareBootMediaType (&BootMedia);
-  if (EFI_ERROR (Status) || BootMedia != FwBootMediaEmmc) {
-    return FALSE;
-  } else {
-    return TRUE;
-  }
-}
-
-/**
-  Determines if the platform firmware is booting from NVMe.
-
-  @retval TRUE        Platform firmware is booting from NVMe.
-  @retval FALSE       Platform firmware is booting from a non-NVMe device or the boot media is unknown
-**/
-BOOLEAN
-EFIAPI
-FirmwareBootMediaIsNvme (
-  VOID
-  )
-{
-  EFI_STATUS          Status;
-  FW_BOOT_MEDIA_TYPE  BootMedia;
-
-  Status = GetFirmwareBootMediaType (&BootMedia);
-  if (EFI_ERROR (Status) || BootMedia != FwBootMediaNvme) {
-    return FALSE;
-  } else {
-    return TRUE;
-  }
-}
-- 
2.16.2.windows.1


             reply	other threads:[~2019-10-14 21:26 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-14 21:26 Kubacki, Michael A [this message]
2019-10-15  1:29 ` [edk2-platforms][PATCH V1 1/1] IntelSiliconPkg/BootMediaLib: Reduce library API Ni, Ray
2019-10-15  2:21   ` Kubacki, Michael A
2019-10-15  4:59     ` Ni, Ray
2019-10-15 16:55       ` Kubacki, Michael A
2019-10-16  6:30         ` Ni, Ray
2019-10-16 17:38           ` Kubacki, Michael A
2019-10-17  7:26           ` [edk2-devel] " Nate DeSimone
2019-10-17  7:37             ` Ni, Ray
2019-10-15 17:20 ` Chaganty, Rangasai V
2019-10-17  7:25 ` [edk2-devel] " Nate DeSimone

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=20191014212616.18376-1-michael.a.kubacki@intel.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