jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2020, Liav A. <liavalb@hotmail.co.il>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/HashTable.h>
30#include <AK/String.h>
31#include <AK/Types.h>
32#include <Kernel/Arch/i386/CPU.h>
33
34namespace Kernel {
35
36enum class HandlerPurpose : u8 {
37 IRQHandler = 1,
38 SharedIRQHandler = 2,
39 UnhandledInterruptHandler = 3,
40};
41
42class GenericInterruptHandler {
43public:
44 static GenericInterruptHandler& from(u8 interrupt_number);
45 virtual ~GenericInterruptHandler();
46 virtual void handle_interrupt(RegisterState& regs) = 0;
47
48 u8 interrupt_number() const { return m_interrupt_number; }
49
50 bool is_enabled() const { return m_enabled; }
51
52 size_t get_invoking_count() const { return m_invoking_count; }
53
54 virtual size_t sharing_devices_count() const = 0;
55 virtual bool is_shared_handler() const = 0;
56 virtual bool is_sharing_with_others() const = 0;
57
58 virtual HandlerPurpose purpose() const = 0;
59
60 virtual bool eoi() = 0;
61 void increment_invoking_counter();
62
63protected:
64 void enable_interrupt_vector();
65 void disable_interrupt_vector();
66 void change_interrupt_number(u8 number);
67 explicit GenericInterruptHandler(u8 interrupt_number);
68
69private:
70 size_t m_invoking_count { 0 };
71 bool m_enabled { false };
72 u8 m_interrupt_number { 0 };
73};
74}