summaryrefslogtreecommitdiffstats
path: root/src/sbefw/core/sbeevents.H
blob: 783dc183a773571d2854f1159a6b70e1f2c7b0b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/sbefw/core/sbeevents.H $                                  */
/*                                                                        */
/* OpenPOWER sbe Project                                                  */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2016,2017                        */
/*                                                                        */
/*                                                                        */
/* 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_RUNTIME_EVENT          = 0x0, // From Unknown/ISTEP/IPLING State
    SBE_ISTEP_EVENT            = 0x1, // From Unknown State
    SBE_PLCK_EVENT             = 0x2, // From Unknown state
    SBE_DUMP_FAILURE_EVENT     = 0x3, // From IPLING/RUNTIME/MPIPL/DMT/Unknown State
    SBE_ENTER_MPIPL_EVENT      = 0x4, // From Runtime State
    SBE_CONTINUE_MPIPL_EVENT   = 0x5, // From MPIPL Wait State
    SBE_DMT_ENTER_EVENT        = 0x6, // From Runtime State
    SBE_DMT_COMP_EVENT         = 0x7, // From DMT State
    SBE_FAILURE_EVENT          = 0x8, // From Any State
    SBE_QUIESCE_EVENT          = 0x9, // From Any State
};

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

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


// 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_IPLING_ENTRY_TO_MAP  = SBE_STATE_UNKNOWN_ENTRY_TO_MAP + SBE_STATE_UNKNOWN_MAX_EVENT, // 4
    SBE_STATE_ISTEP_ENTRY_TO_MAP   = SBE_STATE_IPLING_ENTRY_TO_MAP + SBE_STATE_IPLING_MAX_EVENT, //8
    SBE_STATE_MPIPL_ENTRY_TO_MAP   = SBE_STATE_ISTEP_ENTRY_TO_MAP + SBE_STATE_ISTEP_MAX_EVENT, //11
    SBE_STATE_RUNTIME_ENTRY_TO_MAP = SBE_STATE_MPIPL_ENTRY_TO_MAP + SBE_STATE_MPIPL_MAX_EVENT, //14
    SBE_STATE_DMT_ENTRY_TO_MAP     = SBE_STATE_RUNTIME_ENTRY_TO_MAP + SBE_STATE_RUNTIME_MAX_EVENT, //19
    SBE_STATE_DUMP_ENTRY_TO_MAP    = SBE_STATE_DMT_ENTRY_TO_MAP + SBE_STATE_DMT_MAX_EVENT, //22
    SBE_STATE_FAILURE_ENTRY_TO_MAP = SBE_STATE_DUMP_ENTRY_TO_MAP + SBE_STATE_DUMP_MAX_EVENT, //22
    SBE_STATE_QUIESCE_ENTRY_TO_MAP = SBE_STATE_FAILURE_ENTRY_TO_MAP + SBE_STATE_FAILURE_MAX_EVENT, //22
};

#endif //__SBEFW_SBEEVENTS_H

OpenPOWER on IntegriCloud