summaryrefslogtreecommitdiffstats
path: root/src/usr/hwpf/hwp/dmi_training/dmi_training.H
blob: 0d60424286ea0da7e8c12638faeb7f278810e74c (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/hwpf/hwp/dmi_training/dmi_training.H $                */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2012,2014              */
/*                                                                        */
/* 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  __DMI_TRAINING_DMI_TRAINING_H
#define __DMI_TRAINING_DMI_TRAINING_H
/**
 *  @file dmi_training.H
 *
 *  All of the following routines are "named isteps" - they are invoked as
 *  tasks by the @ref IStepDispatcher.
 *
 *  HWP_IGNORE_VERSION_CHECK
 *
 */

/*  @tag isteplist
 *  @docversion     v1.18 (12/03/12)
 *  @istepname      dmi_training
 *  @istepnum       11
 *  @istepdesc      DMI Training
 *
 *  @{
 *      @substepnum     1
 *      @substepname    mss_getecid
 *      @substepdesc    : Read out ECID from all centaur chips
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum     2
 *      @substepname    proc_dmi_scominit
 *      @substepdesc    : DMI Scom setup on P8 MCS
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum     3
 *      @substepname    dmi_scominit
 *      @substepdesc    : Scom setup on centaur
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum     4
 *      @substepname    dmi_erepair
 *      @substepdesc    : Restore EDI Bus eRepair data
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum     5
 *      @substepname    dmi_io_dccal
 *      @substepdesc    : Calibrate DMI interfaces
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum     6
 *      @substepname    dmi_pre_trainadv
 *      @substepdesc    : Advanced pre DMI training
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum     7
 *      @substepname    dmi_io_run_training
 *      @substepdesc    : Run training on MC buses
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum     8
 *      @substepname    dmi_post_trainadv
 *      @substepdesc    : Advanced post DMI training
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum     9
 *      @substepname    proc_cen_framelock
 *      @substepdesc    : Initialize EDI Frame
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum     10
 *      @substepname    host_startprd_dmi
 *      @substepdesc    : Load PRD for DMI domain
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum     11
 *      @substepname    host_attnlisten_cen
 *      @substepdesc    : Start listening for attentions
 *          @target_sched   serial
 *  @}
 *  @{
 *      @substepnum    12
 *      @substepname    cen_set_inband_addr
 *      @substepdesc    : Set the Inband base addresses
 *          @target_sched   serial
 *  @}
 *
 */


/******************************************************************************/
// Includes
/******************************************************************************/
#include    <stdint.h>


namespace   DMI_TRAINING
{

/**
 * @brief   mss_getecid
 *
 *          Read out ECID of all centaur chips
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_mss_getecid( void * io_pArgs );

/**
 * @brief   dmi_attr_update
 *
 *  Stub HWP to allow FW to override attributes programmatically
 *
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */

void * call_dmi_attr_update( void * io_pArgs );

/**
 * @brief   proc_dmi_scominit
 *
 *          DMI Scom setup on P8 MCS
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_proc_dmi_scominit( void * io_pArgs );


/**
 * @brief   dmi_scominit
 *
 *          Scom setup on centaur
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_dmi_scominit( void * io_pArgs );


/**
 *  @brief   dmi_erepair
 *
 *           Restore EDI Bus eRepair data
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_dmi_erepair( void * io_pArgs );


/**
 *  @brief   dmi_io_dccal
 *
 *           Calibrate DMI interfaces
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_dmi_io_dccal( void * io_pArgs );


/**
 *  @brief   dmi_pre_trainadv
 *
 *           Advanced pre DMI training
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_dmi_pre_trainadv( void * io_pArgs );


/**
 *  @brief   dmi_io_run_training
 *
 *           Run training on MC buses
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_dmi_io_run_training( void * io_pArgs );


/**
 *  @brief   dmi_post_trainadv
 *
 *           Advanced post DMI training
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_dmi_post_trainadv( void * io_pArgs );


/**
 *  @brief  proc_cen_framelock
 *
 *          Initialize EDI Frame
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_proc_cen_framelock( void *io_pArgs );


/**
 *  @brief   host_startprd_dmi
 *
 *           Load PRD for DMI domain
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_host_startprd_dmi( void * io_pArgs );


/**
 *  @brief   host_attnlisten_cen
 *
 *           Start listening for attentions
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_host_attnlisten_cen( void * io_pArgs );


/**
 *  @brief   cen_set_inband_addr
 *
 *           Set the Inband base addresses
 *
 *  param[in,out] io_pArgs  -   (normally) a pointer to a TaskArgs struct,
 *                               or NULL.
 *  return  any error logs to istep
 *
 */
void*    call_cen_set_inband_addr( void * io_pArgs );


};   // end namespace

#endif
OpenPOWER on IntegriCloud