Asuro/doc/index.html

371 lines
19 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>Asuro: All Units</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.15.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Asuro</h2><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p><p><a href="GVUses.png" class="navigation">Unit dependency graph</a></p><form class="search-form" action="_tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input"></div><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></form>
<div style="clear: both"></div>
<script type="text/javascript">
$(document).ready(function() {
$('#tipue_search_input').tipuesearch({
/* 10 items to display seems standard */
'show': 10,
/* For PasDoc docs, showing urls is not very useful,
since the page title already shows the unit and identifier. */
'showURL': false
});
});
</script>
</td><td class="content">
<h1 class="allitems">All Units</h1>
<table class="unitstable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ACE.html">ACE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>ACE</code> - Alignment Check Exception.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="arp.html">arp</a></td>
<td class="itemdesc"><p>Driver-&gt;<a class="normal" href="net.html">Net</a>-&gt;L3-&gt;<code>ARP</code> - Address Resolution Protocol Driver.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="asuro.html">asuro</a></td>
<td class="itemdesc"><p>Include-&gt;<code>Asuro</code> - Auto-Generated <a class="normal" href="asuro.html#VERSION">Version</a> &amp; Compilation Information
<p></p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="bios_data_area.html">bios_data_area</a></td>
<td class="itemdesc"><p>Include-&gt;<code>BIOS_Data_Area</code> - Data Structures Controlled by the BIOS.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="BPE.html">BPE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>BPE</code> - Break Point Exception.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="BTSSE.html">BTSSE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>BTSSE</code> - Bad <a class="normal" href="tss.html">TSS</a> Exception.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="CFE.html">CFE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>CFE</code> - Coprocessor Fault Exception.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="console.html">console</a></td>
<td class="itemdesc"><p><code>Console</code> - Provides Screen/Window management &amp; drawing.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="contextswitcher.html">contextswitcher</a></td>
<td class="itemdesc"><p><code>ContextSwitcher</code> - Switch Process Contexts when preempted.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="cpu.html">cpu</a></td>
<td class="itemdesc"><p><code>CPU</code> - <code>CPU</code> Structures &amp; Utility/Capabilities Functions.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="crc.html">crc</a></td>
<td class="itemdesc"><p>Include-&gt;<code>CRC</code> - <a class="normal" href="crc.html#CRC32">CRC32</a> Implementation.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="CSOE.html">CSOE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>CSOE</code> - Coprocessor Seg Overruun Exception.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="DBGE.html">DBGE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>DBGE</code> - Debug Exception.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="DBZ.html">DBZ</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>DBZ</code> - Divide By Zero Exception.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="DFE.html">DFE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>DFE</code> - Double Fault Exception.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="drivermanagement.html">drivermanagement</a></td>
<td class="itemdesc"><p><code>DriverManagement</code> - Driver Initialization &amp; Management Interface.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="drivertypes.html">drivertypes</a></td>
<td class="itemdesc"><p>Driver-&gt;Include-&gt;<code>DriverTypes</code> - Structs &amp; Data Shared Across Drivers.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="E1000.html">E1000</a></td>
<td class="itemdesc"><p>Driver-&gt;NetDev-&gt;<code>E1000</code> - Intel <code>E1000</code>/I217/82577LM Network Card Driver.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="EHCI.html">EHCI</a></td>
<td class="itemdesc"><p>Driver-&gt;Bus-&gt;<code>EHCI</code> - Enhanced Host Controller Interface Driver.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="eth2.html">eth2</a></td>
<td class="itemdesc"><p>Driver-&gt;<a class="normal" href="net.html">Net</a>-&gt;L2-&gt;<code>Eth2</code> - Ethernet Driver.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="faults.html">faults</a></td>
<td class="itemdesc"><p><code>Faults</code> - Fault Registration &amp; Detouring.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="fonts.html">fonts</a></td>
<td class="itemdesc"><p>Include-&gt;<code>Fonts</code> - Standard <code>Fonts</code> &amp; Font Masks.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="gdt.html">gdt</a></td>
<td class="itemdesc"><p>Global Descriptor Table - Data Structures &amp; Interface.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="GPF.html">GPF</a></td>
<td class="itemdesc"><p>Fault-&gt;<a class="normal" href="util.html#GPF">GPF</a> - General Protection Fault.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="icmp.html">icmp</a></td>
<td class="itemdesc"><p>Driver-&gt;<a class="normal" href="net.html">Net</a>-&gt;L4-&gt;<code>ICMP</code> - Internet Control Message Protocol Driver,
<p></p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="IDOE.html">IDOE</a></td>
<td class="itemdesc"><p>Fault-&gt;IDO - Into Detected Overflow Exception.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="idt.html">idt</a></td>
<td class="itemdesc"><p>Interrupt Descriptor Table - Structures &amp; Interface.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="IOPE.html">IOPE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>IOPE</code> - Invalid OPCode Exception.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ipv4.html">ipv4</a></td>
<td class="itemdesc"><p>Driver-&gt;<a class="normal" href="net.html">Net</a>-&gt;L3-&gt;<code>IPv4</code> - Internet Protocol <a class="normal" href="asuro.html#VERSION">Version</a> 4 Driver.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="irq.html">irq</a></td>
<td class="itemdesc"><p>Interrupt Request Line - Initialization &amp; Remapping.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="isr.html">isr</a></td>
<td class="itemdesc"><p><code>ISR</code> Driver - Initialization (stub).</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="isrmanager.html">isrmanager</a></td>
<td class="itemdesc"><p><a class="normal" href="isr.html">ISR</a>-&gt;<code>ISRManager</code> - Interrupt Service Routine Registration, Dispatch &amp; Management.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="isr_types.html">isr_types</a></td>
<td class="itemdesc"><p><a class="normal" href="isr.html">ISR</a>-&gt;<code>ISR_Types</code> - Interrupt Service Routine Structures.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="kernel.html">kernel</a></td>
<td class="itemdesc"><p><code>Kernel</code> Main - Main <code>Kernel</code> Entry Point.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="keyboard.html">keyboard</a></td>
<td class="itemdesc"><p>Driver-&gt;HID-&gt;<code>Keyboard</code> - <code>Keyboard</code> Driver.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="lists.html">lists</a></td>
<td class="itemdesc"><p>Include-&gt;<code>Lists</code> - Linked List Data Structures &amp; Helpers.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="lmemorymanager.html">lmemorymanager</a></td>
<td class="itemdesc"><p><code>LMemoryManager</code> - Logical Memory Management
<p></p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="MCE.html">MCE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>MCE</code> - Machine Check Exception.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="memview.html">memview</a></td>
<td class="itemdesc"><p>Prog-&gt;<code>MemView</code> - Live Memory View.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="mouse.html">mouse</a></td>
<td class="itemdesc"><p>Driver-&gt;HID-&gt;<code>Mouse</code> - <code>Mouse</code> Driver.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="multiboot.html">multiboot</a></td>
<td class="itemdesc"><p>Include-&gt;<code>Multiboot</code> - <code>Multiboot</code> Structures &amp; Access.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="NCE.html">NCE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>NCE</code> - No Coprocessor Exception.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="net.html">net</a></td>
<td class="itemdesc"><p>Driver-&gt;<code>Net</code>-&gt;L1-&gt;<code>Net</code> - Network Card&lt;-&gt;Driver Interface.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="netlog.html">netlog</a></td>
<td class="itemdesc"><p>Prog-&gt;<code>NetLog</code> - Network Driver Logs.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="nettypes.html">nettypes</a></td>
<td class="itemdesc"><p>Driver-&gt;<a class="normal" href="net.html">Net</a>-&gt;<code>NetTypes</code> - Structures &amp; <a class="normal" href="types.html">Types</a> Shared Across Network Drivers.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="netutils.html">netutils</a></td>
<td class="itemdesc"><p>Driver-&gt;<a class="normal" href="net.html">Net</a>-&gt;<code>NetUtils</code> - Helper Functions For Network Drivers.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="NMIE.html">NMIE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>NMIE</code> - Non-Maskable Interrupt Exception.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OHCI.html">OHCI</a></td>
<td class="itemdesc"><p>Driver-&gt;Bus-&gt;<code>OHCI</code> - Open Host Controller Interface Driver.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OOBE.html">OOBE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>OOBE</code> - Out Of Bounds Exception.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="PCI.html">PCI</a></td>
<td class="itemdesc"><p>Driver-&gt;Bus-&gt;<code>PCI</code> - Peripheral Component Interconnect Driver.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="PF.html">PF</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>PF</code> - Page Fault.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="pmemorymanager.html">pmemorymanager</a></td>
<td class="itemdesc"><p><code>PMemoryManager</code> - Physical Memory Management
<p></p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="processloader.html">processloader</a></td>
<td class="itemdesc"><p><code>ProcessLoader</code> - Process Initialization &amp; Tasking (stub).</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="PS2_KEYBOARD_ISR.html">PS2_KEYBOARD_ISR</a></td>
<td class="itemdesc"><p>Driver-&gt;HID-&gt;PS2_KEYBAORD_ISR - PS2 <a class="normal" href="isr.html">ISR</a> <a class="normal" href="PS2_KEYBOARD_ISR.html#hook">Hook</a> &amp; Driver.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="RTC.html">RTC</a></td>
<td class="itemdesc"><p>Driver-&gt;Timers-&gt;<code>RTC</code> - Real Time Clock Driver.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="scheduler.html">scheduler</a></td>
<td class="itemdesc"><p><code>Scheduler</code> - Schedules Context Switches.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="serial.html">serial</a></td>
<td class="itemdesc"><p>Driver-&gt;Interface-&gt;<code>Serial</code> - <code>Serial</code> Driver.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="SFE.html">SFE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>SFE</code> - <a class="normal" href="util.html#stack">Stack</a> Fault Exception.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="shell.html">shell</a></td>
<td class="itemdesc"><p>Prog-&gt;<code>Shell</code> - Main Desktop UI.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="SNPE.html">SNPE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>SNPE</code> - Segment Not Present Exception.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="splash.html">splash</a></td>
<td class="itemdesc"><p>Prog-&gt;<code>Splash</code> - <a class="normal" href="asuro.html">Asuro</a> <code>Splash</code> Screen.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="strings.html">strings</a></td>
<td class="itemdesc"><p>Include-&gt;<code>Strings</code> - String Manipulation.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="system.html">system</a></td>
<td class="itemdesc"><p>Include-&gt;<code>System</code> - Base <a class="normal" href="types.html">Types</a> &amp; Structures.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="tcp.html">tcp</a></td>
<td class="itemdesc"><p>Driver-&gt;<a class="normal" href="net.html">Net</a>-&gt;L4-&gt;<code>TCP</code> - Transmission Control Protocol Driver.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="terminal.html">terminal</a></td>
<td class="itemdesc"><p>Prog-&gt;<code>Terminal</code> - Interactive Command Line Environment.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="testdriver.html">testdriver</a></td>
<td class="itemdesc"><p>Driver-&gt;Exp-&gt;<code>TestDriver</code> - Dummy Driver For Testing.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="themer.html">themer</a></td>
<td class="itemdesc"><p>Prog-&gt;<code>Themer</code> - Live Desktop Color Picker.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="TMR_0_ISR.html">TMR_0_ISR</a></td>
<td class="itemdesc"><p>Driver-&gt;Timer-&gt;<code>TMR_0_ISR</code> - 1024hz Timer Driver.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="TMR_1_ISR.html">TMR_1_ISR</a></td>
<td class="itemdesc"><p>Driver-&gt;Timer-&gt;<code>TMR_1_ISR</code> - 1024/s Timer Driver.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="tracer.html">tracer</a></td>
<td class="itemdesc"><p><code>Tracer</code> - Trace <a class="normal" href="util.html#stack">stack</a> for debugging method calls.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="tss.html">tss</a></td>
<td class="itemdesc"><p><code>TSS</code> - Task State Segment (stub).</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="types.html">types</a></td>
<td class="itemdesc"><p>Include-&gt;<code>Types</code> - Dummy Unit For VM Compatability.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="udp.html">udp</a></td>
<td class="itemdesc"><p>Driver-&gt;<a class="normal" href="net.html">Net</a>-&gt;L4-&gt;<code>UDP</code> - User Datagram Protocol Driver.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="UHCI.html">UHCI</a></td>
<td class="itemdesc"><p>Driver-&gt;Bus-&gt;<code>UHCI</code> - Universal Host Controller Interface Driver.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="UIE.html">UIE</a></td>
<td class="itemdesc"><p>Fault-&gt;<code>UIE</code> - Unknown Interrupt Exception.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="USB.html">USB</a></td>
<td class="itemdesc"><p>Driver-&gt;Bus-&gt;<code>USB</code> - Universal <a class="normal" href="serial.html">Serial</a> Bus Driver/Interface.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="util.html">util</a></td>
<td class="itemdesc"><p>Include-&gt;<code>Util</code> - Data Manipulation Utlities.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="vmemorymanager.html">vmemorymanager</a></td>
<td class="itemdesc"><p><code>VMemoryManager</code> - Virtual Memory Management.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="vmlog.html">vmlog</a></td>
<td class="itemdesc"><p>Prog-&gt;<code>VMLog</code> - Virtual Machine Event Log.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="vmstate.html">vmstate</a></td>
<td class="itemdesc"><p>Prog-&gt;<code>VMState</code> - Live MINJ Virtual Machine State Information.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="XHCI.html">XHCI</a></td>
<td class="itemdesc"><p>Driver-&gt;Bus-&gt;<code>XHCI</code> - eXtensible Host Controller Interface Driver.</p></td>
</tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
</span>
</td></tr></table></body></html>