SpiNorFlashJedecSfdpSmm.c File Reference

#include <Base.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/SmmServicesTableLib.h>
#include <Protocol/SpiSmmConfiguration.h>
#include <Protocol/SpiSmmNorFlash.h>
#include <Protocol/SpiIo.h>
#include <IndustryStandard/SpiNorFlashJedecSfdp.h>
#include "SpiNorFlash.h"
#include "SpiNorFlashJedecSfdpInternal.h"

Go to the source code of this file.

Functions
EFI_STATUS	CreateSpiNorFlashSfdpInstance (IN EFI_HANDLE SpiIoHandle)
EFI_STATUS EFIAPI	SpiIoProtocolInstalledCallback (IN CONST EFI_GUID *Protocol, IN VOID *Interface, IN EFI_HANDLE Handle)
EFI_STATUS	RegisterSpioProtocolNotification (VOID)
EFI_STATUS EFIAPI	SpiNorFlashJedecSfdpSmmEntry (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Detailed Description

SPI NOR Flash JEDEC Serial Flash Discoverable Parameters (SFDP) SMM driver.

Copyright (C) 2024 Advanced Micro Devices, Inc. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:

• JEDEC Standard, JESD216F.02 https://www.jedec.org/document_search?search_api_views_fulltext=JESD216

Glossary:

• SFDP - Serial Flash Discoverable Parameters
• PTP - Parameter Table Pointer

Definition in file SpiNorFlashJedecSfdpSmm.c.

Function Documentation

CreateSpiNorFlashSfdpInstance()

EFI_STATUS CreateSpiNorFlashSfdpInstance

(

IN EFI_HANDLE

SpiIoHandle

)

Function to create SPI_NOR_FLASH_INSTANCE for this SPI part.

Parameters

[in]

SpiIoHandle

The handle with SPI I/O protocol installed.

Return values

EFI_SUCCESS	Succeed.
EFI_OUT_OF_RESOURCES	Not enough resource to create SPI_NOR_FLASH_INSTANCE.
otherwise	Fail to create SPI NOR Flash SFDP Instance

Definition at line 38 of file SpiNorFlashJedecSfdpSmm.c.

RegisterSpioProtocolNotification()

EFI_STATUS RegisterSpioProtocolNotification

(

VOID

)

Register notification for the later installed SPI I/O protocol.

Return values

EFI_SUCCESS	Succeed.
otherwise	Fail to register the notification of SPI I/O protocol installation.

Definition at line 121 of file SpiNorFlashJedecSfdpSmm.c.

SpiIoProtocolInstalledCallback()

EFI_STATUS EFIAPI SpiIoProtocolInstalledCallback	(	IN CONST EFI_GUID *	Protocol,
		IN VOID *	Interface,
		IN EFI_HANDLE	Handle
	)

Callback function executed when the EFI_SPI_IO_PROTOCOL protocol interface is installed.

Parameters

[in]	Protocol	Points to the protocol's unique identifier.
[in]	Interface	Points to the interface instance.
[in]	Handle	The handle on which the interface was installed.

Returns

Status Code

Definition at line 99 of file SpiNorFlashJedecSfdpSmm.c.

SpiNorFlashJedecSfdpSmmEntry()

EFI_STATUS EFIAPI SpiNorFlashJedecSfdpSmmEntry	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Entry point of the SPI NOR Flash SFDP SMM driver.

Parameters

ImageHandle	Image handle of this driver.
SystemTable	Pointer to standard EFI system table.

Return values

EFI_SUCCESS	Succeed.
EFI_NOT_FOUND	No gEdk2JedecSfdpSpiSmmDriverGuid installed on system yet.
EFI_OUT_OF_RESOURCES	Not enough resource for SPI NOR Flash JEDEC SFDP initialization.
Otherwise	Other errors.

Definition at line 157 of file SpiNorFlashJedecSfdpSmm.c.