mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 03:49:34 +01:00
22 lines
8.5 KiB
HTML
22 lines
8.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="ROSC"><title>rp2040_pac::rosc - 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-b0742ba02757f159.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.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.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><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module rosc</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate rp2040_<wbr>pac</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">rp2040_pac</a></span><h1>Module <span>rosc</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rp2040_pac/rosc.rs.html#1-156">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>ROSC</p>
|
||
|
|
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="ctrl/index.html" title="mod rp2040_pac::rosc::ctrl">ctrl</a></div><div class="desc docblock-short">Ring Oscillator control</div></li><li><div class="item-name"><a class="mod" href="div/index.html" title="mod rp2040_pac::rosc::div">div</a></div><div class="desc docblock-short">Controls the output divider</div></li><li><div class="item-name"><a class="mod" href="dormant/index.html" title="mod rp2040_pac::rosc::dormant">dormant</a></div><div class="desc docblock-short">Ring Oscillator pause control<br />
|
||
|
|
This is used to save power by pausing the ROSC<br />
|
||
|
|
On power-up this field is initialised to WAKE<br />
|
||
|
|
An invalid write will also select WAKE<br />
|
||
|
|
Warning: setup the irq before selecting dormant mode</div></li><li><div class="item-name"><a class="mod" href="freqa/index.html" title="mod rp2040_pac::rosc::freqa">freqa</a></div><div class="desc docblock-short">The FREQA & FREQB registers control the frequency by controlling the drive strength of each stage<br />
|
||
|
|
The drive strength has 4 levels determined by the number of bits set<br />
|
||
|
|
Increasing the number of bits set increases the drive strength and increases the oscillation frequency<br />
|
||
|
|
0 bits set is the default drive strength<br />
|
||
|
|
1 bit set doubles the drive strength<br />
|
||
|
|
2 bits set triples drive strength<br />
|
||
|
|
3 bits set quadruples drive strength</div></li><li><div class="item-name"><a class="mod" href="freqb/index.html" title="mod rp2040_pac::rosc::freqb">freqb</a></div><div class="desc docblock-short">For a detailed description see freqa register</div></li><li><div class="item-name"><a class="mod" href="phase/index.html" title="mod rp2040_pac::rosc::phase">phase</a></div><div class="desc docblock-short">Controls the phase shifted output</div></li><li><div class="item-name"><a class="mod" href="randombit/index.html" title="mod rp2040_pac::rosc::randombit">randombit</a></div><div class="desc docblock-short">This just reads the state of the oscillator output so randomness is compromised if the ring oscillator is stopped or run at a harmonic of the bus frequency</div></li><li><div class="item-name"><a class="mod" href="status/index.html" title="mod rp2040_pac::rosc::status">status</a></div><div class="desc docblock-short">Ring Oscillator Status</div></li></ul><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.RegisterBlock.html" title="struct rp2040_pac::rosc::RegisterBlock">Register<wbr>Block</a></div><div class="desc docblock-short">Register block</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.CTRL.html" title="type rp2040_pac::rosc::CTRL">CTRL</a></div><div class="desc docblock-short">CTRL (rw) register accessor: Ring Oscillator control</div></li><li><div class="item-name"><a class="type" href="type.DIV.html" title="type rp2040_pac::rosc::DIV">DIV</a></div><div class="desc docblock-short">DIV (rw) register accessor: Controls the output divider</div></li><li><div class="item-name"><a class="type" href="type.DORMANT.html" title="type rp2040_pac::rosc::DORMANT">DORMANT</a></div><div class="desc docblock-short">DORMANT (rw) register accessor: Ring Oscillator pause control<br />
|
||
|
|
This is used to save power by pausing the ROSC<br />
|
||
|
|
On power-up this field is initialised to WAKE<br />
|
||
|
|
An invalid write will also select WAKE<br />
|
||
|
|
Warning: setup the irq before selecting dormant mode</div></li><li><div class="item-name"><a class="type" href="type.FREQA.html" title="type rp2040_pac::rosc::FREQA">FREQA</a></div><div class="desc docblock-short">FREQA (rw) register accessor: The FREQA & FREQB registers control the frequency by controlling the drive strength of each stage<br />
|
||
|
|
The drive strength has 4 levels determined by the number of bits set<br />
|
||
|
|
Increasing the number of bits set increases the drive strength and increases the oscillation frequency<br />
|
||
|
|
0 bits set is the default drive strength<br />
|
||
|
|
1 bit set doubles the drive strength<br />
|
||
|
|
2 bits set triples drive strength<br />
|
||
|
|
3 bits set quadruples drive strength</div></li><li><div class="item-name"><a class="type" href="type.FREQB.html" title="type rp2040_pac::rosc::FREQB">FREQB</a></div><div class="desc docblock-short">FREQB (rw) register accessor: For a detailed description see freqa register</div></li><li><div class="item-name"><a class="type" href="type.PHASE.html" title="type rp2040_pac::rosc::PHASE">PHASE</a></div><div class="desc docblock-short">PHASE (rw) register accessor: Controls the phase shifted output</div></li><li><div class="item-name"><a class="type" href="type.RANDOMBIT.html" title="type rp2040_pac::rosc::RANDOMBIT">RANDOMBIT</a></div><div class="desc docblock-short">RANDOMBIT (r) register accessor: This just reads the state of the oscillator output so randomness is compromised if the ring oscillator is stopped or run at a harmonic of the bus frequency</div></li><li><div class="item-name"><a class="type" href="type.STATUS.html" title="type rp2040_pac::rosc::STATUS">STATUS</a></div><div class="desc docblock-short">STATUS (r) register accessor: Ring Oscillator Status</div></li></ul></section></div></main></body></html>
|