/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/plat/p9/prdfP9ProcDomain.H $         */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2016                             */
/* [+] 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 __prdfP9ProcDomain_H
#define __prdfP9ProcDomain_H

#include <prdfRuleChipDomain.H>

namespace PRDF
{

class ProcDomain : public RuleChipDomain
{
  public:

    /**
     * @brief Constructor
     * @param i_did  The domain ID
     * @param i_size The projected size of the domain
     */
    ProcDomain( DOMAIN_ID i_did, uint32_t i_size = PROC_DOMAIN_SIZE ) :
                RuleChipDomain( i_did, i_size )
    {}

    /**
     * @brief Determin which chip to Analyze and call it's Analyze() function
     * @param serviceData   Service data collector
     * @param attentionType attention type
     * @return return code (0 == SUCCESS)
     */
     virtual int32_t Analyze( STEP_CODE_DATA_STRUCT & serviceData,
                              ATTENTION_TYPE attentionType );

    /**
     * @brief  Determine which chip to Analyze in a list of chips in this domain
     * @note   This main only analyze one chip in the domain.
     *          Not the whole domain.
     * @param  serviceData   Service data collector
     * @param  attentionType Attention of the chip
     * @param  i_chips       List of chips in the domain to analyze
     * @return SUCCESS
     */
     virtual int32_t AnalyzeTheseChips( STEP_CODE_DATA_STRUCT & serviceData,
                                        ATTENTION_TYPE attentionType,
                                        TARGETING::TargetHandleList & i_chips );
    /**
     * @brief  Order chips in a list of chips in this domain.
     * @note
     * @param  attentionType Attention of the chip
     * @param  i_chips       List of chips in the domain to analyze
     * @return SUCCESS
     */
     virtual int32_t OrderTheseChips( ATTENTION_TYPE attentionType,
                                      TARGETING::TargetHandleList & i_chips );

    /**
     * @brief  Finds the pointer to the appropriate chip to do analysis or other
     * @note   Just a function to help keep order in a subset of the domain
     * @param  i_chipId      Handle of the chip to find
     * @param  i_chips       List of chips in the domain to analyze
     * @return SUCCESS
     */
     virtual RuleChip * FindChipInTheseChips( TARGETING::TargetHandle_t
                                                                  i_chipId,
                                              TARGETING::TargetHandleList &
                                                                  i_chips );

    /**
     * @brief  Moves the chip in question to the front of the list of chips.
     * @param  i_chipToFront The chip that should be in the front of the list.
     * @param  i_chips       List of chips in the domain to analyze.
     * @return SUCCESS
     */
     virtual void MoveToFrontInTheseChips( uint32_t i_chipToFront,
                                      TARGETING::TargetHandleList & i_chips );

protected:

    /**
     * @brief Determine which chip to Analyze and call it's Analyze() function
     * @param  attentionType Attention of the chip
     * @return SUCCESS
     */
     virtual void Order(ATTENTION_TYPE attentionType);

    /**
     @brief Determine which chip to Analyze and put at front of list.
     */
     virtual void SortForXstop();
     virtual void SortForRecov();
};

} // end namespace PRDF

#endif /* __prdfP9ProcDomain_H */