75 lines
8.2 KiB
HTML
75 lines
8.2 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 `debug` mod in crate `cortex_m_semihosting`."><meta name="keywords" content="rust, rustlang, rust-lang, debug"><title>cortex_m_semihosting::debug - 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'>Module debug</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>cortex_m_semihosting</a></p><script>window.sidebarCurrent = {name: 'debug', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></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/cortex_m_semihosting/debug.rs.html#1-98' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>cortex_m_semihosting</a>::<wbr><a class="mod" href=''>debug</a></span></h1><div class='docblock'><p>Interacting with debugging agent</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<p>This example will show how to terminate the QEMU session. The program
|
||
should be running under QEMU with semihosting enabled
|
||
(use <code>-semihosting</code> flag).</p>
|
||
<p>Target program:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">cortex_m_semihosting</span>;
|
||
<span class="kw">use</span> <span class="ident">cortex_m_semihosting</span>::<span class="ident">debug</span>::{<span class="self">self</span>, <span class="ident">EXIT_SUCCESS</span>, <span class="ident">EXIT_FAILURE</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">if</span> <span class="number">2</span> <span class="op">==</span> <span class="number">2</span> {
|
||
<span class="comment">// report success</span>
|
||
<span class="ident">debug</span>::<span class="ident">exit</span>(<span class="ident">EXIT_SUCCESS</span>);
|
||
} <span class="kw">else</span> {
|
||
<span class="comment">// report failure</span>
|
||
<span class="ident">debug</span>::<span class="ident">exit</span>(<span class="ident">EXIT_FAILURE</span>);
|
||
}
|
||
}</pre>
|
||
</div><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.Exception.html"
|
||
title='enum cortex_m_semihosting::debug::Exception'>Exception</a></td>
|
||
<td class='docblock-short'>
|
||
<p>This values are taken from section 5.5.2 of
|
||
ADS Debug Target Guide (DUI0058).</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.EXIT_FAILURE.html"
|
||
title='constant cortex_m_semihosting::debug::EXIT_FAILURE'>EXIT_FAILURE</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Unsuccessful execution of a program.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="constant" href="constant.EXIT_SUCCESS.html"
|
||
title='constant cortex_m_semihosting::debug::EXIT_SUCCESS'>EXIT_SUCCESS</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Successful execution of a program.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.exit.html"
|
||
title='fn cortex_m_semihosting::debug::exit'>exit</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Reports to the debugger that the execution has completed.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.report_exception.html"
|
||
title='fn cortex_m_semihosting::debug::report_exception'>report_exception</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Report an exception to the debugger directly.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="type" href="type.ExitStatus.html"
|
||
title='type cortex_m_semihosting::debug::ExitStatus'>ExitStatus</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Status enum for <code>exit</code> syscall.</p>
|
||
|
||
</td>
|
||
</tr></table></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 = "cortex_m_semihosting";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |