web/docs/group__channel__config.html

   1 <!-- HTML header for doxygen 1.8.20-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: channel_config</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('group__channel__config.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="summary">
 106 <a href="#func-members">Functions</a>  </div>
 107   <div class="headertitle"><div class="title">channel_config<div class="ingroups"><a class="el" href="group__hardware.html">Hardware APIs</a> &raquo; <a class="el" href="group__hardware__dma.html">hardware_dma</a></div></div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110
 111 <p>DMA channel configuration.
 112 <a href="#details">More...</a></p>
 113 <table class="memberdecls">
 114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 115 Functions</h2></td></tr>
 116 <tr class="memitem:ga28d1103cea7f7d73406a2aee44bfebd9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga28d1103cea7f7d73406a2aee44bfebd9">channel_config_set_read_increment</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, bool incr)</td></tr>
 117 <tr class="memdesc:ga28d1103cea7f7d73406a2aee44bfebd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set DMA channel read increment in a channel configuration object.  <a href="group__channel__config.html#ga28d1103cea7f7d73406a2aee44bfebd9">More...</a><br /></td></tr>
 118 <tr class="separator:ga28d1103cea7f7d73406a2aee44bfebd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 <tr class="memitem:ga864c9d35a39c315f2972b7272f860e9e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga864c9d35a39c315f2972b7272f860e9e">channel_config_set_write_increment</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, bool incr)</td></tr>
 120 <tr class="memdesc:ga864c9d35a39c315f2972b7272f860e9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set DMA channel write increment in a channel configuration object.  <a href="group__channel__config.html#ga864c9d35a39c315f2972b7272f860e9e">More...</a><br /></td></tr>
 121 <tr class="separator:ga864c9d35a39c315f2972b7272f860e9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <tr class="memitem:ga7c5a515cf1cfc6a8889464250b1e375b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga7c5a515cf1cfc6a8889464250b1e375b">channel_config_set_dreq</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, uint dreq)</td></tr>
 123 <tr class="memdesc:ga7c5a515cf1cfc6a8889464250b1e375b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a transfer request signal in a channel configuration object.  <a href="group__channel__config.html#ga7c5a515cf1cfc6a8889464250b1e375b">More...</a><br /></td></tr>
 124 <tr class="separator:ga7c5a515cf1cfc6a8889464250b1e375b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 <tr class="memitem:ga7df3433a59311b83289490586f1242c8"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga7df3433a59311b83289490586f1242c8">channel_config_set_chain_to</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, uint chain_to)</td></tr>
 126 <tr class="memdesc:ga7df3433a59311b83289490586f1242c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set DMA channel chain_to channel in a channel configuration object.  <a href="group__channel__config.html#ga7df3433a59311b83289490586f1242c8">More...</a><br /></td></tr>
 127 <tr class="separator:ga7df3433a59311b83289490586f1242c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 <tr class="memitem:gad1a02fcee90d21f133460006b025bac0"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#gad1a02fcee90d21f133460006b025bac0">channel_config_set_transfer_data_size</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, enum <a class="el" href="group__hardware__dma.html#gaccecdff367b06a019373e9a55d4f3e01">dma_channel_transfer_size</a> size)</td></tr>
 129 <tr class="memdesc:gad1a02fcee90d21f133460006b025bac0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the size of each DMA bus transfer in a channel configuration object.  <a href="group__channel__config.html#gad1a02fcee90d21f133460006b025bac0">More...</a><br /></td></tr>
 130 <tr class="separator:gad1a02fcee90d21f133460006b025bac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 <tr class="memitem:gadd7ee73f3652261ae5e195b709cc6dc0"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#gadd7ee73f3652261ae5e195b709cc6dc0">channel_config_set_ring</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, bool write, uint size_bits)</td></tr>
 132 <tr class="memdesc:gadd7ee73f3652261ae5e195b709cc6dc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set address wrapping parameters in a channel configuration object.  <a href="group__channel__config.html#gadd7ee73f3652261ae5e195b709cc6dc0">More...</a><br /></td></tr>
 133 <tr class="separator:gadd7ee73f3652261ae5e195b709cc6dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:ga43c3a2dd43fe7e962b1de0e90a46bb9e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga43c3a2dd43fe7e962b1de0e90a46bb9e">channel_config_set_bswap</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, bool bswap)</td></tr>
 135 <tr class="memdesc:ga43c3a2dd43fe7e962b1de0e90a46bb9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set DMA byte swapping config in a channel configuration object.  <a href="group__channel__config.html#ga43c3a2dd43fe7e962b1de0e90a46bb9e">More...</a><br /></td></tr>
 136 <tr class="separator:ga43c3a2dd43fe7e962b1de0e90a46bb9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:ga8ccbf80d437f895f95ad0531197dcaab"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga8ccbf80d437f895f95ad0531197dcaab">channel_config_set_irq_quiet</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, bool irq_quiet)</td></tr>
 138 <tr class="memdesc:ga8ccbf80d437f895f95ad0531197dcaab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set IRQ quiet mode in a channel configuration object.  <a href="group__channel__config.html#ga8ccbf80d437f895f95ad0531197dcaab">More...</a><br /></td></tr>
 139 <tr class="separator:ga8ccbf80d437f895f95ad0531197dcaab"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:ga1acca0d1b5a1793c78dc0daec8a5fffc"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga1acca0d1b5a1793c78dc0daec8a5fffc">channel_config_set_high_priority</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, bool high_priority)</td></tr>
 141 <tr class="memdesc:ga1acca0d1b5a1793c78dc0daec8a5fffc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the channel priority in a channel configuration object.  <a href="group__channel__config.html#ga1acca0d1b5a1793c78dc0daec8a5fffc">More...</a><br /></td></tr>
 142 <tr class="separator:ga1acca0d1b5a1793c78dc0daec8a5fffc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:gab8f61e99408c4440866af231f947a7b9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#gab8f61e99408c4440866af231f947a7b9">channel_config_set_enable</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, bool enable)</td></tr>
 144 <tr class="memdesc:gab8f61e99408c4440866af231f947a7b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/Disable the DMA channel in a channel configuration object.  <a href="group__channel__config.html#gab8f61e99408c4440866af231f947a7b9">More...</a><br /></td></tr>
 145 <tr class="separator:gab8f61e99408c4440866af231f947a7b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:ga5eb02f42a33115052031d0b457fa2674"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga5eb02f42a33115052031d0b457fa2674">channel_config_set_sniff_enable</a> (<a class="el" href="structdma__channel__config.html">dma_channel_config</a> *c, bool sniff_enable)</td></tr>
 147 <tr class="memdesc:ga5eb02f42a33115052031d0b457fa2674"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable access to channel by sniff hardware in a channel configuration object.  <a href="group__channel__config.html#ga5eb02f42a33115052031d0b457fa2674">More...</a><br /></td></tr>
 148 <tr class="separator:ga5eb02f42a33115052031d0b457fa2674"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:ga432f0d010da5935d333c27fbce0135f8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structdma__channel__config.html">dma_channel_config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga432f0d010da5935d333c27fbce0135f8">dma_channel_get_default_config</a> (uint channel)</td></tr>
 150 <tr class="memdesc:ga432f0d010da5935d333c27fbce0135f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the default channel configuration for a given channel.  <a href="group__channel__config.html#ga432f0d010da5935d333c27fbce0135f8">More...</a><br /></td></tr>
 151 <tr class="separator:ga432f0d010da5935d333c27fbce0135f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:ga369ee3104c5a9b5a32673c163a499a1d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structdma__channel__config.html">dma_channel_config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga369ee3104c5a9b5a32673c163a499a1d">dma_get_channel_config</a> (uint channel)</td></tr>
 153 <tr class="memdesc:ga369ee3104c5a9b5a32673c163a499a1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current configuration for the specified channel.  <a href="group__channel__config.html#ga369ee3104c5a9b5a32673c163a499a1d">More...</a><br /></td></tr>
 154 <tr class="separator:ga369ee3104c5a9b5a32673c163a499a1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:ga7f379a63d28a2565ff9a433cb8d31c90"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__channel__config.html#ga7f379a63d28a2565ff9a433cb8d31c90">channel_config_get_ctrl_value</a> (const <a class="el" href="structdma__channel__config.html">dma_channel_config</a> *config)</td></tr>
 156 <tr class="memdesc:ga7f379a63d28a2565ff9a433cb8d31c90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the raw configuration register from a channel configuration.  <a href="group__channel__config.html#ga7f379a63d28a2565ff9a433cb8d31c90">More...</a><br /></td></tr>
 157 <tr class="separator:ga7f379a63d28a2565ff9a433cb8d31c90"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 </table>
 159 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 160 <p >DMA channel configuration. </p>
 161 <p >A DMA channel needs to be configured, these functions provide handy helpers to set up configuration structures. See <a class="el" href="structdma__channel__config.html">dma_channel_config</a> </p>
 162 <h2 class="groupheader">Function Documentation</h2>
 163 <a id="ga7f379a63d28a2565ff9a433cb8d31c90" name="ga7f379a63d28a2565ff9a433cb8d31c90"></a>
 164 <h2 class="memtitle"><span class="permalink"><a href="#ga7f379a63d28a2565ff9a433cb8d31c90">&#9670;&nbsp;</a></span>channel_config_get_ctrl_value()</h2>
 165
 166 <div class="memitem">
 167 <div class="memproto">
 168 <table class="mlabels">
 169   <tr>
 170   <td class="mlabels-left">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname">static uint32_t channel_config_get_ctrl_value </td>
 174           <td>(</td>
 175           <td class="paramtype">const <a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 176           <td class="paramname"><em>config</em></td><td>)</td>
 177           <td></td>
 178         </tr>
 179       </table>
 180   </td>
 181   <td class="mlabels-right">
 182 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 183   </tr>
 184 </table>
 185 </div><div class="memdoc">
 186
 187 <p>Get the raw configuration register from a channel configuration. </p>
 188 <dl class="params"><dt>Parameters</dt><dd>
 189   <table class="params">
 190     <tr><td class="paramname">config</td><td>Pointer to a config structure. </td></tr>
 191   </table>
 192   </dd>
 193 </dl>
 194 <dl class="section return"><dt>Returns</dt><dd>Register content </dd></dl>
 195
 196 </div>
 197 </div>
 198 <a id="ga43c3a2dd43fe7e962b1de0e90a46bb9e" name="ga43c3a2dd43fe7e962b1de0e90a46bb9e"></a>
 199 <h2 class="memtitle"><span class="permalink"><a href="#ga43c3a2dd43fe7e962b1de0e90a46bb9e">&#9670;&nbsp;</a></span>channel_config_set_bswap()</h2>
 200
 201 <div class="memitem">
 202 <div class="memproto">
 203 <table class="mlabels">
 204   <tr>
 205   <td class="mlabels-left">
 206       <table class="memname">
 207         <tr>
 208           <td class="memname">static void channel_config_set_bswap </td>
 209           <td>(</td>
 210           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 211           <td class="paramname"><em>c</em>, </td>
 212         </tr>
 213         <tr>
 214           <td class="paramkey"></td>
 215           <td></td>
 216           <td class="paramtype">bool&#160;</td>
 217           <td class="paramname"><em>bswap</em>&#160;</td>
 218         </tr>
 219         <tr>
 220           <td></td>
 221           <td>)</td>
 222           <td></td><td></td>
 223         </tr>
 224       </table>
 225   </td>
 226   <td class="mlabels-right">
 227 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 228   </tr>
 229 </table>
 230 </div><div class="memdoc">
 231
 232 <p>Set DMA byte swapping config in a channel configuration object. </p>
 233 <p >No effect for byte data, for halfword data, the two bytes of each halfword are swapped. For word data, the four bytes of each word are swapped to reverse their order.</p>
 234 <dl class="params"><dt>Parameters</dt><dd>
 235   <table class="params">
 236     <tr><td class="paramname">c</td><td>Pointer to channel configuration object </td></tr>
 237     <tr><td class="paramname">bswap</td><td>True to enable byte swapping </td></tr>
 238   </table>
 239   </dd>
 240 </dl>
 241
 242 </div>
 243 </div>
 244 <a id="ga7df3433a59311b83289490586f1242c8" name="ga7df3433a59311b83289490586f1242c8"></a>
 245 <h2 class="memtitle"><span class="permalink"><a href="#ga7df3433a59311b83289490586f1242c8">&#9670;&nbsp;</a></span>channel_config_set_chain_to()</h2>
 246
 247 <div class="memitem">
 248 <div class="memproto">
 249 <table class="mlabels">
 250   <tr>
 251   <td class="mlabels-left">
 252       <table class="memname">
 253         <tr>
 254           <td class="memname">static void channel_config_set_chain_to </td>
 255           <td>(</td>
 256           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 257           <td class="paramname"><em>c</em>, </td>
 258         </tr>
 259         <tr>
 260           <td class="paramkey"></td>
 261           <td></td>
 262           <td class="paramtype">uint&#160;</td>
 263           <td class="paramname"><em>chain_to</em>&#160;</td>
 264         </tr>
 265         <tr>
 266           <td></td>
 267           <td>)</td>
 268           <td></td><td></td>
 269         </tr>
 270       </table>
 271   </td>
 272   <td class="mlabels-right">
 273 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 274   </tr>
 275 </table>
 276 </div><div class="memdoc">
 277
 278 <p>Set DMA channel chain_to channel in a channel configuration object. </p>
 279 <p >When this channel completes, it will trigger the channel indicated by chain_to. Disable by setting chain_to to itself (the same channel)</p>
 280 <dl class="params"><dt>Parameters</dt><dd>
 281   <table class="params">
 282     <tr><td class="paramname">c</td><td>Pointer to channel configuration object </td></tr>
 283     <tr><td class="paramname">chain_to</td><td>Channel to trigger when this channel completes. </td></tr>
 284   </table>
 285   </dd>
 286 </dl>
 287
 288 </div>
 289 </div>
 290 <a id="ga7c5a515cf1cfc6a8889464250b1e375b" name="ga7c5a515cf1cfc6a8889464250b1e375b"></a>
 291 <h2 class="memtitle"><span class="permalink"><a href="#ga7c5a515cf1cfc6a8889464250b1e375b">&#9670;&nbsp;</a></span>channel_config_set_dreq()</h2>
 292
 293 <div class="memitem">
 294 <div class="memproto">
 295 <table class="mlabels">
 296   <tr>
 297   <td class="mlabels-left">
 298       <table class="memname">
 299         <tr>
 300           <td class="memname">static void channel_config_set_dreq </td>
 301           <td>(</td>
 302           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 303           <td class="paramname"><em>c</em>, </td>
 304         </tr>
 305         <tr>
 306           <td class="paramkey"></td>
 307           <td></td>
 308           <td class="paramtype">uint&#160;</td>
 309           <td class="paramname"><em>dreq</em>&#160;</td>
 310         </tr>
 311         <tr>
 312           <td></td>
 313           <td>)</td>
 314           <td></td><td></td>
 315         </tr>
 316       </table>
 317   </td>
 318   <td class="mlabels-right">
 319 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 320   </tr>
 321 </table>
 322 </div><div class="memdoc">
 323
 324 <p>Select a transfer request signal in a channel configuration object. </p>
 325 <p >The channel uses the transfer request signal to pace its data transfer rate. Sources for TREQ signals are internal (TIMERS) or external (DREQ, a Data Request from the system). 0x0 to 0x3a -&gt; select DREQ n as TREQ 0x3b -&gt; Select Timer 0 as TREQ 0x3c -&gt; Select Timer 1 as TREQ 0x3d -&gt; Select Timer 2 as TREQ (Optional) 0x3e -&gt; Select Timer 3 as TREQ (Optional) 0x3f -&gt; Permanent request, for unpaced transfers.</p>
 326 <dl class="params"><dt>Parameters</dt><dd>
 327   <table class="params">
 328     <tr><td class="paramname">c</td><td>Pointer to channel configuration data </td></tr>
 329     <tr><td class="paramname">dreq</td><td>Source (see description) </td></tr>
 330   </table>
 331   </dd>
 332 </dl>
 333
 334 </div>
 335 </div>
 336 <a id="gab8f61e99408c4440866af231f947a7b9" name="gab8f61e99408c4440866af231f947a7b9"></a>
 337 <h2 class="memtitle"><span class="permalink"><a href="#gab8f61e99408c4440866af231f947a7b9">&#9670;&nbsp;</a></span>channel_config_set_enable()</h2>
 338
 339 <div class="memitem">
 340 <div class="memproto">
 341 <table class="mlabels">
 342   <tr>
 343   <td class="mlabels-left">
 344       <table class="memname">
 345         <tr>
 346           <td class="memname">static void channel_config_set_enable </td>
 347           <td>(</td>
 348           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 349           <td class="paramname"><em>c</em>, </td>
 350         </tr>
 351         <tr>
 352           <td class="paramkey"></td>
 353           <td></td>
 354           <td class="paramtype">bool&#160;</td>
 355           <td class="paramname"><em>enable</em>&#160;</td>
 356         </tr>
 357         <tr>
 358           <td></td>
 359           <td>)</td>
 360           <td></td><td></td>
 361         </tr>
 362       </table>
 363   </td>
 364   <td class="mlabels-right">
 365 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 366   </tr>
 367 </table>
 368 </div><div class="memdoc">
 369
 370 <p>Enable/Disable the DMA channel in a channel configuration object. </p>
 371 <p >When false, the channel will ignore triggers, stop issuing transfers, and pause the current transfer sequence (i.e. BUSY will remain high if already high)</p>
 372 <dl class="params"><dt>Parameters</dt><dd>
 373   <table class="params">
 374     <tr><td class="paramname">c</td><td>Pointer to channel configuration object </td></tr>
 375     <tr><td class="paramname">enable</td><td>True to enable the DMA channel. When enabled, the channel will respond to triggering events, and start transferring data. </td></tr>
 376   </table>
 377   </dd>
 378 </dl>
 379
 380 </div>
 381 </div>
 382 <a id="ga1acca0d1b5a1793c78dc0daec8a5fffc" name="ga1acca0d1b5a1793c78dc0daec8a5fffc"></a>
 383 <h2 class="memtitle"><span class="permalink"><a href="#ga1acca0d1b5a1793c78dc0daec8a5fffc">&#9670;&nbsp;</a></span>channel_config_set_high_priority()</h2>
 384
 385 <div class="memitem">
 386 <div class="memproto">
 387 <table class="mlabels">
 388   <tr>
 389   <td class="mlabels-left">
 390       <table class="memname">
 391         <tr>
 392           <td class="memname">static void channel_config_set_high_priority </td>
 393           <td>(</td>
 394           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 395           <td class="paramname"><em>c</em>, </td>
 396         </tr>
 397         <tr>
 398           <td class="paramkey"></td>
 399           <td></td>
 400           <td class="paramtype">bool&#160;</td>
 401           <td class="paramname"><em>high_priority</em>&#160;</td>
 402         </tr>
 403         <tr>
 404           <td></td>
 405           <td>)</td>
 406           <td></td><td></td>
 407         </tr>
 408       </table>
 409   </td>
 410   <td class="mlabels-right">
 411 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 412   </tr>
 413 </table>
 414 </div><div class="memdoc">
 415
 416 <p>Set the channel priority in a channel configuration object. </p>
 417 <p >When true, gives a channel preferential treatment in issue scheduling: in each scheduling round, all high priority channels are considered first, and then only a single low priority channel, before returning to the high priority channels.</p>
 418 <p >This only affects the order in which the DMA schedules channels. The DMA's bus priority is not changed. If the DMA is not saturated then a low priority channel will see no loss of throughput.</p>
 419 <dl class="params"><dt>Parameters</dt><dd>
 420   <table class="params">
 421     <tr><td class="paramname">c</td><td>Pointer to channel configuration object </td></tr>
 422     <tr><td class="paramname">high_priority</td><td>True to enable high priority </td></tr>
 423   </table>
 424   </dd>
 425 </dl>
 426
 427 </div>
 428 </div>
 429 <a id="ga8ccbf80d437f895f95ad0531197dcaab" name="ga8ccbf80d437f895f95ad0531197dcaab"></a>
 430 <h2 class="memtitle"><span class="permalink"><a href="#ga8ccbf80d437f895f95ad0531197dcaab">&#9670;&nbsp;</a></span>channel_config_set_irq_quiet()</h2>
 431
 432 <div class="memitem">
 433 <div class="memproto">
 434 <table class="mlabels">
 435   <tr>
 436   <td class="mlabels-left">
 437       <table class="memname">
 438         <tr>
 439           <td class="memname">static void channel_config_set_irq_quiet </td>
 440           <td>(</td>
 441           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 442           <td class="paramname"><em>c</em>, </td>
 443         </tr>
 444         <tr>
 445           <td class="paramkey"></td>
 446           <td></td>
 447           <td class="paramtype">bool&#160;</td>
 448           <td class="paramname"><em>irq_quiet</em>&#160;</td>
 449         </tr>
 450         <tr>
 451           <td></td>
 452           <td>)</td>
 453           <td></td><td></td>
 454         </tr>
 455       </table>
 456   </td>
 457   <td class="mlabels-right">
 458 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 459   </tr>
 460 </table>
 461 </div><div class="memdoc">
 462
 463 <p>Set IRQ quiet mode in a channel configuration object. </p>
 464 <p >In QUIET mode, the channel does not generate IRQs at the end of every transfer block. Instead, an IRQ is raised when NULL is written to a trigger register, indicating the end of a control block chain.</p>
 465 <dl class="params"><dt>Parameters</dt><dd>
 466   <table class="params">
 467     <tr><td class="paramname">c</td><td>Pointer to channel configuration object </td></tr>
 468     <tr><td class="paramname">irq_quiet</td><td>True to enable quiet mode, false to disable. </td></tr>
 469   </table>
 470   </dd>
 471 </dl>
 472
 473 </div>
 474 </div>
 475 <a id="ga28d1103cea7f7d73406a2aee44bfebd9" name="ga28d1103cea7f7d73406a2aee44bfebd9"></a>
 476 <h2 class="memtitle"><span class="permalink"><a href="#ga28d1103cea7f7d73406a2aee44bfebd9">&#9670;&nbsp;</a></span>channel_config_set_read_increment()</h2>
 477
 478 <div class="memitem">
 479 <div class="memproto">
 480 <table class="mlabels">
 481   <tr>
 482   <td class="mlabels-left">
 483       <table class="memname">
 484         <tr>
 485           <td class="memname">static void channel_config_set_read_increment </td>
 486           <td>(</td>
 487           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 488           <td class="paramname"><em>c</em>, </td>
 489         </tr>
 490         <tr>
 491           <td class="paramkey"></td>
 492           <td></td>
 493           <td class="paramtype">bool&#160;</td>
 494           <td class="paramname"><em>incr</em>&#160;</td>
 495         </tr>
 496         <tr>
 497           <td></td>
 498           <td>)</td>
 499           <td></td><td></td>
 500         </tr>
 501       </table>
 502   </td>
 503   <td class="mlabels-right">
 504 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 505   </tr>
 506 </table>
 507 </div><div class="memdoc">
 508
 509 <p>Set DMA channel read increment in a channel configuration object. </p>
 510 <dl class="params"><dt>Parameters</dt><dd>
 511   <table class="params">
 512     <tr><td class="paramname">c</td><td>Pointer to channel configuration object </td></tr>
 513     <tr><td class="paramname">incr</td><td>True to enable read address increments, if false, each read will be from the same address Usually disabled for peripheral to memory transfers </td></tr>
 514   </table>
 515   </dd>
 516 </dl>
 517
 518 </div>
 519 </div>
 520 <a id="gadd7ee73f3652261ae5e195b709cc6dc0" name="gadd7ee73f3652261ae5e195b709cc6dc0"></a>
 521 <h2 class="memtitle"><span class="permalink"><a href="#gadd7ee73f3652261ae5e195b709cc6dc0">&#9670;&nbsp;</a></span>channel_config_set_ring()</h2>
 522
 523 <div class="memitem">
 524 <div class="memproto">
 525 <table class="mlabels">
 526   <tr>
 527   <td class="mlabels-left">
 528       <table class="memname">
 529         <tr>
 530           <td class="memname">static void channel_config_set_ring </td>
 531           <td>(</td>
 532           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 533           <td class="paramname"><em>c</em>, </td>
 534         </tr>
 535         <tr>
 536           <td class="paramkey"></td>
 537           <td></td>
 538           <td class="paramtype">bool&#160;</td>
 539           <td class="paramname"><em>write</em>, </td>
 540         </tr>
 541         <tr>
 542           <td class="paramkey"></td>
 543           <td></td>
 544           <td class="paramtype">uint&#160;</td>
 545           <td class="paramname"><em>size_bits</em>&#160;</td>
 546         </tr>
 547         <tr>
 548           <td></td>
 549           <td>)</td>
 550           <td></td><td></td>
 551         </tr>
 552       </table>
 553   </td>
 554   <td class="mlabels-right">
 555 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 556   </tr>
 557 </table>
 558 </div><div class="memdoc">
 559
 560 <p>Set address wrapping parameters in a channel configuration object. </p>
 561 <p >Size of address wrap region. If 0, don’t wrap. For values n &gt; 0, only the lower n bits of the address will change. This wraps the address on a (1 &lt;&lt; n) byte boundary, facilitating access to naturally-aligned ring buffers. Ring sizes between 2 and 32768 bytes are possible (size_bits from 1 - 15)</p>
 562 <p >0x0 -&gt; No wrapping.</p>
 563 <dl class="params"><dt>Parameters</dt><dd>
 564   <table class="params">
 565     <tr><td class="paramname">c</td><td>Pointer to channel configuration object </td></tr>
 566     <tr><td class="paramname">write</td><td>True to apply to write addresses, false to apply to read addresses </td></tr>
 567     <tr><td class="paramname">size_bits</td><td>0 to disable wrapping. Otherwise the size in bits of the changing part of the address. Effectively wraps the address on a (1 &lt;&lt; size_bits) byte boundary. </td></tr>
 568   </table>
 569   </dd>
 570 </dl>
 571
 572 </div>
 573 </div>
 574 <a id="ga5eb02f42a33115052031d0b457fa2674" name="ga5eb02f42a33115052031d0b457fa2674"></a>
 575 <h2 class="memtitle"><span class="permalink"><a href="#ga5eb02f42a33115052031d0b457fa2674">&#9670;&nbsp;</a></span>channel_config_set_sniff_enable()</h2>
 576
 577 <div class="memitem">
 578 <div class="memproto">
 579 <table class="mlabels">
 580   <tr>
 581   <td class="mlabels-left">
 582       <table class="memname">
 583         <tr>
 584           <td class="memname">static void channel_config_set_sniff_enable </td>
 585           <td>(</td>
 586           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 587           <td class="paramname"><em>c</em>, </td>
 588         </tr>
 589         <tr>
 590           <td class="paramkey"></td>
 591           <td></td>
 592           <td class="paramtype">bool&#160;</td>
 593           <td class="paramname"><em>sniff_enable</em>&#160;</td>
 594         </tr>
 595         <tr>
 596           <td></td>
 597           <td>)</td>
 598           <td></td><td></td>
 599         </tr>
 600       </table>
 601   </td>
 602   <td class="mlabels-right">
 603 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 604   </tr>
 605 </table>
 606 </div><div class="memdoc">
 607
 608 <p>Enable access to channel by sniff hardware in a channel configuration object. </p>
 609 <p >Sniff HW must be enabled and have this channel selected.</p>
 610 <dl class="params"><dt>Parameters</dt><dd>
 611   <table class="params">
 612     <tr><td class="paramname">c</td><td>Pointer to channel configuration object </td></tr>
 613     <tr><td class="paramname">sniff_enable</td><td>True to enable the Sniff HW access to this DMA channel. </td></tr>
 614   </table>
 615   </dd>
 616 </dl>
 617
 618 </div>
 619 </div>
 620 <a id="gad1a02fcee90d21f133460006b025bac0" name="gad1a02fcee90d21f133460006b025bac0"></a>
 621 <h2 class="memtitle"><span class="permalink"><a href="#gad1a02fcee90d21f133460006b025bac0">&#9670;&nbsp;</a></span>channel_config_set_transfer_data_size()</h2>
 622
 623 <div class="memitem">
 624 <div class="memproto">
 625 <table class="mlabels">
 626   <tr>
 627   <td class="mlabels-left">
 628       <table class="memname">
 629         <tr>
 630           <td class="memname">static void channel_config_set_transfer_data_size </td>
 631           <td>(</td>
 632           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 633           <td class="paramname"><em>c</em>, </td>
 634         </tr>
 635         <tr>
 636           <td class="paramkey"></td>
 637           <td></td>
 638           <td class="paramtype">enum <a class="el" href="group__hardware__dma.html#gaccecdff367b06a019373e9a55d4f3e01">dma_channel_transfer_size</a>&#160;</td>
 639           <td class="paramname"><em>size</em>&#160;</td>
 640         </tr>
 641         <tr>
 642           <td></td>
 643           <td>)</td>
 644           <td></td><td></td>
 645         </tr>
 646       </table>
 647   </td>
 648   <td class="mlabels-right">
 649 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 650   </tr>
 651 </table>
 652 </div><div class="memdoc">
 653
 654 <p>Set the size of each DMA bus transfer in a channel configuration object. </p>
 655 <p >Set the size of each bus transfer (byte/halfword/word). The read and write addresses advance by the specific amount (1/2/4 bytes) with each transfer.</p>
 656 <dl class="params"><dt>Parameters</dt><dd>
 657   <table class="params">
 658     <tr><td class="paramname">c</td><td>Pointer to channel configuration object </td></tr>
 659     <tr><td class="paramname">size</td><td>See enum for possible values. </td></tr>
 660   </table>
 661   </dd>
 662 </dl>
 663
 664 </div>
 665 </div>
 666 <a id="ga864c9d35a39c315f2972b7272f860e9e" name="ga864c9d35a39c315f2972b7272f860e9e"></a>
 667 <h2 class="memtitle"><span class="permalink"><a href="#ga864c9d35a39c315f2972b7272f860e9e">&#9670;&nbsp;</a></span>channel_config_set_write_increment()</h2>
 668
 669 <div class="memitem">
 670 <div class="memproto">
 671 <table class="mlabels">
 672   <tr>
 673   <td class="mlabels-left">
 674       <table class="memname">
 675         <tr>
 676           <td class="memname">static void channel_config_set_write_increment </td>
 677           <td>(</td>
 678           <td class="paramtype"><a class="el" href="structdma__channel__config.html">dma_channel_config</a> *&#160;</td>
 679           <td class="paramname"><em>c</em>, </td>
 680         </tr>
 681         <tr>
 682           <td class="paramkey"></td>
 683           <td></td>
 684           <td class="paramtype">bool&#160;</td>
 685           <td class="paramname"><em>incr</em>&#160;</td>
 686         </tr>
 687         <tr>
 688           <td></td>
 689           <td>)</td>
 690           <td></td><td></td>
 691         </tr>
 692       </table>
 693   </td>
 694   <td class="mlabels-right">
 695 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 696   </tr>
 697 </table>
 698 </div><div class="memdoc">
 699
 700 <p>Set DMA channel write increment in a channel configuration object. </p>
 701 <dl class="params"><dt>Parameters</dt><dd>
 702   <table class="params">
 703     <tr><td class="paramname">c</td><td>Pointer to channel configuration object </td></tr>
 704     <tr><td class="paramname">incr</td><td>True to enable write address increments, if false, each write will be to the same address Usually disabled for memory to peripheral transfers </td></tr>
 705   </table>
 706   </dd>
 707 </dl>
 708
 709 </div>
 710 </div>
 711 <a id="ga432f0d010da5935d333c27fbce0135f8" name="ga432f0d010da5935d333c27fbce0135f8"></a>
 712 <h2 class="memtitle"><span class="permalink"><a href="#ga432f0d010da5935d333c27fbce0135f8">&#9670;&nbsp;</a></span>dma_channel_get_default_config()</h2>
 713
 714 <div class="memitem">
 715 <div class="memproto">
 716 <table class="mlabels">
 717   <tr>
 718   <td class="mlabels-left">
 719       <table class="memname">
 720         <tr>
 721           <td class="memname">static <a class="el" href="structdma__channel__config.html">dma_channel_config</a> dma_channel_get_default_config </td>
 722           <td>(</td>
 723           <td class="paramtype">uint&#160;</td>
 724           <td class="paramname"><em>channel</em></td><td>)</td>
 725           <td></td>
 726         </tr>
 727       </table>
 728   </td>
 729   <td class="mlabels-right">
 730 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 731   </tr>
 732 </table>
 733 </div><div class="memdoc">
 734
 735 <p>Get the default channel configuration for a given channel. </p>
 736 <table class="markdownTable">
 737 <tr class="markdownTableHead">
 738 <th class="markdownTableHeadNone">Setting   </th><th class="markdownTableHeadNone">Default    </th></tr>
 739 <tr class="markdownTableRowOdd">
 740 <td class="markdownTableBodyNone">Read Increment   </td><td class="markdownTableBodyNone">true    </td></tr>
 741 <tr class="markdownTableRowEven">
 742 <td class="markdownTableBodyNone">Write Increment   </td><td class="markdownTableBodyNone">false    </td></tr>
 743 <tr class="markdownTableRowOdd">
 744 <td class="markdownTableBodyNone">DReq   </td><td class="markdownTableBodyNone">DREQ_FORCE    </td></tr>
 745 <tr class="markdownTableRowEven">
 746 <td class="markdownTableBodyNone">Chain to   </td><td class="markdownTableBodyNone">self    </td></tr>
 747 <tr class="markdownTableRowOdd">
 748 <td class="markdownTableBodyNone">Data size   </td><td class="markdownTableBodyNone">DMA_SIZE_32    </td></tr>
 749 <tr class="markdownTableRowEven">
 750 <td class="markdownTableBodyNone">Ring   </td><td class="markdownTableBodyNone">write=false, size=0 (i.e. off)    </td></tr>
 751 <tr class="markdownTableRowOdd">
 752 <td class="markdownTableBodyNone">Byte Swap   </td><td class="markdownTableBodyNone">false    </td></tr>
 753 <tr class="markdownTableRowEven">
 754 <td class="markdownTableBodyNone">Quiet IRQs   </td><td class="markdownTableBodyNone">false    </td></tr>
 755 <tr class="markdownTableRowOdd">
 756 <td class="markdownTableBodyNone">High Priority   </td><td class="markdownTableBodyNone">false    </td></tr>
 757 <tr class="markdownTableRowEven">
 758 <td class="markdownTableBodyNone">Channel Enable   </td><td class="markdownTableBodyNone">true    </td></tr>
 759 <tr class="markdownTableRowOdd">
 760 <td class="markdownTableBodyNone">Sniff Enable   </td><td class="markdownTableBodyNone">false   </td></tr>
 761 </table>
 762 <dl class="params"><dt>Parameters</dt><dd>
 763   <table class="params">
 764     <tr><td class="paramname">channel</td><td>DMA channel </td></tr>
 765   </table>
 766   </dd>
 767 </dl>
 768 <dl class="section return"><dt>Returns</dt><dd>the default configuration which can then be modified. </dd></dl>
 769
 770 </div>
 771 </div>
 772 <a id="ga369ee3104c5a9b5a32673c163a499a1d" name="ga369ee3104c5a9b5a32673c163a499a1d"></a>
 773 <h2 class="memtitle"><span class="permalink"><a href="#ga369ee3104c5a9b5a32673c163a499a1d">&#9670;&nbsp;</a></span>dma_get_channel_config()</h2>
 774
 775 <div class="memitem">
 776 <div class="memproto">
 777 <table class="mlabels">
 778   <tr>
 779   <td class="mlabels-left">
 780       <table class="memname">
 781         <tr>
 782           <td class="memname">static <a class="el" href="structdma__channel__config.html">dma_channel_config</a> dma_get_channel_config </td>
 783           <td>(</td>
 784           <td class="paramtype">uint&#160;</td>
 785           <td class="paramname"><em>channel</em></td><td>)</td>
 786           <td></td>
 787         </tr>
 788       </table>
 789   </td>
 790   <td class="mlabels-right">
 791 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 792   </tr>
 793 </table>
 794 </div><div class="memdoc">
 795
 796 <p>Get the current configuration for the specified channel. </p>
 797 <dl class="params"><dt>Parameters</dt><dd>
 798   <table class="params">
 799     <tr><td class="paramname">channel</td><td>DMA channel </td></tr>
 800   </table>
 801   </dd>
 802 </dl>
 803 <dl class="section return"><dt>Returns</dt><dd>The current configuration as read from the HW register (not cached) </dd></dl>
 804
 805 </div>
 806 </div>
 807 </div><!-- contents -->
 808 </div><!-- doc-content -->
 809
 810         <script src="main.js"></script>
 811 </body>
 812 </html>