/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/usr/isteps/ucd/updateUcdFlash.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 __UPDATE_UCD_FLASH_H
#define __UPDATE_UCD_FLASH_H

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

namespace POWER_SEQUENCER
{

namespace TI // Texas Instruments
{

namespace UCD // UCD series
{

/**
 *  @brief Applies UCD data flash image updates (if needed) to the requested
 *      UCDs
 *
 *  @param[in] i_powerSequencers Fixed vector of PowerSequencer targets to
 *      update flash image on
 *  @param[in] i_image Reference to UtilMem buffer holding the UCD flash image
 *      contents (including header, TOC entries, and flash images).  Note: the
 *      implementation will not alter the buffer content, and will seek back
 *      to the beginning before handing control back.
 *
 *  @return errlHndl_t Error log handle
 *  @retval nullptr Successfully took action against all requested UCDs.  It's
 *      possible an individual UCD update failed, in which case the error is
 *      committed.
 *  @retval !nullptr Failed to take action against one or more requested UCDs.
 *      Typically this is due to a firmware problem.  Handle points to valid
 *      error log
 */
errlHndl_t updateAllUcdFlashImages(
    const TARGETING::TargetHandleList& i_powerSequencers,
          UtilMem&                     i_image);

} // End namespace UCD

} // End namespace TI

} // End namespace POWER_SEQUENCER

#endif // __UPDATE_UCD_FLASH_H