/*
DingusPPC - The Experimental PowerPC Macintosh emulator
Copyright (C) 2018-24 divingkatae and maximum
                      (theweirdo)     spatium

(Contact divingkatae#1017 or powermax#2286 on Discord for more info)

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

#ifndef HW_INTERRUPT_H
#define HW_INTERRUPT_H

#include <cinttypes>

//#define DEBUG_CPU_INT // uncomment this to enable hacks for debugging HW interrupts

/** Enumerator for various interrupt sources. */
enum IntSrc : uint32_t {
    INT_UNKNOWN = 0,
    VIA_CUDA,
    SCSI_MESH,
    SCSI_CURIO,
    SWIM3,
    SCCA,
    SCCB,
    ETHERNET,
    NMI,
    EXT1,
    IDE0,
    IDE1,
    DAVBUS,
    PERCH1,
    PERCH2,
    PCI_A,
    PCI_B,
    PCI_C,
    PCI_D,
    PCI_E,
    PCI_F,
    PCI_GPU,
    PCI_PERCH,
    BANDIT1,
    BANDIT2,
    CONTROL,
    SIXTY6,
    PLANB,
    VCI,
    PLATINUM,
    DMA_SCSI_MESH,
    DMA_SCSI_CURIO,
    DMA_SWIM3,
    DMA_IDE0,
    DMA_IDE1,
    DMA_SCCA_Tx,
    DMA_SCCA_Rx,
    DMA_SCCB_Tx,
    DMA_SCCB_Rx,
    DMA_DAVBUS_Tx,
    DMA_DAVBUS_Rx,
    DMA_ETHERNET_Tx,
    DMA_ETHERNET_Rx,
};

/** Base class for interrupt controllers. */
class InterruptCtrl {
public:
    InterruptCtrl() = default;
    virtual ~InterruptCtrl() = default;

    // register interrupt sources for a device
    virtual uint32_t register_dev_int(IntSrc src_id) = 0;
    virtual uint32_t register_dma_int(IntSrc src_id) = 0;

    // acknowledge HW interrupt
    virtual void ack_int(uint32_t irq_id, uint8_t irq_line_state)     = 0;
    virtual void ack_dma_int(uint32_t irq_id, uint8_t irq_line_state) = 0;
};

#endif // HW_INTERRUPT_H