summaryrefslogtreecommitdiffstats
path: root/src/include/usr/hwpf/hwp/fapiTestHwpError.H
blob: 5d7954e35dd3a77b8f3f1197e006f4412f1759fe (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
/**
 *  @file fapiTestHwpError.H
 *
 *  @brief Defines a simple test Hardware Procedure that returns an error
 */

/*
 * Change Log ******************************************************************
 * Flag     Defect/Feature  User        Date        Description
 * ------   --------------  ----------  ----------- ----------------------------
 *                          mjjones     08/08/2011  Created.
 *
 */

#ifndef FAPITESTHWPERROR_H_
#define FAPITESTHWPERROR_H_

#include <fapi.H>

// HWPs are defined as C functions because platforms may wish to package them
// in linux shared libraries which are DL-Opened
extern "C"
{

/**
 * @brief Simple HWP that returns an error (RC_TEST_ERROR_A)
 *
 * @param[in] i_target Reference to target (unused by HWP)
 *
 * @return ReturnCode
 */
fapi::ReturnCode hwpTestError(const fapi::Target & i_target);

} // extern "C"

#endif // FAPITESTHWPERROR_H_
OpenPOWER on IntegriCloud