32 lines
5.5 KiB
HTML
32 lines
5.5 KiB
HTML
<!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 `panic_semihosting` crate."><meta name="keywords" content="rust, rustlang, rust-lang, panic_semihosting"><title>panic_semihosting - Rust</title><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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Crate panic_semihosting</p><div class="sidebar-elems"><p class='location'></p><script>window.sidebarCurrent = {name: 'panic_semihosting', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/panic_semihosting/lib.rs.html#1-75' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>panic_semihosting</a></span></h1><div class='docblock'><p>Report panic messages to the host stderr using semihosting</p>
|
||
<p>This crate contains an implementation of <code>panic_fmt</code> that logs panic messages to the host stderr
|
||
using <a href="https://crates.io/crates/cortex-m-semihosting"><code>cortex-m-semihosting</code></a>. Before logging the message the panic handler disables (masks)
|
||
the device specific interrupts. After logging the message the panic handler trigger a breakpoint
|
||
and then goes into an infinite loop.</p>
|
||
<p>Currently, this crate only supports the ARM Cortex-M architecture.</p>
|
||
<h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1>
|
||
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
|
||
<span class="attribute">#![<span class="ident">no_std</span>]</span>
|
||
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">panic_semihosting</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="macro">panic</span><span class="macro">!</span>(<span class="string">"FOO"</span>)
|
||
}</pre>
|
||
<pre><code class="language-text">(gdb) monitor arm semihosting enable
|
||
(gdb) continue
|
||
Program received signal SIGTRAP, Trace/breakpoint trap.
|
||
rust_begin_unwind (args=..., file=..., line=8, col=5)
|
||
at $CRATE/src/lib.rs:69
|
||
69 asm::bkpt();
|
||
</code></pre>
|
||
<pre><code class="language-text">$ openocd -f (..)
|
||
(..)
|
||
panicked at 'FOO', src/main.rs:6:5
|
||
</code></pre>
|
||
<h1 id="optional-features" class="section-header"><a href="#optional-features">Optional features</a></h1><h2 id="inline-asm" class="section-header"><a href="#inline-asm"><code>inline-asm</code></a></h2>
|
||
<p>When this feature is enabled semihosting is implemented using inline assembly (<code>asm!</code>) and
|
||
compiling this crate requires nightly.</p>
|
||
<p>When this feature is disabled semihosting is implemented using FFI calls into an external
|
||
assembly file and compiling this crate works on stable and beta.</p>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "panic_semihosting";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |