mirror of
https://github.com/RGBCube/serenity
synced 2025-05-20 05:55:08 +00:00
82cf0bfb75
Add reserve_irqs, allocate_irq, enable_interrupt and disable_interrupt
API to a PCI device.
reserve_irqs() can be used by a device driver that would like to
reserve irqs for MSI(x) interrupts. The API returns the type of IRQ
that was reserved by the PCI device. If the PCI device does not support
MSI(x), then it is a noop.
allocate_irq() API can be used to allocate an IRQ at an index. For
MSIx the driver needs to map the vector table into the memory and add
the corresponding IRQ at the given index. This API will return the
actual IRQ that was used so that the driver can use it create interrupt
handler for that IRQ.
{enable, disable}_interrupt API is used to enable or disable a
particular IRQ at the given index. It is a noop for pin-based
interrupts. This could be used by IRQHandler to enable or disable an
interrupt.
84 lines
2.2 KiB
C++
84 lines
2.2 KiB
C++
/*
|
|
* Copyright (c) 2020, Liav A. <liavalb@hotmail.co.il>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/Format.h>
|
|
#include <AK/NonnullRefPtr.h>
|
|
#include <AK/StringBuilder.h>
|
|
#include <AK/Types.h>
|
|
#include <Kernel/Bus/PCI/Definitions.h>
|
|
|
|
namespace Kernel::PCI {
|
|
|
|
enum class InterruptType {
|
|
PIN,
|
|
MSI,
|
|
MSIX
|
|
};
|
|
|
|
struct InterruptRange {
|
|
u8 m_start_irq { 0 };
|
|
u8 m_irq_count { 0 };
|
|
InterruptType m_type { InterruptType::PIN };
|
|
};
|
|
|
|
struct [[gnu::packed]] MSIxTableEntry {
|
|
u32 address_low;
|
|
u32 address_high;
|
|
u32 data;
|
|
u32 vector_control;
|
|
};
|
|
|
|
class Device {
|
|
public:
|
|
DeviceIdentifier const& device_identifier() const { return *m_pci_identifier; };
|
|
|
|
virtual ~Device() = default;
|
|
|
|
virtual StringView device_name() const = 0;
|
|
|
|
void enable_pin_based_interrupts() const;
|
|
void disable_pin_based_interrupts() const;
|
|
|
|
bool is_msi_capable() const;
|
|
bool is_msix_capable() const;
|
|
|
|
void enable_message_signalled_interrupts();
|
|
void disable_message_signalled_interrupts();
|
|
|
|
void enable_extended_message_signalled_interrupts();
|
|
void disable_extended_message_signalled_interrupts();
|
|
ErrorOr<InterruptType> reserve_irqs(u8 number_of_irqs, bool msi);
|
|
ErrorOr<u8> allocate_irq(u8 index);
|
|
PCI::InterruptType get_interrupt_type();
|
|
void enable_interrupt(u8 irq);
|
|
void disable_interrupt(u8 irq);
|
|
|
|
protected:
|
|
explicit Device(DeviceIdentifier const& pci_identifier);
|
|
|
|
private:
|
|
PhysicalAddress msix_table_entry_address(u8 irq);
|
|
|
|
private:
|
|
NonnullRefPtr<DeviceIdentifier> const m_pci_identifier;
|
|
InterruptRange m_interrupt_range;
|
|
};
|
|
|
|
template<typename... Parameters>
|
|
void dmesgln_pci(Device const& device, AK::CheckedFormatString<Parameters...>&& fmt, Parameters const&... parameters)
|
|
{
|
|
AK::StringBuilder builder;
|
|
if (builder.try_append("{}: {}: "sv).is_error())
|
|
return;
|
|
if (builder.try_append(fmt.view()).is_error())
|
|
return;
|
|
AK::VariadicFormatParams<AK::AllowDebugOnlyFormatters::Yes, StringView, Address, Parameters...> variadic_format_params { device.device_name(), device.device_identifier().address(), parameters... };
|
|
vdmesgln(builder.string_view(), variadic_format_params);
|
|
}
|
|
|
|
}
|