Skip to content

Commit

Permalink
Create GENERIC_PROFILE_INDEX Macro (#196)
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 a macro to clarify that MAX_UINT32 is the generic profile index for
ActiveProfileIndexSelectorLib, instead of requiring consumers to know
this offhand.

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

- [ ] 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

Just a macro addition.

## Integration Instructions

N/A.
  • Loading branch information
os-d authored Jun 8, 2023
1 parent c0ef0cc commit 716ad72
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
3 changes: 3 additions & 0 deletions SetupDataPkg/Include/Library/ActiveProfileIndexSelectorLib.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
#ifndef ACTIVE_PROFILE_INDEX_SELECTOR_LIB_H_
#define ACTIVE_PROFILE_INDEX_SELECTOR_LIB_H_

// macro to represent the generic profile, used as a default if no profile is selected or a failure occurs
#define GENERIC_PROFILE_INDEX MAX_UINT32

/**
Return which profile is the active profile for this boot.
This function validates the profile GUID is valid.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
**/
#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/ActiveProfileIndexSelectorLib.h>

/**
Return which profile is the active profile for this boot.
Expand All @@ -34,7 +35,7 @@ GetActiveProfileIndex (
}

// Null instance, we just return the default profile
*ActiveProfileIndex = MAX_UINT32;
*ActiveProfileIndex = GENERIC_PROFILE_INDEX;

return EFI_SUCCESS;
}

0 comments on commit 716ad72

Please sign in to comment.