rtic/2/api/rp2040_pac/i2c0/ic_status/index.html

4 lines
10 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="I2C Status Register"><title>rp2040_pac::i2c0::ic_status - 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 ic_<wbr>status</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In rp2040_<wbr>pac::<wbr>i2c0</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">i2c0</a>::<wbr><a class="mod" href="#">ic_status</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/i2c0/ic_status.rs.html#1-328">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>I2C Status Register</p>
<p>This is a read-only register used to indicate the current transfer status and FIFO status. The status register may be read at any time. None of the bits in this register request an interrupt.</p>
<p>When the I2C is disabled by writing 0 in bit 0 of the IC_ENABLE register: - Bits 1 and 2 are set to 1 - Bits 3 and 10 are set to 0 When the master or slave state machines goes to idle and ic_en=0: - Bits 5 and 6 are set to 0</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.IC_STATUS_SPEC.html" title="struct rp2040_pac::i2c0::ic_status::IC_STATUS_SPEC">IC_<wbr>STATU<wbr>S_<wbr>SPEC</a></div><div class="desc docblock-short">I2C Status Register</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ACTIVITY_A.html" title="enum rp2040_pac::i2c0::ic_status::ACTIVITY_A">ACTIVIT<wbr>Y_<wbr>A</a></div><div class="desc docblock-short">I2C Activity Status. Reset value: 0x0</div></li><li><div class="item-name"><a class="enum" href="enum.MST_ACTIVITY_A.html" title="enum rp2040_pac::i2c0::ic_status::MST_ACTIVITY_A">MST_<wbr>ACTIVIT<wbr>Y_<wbr>A</a></div><div class="desc docblock-short">Master FSM Activity Status. When the Master Finite State Machine (FSM) is not in the IDLE state, this bit is set. - 0: Master FSM is in IDLE state so the Master part of DW_apb_i2c is not Active - 1: Master FSM is not in IDLE state so the Master part of DW_apb_i2c is Active Note: IC_STATUS[0]-that is, ACTIVITY bit-is the OR of SLV_ACTIVITY and MST_ACTIVITY bits.</div></li><li><div class="item-name"><a class="enum" href="enum.RFF_A.html" title="enum rp2040_pac::i2c0::ic_status::RFF_A">RFF_A</a></div><div class="desc docblock-short">Receive FIFO Completely Full. When the receive FIFO is completely full, this bit is set. When the receive FIFO contains one or more empty location, this bit is cleared. - 0: Receive FIFO is not full - 1: Receive FIFO is full Reset value: 0x0</div></li><li><div class="item-name"><a class="enum" href="enum.RFNE_A.html" title="enum rp2040_pac::i2c0::ic_status::RFNE_A">RFNE_A</a></div><div class="desc docblock-short">Receive FIFO Not Empty. This bit is set when the receive FIFO contains one or more entries; it is cleared when the receive FIFO is empty. - 0: Receive FIFO is empty - 1: Receive FIFO is not empty Reset value: 0x0</div></li><li><div class="item-name"><a class="enum" href="enum.SLV_ACTIVITY_A.html" title="enum rp2040_pac::i2c0::ic_status::SLV_ACTIVITY_A">SLV_<wbr>ACTIVIT<wbr>Y_<wbr>A</a></div><div class="desc docblock-short">Slave FSM Activity Status. When the Slave Finite State Machine (FSM) is not in the IDLE state, this bit is set. - 0: Slave FSM is in IDLE state so the Slave part of DW_apb_i2c is not Active - 1: Slave FSM is not in IDLE state so the Slave part of DW_apb_i2c is Active Reset value: 0x0</div></li><li><div class="item-name"><a class="enum" href="enum.TFE_A.html" title="enum rp2040_pac::i2c0::ic_status::TFE_A">TFE_A</a></div><div class="desc docblock-short">Transmit FIFO Completely Empty. When the transmit FIFO is completely empty, this bit is set. When it contains one or more valid entries, this bit is cleared. This bit field does not request an interrupt. - 0: Transmit FIFO is not empty - 1: Transmit FIFO is empty Reset value: 0x1</div></li><li><div class="item-name"><a class="enum" href="enum.TFNF_A.html" title="enum rp2040_pac::i2c0::ic_status::TFNF_A">TFNF_A</a></div><div class="desc docblock-short">Transmit FIFO Not Full. Set when the transmit FIFO contains one or more empty locations, and is cleared when the FIFO is full. - 0: Transmit FIFO is full - 1: Transmit FIFO is not full Reset value: 0x1</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.ACTIVITY_R.html" title="type rp2040_pac::i2c0::ic_status::ACTIVITY_R">ACTIVIT<wbr>Y_<wbr>R</a></div><div class="desc docblock-short">Field <code>ACTIVITY</code> reader - I2C Activity Status. Reset value: 0x0</div></li><li><div class="item-name"><a class="type" href="type.MST_ACTIVITY_R.html" title="type rp2040_pac::i2c0::ic_status::MST_ACTIVITY_R">MST_<wbr>ACTIVIT<wbr>Y_<wbr>R</a></div><div class="desc docblock-short">Field <code>MST_ACTIVITY</code> reader - Master FSM Activity Status.