2020-02-22 17:36:40 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2020, Liav A. <liavalb@hotmail.co.il>
|
|
|
|
*
|
2021-04-22 08:24:48 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-02-22 17:36:40 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2021-07-21 18:21:29 +00:00
|
|
|
#include <AK/IntrusiveList.h>
|
2020-02-22 17:36:40 +00:00
|
|
|
#include <AK/Types.h>
|
2021-10-14 22:01:29 +00:00
|
|
|
#include <Kernel/Arch/RegisterState.h>
|
2020-02-22 17:36:40 +00:00
|
|
|
|
|
|
|
namespace Kernel {
|
|
|
|
|
2020-03-05 17:13:55 +00:00
|
|
|
enum class HandlerType : u8 {
|
2020-02-22 17:36:40 +00:00
|
|
|
IRQHandler = 1,
|
|
|
|
SharedIRQHandler = 2,
|
|
|
|
UnhandledInterruptHandler = 3,
|
2020-02-28 16:23:32 +00:00
|
|
|
SpuriousInterruptHandler = 4
|
2020-02-22 17:36:40 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
class GenericInterruptHandler {
|
|
|
|
public:
|
|
|
|
static GenericInterruptHandler& from(u8 interrupt_number);
|
2021-02-27 00:17:57 +00:00
|
|
|
virtual ~GenericInterruptHandler()
|
|
|
|
{
|
|
|
|
VERIFY(!m_registered);
|
|
|
|
}
|
2021-06-05 06:00:18 +00:00
|
|
|
// Note: this method returns boolean value, to indicate if the handler handled
|
|
|
|
// the interrupt or not. This is useful for shared handlers mostly.
|
2022-04-01 17:58:27 +00:00
|
|
|
virtual bool handle_interrupt(RegisterState const& regs) = 0;
|
2020-02-22 17:36:40 +00:00
|
|
|
|
2021-02-27 00:17:57 +00:00
|
|
|
void will_be_destroyed();
|
|
|
|
bool is_registered() const { return m_registered; }
|
|
|
|
void register_interrupt_handler();
|
|
|
|
void unregister_interrupt_handler();
|
|
|
|
|
2020-02-22 17:36:40 +00:00
|
|
|
u8 interrupt_number() const { return m_interrupt_number; }
|
|
|
|
|
2021-01-03 23:58:50 +00:00
|
|
|
size_t get_invoking_count() const { return m_invoking_count; }
|
2020-02-22 17:36:40 +00:00
|
|
|
|
2020-02-23 12:14:01 +00:00
|
|
|
virtual size_t sharing_devices_count() const = 0;
|
2020-02-22 17:36:40 +00:00
|
|
|
virtual bool is_shared_handler() const = 0;
|
|
|
|
virtual bool is_sharing_with_others() const = 0;
|
|
|
|
|
2020-03-05 17:13:55 +00:00
|
|
|
virtual HandlerType type() const = 0;
|
2021-07-10 23:46:09 +00:00
|
|
|
virtual StringView purpose() const = 0;
|
|
|
|
virtual StringView controller() const = 0;
|
2020-02-22 17:36:40 +00:00
|
|
|
|
|
|
|
virtual bool eoi() = 0;
|
2020-12-02 16:41:52 +00:00
|
|
|
ALWAYS_INLINE void increment_invoking_counter()
|
|
|
|
{
|
2021-01-03 23:58:50 +00:00
|
|
|
m_invoking_count++;
|
2020-12-02 16:41:52 +00:00
|
|
|
}
|
2020-02-22 17:36:40 +00:00
|
|
|
|
|
|
|
protected:
|
|
|
|
void change_interrupt_number(u8 number);
|
2020-08-27 21:28:07 +00:00
|
|
|
GenericInterruptHandler(u8 interrupt_number, bool disable_remap = false);
|
2020-02-22 17:36:40 +00:00
|
|
|
|
2020-10-25 15:13:47 +00:00
|
|
|
void disable_remap() { m_disable_remap = true; }
|
|
|
|
|
2020-02-22 17:36:40 +00:00
|
|
|
private:
|
2021-01-03 23:58:50 +00:00
|
|
|
Atomic<u32, AK::MemoryOrder::memory_order_relaxed> m_invoking_count { 0 };
|
2020-02-22 17:36:40 +00:00
|
|
|
u8 m_interrupt_number { 0 };
|
2020-07-06 13:27:22 +00:00
|
|
|
bool m_disable_remap { false };
|
2021-02-27 00:17:57 +00:00
|
|
|
bool m_registered { false };
|
2021-07-21 18:21:29 +00:00
|
|
|
|
|
|
|
IntrusiveListNode<GenericInterruptHandler> m_list_node;
|
|
|
|
|
|
|
|
public:
|
2021-09-09 12:00:59 +00:00
|
|
|
using List = IntrusiveList<&GenericInterruptHandler::m_list_node>;
|
2020-02-22 17:36:40 +00:00
|
|
|
};
|
|
|
|
}
|