summaryrefslogtreecommitdiffstats
path: root/src/usr/hwpf/hwp/dmi_training/mss_getecid/mss_get_cen_ecid.H
blob: 481ea8d24f6ef0a382156369348eed45745dabd0 (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
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/hwpf/hwp/dmi_training/mss_getecid/mss_get_cen_ecid.H $ */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2012,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: mss_get_cen_ecid.H,v 1.12 2014/03/25 21:09:09 uid157495 Exp $
//------------------------------------------------------------------------------
// *|
// *! (C) Copyright International Business Machines Corp. 2012
// *! All Rights Reserved -- Property of IBM
// *! *** IBM Confidential ***
// *|
// *! TITLE       : mss_get_cen_ecid.H
// *! DESCRIPTION : Get ECID string from target using SCOM's
// *!
// *! OWNER NAME  : Mark Bellows Email: bellows@us.ibm.com
// *! Copied From : Joe McGill's proc_cleanup code 
// *!
// *! ADDITIONAL COMMENTS:
// *!
// *!
//------------------------------------------------------------------------------
// CHANGE HISTORY:
//------------------------------------------------------------------------------
// Version:|  Author: |  Date:  | Comment:
//---------|----------|---------|-----------------------------------------------
//   1.11  | sglancy  |25-MAR-14| Minor Review Comments addressed
//   1.10  | bellows  |02-OCT-13| Minor Review Comments addressed
//   1.9   | bellows  |17-SEP-13| Allow for external wrapper parsing
//   1.8   | bellows  |26-MAR-13| Reviewer found updates
//   1.7   | bellows  |22-MAR-13| Changed commented name of ECID Attribute per Firmware request
//   1.6   | bellows  |21-JAN-13| added in sub revision reader
//   1.5   | bellows  |15-JAN-13| moved Cache Enable Information to the caller
// 1.1-1.4 | various  |07-DEC-12| Original Program

#ifndef _MSS_GET_CEN_ECID_H_
#define _MSS_GET_CEN_ECID_H_


//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------

#include <fapi.H>
#include <cen_scom_addresses.H>

//defines enumerators
enum mss_get_cen_ecid_ddr_status
{
  MSS_GET_CEN_ECID_DDR_STATUS_ALL_GOOD = 0,
  MSS_GET_CEN_ECID_DDR_STATUS_MBA1_BAD = 1,
  MSS_GET_CEN_ECID_DDR_STATUS_MBA0_BAD = 2,
  MSS_GET_CEN_ECID_DDR_STATUS_ALL_BAD = 3,
};

//------------------------------------------------------------------------------
// Structure definitions
//------------------------------------------------------------------------------
class  ecid_user_struct {
public:
  uint8_t  valid;
  uint8_t  i_checkL4CacheEnableUnknown;
  uint8_t  i_ecidContainsPortLogicBadIndication;
  uint8_t  i_user_defined;
  uint8_t  io_ec;
  uint64_t io_ecid[2];
  uint8_t  o_psro;
  uint8_t  o_bluewaterfall_broken;
  uint8_t  o_nwell_misplacement;

  ecid_user_struct();
};

inline   ecid_user_struct::ecid_user_struct() { valid=0; i_checkL4CacheEnableUnknown=0; i_ecidContainsPortLogicBadIndication=0; i_user_defined=0; io_ec=0; io_ecid[0]=0; io_ecid[1]=0;  }


// function pointer typedef definition for HWP call support
typedef fapi::ReturnCode
(*mss_get_cen_ecid_FP_t)(const fapi::Target& i_target, uint8_t & o_ddr_port_status, uint8_t & o_cache_enable,      uint8_t & o_centaur_sub_revision, ecid_user_struct & user_data

                         );


//------------------------------------------------------------------------------
// Function prototypes
//------------------------------------------------------------------------------

extern "C"
{

// function: FAPI mss_get_cen_ecid HWP entry point
// parameters: i_target => cen chip target
//             &o_ddr_port_status => indicates if the MBA's are bad, with MBA 1 being the rightmost bit and MBA 0 being the next to right most bit
//             &o_cache_enable => what it would have set the cache enable attribute to if it sets attributes
//             &o_centaur_sub_revision => the sub revision indicator between DD1.0 and DD1.01
// returns: FAPI_RC_SUCCESS if FBC stop is deasserted at end of execution
//          else FAPI return code for failing operation
// Updates attributes: ATTR_ECID[2] -> bits 1-64 and 65-128 of the ECID
//                     ATTR_MSS_PSRO -> average PSRO from 85C wafer test
//                     ATTR_MSS_NWELL_MISPLACEMENT -> indicates if nwell defect in hardware
  fapi::ReturnCode mss_get_cen_ecid(
                                    const fapi::Target& i_target,
                                    uint8_t & o_ddr_port_status,
                                    uint8_t & o_cache_enable,
                                    uint8_t & o_centaur_sub_revision,
                                    ecid_user_struct & user_data

                                    );

  fapi::ReturnCode mss_parse_ecid(
                                  uint64_t ecid[2], // input ECID in bit order
                                  const uint8_t l_checkL4CacheEnableUnknown, // input L4CacheEnableUnknown is possible
                                  const uint8_t l_ecidContainsPortLogicBadIndication, // input logic can be bad
                                  const uint8_t ec, // input ec of chip
                                  uint8_t & ddr_port, //output ddr ports are non functional
                                  uint8_t & cache_enable_o, // output cache is functional or not
                                  uint8_t & centaur_sub_revision_o, // output sub revsion number
                                  uint8_t & o_psro, // output psro
                                  uint8_t & o_bluewaterfall_broken, // output blue waterfall broken
                                  uint8_t & o_nwell_misplacement   // output nwell misplacement
                                  );



} // extern "C"

#endif // _MSS_GET_CEN_ECID_H_
OpenPOWER on IntegriCloud