mirror of
https://github.com/xomboverlord/xomb-docs.git
synced 2026-03-28 06:49:04 +01:00
Adds kernel docs.
This commit is contained in:
wilkie
38
kernel/system/bootinfo.html
Normal file
38
kernel/system/bootinfo.html
Normal file
@@ -0,0 +1,38 @@
|
||||
<html><head>
|
||||
<META http-equiv="content-type" content="text/html; charset=utf-8">
|
||||
<title>kernel.system.bootinfo</title>
|
||||
</head><body>
|
||||
<h1>kernel.system.bootinfo</h1>
|
||||
<!-- Generated by Ddoc from ../kernel/system/bootinfo.d -->
|
||||
<br><br>
|
||||
<dl><dt><big>struct <u>BootInfo</u>;
|
||||
</big></dt>
|
||||
<dd>This structure will handle all requests to the information given
|
||||
by the bootloader. It makes no assumptions about which bootloader
|
||||
is actually used by the system.<br><br>
|
||||
|
||||
<dl><dt><big>enum <u>Type</u>;
|
||||
</big></dt>
|
||||
<dd>All of the types of boot loader specifications in use, so we
|
||||
*can* make assumptions sometimes.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>static ErrorVal <u>initialize</u>(int <i>bootLoaderID</i>, void* <i>data</i>);
|
||||
</big></dt>
|
||||
<dd>This function takes in the parameters passed to kmain.
|
||||
It will pass it off to the correct module for utilization.
|
||||
<br><br>
|
||||
<b>Params:</b><br>
|
||||
<table><tr><td>int <i>bootLoaderID</i></td>
|
||||
<td>the id the bootloader passes to identify itself.</td></tr>
|
||||
<tr><td>void* <i>data</i></td>
|
||||
<td>the payload point the bootloader passes with system info.</td></tr>
|
||||
</table><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<hr><small>Page generated by <a href="http://www.digitalmars.com/d/1.0/ddoc.html">Ddoc</a>. </small>
|
||||
</body></html>
|
||||
126
kernel/system/definitions.html
Normal file
126
kernel/system/definitions.html
Normal file
@@ -0,0 +1,126 @@
|
||||
<html><head>
|
||||
<META http-equiv="content-type" content="text/html; charset=utf-8">
|
||||
<title>kernel.system.definitions</title>
|
||||
</head><body>
|
||||
<h1>kernel.system.definitions</h1>
|
||||
<!-- Generated by Ddoc from ../kernel/system/definitions.d -->
|
||||
<br><br>
|
||||
<dl><dt><big>struct <u>Memory</u>;
|
||||
</big></dt>
|
||||
<dd>This structure keeps track of information pertaining to onboard memory.<br><br>
|
||||
|
||||
<dl><dt><big>ulong <u>length</u>;
|
||||
</big></dt>
|
||||
<dd>The size of the RAM.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>void* <u>virtualStart</u>;
|
||||
</big></dt>
|
||||
<dd>The Virtual location of RAM.<br><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt><big>struct <u>Module</u>;
|
||||
</big></dt>
|
||||
<dd>This structure keeps track of modules loaded alongside the kernel.<br><br>
|
||||
|
||||
<dl><dt><big>PhysicalAddress <u>start</u>;
|
||||
</big></dt>
|
||||
<dd>The physical location of the module.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>ulong <u>length</u>;
|
||||
</big></dt>
|
||||
<dd>The <u>length</u> of the module.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>char[] <u>name</u>;
|
||||
</big></dt>
|
||||
<dd>The <u>name</u> of the module, if given.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>char[] <u>path</u>;
|
||||
</big></dt>
|
||||
<dd>The <u>path</u> to this module on the file system.<br><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt><big>enum <u>RegionType</u>;
|
||||
</big></dt>
|
||||
<dd>This enum is for the Region structure
|
||||
It contains human-read information about the type of region.<br><br>
|
||||
|
||||
<dl><dt><big><u>Reserved</u></big></dt>
|
||||
<dd>The region is special reserved data from the BIOS<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big><u>Kernel</u></big></dt>
|
||||
<dd>This signifies that this region is the kernel<br><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt><big>struct <u>Region</u>;
|
||||
</big></dt>
|
||||
<dd>This structure keeps track of special memory regions.<br><br>
|
||||
|
||||
<dl><dt><big>PhysicalAddress <u>start</u>;
|
||||
</big></dt>
|
||||
<dd>The location and length of the region<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>ubyte* <u>virtualStart</u>;
|
||||
</big></dt>
|
||||
<dd>The virtual location of the region<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>RegionType <u>type</u>;
|
||||
</big></dt>
|
||||
<dd>The <u>type</u> of region. See above for a list of values.<br><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt><big>struct <u>Disk</u>;
|
||||
</big></dt>
|
||||
<dd>This structure keeps information about the disks found in the system.<br><br>
|
||||
|
||||
<dl><dt><big>ulong <u>number</u>;
|
||||
</big></dt>
|
||||
<dd>Some identifing <u>number</u> for the drive, as reported by the system.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>ulong <u>cylinders</u>;
|
||||
</big></dt>
|
||||
<dd>Typical information about a mechanical hard disk.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>uint <u>numPorts</u>;
|
||||
</big></dt>
|
||||
<dd>The ports used to communicate with the disk, if any.<br><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt><big>struct <u>Processor</u>;
|
||||
</big></dt>
|
||||
<dd>This structure stores information about the processors available
|
||||
in the system.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>struct <u>Cache</u>;
|
||||
</big></dt>
|
||||
<dd>This structure stores information about processor caches available.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>struct <u>Device</u>;
|
||||
</big></dt>
|
||||
<dd>This structure stores information about known devices on the system.<br><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<hr><small>Page generated by <a href="http://www.digitalmars.com/d/1.0/ddoc.html">Ddoc</a>. </small>
|
||||
</body></html>
|
||||
59
kernel/system/info.html
Normal file
59
kernel/system/info.html
Normal file
@@ -0,0 +1,59 @@
|
||||
<html><head>
|
||||
<META http-equiv="content-type" content="text/html; charset=utf-8">
|
||||
<title>kernel.system.info</title>
|
||||
</head><body>
|
||||
<h1>kernel.system.info</h1>
|
||||
<!-- Generated by Ddoc from ../kernel/system/info.d -->
|
||||
<br><br>
|
||||
<dl><dt><big>struct <u>System</u>;
|
||||
</big></dt>
|
||||
<dd>This structure holds information about the system.<br><br>
|
||||
|
||||
<dl><dt><big>static Memory <u>memory</u>;
|
||||
</big></dt>
|
||||
<dd>The information about RAM.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>static Region <u>kernel</u>;
|
||||
</big></dt>
|
||||
<dd>This region is specifically the <u>kernel</u> memory.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>static uint <u>numRegions</u>;
|
||||
</big></dt>
|
||||
<dd>Information about specific memory regions.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>static uint <u>numModules</u>;
|
||||
</big></dt>
|
||||
<dd>Information about modules that have been loaded
|
||||
during the boot process.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>static uint <u>numDisks</u>;
|
||||
</big></dt>
|
||||
<dd>Information about disks available to the system.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>static uint <u>numProcessors</u>;
|
||||
</big></dt>
|
||||
<dd>Information about each processor available.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>static uint <u>numDevices</u>;
|
||||
</big></dt>
|
||||
<dd>Information about generic devices available on the system.<br><br>
|
||||
|
||||
</dd>
|
||||
<dt><big>static char[128LU] <u>cmdlineStorage</u>;
|
||||
</big></dt>
|
||||
<dd>Information about how the kernel was invoked by the bootloader.
|
||||
This generally contains command line arguments from GRUB, for instance.<br><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<hr><small>Page generated by <a href="http://www.digitalmars.com/d/1.0/ddoc.html">Ddoc</a>. </small>
|
||||
</body></html>
|
||||
18
kernel/system/multiboot.html
Normal file
18
kernel/system/multiboot.html
Normal file
@@ -0,0 +1,18 @@
|
||||
<html><head>
|
||||
<META http-equiv="content-type" content="text/html; charset=utf-8">
|
||||
<title>kernel.system.multiboot</title>
|
||||
</head><body>
|
||||
<h1>kernel.system.multiboot</h1>
|
||||
<!-- Generated by Ddoc from ../kernel/system/multiboot.d -->
|
||||
<br><br>
|
||||
<dl><dt><big>const int <u>MULTIBOOT_HEADER_MAGIC</u>;
|
||||
</big></dt>
|
||||
<dd>These two magic numbers are
|
||||
defined in the multiboot spec, we use them
|
||||
to verify that our environment is sane.<br><br>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<hr><small>Page generated by <a href="http://www.digitalmars.com/d/1.0/ddoc.html">Ddoc</a>. </small>
|
||||
</body></html>
|
||||
Reference in New Issue
Block a user