blob: 5f51bc7e3bd555edff8b2ac0c1b3e4c4f15b672b (
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/hwpf/plat/fapiPlatHwpInvoker.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,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 */
/**
* @file fapiPlatHwpInvoker.H
*
* @brief Defines the HostBoot HWP invoker macro and a function to convert a
* fapi::ReturnCode to an error log
*/
#ifndef FAPIPLATHWPINVOKER_H_
#define FAPIPLATHWPINVOKER_H_
#include <errl/errlentry.H>
#include <fapiReturnCode.H>
#include <fapiHwpExecutor.H>
/**
* @brief HWP Invoker macro
*
* This macro is called by HostBoot PLAT code to invoke a HW Procedure (HWP).
* The caller must create any necessary fapi::Targets and pass them as
* parameters. This macro simply calls the FAPI HWP executor macro and converts
* the returned fapi::Return code to a HostBoot error log
*
* ERRHNDL - errlHndl_t
* FUNC - HWP function name
* _args_... - Any additional arguments that the HWP requires
*/
#define FAPI_INVOKE_HWP(ERRHNDL, FUNC, _args_...) \
{\
fapi::ReturnCode l_rc; \
FAPI_EXEC_HWP(l_rc, FUNC, ##_args_); \
ERRHNDL = fapi::fapiRcToErrl(l_rc); \
}
namespace fapi
{
/**
* @brief Converts a fapi::ReturnCode to a HostBoot PLAT error log
*
* @param[io] io_rc Reference to ReturnCode (set to success after function ends)
* @param[in] i_sev Error log severity defaulted to unrecoverable
*
* @return errlHndl_t (NULL if Return Code contained success)
*/
errlHndl_t fapiRcToErrl(ReturnCode & io_rc,
ERRORLOG::errlSeverity_t i_sev =
ERRORLOG::ERRL_SEV_UNRECOVERABLE);
}
#endif // FAPIPLATHWPINVOKER_H_
|
