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/NonnullRefPtr.h>
30#include <Kernel/RTC.h>
31#include <Kernel/Time/HardwareTimer.h>
32
33namespace Kernel {
34class RealTimeClock final : public HardwareTimer {
35public:
36 static NonnullRefPtr<RealTimeClock> create(Function<void(const RegisterState&)> callback);
37 virtual HardwareTimerType timer_type() const override { return HardwareTimerType::RTC; }
38 virtual const char* model() const override { return "Real Time Clock"; }
39 virtual size_t ticks_per_second() const override;
40
41 virtual bool is_periodic() const override { return true; }
42 virtual bool is_periodic_capable() const override { return true; }
43 virtual void set_periodic() override {}
44 virtual void set_non_periodic() override {}
45
46 virtual void reset_to_default_ticks_per_second() override;
47 virtual bool try_to_set_frequency(size_t frequency) override;
48 virtual bool is_capable_of_frequency(size_t frequency) const override;
49 virtual size_t calculate_nearest_possible_frequency(size_t frequency) const override;
50
51private:
52 explicit RealTimeClock(Function<void(const RegisterState&)> callback);
53 virtual void handle_irq(const RegisterState&) override;
54};
55}