blob: 326d7cf29cf08489b85b36ec5bee6ba41b821c0a (
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/hwpf/hwp/tod_init/TodTopologyManager.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2013 */
/* */
/* p1 */
/* */
/* Object Code Only (OCO) source materials */
/* Licensed Internal Code Source Materials */
/* IBM HostBoot Licensed Internal Code */
/* */
/* The source code for this program is not published or otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef TODTOPOLOGYMANAGER_H
#define TODTOPOLOGYMANAGER_H
/**
* @file TodTopologyManager.H
*
* @brief TOD Topology Manager class definition. Responsible for
* creating/modifying the primary and secondary topologies
*
* HWP_IGNORE_VERSION_CHECK
*
*/
#include <errl/errlentry.H>
#include "proc_tod_utils/proc_tod_utils.H"
namespace TOD
{
//------------------------------------------------------------------------------
//Forward declarations
//------------------------------------------------------------------------------
class TodDrawer;
class TodTopologyManager
{
public:
/**
* @brief Constructor.
*
* @par Detailed Description:
* Create a topology manager by specifying the type :
* TOD_PRIMARY/TOD_SECONDARY. Having separate managers
* for the primary/secondary topology allows exclusive
* operations on the topology and a greater degree of
* error management.
*
* @param[in] i_type
* Primary(TOD_PRIMARY) or Secondary(TOD_SECONDARY)
*/
TodTopologyManager(const proc_tod_setup_tod_sel i_type);
/**
* @brief Destructor.
*/
~TodTopologyManager();
/**
* @brief Create a TOD topology
*
* @par Detailed Description:
* The topology creation algorithm goes as follows:
* 1)Pick the MDMT.
* 2)In the master TOD drawer (the one in which MDMT lies),
* wire the procs together.
* 3)Connect the MDMT to one processor in each of the slave TOD drawers
* (the TOD drawers other than the master TOD drawer).
* 4)Wire the procs in the slave TOD drawers.
*
* @return Error log handle indicating the status of the request.
* @retval NULL if successful
* @retval !NULL if failed to create topology
*
* Error log handle points to a valid error log object whose primary
* SRC reason code (pError->getSRC()->reasonCode()) indicates the type
* of error.
*
* @note It is up to the caller to change the severity of the
* returned error based on what it decides to do with it. By default
* any returned error created by this function will be a non-reported
* tracing event error log.
*/
errlHndl_t create();
/**
* @brief Dumps the topology connections in this format to fsp-trace:
* parent---bus out---bus in---child. An example would be
* pu:k0:n0:s0:p00---XBUS1---XBUS1---pu:k0:n0:s0:p01
*
* @return N/A
*/
void dumpTopology() const;
/**
* @brief Dumps the TOD register values that the hardware procedure
* supplied us with to fsp-trace. Check proc_tod_utils.H :
* proc_tod_setup_conf_regs for the list of registers.
*
* @return N/A
*/
void dumpTodRegs() const;
private:
/**
* @brief Wires, or sets the X bus connection paths between
* processors in the input TOD drawer
*
* @param[in] i_pTodDrawer
* Pointer to a HwsvTodDrawer
*
* @return Error log handle indicating the status of the request.
* @retval NULL if successful
* @retval !NULL if failed to wire one or more procs in the TOD drawer
*
* Error log handle points to a valid error log object whose primary
* SRC reason code (pError->getSRC()->reasonCode()) indicates the type
* of error.
*
* @note It is up to the caller to change the severity of the
* returned error based on what it decides to do with it. By default
* any returned error created by this function will be a non-reported
* tracing event error log.
*/
errlHndl_t wireProcs(const TodDrawer* i_pTodDrawer);
/**
* @brief Wires, or sets the A bus connection paths between
* the MDMT and one of the processors in the input TOD
* drawer (thus designating that processor as the SDMT).
*
* @param[in] i_pTodDrawer
* Pointer to a TodDrawer
*
* @return Error log handle indicating the status of the request.
* @retval NULL if successful
* @retval !NULL if failed to connect the MDMT to any processor in the
* input TOD drawer.
*
* Error log handle points to a valid error log object whose primary
* SRC reason code (pError->getSRC()->reasonCode()) indicates the type
* of error.
*
* @note It is up to the caller to change the severity of the
* returned error based on what it decides to do with it. By default
* any returned error created by this function will be a non-reported
* tracing event error log.
*/
errlHndl_t wireTodDrawer(TodDrawer* i_pTodDrawer);
//Holds the type of the topology this manager is working on :
//primary/secondary
proc_tod_setup_tod_sel iv_topologyType;
};
} //namespace TOD
#endif //#define TODTOPOLOGYMANAGER_H
|
