Skip to content

Commit

Permalink
AdvLoggerPkg: fix AdvLoggerSerialPortLib class (#268)
Browse files Browse the repository at this point in the history
## Description

AdvLoggerSerialPortLib was using a library class that was not a true
library class (not defined in any .dec file or have an associated .h).

This changes the library class to use the correct library class,
SerialPortLib.

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

Successfully build multiple platforms and pass the newly added BaseTools
change for verifying library override class names.

## Integration Instructions

Any library class definitions in a dsc using AdvLoggerSerialPortLib
needs to be switched to SerialPortLib.
  • Loading branch information
Javagedes committed Jun 26, 2023
1 parent 092c55e commit 819d93c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ SPDX-License-Identifier: BSD-2-Clause-Patent

#include <AdvancedLoggerInternal.h>

#include <Protocol/SerialIo.h>

#include <Library/AdvancedLoggerLib.h>

#include <Library/SerialPortLib.h>

/**
Initialize the serial device hardware.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@
[Defines]
INF_VERSION = 1.26
BASE_NAME = AdvLoggerSerialPortLib
MODULE_UNI_FILE = AdvLoggerSerialPortLib.uni
FILE_GUID = 2532f02a-a36a-451a-84f4-9e94c2256a83
MODULE_TYPE = BASE
VERSION_STRING = 1.0
LIBRARY_CLASS = AdvLoggerSerialPortLib
LIBRARY_CLASS = SerialPortLib

#
# VALID_ARCHITECTURES = X64 AARCH64
Expand All @@ -29,10 +28,3 @@

[LibraryClasses]
AdvancedLoggerLib

[Protocols]

[Pcd]

[Depex]
TRUE

0 comments on commit 819d93c

Please sign in to comment.