/*
 * Copyright (c) 2020, Liav A. <liavalb@hotmail.co.il>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/Function.h>
#include <AK/NonnullOwnPtr.h>
#include <AK/OwnPtr.h>
#include <AK/Types.h>
#include <Kernel/Arch/x86_64/IRQController.h>
#include <Kernel/Arch/x86_64/Interrupts/IOAPIC.h>
#include <Kernel/Firmware/ACPI/Definitions.h>
#include <Kernel/Interrupts/GenericInterruptHandler.h>
#include <Kernel/Library/LockRefPtr.h>

namespace Kernel {

class ISAInterruptOverrideMetadata {
public:
    ISAInterruptOverrideMetadata(u8 bus, u8 source, u32 global_system_interrupt, u16 flags)
        : m_bus(bus)
        , m_source(source)
        , m_global_system_interrupt(global_system_interrupt)
        , m_flags(flags)
    {
    }

    u8 bus() const { return m_bus; }
    u8 source() const { return m_source; }
    u32 gsi() const { return m_global_system_interrupt; }
    u16 flags() const { return m_flags; }

private:
    u8 const m_bus;
    u8 const m_source;
    u32 const m_global_system_interrupt;
    u16 const m_flags;
};

class InterruptManagement {
public:
    static InterruptManagement& the();
    static void initialize();
    static bool initialized();
    static InterruptNumber acquire_mapped_interrupt_number(InterruptNumber original_irq);
    static InterruptNumber acquire_irq_number(InterruptNumber mapped_interrupt_vector);

    void switch_to_pic_mode();
    void switch_to_ioapic_mode();

    NonnullLockRefPtr<IRQController> get_responsible_irq_controller(InterruptNumber interrupt_vector);

    Vector<ISAInterruptOverrideMetadata> const& isa_overrides() const { return m_isa_interrupt_overrides; }

    InterruptNumber get_mapped_interrupt_vector(InterruptNumber original_irq);
    InterruptNumber get_irq_vector(InterruptNumber mapped_interrupt_vector);

    void enumerate_interrupt_handlers(Function<void(GenericInterruptHandler&)>);
    IRQController& get_interrupt_controller(size_t index);

protected:
    virtual ~InterruptManagement() = default;

private:
    InterruptManagement();
    ErrorOr<Optional<PhysicalAddress>> find_madt_physical_address();
    void locate_apic_data();
    Vector<NonnullLockRefPtr<IRQController>> m_interrupt_controllers;
    Vector<ISAInterruptOverrideMetadata> m_isa_interrupt_overrides;
    Optional<PhysicalAddress> m_madt_physical_address;
};

}
