/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/initservice/istepdispatcher/istep_mbox_msgs.H $       */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2012,2013              */
/*                                                                        */
/* p1                                                                     */
/*                                                                        */
/* Object Code Only (OCO) source materials                                */
/* Licensed Internal Code Source Materials                                */
/* IBM HostBoot Licensed Internal Code                                    */
/*                                                                        */
/* The source code for this program is not published or otherwise         */
/* divested of its trade secrets, irrespective of what has been           */
/* deposited with the U.S. Copyright Office.                              */
/*                                                                        */
/* Origin: 30                                                             */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#ifndef __INITSERVICE_ISTEP_MBOX_MSGS_H
#define __INITSERVICE_ISTEP_MBOX_MSGS_H

#include <mbox/mbox_queues.H>

/**
 * @file istep_mbox_msgs.H
 *
 * @brief   Mailbox types used by IStepDisp to communicate with FSP/SP
 *
 */
namespace   INITSERVICE
{

const uint32_t SPLESS_MSG   = 0x000F0000;
const uint32_t ISTEP_WORKER_MSG = 0x00F00000;

const uint32_t ISTEP_MSG_SUCCESS     = 0x00F00000;
const uint32_t ISTEP_INVALID_MESSAGE = 0x00F00000;

// ------------------------------------------------------------------
// HwSvr Msg Type RC values
enum
{
    HWSVR_MSG_SUCCESS            = 0x00,
    HWSVR_INVALID_MESSAGE        = 0x01,
};

// ------------------------------------------------------------------
// HwSvr Msg Type Enums
enum
{
    HWSVR_BREAKPOINT            = 0x00,
    HWSVR_SYNC_POINT            = 0x10,
    HWSVR_IPL_PROGRESS_CODE     = 0x11,
    HWSVR_DO_IOVALID_PROCESSING = 0xC1,
};

// ------------------------------------------------------------------
// Worker Thread Msg Type Enums
enum
{
    WORKER_MORE_WORK_NEEDED     = 0x00,
    WORKER_BREAKPOINT           = 0x01,
};

// ------------------------------------------------------------------
// Msgs that IstepDispatcher can accept
enum
{
    // --------------------------------------------------------------
    // General Messages from all sources
    // --------------------------------------------------------------
    SYNC_POINT_REACHED      = MBOX::FIRST_UNSECURE_MSG |
                                HWSVR_SYNC_POINT,
    BREAKPOINT              = MBOX::FIRST_UNSECURE_MSG |
                                HWSVR_BREAKPOINT,
    PROCESS_IOVALID_REQUEST = MBOX::FIRST_UNSECURE_MSG |
                              HWSVR_DO_IOVALID_PROCESSING,
    IPL_PROGRESS_CODE       = MBOX::FIRST_UNSECURE_MSG |
                                HWSVR_IPL_PROGRESS_CODE,

    // --------------------------------------------------------------
    // Worker Thread Messages
    // --------------------------------------------------------------
    MORE_WORK_NEEDED        = MBOX::FIRST_SECURE_MSG |
                                ISTEP_WORKER_MSG |
                                WORKER_MORE_WORK_NEEDED,
    BREAKPOINT_WORKER       = MBOX::FIRST_SECURE_MSG |
                                ISTEP_WORKER_MSG |
                                WORKER_BREAKPOINT,
};

}   // namespace

#endif