blob: 903a227b2690253a5c3e44850206e08ad2034cd7 (
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/hwpf/hwp/tod_init/proc_tod_save_config/proc_tod_save_config.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 */
// $Id: proc_tod_save_config.H,v 1.1 2012/10/31 21:34:27 jklazyns Exp $
//------------------------------------------------------------------------------
// *! (C) Copyright International Business Machines Corp. 2012
// *! All Rights Reserved -- Property of IBM
// *! *** IBM Confidential ***
// *!
// *! TITLE : proc_tod_save_config.H
// *!
// *! DESCRIPTION : Header for proc_tod_save_config.C
// *!
// *! OWNER NAME : Nick Klazynski Email: jklazyns@us.ibm.com
// *! BACKUP NAME : Email:
// *!
// *! ADDITIONAL COMMENTS :
// *!
//------------------------------------------------------------------------------
#ifndef PROC_TOD_SAVE_CONFIG_H_
#define PROC_TOD_SAVE_CONFIG_H_
//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include <fapi.H>
#include "proc_tod_utils.H"
extern "C"
{
//------------------------------------------------------------------------------
// Constant definitions
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
// Structure definitions
//------------------------------------------------------------------------------
// function pointer typedef definition for HWP call support
typedef fapi::ReturnCode
(*proc_tod_save_config_FP_t) (tod_topology_node*);
//------------------------------------------------------------------------------
// Function prototypes
//------------------------------------------------------------------------------
/**
* @brief Saves TOD configuration registers to i_tod_node->o_todRegs
*
* @param[in] i_tod_node Reference to TOD topology (FAPI targets included within)
*
* @return FAPI_RC_SUCCESS if all registers were read and saved in node structure
* else FAPI or ECMD error is sent through
*/
fapi::ReturnCode proc_tod_save_config(tod_topology_node* i_tod_node);
/**
* @brief Helper function which saves a single register to output buffer
*
* @param[in] i_target FAPI target
* i_addr SCOM address to read
* @param[out] o_data Buffer to save register read
*
* @return FAPI_RC_SUCCESS if the given register was read and saved into buffer
* else FAPI or ECMD error is sent through
*/
fapi::ReturnCode proc_tod_save_single_reg(const fapi::Target& i_target,
const uint64_t i_addr,
ecmdDataBufferBase& o_data);
} // extern "C"
#endif // PROC_TOD_SAVE_CONFIG_H_
|
