forked from theseus-os/Theseus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
33 lines (33 loc) · 9.65 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `apic` crate."><meta name="keywords" content="rust, rustlang, rust-lang, apic"><title>apic - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../apic/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../apic/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">Crate apic</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#statics">Statics</a></li><li><a href="#functions">Functions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../apic/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1">
<a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div>
</div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">apic</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/apic/lib.rs.html#1-776">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ApicRegisters.html" title="apic::ApicRegisters struct">ApicRegisters</a></div><div class="item-right docblock-short"><p>A structure that offers access to APIC/xAPIC through its I/O registers.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LocalApic.html" title="apic::LocalApic struct">LocalApic</a></div><div class="item-right docblock-short"><p>This structure represents a single APIC in the system, there is one per core. </p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RegisterArray.html" title="apic::RegisterArray struct">RegisterArray</a></div><div class="item-right docblock-short"></div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.InterruptChip.html" title="apic::InterruptChip enum">InterruptChip</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.LapicIpiDestination.html" title="apic::LapicIpiDestination enum">LapicIpiDestination</a></div><div class="item-right docblock-short"><p>The possible destination shorthand values for IPI ICR.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.LvtLint.html" title="apic::LvtLint enum">LvtLint</a></div><div class="item-right docblock-short"><p>The Local APIC’s vector table local interrupt pins.</p>
</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.APIC_SPURIOUS_INTERRUPT_IRQ.html" title="apic::APIC_SPURIOUS_INTERRUPT_IRQ constant">APIC_SPURIOUS_INTERRUPT_IRQ</a></div><div class="item-right docblock-short"><p>The IRQ number reserved for spurious APIC interrupts (as recommended by OS dev wiki).</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.LOCAL_APIC_LVT_IRQ.html" title="apic::LOCAL_APIC_LVT_IRQ constant">LOCAL_APIC_LVT_IRQ</a></div><div class="item-right docblock-short"><p>The IRQ number reserved for Local APIC timer interrupts in the IDT.</p>
</div></div></div><h2 id="statics" class="small-section-header"><a href="#statics">Statics</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="static" href="static.INTERRUPT_CHIP.html" title="apic::INTERRUPT_CHIP static">INTERRUPT_CHIP</a></div><div class="item-right docblock-short"><p>The interrupt chip that is currently configured on this machine.
The default is <code>InterruptChip::PIC</code>, but the typical case is <code>APIC</code> or <code>X2APIC</code>,
which will be set once those chips have been initialized.</p>
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cpu_count.html" title="apic::cpu_count fn">cpu_count</a></div><div class="item-right docblock-short"><p>Returns the number of CPUs (cores, or local APICs) that exist
and are currently initialized on this system.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_bsp_id.html" title="apic::get_bsp_id fn">get_bsp_id</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_lapics.html" title="apic::get_lapics fn">get_lapics</a></div><div class="item-right docblock-short"><p>Returns a reference to the list of LocalApics, one per CPU core.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_my_apic.html" title="apic::get_my_apic fn">get_my_apic</a></div><div class="item-right docblock-short"><p>Returns a reference to the LocalApic for the currently executing CPU core.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_my_apic_id.html" title="apic::get_my_apic_id fn">get_my_apic_id</a></div><div class="item-right docblock-short"><p>Returns the APIC ID of the currently executing CPU core.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.has_x2apic.html" title="apic::has_x2apic fn">has_x2apic</a></div><div class="item-right docblock-short"><p>Returns true if the machine has support for x2apic</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.init.html" title="apic::init fn">init</a></div><div class="item-right docblock-short"><p>Initially maps the base APIC MMIO register frames so that we can know which LAPIC (core) we are.
This only does something for apic/xapic systems, it does nothing for x2apic systems, as required.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_bsp.html" title="apic::is_bsp fn">is_bsp</a></div><div class="item-right docblock-short"><p>Returns true if the currently executing processor core is the bootstrap processor,
i.e., the first procesor to run </p>
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="apic" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0-nightly (f8588549c 2022-07-18)" ></div>
</body></html>