[REBASE && FF] Fix DeviceStateLib Formatting and Move Unit Test Mode to Fixed PCD #542
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kenlautner
approved these changes
Aug 29, 2023
TaylorBeebe
force-pushed
the
update_device_state_unit_test_2
branch
from
3fadad3
to
e8e1b6e
Compare
makubacki
added
impact:breaking-change
|
Feel free to review the labels, I marked as a design change and breaking change. Though this will be rebased, I think it'd still be good to copy the integration instructions to the PR description since that will be the main reference point for the change in the release notes. |
makubacki
approved these changes
Aug 30, 2023
Description
- [ ] 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, ...
- [ ] 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
N/A
Integration Instructions
N/A
Description
DeviceStateLib provides an interface to get and set various device
state indicators (secure boot, unit test mode, etc.). This change
removes the unit test mode setting from the DeviceStateLib interface
and transitions it to a fixed at build PCD so it cannot be changed
at runtime. The one instance in this repo where
DEVICE_STATE_UNIT_TEST_MODE was referenced has been updated to
reference the PCD.
- [x] Impacts functionality?
- **Functionality** - Does the change ultimately impact how firmware functions?
- Examples: Add a new library, publish a new PPI, update an algorithm, ...
- [x] 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
Tested on Q35
Integration Instructions
References to DEVICE_STATE_UNIT_TEST_MODE will need to be removed
from platform code and platforms which want to set unit test mode
will need to set the PCD in their platform DSC file(s).
TaylorBeebe
force-pushed
the
update_device_state_unit_test_2
branch
from
e8e1b6e
to
2a94654
Compare
spbrogan
requested changes
Aug 31, 2023
| #define DEVICE_STATE_DEVELOPMENT_BUILD_ENABLED (1 << (2)) | ||
| #define DEVICE_STATE_SOURCE_DEBUG_ENABLED (1 << (3)) | ||
| #define DEVICE_STATE_UNDEFINED (1 << (4)) | ||
| #define DEVICE_STATE_UNIT_TEST_MODE (1 << (5)) |
There was a problem hiding this comment.
i don't think we should delete this state.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
DeviceStateLib provides an interface to get and set various device
state indicators (secure boot, unit test mode, etc.). This change
removes the unit test mode setting from the DeviceStateLib interface
and transitions it to a fixed at build PCD so it cannot be changed
at runtime. The one instance in this repo where
DEVICE_STATE_UNIT_TEST_MODE was referenced has been updated to
reference the PCD.
flow, or firmware?
validation improvement, ...
in build or boot behavior?
a function in a new library class in a pre-existing module, ...
outside direct code modifications (and comments)?
on an a separate Web page, ...
How This Was Tested
Tested on Q35
Integration Instructions
References to DEVICE_STATE_UNIT_TEST_MODE will need to be removed
from platform code and platforms which want to set unit test mode
will need to set the PCD in their platform DSC file(s).