/** @file\r
- Include file matches things in the Smm CIS spec.\r
+ Include file for definitions in the Intel Platform Innovation Framework for EFI\r
+ System Management Mode Core Interface Specification (SMM CIS) version 0.90.\r
\r
- Copyright (c) 2007, Intel Corporation\r
+ Copyright (c) 2007 - 2009, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
- Module Name: FrameworkSmmCis.h\r
-\r
- @par Revision Reference:\r
- Version 0.9.\r
-\r
**/\r
\r
#ifndef _FRAMEWORK_SMM_CIS_H_\r
#define _FRAMEWORK_SMM_CIS_H_\r
\r
-#include <Framework/DxeCis.h>\r
-\r
#define EFI_SMM_CPU_IO_GUID \\r
{ \\r
0x5f439a0b, 0x45d8, 0x4682, {0xa4, 0xf4, 0xf0, 0x57, 0x6b, 0x51, 0x34, 0x41 } \\r
//\r
// SMM Base specification constant and types\r
//\r
-#define SMM_SMST_SIGNATURE EFI_SIGNATURE_32 ('S', 'M', 'S', 'T')\r
+#define SMM_SMST_SIGNATURE SIGNATURE_32 ('S', 'M', 'S', 'T')\r
#define EFI_SMM_SYSTEM_TABLE_REVISION (0 << 16) | (0x09)\r
\r
//\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_CPU_IO) (\r
+(EFIAPI *EFI_SMM_CPU_IO)(\r
IN EFI_SMM_CPU_IO_INTERFACE *This,\r
IN EFI_SMM_IO_WIDTH Width,\r
IN UINT64 Address,\r
);\r
\r
typedef struct {\r
- EFI_SMM_CPU_IO Read;\r
- EFI_SMM_CPU_IO Write;\r
+ EFI_SMM_CPU_IO Read; ///< This service provides the various modalities of memory and I/O read.\r
+ EFI_SMM_CPU_IO Write; ///< This service provides the various modalities of memory and I/O write.\r
} EFI_SMM_IO_ACCESS;\r
\r
+///\r
+/// The EFI_SMM_CPU_IO_INTERFACE service provides the basic memory, I/O, and PCI\r
+/// interfaces that are used to abstract accesses to devices.\r
+///\r
struct _EFI_SMM_CPU_IO_INTERFACE {\r
+ ///\r
+ /// Allows reads and writes to memory-mapped I/O space. \r
+ ///\r
EFI_SMM_IO_ACCESS Mem;\r
+ ///\r
+ /// Allows reads and writes to I/O space. \r
+ ///\r
EFI_SMM_IO_ACCESS Io;\r
};\r
\r
@retval EFI_SUCCESS The requested number of bytes was allocated.\r
@retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.\r
@retval EFI_UNSUPPORTED In runtime.\r
-\r
+ @note: Inconsistent with specification here:\r
+ In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_POOL. However, \r
+ To avoid the naming conflict, the definition is renamed.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMMCORE_ALLOCATE_POOL) (\r
+(EFIAPI *EFI_SMMCORE_ALLOCATE_POOL)(\r
IN EFI_MEMORY_TYPE PoolType,\r
IN UINTN Size,\r
OUT VOID **Buffer\r
@retval EFI_SUCCESS The memory was returned to the system.\r
@retval EFI_INVALID_PARAMETER Buffer was invalid.\r
@retval EFI_UNSUPPORTED In runtime.\r
-\r
+ @note: Inconsistent with specification here:\r
+ In Framework Spec, This definition is naming EFI_SMM_FREE_POOL However, \r
+ To avoid the naming conflict, the definition is renamed.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMMCORE_FREE_POOL) (\r
+(EFIAPI *EFI_SMMCORE_FREE_POOL)(\r
IN VOID *Buffer\r
);\r
\r
@retval EFI_NOT_FOUND The requested pages could not be found.\r
@retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress\r
or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.\r
-\r
+ @note: Inconsistent with specification here:\r
+ In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_PAGES However, \r
+ To avoid the naming conflict, the definition is renamed.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMMCORE_ALLOCATE_PAGES) (\r
+(EFIAPI *EFI_SMMCORE_ALLOCATE_PAGES)(\r
IN EFI_ALLOCATE_TYPE Type,\r
IN EFI_MEMORY_TYPE MemoryType,\r
IN UINTN NumberOfPages,\r
@retval EFI_SUCCESS The requested memory pages were freed.\r
@retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.\r
@retval EFI_NOT_FOUND The requested memory pages were not allocated with SmmAllocatePages().\r
-\r
+ \r
+ @note: Inconsistent with specification here:\r
+ In Framework Spec, This definition is naming EFI_SMM_FREE_PAGES However, \r
+ To avoid the naming conflict, the definition is renamed.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMMCORE_FREE_PAGES) (\r
+(EFIAPI *EFI_SMMCORE_FREE_PAGES)(\r
IN EFI_PHYSICAL_ADDRESS Memory,\r
IN UINTN NumberOfPages\r
);\r
\r
+/**\r
+ Frees memory pages for the system.\r
+\r
+ @param Procedure A pointer to the code stream to be run on the designated AP of the system.\r
+ @param CpuNumber The zero-based index of the processor number of the AP on which the code stream is\r
+ supposed to run. If the processor number points to the current processor or a disabled\r
+ processor, then it will not run the supplied code.\r
+ @param ProcArguments Allows the caller to pass a list of parameters to the code that is run by\r
+ the AP. It is an optional common mailbox between APs and the BSP to share information.\r
+\r
+ @retval EFI_SUCCESS The call was successful and the return parameters are valid.\r
+ @retval EFI_INVALID_PARAMETER The input arguments are out of range.\r
+ @retval EFI_INVALID_PARAMETER The CPU requested is not available on this SMI invocation.\r
+ @retval EFI_INVALID_PARAMETER The CPU cannot support an additional service invocation.\r
+ \r
+ @note: Inconsistent with specification here:\r
+ In Framework Spec, No this definition. This method is introduced in PI1.0 spec for \r
+ implementation needed.\r
+ \r
+**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_STARTUP_THIS_AP) (\r
- IN EFI_AP_PROCEDURE Procedure,\r
+(EFIAPI *EFI_SMM_STARTUP_THIS_AP)(\r
+ IN FRAMEWORK_EFI_AP_PROCEDURE Procedure,\r
IN UINTN CpuNumber,\r
IN OUT VOID *ProcArguments OPTIONAL\r
);\r
\r
+///\r
+/// The processor save-state information for IA-32 processors. This information is important in that the\r
+/// SMM drivers may need to ascertain the state of the processor before invoking the SMI.\r
+///\r
typedef struct {\r
+ ///\r
+ /// Reserved for future processors. As such, software should not attempt to interpret or\r
+ /// write to this region.\r
+ ///\r
UINT8 Reserved1[248];\r
+ ///\r
+ /// The location of the processor SMBASE, which is the location where the processor\r
+ /// will pass control upon receipt of an SMI.\r
+ ///\r
UINT32 SMBASE;\r
+ ///\r
+ /// The revision of the SMM save state. This value is set by the processor.\r
+ ///\r
UINT32 SMMRevId;\r
+ ///\r
+ /// The value of the I/O restart field. Allows for restarting an in-process I/O instruction.\r
+ ///\r
UINT16 IORestart;\r
+ ///\r
+ /// Describes behavior that should be commenced in response to a halt instruction.\r
+ ///\r
UINT16 AutoHALTRestart;\r
+ ///\r
+ /// Reserved for future processors. As such, software should not attempt to interpret or\r
+ /// write to this region.\r
+ ///\r
UINT8 Reserved2[164];\r
+\r
+ //\r
+ // Registers in IA-32 processors. \r
+ //\r
UINT32 ES;\r
UINT32 CS;\r
UINT32 SS;\r
UINT32 CR0;\r
} EFI_SMI_CPU_SAVE_STATE;\r
\r
+///\r
+/// The processor save-state information for the Itanium processor family. This information is\r
+/// important in that the SMM drivers may need to ascertain the state of the processor before invoking\r
+/// the PMI. This structure is mandatory and must be 512 byte aligned.\r
+/// \r
typedef struct {\r
UINT64 reserved;\r
UINT64 r1;\r
\r
} EFI_PMI_SYSTEM_CONTEXT;\r
\r
+///\r
+/// The processor save-state information for IA-32 and Itanium processors. This information is\r
+/// important in that the SMM drivers may need to ascertain the state of the processor before invoking\r
+/// the SMI or PMI.\r
+///\r
typedef union {\r
+ ///\r
+ /// The processor save-state information for IA-32 processors. \r
+ ///\r
EFI_SMI_CPU_SAVE_STATE Ia32SaveState;\r
+ ///\r
+ /// The processor save-state information for Itanium processors.\r
+ ///\r
EFI_PMI_SYSTEM_CONTEXT ItaniumSaveState;\r
} EFI_SMM_CPU_SAVE_STATE;\r
\r
+///\r
+/// The optional floating point save-state information for IA-32 processors. If the optional floating\r
+/// point save is indicated for any handler, the following data structure must be preserved.\r
+///\r
typedef struct {\r
UINT16 Fcw;\r
UINT16 Fsw;\r
UINT8 Rsvd11[22*16];\r
} EFI_SMI_OPTIONAL_FPSAVE_STATE;\r
\r
+///\r
+/// The optional floating point save-state information for the Itanium processor family. If the optional\r
+/// floating point save is indicated for any handler, then this data structure must be preserved. \r
+/// \r
typedef struct {\r
UINT64 f2[2];\r
UINT64 f3[2];\r
UINT64 f31[2];\r
} EFI_PMI_OPTIONAL_FLOATING_POINT_CONTEXT;\r
\r
+///\r
+/// The processor save-state information for IA-32 and Itanium processors. If the optional floating\r
+/// point save is indicated for any handler, then this data structure must be preserved.\r
+///\r
typedef union {\r
+ /// \r
+ /// The optional floating point save-state information for IA-32 processors. \r
+ ///\r
EFI_SMI_OPTIONAL_FPSAVE_STATE Ia32FpSave;\r
+ ///\r
+ /// The optional floating point save-state information for Itanium processors. \r
+ ///\r
EFI_PMI_OPTIONAL_FLOATING_POINT_CONTEXT ItaniumFpSave;\r
} EFI_SMM_FLOATING_POINT_SAVE_STATE;\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_HANDLER_ENTRY_POINT) (\r
+(EFIAPI *EFI_SMM_HANDLER_ENTRY_POINT)(\r
IN EFI_HANDLE SmmImageHandle,\r
IN OUT VOID *CommunicationBuffer OPTIONAL,\r
IN OUT UINTN *SourceSize OPTIONAL\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_INSTALL_CONFIGURATION_TABLE) (\r
+(EFIAPI *EFI_SMM_INSTALL_CONFIGURATION_TABLE)(\r
IN EFI_SMM_SYSTEM_TABLE *SystemTable,\r
IN EFI_GUID *Guid,\r
IN VOID *Table,\r
// System Management System Table (SMST)\r
//\r
struct _EFI_SMM_SYSTEM_TABLE {\r
+ ///\r
+ /// The table header for the System Management System Table (SMST). \r
+ ///\r
EFI_TABLE_HEADER Hdr;\r
\r
+ ///\r
+ /// A pointer to a NULL-terminated Unicode string containing the vendor name. It is\r
+ /// permissible for this pointer to be NULL.\r
+ ///\r
CHAR16 *SmmFirmwareVendor;\r
+ ///\r
+ /// The particular revision of the firmware.\r
+ ///\r
UINT32 SmmFirmwareRevision;\r
\r
+ ///\r
+ /// Adds, updates, or removes a configuration table entry from the SMST. \r
+ ///\r
EFI_SMM_INSTALL_CONFIGURATION_TABLE SmmInstallConfigurationTable;\r
\r
//\r
// I/O Services\r
//\r
+ ///\r
+ /// A GUID that designates the particular CPU I/O services. \r
+ ///\r
EFI_GUID EfiSmmCpuIoGuid;\r
+ ///\r
+ /// Provides the basic memory and I/O interfaces that are used to abstract accesses to\r
+ /// devices.\r
+ ///\r
EFI_SMM_CPU_IO_INTERFACE SmmIo;\r
\r
//\r
// Runtime memory service\r
//\r
+ ///\r
+ ///\r
+ /// Allocates pool memory from SMRAM for IA-32 or runtime memory for the\r
+ /// Itanium processor family.\r
+ ///\r
EFI_SMMCORE_ALLOCATE_POOL SmmAllocatePool;\r
+ ///\r
+ /// Returns pool memory to the system. \r
+ ///\r
EFI_SMMCORE_FREE_POOL SmmFreePool;\r
+ ///\r
+ /// Allocates memory pages from the system. \r
+ ///\r
EFI_SMMCORE_ALLOCATE_PAGES SmmAllocatePages;\r
+ ///\r
+ /// Frees memory pages for the system.\r
+ ///\r
EFI_SMMCORE_FREE_PAGES SmmFreePages;\r
\r
//\r
// MP service\r
//\r
+ \r
+ ///Inconsistent with specification here:\r
+ /// In Framework Spec, No this definition. This method is introduced in PI1.0 spec for \r
+ /// implementation needed.\r
EFI_SMM_STARTUP_THIS_AP SmmStartupThisAp;\r
\r
//\r
// CPU information records\r
//\r
+ ///\r
+ /// A 1-relative number between 1 and the NumberOfCpus field. This field designates\r
+ /// which processor is executing the SMM infrastructure. This number also serves as an\r
+ /// index into the CpuSaveState and CpuOptionalFloatingPointState\r
+ /// fields.\r
+ ///\r
UINTN CurrentlyExecutingCpu;\r
+ ///\r
+ /// The number of EFI Configuration Tables in the buffer\r
+ /// SmmConfigurationTable.\r
+ ///\r
UINTN NumberOfCpus;\r
+ ///\r
+ /// A pointer to the EFI Configuration Tables. The number of entries in the table is\r
+ /// NumberOfTableEntries.\r
+ ///\r
EFI_SMM_CPU_SAVE_STATE *CpuSaveState;\r
+ ///\r
+ /// A pointer to a catenation of the EFI_SMM_FLOATING_POINT_SAVE_STATE.\r
+ /// The size of this entire table is NumberOfCpus* size of the\r
+ /// EFI_SMM_FLOATING_POINT_SAVE_STATE. These fields are populated only if\r
+ /// there is at least one SMM driver that has registered for a callback with the\r
+ /// FloatingPointSave field in EFI_SMM_BASE_PROTOCOL.RegisterCallback() set to TRUE.\r
+ ///\r
EFI_SMM_FLOATING_POINT_SAVE_STATE *CpuOptionalFloatingPointState;\r
\r
//\r
// Extensibility table\r
//\r
+ ///\r
+ /// The number of EFI Configuration Tables in the buffer\r
+ /// SmmConfigurationTable.\r
+ ///\r
UINTN NumberOfTableEntries;\r
+ ///\r
+ /// A pointer to the EFI Configuration Tables. The number of entries in the table is\r
+ /// NumberOfTableEntries.\r
+ ///\r
EFI_CONFIGURATION_TABLE *SmmConfigurationTable;\r
};\r
\r
projects / mirror_edk2.git / blobdiff