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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/hwpf/fapi/fapiSystemConfig.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2014 */
/* */
/* 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: fapiSystemConfig.H,v 1.6 2013/10/15 13:13:41 dcrowell Exp $
// $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/hwpf/working/fapi/fapiSystemConfig.H,v $
/**
* @file fapiSystemConfig.H
*
* @brief Defines the System Config query functions that platform code must
* implement. It is an eCMD requirement that these be "C" functions.
*/
/*
* Change Log ******************************************************************
* Flag Defect/Feature User Date Description
* ------ -------------- ---------- ----------- ----------------------------
* mjjones 09/12/2011 Updated with new functions.
* mjjones 02/17/2012 Updated fapiGetAssociatedDimms
* description to only allow MBA
*
*/
#ifndef FAPISYSTEMCONFIG_H_
#define FAPISYSTEMCONFIG_H_
#include <stdint.h>
#include <vector>
#include <fapiReturnCode.H>
#include <fapiTarget.H>
extern "C"
{
/**
* @brief Gets the Target on the other side of the memory channel
* - Input MEMBUF_CHIP, Output MCS_CHIPLET
* - Input MCS_CHIPLET, Output MEMBUF_CHIP
*
* @param[in] i_target Input MCS_CHIPLET or MEMBUF_CHIP Target
* @param[out] o_target Reference to Target that is set to the Target on
* the other side of the memory channel, if there is no such
* Target in the specified state then an error is returned
* @param[in] i_state Only return a target in the specified state. Either
* present or functional (default)
*
* @return ReturnCode. Zero on success, else error
*/
fapi::ReturnCode fapiGetOtherSideOfMemChannel(
const fapi::Target& i_target,
fapi::Target & o_target,
const fapi::TargetState i_state = fapi::TARGET_STATE_FUNCTIONAL);
/**
* @brief Gets the chiplets that are children of the input chip
*
* @param[in] i_chip Input chip
* @param[in] i_chipletType Type of chiplet required
* @param[out] o_chiplets Reference to vector that is cleared then filled in
* with the children chiplet Targets
* @param[in] i_state Only return targets of the specified state. Either
* present or functional (default)
*
* @return ReturnCode. Zero on success, else error
*/
fapi::ReturnCode fapiGetChildChiplets(
const fapi::Target & i_chip,
const fapi::TargetType i_chipletType,
std::vector<fapi::Target> & o_chiplets,
const fapi::TargetState i_state = fapi::TARGET_STATE_FUNCTIONAL);
/**
* @brief Gets the DIMMs that are logically associated with the input MBA target
*
* @param[in] i_target Input MBA chiplet target
* @param[out] o_dimms Reference to vector that is cleared then filled in with
* the associated DIMM Targets
* @param[in] i_state Only return targets of the specified state. Either
* present or functional (default)
*
* @return ReturnCode. Zero on success, else error
*/
fapi::ReturnCode fapiGetAssociatedDimms(
const fapi::Target& i_target,
std::vector<fapi::Target> & o_dimms,
const fapi::TargetState i_state = fapi::TARGET_STATE_FUNCTIONAL);
/**
* @brief Gets the parent chip of the input chiplet
*
* @param[in] i_chiplet Input chiplet
* @param[out] o_chip Reference to Target that is set to the parent chip
*
* @return ReturnCode. Zero on success, else error
*/
fapi::ReturnCode fapiGetParentChip(
const fapi::Target& i_chiplet,
fapi::Target & o_chip);
} // extern "C"
#endif // FAPISYSTEMCONFIG_H_
|
