blob: 88fc7594351800b69bca48da579ed8eb572289ba (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/isteps/mem_utils.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2018 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef __MEM_UTILS_H
#define __MEM_UTILS_H
#include <errl/errlentry.H>
namespace ISTEP
{
/**
* @brief Utility function to obtain the highest known address in the system
*
* @return The highest address in the system in bytes
*/
uint64_t get_top_mem_addr();
/**
* @brief Utility function to obtain the highest known address in a given proc
*
* @param[in] i_proc: Proc that we want to calculate the top address for;
* must not be nullptr or the func will assert
* must be of TYPE_PROC or the func will assert
*
* @return The highest address in the given proc (in bytes)
*/
uint64_t get_top_mem_addr(const TARGETING::Target* i_proc);
/**
* @brief Utility function to obtain the lowest known address in the system
*
* @return the lowest known address in the system
*/
uint64_t get_bottom_mem_addr();
/**
* @brief Utility function to obtain the lowest known address in a given proc
*
* @param[in] i_proc: Proc that we want to calculate the bottom address for;
* must not be nullptr or the func will assert
* must be of TYPE_PROC or the func will assert
*
* @return the lowest known address on the specified proc
*/
uint64_t get_bottom_mem_addr(const TARGETING::Target* i_proc);
/**
* @brief Utility function to obtain the highest known SMF base address on
* the system.
*
* @return: the address (in bytes) of the top SMF memory
*
*/
uint64_t get_top_smf_mem_addr();
/**
* @brief Utility function to obtain the SMF base address on the given proc
*
* @param[in] i_proc: Proc to fetch the SMF BAR from;
* must not be nullptr or the func will assert
* must be of TYPE_PROC or the func will assert
*
*
* @return The SMF BAR of the given proc (in bytes)
*/
uint64_t get_top_smf_mem_addr(const TARGETING::Target* i_proc);
/**
* @brief Utility function to fetch the top of the HOMER memory
*
* @return the address of the HOMER mem
*
* @note When SMF is enabled, the highest available SMF BAR will be returned;
* when SMF is disabled, the function behaves exactly like
* get_top_mem_addr
*/
uint64_t get_top_homer_mem_addr();
} //namespace ISTEP
#endif
|
