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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/hwpf/hwp/occ/occ_procedures/p8_ocb_indir_access.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: p8_ocb_indir_access.H,v 1.1 2012/08/23 04:58:50 stillgs Exp $
// $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/chips/p8/working/procedures/ipl/fapi/p8_ocb_indir_access.H,v $
//------------------------------------------------------------------------------
// *|
// *! (C) Copyright International Business Machines Corp. 2011
// *! All Rights Reserved -- Property of IBM
// *! *** IBM Confidential ***
// *|
// *! TITLE : p8_ocb_indir_access.H
// *! DESCRIPTION : Access procedure to the OCC OCB indirect channels
// *!
// *! OWNER NAME : Jim Yacynych Email: jimyac@us.ibm.com
// *! BACKUP NAME : Greg Still Email: stillgs@us.ibm.com
//------------------------------------------------------------------------------
#ifndef _P8_OCBINDIRACC_H_
#define _P8_OCBINDIRACC_H_
extern "C" {
//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
// function pointer typedef definition for HWP call support
typedef fapi::ReturnCode (*p8_ocb_indir_access_FP_t)
( const fapi::Target&,
uint32_t,
uint32_t,
uint32_t,
ecmdDataBufferBase&,
uint32_t&,
bool,
uint32_t
);
//------------------------------------------------------------------------------
// Constant definitions
//------------------------------------------------------------------------------
#ifndef _P8_OCB_ACCESS_OP_
#define _P8_OCB_ACCESS_OP_
enum P8_OCB_ACCESS_OP {
OCB_GET = 0x1,
OCB_PUT = 0x2
};
#endif // _P8_OCB_ACCESS_OP_
//------------------------------------------------------------------------------
// Parameter structure definitions
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
// Function prototype
//------------------------------------------------------------------------------
/// \brief Provides for the abstract access to an OCB indirect channel that has
/// been configured previously via p8_ocb_indir_setup_[linear/circular]
/// procedures
///
/// \param[in] &i_target Chip target
/// \param[in] i_ocb_chan OCB channel number (0, 1, 2, 3)
/// \param[in] i_ocb_op Operation (Get, Put)
/// \param[in] i_ocb_req_length Requested length in the number of 8B
/// elements to be accessed (unit origin)
/// Number of bytes = (i_ocb_req_length) *
/// 8B
/// \param[in/out] &io_ocb_buffer Reference to ecmdDataBuffer
/// \param[out] &o_ocb_act_length Address containing to contain the actual
/// length in the number of 8B elements to
/// be accessed (zero origin)
/// Number of bytes = (i_ocb_act_length+1) *
/// 8B
/// \param[in] i_oci_address_valid Indicator that oci_address is to be used
/// \param[in] i_oci_address OCI Address to be used for the operation
/// \retval ECMD_SUCCESS if something good happens,
/// \retval BAD_RETURN_CODE otherwise
fapi::ReturnCode
p8_ocb_indir_access(const fapi::Target& i_target,
uint32_t i_ocb_chan,
uint32_t i_ocb_op,
uint32_t i_ocb_req_length,
ecmdDataBufferBase& io_ocb_buffer,
uint32_t& o_ocb_act_length,
bool i_oci_address_valid,
uint32_t i_oci_address);
} // extern "C"
#endif // _P8_OCBINDIRACC_H_
|
