rtic/stable/api/rp2040_pac/usbctrl_regs/index.html

2 lines
19 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="USB FS/LS controller device registers"><title>rp2040_pac::usbctrl_regs - 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 usbctrl_<wbr>regs</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crate rp2040_<wbr>pac</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 class="mod" href="#">usbctrl_regs</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/usbctrl_regs.rs.html#1-448">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>USB FS/LS controller device registers</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="addr_endp/index.html" title="mod rp2040_pac::usbctrl_regs::addr_endp">addr_<wbr>endp</a></div><div class="desc docblock-short">Device address and endpoint control</div></li><li><div class="item-name"><a class="mod" href="buff_cpu_should_handle/index.html" title="mod rp2040_pac::usbctrl_regs::buff_cpu_should_handle">buff_<wbr>cpu_<wbr>should_<wbr>handle</a></div><div class="desc docblock-short">Which of the double buffers should be handled. Only valid if using an interrupt per buffer (i.e. not per 2 buffers). Not valid for host interrupt endpoint polling because they are only single buffered.</div></li><li><div class="item-name"><a class="mod" href="buff_status/index.html" title="mod rp2040_pac::usbctrl_regs::buff_status">buff_<wbr>status</a></div><div class="desc docblock-short">Buffer status register. A bit set here indicates that a buffer has completed on the endpoint (if the buffer interrupt is enabled). It is possible for 2 buffers to be completed, so clearing the buffer status bit may instantly re set it on the next clock cycle.</div></li><li><div class="item-name"><a class="mod" href="ep_abort/index.html" title="mod rp2040_pac::usbctrl_regs::ep_abort">ep_<wbr>abort</a></div><div class="desc docblock-short">Device only: Can be set to ignore the buffer control register for this endpoint in case you would like to revoke a buffer. A NAK will be sent for every access to the endpoint until this bit is cleared. A corresponding bit in <code>EP_ABORT_DONE</code> is set when it is safe to modify the buffer control register.</div></li><li><div class="item-name"><a class="mod" href="ep_abort_done/index.html" title="mod rp2040_pac::usbctrl_regs::ep_abort_done">ep_<wbr>abort_<wbr>done</a></div><div class="desc docblock-short">Device only: Used in conjunction with <code>EP_ABORT</code>. Set once an endpoint is idle so the programmer knows it is safe to modify the buffer control register.</div></li><li><div class="item-name"><a class="mod" href="ep_stall_arm/index.html" title="mod rp2040_pac::usbctrl_regs::ep_stall_arm">ep_<wbr>stall_<wbr>arm</a></div><div class="desc docblock-short">Device: this bit must be set in conjunction with the <code>STALL</code> bit in the buffer control register to send a STALL on EP0. The device controller clears these bits when a SETUP packet is received because the USB spec requires that a STALL condition is cleared when a SETUP packet is received.</div></li><li><div class="item-name"><a class="mod" href="ep_status_stall_nak/index.html" title="mod rp2040_pac::usbctrl_regs::ep_status_stall_nak">ep_<wbr>status_<wbr>stall_<wbr>nak</a></div><div class="desc docblock-short">Device: bits are set when the <code>IRQ_ON_NAK</code> or <code>IRQ_ON_STALL</code> bits are set. For EP0 this comes from <code>SIE_CTRL</code>. For all other endpoints it comes from the endpoint control register.</div></li><li><div class="item-name"><a class="mod" href="host_addr_endp/index.html" title="mod rp2040_pac::usbctrl_regs::host_addr_endp">host_<wbr>addr_<wbr>endp</a></div><div class="desc docblock-short">Interrupt endpoints. Only valid in HOST mode.</div></li><li><div class="item-name"><a class="mod" href="int_ep_ctrl/index.html" title="mod rp2040_pac::usbctrl_regs::int_ep_ctrl">int_<wbr>ep_<wbr>ctrl</a></div><div class="desc docblock-short">interrupt endpoint control register</div></li><li><div class="item-name"><a class="mod" href="inte/index.html" title="mod rp2040_pac::usbctrl_regs::inte">inte</a></div><div class="desc docblock-short">Interrupt Enable</div></li><li><div class="item-name"><a class="mod" href="intf/index.html" title="mod rp2040_pac::usbctrl_regs::intf">intf</a></div><div class="desc docblock-short">Interrupt Force</div></li><li><div class="item-name"><a class="mod" href="intr/index.html" title="mod rp2040_pac::usbctrl_regs::intr">intr</a></div><div class="desc docblock-short">Raw Interrupts</div></li><li><div class="item-name"><a c