-
Notifications
You must be signed in to change notification settings - Fork 97
/
p9_eq_clear_atomic_lock.H
86 lines (79 loc) · 4.13 KB
/
p9_eq_clear_atomic_lock.H
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
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/import/chips/p9/procedures/hwp/ffdc/p9_eq_clear_atomic_lock.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2017 */
/* [+] 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_eq_clear_atomic_lock.H
/// @brief FFDC procedure to pick up the atomic lock on cache chiplet
//
///
/// *HWP HW Owner : Greg Still <stillgs@us.ibm.com>
/// *HWP HW Backup Owner : Brian Vanderpool <vanderp@us.ibm.com>
/// *HWP FW Owner : Amit Tendolkar <amit.tendolkar@in.ibm.com>
/// *HWP Team : PM
/// *HWP Level : 2
/// *HWP Consumed by : SBE, HB
#ifndef __P9_EQ_CLEAR_ATOMIC_LOCK_H__
#define __P9_EQ_CLEAR_ATOMIC_LOCK_H__
//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include <fapi2.H>
#include <error_info_defs.H>
#ifndef __PPE__
/// @typedef p9_eq_clear_atomic_lock_FP_t
/// function pointer typedef definition for HWP call support
typedef fapi2::ReturnCode (*p9_eq_clear_atomic_lock_FP_t) (
const fapi2::ffdc_t&,
fapi2::ReturnCode&
);
#endif
/// typedef p9_clear_atomic_lock_FP_t
/// function pointer typdef definition for HWP call support
typedef fapi2::ReturnCode (*p9_clear_atomic_lock_FP_t) (
const fapi2::Target<fapi2::TARGET_TYPE_EQ>& );
//------------------------------------------------------------------------------
// Function prototypes
//------------------------------------------------------------------------------
extern "C"
{
#ifndef __PPE__
/// @brief HWP to pick up the atomic lock on a cache chiplet to allow the
/// collection of CME FFDC register content (SCOM or RAM)
/// @param [in] i_eq_target TARGET_TYPE_EQ
/// @param [inout] io_rc Return code - unused
/// @return FAPI2_RC_SUCCESS Always succeeds
fapi2::ReturnCode
p9_eq_clear_atomic_lock ( const fapi2::ffdc_t& i_eq_target,
fapi2::ReturnCode& io_rc );
#endif
/// @brief HWP to pick up the atomic lock on a cache chiplet to allow the
/// collection of CME FFDC register content (SCOM or RAM)
/// @param [in] i_eq EQ target on which the atomic lock should be released
/// @return FAPI2_RC_SUCCESS on success, else error code
/// @note Unlike the collectFfdc triggered callback, this is a direct HWP call
/// to support the SBE platform limitations
fapi2::ReturnCode
p9_clear_atomic_lock ( const fapi2::Target<fapi2::TARGET_TYPE_EQ>& i_eq );
} // extern C
#endif // __P9_EQ_CLEAR_ATOMIC_LOCK_H__