fapiWrapif.H

/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/usr/fapiwrap/fapiWrapif.H $                       */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 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 _FAPIWRAPIF_H
#define _FAPIWRAPIF_H

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


/* *** Overview ***
   There has been a trend to create more HWPs that process raw data.
   This allows Hostboot and Cronus (and other platforms to share more code.
   The trick is that we generally want to call these HWPs inside what has
   traditionally been Hostboot-only code. The fapiwrap directory will help
   encapsulate all of the calls to ekb code in one place. That way if we
   ever need to remove HWPs/EKB code it will be easier to stub out the calls.
   We have found in the past we have contaminated a lot of Hostboot-only
   code with calls to EKB code. This directory should help address that problem.
*/


namespace FAPIWRAP
{
    /**
     * @brief This function wraps around the FAPI2 HWP "exp_getidec" which
     *        takes in a OCMB target and returns the associated chipId
     *        and ec level.
     *        Chip Ids can be found in src/import/chips/common/utils/chipids.H
     * @param[in]  i_ocmbChip - Explorer OCMB target to lookup values on
     * @param[out] o_chipId   - Power Chip Id associated with this OCMB
     * @param[out] o_ec       - EC level of this chip
     * @return errlHndl_t - nullptr if no error, otherwise contains error
     */
    errlHndl_t explorer_getidec( TARGETING::Target * i_ocmbChip,
                                  uint16_t& o_chipId,
                                  uint8_t&  o_ec);
}

#endif