blob: 7beba7cfe89f9bcb0eea8a0a276842a68a1573f8 (
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/hwpf/hwp/tod_init/TodHwpIntf.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2013,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 TODHWPINTF_H
#define TODHWPINTF_H
/**
* @file TodHwpIntf.H
*
* @brief TOD Hardware Procedure interfaces
*
* HWP_IGNORE_VERSION_CHECK
*
*/
#include <errl/errlentry.H>
#include "proc_tod_utils.H"
namespace TOD
{
/**
* @brief Invokes the TOD setup hardware procedure
*
* @par Detailed Description:
* We pass in the TOD topology to the HWP. The HWP traverses the
* the topology and writes various TOD registers with TOD specific
* information. It also computes TOD delays and writes appropriate regs.
*
* @param[in] i_topologyType
* Topology type : primary/secondary
*
* @return Error log handle indicating the status of the request
* @retval NULL HWP executed succesfully
* @retval !NULL HWP failure
*
* 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 todSetupHwp(const proc_tod_setup_tod_sel i_topologyType);
/**
* @brief Invokes the TOD registry read HWP.
*
* @par Detailed Description:
* We pass in the TOD topology to the HWP. The HWP traverses the
* topology and fills up, for each TOD proc datastructure, an output
* field which corresponds to the TOD registers for that proc. The HWP
* gets the register content by scomming the register.
* Check proc_tod_utils.H : proc_tod_setup_conf_regs for the list of regs.
*
* @param[in] i_topologyType
* Topology type : primary/secondary
*
* @return Error log handle indicating the status of the request
* @retval NULL HWP executed succesfully
* @retval !NULL HWP failure
*
* 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 todSaveRegsHwp(const proc_tod_setup_tod_sel i_topologyType);
/**
* @brief Invokes the TOD init HWP.
*
* @param[in] i_topologyType
* Topology type : primary/secondary
*
* @return Error log handle indicating the status of the request
* @retval NULL HWP executed succesfully
* @retval !NULL HWP failure
*
* 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 todInitHwp(const proc_tod_setup_tod_sel i_topologyType);
} //namespace TOD
#endif //TODHWPINTF_H
|
