summaryrefslogtreecommitdiffstats
path: root/src/import/hwpf/fapi2/include/fapi2_spd_access.H
blob: fe7c75e597dd3463970bdeb519d9f390b72755a4 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: hwpf/fapi2/include/fapi2_spd_access.H $                       */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* EKB Project                                                            */
/*                                                                        */
/* COPYRIGHT 2016                                                         */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* 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.                              */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
///
/// @file fapi2_spd_access.H
///
/// @brief Defines the SPD functions that platform must implement
///

#ifndef _FAPI2_SPDACCESS_H_
#define _FAPI2_SPDACCESS_H_

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

namespace fapi2
{
///
/// @brief Return a blob of SPD data from a DIMM
/// @param[in] i_target  a DIMM target representing the DIMM in question
/// @param[out] o_blob   the blob of data from the DIMM - raw
/// @param[out] s        the size of the blob
/// @return FAPI2_RC_SUCCESS if there's no problem
/// @note passing nullptr for o_blob will return the size of the blob
///   size_t s;
///   FAPI_TRY( getSPD(d->target(), nullptr, s) );
///   {
///       uint8_t blob[s];
///       FAPI_TRY( getSPD(d->target(), blob, s) );
///    }
///
fapi2::ReturnCode getSPD( const fapi2::Target<fapi2::TARGET_TYPE_DIMM>& i_target,
                          uint8_t* o_blob,
                          size_t& s );

}
#endif
OpenPOWER on IntegriCloud