Subrata Banik | 20fe24b | 2021-12-09 02:46:38 +0530 | [diff] [blame] | 1 | /** @file |
| 2 | Provides a service to publish discovered system resources. |
| 3 | |
| 4 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> |
| 5 | SPDX-License-Identifier: BSD-2-Clause-Patent |
| 6 | |
| 7 | **/ |
| 8 | |
| 9 | #ifndef __RESOURCE_PUBLICATION_LIB__ |
| 10 | #define __RESOURCE_PUBLICATION_LIB__ |
| 11 | |
| 12 | /** |
| 13 | Declares the presence of permanent system memory in the platform. |
| 14 | |
| 15 | Declares that the system memory buffer specified by MemoryBegin and MemoryLength |
| 16 | as permanent memory that may be used for general purpose use by software. |
| 17 | The amount of memory available to software may be less than MemoryLength |
| 18 | if published memory has alignment restrictions. |
| 19 | If MemoryLength is 0, then ASSERT(). |
| 20 | If MemoryLength is greater than (MAX_ADDRESS - MemoryBegin + 1), then ASSERT(). |
| 21 | |
| 22 | @param MemoryBegin The start address of the memory being declared. |
| 23 | @param MemoryLength The number of bytes of memory being declared. |
| 24 | |
| 25 | @retval RETURN_SUCCESS The memory buffer was published. |
| 26 | @retval RETURN_OUT_OF_RESOURCES There are not enough resources to publish the memory buffer |
| 27 | |
| 28 | **/ |
| 29 | RETURN_STATUS |
| 30 | EFIAPI |
| 31 | PublishSystemMemory ( |
| 32 | IN PHYSICAL_ADDRESS MemoryBegin, |
| 33 | IN UINT64 MemoryLength |
| 34 | ); |
| 35 | |
| 36 | #endif |