/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/occ_405/common.h $                                        */
/*                                                                        */
/* OpenPOWER OnChipController Project                                     */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2015,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 _common_h
#define _common_h

#include <rtls.h>

// Allow Trace Masks
#define ALLOW_PMCR_TRACE       0x0001
#define ALLOW_CLIP_TRACE       0x0002
#define ALLOW_VFRT_TRACE       0x0004
#define ALLOW_OPAL_TRACE       0x0008
#define ALLOW_MEM_TRACE        0x0010
#define ALLOW_AVSBUS_TRACE     0x0020

// Start of SRAM memory
#define SRAM_START_ADDRESS_405      0xFFF40000

// Reasons why the OCCMISC external interrupt was triggered
typedef enum
{
    // defined as individual bits (since multiple interrupts could be queued)
    INTR_REASON_HTMGT_SERVICE_REQUIRED  = 0x04,
    INTR_REASON_I2C_OWNERSHIP_CHANGE    = 0x02,
    INTR_REASON_OPAL_SHARED_MEM_CHANGE  = 0x01
} ext_intr_reason_t;


// Miscellaneous checks to be done by 405
// - check for pending host notifications
// - check for checkstop
void task_misc_405_checks(task_t *i_self);

// Trigger interrupt to the host with the specified reason (OCCMISC/core_ext_intr)
// Returns true if notification was sent, false if interrupt already outstanding
bool notify_host(const ext_intr_reason_t i_reason);

// Returns true if PGPE error should be ignored
bool ignore_pgpe_error(void);

#endif // _common_h