/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/sbefw/sbeevents.H $                                       */
/*                                                                        */
/* OpenPOWER sbe 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                                                     */
/*
 * @file: ppe/sbe/sbefw/sbeevents.H
 *
 * @brief This file contains interfaces pertaining to the events for state
 * transition trigger.
 *
 */

#ifndef __SBEFW_SBEEVENTS_H
#define __SBEFW_SBEEVENTS_H

/**
 * @brief An enumeration of all SBE state transition events
 *
 */
enum sbeEvent
{
    SBE_CONTINUE_BOOT_PLCK_EVENT           = 0x0, // From FFDC State
    SBE_CONTINUE_BOOT_RUNTIME_EVENT        = 0x1, // From FFDC State
    SBE_RUNTIME_EVENT                      = 0x2, // From FFDC/Unknown/ISTEP/IPLING State
    SBE_ISTEP_EVENT                        = 0x3, // From FFDC/Unknown State
    SBE_PLCK_EVENT                         = 0x4, // From FFDC/Unknown state
    SBE_DUMP_FAILURE_EVENT                 = 0x5, // From IPLING/RUNTIME/MPIPL/DMT/Unknown State
    SBE_ENTER_MPIPL_EVENT                  = 0x6, // From Runtime State
    SBE_CONTINUE_MPIPL_EVENT               = 0x7, // From MPIPL Wait State
    SBE_ABORT_EVENT                        = 0x8, // From Any state
    SBE_DMT_ENTER_EVENT                    = 0x9, // From Runtime State
    SBE_DMT_COMP_EVENT                     = 0xA, // From DMT State
    SBE_FAILURE_EVENT                      = 0xB, // From Any State
    SBE_FFDC_COLLECT_EVENT                 = 0xC, // From Unknown State
};

// Maximum number of Events per State
enum maxEventPerState
{
    SBE_STATE_UNKNOWN_MAX_EVENT = 5,
    SBE_STATE_FFDC_COLLECT_MAX_EVENT = 4,
    SBE_STATE_IPLING_MAX_EVENT = 4,
    SBE_STATE_ISTEP_MAX_EVENT = 3,
    SBE_STATE_RUNTIME_MAX_EVENT = 4,
    SBE_STATE_MPIPL_MAX_EVENT = 2,
    SBE_STATE_DMT_MAX_EVENT = 1,
    SBE_STATE_DUMP_MAX_EVENT = 0,
    SBE_STATE_FAILURE_MAX_EVENT = 0,
    SBE_STATE_QUIESCE_MAX_EVENT = 0,
    SBE_STATE_ABORT_MAX_EVENT = 0,

    // Total number of State Transition Events, Addition of all the above
    SBE_MAX_TRANSITIONS = 23,
};


// Entry Point to stateTransitionStr_t Map Structure, This adds up all the state
// transition of the previous state, If any more transition is added, this will
// add up to all subsequent entries. This is closely mapped with the sbestates.H
// as well.
enum entryToStateMap
{
    SBE_STATE_UNKNOWN_ENTRY_TO_MAP = 0,
    SBE_STATE_FFDC_COLLECT_ENTRY_TO_MAP = SBE_STATE_UNKNOWN_ENTRY_TO_MAP + SBE_STATE_UNKNOWN_MAX_EVENT, // 5
    SBE_STATE_IPLING_ENTRY_TO_MAP = SBE_STATE_FFDC_COLLECT_ENTRY_TO_MAP + SBE_STATE_FFDC_COLLECT_MAX_EVENT, //9
    SBE_STATE_ISTEP_ENTRY_TO_MAP = SBE_STATE_IPLING_ENTRY_TO_MAP + SBE_STATE_IPLING_MAX_EVENT, //13
    SBE_STATE_RUNTIME_ENTRY_TO_MAP = SBE_STATE_ISTEP_ENTRY_TO_MAP + SBE_STATE_ISTEP_MAX_EVENT, //16
    SBE_STATE_MPIPL_ENTRY_TO_MAP = SBE_STATE_RUNTIME_ENTRY_TO_MAP + SBE_STATE_RUNTIME_MAX_EVENT, //20
    SBE_STATE_DMT_ENTRY_TO_MAP = SBE_STATE_MPIPL_ENTRY_TO_MAP + SBE_STATE_MPIPL_MAX_EVENT, //22
    SBE_STATE_DUMP_ENTRY_TO_MAP = SBE_STATE_DMT_ENTRY_TO_MAP + SBE_STATE_DMT_MAX_EVENT, //23
    SBE_STATE_FAILURE_ENTRY_TO_MAP = SBE_STATE_DUMP_ENTRY_TO_MAP + SBE_STATE_DUMP_MAX_EVENT, //23
    SBE_STATE_QUIESCE_ENTRY_TO_MAP = SBE_STATE_FAILURE_ENTRY_TO_MAP + SBE_STATE_FAILURE_MAX_EVENT, //23
    SBE_STATE_ABORT_ENTRY_TO_MAP = SBE_STATE_QUIESCE_ENTRY_TO_MAP + SBE_STATE_QUIESCE_MAX_EVENT, //23
};

#endif //__SBEFW_SBEEVENTS_H