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.
16 #ifndef _FRAMEWORK_SMM_CIS_H_
17 #define _FRAMEWORK_SMM_CIS_H_
19 #define EFI_SMM_CPU_IO_GUID \
21 0x5f439a0b, 0x45d8, 0x4682, {0xa4, 0xf4, 0xf0, 0x57, 0x6b, 0x51, 0x34, 0x41 } \
24 typedef struct _EFI_SMM_SYSTEM_TABLE EFI_SMM_SYSTEM_TABLE
;
25 typedef struct _EFI_SMM_CPU_IO_INTERFACE EFI_SMM_CPU_IO_INTERFACE
;
29 // SMM Base specification constant and types
31 #define SMM_SMST_SIGNATURE SIGNATURE_32 ('S', 'M', 'S', 'T')
32 #define EFI_SMM_SYSTEM_TABLE_REVISION (0 << 16) | (0x09)
35 // *******************************************************
37 // *******************************************************
47 Provides the basic memory and I/O interfaces that are used to
48 abstract accesses to devices.
50 @param This The EFI_SMM_CPU_IO_INTERFACE instance.
51 @param Width Signifies the width of the I/O operations.
52 @param Address The base address of the I/O operations.
53 @param Count The number of I/O operations to perform.
54 @param Buffer For read operations, the destination buffer to store the results.
55 For write operations, the source buffer from which to write data.
57 @retval EFI_SUCCESS The data was read from or written to the device.
58 @retval EFI_UNSUPPORTED The Address is not valid for this system.
59 @retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
60 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
65 (EFIAPI
*EFI_SMM_CPU_IO
)(
66 IN EFI_SMM_CPU_IO_INTERFACE
*This
,
67 IN EFI_SMM_IO_WIDTH Width
,
74 EFI_SMM_CPU_IO Read
; ///< This service provides the various modalities of memory and I/O read.
75 EFI_SMM_CPU_IO Write
; ///< This service provides the various modalities of memory and I/O write.
79 /// The EFI_SMM_CPU_IO_INTERFACE service provides the basic memory, I/O, and PCI
80 /// interfaces that are used to abstract accesses to devices.
82 struct _EFI_SMM_CPU_IO_INTERFACE
{
84 /// Allows reads and writes to memory-mapped I/O space.
86 EFI_SMM_IO_ACCESS Mem
;
88 /// Allows reads and writes to I/O space.
94 Allocates pool memory from SMRAM for IA-32 or runtime memory for
95 the Itanium processor family.
97 @param PoolType The type of pool to allocate.The only supported type is EfiRuntimeServicesData
98 @param Size The number of bytes to allocate from the pool.
99 @param Buffer A pointer to a pointer to the allocated buffer if the call
100 succeeds; undefined otherwise.
102 @retval EFI_SUCCESS The requested number of bytes was allocated.
103 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
104 @retval EFI_UNSUPPORTED In runtime.
105 @note: Inconsistent with specification here:
106 In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_POOL. However,
107 To avoid the naming conflict, the definition is renamed.
111 (EFIAPI
*EFI_SMMCORE_ALLOCATE_POOL
)(
112 IN EFI_MEMORY_TYPE PoolType
,
118 Returns pool memory to the system.
120 @param Buffer Pointer to the buffer to free.
122 @retval EFI_SUCCESS The memory was returned to the system.
123 @retval EFI_INVALID_PARAMETER Buffer was invalid.
124 @retval EFI_UNSUPPORTED In runtime.
125 @note: Inconsistent with specification here:
126 In Framework Spec, This definition is naming EFI_SMM_FREE_POOL However,
127 To avoid the naming conflict, the definition is renamed.
131 (EFIAPI
*EFI_SMMCORE_FREE_POOL
)(
136 Allocates memory pages from the system.
138 @param Type The type of allocation to perform.
139 @param MemoryType The only supported type is EfiRuntimeServicesData
140 @param NumberofPages The number of contiguous 4 KB pages to allocate
141 @param Memory Pointer to a physical address. On input, the way in which
142 the address is used depends on the value of Type. On output, the address
143 is set to the base of the page range that was allocated.
145 @retval EFI_SUCCESS The requested pages were allocated.
146 @retval EFI_OUT_OF_RESOURCES The pages requested could not be allocated.
147 @retval EFI_NOT_FOUND The requested pages could not be found.
148 @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress
149 or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.
150 @note: Inconsistent with specification here:
151 In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_PAGES However,
152 To avoid the naming conflict, the definition is renamed.
156 (EFIAPI
*EFI_SMMCORE_ALLOCATE_PAGES
)(
157 IN EFI_ALLOCATE_TYPE Type
,
158 IN EFI_MEMORY_TYPE MemoryType
,
159 IN UINTN NumberOfPages
,
160 OUT EFI_PHYSICAL_ADDRESS
*Memory
164 Frees memory pages for the system.
166 @param Memory The base physical address of the pages to be freed
167 @param NumberOfPages The number of contiguous 4 KB pages to free.
169 @retval EFI_SUCCESS The requested memory pages were freed.
170 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.
171 @retval EFI_NOT_FOUND The requested memory pages were not allocated with SmmAllocatePages().
173 @note: Inconsistent with specification here:
174 In Framework Spec, This definition is naming EFI_SMM_FREE_PAGES However,
175 To avoid the naming conflict, the definition is renamed.
179 (EFIAPI
*EFI_SMMCORE_FREE_PAGES
)(
180 IN EFI_PHYSICAL_ADDRESS Memory
,
181 IN UINTN NumberOfPages
184 Frees memory pages for the system.
186 @param Procedure A pointer to the code stream to be run on the designated AP of the system.
187 @param CpuNumber The zero-based index of the processor number of the AP on which the code stream is
188 supposed to run. If the processor number points to the current processor or a disabled
189 processor, then it will not run the supplied code.
190 @param ProcArguments Allows the caller to pass a list of parameters to the code that is run by
191 the AP. It is an optional common mailbox between APs and the BSP to share information.
193 @retval EFI_SUCCESS The call was successful and the return parameters are valid.
194 @retval EFI_INVALID_PARAMETER The input arguments are out of range.
195 @retval EFI_INVALID_PARAMETER The CPU requested is not available on this SMI invocation.
196 @retval EFI_INVALID_PARAMETER The CPU cannot support an additional service invocation.
198 @note: Inconsistent with specification here:
199 In Framework Spec, No this definition. This method is introduced in PI1.0 spec for
200 implementation needed.
205 (EFIAPI
*EFI_SMM_STARTUP_THIS_AP
)(
206 IN EFI_AP_PROCEDURE Procedure
,
208 IN OUT VOID
*ProcArguments OPTIONAL
212 /// The processor save-state information for IA-32 processors. This information is important in that the
213 /// SMM drivers may need to ascertain the state of the processor before invoking the SMI.
217 /// Reserved for future processors. As such, software should not attempt to interpret or
218 /// write to this region.
220 UINT8 Reserved1
[248];
222 /// The location of the processor SMBASE, which is the location where the processor
223 /// will pass control upon receipt of an SMI.
227 /// The revision of the SMM save state. This value is set by the processor.
231 /// The value of the I/O restart field. Allows for restarting an in-process I/O instruction.
235 /// Describes behavior that should be commenced in response to a halt instruction.
237 UINT16 AutoHALTRestart
;
239 /// Reserved for future processors. As such, software should not attempt to interpret or
240 /// write to this region.
242 UINT8 Reserved2
[164];
245 // Registers in IA-32 processors.
269 } EFI_SMI_CPU_SAVE_STATE
;
272 /// The processor save-state information for the Itanium processor family. This information is
273 /// important in that the SMM drivers may need to ascertain the state of the processor before invoking
274 /// the PMI. This structure is mandatory and must be 512 byte aligned.
321 // application registers
382 UINT64 int_nat
; // nat bits for R1-R31
384 } EFI_PMI_SYSTEM_CONTEXT
;
387 /// The processor save-state information for IA-32 and Itanium processors. This information is
388 /// important in that the SMM drivers may need to ascertain the state of the processor before invoking
393 /// The processor save-state information for IA-32 processors.
395 EFI_SMI_CPU_SAVE_STATE Ia32SaveState
;
397 /// The processor save-state information for Itanium processors.
399 EFI_PMI_SYSTEM_CONTEXT ItaniumSaveState
;
400 } EFI_SMM_CPU_SAVE_STATE
;
403 /// The optional floating point save-state information for IA-32 processors. If the optional floating
404 /// point save is indicated for any handler, the following data structure must be preserved.
417 UINT8 St0Mm0
[10], Rsvd3
[6];
418 UINT8 St0Mm1
[10], Rsvd4
[6];
419 UINT8 St0Mm2
[10], Rsvd5
[6];
420 UINT8 St0Mm3
[10], Rsvd6
[6];
421 UINT8 St0Mm4
[10], Rsvd7
[6];
422 UINT8 St0Mm5
[10], Rsvd8
[6];
423 UINT8 St0Mm6
[10], Rsvd9
[6];
424 UINT8 St0Mm7
[10], Rsvd10
[6];
426 } EFI_SMI_OPTIONAL_FPSAVE_STATE
;
429 /// The optional floating point save-state information for the Itanium processor family. If the optional
430 /// floating point save is indicated for any handler, then this data structure must be preserved.
463 } EFI_PMI_OPTIONAL_FLOATING_POINT_CONTEXT
;
466 /// The processor save-state information for IA-32 and Itanium processors. If the optional floating
467 /// point save is indicated for any handler, then this data structure must be preserved.
471 /// The optional floating point save-state information for IA-32 processors.
473 EFI_SMI_OPTIONAL_FPSAVE_STATE Ia32FpSave
;
475 /// The optional floating point save-state information for Itanium processors.
477 EFI_PMI_OPTIONAL_FLOATING_POINT_CONTEXT ItaniumFpSave
;
478 } EFI_SMM_FLOATING_POINT_SAVE_STATE
;
481 This function is the main entry point for an SMM handler dispatch
482 or communicate-based callback.
484 @param SmmImageHandle A unique value returned by the SMM infrastructure
485 in response to registration for a communicate-based callback or dispatch.
486 @param CommunicationBuffer
487 An optional buffer that will be populated
488 by the SMM infrastructure in response to a non-SMM agent (preboot or runtime)
489 invoking the EFI_SMM_BASE_PROTOCOL.Communicate() service.
490 @param SourceSize If CommunicationBuffer is non-NULL, this field
491 indicates the size of the data payload in this buffer.
498 (EFIAPI
*EFI_SMM_HANDLER_ENTRY_POINT
)(
499 IN EFI_HANDLE SmmImageHandle
,
500 IN OUT VOID
*CommunicationBuffer OPTIONAL
,
501 IN OUT UINTN
*SourceSize OPTIONAL
505 The SmmInstallConfigurationTable() function is used to maintain the list
506 of configuration tables that are stored in the System Management System
507 Table. The list is stored as an array of (GUID, Pointer) pairs. The list
508 must be allocated from pool memory with PoolType set to EfiRuntimeServicesData.
510 @param SystemTable A pointer to the SMM System Table.
511 @param Guid A pointer to the GUID for the entry to add, update, or remove.
512 @param Table A pointer to the buffer of the table to add.
513 @param TableSize The size of the table to install.
515 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
516 @retval EFI_INVALID_PARAMETER Guid is not valid.
517 @retval EFI_NOT_FOUND An attempt was made to delete a non-existent entry.
518 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
523 (EFIAPI
*EFI_SMM_INSTALL_CONFIGURATION_TABLE
)(
524 IN EFI_SMM_SYSTEM_TABLE
*SystemTable
,
531 // System Management System Table (SMST)
533 struct _EFI_SMM_SYSTEM_TABLE
{
535 /// The table header for the System Management System Table (SMST).
537 EFI_TABLE_HEADER Hdr
;
540 /// A pointer to a NULL-terminated Unicode string containing the vendor name. It is
541 /// permissible for this pointer to be NULL.
543 CHAR16
*SmmFirmwareVendor
;
545 /// The particular revision of the firmware.
547 UINT32 SmmFirmwareRevision
;
550 /// Adds, updates, or removes a configuration table entry from the SMST.
552 EFI_SMM_INSTALL_CONFIGURATION_TABLE SmmInstallConfigurationTable
;
558 /// A GUID that designates the particular CPU I/O services.
560 EFI_GUID EfiSmmCpuIoGuid
;
562 /// Provides the basic memory and I/O interfaces that are used to abstract accesses to
565 EFI_SMM_CPU_IO_INTERFACE SmmIo
;
568 // Runtime memory service
572 /// Allocates pool memory from SMRAM for IA-32 or runtime memory for the
573 /// Itanium processor family.
575 EFI_SMMCORE_ALLOCATE_POOL SmmAllocatePool
;
577 /// Returns pool memory to the system.
579 EFI_SMMCORE_FREE_POOL SmmFreePool
;
581 /// Allocates memory pages from the system.
583 EFI_SMMCORE_ALLOCATE_PAGES SmmAllocatePages
;
585 /// Frees memory pages for the system.
587 EFI_SMMCORE_FREE_PAGES SmmFreePages
;
593 ///Inconsistent with specification here:
594 /// In Framework Spec, No this definition. This method is introduced in PI1.0 spec for
595 /// implementation needed.
596 EFI_SMM_STARTUP_THIS_AP SmmStartupThisAp
;
599 // CPU information records
602 /// A 1-relative number between 1 and the NumberOfCpus field. This field designates
603 /// which processor is executing the SMM infrastructure. This number also serves as an
604 /// index into the CpuSaveState and CpuOptionalFloatingPointState
607 UINTN CurrentlyExecutingCpu
;
609 /// The number of EFI Configuration Tables in the buffer
610 /// SmmConfigurationTable.
614 /// A pointer to the EFI Configuration Tables. The number of entries in the table is
615 /// NumberOfTableEntries.
617 EFI_SMM_CPU_SAVE_STATE
*CpuSaveState
;
619 /// A pointer to a catenation of the EFI_SMM_FLOATING_POINT_SAVE_STATE.
620 /// The size of this entire table is NumberOfCpus* size of the
621 /// EFI_SMM_FLOATING_POINT_SAVE_STATE. These fields are populated only if
622 /// there is at least one SMM driver that has registered for a callback with the
623 /// FloatingPointSave field in EFI_SMM_BASE_PROTOCOL.RegisterCallback() set to TRUE.
625 EFI_SMM_FLOATING_POINT_SAVE_STATE
*CpuOptionalFloatingPointState
;
628 // Extensibility table
631 /// The number of EFI Configuration Tables in the buffer
632 /// SmmConfigurationTable.
634 UINTN NumberOfTableEntries
;
636 /// A pointer to the EFI Configuration Tables. The number of entries in the table is
637 /// NumberOfTableEntries.
639 EFI_CONFIGURATION_TABLE
*SmmConfigurationTable
;