Prm.h File Reference

#include <Uefi.h>
#include <PrmContextBuffer.h>

Go to the source code of this file.

Macros
#define	PRM_EXPORT_API
#define	PRM_HANDLER_NAME_MAXIMUM_LENGTH   128
#define	PRM_STRING_(x)   #x
#define	PRM_STRING(x)   PRM_STRING_(x)

Typedefs
typedef IN PRM_CONTEXT_BUFFER *ContextBuffer	OPTIONAL

Functions
typedef	EFI_STATUS (EFIAPI PRM_HANDLER)(IN VOID *ParameterBuffer OPTIONAL

Detailed Description

Common Platform Runtime Mechanism (PRM) definitions.

Copyright (c) Microsoft Corporation Copyright (c) 2022, Arm Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Prm.h.

Macro Definition Documentation

PRM_EXPORT_API

#define PRM_EXPORT_API

Definition at line 22 of file Prm.h.

PRM_HANDLER_NAME_MAXIMUM_LENGTH

#define PRM_HANDLER_NAME_MAXIMUM_LENGTH   128

Definition at line 25 of file Prm.h.

PRM_STRING

#define PRM_STRING

(

x

)

PRM_STRING_(x)

Definition at line 28 of file Prm.h.

PRM_STRING_

#define PRM_STRING_

(

x

)

#x

Definition at line 27 of file Prm.h.

Typedef Documentation

OPTIONAL

typedef IN PRM_CONTEXT_BUFFER* ContextBuffer OPTIONAL

Definition at line 46 of file Prm.h.

Function Documentation

EFI_STATUS()

typedef EFI_STATUS

(

EFIAPI

PRM_HANDLER

)

A Platform Runtime Mechanism (PRM) handler function.

Parameters

[in]	ParameterBuffer	A pointer to a buffer with arbitrary data that is allocated and populated by the PRM handler caller.
[in]	ContextBuffer	A pointer to a buffer with arbitrary data that is allocated in the firmware boot environment.

Return values

EFI_STATUS	The PRM handler executed successfully.
Others	An error occurred in the PRM handler.