jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
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/CircularQueue.h>
30#include <Kernel/Devices/CharacterDevice.h>
31#include <Kernel/Interrupts/IRQHandler.h>
32#include <Kernel/MousePacket.h>
33
34namespace Kernel {
35
36class PS2MouseDevice final : public IRQHandler
37 , public CharacterDevice {
38public:
39 PS2MouseDevice();
40 virtual ~PS2MouseDevice() override;
41
42 static PS2MouseDevice& the();
43
44 // ^CharacterDevice
45 virtual bool can_read(const FileDescription&) const override;
46 virtual ssize_t read(FileDescription&, u8*, ssize_t) override;
47 virtual ssize_t write(FileDescription&, const u8*, ssize_t) override;
48 virtual bool can_write(const FileDescription&) const override { return true; }
49
50 virtual const char* purpose() const override { return class_name(); }
51
52private:
53 // ^IRQHandler
54 void handle_vmmouse_absolute_pointer();
55 virtual void handle_irq(const RegisterState&) override;
56
57 // ^CharacterDevice
58 virtual const char* class_name() const override { return "PS2MouseDevice"; }
59
60 void initialize();
61 void check_device_presence();
62 void initialize_device();
63 void prepare_for_input();
64 void prepare_for_output();
65 void mouse_write(u8);
66 u8 mouse_read();
67 void wait_then_write(u8 port, u8 data);
68 u8 wait_then_read(u8 port);
69 void parse_data_packet();
70 void expect_ack();
71
72 bool m_device_present { false };
73 CircularQueue<MousePacket, 100> m_queue;
74 u8 m_data_state { 0 };
75 u8 m_data[4];
76 bool m_has_wheel { false };
77};
78
79}