SetupDesignGuide.pdf - Firmware Encoding Index

Setup Design Guide
DRAFT
7.2.2 EFI_FORM_CONFIGURATION_PROTOCOL.SendMessage()
Summary
This function allows the caller to put data into the configuration driver’s internal mailbox. This has the
effect of allowing data to be posted as a key/value pair and have information be updated as an out-ofband
transaction.
Prototype
EFI_STATUS
(EFIAPI *EFI_SEND_MESSAGE) (
IN EFI_FORM_CONFIGURATION_PROTOCOL *This,
IN UINT16
MessageKey,
IN VOID
*MessageData,
IN UINTN
MessageDataLength
);
Parameters
This
MessageKey
MessageData
MessageDataLength
A pointer to the EFI_FORM_CONFIGURATION_PROTOCOL
instance.
A unique value which will have be associated with a particular opcode.
The messaging services are typically to be used in an
Interactive or Dynamic mode situation where a periodic event may
occur that requires certain pieces of data to be updated. For
instance, temperature sensor data might get dynamically updated
based on events from the calling driver.
A pointer to the data associated with the MessageKey.
The length of the data in MessageData.
Related Definitions
The MessageData format will be based on the op-code type that the
MessageKey references.
If OneOf command:
An array of option encodings.
Each encoding is as follows:
typedef struct _EFI_IFR_OP_HEADER {
UINT8
OpCode;
UINT8
Length;
} EFI_IFR_OP_HEADER;
typedef struct {
EFI_IFR_OP_HEADER
Header;
70