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 #include <Framework/DxeCis.h>
21 #define EFI_SMM_CPU_IO_GUID \
23 0x5f439a0b, 0x45d8, 0x4682, {0xa4, 0xf4, 0xf0, 0x57, 0x6b, 0x51, 0x34, 0x41 } \
26 typedef struct _EFI_SMM_SYSTEM_TABLE EFI_SMM_SYSTEM_TABLE
;
27 typedef struct _EFI_SMM_CPU_IO_INTERFACE EFI_SMM_CPU_IO_INTERFACE
;
31 // SMM Base specification constant and types
33 #define SMM_SMST_SIGNATURE SIGNATURE_32 ('S', 'M', 'S', 'T')
34 #define EFI_SMM_SYSTEM_TABLE_REVISION (0 << 16) | (0x09)
37 // *******************************************************
39 // *******************************************************
49 Provides the basic memory and I/O interfaces that are used to
50 abstract accesses to devices.
52 @param This The EFI_SMM_CPU_IO_INTERFACE instance.
53 @param Width Signifies the width of the I/O operations.
54 @param Address The base address of the I/O operations.
55 @param Count The number of I/O operations to perform.
56 @param Buffer For read operations, the destination buffer to store the results.
57 For write operations, the source buffer from which to write data.
59 @retval EFI_SUCCESS The data was read from or written to the device.
60 @retval EFI_UNSUPPORTED The Address is not valid for this system.
61 @retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
62 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
67 (EFIAPI
*EFI_SMM_CPU_IO
)(
68 IN EFI_SMM_CPU_IO_INTERFACE
*This
,
69 IN EFI_SMM_IO_WIDTH Width
,
76 EFI_SMM_CPU_IO Read
; ///> This service provides the various modalities of memory and I/O read.
77 EFI_SMM_CPU_IO Write
; ///> This service provides the various modalities of memory and I/O write.
81 /// The EFI_SMM_CPU_IO_INTERFACE service provides the basic memory, I/O, and PCI
82 /// interfaces that are used to abstract accesses to devices.
84 struct _EFI_SMM_CPU_IO_INTERFACE
{
86 /// Allows reads and writes to memory-mapped I/O space.
88 EFI_SMM_IO_ACCESS Mem
;
90 /// Allows reads and writes to I/O space.
96 Allocates pool memory from SMRAM for IA-32 or runtime memory for
97 the Itanium processor family.
99 @param PoolType The type of pool to allocate.The only supported type is EfiRuntimeServicesData
100 @param Size The number of bytes to allocate from the pool.
101 @param Buffer A pointer to a pointer to the allocated buffer if the call
102 succeeds; undefined otherwise.
104 @retval EFI_SUCCESS The requested number of bytes was allocated.
105 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
106 @retval EFI_UNSUPPORTED In runtime.
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.
129 (EFIAPI
*EFI_SMMCORE_FREE_POOL
)(
134 Allocates memory pages from the system.
136 @param Type The type of allocation to perform.
137 @param MemoryType The only supported type is EfiRuntimeServicesData
138 @param NumberofPages The number of contiguous 4 KB pages to allocate
139 @param Memory Pointer to a physical address. On input, the way in which
140 the address is used depends on the value of Type. On output, the address
141 is set to the base of the page range that was allocated.
143 @retval EFI_SUCCESS The requested pages were allocated.
144 @retval EFI_OUT_OF_RESOURCES The pages requested could not be allocated.
145 @retval EFI_NOT_FOUND The requested pages could not be found.
146 @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress
147 or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.
152 (EFIAPI
*EFI_SMMCORE_ALLOCATE_PAGES
)(
153 IN EFI_ALLOCATE_TYPE Type
,
154 IN EFI_MEMORY_TYPE MemoryType
,
155 IN UINTN NumberOfPages
,
156 OUT EFI_PHYSICAL_ADDRESS
*Memory
160 Frees memory pages for the system.
162 @param Memory The base physical address of the pages to be freed
163 @param NumberOfPages The number of contiguous 4 KB pages to free.
165 @retval EFI_SUCCESS The requested memory pages were freed.
166 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.
167 @retval EFI_NOT_FOUND The requested memory pages were not allocated with SmmAllocatePages().
172 (EFIAPI
*EFI_SMMCORE_FREE_PAGES
)(
173 IN EFI_PHYSICAL_ADDRESS Memory
,
174 IN UINTN NumberOfPages
179 (EFIAPI
*EFI_SMM_STARTUP_THIS_AP
)(
180 IN EFI_AP_PROCEDURE Procedure
,
182 IN OUT VOID
*ProcArguments OPTIONAL
186 /// The processor save-state information for IA-32 processors. This information is important in that the
187 /// SMM drivers may need to ascertain the state of the processor before invoking the SMI.
191 /// Reserved for future processors. As such, software should not attempt to interpret or
192 /// write to this region.
194 UINT8 Reserved1
[248];
196 /// The location of the processor SMBASE, which is the location where the processor
197 /// will pass control upon receipt of an SMI.
201 /// The revision of the SMM save state. This value is set by the processor.
205 /// The value of the I/O restart field. Allows for restarting an in-process I/O instruction.
209 /// Describes behavior that should be commenced in response to a halt instruction.
211 UINT16 AutoHALTRestart
;
213 /// Reserved for future processors. As such, software should not attempt to interpret or
214 /// write to this region.
216 UINT8 Reserved2
[164];
219 // Registers in IA-32 processors.
243 } EFI_SMI_CPU_SAVE_STATE
;
246 /// The processor save-state information for the Itanium processor family. This information is
247 /// important in that the SMM drivers may need to ascertain the state of the processor before invoking
248 /// the PMI. This structure is mandatory and must be 512 byte aligned.
295 // application registers
356 UINT64 int_nat
; // nat bits for R1-R31
358 } EFI_PMI_SYSTEM_CONTEXT
;
361 /// The processor save-state information for IA-32 and Itanium processors. This information is
362 /// important in that the SMM drivers may need to ascertain the state of the processor before invoking
367 /// The processor save-state information for IA-32 processors.
369 EFI_SMI_CPU_SAVE_STATE Ia32SaveState
;
371 /// The processor save-state information for Itanium processors.
373 EFI_PMI_SYSTEM_CONTEXT ItaniumSaveState
;
374 } EFI_SMM_CPU_SAVE_STATE
;
377 /// The optional floating point save-state information for IA-32 processors. If the optional floating
378 /// point save is indicated for any handler, the following data structure must be preserved.
391 UINT8 St0Mm0
[10], Rsvd3
[6];
392 UINT8 St0Mm1
[10], Rsvd4
[6];
393 UINT8 St0Mm2
[10], Rsvd5
[6];
394 UINT8 St0Mm3
[10], Rsvd6
[6];
395 UINT8 St0Mm4
[10], Rsvd7
[6];
396 UINT8 St0Mm5
[10], Rsvd8
[6];
397 UINT8 St0Mm6
[10], Rsvd9
[6];
398 UINT8 St0Mm7
[10], Rsvd10
[6];
400 } EFI_SMI_OPTIONAL_FPSAVE_STATE
;
403 /// The optional floating point save-state information for the Itanium processor family. If the optional
404 /// floating point save is indicated for any handler, then this data structure must be preserved.
437 } EFI_PMI_OPTIONAL_FLOATING_POINT_CONTEXT
;
440 /// The processor save-state information for IA-32 and Itanium processors. If the optional floating
441 /// point save is indicated for any handler, then this data structure must be preserved.
445 /// The optional floating point save-state information for IA-32 processors.
447 EFI_SMI_OPTIONAL_FPSAVE_STATE Ia32FpSave
;
449 /// The optional floating point save-state information for Itanium processors.
451 EFI_PMI_OPTIONAL_FLOATING_POINT_CONTEXT ItaniumFpSave
;
452 } EFI_SMM_FLOATING_POINT_SAVE_STATE
;
455 This function is the main entry point for an SMM handler dispatch
456 or communicate-based callback.
458 @param SmmImageHandle A unique value returned by the SMM infrastructure
459 in response to registration for a communicate-based callback or dispatch.
460 @param CommunicationBuffer
461 An optional buffer that will be populated
462 by the SMM infrastructure in response to a non-SMM agent (preboot or runtime)
463 invoking the EFI_SMM_BASE_PROTOCOL.Communicate() service.
464 @param SourceSize If CommunicationBuffer is non-NULL, this field
465 indicates the size of the data payload in this buffer.
472 (EFIAPI
*EFI_SMM_HANDLER_ENTRY_POINT
)(
473 IN EFI_HANDLE SmmImageHandle
,
474 IN OUT VOID
*CommunicationBuffer OPTIONAL
,
475 IN OUT UINTN
*SourceSize OPTIONAL
479 The SmmInstallConfigurationTable() function is used to maintain the list
480 of configuration tables that are stored in the System Management System
481 Table. The list is stored as an array of (GUID, Pointer) pairs. The list
482 must be allocated from pool memory with PoolType set to EfiRuntimeServicesData.
484 @param SystemTable A pointer to the SMM System Table.
485 @param Guid A pointer to the GUID for the entry to add, update, or remove.
486 @param Table A pointer to the buffer of the table to add.
487 @param TableSize The size of the table to install.
489 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
490 @retval EFI_INVALID_PARAMETER Guid is not valid.
491 @retval EFI_NOT_FOUND An attempt was made to delete a non-existent entry.
492 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
497 (EFIAPI
*EFI_SMM_INSTALL_CONFIGURATION_TABLE
)(
498 IN EFI_SMM_SYSTEM_TABLE
*SystemTable
,
505 // System Management System Table (SMST)
507 struct _EFI_SMM_SYSTEM_TABLE
{
509 /// The table header for the System Management System Table (SMST).
511 EFI_TABLE_HEADER Hdr
;
514 /// A pointer to a NULL-terminated Unicode string containing the vendor name. It is
515 /// permissible for this pointer to be NULL.
517 CHAR16
*SmmFirmwareVendor
;
519 /// The particular revision of the firmware.
521 UINT32 SmmFirmwareRevision
;
524 /// Adds, updates, or removes a configuration table entry from the SMST.
526 EFI_SMM_INSTALL_CONFIGURATION_TABLE SmmInstallConfigurationTable
;
532 /// A GUID that designates the particular CPU I/O services.
534 EFI_GUID EfiSmmCpuIoGuid
;
536 /// Provides the basic memory and I/O interfaces that are used to abstract accesses to
539 EFI_SMM_CPU_IO_INTERFACE SmmIo
;
542 // Runtime memory service
545 /// Allocates pool memory from SMRAM for IA-32 or runtime memory for the
546 /// Itanium processor family.
548 EFI_SMMCORE_ALLOCATE_POOL SmmAllocatePool
;
550 /// Returns pool memory to the system.
552 EFI_SMMCORE_FREE_POOL SmmFreePool
;
554 /// Allocates memory pages from the system.
556 EFI_SMMCORE_ALLOCATE_PAGES SmmAllocatePages
;
558 /// Frees memory pages for the system.
560 EFI_SMMCORE_FREE_PAGES SmmFreePages
;
565 EFI_SMM_STARTUP_THIS_AP SmmStartupThisAp
;
568 // CPU information records
571 /// A 1-relative number between 1 and the NumberOfCpus field. This field designates
572 /// which processor is executing the SMM infrastructure. This number also serves as an
573 /// index into the CpuSaveState and CpuOptionalFloatingPointState
576 UINTN CurrentlyExecutingCpu
;
578 /// The number of EFI Configuration Tables in the buffer
579 /// SmmConfigurationTable.
583 /// A pointer to the EFI Configuration Tables. The number of entries in the table is
584 /// NumberOfTableEntries.
586 EFI_SMM_CPU_SAVE_STATE
*CpuSaveState
;
588 /// A pointer to a catenation of the EFI_SMM_FLOATING_POINT_SAVE_STATE.
589 /// The size of this entire table is NumberOfCpus* size of the
590 /// EFI_SMM_FLOATING_POINT_SAVE_STATE. These fields are populated only if
591 /// there is at least one SMM driver that has registered for a callback with the
592 /// FloatingPointSave field in EFI_SMM_BASE_PROTOCOL.RegisterCallback() set to TRUE.
594 EFI_SMM_FLOATING_POINT_SAVE_STATE
*CpuOptionalFloatingPointState
;
597 // Extensibility table
600 /// The number of EFI Configuration Tables in the buffer
601 /// SmmConfigurationTable.
603 UINTN NumberOfTableEntries
;
605 /// A pointer to the EFI Configuration Tables. The number of entries in the table is
606 /// NumberOfTableEntries.
608 EFI_CONFIGURATION_TABLE
*SmmConfigurationTable
;