summaryrefslogtreecommitdiffstats
path: root/src/import/chips/p9/procedures/hwp/cache/p9_l3err_extract.H
blob: 823c3463bb71e5ca2b2a71987b8e3a6e3a54d326 (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/import/chips/p9/procedures/hwp/cache/p9_l3err_extract.H $ */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2016,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                                                     */
//------------------------------------------------------------------------------
// *|
// *! TITLE       : p3_l3err_extract.H
// *! DESCRIPTION : Parse and extract error information from L3 Scom Register (FAPI2)
// *!
// *! OWNER NAME  : Chen Qian              Email: qianqc@cn.ibm.com
// *!
// *! ADDITIONAL COMMENTS :
// *!
//------------------------------------------------------------------------------

#ifndef _P9_L3ERR_EXTRACT_H_
#define _P9_L3ERR_EXTRACT_H_

//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include <fapi2.H>

//------------------------------------------------------------------------------
// Structure definitions
//------------------------------------------------------------------------------

// enum used to denote what type of error occured or which we want to find
enum p9_l3err_extract_err_type
{
    L3ERR_CE,
    L3ERR_UE,
    L3ERR_SUE,
    L3ERR_CE_UE
};

// structure to document control/data registers for each supported trace array
struct p9_l3err_extract_err_data
{
    p9_l3err_extract_err_type ce_ue;
    uint8_t member;
    uint8_t dw;      //3-bit
    uint8_t bank;    //3-bit
    uint8_t dataout; //decimal 0-144, 8-bit
    uint16_t hashed_real_address_45_56;//12-bit
    uint16_t cache_read_address;//14-bit
};

// function pointer typedef definition for HWP call support
typedef fapi2::ReturnCode (*p9_l3err_extract_FP_t)( const fapi2::Target<fapi2::TARGET_TYPE_EX>& i_target,
        p9_l3err_extract_err_data& o_err_data,
        bool& o_err_found);

extern "C"
{

//------------------------------------------------------------------------------
// Function prototype
//------------------------------------------------------------------------------

// function: FAPI p9_l3err_extract HWP entry point
//           Parse and extract L3 error information from provided
// parameters: i_ex_chiplet => chiplet target used for callouts
//             i_err_type   => type of error that is to be extracted (CE,UE,both)
//             o_err_data   => failing location information for CE or UE
//             o_err_found  => error is found

    fapi2::ReturnCode p9_l3err_extract(const fapi2::Target<fapi2::TARGET_TYPE_EX>& i_target,
                                       p9_l3err_extract_err_data& o_err_data,
                                       bool& o_error_found);

} // extern "C"

#endif // _P9_L3ERR_EXTRACT_H_

OpenPOWER on IntegriCloud