summaryrefslogtreecommitdiffstats
path: root/src/include/usr/hwpf/hwp/pll_accessors/getPllRingAttr.H
blob: 33c6176206e90fa2d59f0d9f4b492c442fb3264e (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/usr/hwpf/hwp/pll_accessors/getPllRingAttr.H $     */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2013                   */
/*                                                                        */
/* p1                                                                     */
/*                                                                        */
/* Object Code Only (OCO) source materials                                */
/* Licensed Internal Code Source Materials                                */
/* IBM HostBoot Licensed Internal Code                                    */
/*                                                                        */
/* 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.                              */
/*                                                                        */
/* Origin: 30                                                             */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
// $Id: getPllRingAttr.H,v 1.1 2013/12/05 18:23:24 mjjones Exp $
/**
 *  @file getPllRingAttr.H
 *
 *  @brief Prototype for getPllRingAttr() -
 *         fetch PLL ring attributes based on chip EC and frequencies
 *         from data from static arrays (fapiPllRingAttr.H)
 */

 #ifndef    _HWP_GETPLLRINGATTR_
 #define    _HWP_GETPLLRINGATTR_

#include   <fapi.H>
#define MAX_PLL_RING_SIZE_BYTES 256

//#include   <fapiPllRingAttr.H>


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

extern "C"
{
/**
 * @brief   get specified PLL ring attribute for the specified target CPU.
 *
 * @param i_attrId          -   fapi attribute requested by the caller.
 * @param i_fapiTarget      -   cpu target
 * @param o_ringLength      -   out:    size of ring buffer that caller has
 *                                      allocated
 * @param 0_data            -   out:    PLL ring data.
 *
 * @return fapi::ReturnCode -   FAPI_RC_SUCCESS if success,
 *                              relevant error code for failure.
 */
    fapi::ReturnCode getPllRingAttr( const fapi::AttributeId  i_attrId,
                                     const fapi::Target  i_pChipTarget,
                                     uint32_t & o_ringBitLength,
                                     uint8_t *o_data);

}

#endif
OpenPOWER on IntegriCloud