summaryrefslogtreecommitdiffstats
path: root/src/usr/hwpf/hwp/build_winkle_images/p8_set_pore_bar/p8_pfet_control.H
blob: 0506db3c1f5566fb052b0db7b4a3c7163427de68 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/hwpf/hwp/build_winkle_images/p8_set_pore_bar/p8_pfet_control.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: p8_pfet_control.H,v 1.5 2014/02/25 04:30:36 stillgs Exp $
// $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/chips/p8/working/procedures/ipl/fapi/p8_pfet_control.H,v $
//------------------------------------------------------------------------------
// *|
// *! (C) Copyright International Business Machines Corp. 2011
// *! All Rights Reserved -- Property of IBM
// *! *** IBM Confidential ***
// *|
// *! TITLE       : p8_pfet_control.H
// *! DESCRIPTION : General routines for controlling EX chiplet PFET headers
// *!
// *! OWNER NAME  : Ralf Maier    Email: ralf.maier@de.ibm.com
// *! BACKUP NAME : Greg Still    Email: stillgs@us.ibm.com
// *!
//------------------------------------------------------------------------------

#ifndef _P8_PFETCTL_H_
#define _P8_PFETCTL_H_


//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include "p8_pfet_types.H"

// function pointer typedef definition for HWP call support
typedef fapi::ReturnCode (*p8_pfet_control_FP_t) (const fapi::Target&,
                                                  uint8_t,
                                                  pfet_dom_t,
                                                  pfet_force_t);

extern "C" {

/// Controls the pfets for the specified EX chiplet
///
/// \param[in] i_target    Processor Chip target
/// \param[in] i_ex_number EX number
/// \param[in] i_domain    Domain: BOTH, ECO, CORE
/// \param[in] i_op        Operation:
///                          VON: Turns a chiplet domain on, VCS then VDD
///                          VOFF: Turns a chiplet domain off, VDD then VCS
//                           VOFF_OVERRIDE: Turns a chiplet domain off with
///                                         controller override
///
/// \retval SUCCESS if something good happens,
/// \retval BAD_RETURN_CODE otherwise
fapi::ReturnCode p8_pfet_control(const fapi::Target& i_target,
                                 uint8_t             i_ex_number,
                                 pfet_dom_t          i_domain,
                                 pfet_force_t        i_op);

} // extern "C"

#endif // _P8_PFETCTL_H_
OpenPOWER on IntegriCloud