| Vishal Bhoj | 82c8071 | 2015-12-15 21:13:33 +0530 | [diff] [blame] | 1 | /** @file
|
| 2 | EFI SMM Configuration Protocol as defined in the PI 1.2 specification.
|
| 3 |
|
| 4 | This protocol is used to:
|
| 5 | 1) report the portions of SMRAM regions which cannot be used for the SMRAM heap.
|
| 6 | 2) register the SMM Foundation entry point with the processor code. The entry
|
| 7 | point will be invoked by the SMM processor entry code.
|
| 8 |
|
| 9 | Copyright (c) 2009, Intel Corporation. All rights reserved.<BR>
|
| 10 | This program and the accompanying materials
|
| 11 | are licensed and made available under the terms and conditions of the BSD License
|
| 12 | which accompanies this distribution. The full text of the license may be found at
|
| 13 | http://opensource.org/licenses/bsd-license.php
|
| 14 |
|
| 15 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
| 16 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
| 17 |
|
| 18 | **/
|
| 19 |
|
| 20 | #ifndef _SMM_CONFIGURATION_H_
|
| 21 | #define _SMM_CONFIGURATION_H_
|
| 22 |
|
| 23 | #include <Pi/PiSmmCis.h>
|
| 24 |
|
| 25 | #define EFI_SMM_CONFIGURATION_PROTOCOL_GUID \
|
| 26 | { \
|
| 27 | 0x26eeb3de, 0xb689, 0x492e, {0x80, 0xf0, 0xbe, 0x8b, 0xd7, 0xda, 0x4b, 0xa7 } \
|
| 28 | }
|
| 29 |
|
| 30 | ///
|
| 31 | /// Structure describing a SMRAM region which cannot be used for the SMRAM heap.
|
| 32 | ///
|
| 33 | typedef struct _EFI_SMM_RESERVED_SMRAM_REGION {
|
| 34 | ///
|
| 35 | /// Starting address of the reserved SMRAM area, as it appears while SMRAM is open.
|
| 36 | /// Ignored if SmramReservedSize is 0.
|
| 37 | ///
|
| 38 | EFI_PHYSICAL_ADDRESS SmramReservedStart;
|
| 39 | ///
|
| 40 | /// Number of bytes occupied by the reserved SMRAM area. A size of zero indicates the
|
| 41 | /// last SMRAM area.
|
| 42 | ///
|
| 43 | UINT64 SmramReservedSize;
|
| 44 | } EFI_SMM_RESERVED_SMRAM_REGION;
|
| 45 |
|
| 46 | typedef struct _EFI_SMM_CONFIGURATION_PROTOCOL EFI_SMM_CONFIGURATION_PROTOCOL;
|
| 47 |
|
| 48 | /**
|
| 49 | Register the SMM Foundation entry point.
|
| 50 |
|
| 51 | This function registers the SMM Foundation entry point with the processor code. This entry point
|
| 52 | will be invoked by the SMM Processor entry code.
|
| 53 |
|
| 54 | @param[in] This The EFI_SMM_CONFIGURATION_PROTOCOL instance.
|
| 55 | @param[in] SmmEntryPoint SMM Foundation entry point.
|
| 56 |
|
| 57 | @retval EFI_SUCCESS Success to register SMM Entry Point.
|
| 58 | @retval EFI_INVALID_PARAMETER SmmEntryPoint is NULL.
|
| 59 | **/
|
| 60 | typedef
|
| 61 | EFI_STATUS
|
| 62 | (EFIAPI *EFI_SMM_REGISTER_SMM_ENTRY)(
|
| 63 | IN CONST EFI_SMM_CONFIGURATION_PROTOCOL *This,
|
| 64 | IN EFI_SMM_ENTRY_POINT SmmEntryPoint
|
| 65 | );
|
| 66 |
|
| 67 | ///
|
| 68 | /// The EFI SMM Configuration Protocol is a mandatory protocol published by a DXE CPU driver to
|
| 69 | /// indicate which areas within SMRAM are reserved for use by the CPU for any purpose,
|
| 70 | /// such as stack, save state or SMM entry point.
|
| 71 | ///
|
| 72 | /// The RegisterSmmEntry() function allows the SMM IPL DXE driver to register the SMM
|
| 73 | /// Foundation entry point with the SMM entry vector code.
|
| 74 | ///
|
| 75 | struct _EFI_SMM_CONFIGURATION_PROTOCOL {
|
| 76 | ///
|
| 77 | /// A pointer to an array SMRAM ranges used by the initial SMM entry code.
|
| 78 | ///
|
| 79 | EFI_SMM_RESERVED_SMRAM_REGION *SmramReservedRegions;
|
| 80 | EFI_SMM_REGISTER_SMM_ENTRY RegisterSmmEntry;
|
| 81 | };
|
| 82 |
|
| 83 | extern EFI_GUID gEfiSmmConfigurationProtocolGuid;
|
| 84 |
|
| 85 | #endif
|
| 86 |
|