123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839 |
- /**
- Copyright (c) Microsoft Corporation.<BR>
- Copyright (c) 2019, Intel Corporation. All rights reserved.
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #include <PiDxe.h>
- #include <LastAttemptStatus.h>
- #include <Guid/SystemResourceTable.h>
- #include <Library/FmpDeviceLib.h>
- #include <Library/DebugLib.h>
- #include <Library/BaseLib.h>
- #include <Library/BaseMemoryLib.h>
- #include <Library/MemoryAllocationLib.h>
- #include <Library/UefiBootServicesTableLib.h>
- #include <Library/PlatformFlashAccessLib.h>
- //#include <Protocol/FirmwareManagement.h>
- //#include <Guid/SystemResourceTable.h>
- typedef struct {
- PLATFORM_FIRMWARE_TYPE FirmwareType;
- FLASH_ADDRESS_TYPE AddressType;
- EFI_PHYSICAL_ADDRESS BaseAddress;
- UINTN Length;
- UINTN ImageOffset;
- } UPDATE_CONFIG_DATA;
- UPDATE_CONFIG_DATA mUpdateConfigData[] = {
- { PlatformFirmwareTypeSystemFirmware, FlashAddressTypeRelativeAddress, 0x00400000, 0x00040000, 0x00400000 },
- { PlatformFirmwareTypeSystemFirmware, FlashAddressTypeRelativeAddress, 0x004C0000, 0x00050000, 0x004C0000 },
- { PlatformFirmwareTypeSystemFirmware, FlashAddressTypeRelativeAddress, 0x00510000, 0x00210000, 0x00510000 },
- { PlatformFirmwareTypeSystemFirmware, FlashAddressTypeRelativeAddress, 0x00720000, 0x00070000, 0x00720000 },
- { PlatformFirmwareTypeSystemFirmware, FlashAddressTypeRelativeAddress, 0x00790000, 0x00070000, 0x00790000 }
- };
- /**
- Used to pass the FMP install function to this lib. This allows the library to
- have control of the handle that the FMP instance is installed on. This allows
- the library to use DriverBinding protocol model to locate its device(s) in the
- system.
- @param[in] Func Function pointer to FMP install function.
- @retval EFI_SUCCESS Library has saved function pointer and will call
- function pointer on each DriverBinding Start.
- @retval EFI_UNSUPPORTED Library doesn't use driver binding and only supports
- a single instance.
- @retval other error Error occurred. Don't install FMP
- **/
- EFI_STATUS
- EFIAPI
- RegisterFmpInstaller (
- IN FMP_DEVICE_LIB_REGISTER_FMP_INSTALLER Func
- )
- {
- //
- // This is a system firmware update that does not use Driver Binding Protocol
- //
- return EFI_UNSUPPORTED;
- }
- /**
- Provide a function to uninstall the Firmware Management Protocol instance from a
- device handle when the device is managed by a driver that follows the UEFI
- Driver Model. If the device is not managed by a driver that follows the UEFI
- Driver Model, then EFI_UNSUPPORTED is returned.
- @param[in] FmpUninstaller Function that installs the Firmware Management
- Protocol.
- @retval EFI_SUCCESS The device is managed by a driver that follows the
- UEFI Driver Model. FmpUinstaller must be called on
- each Driver Binding Stop().
- @retval EFI_UNSUPPORTED The device is not managed by a driver that follows
- the UEFI Driver Model.
- @retval other The Firmware Management Protocol for this firmware
- device is not installed. The firmware device is
- still locked using FmpDeviceLock().
- **/
- EFI_STATUS
- EFIAPI
- RegisterFmpUninstaller (
- IN FMP_DEVICE_LIB_REGISTER_FMP_UNINSTALLER FmpUninstaller
- )
- {
- //
- // This is a system firmware update that does not use Driver Binding Protocol
- //
- return EFI_UNSUPPORTED;
- }
- /**
- Set the device context for the FmpDeviceLib services when the device is
- managed by a driver that follows the UEFI Driver Model. If the device is not
- managed by a driver that follows the UEFI Driver Model, then EFI_UNSUPPORTED
- is returned. Once a device context is set, the FmpDeviceLib services
- operate on the currently set device context.
- @param[in] Handle Device handle for the FmpDeviceLib services.
- If Handle is NULL, then Context is freed.
- @param[in, out] Context Device context for the FmpDeviceLib services.
- If Context is NULL, then a new context is allocated
- for Handle and the current device context is set and
- returned in Context. If Context is not NULL, then
- the current device context is set.
- @retval EFI_SUCCESS The device is managed by a driver that follows the
- UEFI Driver Model.
- @retval EFI_UNSUPPORTED The device is not managed by a driver that follows
- the UEFI Driver Model.
- @retval other The Firmware Management Protocol for this firmware
- device is not installed. The firmware device is
- still locked using FmpDeviceLock().
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceSetContext (
- IN EFI_HANDLE Handle,
- IN OUT VOID **Context
- )
- {
- //
- // This is a system firmware update that does not use Driver Binding Protocol
- //
- return EFI_UNSUPPORTED;
- }
- /**
- Returns the size, in bytes, of the firmware image currently stored in the
- firmware device. This function is used to by the GetImage() and
- GetImageInfo() services of the Firmware Management Protocol. If the image
- size can not be determined from the firmware device, then 0 must be returned.
- @param[out] Size Pointer to the size, in bytes, of the firmware image
- currently stored in the firmware device.
- @retval EFI_SUCCESS The size of the firmware image currently
- stored in the firmware device was returned.
- @retval EFI_INVALID_PARAMETER Size is NULL.
- @retval EFI_UNSUPPORTED The firmware device does not support reporting
- the size of the currently stored firmware image.
- @retval EFI_DEVICE_ERROR An error occured attempting to determine the
- size of the firmware image currently stored in
- in the firmware device.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceGetSize (
- IN UINTN *Size
- )
- {
- if (Size == NULL) {
- return EFI_INVALID_PARAMETER;
- }
- *Size = PcdGet32 (PcdBiosRomSize);
- return EFI_SUCCESS;
- }
- /**
- Used to return a library supplied guid that will be the ImageTypeId guid of
- the FMP descriptor. This is optional but can be used if at runtime the guid
- needs to be determined.
- @param[out] Guid Double Guid Ptr that will be updated to point to guid.
- This should be from static memory and will not be freed.
- @return EFI_UNSUPPORTED Library instance doesn't need dynamic guid.
- @return Error Any error will cause the wrapper to use the GUID
- defined by PCD.
- @return EFI_SUCCESS Guid ptr should be updated to point to static memeory
- which contains a valid guid.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceGetImageTypeIdGuidPtr (
- OUT EFI_GUID **Guid
- )
- {
- return EFI_UNSUPPORTED;
- }
- /**
- Returns values used to fill in the AttributesSupported and AttributesSettings
- fields of the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the
- GetImageInfo() service of the Firmware Management Protocol. The following
- bit values from the Firmware Management Protocol may be combined:
- IMAGE_ATTRIBUTE_IMAGE_UPDATABLE
- IMAGE_ATTRIBUTE_RESET_REQUIRED
- IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED
- IMAGE_ATTRIBUTE_IN_USE
- IMAGE_ATTRIBUTE_UEFI_IMAGE
- @param[out] Supported Attributes supported by this firmware device.
- @param[out] Setting Attributes settings for this firmware device.
- @retval EFI_SUCCESS The attributes supported by the firmware
- device were returned.
- @retval EFI_INVALID_PARAMETER Supported is NULL.
- @retval EFI_INVALID_PARAMETER Setting is NULL.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceGetAttributes (
- IN OUT UINT64 *Supported,
- IN OUT UINT64 *Setting
- )
- {
- if (Supported == NULL || Setting == NULL) {
- return EFI_INVALID_PARAMETER;
- }
- *Supported = (IMAGE_ATTRIBUTE_IMAGE_UPDATABLE |
- IMAGE_ATTRIBUTE_RESET_REQUIRED |
- IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED |
- IMAGE_ATTRIBUTE_IN_USE
- );
- *Setting = (IMAGE_ATTRIBUTE_IMAGE_UPDATABLE |
- IMAGE_ATTRIBUTE_RESET_REQUIRED |
- IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED |
- IMAGE_ATTRIBUTE_IN_USE
- );
- return EFI_SUCCESS;
- }
- /**
- Gets the current Lowest Supported Version.
- This is a protection mechanism so that a previous version with known issue is
- not applied. ONLY implement this if your running firmware has a method to
- return this at runtime. If EFI_UNSUPPORTED is returned, then the Lowest
- Supported Version is stored in a UEFI Variable.
- @param[out] Version On return this value represents the current Lowest
- Supported Version (in same format as GetVersion).
- @retval EFI_SUCCESS The Lowest Supported Version was correctly retrieved
- @retval EFI_UNSUPPORTED Device firmware doesn't support reporting LSV
- @retval EFI_DEVICE_ERROR Error occurred when trying to get the LSV
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceGetLowestSupportedVersion (
- IN OUT UINT32 *LowestSupportedVersion
- )
- {
- //
- // Retrieve the lowest support version from a PCD
- // NOTE: This method of using a PCD can only be used for the system firmware
- // FMP instance that is updated every time the system firmware is
- // updated. If system firmware updates support partial updates that
- // would not include the system firmware FMP instance, then a PCD can
- // not be used and the value must come from the currently running system
- // firmware image.
- //
- *LowestSupportedVersion = PcdGet32 (PcdSystemFirmwareFmpLowestSupportedVersion);
- return EFI_SUCCESS;
- }
- /**
- Returns the Null-terminated Unicode string that is used to fill in the
- VersionName field of the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is
- returned by the GetImageInfo() service of the Firmware Management Protocol.
- The returned string must be allocated using EFI_BOOT_SERVICES.AllocatePool().
- @note It is recommended that all firmware devices support a method to report
- the VersionName string from the currently stored firmware image.
- @param[out] VersionString The version string retrieved from the currently
- stored firmware image.
- @retval EFI_SUCCESS The version string of currently stored
- firmware image was returned in Version.
- @retval EFI_INVALID_PARAMETER VersionString is NULL.
- @retval EFI_UNSUPPORTED The firmware device does not support a method
- to report the version string of the currently
- stored firmware image.
- @retval EFI_DEVICE_ERROR An error occurred attempting to retrieve the
- version string of the currently stored
- firmware image.
- @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate the
- buffer for the version string of the currently
- stored firmware image.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceGetVersionString (
- OUT CHAR16 **VersionString
- )
- {
- if (VersionString == NULL) {
- return EFI_INVALID_PARAMETER;
- }
- //
- // Retrieve the version string from a PCD
- // NOTE: This method of using a PCD can only be used for the system firmware
- // FMP instance that is updated every time the system firmware is
- // updated. If system firmware updates support partial updates that
- // would not include the system firmware FMP instance, then a PCD can
- // not be used and the value must come from the currently running system
- // firmware image.
- //
- *VersionString = (CHAR16 *)AllocateCopyPool (
- PcdGetSize (PcdSystemFirmwareFmpVersionString),
- PcdGetPtr (PcdSystemFirmwareFmpVersionString)
- );
- if (*VersionString == NULL) {
- return EFI_OUT_OF_RESOURCES;
- }
- return EFI_SUCCESS;
- }
- /**
- Gets the current running version.
- ONLY implement this if your running firmware has a method to return this at
- runtime.
- @param[out] Version On return this value represents the current running
- version.
- @retval EFI_SUCCESS The version was correctly retrieved.
- @retval EFI_UNSUPPORTED Device firmware doesn't support reporting current
- version.
- @retval EFI_DEVICE_ERROR Error occurred when trying to get the version.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceGetVersion (
- IN OUT UINT32 *Version
- )
- {
- //
- // Retrieve the version string from a PCD
- // NOTE: This method of using a PCD can only be used for the system firmware
- // FMP instance that is updated every time the system firmware is
- // updated. If system firmware updates support partial updates that
- // would not include the system firmware FMP instance, then a PCD can
- // not be used and the value must come from the currently running system
- // firmware image.
- //
- *Version = PcdGet32 (PcdSystemFirmwareFmpVersion);
- return EFI_SUCCESS;
- }
- /**
- Returns the value used to fill in the HardwareInstance field of the
- EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the GetImageInfo()
- service of the Firmware Management Protocol. If EFI_SUCCESS is returned, then
- the firmware device supports a method to report the HardwareInstance value.
- If the value can not be reported for the firmware device, then EFI_UNSUPPORTED
- must be returned. EFI_DEVICE_ERROR is returned if an error occurs attempting
- to retrieve the HardwareInstance value for the firmware device.
- @param[out] HardwareInstance The hardware instance value for the firmware
- device.
- @retval EFI_SUCCESS The hardware instance for the current firmware
- devide is returned in HardwareInstance.
- @retval EFI_UNSUPPORTED The firmware device does not support a method to
- report the hardware instance value.
- @retval EFI_DEVICE_ERROR An error occurred attempting to retrieve the hardware
- instance value.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceGetHardwareInstance (
- OUT UINT64 *HardwareInstance
- )
- {
- return EFI_UNSUPPORTED;
- }
- /**
- Retrieves a copy of the current firmware image of the device.
- This function allows a copy of the current firmware image to be created and
- saved. The saved copy could later been used, for example, in firmware image
- recovery or rollback.
- @param[out] Image Points to the buffer where the current image is copied
- to.
- @param[out] ImageSize On entry, points to the size of the buffer pointed to
- by Image, in bytes. On return, points to the length of
- the image, in bytes.
- @retval EFI_SUCCESS The image was successfully read from the device.
- @retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small
- to hold the image. The current buffer size
- needed to hold the image is returned in
- ImageSize.
- @retval EFI_INVALID_PARAMETER The Image was NULL.
- @retval EFI_NOT_FOUND The current image is not copied to the buffer.
- @retval EFI_UNSUPPORTED The operation is not supported.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceGetImage (
- IN OUT VOID *Image,
- IN OUT UINTN *ImageSize
- )
- {
- //
- // Check for invalid p;arameters
- //
- if (Image == NULL || ImageSize == NULL) {
- return EFI_INVALID_PARAMETER;
- }
- //
- // Make sure the buffer is big enough to hold the device image
- //
- if (*ImageSize < PcdGet32 (PcdBiosRomSize)) {
- *ImageSize = PcdGet32 (PcdBiosRomSize);
- return EFI_BUFFER_TOO_SMALL;
- }
- //
- // Copy the device image to the buffer
- //
- *ImageSize = PcdGet32 (PcdBiosRomSize);
- CopyMem (
- Image,
- (VOID *)(UINTN)PcdGet32 (PcdBiosRomBase),
- *ImageSize
- );
- return EFI_SUCCESS;
- }
- /**
- Updates a firmware device with a new firmware image. This function returns
- EFI_UNSUPPORTED if the firmware image is not updatable. If the firmware image
- is updatable, the function should perform the following minimal validations
- before proceeding to do the firmware image update.
- - Validate that the image is a supported image for this firmware device.
- Return EFI_ABORTED if the image is not supported. Additional details
- on why the image is not a supported image may be returned in AbortReason.
- - Validate the data from VendorCode if is not NULL. Firmware image
- validation must be performed before VendorCode data validation.
- VendorCode data is ignored or considered invalid if image validation
- fails. Return EFI_ABORTED if the VendorCode data is invalid.
- VendorCode enables vendor to implement vendor-specific firmware image update
- policy. Null if the caller did not specify the policy or use the default
- policy. As an example, vendor can implement a policy to allow an option to
- force a firmware image update when the abort reason is due to the new firmware
- image version is older than the current firmware image version or bad image
- checksum. Sensitive operations such as those wiping the entire firmware image
- and render the device to be non-functional should be encoded in the image
- itself rather than passed with the VendorCode. AbortReason enables vendor to
- have the option to provide a more detailed description of the abort reason to
- the caller.
- @param[in] Image Points to the new firmware image.
- @param[in] ImageSize Size, in bytes, of the new firmware image.
- @param[in] VendorCode This enables vendor to implement vendor-specific
- firmware image update policy. NULL indicates
- the caller did not specify the policy or use the
- default policy.
- @param[in] Progress A function used to report the progress of
- updating the firmware device with the new
- firmware image.
- @param[in] CapsuleFwVersion The version of the new firmware image from the
- update capsule that provided the new firmware
- image.
- @param[out] AbortReason A pointer to a pointer to a Null-terminated
- Unicode string providing more details on an
- aborted operation. The buffer is allocated by
- this function with
- EFI_BOOT_SERVICES.AllocatePool(). It is the
- caller's responsibility to free this buffer with
- EFI_BOOT_SERVICES.FreePool().
- @param[out] LastAttemptStatus A pointer to a UINT32 that holds the last attempt
- status to report back to the ESRT table in case
- of error. This value will only be checked when this
- function returns an error.
- The return status code must fall in the range of
- LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MIN_ERROR_CODE_VALUE to
- LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MAX_ERROR_CODE_VALUE.
- If the value falls outside this range, it will be converted
- to LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL.
- @retval EFI_SUCCESS The firmware device was successfully updated
- with the new firmware image.
- @retval EFI_ABORTED The operation is aborted. Additional details
- are provided in AbortReason.
- @retval EFI_INVALID_PARAMETER The Image was NULL.
- @retval EFI_INVALID_PARAMETER LastAttemptStatus was NULL.
- @retval EFI_UNSUPPORTED The operation is not supported.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceSetImageWithStatus (
- IN CONST VOID *Image,
- IN UINTN ImageSize,
- IN CONST VOID *VendorCode, OPTIONAL
- IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress, OPTIONAL
- IN UINT32 CapsuleFwVersion,
- OUT CHAR16 **AbortReason,
- OUT UINT32 *LastAttemptStatus
- )
- {
- EFI_STATUS Status;
- UINT32 Updateable;
- UINTN Percentage;
- UINTN Index;
- UPDATE_CONFIG_DATA *ConfigData;
- UINTN TotalSize;
- UINTN BytesWritten;
- Updateable = 0;
- Status = FmpDeviceCheckImageWithStatus (Image, ImageSize, &Updateable, LastAttemptStatus);
- if (EFI_ERROR (Status)) {
- DEBUG((DEBUG_ERROR, "FmpDeviceSetImageWithStatus - Check Image failed with %r.\n", Status));
- return Status;
- }
- if (Updateable != IMAGE_UPDATABLE_VALID) {
- DEBUG((DEBUG_ERROR, "FmpDeviceSetImageWithStatus - Check Image returned that the Image was not valid for update. Updatable value = 0x%X.\n", Updateable));
- *LastAttemptStatus = LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MIN_ERROR_CODE_VALUE;
- return EFI_ABORTED;
- }
- if (Progress == NULL) {
- DEBUG((DEBUG_ERROR, "FmpDeviceSetImageWithStatus - Invalid progress callback\n"));
- *LastAttemptStatus = LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MIN_ERROR_CODE_VALUE;
- return EFI_INVALID_PARAMETER;
- }
- Status = Progress (15);
- if (EFI_ERROR (Status)) {
- DEBUG((DEBUG_ERROR, "FmpDeviceSetImageWithStatus - Progress Callback failed with Status %r.\n", Status));
- }
- //
- // Write the image to the firmware device
- //
- Progress (20);
- if (EFI_ERROR (Status)) {
- DEBUG((DEBUG_ERROR, "FmpDeviceSetImageWithStatus - Progress Callback failed with Status %r.\n", Status));
- }
- //
- // Simulate update with delays between progress updates
- //
- for (Percentage = 20; Percentage <= 100; Percentage++) {
- //
- // Wait 0.05 seconds
- //
- // gBS->Stall (50000);
- // Progress (Percentage);
- // if (EFI_ERROR (Status)) {
- // DEBUG((DEBUG_ERROR, "FmpDeviceSetImageWithStatus - Progress Callback failed with Status %r.\n", Status));
- // }
- }
- DEBUG ((DEBUG_INFO, "FmpDeviceSetImageWithStatus - %d Images ...\n", ARRAY_SIZE (mUpdateConfigData)));
- if (ARRAY_SIZE (mUpdateConfigData) == 0) {
- DEBUG((DEBUG_INFO, "PlatformUpdate: BaseAddress - 0x%lx ImageOffset - 0x%x Length - 0x%x\n", 0, 0, ImageSize));
- Status = PerformFlashWriteWithProgress (
- PlatformFirmwareTypeSystemFirmware, // FirmwareType
- 0x00000000, // FlashAddress
- FlashAddressTypeRelativeAddress, // FlashAddressType
- (VOID *)(UINTN)Image, // Buffer
- ImageSize, // BufferLength
- Progress, // Progress
- 20, // StartPercentage
- 100 // EndPercentage
- );
- }
- //
- // Compute total size of update
- //
- for (Index = 0, TotalSize = 0; Index < ARRAY_SIZE (mUpdateConfigData); Index++) {
- TotalSize += mUpdateConfigData[Index].Length;
- }
- BytesWritten = 0;
- for (Index = 0, ConfigData = mUpdateConfigData; Index < ARRAY_SIZE (mUpdateConfigData); Index++, ConfigData++) {
- DEBUG((DEBUG_INFO, "PlatformUpdate(%d): BaseAddress - 0x%lx ImageOffset - 0x%x Length - 0x%x\n",
- Index,
- ConfigData->BaseAddress,
- ConfigData->ImageOffset,
- ConfigData->Length
- ));
- Status = PerformFlashWriteWithProgress (
- ConfigData->FirmwareType, // FirmwareType
- ConfigData->BaseAddress, // FlashAddress
- ConfigData->AddressType, // FlashAddressType
- (VOID *)((UINTN)Image + (UINTN)ConfigData->ImageOffset), // Buffer
- ConfigData->Length, // BufferLength
- Progress, // Progress
- 20 + (BytesWritten * 80) / TotalSize, // StartPercentage
- 20 + ((BytesWritten + ConfigData->Length) * 80) / TotalSize // EndPercentage
- );
- if (EFI_ERROR(Status)) {
- break;
- }
- BytesWritten += ConfigData->Length;
- }
- DEBUG ((DEBUG_INFO, "FmpDeviceSetImageWithStatus - %r\n", Status));
- if (EFI_ERROR (Status)) {
- *LastAttemptStatus = LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MIN_ERROR_CODE_VALUE;
- }
- return Status;
- }
- /**
- Updates the firmware image of the device.
- This function updates the hardware with the new firmware image. This function
- returns EFI_UNSUPPORTED if the firmware image is not updatable. If the
- firmware image is updatable, the function should perform the following minimal
- validations before proceeding to do the firmware image update.
- - Validate the image is a supported image for this device. The function
- returns EFI_ABORTED if the image is unsupported. The function can
- optionally provide more detailed information on why the image is not a
- supported image.
- - Validate the data from VendorCode if not null. Image validation must be
- performed before VendorCode data validation. VendorCode data is ignored
- or considered invalid if image validation failed. The function returns
- EFI_ABORTED if the data is invalid.
- VendorCode enables vendor to implement vendor-specific firmware image update
- policy. Null if the caller did not specify the policy or use the default
- policy. As an example, vendor can implement a policy to allow an option to
- force a firmware image update when the abort reason is due to the new firmware
- image version is older than the current firmware image version or bad image
- checksum. Sensitive operations such as those wiping the entire firmware image
- and render the device to be non-functional should be encoded in the image
- itself rather than passed with the VendorCode. AbortReason enables vendor to
- have the option to provide a more detailed description of the abort reason to
- the caller.
- @param[in] Image Points to the new image.
- @param[in] ImageSize Size of the new image in bytes.
- @param[in] VendorCode This enables vendor to implement vendor-specific
- firmware image update policy. Null indicates the
- caller did not specify the policy or use the
- default policy.
- @param[in] Progress A function used by the driver to report the
- progress of the firmware update.
- @param[in] CapsuleFwVersion FMP Payload Header version of the image.
- @param[out] AbortReason A pointer to a pointer to a null-terminated
- string providing more details for the aborted
- operation. The buffer is allocated by this
- function with AllocatePool(), and it is the
- caller's responsibility to free it with a call
- to FreePool().
- @retval EFI_SUCCESS The device was successfully updated with the
- new image.
- @retval EFI_ABORTED The operation is aborted.
- @retval EFI_INVALID_PARAMETER The Image was NULL.
- @retval EFI_UNSUPPORTED The operation is not supported.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceSetImage (
- IN CONST VOID *Image,
- IN UINTN ImageSize,
- IN CONST VOID *VendorCode,
- IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress,
- IN UINT32 CapsuleFwVersion,
- OUT CHAR16 **AbortReason
- )
- {
- UINT32 LastAttemptStatus;
- return FmpDeviceSetImageWithStatus (
- Image,
- ImageSize,
- VendorCode,
- Progress,
- CapsuleFwVersion,
- AbortReason,
- &LastAttemptStatus
- );
- }
- /**
- Checks if a new firmware image is valid for the firmware device. This
- function allows firmware update operation to validate the firmware image
- before FmpDeviceSetImage() is called.
- @param[in] Image Points to a new firmware image.
- @param[in] ImageSize Size, in bytes, of a new firmware image.
- @param[out] ImageUpdatable Indicates if a new firmware image is valid for
- a firmware update to the firmware device. The
- following values from the Firmware Management
- Protocol are supported:
- IMAGE_UPDATABLE_VALID
- IMAGE_UPDATABLE_INVALID
- IMAGE_UPDATABLE_INVALID_TYPE
- IMAGE_UPDATABLE_INVALID_OLD
- IMAGE_UPDATABLE_VALID_WITH_VENDOR_CODE
- @param[out] LastAttemptStatus A pointer to a UINT32 that holds the last attempt
- status to report back to the ESRT table in case
- of error. This value will only be checked when this
- function returns an error.
- The return status code must fall in the range of
- LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MIN_ERROR_CODE_VALUE to
- LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MAX_ERROR_CODE_VALUE.
- If the value falls outside this range, it will be converted
- to LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL.
- @retval EFI_SUCCESS The image was successfully checked. Additional
- status information is returned in
- ImageUpdatable.
- @retval EFI_INVALID_PARAMETER Image is NULL.
- @retval EFI_INVALID_PARAMETER ImageUpdatable is NULL.
- @retval EFI_INVALID_PARAMETER LastAttemptStatus is NULL.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceCheckImageWithStatus (
- IN CONST VOID *Image,
- IN UINTN ImageSize,
- OUT UINT32 *ImageUpdatable,
- OUT UINT32 *LastAttemptStatus
- )
- {
- if (LastAttemptStatus == NULL) {
- DEBUG ((DEBUG_ERROR, "CheckImageWithStatus - LastAttemptStatus Pointer Parameter is NULL.\n"));
- return EFI_INVALID_PARAMETER;
- }
- *LastAttemptStatus = LAST_ATTEMPT_STATUS_SUCCESS;
- if (ImageUpdatable == NULL) {
- DEBUG((DEBUG_ERROR, "CheckImageWithStatus - ImageUpdatable Pointer Parameter is NULL.\n"));
- *LastAttemptStatus = LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MIN_ERROR_CODE_VALUE;
- return EFI_INVALID_PARAMETER;
- }
- //
- //Set to valid and then if any tests fail it will update this flag.
- //
- *ImageUpdatable = IMAGE_UPDATABLE_VALID;
- if (Image == NULL) {
- DEBUG((DEBUG_ERROR, "CheckImageWithStatus - Image Pointer Parameter is NULL.\n"));
- //
- // Not sure if this is needed
- //
- *ImageUpdatable = IMAGE_UPDATABLE_INVALID;
- *LastAttemptStatus = LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MIN_ERROR_CODE_VALUE;
- return EFI_INVALID_PARAMETER;
- }
- //
- // Make sure the image size is correct
- //
- if (ImageSize != PcdGet32 (PcdBiosRomSize)) {
- *ImageUpdatable = IMAGE_UPDATABLE_INVALID;
- *LastAttemptStatus = LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MIN_ERROR_CODE_VALUE;
- return EFI_INVALID_PARAMETER;
- }
- return EFI_SUCCESS;
- }
- /**
- Checks if the firmware image is valid for the device.
- This function allows firmware update application to validate the firmware image without
- invoking the SetImage() first.
- @param[in] Image Points to the new image.
- @param[in] ImageSize Size of the new image in bytes.
- @param[out] ImageUpdatable Indicates if the new image is valid for update. It also provides,
- if available, additional information if the image is invalid.
- @retval EFI_SUCCESS The image was successfully checked.
- @retval EFI_INVALID_PARAMETER The Image was NULL.
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceCheckImage (
- IN CONST VOID *Image,
- IN UINTN ImageSize,
- OUT UINT32 *ImageUpdateable
- )
- {
- UINT32 LastAttemptStatus;
- return FmpDeviceCheckImageWithStatus (Image, ImageSize, ImageUpdateable, &LastAttemptStatus);
- }
- /**
- Device firmware should trigger lock mechanism so that device fw can not be
- updated or tampered with. This lock mechanism is generally only cleared by a
- full system reset (not just sleep state/low power mode)
- @retval EFI_SUCCESS The device was successfully locked.
- @retval EFI_UNSUPPORTED The hardware device/firmware doesn't support locking
- **/
- EFI_STATUS
- EFIAPI
- FmpDeviceLock (
- VOID
- )
- {
- DEBUG ((DEBUG_INFO, "VLV2: FmpDeviceLock() for system FLASH\n"));
- // TODO: Add lock logic
- return EFI_UNSUPPORTED;
- }
|