blob: 9bfa88c4ff059b6feb1ab3124ba95416a2ed8ee8 (
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: chips/p9/procedures/hwp/pm/p9_setup_evid.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* EKB Project */
/* */
/* COPYRIGHT 2015,2016 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* The source code for this program is not published or otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* IBM_PROLOG_END_TAG */
///
/// @file p9_setup_evid.H
/// @brief Setup External Voltage IDs
///
/// *HW Owner : Sudheendra K Srivathsa <sudheendraks@in.ibm.com>
/// *FW Owner : Sangeetha T S <sangeet2@in.ibm.com>
/// *Team : PM
/// *Consumed by : HB
/// *Level : 2
///
#ifndef __P9_SETUP_EVID_H__
#define __P9_SETUP_EVID_H__
#include <fapi2.H>
extern "C"
{
/// @typedef VoltageConfigActions_t
/// enum of the two actions this hwp can perform
/// it can either compute default voltage settings
/// otherwise it can apply voltage setting to the system
typedef enum
{
COMPUTE_VOLTAGE_SETTINGS,
APPLY_VOLTAGE_SETTINGS
} VoltageConfigActions_t;
/// @typedef p9_setup_evid_FP_t
/// function pointer typedef definition for HWP call support
typedef fapi2::ReturnCode (*p9_setup_evid_FP_t) (
const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&,
const VoltageConfigActions_t);
/// @brief Read attributes containing part's boot voltages(VDD,VCS and VDN)
/// and set these voltage using the AVSBUS interface (VDD, VDN and VCS).
///
/// @param [in] i_target TARGET_TYPE_PROC_CHIP
/// @param [in] i_action Describes whether you wish to COMPUTE voltage settings
/// during the step or if you would like to APPLY them.
/// @attr
/// @attritem ATTR_VCS_BOOT_VOLTAGE - 1mV grandularity setting for VCS rail
/// @attritem ATTR_VDD_BOOT_VOLTAGE - 1mV grandularity setting for VDD rail
/// @attritem ATTR_VDN_BOOT_VOLTAGE - 1mV grandularity setting for VDN rail
/// @attritem ATTR_VDD_AVSBUS_BUSNUM - AVSBus Number having the VDD VRM
/// @attritem ATTR_VDD_AVSBUS_RAIL - AVSBus Rail number for VDD VRM
/// @attritem ATTR_VDN_AVSBUS_BUSNUM - AVSBus Number having the VDN VRM
/// @attritem ATTR_VDN_AVSBUS_RAIL - AVSBus Rail number for VDN VRM
/// @attritem ATTR_VCS_AVSBUS_BUSNUM - AVSBus Number having the VCS VRM
/// @attritem ATTR_VCS_AVSBUS_RAIL - AVSBus Rail number for VCS VRM
///
/// @retval FAPI_RC_SUCCESS
fapi2::ReturnCode
p9_setup_evid(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
const VoltageConfigActions_t i_action);
} // extern C
#endif // __P9_SETUP_EVID_H__
|
