rtic/2/api/rp2040_pac/i2c0/ic_tar/index.html
2024-12-06 13:35:18 +00:00

5 lines
No EOL
9 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="I2C Target Address Register"><title>rp2040_pac::i2c0::ic_tar - 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 ic_tar</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In rp2040_<wbr>pac::<wbr>i2c0</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>::<wbr><a href="../index.html">i2c0</a></span><h1>Module <span>ic_tar</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/i2c0/ic_tar.rs.html#1-196">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>I2C Target Address Register</p>
<p>This register is 12 bits wide, and bits 31:12 are reserved. This register can be written to only when IC_ENABLE[0]
is set to 0.</p>
<p>Note: If the software or application is aware that the DW_apb_i2c is not using the TAR address for the pending commands in the Tx FIFO, then it is possible to update the TAR address even while the Tx FIFO has entries (IC_STATUS[2]= 0). - It is not necessary to perform any write to this register if DW_apb_i2c is enabled as an I2C slave only.</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_TAR_SPEC.html" title="struct rp2040_pac::i2c0::ic_tar::IC_TAR_SPEC">IC_<wbr>TAR_<wbr>SPEC</a></div><div class="desc docblock-short">I2C Target Address 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.GC_OR_START_A.html" title="enum rp2040_pac::i2c0::ic_tar::GC_OR_START_A">GC_<wbr>OR_<wbr>START_<wbr>A</a></div><div class="desc docblock-short">If bit 11 (SPECIAL) is set to 1 and bit 13(Device-ID) is set to 0, then this bit indicates whether a General Call or START byte command is to be performed by the DW_apb_i2c. - 0: General Call Address - after issuing a General Call, only writes may be performed. Attempting to issue a read command results in setting bit 6 (TX_ABRT) of the IC_RAW_INTR_STAT register. The DW_apb_i2c remains in General Call mode until the SPECIAL bit value (bit 11) is cleared. - 1: START BYTE Reset value: 0x0</div></li><li><div class="item-name"><a class="enum" href="enum.SPECIAL_A.html" title="enum rp2040_pac::i2c0::ic_tar::SPECIAL_A">SPECIAL_<wbr>A</a></div><div class="desc docblock-short">This bit indicates whether software performs a Device-ID or General Call or START BYTE command. - 0: ignore bit 10 GC_OR_START and use IC_TAR normally - 1: perform special I2C command as specified in Device_ID or GC_OR_START bit Reset value: 0x0</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.GC_OR_START_R.html" title="type rp2040_pac::i2c0::ic_tar::GC_OR_START_R">GC_<wbr>OR_<wbr>START_<wbr>R</a></div><div class="desc docblock-short">Field <code>GC_OR_START</code> reader - If bit 11 (SPECIAL) is set to 1 and bit 13(Device-ID) is set to 0, then this bit indicates whether a General Call or START byte command is to be performed by the DW_apb_i2c. - 0: General Call Address - after issuing a General Call, only writes may be performed. Attempting to issue a read command results in setting bit 6 (TX_ABRT) of the IC_RAW_INTR_STAT register. The DW_apb_i2c remains in General Call mode until the SPECIAL bit value (bit 11) is cleared. - 1: START BYTE Reset value: 0x0</div></li><li><div class="item-name"><a class="type" href="type.GC_OR_START_W.html" title="type rp2040_pac::i2c0::ic_tar::GC_OR_START_W">GC_<wbr>OR_<wbr>START_<wbr>W</a></div><div class="desc docblock-short">Field <code>GC_OR_START</code> writer - If bit 11 (SPECIAL) is set to 1 and bit 13(Device-ID) is set to 0, then this bit indicates whether a General Call or START byte command is to be performed by the DW_apb_i2c. - 0: General Call Address - after issuing a General Call, only writes may be performed. Attempting to issue a read command results in setting bit 6 (TX_ABRT) of the IC_RAW_INTR_STAT register. The DW_apb_i2c remains in General Call mode until the SPECIAL bit value (bit 11) is cleared. - 1: START BYTE Reset value: 0x0</div></li><li><div class="item-name"><a class="type" href="type.IC_TAR_R.html" title="type rp2040_pac::i2c0::ic_tar::IC_TAR_R">IC_<wbr>TAR_<wbr>R</a></div><div class="desc docblock-short">Field <code>IC_TAR</code> reader - This is the target address for any master transaction. When transmitting a General Call, these bits are ignored. To generate a START BYTE, the CPU needs to write only once into these bits.</div></li><li><div class="item-name"><a class="type" href="type.IC_TAR_W.html" title="type rp2040_pac::i2c0::ic_tar::IC_TAR_W">IC_<wbr>TAR_<wbr>W</a></div><div class="desc docblock-short">Field <code>IC_TAR</code> writer - This is the target address for any master transaction. When transmitting a General Call, these bits are ignored. To generate a START BYTE, the CPU needs to write only once into these bits.</div></li><li><div class="item-name"><a class="type" href="type.R.html" title="type rp2040_pac::i2c0::ic_tar::R">R</a></div><div class="desc docblock-short">Register <code>IC_TAR</code> reader</div></li><li><div class="item-name"><a class="type" href="type.SPECIAL_R.html" title="type rp2040_pac::i2c0::ic_tar::SPECIAL_R">SPECIAL_<wbr>R</a></div><div class="desc docblock-short">Field <code>SPECIAL</code> reader - This bit indicates whether software performs a Device-ID or General Call or START BYTE command. - 0: ignore bit 10 GC_OR_START and use IC_TAR normally - 1: perform special I2C command as specified in Device_ID or GC_OR_START bit Reset value: 0x0</div></li><li><div class="item-name"><a class="type" href="type.SPECIAL_W.html" title="type rp2040_pac::i2c0::ic_tar::SPECIAL_W">SPECIAL_<wbr>W</a></div><div class="desc docblock-short">Field <code>SPECIAL</code> writer - This bit indicates whether software performs a Device-ID or General Call or START BYTE command. - 0: ignore bit 10 GC_OR_START and use IC_TAR normally - 1: perform special I2C command as specified in Device_ID or GC_OR_START bit Reset value: 0x0</div></li><li><div class="item-name"><a class="type" href="type.W.html" title="type rp2040_pac::i2c0::ic_tar::W">W</a></div><div class="desc docblock-short">Register <code>IC_TAR</code> writer</div></li></ul></section></div></main></body></html>