xt-sys/exectos
3
5
Fork 2
Code Issues 4 Pull Requests Actions Projects 1 Releases Wiki Activity

Update doxygen comments for RTC and timer functions
All checks were successful
Builds / ExectOS (amd64, debug) (push) Successful in 29s
Details
Builds / ExectOS (i686, release) (push) Successful in 32s
Details
Builds / ExectOS (amd64, release) (push) Successful in 45s
Details
Builds / ExectOS (i686, debug) (push) Successful in 42s
Details

Browse Source
This commit is contained in:
Aiken Harris
2026-05-18 20:16:49 +02:00
parent 24c9ae321c
commit f2c70d582a
2 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
xtoskrnl/hl/x86/rtc.cc
View File

@@ -15,7 +15,7 @@
* @param Time * @param Time
* Supplies a pointer to a structure to receive the system time. * Supplies a pointer to a structure to receive the system time.
* *
* @return This routine returns the status code. * @return This routine returns a status code indicating the success or failure of the operation.
* *
* @since XT 1.0 * @since XT 1.0
*/ */
@@ -192,7 +192,7 @@ HL::Rtc::GetRealTimeClock(OUT PTIME_FIELDS Time)
* @param Time * @param Time
* Supplies a pointer to a structure with populated data and time. * Supplies a pointer to a structure with populated data and time.
* *
* @return This routine returns the status code. * @return This routine returns a status code indicating the success or failure of the operation.
* *
* @since XT 1.0 * @since XT 1.0
*/ */

12
xtoskrnl/hl/x86/timer.cc
View File

@@ -12,7 +12,7 @@
/** /**
* Calibrates the Local APIC timer frequency. * Calibrates the Local APIC timer frequency.
* *
* @return This routine returns a status code. * @return This routine returns a status code indicating the success or failure of the operation.
* *
* @since XT 1.0 * @since XT 1.0
*/ */
@@ -104,6 +104,10 @@ HL::Timer::CalibrateTscCounter(VOID)
* *
* @param HardwareDivider * @param HardwareDivider
* Supplies the programmed threshold/divider for the interrupt generation. * Supplies the programmed threshold/divider for the interrupt generation.
*
* @return This routine does not return any value.
*
* @since XT 1.0
*/ */
XTAPI XTAPI
VOID VOID
@@ -124,7 +128,7 @@ HL::Timer::ConfigureTimeIncrement(IN ULONGLONG BaseFrequency, IN ULONGLONG Hardw
* Initializes the High Precision Event Timer (HPET) by discovering its ACPI configuration and mapping * Initializes the High Precision Event Timer (HPET) by discovering its ACPI configuration and mapping
* its hardware registers into the kernel's virtual address space. * its hardware registers into the kernel's virtual address space.
* *
* @return This routine returns a status code. * @return This routine returns a status code indicating the success or failure of the operation.
* *
* @since XT 1.0 * @since XT 1.0
*/ */
@@ -388,7 +392,7 @@ HL::Timer::InitializeApicTimer(VOID)
/** /**
* Initializes the High Precision Event Timer (HPET) Timer. * Initializes the High Precision Event Timer (HPET) Timer.
* *
* @return This routine returns a status code. * @return This routine returns a status code indicating the success or failure of the operation.
* *
* @since XT 1.0 * @since XT 1.0
*/ */
@@ -446,7 +450,7 @@ HL::Timer::InitializeHpetTimer(VOID)
/** /**
* Initializes the legacy Programmable Interval Timer (PIT). * Initializes the legacy Programmable Interval Timer (PIT).
* *
* @return This routine returns a status code. * @return This routine returns a status code indicating the success or failure of the operation.
* *
* @since XT 1.0 * @since XT 1.0
*/ */