summaryrefslogtreecommitdiffstats
path: root/src/include/usr/hwpf/hwp/pll_accessors/getPllRingInfoAttr.H
blob: 4a77e7282542c5170347975e2077694229f378f1 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/usr/hwpf/hwp/pll_accessors/getPllRingInfoAttr.H $ */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2013,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: getPllRingInfoAttr.H,v 1.2 2014/01/17 23:50:25 whs Exp $
/**
 *  @file getPllRingInfoAttr.H
 *
 *  @brief Accessor HWP that gets attributes containing information about PLL
 *         Rings
 */

#ifndef _GETPLLRINGINFOATTR_
#define _GETPLLRINGINFOATTR_

#include <fapi.H>

namespace fapi
{
    // Attributes supported
    namespace getPllRingInfo
    {
        enum Attr
        {
            PROC_DMI_CUPLL_PFD360_OFFSET     = 0x01,
            PROC_DMI_CUPLL_REFCLKSEL_OFFSET  = 0x02,
            PROC_ABUS_CUPLL_PFD360_OFFSET    = 0x03,
            PROC_ABUS_CUPLL_REFCLKSEL_OFFSET = 0x04,
            MEMB_DMI_CUPLL_PFD360_OFFSET     = 0x05,
            MEMB_DMI_CUPLL_REFCLKSEL_OFFSET  = 0x06,
            MEMB_MEM_PLL_CFG_UPDATE_OFFSET   = 0x07,
        };
    }
}

// function pointer typedef definition for HWP call support
typedef fapi::ReturnCode (*getPllRingInfoAttr_FP_t) (
    const fapi::Target &,
    const fapi::getPllRingInfo::Attr,
    void *, const size_t);

extern "C"
{
/**
 * @brief Accessor HWP that gets attributes containing information about PLL
 *        Rings
 *
 * FAPI_ATTR_GET checks at compile time that the user's attribute is the correct
 * type. Assuming that the platform routes the access of the attribute to the
 * corresponding attribute enum defined in this file  then the size of o_pVal
 * will be correct, in the unlikely event of a misroute where the buffer is too
 * small, an error will be returned.
 *
 * @param[in]  i_chip Reference to Processor/Membuf Chip fapi target
 * @param[in]  i_attr The Attribute to get
 * @param[out] o_pVal Pointer to data buffer filled in with attribute data
 * @param[in]  i_len  Size of o_pVal
 *
 * @return fapi::ReturnCode Indicating success or error
 */
fapi::ReturnCode getPllRingInfoAttr(const fapi::Target & i_chip,
                                    const fapi::getPllRingInfo::Attr i_attr,
                                    void * o_pVal,
                                    const size_t i_len);
}

#endif
OpenPOWER on IntegriCloud