IgrOS-Kernel 0.1.34.545
Simple C++20 Kernel for i386/x86_64
Loading...
Searching...
No Matches
pit.cpp
Go to the documentation of this file.
1
11
12
13// IgrOS-Kernel arch
14#include <arch/io.hpp>
15#include <arch/irq.hpp>
16#include <arch/register.hpp>
17#include <arch/types.hpp>
18// IgrOS-Kernel drivers
19#include <drivers/clock/pit.hpp>
20// IgrOS-Kernel library
21#include <klib/kMath.hpp>
22#include <klib/kPrint.hpp>
23
24
25// Arch-dependent code zone
26namespace igros::arch {
27
28
29 // PIT ports
30 constexpr auto PIT_CONTROL {static_cast<port_t>(0x0043_u16)};
31 constexpr auto PIT_CHANNEL_0 {static_cast<port_t>(0x0040_u16)};
32 // (channels 1 and 2 - ports 0x41 and 0x42 - are not used)
33
34
36 namespace {
37
39 struct pit_t {
40 igros_usize_t ticks {0_usize};
43 };
44
45 } // namespace
46
48 constinit static pit_t pit {};
49
50
51 // Setup PIT frequency
52 void pitSetupFrequency(const igros_word_t frequency) noexcept {
53
54 // Lowest frequency which divisor fits into 16 bits (~19 Hz)
55 constexpr auto PIT_MIN_FREQUENCY {static_cast<igros_word_t>((PIT_MAIN_FREQUENCY / 0xFFFF_u32) + 1_u32)};
56 // Clamp requested frequency (also prevents division by zero)
57 const auto requested {(frequency < PIT_MIN_FREQUENCY) ? PIT_MIN_FREQUENCY : frequency};
58
59 // Calculate PIT divisor (Base PIT frequency / required frequency)
60 pit.divisor = static_cast<igros_word_t>(PIT_MAIN_FREQUENCY / requested);
61 // Save current real frequency value
62 pit.frequency = static_cast<igros_word_t>(PIT_MAIN_FREQUENCY / pit.divisor);
63
64 // Channel 0, low then high byte, mode 2 (rate generator: counter runs from divisor
65 // down to 1 once per period, so elapsed ticks are divisor - counter; mode 3 runs it twice)
67 // Set divisor (LOW first, then HIGH)
68 io::writePort8(PIT_CHANNEL_0, static_cast<igros_byte_t>(pit.divisor & 0x00FF_u16));
69 io::writePort8(PIT_CHANNEL_0, static_cast<igros_byte_t>((static_cast<igros_dword_t>(pit.divisor) >> 8) & 0x00FF_u32));
70
71 // Print
73 "PIT frequency:\t%d Hz\n",
74 pit.frequency
75 );
76 }
77
78
79 // Get expired ticks
80 [[nodiscard]]
81 auto pitGetTicks() noexcept -> igros_quad_t {
82 // Send latch command for channel 0
84 // Get current counter value (counts down from divisor)
85 const auto loByte {io::readPort8(PIT_CHANNEL_0)};
86 const auto hiByte {io::readPort8(PIT_CHANNEL_0)};
87 const auto counter {static_cast<igros_word_t>((static_cast<igros_dword_t>(hiByte) << 8) | loByte)};
88 // Total elapsed ticks value since IRQ
89 const auto elapsed {static_cast<igros_word_t>(pit.divisor - counter)};
90 // Return full expired ticks count
91 return (static_cast<igros_quad_t>(pit.ticks) * pit.divisor) + elapsed;
92 }
93
94
97 static void pitInterruptHandler([[maybe_unused]] const register_t* regs) noexcept {
98 // Count every tick (pitGetTicks() relies on it, regardless of output below)
99 ++pit.ticks;
100 // Output every N-th tick were N = frequency
101 if ((0_u16 != pit.frequency) && (0_usize == (pit.ticks % pit.frequency))) [[unlikely]] {
102 // Current time to HH:MM:SS.zzz
103 const auto elapsed {pitGetTicks()};
104 const auto res {klib::kdivmod(elapsed, PIT_MAIN_FREQUENCY)};
105 // Remainder is in PIT ticks (< PIT_MAIN_FREQUENCY, so * 1000 fits 32 bits)
106 const auto milliseconds {static_cast<igros_dword_t>(res.remainder) * 1000_u32 / PIT_MAIN_FREQUENCY};
107 const auto seconds {static_cast<igros_dword_t>(res.quotient)};
108 const auto minutes {seconds / 60_u32};
109 const auto hours {minutes / 60_u32};
110 // Debug date/time
112 "IRQ #%u\t[PIT]\n"
113 "Time:\t%02d:%02d:%02d.%03d (~1 sec.)\n",
114 static_cast<igros_dword_t>(irq_t::PIT),
115 hours % 24_u32,
116 minutes % 60_u32,
117 seconds % 60_u32,
118 milliseconds
119 );
120 }
121 }
122
123
124 // Setup programmable interrupt timer
125 [[nodiscard]]
126 auto pitSetup() noexcept -> bool {
127
128 // Setup PIT frequency to 100 HZ
130
131 // Install PIT interrupt handler
133 // Unmask PIT interrupts
134 irq::unmask(irq_t::PIT);
135
136 // Success
137 return true;
138 }
139
140
141} // namespace igros::arch
142
static auto readPort8(const port_t addr) noexcept -> igros_byte_t
Read byte from port.
Definition io.hpp:160
static void writePort8(const port_t addr, const igros_byte_t value) noexcept
Write byte to port.
Definition io.hpp:178
static void install() noexcept
Install IRQ handler.
Definition irq.hpp:199
static void unmask(const irq_t number) noexcept
Unmask interrupt.
Definition irq.cpp:85
std::uint16_t igros_word_t
16-bit unsigned integer
Definition types.hpp:42
std::size_t igros_usize_t
Unsigned size.
Definition types.hpp:51
std::uint8_t igros_byte_t
8-bit unsigned integer
Definition types.hpp:41
std::uint32_t igros_dword_t
32-bit unsigned integer
Definition types.hpp:43
std::uint64_t igros_quad_t
64-bit unsigned integer
Definition types.hpp:44
I/O operations.
Architecture interrupts type deduction.
Kernel math functions definitions.
Kernel text print functions.
Architecture-independent interface: drivers and aliases of current architecture types.
static void pitInterruptHandler(const register_t *regs) noexcept
PIT interrupt (#0) handler.
Definition pit.cpp:97
void pitSetupFrequency(const igros_word_t frequency) noexcept
Setup PIT frequency.
Definition pit.cpp:52
constexpr auto PIT_CHANNEL_0
Channel 0 data port (system timer).
Definition pit.cpp:31
constexpr auto PIT_MAIN_FREQUENCY
PIT frequency (1.193181(3) MHz).
Definition pit.hpp:25
constexpr auto PIT_CONTROL
Mode/command register.
Definition pit.cpp:30
auto pitGetTicks() noexcept -> igros_quad_t
Get expired ticks.
Definition pit.cpp:81
constexpr auto PIT_DEFAULT_FREQUENCY
Default pit frequency (100 Hz).
Definition pit.hpp:27
static constinit pit_t pit
PIT state.
Definition pit.cpp:48
auto pitSetup() noexcept -> bool
Setup programmable interrupt timer.
Definition pit.cpp:126
void kprintf(const char *const format,...) noexcept
Kernel printf function (arguments are checked against format at compile time).
Definition kPrint.cpp:358
constexpr auto kdivmod(const T dividend, const D divisor) noexcept -> divmod_t< T >
Divide integer by integer of the same signedness.
Definition kMath.hpp:115
igros_word_t port_t
Define port data type which is 16bit word.
Definition io.hpp:25
Programmable interrupt timer.
Architecture register type deduction.
igros_word_t divisor
Current divisor.
Definition pit.cpp:42
igros_usize_t ticks
IRQ ticks count.
Definition pit.cpp:40
igros_word_t frequency
Current frequency.
Definition pit.cpp:41
x86_64 task switch registers save
Definition register.hpp:32
Common C++ types redefinition.