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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/import/chips/p9/procedures/hwp/nest/p9_pba_setup.H $ */
/* */
/* OpenPOWER sbe 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_pba_setup.H
/// @brief Setup the PBA to do reads/writes
///
// *HWP HWP Owner: Christina Graves clgraves@us.ibm.com
// *HWP FW Owner: Thi Tran thi@us.ibm.com
// *HWP Team: Nest
// *HWP Level: 2
// *HWP Consumed by: SBE
// ----------------------------------------------------------------------------------
// *!
// *! ADDITIONAL COMMENTS:
// *!
// *! The purpose of this procedure is to setup the PBA to do reads/writes
// *! and to return the number of granules (number of 128B reads/writes) that
// *! can be done before setup needs to be called again
// *!
// *! Successful operation assumes that:
// *!
// *! High-level procedure flow:
// *!
// *!
// *!---------------------------------------------------------------------------------
#ifndef _P9_PBA_SETUP_H_
#define _P9_PBA_SETUP_H_
//-----------------------------------------------------------------------------------
// Includes
//-----------------------------------------------------------------------------------
#include <fapi2.H>
#include <p9_pba_constants.H>
//-----------------------------------------------------------------------------------
// Structure definitions
//-----------------------------------------------------------------------------------
typedef fapi2::ReturnCode
(*p9_pba_setup_FP_t) (const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&,
const fapi2::Target<fapi2::TARGET_TYPE_EX>&,
const uint64_t,
const bool,
const uint32_t,
uint32_t&);
// Constant definitions
//-----------------------------------------------------------------------------------
extern "C" {
//-----------------------------------------------------------------------------------
// Function prototype
//-----------------------------------------------------------------------------------
/// @brief setup for reads/writes from the PBA
/// @param[in] i_target => P9 chip target
/// @param[in] i_ex_target => P9 EX Target for use with lco_m operations
/// @param[in] i_address => base real address for read/write operation (expected to be 128B aligned)
/// @param[in] i_rnw => if the operation is read not write (1 for read, 0 for write)
/// @param[in] i_flags => other information that is needed - see the p9_pba_constants pba_flags enums for bit definitions
/// Note: to construct the flag you can use the p9_PBA_oper_flag class
/// @param[out] o_numGranules => number of 128B granules that can be read/written before setup needs to be called again
//
/// @return FAPI_RC_SUCCESS if the setup completes successfully,
//
fapi2::ReturnCode p9_pba_setup(
const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
const fapi2::Target<fapi2::TARGET_TYPE_EX>& i_ex_target,
const uint64_t i_address,
const bool i_rnw,
const uint32_t i_flags,
uint32_t& o_numGranules);
} //extern "C"
#endif //_P9_PBA_SETUP_H_
|
