blob: ec2f79502d655b7d81579ef8df5ed7df02b5e1ce [file] [log] [blame]
Zane Shelleyf4bd5ff2020-11-05 22:26:04 -06001#pragma once
2
Zane Shelleya0299852020-11-13 13:38:04 -06003#include <libpdbg.h>
4
Zane Shelley3a851082021-03-23 16:45:28 -05005#include <string>
Zane Shelley7ae9c8c2020-12-02 20:10:31 -06006#include <vector>
7
8// Forward reference to avoid pulling the libhei library into everything that
9// includes this header.
10namespace libhei
11{
12class Chip;
13}
Zane Shelleyf4bd5ff2020-11-05 22:26:04 -060014
15namespace util
16{
17
18namespace pdbg
19{
20
Zane Shelley35171d92020-12-03 13:31:13 -060021/** Chip target types. */
22enum TargetType_t : uint8_t
23{
Zane Shelley5d63cef2021-09-17 18:10:17 -050024 TYPE_PROC = 0x05,
25 TYPE_IOLINK = 0x47,
26 TYPE_OMI = 0x48,
27 TYPE_OCMB = 0x4b,
Zane Shelleybe619c02021-09-30 17:56:42 -050028 TYPE_IOHS = 0x51,
Zane Shelley35171d92020-12-03 13:31:13 -060029};
30
Zane Shelleya0299852020-11-13 13:38:04 -060031/** @return The target associated with the given chip. */
32pdbg_target* getTrgt(const libhei::Chip& i_chip);
33
Zane Shelley236bb732021-03-24 17:07:46 -050034/** @return The target associated with the given devtree path. */
35pdbg_target* getTrgt(const std::string& i_path);
36
Zane Shelleya0299852020-11-13 13:38:04 -060037/** @return A string representing the given target's devtree path. */
38const char* getPath(pdbg_target* i_trgt);
39
40/** @return A string representing the given chip's devtree path. */
Zane Shelleyf4bd5ff2020-11-05 22:26:04 -060041const char* getPath(const libhei::Chip& i_chip);
42
Zane Shelleya0299852020-11-13 13:38:04 -060043/** @return The absolute position of the given target. */
44uint32_t getChipPos(pdbg_target* i_trgt);
45
46/** @return The absolute position of the given chip. */
47uint32_t getChipPos(const libhei::Chip& i_chip);
48
49/** @return The target type of the given target. */
50uint8_t getTrgtType(pdbg_target* i_trgt);
51
52/** @return The target type of the given chip. */
53uint8_t getTrgtType(const libhei::Chip& i_chip);
54
Zane Shelley171a2e02020-11-13 13:56:13 -060055/**
56 * @return The pib target associated with the given proc target.
57 * @note Will assert the given target is a proc target.
58 * @note Will assert the returned pib target it not nullptr.
59 */
60pdbg_target* getPibTrgt(pdbg_target* i_procTrgt);
61
62/**
Zane Shelleyff76b6b2020-11-18 13:54:26 -060063 * @return The fsi target associated with the given proc target.
64 * @note Will assert the given target is a proc target.
65 * @note Will assert the returned fsi target it not nullptr.
66 */
67pdbg_target* getFsiTrgt(pdbg_target* i_procTrgt);
68
69/**
Zane Shelley35171d92020-12-03 13:31:13 -060070 * @brief Reads a CFAM FSI register.
71 * @param i_trgt Given target.
72 * @param i_addr Given address.
73 * @param o_val The returned value of the register.
74 * @return 0 if successful, non-0 otherwise.
75 * @note Will assert the given target is a proc target.
76 */
77int getCfam(pdbg_target* i_trgt, uint32_t i_addr, uint32_t& o_val);
78
79/**
Zane Shelley171a2e02020-11-13 13:56:13 -060080 * @brief Returns the list of all active chips in the system.
81 * @param o_chips The returned list of chips.
82 */
83void getActiveChips(std::vector<libhei::Chip>& o_chips);
84
Zane Shelley7ae9c8c2020-12-02 20:10:31 -060085/**
86 * @return True, if hardware analysis is supported on this system. False,
87 * otherwise.
88 * @note Support for hardware analysis from the BMC started with P10 systems
89 * and is not supported on any older chip generations.
90 */
91bool queryHardwareAnalysisSupported();
92
Zane Shelley3a851082021-03-23 16:45:28 -050093/**
94 * @return A string containing the FRU location code of the given chip. An empty
95 * string indicates the target was null or the attribute does not exist
96 * for this target.
97 * @note This function requires PHAL APIs that are only available in certain
98 * environments. If they do not exist the devtree path of the target is
99 * returned.
100 */
101std::string getLocationCode(pdbg_target* trgt);
102
103/**
104 * @return A string containing the physical device path (entity path) of the
105 * given chip. An empty string indicates the target was null or the
106 * attribute does not exist for this target.
107 * @note This function requires PHAL APIs that are only available in certain
108 * environments. If they do not exist the devtree path of the target is
109 * returned.
110 */
111std::string getPhysDevPath(pdbg_target* trgt);
112
Zane Shelleyf4bd5ff2020-11-05 22:26:04 -0600113} // namespace pdbg
114
115} // namespace util