rtic/2/api/rp2040_pac/ppb/scr/index.html

22 lines
7.8 KiB
HTML
Raw Normal View History

<!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="System Control Register. Use the System Control Register for power-management functions: signal to the system when the processor can enter a low power state, control how the processor enters and exits low power states."><title>rp2040_pac::ppb::scr - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="rp2040_pac" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../rp2040_pac/index.html">rp2040_<wbr>pac</a><span class="version">0.6.0</span></h2></div><h2 class="location"><a href="#">Module scr</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In rp2040_<wbr>pac::<wbr>ppb</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">rp2040_pac</a>::<wbr><a href="../index.html">ppb</a>::<wbr><a class="mod" href="#">scr</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/rp2040_pac/ppb/scr.rs.html#1-121">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>System Control Register. Use the System Control Register for power-management functions: signal to the system when the processor can enter a low power state, control how the processor enters and exits low power states.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.SCR_SPEC.html" title="struct rp2040_pac::ppb::scr::SCR_SPEC">SCR_<wbr>SPEC</a></div><div class="desc docblock-short">System Control Register. Use the System Control Register for power-management functions: signal to the system when the processor can enter a low power state, control how the processor enters and exits low power states.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.R.html" title="type rp2040_pac::ppb::scr::R">R</a></div><div class="desc docblock-short">Register <code>SCR</code> reader</div></li><li><div class="item-name"><a class="type" href="type.SEVONPEND_R.html" title="type rp2040_pac::ppb::scr::SEVONPEND_R">SEVONPEN<wbr>D_<wbr>R</a></div><div class="desc docblock-short">Field <code>SEVONPEND</code> reader - Send Event on Pending bit:<br />
0 = Only enabled interrupts or events can wakeup the processor, disabled interrupts are excluded.<br />
1 = Enabled events and all interrupts, including disabled interrupts, can wakeup the processor.<br />
When an event or interrupt becomes pending, the event signal wakes up the processor from WFE. If the<br />
processor is not waiting for an event, the event is registered and affects the next WFE.<br />
The processor also wakes up on execution of an SEV instruction or an external event.</div></li><li><div class="item-name"><a class="type" href="type.SEVONPEND_W.html" title="type rp2040_pac::ppb::scr::SEVONPEND_W">SEVONPEN<wbr>D_<wbr>W</a></div><div class="desc docblock-short">Field <code>SEVONPEND</code> writer - Send Event on Pending bit:<br />
0 = Only enabled interrupts or events can wakeup the processor, disabled interrupts are excluded.<br />
1 = Enabled events and all interrupts, including disabled interrupts, can wakeup the processor.<br />
When an event or interrupt becomes pending, the event signal wakes up the processor from WFE. If the<br />
processor is not waiting for an event, the event is registered and affects the next WFE.<br />
The processor also wakes up on execution of an SEV instruction or an external event.</div></li><li><div class="item-name"><a class="type" href="type.SLEEPDEEP_R.html" title="type rp2040_pac::ppb::scr::SLEEPDEEP_R">SLEEPDEE<wbr>P_<wbr>R</a></div><div class="desc docblock-short">Field <code>SLEEPDEEP</code> reader - Controls whether the processor uses sleep or deep sleep as its low power mode:<br />
0 = Sleep.<br />
1 = Deep sleep.</div></li><li><div class="item-name"><a class="type" href="type.SLEEPDEEP_W.html" title="type rp2040_pac::ppb::scr::SLEEPDEEP_W">SLEEPDEE<wbr>P_<wbr>W</a></div><div class="desc docblock-short">Field <code>SLEEPDEEP</code> writer - Controls whether the processor uses sleep or deep sleep as its low power mode:<br />
0 = Sleep.<br />
1 = Deep sleep.</div></li><li><div class="item-name"><a class="type" href="type.SLEEPONEXIT_R.html" title="type rp2040_pac::ppb::scr::SLEEPONEXIT_R">SLEEPONEXI<wbr>T_<wbr>R</a></div><div class="desc docblock-short">Field <code>SLEEPONEXIT</code> reader - Indicates sleep-on-exit when returning from Handler mode to Thread mode:<br />
0 = Do not sleep when returning to Thread mode.<br />
1 = Enter sleep, or deep sleep, on return from an ISR to Thread mode.<br />
Setting this bit to 1 enables an interrupt driven application to avoid returning to an empty main application.</div></li><li><div class="item-name"><a class="type" href="type.SLEEPONEXIT_W.html" title="type rp2040_pac::ppb::scr::SLEEPONEXIT_W">SLEEPONEXI<wbr>T_<wbr>W</a></div><div class="desc docblock-short">Field <code>SLEEPONEXIT</code> writer - Indicates sleep-on-exit when returning from Handler mode to Thread mode:<br />
0 = Do not sleep when returning to Thread mode.<br />
1 = Enter sleep, or deep sleep, on return from an ISR to Thread mode.<br />
Setting this bit to 1 enables an interrupt driven application to avoid returning to an empty main application.</div></li><li><div class="item-name"><a class="type" href="type.W.html" title="type rp2040_pac::ppb::scr::W">W</a></div><div class="desc docblock-short">Register <code>SCR</code> writer</div></li></ul></section></div></main></body></html>