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

Update doxygen comments and formatting
All checks were successful
Builds / ExectOS (i686, debug) (push) Successful in 37s
Details
Builds / ExectOS (amd64, debug) (push) Successful in 39s
Details
Builds / ExectOS (amd64, release) (push) Successful in 49s
Details
Builds / ExectOS (i686, release) (push) Successful in 46s
Details

Browse Source
This commit is contained in:
Aiken Harris
2026-05-20 20:52:52 +02:00
parent fe2e78f3c7
commit 72a03f641d
22 changed files with 72 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
xtoskrnl/mm/alloc.cc
View File

@@ -18,7 +18,7 @@
* @param Memory
* Supplies a pointer to the allocated pool of pages.
*
* @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
*/
@@ -192,7 +192,7 @@ MM::Allocator::AllocateNonPagedPoolPages(IN PFN_COUNT Pages,
* @param Memory
* Supplies a pointer to the allocated pool of pages.
*
* @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
*/
@@ -219,7 +219,7 @@ MM::Allocator::AllocatePagedPoolPages(IN PFN_COUNT Pages,
* @param Memory
* Supplies a pointer to the allocated pool of pages.
*
* @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
*/
@@ -271,7 +271,7 @@ MM::Allocator::AllocatePages(IN MMPOOL_TYPE PoolType,
* @param Memory
* Supplies a pointer to the allocated memory.
*
* @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
*/
@@ -300,7 +300,7 @@ MM::Allocator::AllocatePool(IN MMPOOL_TYPE PoolType,
* @param Tag
* Specifies the allocation identifying tag.
*
* @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
*/
@@ -737,7 +737,7 @@ MM::Allocator::ExpandBigAllocationsTable(VOID)
* @param PagesFreed
* Supplies a pointer to a variable that will receive the number of pages freed.
*
* @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
*/
@@ -985,7 +985,7 @@ MM::Allocator::FreeNonPagedPoolPages(IN PVOID VirtualAddress,
* @param PagesFreed
* Supplies a pointer to a variable that will receive the number of pages freed.
*
* @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
*/
@@ -1006,7 +1006,7 @@ MM::Allocator::FreePagedPoolPages(IN PVOID VirtualAddress,
* @param VirtualAddress
* Supplies the base virtual address of the pages allocation to free.
*
* @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
*/
@@ -1026,7 +1026,7 @@ MM::Allocator::FreePages(IN PVOID VirtualAddress)
* @param PagesFreed
* Supplies a pointer to a variable that will receive the number of pages freed.
*
* @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
*/
@@ -1059,7 +1059,7 @@ MM::Allocator::FreePages(IN PVOID VirtualAddress,
* @param VirtualAddress
* Supplies the base virtual address of the pool allocation to free.
*
* @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
*/
@@ -1080,7 +1080,7 @@ MM::Allocator::FreePool(IN PVOID VirtualAddress)
* @param Tag
* Specifies the allocation identifying tag.
*
* @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
*/

4
xtoskrnl/mm/amd64/pagemap.cc
View File

@@ -18,7 +18,7 @@
* @param Count
* The number of PTE entries to advance by.
*
* @return The advanced PTE pointer.
* @return This routine returns the advanced PTE pointer.
*
* @since XT 1.0
*/
@@ -96,7 +96,7 @@ MM::PageMap::GetNextEntry(IN PMMPTE Pte)
* @param Pte
* The PTE pointer to advance.
*
* @return The advanced PTE pointer.
* @return This routine returns the advanced PTE pointer.
*
* @since XT 1.0
*/

2
xtoskrnl/mm/amd64/paging.cc
View File

@@ -109,7 +109,7 @@ MM::Paging::GetPxeVirtualAddress(IN PMMPXE PxePointer)
* @param Attributes
* Specifies the attributes (protections, caching) to apply to the PTE.
*
* @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
*/

2
xtoskrnl/mm/amd64/pfault.cc
View File

@@ -16,6 +16,8 @@
* Specifies the virtual address to verify.
*
* @return This routine returns ACCESS_VIOLATION regardless PML4 or PML5 is used.
*
* @since XT 1.0
*/
XTFASTCALL
XTSTATUS

8
xtoskrnl/mm/hlpool.cc
View File

@@ -25,7 +25,7 @@
* @param Buffer
* Supplies a buffer that receives the physical address.
*
* @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
*/
@@ -153,7 +153,7 @@ MM::HardwarePool::AllocateHardwareMemory(IN PFN_NUMBER PageCount,
* @param MemoryAddress
* Supplies a pointer to a variable that receives the identity-mapped virtual address of the allocated memory.
*
* @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
*/
@@ -207,7 +207,7 @@ MM::HardwarePool::AllocateRealModeMemory(IN PFN_NUMBER PageCount,
* @param VirtualAddress
* Supplies a buffer that receives the virtual address of the mapped pages.
*
* @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
*/
@@ -374,7 +374,7 @@ MM::HardwarePool::RemapHardwareMemory(IN PVOID VirtualAddress,
* @param FlushTlb
* Specifies whether to flush the TLB or not.
*
* @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
*/

10
xtoskrnl/mm/i686/pagemap.cc
View File

@@ -251,7 +251,7 @@ MM::PageMapBasic::GetNextEntry(IN PMMPTE Pte)
* @param Pte
* The PTE pointer to advance.
*
* @return The advanced PTE pointer.
* @return This routine returns the advanced PTE pointer.
*
* @since XT 1.0
*/
@@ -472,7 +472,7 @@ MM::PageMapBasic::InitializePageMapInfo(VOID)
* @param PtePointer
* Pointer to the page table entry (PTE) to check.
*
* @return Returns TRUE if the entry is valid, FALSE otherwise.
* @return This routine returns TRUE if the entry is valid, FALSE otherwise.
*
* @since XT 1.0
*/
@@ -666,7 +666,7 @@ MM::PageMapBasic::WritePte(IN PMMPTE Pte,
* @param Count
* The number of PTE entries to advance by.
*
* @return The advanced PTE pointer.
* @return This routine returns the advanced PTE pointer.
*
* @since XT 1.0
*/
@@ -721,7 +721,7 @@ MM::PageMapXpa::GetNextEntry(IN PMMPTE Pte)
* @param Pte
* The PTE pointer to advance.
*
* @return The advanced PTE pointer.
* @return This routine returns the advanced PTE pointer.
*
* @since XT 1.0
*/
@@ -942,7 +942,7 @@ MM::PageMapXpa::InitializePageMapInfo(VOID)
* @param PtePointer
* Pointer to the page table entry (PTE) to check.
*
* @return Returns TRUE if the entry is valid, FALSE otherwise.
* @return This routine returns TRUE if the entry is valid, FALSE otherwise.
*
* @since XT 1.0
*/

2
xtoskrnl/mm/i686/paging.cc
View File

@@ -37,7 +37,7 @@ MM::Paging::GetExtendedPhysicalAddressingStatus(VOID)
* @param Attributes
* Specifies the attributes (protections, caching) to apply to the PTE.
*
* @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
*/

4
xtoskrnl/mm/kpool.cc
View File

@@ -19,7 +19,7 @@
* @param StackSize
* Supplies the size of the stack to be allocated, in bytes.
*
* @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
*/
@@ -95,7 +95,7 @@ MM::KernelPool::AllocateKernelStack(OUT PVOID *Stack,
* @param StructuresData
* Supplies a pointer to the memory area that will contain the allocated buffer.
*
* @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
*/

2
xtoskrnl/mm/mmgr.cc
View File

@@ -285,7 +285,7 @@ MM::Manager::InitializeMemoryManager(VOID)
/**
* Allocates and maps the Kernel Shared Data page to its hardcoded virtual address.
*
* @return This routine returns status code.
* @return This routine returns a status code indicating the success or failure of the operation.
*
* @since XT 1.0
*/

6
xtoskrnl/mm/paging.cc
View File

@@ -18,7 +18,7 @@
* @param Count
* The number of PTE entries to advance by.
*
* @return The advanced PTE pointer.
* @return This routine returns the advanced PTE pointer.
*
* @since XT 1.0
*/
@@ -158,7 +158,7 @@ MM::Paging::GetNextEntry(IN PMMPTE Pte)
* @param Pte
* The PTE pointer to advance.
*
* @return The advanced PTE pointer.
* @return This routine returns the advanced PTE pointer.
*
* @since XT 1.0
*/
@@ -517,7 +517,7 @@ MM::Paging::InitializePageMapSupport(VOID)
* @param PtePointer
* Pointer to the page table entry (PTE) to check.
*
* @return Returns TRUE if the entry is valid, FALSE otherwise.
* @return This routine returns TRUE if the entry is valid, FALSE otherwise.
*
* @since XT 1.0
*/

2
xtoskrnl/mm/pfn.cc
View File

@@ -390,7 +390,7 @@ MM::Pfn::GetHighestPhysicalPage(VOID)
/**
* Retrieves the total number of physical pages managed by the system.
*
* @return Returns the total count of physical memory pages.
* @return This routine returns the total count of physical memory pages.
*
* @since XT 1.0
*/