summaryrefslogtreecommitdiffstats
path: root/importtemp/fapi2/include/fapi2_chip_ec_feature.H
blob: 2398b5dad946efa35bf7c54e0da0329ec20858de (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
///
/// @file src/include/usr/hwpf/fapi2/fapi2_chip_ec_feature.H
///
/// @brief Defines the queryChipEcFeature function that allows HWPs to
///        query if a particular chip has a feature determined by its EC level.
///        Chip EC features are specified in attribute XML files and the
///        queryChipEcFeature function implementation is auto-generated.
///        HWPs should not call this function directly, but should access the
///        corresponding HWPF attribute using FAPI_ATTR_GET
///

#ifndef FAPI2CHIPECFEATURE_H_
#define FAPI2CHIPECFEATURE_H_

#include <stdint.h>
#include <target.H>
#include <return_code.H>

namespace fapi2
{

///
/// @brief Queries if a Chip has a particular feature
///
/// This should only be called by FAPI during the processing of a FAPI_ATTR_GET
/// for a Chip EC Feature attribute
///
/// @param[in]  i_id         Attribute ID of the Chip EC Feature
/// @param[in]  i_target     Reference to chip target
/// @param[out] o_hasFeature Set to 1 if chip has feature else 0
/// @return ReturnCode. Zero on success, else platform specified error
///
template< TargetType K >
ReturnCode queryChipEcFeature(AttributeId i_id,
                              const Target<K>& i_target,
                              uint8_t & o_hasFeature);
}

#endif
OpenPOWER on IntegriCloud