IgrOS-Kernel 0.1.34.545
Simple C++20 Kernel for i386/x86_64
Loading...
Searching...
No Matches
rtc.cpp
Go to the documentation of this file.
1
11
12
13// IgrOS-Kernel arch
14#include <arch/io.hpp>
15// IgrOS-Kernel drivers
16#include <drivers/clock/rtc.hpp>
17// IgrOS-Kernel library
18#include <klib/kFlags.hpp>
19#include <klib/kPrint.hpp>
20
21
22// Arch-dependent code zone
23namespace igros::arch {
24
25
26 // CMOS ports
27 constexpr auto CMOS_COMMAND {static_cast<port_t>(0x0070_u16)};
28 constexpr auto CMOS_DATA {static_cast<port_t>(CMOS_COMMAND + 1_u16)};
29
30
31 // Clock from RTC conversion
32 [[nodiscard]]
33 auto clockFromRTC(const rtcDateTime_t &rtcDateTime, const igros_dword_t century) noexcept -> clockDateTime_t {
34 return clockDateTime_t {
35 .year = rtcDateTime.date.year + century,
36 .month = rtcDateTime.date.month,
37 .day = rtcDateTime.date.day,
38 .weekday = rtcDateTime.weekday,
39 .hour = rtcDateTime.time.hour,
40 .minute = rtcDateTime.time.minute,
41 .second = rtcDateTime.time.second,
42 };
43 }
44
45
46 // RTC date/time commands
47 constexpr auto RTC_YEAR {0x09_u8};
48 constexpr auto RTC_MONTH {0x08_u8};
49 constexpr auto RTC_DAY {0x07_u8};
50 constexpr auto RTC_WEEKDAY {0x06_u8};
51 constexpr auto RTC_HOUR {0x04_u8};
52 constexpr auto RTC_MINUTE {0x02_u8};
53 constexpr auto RTC_SECOND {0x00_u8};
54
55 constexpr auto RTC_CENTURY {0x32_u8};
56
57 constexpr auto RTC_REGISTER_A {0x0A_u8};
58 constexpr auto RTC_REGISTER_B {0x0B_u8};
59
61 namespace {
62
64 enum class RTC_A : igros_byte_t {
65 UPDATING = 0x80_u8,
66 };
67
69 enum class RTC_B : igros_byte_t {
70 TIME_24 = 0x02_u8,
71 BINARY = 0x04_u8,
72 };
73
74 } // namespace
75
76
77 // Read CMOS register
78 [[nodiscard]]
79 auto rtcRead(const igros_byte_t cmd) noexcept -> igros_byte_t {
80 // Write command
82 // Read data
84 }
85
86 // Read CMOS date
87 [[nodiscard]]
88 auto rtcReadDate() noexcept -> rtcDate_t {
89 return rtcDate_t {
90 .year = rtcRead(RTC_YEAR),
91 .month = rtcRead(RTC_MONTH),
92 .day = rtcRead(RTC_DAY),
93 };
94 }
95
96 // Read CMOS time
97 [[nodiscard]]
98 auto rtcReadTime() noexcept -> rtcTime_t {
99 return rtcTime_t {
100 .hour = rtcRead(RTC_HOUR),
101 .minute = rtcRead(RTC_MINUTE),
102 .second = rtcRead(RTC_SECOND),
103 };
104 }
105
106 // Read CMOS date/time
107 [[nodiscard]]
108 auto rtcReadDateTime() noexcept -> rtcDateTime_t {
109 return rtcDateTime_t {
110 .date = rtcReadDate(),
111 .weekday = rtcRead(RTC_WEEKDAY),
112 .time = rtcReadTime(),
113 };
114 }
115
116
117 // Convert BCD to binary
118 [[nodiscard]]
119 auto rtcFromBCD(const igros_byte_t bcd) noexcept -> igros_byte_t {
120 const auto value {static_cast<igros_dword_t>(bcd)};
121 return static_cast<igros_byte_t>((value & 0x0F_u32) + (((value >> 4) & 0x0F_u32) * 10_u32));
122 }
123
124 // Convert BCD date to binary
125 void rtcDateFromBCD(rtcDate_t &date) noexcept {
126 date.year = rtcFromBCD(date.year);
127 date.month = rtcFromBCD(date.month);
128 date.day = rtcFromBCD(date.day);
129 }
130
131 // Convert BCD time to binary
132 void rtcTimeFromBCD(rtcTime_t &time) noexcept {
133 time.hour = rtcFromBCD(time.hour);
134 time.minute = rtcFromBCD(time.minute);
135 time.second = rtcFromBCD(time.second);
136 }
137
138 // Convert BCD date/time to binary
139 void rtcDateTimeFromBCD(rtcDateTime_t &dateTime) noexcept {
140 rtcDateFromBCD(dateTime.date);
141 rtcTimeFromBCD(dateTime.time);
142 }
143
144 // Get current date/time
146 // Read CMOS date/time (once no update is in progress)
147 const auto readStable = []() noexcept {
148 while (klib::kFlags<RTC_A>::from(rtcRead(RTC_REGISTER_A)).isSet(RTC_A::UPDATING)) {
149 // Wait for update end
150 }
151 return rtcReadDateTime();
152 };
153 auto rtcDateTime {readStable()};
154 auto lastDateTime {readStable()};
155 // Re-read until two reads match (update could happen between registers reads)
156 while (lastDateTime != rtcDateTime) {
157 lastDateTime = rtcDateTime;
158 rtcDateTime = readStable();
159 }
160 // Get RTC flags
162 // Get RTC century
163 auto century {rtcRead(RTC_CENTURY)};
164 // Check data format
165 if (!flags.isSet(RTC_B::BINARY)) {
166 // Chech hours format
167 const auto hourModeBit {static_cast<igros_byte_t>(rtcDateTime.time.hour & 0x80_u8)};
168 // Drop highest bit from hours
169 rtcDateTime.time.hour &= 0x7F_u8;
170 // Convert from BCD
171 rtcDateTimeFromBCD(rtcDateTime);
172 // Return highest bit to hours
173 rtcDateTime.time.hour |= hourModeBit;
174 // Convert century to BCD
175 century = rtcFromBCD(century);
176 }
177 // Check 12-hours format (1..12, bit 7 - PM)
178 if (!flags.isSet(RTC_B::TIME_24)) {
179 const auto isPM {0x00_u8 != (0x80_u8 & rtcDateTime.time.hour)};
180 // 12 AM -> 0, 12 PM -> 12
181 rtcDateTime.time.hour = static_cast<igros_byte_t>(((rtcDateTime.time.hour & 0x7F_u8) % 12_u8) + (isPM ? 12_u8 : 0_u8));
182 }
183 // Convert RTC to clock
184 return clockFromRTC(rtcDateTime, ((0x00_u8 != century) ? (century * 100_u32) : 2000_u32));
185 }
186
187
188 // Setup RTC function
189 [[nodiscard]]
190 auto rtcSetup() noexcept -> bool {
191 // Get current date/time
192 const auto dateTime {clockGetCurrentDateTime()};
193 // Print result
195 "RTC date/time:\t%02d.%02d.%04d %02d:%02d:%02d",
196 dateTime.day,
197 dateTime.month,
198 dateTime.year,
199 dateTime.hour,
200 dateTime.minute,
201 dateTime.second
202 );
203 // Success
204 return true;
205 }
206
207
208} // namespace igros::arch
209
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 constexpr auto from(const U value) noexcept -> kFlags
From raw value (hardware register, table entry).
Definition kFlags.hpp:55
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
I/O operations.
Bit flags template datatype.
Kernel text print functions.
@ UPDATING
Date/time update in progress (values unstable).
Definition rtc.cpp:65
@ TIME_24
24-hour format (12-hour otherwise, bit 7 of hour - PM)
Definition rtc.cpp:70
@ BINARY
Binary values (BCD otherwise).
Definition rtc.cpp:71
Architecture-independent interface: drivers and aliases of current architecture types.
auto rtcReadDateTime() noexcept -> rtcDateTime_t
Read CMOS date/time.
Definition rtc.cpp:108
constexpr auto RTC_REGISTER_B
Status register B.
Definition rtc.cpp:58
auto clockFromRTC(const rtcDateTime_t &rtcDateTime, const igros_dword_t century) noexcept -> clockDateTime_t
Clock from RTC conversion.
Definition rtc.cpp:33
constexpr auto RTC_WEEKDAY
Day of week register.
Definition rtc.cpp:50
constexpr auto CMOS_DATA
Data port.
Definition rtc.cpp:28
void rtcTimeFromBCD(rtcTime_t &time) noexcept
Convert BCD time to binary.
Definition rtc.cpp:132
constexpr auto RTC_YEAR
Year register.
Definition rtc.cpp:47
auto rtcReadTime() noexcept -> rtcTime_t
Read CMOS time.
Definition rtc.cpp:98
constexpr auto RTC_MONTH
Month register.
Definition rtc.cpp:48
constexpr auto RTC_DAY
Day of month register.
Definition rtc.cpp:49
auto rtcRead(const igros_byte_t cmd) noexcept -> igros_byte_t
Read CMOS register.
Definition rtc.cpp:79
auto rtcFromBCD(const igros_byte_t bcd) noexcept -> igros_byte_t
Convert BCD to binary.
Definition rtc.cpp:119
constexpr auto RTC_HOUR
Hour register.
Definition rtc.cpp:51
constexpr auto RTC_SECOND
Second register.
Definition rtc.cpp:53
void rtcDateTimeFromBCD(rtcDateTime_t &dateTime) noexcept
Convert BCD date/time to binary.
Definition rtc.cpp:139
constexpr auto RTC_MINUTE
Minute register.
Definition rtc.cpp:52
auto clockGetCurrentDateTime() noexcept -> clockDateTime_t
Get current date/time.
Definition rtc.cpp:145
constexpr auto RTC_REGISTER_A
Status register A.
Definition rtc.cpp:57
constexpr auto CMOS_COMMAND
Register select port.
Definition rtc.cpp:27
auto rtcSetup() noexcept -> bool
Setup RTC function.
Definition rtc.cpp:190
auto rtcReadDate() noexcept -> rtcDate_t
Read CMOS date.
Definition rtc.cpp:88
constexpr auto RTC_CENTURY
Century register (ACPI FADT default).
Definition rtc.cpp:55
void rtcDateFromBCD(rtcDate_t &date) noexcept
Convert BCD date to binary.
Definition rtc.cpp:125
void kprintf(const char *const format,...) noexcept
Kernel printf function (arguments are checked against format at compile time).
Definition kPrint.cpp:358
igros_word_t port_t
Define port data type which is 16bit word.
Definition io.hpp:25
RTC clock driver.
Date/time structure.
Definition rtc.hpp:25
RTC date/time.
Definition rtc.hpp:57