summaryrefslogtreecommitdiffstats
path: root/src/include/usr/sbeio/runtime/sbeio_nvdimm_operation.H
blob: 2b650bfae78af69784408508b758e610f5394898 (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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/usr/sbeio/runtime/sbeio_nvdimm_operation.H $      */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2017,2019                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* 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                                                     */
#ifndef __SBE_MSG_SBEIO_NVDIMM_OPERATION_H
#define __SBE_MSG_SBEIO_NVDIMM_OPERATION_H

#include <errl/errlentry.H>
#include <targeting/common/target.H>

namespace SBE_MSG
{

/**
 * @brief SBE pass-through command for executing nvdimm operations at runtime.
 *        This command acts as a bridge between sbe pass-through and the
 *        runtime doNvDimmOperation function.
 *
 * @param[in]  i_targetHandle - The target of the request.
 * @param[in]  i_reqDataSize - Size of the nvdimm operation blob.
 * @param[in]  i_reqData - NVDIMM operation data.
 * @param[out] o_rspStatus - The return value from doNvDimmOperation
 * @param[out] o_rspDataSize - Set to 0 on return.
 * @param[out] o_rspData - Not Used.
 *
 * @return nullptr upon success, pointer to ErrlEntry if an error occurred.
 *
 */
errlHndl_t sbeNvdimmOperation( TARGETING::TargetHandle_t i_targetHandle,
                               uint32_t   i_reqDataSize,
                               uint8_t  * i_reqData,
                               uint32_t * o_rspStatus,
                               uint32_t * o_rspDataSize,
                               uint8_t  * o_rspData );

}

#endif
OpenPOWER on IntegriCloud