Skip to content

Commit

Permalink
Move ConfigKnobShimStandaloneMmLib to ConfigKnobShimMmLib (#218)
Browse files Browse the repository at this point in the history
# Preface

Please ensure you have read the [contribution
docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior
to submitting the pull request. In particular,
[pull request
guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices).

## Description

Add support for DXE_SMM_DRIVER to ConfigKnobShimMmLib, which is also
renamed from ConfigKnobShimStandaloneMmLib to reflect the additional
support. This is a breaking change due to the name change. Resolves
#215.

For each item, place an "x" in between `[` and `]` if true. Example:
`[x]`.
_(you can also check items in the GitHub UI)_

- [x] Impacts functionality?
- **Functionality** - Does the change ultimately impact how firmware
functions?
- Examples: Add a new library, publish a new PPI, update an algorithm,
...
- [ ] Impacts security?
- **Security** - Does the change have a direct security impact on an
application,
    flow, or firmware?
  - Examples: Crypto algorithm change, buffer overflow fix, parameter
    validation improvement, ...
- [x] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
    in build or boot behavior?
- Examples: Add a new library class, move a module to a different repo,
call
    a function in a new library class in a pre-existing module, ...
- [ ] Includes tests?
  - **Tests** - Does the change include any explicit test code?
  - Examples: Unit tests, integration tests, robot tests, ...
- [ ] Includes documentation?
- **Documentation** - Does the change contain explicit documentation
additions
    outside direct code modifications (and comments)?
- Examples: Update readme file, add feature readme file, link to
documentation
    on an a separate Web page, ...

## How This Was Tested

Ran against unit tests.

## Integration Instructions

Consumers of mu_feature_config will need to update their
ConfigKnobShimStandaloneMmLib to be ConfigKnobShimMmLib.
  • Loading branch information
os-d authored Jul 6, 2023
1 parent d760029 commit 43c3cd2
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** @file ConfigKnobShimStandaloneMmLib.c
/** @file ConfigKnobShimMmLib.c
Library interface for an OEM config policy creator to call into to fetch overrides for config values.
Copyright (c) Microsoft Corporation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

[Defines]
INF_VERSION = 0x00010017
BASE_NAME = ConfigKnobShimStandaloneMmLib
BASE_NAME = ConfigKnobShimMmLib
FILE_GUID = 675EE92E-8771-413A-8BBE-B87152B910E2
VERSION_STRING = 1.0
MODULE_TYPE = MM_STANDALONE
LIBRARY_CLASS = ConfigKnobShimLib
MODULE_TYPE = BASE
LIBRARY_CLASS = ConfigKnobShimLib | MM_STANDALONE DXE_SMM_DRIVER
PI_SPECIFICATION_VERSION = 0x00010032

#
Expand All @@ -23,7 +23,7 @@
#

[Sources]
ConfigKnobShimStandaloneMmLib.c
ConfigKnobShimMmLib.c
../ConfigKnobShimLibCommon.c
../ConfigKnobShimLibCommon.h

Expand Down
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
## @file
# Unit tests of the ConfigKnobShimExampleStandaloneMmLib instance.
# Unit tests of the ConfigKnobShimMmLib instance.
#
# Copyright (c) Microsoft Corporation.
# SPDX-License-Identifier: BSD-2-Clause-Patent
##

[Defines]
INF_VERSION = 0x00010017
BASE_NAME = ConfigKnobShimStandaloneMmUnitTest
BASE_NAME = ConfigKnobShimMmUnitTest
FILE_GUID = EA4B9417-78FC-474E-AC35-44AFF09E9099
MODULE_TYPE = HOST_APPLICATION
VERSION_STRING = 1.0

#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64 AARCH64
# VALID_ARCHITECTURES = IA32 X64
#

[Sources]
../../UnitTest/ConfigKnobShimLibUnitTestCommon.c
../ConfigKnobShimStandaloneMmLib.c
../ConfigKnobShimMmLib.c
../../ConfigKnobShimLibCommon.c

[Packages]
Expand Down
2 changes: 1 addition & 1 deletion SetupDataPkg/SetupDataPkg.dsc
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
[Components]
SetupDataPkg/Library/ConfigVariableListLib/ConfigVariableListLib.inf
SetupDataPkg/Library/ConfigSystemModeLibNull/ConfigSystemModeLibNull.inf
SetupDataPkg/Library/ConfigKnobShimLib/ConfigKnobShimStandaloneMmLib/ConfigKnobShimStandaloneMmLib.inf
SetupDataPkg/Library/ConfigKnobShimLib/ConfigKnobShimMmLib/ConfigKnobShimMmLib.inf
SetupDataPkg/Library/ConfigKnobShimLib/ConfigKnobShimPeiLib/ConfigKnobShimPeiLib.inf
SetupDataPkg/Library/ConfigKnobShimLib/ConfigKnobShimDxeLib/ConfigKnobShimDxeLib.inf
SetupDataPkg/Library/SvdXmlSettingSchemaSupportLib/SvdXmlSettingSchemaSupportLib.inf
Expand Down
4 changes: 2 additions & 2 deletions SetupDataPkg/Test/SetupDataPkgHostTest.dsc
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@
PeiServicesLib|SetupDataPkg/Test/MockLibrary/MockPeiServicesLib/MockPeiServicesLib.inf
}

SetupDataPkg/Library/ConfigKnobShimLib/ConfigKnobShimStandaloneMmLib/UnitTest/ConfigKnobShimStandaloneMmLibUnitTest.inf {
SetupDataPkg/Library/ConfigKnobShimLib/ConfigKnobShimMmLib/UnitTest/ConfigKnobShimMmLibUnitTest.inf {
<LibraryClasses>
ConfigKnobShimLib|SetupDataPkg/Library/ConfigKnobShimLib/ConfigKnobShimStandaloneMmLib/ConfigKnobShimStandaloneMmLib.inf
ConfigKnobShimLib|SetupDataPkg/Library/ConfigKnobShimLib/ConfigKnobShimMmLib/ConfigKnobShimMmLib.inf
MmServicesTableLib|SetupDataPkg/Test/MockLibrary/MockMmServicesTableLib/MockMmServicesTableLib.inf
}

Expand Down

0 comments on commit 43c3cd2

Please sign in to comment.