2 Include file for definitions in the Intel Platform Innovation Framework for EFI
3 System Management Mode Core Interface Specification (SMM CIS) version 0.90.
5 Copyright (c) 2007 - 2009, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 // Share some common definitions with PI SMM
22 #include <Pi/PiSmmCis.h>
23 #include <Protocol/SmmCpuIo.h>
25 #define EFI_SMM_CPU_IO_GUID \
27 0x5f439a0b, 0x45d8, 0x4682, {0xa4, 0xf4, 0xf0, 0x57, 0x6b, 0x51, 0x34, 0x41 } \
30 typedef struct _EFI_SMM_SYSTEM_TABLE EFI_SMM_SYSTEM_TABLE
;
31 typedef struct _EFI_SMM_CPU_IO_INTERFACE EFI_SMM_CPU_IO_INTERFACE
;
35 // SMM Base specification constant and types
37 #define EFI_SMM_SYSTEM_TABLE_REVISION (0 << 16) | (0x09)
40 Provides the basic memory and I/O interfaces that are used to
41 abstract accesses to devices.
43 @param This The EFI_SMM_CPU_IO_INTERFACE instance.
44 @param Width Signifies the width of the I/O operations.
45 @param Address The base address of the I/O operations.
46 @param Count The number of I/O operations to perform.
47 @param Buffer For read operations, the destination buffer to store the results (out parameter).
48 For write operations, the source buffer from which to write data (in parameter).
50 @retval EFI_SUCCESS The data was read from or written to the device.
51 @retval EFI_UNSUPPORTED The Address is not valid for this system.
52 @retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
53 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
58 (EFIAPI
*EFI_SMM_CPU_IO
)(
59 IN EFI_SMM_CPU_IO_INTERFACE
*This
,
60 IN EFI_SMM_IO_WIDTH Width
,
67 EFI_SMM_CPU_IO Read
; ///< This service provides the various modalities of memory and I/O read.
68 EFI_SMM_CPU_IO Write
; ///< This service provides the various modalities of memory and I/O write.
72 /// The EFI_SMM_CPU_IO_INTERFACE service provides the basic memory, I/O, and PCI
73 /// interfaces that are used to abstract accesses to devices.
75 struct _EFI_SMM_CPU_IO_INTERFACE
{
77 /// Allows reads and writes to memory-mapped I/O space.
79 EFI_SMM_IO_ACCESS Mem
;
81 /// Allows reads and writes to I/O space.
87 Allocates pool memory from SMRAM for IA-32 or runtime memory for
88 the Itanium processor family.
90 @param PoolType The type of pool to allocate. The only supported type is EfiRuntimeServicesData
91 @param Size The number of bytes to allocate from the pool.
92 @param Buffer A pointer to a pointer to the allocated buffer if the call
93 succeeds; undefined otherwise.
95 @retval EFI_SUCCESS The requested number of bytes was allocated.
96 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
97 @retval EFI_UNSUPPORTED In runtime.
98 @note: Inconsistent with specification here:
99 In Framework Spec, this definition is named EFI_SMM_ALLOCATE_POOL.
100 To avoid a naming conflict, the definition is renamed.
104 (EFIAPI
*EFI_SMMCORE_ALLOCATE_POOL
)(
105 IN EFI_MEMORY_TYPE PoolType
,
111 Returns pool memory to the system.
113 @param Buffer Pointer to the buffer to free.
115 @retval EFI_SUCCESS The memory was returned to the system.
116 @retval EFI_INVALID_PARAMETER Buffer was invalid.
117 @retval EFI_UNSUPPORTED In runtime.
118 @note: Inconsistent with specification here:
119 In Framework Spec, this definition is named EFI_SMM_FREE_POOL.
120 To avoid a naming conflict, the definition is renamed.
124 (EFIAPI
*EFI_SMMCORE_FREE_POOL
)(
129 Allocates memory pages from the system.
131 @param Type The type of allocation to perform.
132 @param MemoryType The only supported type is EfiRuntimeServicesData
133 @param NumberofPages The number of contiguous 4 KB pages to allocate
134 @param Memory Pointer to a physical address. On input, the way in which
135 the address is used depends on the value of Type. On output, the address
136 is set to the base of the page range that was allocated.
138 @retval EFI_SUCCESS The requested pages were allocated.
139 @retval EFI_OUT_OF_RESOURCES The pages requested could not be allocated.
140 @retval EFI_NOT_FOUND The requested pages could not be found.
141 @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress
142 or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.
143 @note: Inconsistent with specification here:
144 In the Framework Spec, this definition is named EFI_SMM_ALLOCATE_PAGES.
145 To avoid a naming conflict, the definition here is renamed.
149 (EFIAPI
*EFI_SMMCORE_ALLOCATE_PAGES
)(
150 IN EFI_ALLOCATE_TYPE Type
,
151 IN EFI_MEMORY_TYPE MemoryType
,
152 IN UINTN NumberOfPages
,
153 OUT EFI_PHYSICAL_ADDRESS
*Memory
157 Frees memory pages for the system.
159 @param Memory The base physical address of the pages to be freed
160 @param NumberOfPages The number of contiguous 4 KB pages to free.
162 @retval EFI_SUCCESS The requested memory pages were freed.
163 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.
164 @retval EFI_NOT_FOUND The requested memory pages were not allocated with SmmAllocatePages().
166 @note: Inconsistent with specification here:
167 In the Framework Spec, this definition is named EFI_SMM_FREE_PAGES.
168 To avoid a naming conflict, the definition here is renamed.
172 (EFIAPI
*EFI_SMMCORE_FREE_PAGES
)(
173 IN EFI_PHYSICAL_ADDRESS Memory
,
174 IN UINTN NumberOfPages
178 /// The processor save-state information for IA-32 processors. This information is important in that the
179 /// SMM drivers may need to ascertain the state of the processor before invoking the SMI.
183 /// Reserved for future processors. As such, software should not attempt to interpret or
184 /// write to this region.
186 UINT8 Reserved1
[248];
188 /// The location of the processor SMBASE, which is the location where the processor
189 /// will pass control upon receipt of an SMI.
193 /// The revision of the SMM save state. This value is set by the processor.
197 /// The value of the I/O restart field. Allows for restarting an in-process I/O instruction.
201 /// Describes behavior that should be commenced in response to a halt instruction.
203 UINT16 AutoHALTRestart
;
205 /// Reserved for future processors. As such, software should not attempt to interpret or
206 /// write to this region.
208 UINT8 Reserved2
[164];
211 // Registers in IA-32 processors.
235 } EFI_SMI_CPU_SAVE_STATE
;
238 /// The processor save-state information for the Itanium processor family. This information is
239 /// important in that the SMM drivers may need to ascertain the state of the processor before invoking
240 /// the PMI. This structure is mandatory and must be 512 byte aligned.
287 // application registers
348 UINT64 int_nat
; // nat bits for R1-R31
350 } EFI_PMI_SYSTEM_CONTEXT
;
353 /// The processor save-state information for IA-32 and Itanium processors. This information is
354 /// important in that the SMM drivers may need to ascertain the state of the processor before invoking
359 /// The processor save-state information for IA-32 processors.
361 EFI_SMI_CPU_SAVE_STATE Ia32SaveState
;
363 /// The processor save-state information for Itanium processors.
365 EFI_PMI_SYSTEM_CONTEXT ItaniumSaveState
;
366 } EFI_SMM_CPU_SAVE_STATE
;
369 /// The optional floating point save-state information for IA-32 processors. If the optional floating
370 /// point save is indicated for any handler, the following data structure must be preserved.
383 UINT8 St0Mm0
[10], Rsvd3
[6];
384 UINT8 St0Mm1
[10], Rsvd4
[6];
385 UINT8 St0Mm2
[10], Rsvd5
[6];
386 UINT8 St0Mm3
[10], Rsvd6
[6];
387 UINT8 St0Mm4
[10], Rsvd7
[6];
388 UINT8 St0Mm5
[10], Rsvd8
[6];
389 UINT8 St0Mm6
[10], Rsvd9
[6];
390 UINT8 St0Mm7
[10], Rsvd10
[6];
392 } EFI_SMI_OPTIONAL_FPSAVE_STATE
;
395 /// The optional floating point save-state information for the Itanium processor family. If the optional
396 /// floating point save is indicated for any handler, then this data structure must be preserved.
429 } EFI_PMI_OPTIONAL_FLOATING_POINT_CONTEXT
;
432 /// The processor save-state information for IA-32 and Itanium processors. If the optional floating
433 /// point save is indicated for any handler, then this data structure must be preserved.
437 /// The optional floating point save-state information for IA-32 processors.
439 EFI_SMI_OPTIONAL_FPSAVE_STATE Ia32FpSave
;
441 /// The optional floating point save-state information for Itanium processors.
443 EFI_PMI_OPTIONAL_FLOATING_POINT_CONTEXT ItaniumFpSave
;
444 } EFI_SMM_FLOATING_POINT_SAVE_STATE
;
447 This function is the main entry point for an SMM handler dispatch
448 or communicate-based callback.
450 @param SmmImageHandle A unique value returned by the SMM infrastructure
451 in response to registration for a communicate-based callback or dispatch.
452 @param CommunicationBuffer
453 An optional buffer that will be populated
454 by the SMM infrastructure in response to a non-SMM agent (preboot or runtime)
455 invoking the EFI_SMM_BASE_PROTOCOL.Communicate() service.
456 @param SourceSize If CommunicationBuffer is non-NULL, this field
457 indicates the size of the data payload in this buffer.
464 (EFIAPI
*EFI_SMM_HANDLER_ENTRY_POINT
)(
465 IN EFI_HANDLE SmmImageHandle
,
466 IN OUT VOID
*CommunicationBuffer OPTIONAL
,
467 IN OUT UINTN
*SourceSize OPTIONAL
471 The SmmInstallConfigurationTable() function is used to maintain the list
472 of configuration tables that are stored in the System Management System
473 Table. The list is stored as an array of (GUID, Pointer) pairs. The list
474 must be allocated from pool memory with PoolType set to EfiRuntimeServicesData.
476 @param SystemTable A pointer to the SMM System Table.
477 @param Guid A pointer to the GUID for the entry to add, update, or remove.
478 @param Table A pointer to the buffer of the table to add.
479 @param TableSize The size of the table to install.
481 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
482 @retval EFI_INVALID_PARAMETER Guid is not valid.
483 @retval EFI_NOT_FOUND An attempt was made to delete a non-existent entry.
484 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
489 (EFIAPI
*EFI_SMM_INSTALL_CONFIGURATION_TABLE
)(
490 IN EFI_SMM_SYSTEM_TABLE
*SystemTable
,
497 // System Management System Table (SMST)
499 struct _EFI_SMM_SYSTEM_TABLE
{
501 /// The table header for the System Management System Table (SMST).
503 EFI_TABLE_HEADER Hdr
;
506 /// A pointer to a NULL-terminated Unicode string containing the vendor name. It is
507 /// permissible for this pointer to be NULL.
509 CHAR16
*SmmFirmwareVendor
;
511 /// The particular revision of the firmware.
513 UINT32 SmmFirmwareRevision
;
516 /// Adds, updates, or removes a configuration table entry from the SMST.
518 EFI_SMM_INSTALL_CONFIGURATION_TABLE SmmInstallConfigurationTable
;
524 /// A GUID that designates the particular CPU I/O services.
526 EFI_GUID EfiSmmCpuIoGuid
;
528 /// Provides the basic memory and I/O interfaces that are used to abstract accesses to
531 EFI_SMM_CPU_IO_INTERFACE SmmIo
;
534 // Runtime memory service
538 /// Allocates pool memory from SMRAM for IA-32 or runtime memory for the
539 /// Itanium processor family.
541 EFI_SMMCORE_ALLOCATE_POOL SmmAllocatePool
;
543 /// Returns pool memory to the system.
545 EFI_SMMCORE_FREE_POOL SmmFreePool
;
547 /// Allocates memory pages from the system.
549 EFI_SMMCORE_ALLOCATE_PAGES SmmAllocatePages
;
551 /// Frees memory pages for the system.
553 EFI_SMMCORE_FREE_PAGES SmmFreePages
;
559 ///Inconsistent with specification here:
560 /// In Framework Spec, this definition does not exist. This method is introduced in PI1.1 spec for
561 /// implementation needed.
562 EFI_SMM_STARTUP_THIS_AP SmmStartupThisAp
;
565 // CPU information records
568 /// A 1-relative number between 1 and the NumberOfCpus field. This field designates
569 /// which processor is executing the SMM infrastructure. This number also serves as an
570 /// index into the CpuSaveState and CpuOptionalFloatingPointState
573 UINTN CurrentlyExecutingCpu
;
575 /// The number of EFI Configuration Tables in the buffer
576 /// SmmConfigurationTable.
580 /// A pointer to the EFI Configuration Tables. The number of entries in the table is
581 /// NumberOfTableEntries.
583 EFI_SMM_CPU_SAVE_STATE
*CpuSaveState
;
585 /// A pointer to a catenation of the EFI_SMM_FLOATING_POINT_SAVE_STATE.
586 /// The size of this entire table is NumberOfCpus* size of the
587 /// EFI_SMM_FLOATING_POINT_SAVE_STATE. These fields are populated only if
588 /// there is at least one SMM driver that has registered for a callback with the
589 /// FloatingPointSave field in EFI_SMM_BASE_PROTOCOL.RegisterCallback() set to TRUE.
591 EFI_SMM_FLOATING_POINT_SAVE_STATE
*CpuOptionalFloatingPointState
;
594 // Extensibility table
597 /// The number of EFI Configuration Tables in the buffer
598 /// SmmConfigurationTable.
600 UINTN NumberOfTableEntries
;
602 /// A pointer to the EFI Configuration Tables. The number of entries in the table is
603 /// NumberOfTableEntries.
605 EFI_CONFIGURATION_TABLE
*SmmConfigurationTable
;