/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/include/usr/targeting/targplatreasoncodes.H $             */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2013,2018                        */
/* [+] 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 TARGPLATREASONCODES_H
#define TARGPLATREASONCODES_H

/**
 *  @file targeting/targplatreasoncodes.H
 *
 *  @brief Provides reason codes for various platform specific targeting errors
 */

//******************************************************************************
// Includes
//******************************************************************************

#include <targeting/adapters/types.H>

//******************************************************************************
// Constants
//******************************************************************************

namespace TARGETING
{

/**
 *  @brief Platform specific targeting module IDs
 *
 *  @note Must always start @ 0x80, since common module IDs occupy 0x00 -> 0x7F
 *     range
 */
enum PlatTargetingModuleId
{
    TARG_MOD_QUERY_MASTER_PROC_CHIP               = 0x80,
    TARG_MOD_SET_MASTER_NODE                      = 0x81,
    TARG_MOD_ATTRRP_RT                            = 0x82,
    TARG_MOD_SAVE_OVERRIDE_TANK                   = 0x83,
    TARG_MOD_SAVE_ATTR_TANK                       = 0x84,
    TARG_RT_HBRT_UPDATE_PREP                      = 0x85,
    TARG_RT_VALIDATEDATA                          = 0x86,
    TARG_RT_SAVERESTOREATTRS                      = 0x87,
    TARG_SVC_RESET_MUTEX                          = 0x88,
    TARG_MOD_ATTRRP_TO_COMMON_ADDR                = 0x89,
    TARG_MOD_CLR_ASSOCS_FROM_SYS_OR_NODE_TARGET   = 0x8A,
    TARG_MOD_ADD_ASSOC_TO_SYS_OR_NODE_TARGET      = 0x8B,
    TARG_MOD_RECONNECT_SYS_AND_NODE_TARGETS       = 0x8C,
};

/**
 *  @brief Platform specific targeting reason codes
 *
 *  @note Must always start @ 0x80, since common reasons codes occupy
 *      0x00 -> 0x7F range
 */
enum PlatTargetingReasonCode
{
    TARG_RC_INVALID_NODE           = TARG_COMP_ID | 0x80,
    TARG_RC_TARGET_NOT_FOUND       = TARG_COMP_ID | 0x81,
    TARG_SPACE_OVERRUN             = TARG_COMP_ID | 0x82,
    TARG_RT_BAD_EYECATCHER_LID     = TARG_COMP_ID | 0x83,
    TARG_RT_BAD_EYECATCHER_MEM     = TARG_COMP_ID | 0x84,
    TARG_RT_SECTION_NUM_MISMATCH   = TARG_COMP_ID | 0x85,
    TARG_RT_SECTION_MISMATCH       = TARG_COMP_ID | 0x86,
    TARG_RT_MISSING_ATTR           = TARG_COMP_ID | 0x87,
    TARG_RT_BAD_ATTR_SIZES         = TARG_COMP_ID | 0x88,
    TARG_SVC_MISSING_ATTR          = TARG_COMP_ID | 0x89,
    TARG_RT_NODE_NOT_IN_IMAGE      = TARG_COMP_ID | 0x8A,
    TARG_RC_FAILED_TO_XLATE_ADDR   = TARG_COMP_ID | 0x8B,
    TARG_RC_EXCEEDED_ENTRY_LIMIT   = TARG_COMP_ID | 0x8C,
};

} // End TARGETING namespace

#endif // TARGPLATREASONCODES_H