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 HandlerType : u8 {
37 IRQHandler = 1,
38 SharedIRQHandler = 2,
39 UnhandledInterruptHandler = 3,
40 SpuriousInterruptHandler = 4
41};
42
43class GenericInterruptHandler {
44public:
45 static GenericInterruptHandler& from(u8 interrupt_number);
46 virtual ~GenericInterruptHandler();
47 virtual void handle_interrupt(const RegisterState& regs) = 0;
48
49 u8 interrupt_number() const { return m_interrupt_number; }
50
51 bool is_enabled() const { return m_enabled; }
52
53 size_t get_invoking_count() const { return m_invoking_count; }
54
55 virtual size_t sharing_devices_count() const = 0;
56 virtual bool is_shared_handler() const = 0;
57 virtual bool is_sharing_with_others() const = 0;
58
59 virtual HandlerType type() const = 0;
60 virtual const char* purpose() const = 0;
61 virtual const char* controller() const = 0;
62
63 virtual bool eoi() = 0;
64 void increment_invoking_counter();
65
66protected:
67 void change_interrupt_number(u8 number);
68 explicit GenericInterruptHandler(u8 interrupt_number);
69
70private:
71 size_t m_invoking_count { 0 };
72 bool m_enabled { false };
73 u8 m_interrupt_number { 0 };
74};
75}