mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-12-27 04:19:33 +01:00
Code Issues Projects Releases Packages Wiki Activity
rtic/dev/api/nrf52840_pac/usbd/index.html

10 lines
30 KiB
HTML
Raw Permalink Normal View History

deploy: 1a1237690cf676733579ffde0f507a00950e474e
2024-12-06 14:35:18 +01:00
<!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="Universal serial bus device"><title>nrf52840_pac::usbd - 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="nrf52840_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="../../nrf52840_pac/index.html">nrf52840_<wbr>pac</a><span class="version">0.12.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module usbd</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><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 nrf52840_<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">nrf52840_pac</a></span><h1>Module <span>usbd</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/nrf52840_pac/usbd.rs.html#1-388">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Universal serial bus device</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.HALTED"><code>pub use halted::<a class="struct" href="halted/struct.HALTED.html" title="struct nrf52840_pac::usbd::halted::HALTED">HALTED</a>;</code></div></li><li><div class="item-name" id="reexport.SIZE"><code>pub use size::<a class="struct" href="size/struct.SIZE.html" title="struct nrf52840_pac::usbd::size::SIZE">SIZE</a>;</code></div></li><li><div class="item-name" id="reexport.EPIN"><code>pub use epin::<a class="struct" href="epin/struct.EPIN.html" title="struct nrf52840_pac::usbd::epin::EPIN">EPIN</a>;</code></div></li><li><div class="item-name" id="reexport.ISOIN"><code>pub use isoin::<a class="struct" href="isoin/struct.ISOIN.html" title="struct nrf52840_pac::usbd::isoin::ISOIN">ISOIN</a>;</code></div></li><li><div class="item-name" id="reexport.EPOUT"><code>pub use epout::<a class="struct" href="epout/struct.EPOUT.html" title="struct nrf52840_pac::usbd::epout::EPOUT">EPOUT</a>;</code></div></li><li><div class="item-name" id="reexport.ISOOUT"><code>pub use isoout::<a class="struct" href="isoout/struct.ISOOUT.html" title="struct nrf52840_pac::usbd::isoout::ISOOUT">ISOOUT</a>;</code></div></li></ul><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="bmrequesttype/index.html" title="mod nrf52840_pac::usbd::bmrequesttype">bmrequesttype</a></div><div class="desc docblock-short">SETUP data, byte 0, bmRequestType</div></li><li><div class="item-name"><a class="mod" href="brequest/index.html" title="mod nrf52840_pac::usbd::brequest">brequest</a></div><div class="desc docblock-short">SETUP data, byte 1, bRequest</div></li><li><div class="item-name"><a class="mod" href="dpdmvalue/index.html" title="mod nrf52840_pac::usbd::dpdmvalue">dpdmvalue</a></div><div class="desc docblock-short">State D+ and D- lines will be forced into by the DPDMDRIVE task. The DPDMNODRIVE task reverts the control of the lines to MAC IP (no forcing).</div></li><li><div class="item-name"><a class="mod" href="dtoggle/index.html" title="mod nrf52840_pac::usbd::dtoggle">dtoggle</a></div><div class="desc docblock-short">Data toggle control and status</div></li><li><div class="item-name"><a class="mod" href="enable/index.html" title="mod nrf52840_pac::usbd::enable">enable</a></div><div class="desc docblock-short">Enable USB</div></li><li><div class="item-name"><a class="mod" href="epdatastatus/index.html" title="mod nrf52840_pac::usbd::epdatastatus">epdatastatus</a></div><div class="desc docblock-short">Provides information on which endpoint(s) an acknowledged data transfer has occurred (EPDATA event)</div></li><li><div class="item-name"><a class="mod" href="epin/index.html" title="mod nrf52840_pac::usbd::epin">epin</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="epinen/index.html" title="mod nrf52840_pac::usbd::epinen">epinen</a></div><div class="desc docblock-short">Endpoint IN enable</div></li><li><div class="item-name"><a class="mod" href="epout/index.html" title="mod nrf52840_pac::usbd::epout">epout</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="epouten/index.html" title="mod nrf52840_pac::usbd::epouten">epouten</a></div><div class="desc docblock-short">Endpoint OUT enable</div></li><li><div class="item-name"><a class="mod" href="epstall/index.html" title="mod nrf52840_pac::usbd::epstall">epstall</a></div><div class="desc docblock-short">STALL endpoints</div></li><li><div class="item-name"><a class="mod" href="epstatus/index.html" title="mod nrf52840_pac::usbd::epstatus">epstatus</a></div><div class="desc docblock-short">Provides information on which endpoint’s EasyDMA registers have been captured</div></li><li><div class="item-name"><a class="mod" href="eventcause/index.html" title="mod nrf52840_pac::usbd::eventcause">eventcause</a></div><div class="desc docblock-short">Details on what caused the USBEVENT event</div></li><li><div class="item-name"><a class="mod" href="events_endepin/index.html" title="mod nrf52840_pac::usbd::events_endepin">events_<wbr>endepin</a></div><div class="desc docblock-short">Description collection[n]: The whole EPIN[n]
buffer has been consumed. The RAM buffer can be accessed safely by software.</div></li><li><div class="item-name"><a class="mod" href="events_endepout/index.html" title="mod nrf52840_pac::usbd::events_endepout">events_<wbr>endepout</a></div><div class="desc docblock-short">Description collection[n]: The whole EPOUT[n]
buffer has been consumed. The RAM buffer can be accessed safely by software.</div></li><li><div class="item-name"><a class="mod" href="events_endisoin/index.html" title="mod nrf52840_pac::usbd::events_endisoin">events_<wbr>endisoin</a></div><div class="desc docblock-short">The whole ISOIN buffer has been consumed. The RAM buffer can be accessed safely by software.</div></li><li><div class="item-name"><a class="mod" href="events_endisoout/index.html" title="mod nrf52840_pac::usbd::events_endisoout">events_<wbr>endisoout</a></div><div class="desc docblock-short">The whole ISOOUT buffer has been consumed. The RAM buffer can be accessed safely by software.</div></li><li><div class="item-name"><a class="mod" href="events_ep0datadone/index.html" title="mod nrf52840_pac::usbd::events_ep0datadone">events_<wbr>ep0datadone</a></div><div class="desc docblock-short">An acknowledged data transfer has taken place on the control endpoint</div></li><li><div class="item-name"><a class="mod" href="events_ep0setup/index.html" title="mod nrf52840_pac::usbd::events_ep0setup">events_<wbr>ep0setup</a></div><div class="desc docblock-short">A valid SETUP token has been received (and acknowledged) on the control endpoint</div></li><li><div class="item-name"><a class="mod" href="events_epdata/index.html" title="mod nrf52840_pac::usbd::events_epdata">events_<wbr>epdata</a></div><div class="desc docblock-short">A data transfer has occurred on a data endpoint, indicated by the EPDATASTATUS register</div></li><li><div class="item-name"><a class="mod" href="events_sof/index.html" title="mod nrf52840_pac::usbd::events_sof">events_<wbr>sof</a></div><div class="desc docblock-short">Signals that a SOF (start of frame) condition has been detected on USB lines</div></li><li><div class="item-name"><a class="mod" href="events_started/index.html" title="mod nrf52840_pac::usbd::events_started">events_<wbr>started</a></div><div class="desc docblock-short">Confirms that the EPIN[n].PTR and EPIN[n].MAXCNT, or EPOUT[n].PTR and EPOUT[n].MAXCNT registers have been captured on all endpoints reported in the EPSTATUS register</div></li><li><div class="item-name"><a class="mod" href="events_usbevent/index.html" title="mod nrf52840_pac::usbd::events_usbevent">events_<wbr>usbevent</a></div><div class="desc docblock-short">An event or an error not covered by specific events has occurred. Check EVENTCAUSE register to find the cause.</div></li><li><div class="item-name"><a class="mod" href="events_usbreset/index.html" title="mod nrf52840_pac::usbd::events_usbreset">events_<wbr>usbreset</a></div><div class="desc docblock-short">Signals that a USB reset condition has been detected on USB lines</div></li><li><div class="item-name"><a class="mod" href="framecntr/index.html" title="mod nrf52840_pac::usbd::framecntr">framecntr</a></div><div class="desc docblock-short">Returns the current value of the start of frame counter</div></li><li><div class="item-name"><a class="mod" href="halted/index.html" title="mod nrf52840_pac::usbd::halted">halted</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="inten/index.html" title="mod nrf52840_pac::usbd::inten">inten</a></div><div class="desc docblock-short">Enable or disable interrupt</div></li><li><div class="item-name"><a class="mod" href="intenclr/index.html" title="mod nrf52840_pac::usbd::intenclr">intenclr</a></div><div class="desc docblock-short">Disable interrupt</div></li><li><div class="item-name"><a class="mod" href="intenset/index.html" title="mod nrf52840_pac::usbd::intenset">intenset</a></div><div class="desc docblock-short">Enable interrupt</div></li><li><div class="item-name"><a class="mod" href="isoin/index.html" title="mod nrf52840_pac::usbd::isoin">isoin</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="isoinconfig/index.html" title="mod nrf52840_pac::usbd::isoinconfig">isoinconfig</a></div><div class="desc docblock-short">Controls the response of the ISO IN endpoint to an IN token when no data is ready to be sent</div></li><li><div class="item-name"><a class="mod" href="isoout/index.html" title="mod nrf52840_pac::usbd::isoout">isoout</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="isosplit/index.html" title="mod nrf52840_pac::usbd::isosplit">isosplit</a></div><div class="desc docblock-short">Controls the split of ISO buffers</div></li><li><div class="item-name"><a class="mod" href="lowpower/index.html" title="mod nrf52840_pac::usbd::lowpower">lowpower</a></div><div class="desc docblock-short">Controls USBD peripheral low power mode during USB suspend</div></li><li><div class="item-name"><a class="mod" href="shorts/index.html" title="mod nrf52840_pac::usbd::shorts">shorts</a></div><div class="desc docblock-short">Shortcut register</div></li><li><div class="item-name"><a class="mod" href="size/index.html" title="mod nrf52840_pac::usbd::size">size</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="tasks_dpdmdrive/index.html" title="mod nrf52840_pac::usbd::tasks_dpdmdrive">tasks_<wbr>dpdmdrive</a></div><div class="desc docblock-short">Forces D+ and D- lines into the state defined in the DPDMVALUE register</div></li><li><div class="item-name"><a class="mod" href="tasks_dpdmnodrive/index.html" title="mod nrf52840_pac::usbd::tasks_dpdmnodrive">tasks_<wbr>dpdmnodrive</a></div><div class="desc docblock-short">Stops forcing D+ and D- lines into any state (USB engine takes control)</div></li><li><div class="item-name"><a class="mod" href="tasks_ep0rcvout/index.html" title="mod nrf52840_pac::usbd::tasks_ep0rcvout">tasks_<wbr>ep0rcvout</a></div><div class="desc docblock-short">Allows OUT data stage on control endpoint 0</div></li><li><div class="item-name"><a class="mod" href="tasks_ep0stall/index.html" title="mod nrf52840_pac::usbd::tasks_ep0stall">tasks_<wbr>ep0stall</a></div><div class="desc docblock-short">Stalls data and status stage on control endpoint 0</div></li><li><div class="item-name"><a class="mod" href="tasks_ep0status/index.html" title="mod nrf52840_pac::usbd::tasks_ep0status">tasks_<wbr>ep0status</a></div><div class="desc docblock-short">Allows status stage on control endpoint 0</div></li><li><div class="item-name"><a class="mod" href="tasks_startepin/index.html" title="mod nrf52840_pac::usbd::tasks_startepin">tasks_<wbr>startepin</a></div><div class="desc docblock-short">Description collection[n]: Captures the EPIN[n].PTR and EPIN[n].MAXCNT registers values, and enables endpoint IN n to respond to traffic from host</div></li><li><div class="item-name"><a class="mod" href="tasks_startepout/index.html" title="mod nrf52840_pac::usbd::tasks_startepout">tasks_<wbr>startepout</a></div><div class="desc docblock-short">Description collection[n]: Captures the EPOUT[n].PTR and EPOUT[n].MAXCNT registers values, and enables endpoint n to respond to traffic from host</div></li><li><div class="item-name"><a class="mod" href="tasks_startisoin/index.html" title="mod nrf52840_pac::usbd::tasks_startisoin">tasks_<wbr>startisoin</a></div><div class="desc docblock-short">Captures the ISOIN.PTR and ISOIN.MAXCNT registers values, and enables sending data on ISO endpoint</div></li><li><div class="item-name"><a class="mod" href="tasks_startisoout/index.html" title="mod nrf52840_pac::usbd::tasks_startisoout">tasks_<wbr>startisoout</a></div><div class="desc docblock-short">Captures the ISOOUT.PTR and ISOOUT.MAXCNT registers values, and enables receiving of data on ISO endpoint</div></li><li><div class="item-name"><a class="mod" href="usbaddr/index.html" title="mod nrf52840_pac::usbd::usbaddr">usbaddr</a></div><div class="desc docblock-short">Device USB address</div></li><li><div class="item-name"><a class="mod" href="usbpullup/index.html" title="mod nrf52840_pac::usbd::usbpullup">usbpullup</a></div><div class="desc docblock-short">Control of the USB pull-up</div></li><li><div class="item-name"><a class="mod" href="windexh/index.html" title="mod nrf52840_pac::usbd::windexh">windexh</a></div><div class="desc docblock-short">SETUP data, byte 5, MSB of wIndex</div></li><li><div class="item-name"><a class="mod" href="windexl/index.html" title="mod nrf52840_pac::usbd::windexl">windexl</a></div><div class="desc docblock-short">SETUP data, byte 4, LSB of wIndex</div></li><li><div class="item-name"><a class="mod" href="wlengthh/index.html" title="mod nrf52840_pac::usbd::wlengthh">wlengthh</a></div><div class="desc docblock-short">SETUP data, byte 7, MSB of wLength</div></li><li><div class="item-name"><a class="mod" href="wlengthl/index.html" title="mod nrf52840_pac::usbd::wlengthl">wlengthl</a></div><div class="desc docblock-short">SETUP data, byte 6, LSB of wLength</div></li><li><div class="item-name"><a class="mod" href="wvalueh/index.html" title="mod nrf52840_pac::usbd::wvalueh">wvalueh</a></div><div class="desc docblock-short">SETUP data, byte 3, MSB of wValue</div></li><li><div class="item-name"><a class="mod" href="wvaluel/index.html" title="mod nrf52840_pac::usbd::w
Reference in a new issue Copy permalink