summaryrefslogtreecommitdiffstats
path: root/src/include/usr/hwpf/hwp/mvpd_accessors/getMBvpdSlopeInterceptData.H
blob: 1a3fbb7336a67826b9899cedf1a3ac2c37304991 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/usr/hwpf/hwp/mvpd_accessors/getMBvpdSlopeInterceptData.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: getMBvpdSlopeInterceptData.H,v 1.1 2013/07/18 15:35:01 whs Exp $

/**
 *  @file getMBvpdSlopeInterceptData.H
 *
 *  @brief Prototype for getMBvpdSlopeInterceptData() -
 *          get master and supplier power slope and intercept from MBvpd
 */

#ifndef    _HWP_MBVPDSLOPEINTERCEPTDATA_
#define    _HWP_MBVPDSLOPEINTERCEPTDATA_

#include   <fapi.H>

namespace fapi
{

    enum MBvpdSlopeIntercept
    {
       MASTER_POWER_SLOPE =                0x00,
       MASTER_POWER_INTERCEPT =            0x01,
       SUPPLIER_POWER_SLOPE =              0x02,
       SUPPLIER_POWER_INTERCEPT =          0x03,
    };
}

// function pointer typedef definition for HWP call support
typedef fapi::ReturnCode (*getMBvpdSlopeInterceptData_FP_t)
     (const fapi::Target &, const fapi::MBvpdSlopeIntercept,  uint32_t &);

extern "C"
{
/**
 * @brief Return power slope and intercept data from cvpd record VSPD
 *        keyword MW and MV
 *
 * The Master power slope and intercept data is in the MW keyword.
 * The Supplier power slope and intercept data is in the MV keyword.
 * The #I keyword has the Module ID for this CDIMM. The MV keyword
 *  has the supplier power slope and intercept for multiple vendors.
 *  The list in MV is searched for the Module ID in the #I keyword.
 *  Values for the matching vendor are returned.
 *
 * @param[in]  i_mbTarget   -   membuf chip target
 * @param[in]  i_attr       -   enumerator to select requested value
 * @param[out] o_val        -   master/supplier slope/intercept value
 *
 * @return fapi::ReturnCode -   FAPI_RC_SUCCESS if success,
 *                              relevant error code for failure.
 */
fapi::ReturnCode getMBvpdSlopeInterceptData(
                              const fapi::Target &i_mbTarget,
                              const fapi::MBvpdSlopeIntercept i_attr,
                              uint32_t &o_val);

}

#endif
OpenPOWER on IntegriCloud