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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/import/chips/p9/common/scominfo/p9_scominfo.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2015,2016 */
/* [+] 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 */
///
/// @file p9_scominfo.H
/// @brief P9 chip unit SCOM address platform translation code
///
/// HWP HWP Owner: jmcgill@us.ibm.com
/// HWP FW Owner: dcrowell@us.ibm.com
/// HWP Team: Infrastructure
/// HWP Level: 1
/// HWP Consumed by: FSP/HB
///
#ifndef P9_SCOMINFO_H
#define P9_SCOMINFO_H
// includes
#include <stdint.h>
#include <vector>
#include "p9_cu.H"
extern "C"
{
static const uint32_t PPE_MODE = 1;
typedef enum
{
STANDARD_MODE = 0
} p9TranslationMode_t;
typedef enum
{
FAILED_TRANSLATION = 0xFFFFFFFFFFFFFFF1ull
} p9TranslationResult_t;
/// @brief Creates the actual SCOM address based on the chip unit type, instance, and the input SCOM address (relative to chip unit instance 0)
/// @param[in] i_p9CU Enumeration of the chip unit type
/// @param[in] i_chipUnitNum Instance number of the chip unit
/// @param[in] i_scomAddr The input SCOM address associated with the chip unit type
/// @param[in] i_mode Used for special purposes, default to 0
/// @retval uint64_t Actual SCOM address for the chip unit instance passed in
uint64_t p9_scominfo_createChipUnitScomAddr(const p9ChipUnits_t i_p9CU, const uint8_t i_chipUnitNum,
const uint64_t i_scomAddr, const uint32_t i_mode = 0);
/// @brief Determine if the provided SCOM address correlates to any chip units (if so creates a list of chipUnitPairing structures which correspond)
/// @param[in] i_scomAddr SCOM address to be tested
/// @param[out] o_chipUnitRelated Returns true if SCOM address is associated with any chip units
/// @param[out] o_chipUnitPairing Collection of chipUnitPairing enums
/// @param[in] i_mode Used for special purposes, default to 0
/// @retval uint32_t Return non-zero for error
uint32_t p9_scominfo_isChipUnitScom(const uint64_t i_scomAddr, bool& o_chipUnitRelated,
std::vector<p9_chipUnitPairing_t>& o_chipUnitPairing, const uint32_t i_mode = 0);
/// @brief Alter the unit/unitnum of a target for spys where the clocks-on vs clocks-off targets are different.
/// @param[in] i_p9CU target used for the spy request
/// @param[in] i_targetChipUnitNum the instance number of the target used for the spy request
/// @param[in] i_scomaddr the scom from the clocks-on portion of the spy
/// @param[out] o_modifiedScomAddr the translated scom address (none may be needed)
/// @param[out] o_p9CU the translated target type
/// @param[out] o_modifiedChipUnitNum the translated target instance number
/// @param[in] i_mode Could be used in the future to indicate if the translation is from clocks-on or clocks-off state
/// @retval uint32_t Return non-zero for error
uint32_t p9_scominfo_fixChipUnitScomAddrOrTarget(const p9ChipUnits_t i_p9CU, const uint32_t i_targetChipUnitNum,
const uint64_t i_scomaddr, uint64_t& o_modifiedScomAddr, p9ChipUnits_t& o_p9CU,
uint32_t& o_modifiedChipUnitNum, const uint32_t i_mode = 0);
} // extern "C"
#endif /* P9_SCOMINFO_H */
|
