web/docs/group__hardware__pwm.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: hardware_pwm</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                                 v1.5.1
  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__hardware__pwm.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="#enum-members">Enumerations</a> &#124;
 107 <a href="#func-members">Functions</a>  </div>
 108   <div class="headertitle"><div class="title">hardware_pwm<div class="ingroups"><a class="el" href="group__hardware.html">Hardware APIs</a></div></div></div>
 109 </div><!--header-->
 110 <div class="contents">
 111 <table class="memberdecls">
 112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 113 Enumerations</h2></td></tr>
 114 <tr class="memitem:ga0a00197703c8606641488cfff3f660e6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga0a00197703c8606641488cfff3f660e6">pwm_clkdiv_mode</a> { <a class="el" href="group__hardware__pwm.html#gga0a00197703c8606641488cfff3f660e6acd3efbc3feaca58b87930008fdd8486b">PWM_DIV_FREE_RUNNING</a> = 0
 115 , <a class="el" href="group__hardware__pwm.html#gga0a00197703c8606641488cfff3f660e6a186c27a4768fcb0c6930471db51861b7">PWM_DIV_B_HIGH</a> = 1
 116 , <a class="el" href="group__hardware__pwm.html#gga0a00197703c8606641488cfff3f660e6ad9d2170532c2c9ab4016908544c8ad40">PWM_DIV_B_RISING</a> = 2
 117 , <a class="el" href="group__hardware__pwm.html#gga0a00197703c8606641488cfff3f660e6a0b4afcaa75090169d3b7cbec4c0e2012">PWM_DIV_B_FALLING</a> = 3
 118  }</td></tr>
 119 <tr class="memdesc:ga0a00197703c8606641488cfff3f660e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">PWM Divider mode settings.  <a href="group__hardware__pwm.html#ga0a00197703c8606641488cfff3f660e6">More...</a><br /></td></tr>
 120 <tr class="separator:ga0a00197703c8606641488cfff3f660e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 </table><table class="memberdecls">
 122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 123 Functions</h2></td></tr>
 124 <tr class="memitem:ga8b2117d67a544f64c001f4f32c723eef"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga8b2117d67a544f64c001f4f32c723eef">pwm_gpio_to_slice_num</a> (uint gpio)</td></tr>
 125 <tr class="memdesc:ga8b2117d67a544f64c001f4f32c723eef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine the PWM slice that is attached to the specified GPIO.  <a href="group__hardware__pwm.html#ga8b2117d67a544f64c001f4f32c723eef">More...</a><br /></td></tr>
 126 <tr class="separator:ga8b2117d67a544f64c001f4f32c723eef"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 <tr class="memitem:ga96ba504fe00cb8e0d88f0730cdfdaafc"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga96ba504fe00cb8e0d88f0730cdfdaafc">pwm_gpio_to_channel</a> (uint gpio)</td></tr>
 128 <tr class="memdesc:ga96ba504fe00cb8e0d88f0730cdfdaafc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine the PWM channel that is attached to the specified GPIO.  <a href="group__hardware__pwm.html#ga96ba504fe00cb8e0d88f0730cdfdaafc">More...</a><br /></td></tr>
 129 <tr class="separator:ga96ba504fe00cb8e0d88f0730cdfdaafc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 <tr class="memitem:ga031fe8a502c9640ed4f5fab74d6248ae"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga031fe8a502c9640ed4f5fab74d6248ae">pwm_config_set_phase_correct</a> (<a class="el" href="structpwm__config.html">pwm_config</a> *c, bool phase_correct)</td></tr>
 131 <tr class="memdesc:ga031fe8a502c9640ed4f5fab74d6248ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set phase correction in a PWM configuration.  <a href="group__hardware__pwm.html#ga031fe8a502c9640ed4f5fab74d6248ae">More...</a><br /></td></tr>
 132 <tr class="separator:ga031fe8a502c9640ed4f5fab74d6248ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:ga679802450ac829eff368e8f109df387e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga679802450ac829eff368e8f109df387e">pwm_config_set_clkdiv</a> (<a class="el" href="structpwm__config.html">pwm_config</a> *c, float div)</td></tr>
 134 <tr class="memdesc:ga679802450ac829eff368e8f109df387e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM clock divider in a PWM configuration.  <a href="group__hardware__pwm.html#ga679802450ac829eff368e8f109df387e">More...</a><br /></td></tr>
 135 <tr class="separator:ga679802450ac829eff368e8f109df387e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:ga3b0d7a6e493b4dc9ded8f53fb9be474c"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga3b0d7a6e493b4dc9ded8f53fb9be474c">pwm_config_set_clkdiv_int_frac</a> (<a class="el" href="structpwm__config.html">pwm_config</a> *c, uint8_t integer, uint8_t fract)</td></tr>
 137 <tr class="memdesc:ga3b0d7a6e493b4dc9ded8f53fb9be474c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM clock divider in a PWM configuration using an 8:4 fractional value.  <a href="group__hardware__pwm.html#ga3b0d7a6e493b4dc9ded8f53fb9be474c">More...</a><br /></td></tr>
 138 <tr class="separator:ga3b0d7a6e493b4dc9ded8f53fb9be474c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:ga1d60d45df884a7abbde52e326586d55a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga1d60d45df884a7abbde52e326586d55a">pwm_config_set_clkdiv_int</a> (<a class="el" href="structpwm__config.html">pwm_config</a> *c, uint div)</td></tr>
 140 <tr class="memdesc:ga1d60d45df884a7abbde52e326586d55a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM clock divider in a PWM configuration.  <a href="group__hardware__pwm.html#ga1d60d45df884a7abbde52e326586d55a">More...</a><br /></td></tr>
 141 <tr class="separator:ga1d60d45df884a7abbde52e326586d55a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:ga27a86a921b2ad2ebd811db1255d34d06"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga27a86a921b2ad2ebd811db1255d34d06">pwm_config_set_clkdiv_mode</a> (<a class="el" href="structpwm__config.html">pwm_config</a> *c, enum <a class="el" href="group__hardware__pwm.html#ga0a00197703c8606641488cfff3f660e6">pwm_clkdiv_mode</a> mode)</td></tr>
 143 <tr class="memdesc:ga27a86a921b2ad2ebd811db1255d34d06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM counting mode in a PWM configuration.  <a href="group__hardware__pwm.html#ga27a86a921b2ad2ebd811db1255d34d06">More...</a><br /></td></tr>
 144 <tr class="separator:ga27a86a921b2ad2ebd811db1255d34d06"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:gab459185e217d5e215dae3cfb3d6de1b5"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#gab459185e217d5e215dae3cfb3d6de1b5">pwm_config_set_output_polarity</a> (<a class="el" href="structpwm__config.html">pwm_config</a> *c, bool a, bool b)</td></tr>
 146 <tr class="memdesc:gab459185e217d5e215dae3cfb3d6de1b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set output polarity in a PWM configuration.  <a href="group__hardware__pwm.html#gab459185e217d5e215dae3cfb3d6de1b5">More...</a><br /></td></tr>
 147 <tr class="separator:gab459185e217d5e215dae3cfb3d6de1b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:gad6cf6d9237144234732a50eb6d5e4fe9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#gad6cf6d9237144234732a50eb6d5e4fe9">pwm_config_set_wrap</a> (<a class="el" href="structpwm__config.html">pwm_config</a> *c, uint16_t wrap)</td></tr>
 149 <tr class="memdesc:gad6cf6d9237144234732a50eb6d5e4fe9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM counter wrap value in a PWM configuration.  <a href="group__hardware__pwm.html#gad6cf6d9237144234732a50eb6d5e4fe9">More...</a><br /></td></tr>
 150 <tr class="separator:gad6cf6d9237144234732a50eb6d5e4fe9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:ga01d3e90bb7aa9a8b6884eddbfbebc175"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga01d3e90bb7aa9a8b6884eddbfbebc175">pwm_init</a> (uint slice_num, <a class="el" href="structpwm__config.html">pwm_config</a> *c, bool start)</td></tr>
 152 <tr class="memdesc:ga01d3e90bb7aa9a8b6884eddbfbebc175"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a PWM with settings from a configuration object.  <a href="group__hardware__pwm.html#ga01d3e90bb7aa9a8b6884eddbfbebc175">More...</a><br /></td></tr>
 153 <tr class="separator:ga01d3e90bb7aa9a8b6884eddbfbebc175"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:gad76f94a6dd6133c52284b6be8ae98e16"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structpwm__config.html">pwm_config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#gad76f94a6dd6133c52284b6be8ae98e16">pwm_get_default_config</a> (void)</td></tr>
 155 <tr class="memdesc:gad76f94a6dd6133c52284b6be8ae98e16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a set of default values for PWM configuration.  <a href="group__hardware__pwm.html#gad76f94a6dd6133c52284b6be8ae98e16">More...</a><br /></td></tr>
 156 <tr class="separator:gad76f94a6dd6133c52284b6be8ae98e16"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:ga6f8fe346e6912cfab3d36b00043a3627"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga6f8fe346e6912cfab3d36b00043a3627">pwm_set_wrap</a> (uint slice_num, uint16_t wrap)</td></tr>
 158 <tr class="memdesc:ga6f8fe346e6912cfab3d36b00043a3627"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current PWM counter wrap value.  <a href="group__hardware__pwm.html#ga6f8fe346e6912cfab3d36b00043a3627">More...</a><br /></td></tr>
 159 <tr class="separator:ga6f8fe346e6912cfab3d36b00043a3627"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:ga18a2b3bbc240d1a9b36526d69c06ec3d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga18a2b3bbc240d1a9b36526d69c06ec3d">pwm_set_chan_level</a> (uint slice_num, uint chan, uint16_t level)</td></tr>
 161 <tr class="memdesc:ga18a2b3bbc240d1a9b36526d69c06ec3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current PWM counter compare value for one channel.  <a href="group__hardware__pwm.html#ga18a2b3bbc240d1a9b36526d69c06ec3d">More...</a><br /></td></tr>
 162 <tr class="separator:ga18a2b3bbc240d1a9b36526d69c06ec3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:gae7064c88717eee935e50138f5b0ae2b7"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#gae7064c88717eee935e50138f5b0ae2b7">pwm_set_both_levels</a> (uint slice_num, uint16_t level_a, uint16_t level_b)</td></tr>
 164 <tr class="memdesc:gae7064c88717eee935e50138f5b0ae2b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM counter compare values.  <a href="group__hardware__pwm.html#gae7064c88717eee935e50138f5b0ae2b7">More...</a><br /></td></tr>
 165 <tr class="separator:gae7064c88717eee935e50138f5b0ae2b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <tr class="memitem:ga279d1ba7dcc8f19619f389317efb41fd"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga279d1ba7dcc8f19619f389317efb41fd">pwm_set_gpio_level</a> (uint gpio, uint16_t level)</td></tr>
 167 <tr class="memdesc:ga279d1ba7dcc8f19619f389317efb41fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to set the PWM level for the slice and channel associated with a GPIO.  <a href="group__hardware__pwm.html#ga279d1ba7dcc8f19619f389317efb41fd">More...</a><br /></td></tr>
 168 <tr class="separator:ga279d1ba7dcc8f19619f389317efb41fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <tr class="memitem:ga157c8b11483967714823187725a5ed5a"><td class="memItemLeft" align="right" valign="top">static uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga157c8b11483967714823187725a5ed5a">pwm_get_counter</a> (uint slice_num)</td></tr>
 170 <tr class="memdesc:ga157c8b11483967714823187725a5ed5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get PWM counter.  <a href="group__hardware__pwm.html#ga157c8b11483967714823187725a5ed5a">More...</a><br /></td></tr>
 171 <tr class="separator:ga157c8b11483967714823187725a5ed5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <tr class="memitem:ga5179ec971146ab611b9232587e945769"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga5179ec971146ab611b9232587e945769">pwm_set_counter</a> (uint slice_num, uint16_t c)</td></tr>
 173 <tr class="memdesc:ga5179ec971146ab611b9232587e945769"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM counter.  <a href="group__hardware__pwm.html#ga5179ec971146ab611b9232587e945769">More...</a><br /></td></tr>
 174 <tr class="separator:ga5179ec971146ab611b9232587e945769"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <tr class="memitem:ga98a47b25fcc2f28addf0a28ee3234efd"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga98a47b25fcc2f28addf0a28ee3234efd">pwm_advance_count</a> (uint slice_num)</td></tr>
 176 <tr class="memdesc:ga98a47b25fcc2f28addf0a28ee3234efd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance PWM count.  <a href="group__hardware__pwm.html#ga98a47b25fcc2f28addf0a28ee3234efd">More...</a><br /></td></tr>
 177 <tr class="separator:ga98a47b25fcc2f28addf0a28ee3234efd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 <tr class="memitem:ga0dec65009d8c0738677818b680fd2ad9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga0dec65009d8c0738677818b680fd2ad9">pwm_retard_count</a> (uint slice_num)</td></tr>
 179 <tr class="memdesc:ga0dec65009d8c0738677818b680fd2ad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retard PWM count.  <a href="group__hardware__pwm.html#ga0dec65009d8c0738677818b680fd2ad9">More...</a><br /></td></tr>
 180 <tr class="separator:ga0dec65009d8c0738677818b680fd2ad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 <tr class="memitem:ga0da8e86adb7de041a6b8607b36aee442"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga0da8e86adb7de041a6b8607b36aee442">pwm_set_clkdiv_int_frac</a> (uint slice_num, uint8_t integer, uint8_t fract)</td></tr>
 182 <tr class="memdesc:ga0da8e86adb7de041a6b8607b36aee442"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM clock divider using an 8:4 fractional value.  <a href="group__hardware__pwm.html#ga0da8e86adb7de041a6b8607b36aee442">More...</a><br /></td></tr>
 183 <tr class="separator:ga0da8e86adb7de041a6b8607b36aee442"><td class="memSeparator" colspan="2">&#160;</td></tr>
 184 <tr class="memitem:ga94782fc53adb07a3594ae0939d9a2e3e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga94782fc53adb07a3594ae0939d9a2e3e">pwm_set_clkdiv</a> (uint slice_num, float divider)</td></tr>
 185 <tr class="memdesc:ga94782fc53adb07a3594ae0939d9a2e3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM clock divider.  <a href="group__hardware__pwm.html#ga94782fc53adb07a3594ae0939d9a2e3e">More...</a><br /></td></tr>
 186 <tr class="separator:ga94782fc53adb07a3594ae0939d9a2e3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 187 <tr class="memitem:gab12ab09d76aed43a36f973232718fdd6"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#gab12ab09d76aed43a36f973232718fdd6">pwm_set_output_polarity</a> (uint slice_num, bool a, bool b)</td></tr>
 188 <tr class="memdesc:gab12ab09d76aed43a36f973232718fdd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM output polarity.  <a href="group__hardware__pwm.html#gab12ab09d76aed43a36f973232718fdd6">More...</a><br /></td></tr>
 189 <tr class="separator:gab12ab09d76aed43a36f973232718fdd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 190 <tr class="memitem:ga1ee213ebb13b98dc81e60a512f696227"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga1ee213ebb13b98dc81e60a512f696227">pwm_set_clkdiv_mode</a> (uint slice_num, enum <a class="el" href="group__hardware__pwm.html#ga0a00197703c8606641488cfff3f660e6">pwm_clkdiv_mode</a> mode)</td></tr>
 191 <tr class="memdesc:ga1ee213ebb13b98dc81e60a512f696227"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM divider mode.  <a href="group__hardware__pwm.html#ga1ee213ebb13b98dc81e60a512f696227">More...</a><br /></td></tr>
 192 <tr class="separator:ga1ee213ebb13b98dc81e60a512f696227"><td class="memSeparator" colspan="2">&#160;</td></tr>
 193 <tr class="memitem:gacb2a1995f0bfdb12345607b903c3f11e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#gacb2a1995f0bfdb12345607b903c3f11e">pwm_set_phase_correct</a> (uint slice_num, bool phase_correct)</td></tr>
 194 <tr class="memdesc:gacb2a1995f0bfdb12345607b903c3f11e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set PWM phase correct on/off.  <a href="group__hardware__pwm.html#gacb2a1995f0bfdb12345607b903c3f11e">More...</a><br /></td></tr>
 195 <tr class="separator:gacb2a1995f0bfdb12345607b903c3f11e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 196 <tr class="memitem:ga216496c331542eb57199018fa86b4408"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga216496c331542eb57199018fa86b4408">pwm_set_enabled</a> (uint slice_num, bool enabled)</td></tr>
 197 <tr class="memdesc:ga216496c331542eb57199018fa86b4408"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/Disable PWM.  <a href="group__hardware__pwm.html#ga216496c331542eb57199018fa86b4408">More...</a><br /></td></tr>
 198 <tr class="separator:ga216496c331542eb57199018fa86b4408"><td class="memSeparator" colspan="2">&#160;</td></tr>
 199 <tr class="memitem:ga257ea7fd33fcf33815a01dd279ca578d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga257ea7fd33fcf33815a01dd279ca578d">pwm_set_mask_enabled</a> (uint32_t mask)</td></tr>
 200 <tr class="memdesc:ga257ea7fd33fcf33815a01dd279ca578d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/Disable multiple PWM slices simultaneously.  <a href="group__hardware__pwm.html#ga257ea7fd33fcf33815a01dd279ca578d">More...</a><br /></td></tr>
 201 <tr class="separator:ga257ea7fd33fcf33815a01dd279ca578d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 202 <tr class="memitem:ga093a3c371dda3aa2291331147337265e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga093a3c371dda3aa2291331147337265e">pwm_set_irq_enabled</a> (uint slice_num, bool enabled)</td></tr>
 203 <tr class="memdesc:ga093a3c371dda3aa2291331147337265e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable PWM instance interrupt.  <a href="group__hardware__pwm.html#ga093a3c371dda3aa2291331147337265e">More...</a><br /></td></tr>
 204 <tr class="separator:ga093a3c371dda3aa2291331147337265e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 205 <tr class="memitem:gac32a9b468ddbd49bad6ebff6789fd215"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#gac32a9b468ddbd49bad6ebff6789fd215">pwm_set_irq_mask_enabled</a> (uint32_t slice_mask, bool enabled)</td></tr>
 206 <tr class="memdesc:gac32a9b468ddbd49bad6ebff6789fd215"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable multiple PWM instance interrupts.  <a href="group__hardware__pwm.html#gac32a9b468ddbd49bad6ebff6789fd215">More...</a><br /></td></tr>
 207 <tr class="separator:gac32a9b468ddbd49bad6ebff6789fd215"><td class="memSeparator" colspan="2">&#160;</td></tr>
 208 <tr class="memitem:ga8d4482b5e125e30bc166d3ed33d8ba2d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga8d4482b5e125e30bc166d3ed33d8ba2d">pwm_clear_irq</a> (uint slice_num)</td></tr>
 209 <tr class="memdesc:ga8d4482b5e125e30bc166d3ed33d8ba2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear a single PWM channel interrupt.  <a href="group__hardware__pwm.html#ga8d4482b5e125e30bc166d3ed33d8ba2d">More...</a><br /></td></tr>
 210 <tr class="separator:ga8d4482b5e125e30bc166d3ed33d8ba2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 211 <tr class="memitem:ga565a6b6d19b60b10f5a91b11152cc8c2"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga565a6b6d19b60b10f5a91b11152cc8c2">pwm_get_irq_status_mask</a> (void)</td></tr>
 212 <tr class="memdesc:ga565a6b6d19b60b10f5a91b11152cc8c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get PWM interrupt status, raw.  <a href="group__hardware__pwm.html#ga565a6b6d19b60b10f5a91b11152cc8c2">More...</a><br /></td></tr>
 213 <tr class="separator:ga565a6b6d19b60b10f5a91b11152cc8c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 214 <tr class="memitem:ga457ee599e471a8da59c42f5c26710ff6"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga457ee599e471a8da59c42f5c26710ff6">pwm_force_irq</a> (uint slice_num)</td></tr>
 215 <tr class="memdesc:ga457ee599e471a8da59c42f5c26710ff6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force PWM interrupt.  <a href="group__hardware__pwm.html#ga457ee599e471a8da59c42f5c26710ff6">More...</a><br /></td></tr>
 216 <tr class="separator:ga457ee599e471a8da59c42f5c26710ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 217 <tr class="memitem:ga2f600a7192ecd69a8680be367e8d0a00"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__pwm.html#ga2f600a7192ecd69a8680be367e8d0a00">pwm_get_dreq</a> (uint slice_num)</td></tr>
 218 <tr class="memdesc:ga2f600a7192ecd69a8680be367e8d0a00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the DREQ to use for pacing transfers to a particular PWM slice.  <a href="group__hardware__pwm.html#ga2f600a7192ecd69a8680be367e8d0a00">More...</a><br /></td></tr>
 219 <tr class="separator:ga2f600a7192ecd69a8680be367e8d0a00"><td class="memSeparator" colspan="2">&#160;</td></tr>
 220 </table>
 221 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 222 <p >Hardware Pulse Width Modulation (PWM) API</p>
 223 <p >The RP2040 PWM block has 8 identical slices. Each slice can drive two PWM output signals, or measure the frequency or duty cycle of an input signal. This gives a total of up to 16 controllable PWM outputs. All 30 GPIOs can be driven by the PWM block.</p>
 224 <p >The PWM hardware functions by continuously comparing the input value to a free-running counter. This produces a toggling output where the amount of time spent at the high output level is proportional to the input value. The fraction of time spent at the high signal level is known as the duty cycle of the signal.</p>
 225 <p >The default behaviour of a PWM slice is to count upward until the wrap value (<a class="el" href="group__hardware__pwm.html#gad6cf6d9237144234732a50eb6d5e4fe9">pwm_config_set_wrap</a>) is reached, and then immediately wrap to 0. PWM slices also offer a phase-correct mode, where the counter starts to count downward after reaching TOP, until it reaches 0 again.</p>
 226 <h2><a class="anchor" id="pwm_example"></a>
 227 Example</h2>
 228 <div class="fragment"><div class="line"> </div>
 229 <div class="line"><span class="comment">// Output PWM signals on pins 0 and 1</span></div>
 230 <div class="line"> </div>
 231 <div class="line"><span class="preprocessor">#include &quot;<a class="code" href="stdlib_8h.html">pico/stdlib.h</a>&quot;</span></div>
 232 <div class="line"><span class="preprocessor">#include &quot;<a class="code" href="rp2__common_2hardware__pwm_2include_2hardware_2pwm_8h.html">hardware/pwm.h</a>&quot;</span></div>
 233 <div class="line"> </div>
 234 <div class="line"><span class="keywordtype">int</span> main() {</div>
 235 <div class="line"> </div>
 236 <div class="line">    <span class="comment">// Tell GPIO 0 and 1 they are allocated to the PWM</span></div>
 237 <div class="line">    <a class="code hl_function" href="group__hardware__gpio.html#gaacde9174277ca40aa7b6fdd341bb2b8c">gpio_set_function</a>(0, GPIO_FUNC_PWM);</div>
 238 <div class="line">    <a class="code hl_function" href="group__hardware__gpio.html#gaacde9174277ca40aa7b6fdd341bb2b8c">gpio_set_function</a>(1, GPIO_FUNC_PWM);</div>
 239 <div class="line"> </div>
 240 <div class="line">    <span class="comment">// Find out which PWM slice is connected to GPIO 0 (it&#39;s slice 0)</span></div>
 241 <div class="line">    uint slice_num = <a class="code hl_function" href="group__hardware__pwm.html#ga8b2117d67a544f64c001f4f32c723eef">pwm_gpio_to_slice_num</a>(0);</div>
 242 <div class="line"> </div>
 243 <div class="line">    <span class="comment">// Set period of 4 cycles (0 to 3 inclusive)</span></div>
 244 <div class="line">    <a class="code hl_function" href="group__hardware__pwm.html#ga6f8fe346e6912cfab3d36b00043a3627">pwm_set_wrap</a>(slice_num, 3);</div>
 245 <div class="line">    <span class="comment">// Set channel A output high for one cycle before dropping</span></div>
 246 <div class="line">    <a class="code hl_function" href="group__hardware__pwm.html#ga18a2b3bbc240d1a9b36526d69c06ec3d">pwm_set_chan_level</a>(slice_num, PWM_CHAN_A, 1);</div>
 247 <div class="line">    <span class="comment">// Set initial B output high for three cycles before dropping</span></div>
 248 <div class="line">    <a class="code hl_function" href="group__hardware__pwm.html#ga18a2b3bbc240d1a9b36526d69c06ec3d">pwm_set_chan_level</a>(slice_num, PWM_CHAN_B, 3);</div>
 249 <div class="line">    <span class="comment">// Set the PWM running</span></div>
 250 <div class="line">    <a class="code hl_function" href="group__hardware__pwm.html#ga216496c331542eb57199018fa86b4408">pwm_set_enabled</a>(slice_num, <span class="keyword">true</span>);</div>
 251 <div class="line"> </div>
 252 <div class="line">    <span class="comment">// Note we could also use pwm_set_gpio_level(gpio, x) which looks up the</span></div>
 253 <div class="line">    <span class="comment">// correct slice and channel for a given GPIO.</span></div>
 254 <div class="line">}</div>
 255 <div class="ttc" id="agroup__hardware__gpio_html_gaacde9174277ca40aa7b6fdd341bb2b8c"><div class="ttname"><a href="group__hardware__gpio.html#gaacde9174277ca40aa7b6fdd341bb2b8c">gpio_set_function</a></div><div class="ttdeci">void gpio_set_function(uint gpio, enum gpio_function fn)</div><div class="ttdoc">Select GPIO function.</div><div class="ttdef"><b>Definition:</b> gpio.c:32</div></div>
 256 <div class="ttc" id="agroup__hardware__pwm_html_ga18a2b3bbc240d1a9b36526d69c06ec3d"><div class="ttname"><a href="group__hardware__pwm.html#ga18a2b3bbc240d1a9b36526d69c06ec3d">pwm_set_chan_level</a></div><div class="ttdeci">static void pwm_set_chan_level(uint slice_num, uint chan, uint16_t level)</div><div class="ttdoc">Set the current PWM counter compare value for one channel.</div><div class="ttdef"><b>Definition:</b> pwm.h:274</div></div>
 257 <div class="ttc" id="agroup__hardware__pwm_html_ga216496c331542eb57199018fa86b4408"><div class="ttname"><a href="group__hardware__pwm.html#ga216496c331542eb57199018fa86b4408">pwm_set_enabled</a></div><div class="ttdeci">static void pwm_set_enabled(uint slice_num, bool enabled)</div><div class="ttdoc">Enable/Disable PWM.</div><div class="ttdef"><b>Definition:</b> pwm.h:488</div></div>
 258 <div class="ttc" id="agroup__hardware__pwm_html_ga6f8fe346e6912cfab3d36b00043a3627"><div class="ttname"><a href="group__hardware__pwm.html#ga6f8fe346e6912cfab3d36b00043a3627">pwm_set_wrap</a></div><div class="ttdeci">static void pwm_set_wrap(uint slice_num, uint16_t wrap)</div><div class="ttdoc">Set the current PWM counter wrap value.</div><div class="ttdef"><b>Definition:</b> pwm.h:254</div></div>
 259 <div class="ttc" id="agroup__hardware__pwm_html_ga8b2117d67a544f64c001f4f32c723eef"><div class="ttname"><a href="group__hardware__pwm.html#ga8b2117d67a544f64c001f4f32c723eef">pwm_gpio_to_slice_num</a></div><div class="ttdeci">static uint pwm_gpio_to_slice_num(uint gpio)</div><div class="ttdoc">Determine the PWM slice that is attached to the specified GPIO.</div><div class="ttdef"><b>Definition:</b> pwm.h:78</div></div>
 260 <div class="ttc" id="arp2__common_2hardware__pwm_2include_2hardware_2pwm_8h_html"><div class="ttname"><a href="rp2__common_2hardware__pwm_2include_2hardware_2pwm_8h.html">pwm.h</a></div></div>
 261 <div class="ttc" id="astdlib_8h_html"><div class="ttname"><a href="stdlib_8h.html">stdlib.h</a></div></div>
 262 </div><!-- fragment --> <h2 class="groupheader">Enumeration Type Documentation</h2>
 263 <a id="ga0a00197703c8606641488cfff3f660e6" name="ga0a00197703c8606641488cfff3f660e6"></a>
 264 <h2 class="memtitle"><span class="permalink"><a href="#ga0a00197703c8606641488cfff3f660e6">&#9670;&nbsp;</a></span>pwm_clkdiv_mode</h2>
 265
 266 <div class="memitem">
 267 <div class="memproto">
 268       <table class="memname">
 269         <tr>
 270           <td class="memname">enum <a class="el" href="group__hardware__pwm.html#ga0a00197703c8606641488cfff3f660e6">pwm_clkdiv_mode</a></td>
 271         </tr>
 272       </table>
 273 </div><div class="memdoc">
 274
 275 <p>PWM Divider mode settings. </p>
 276 <table class="fieldtable">
 277 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga0a00197703c8606641488cfff3f660e6acd3efbc3feaca58b87930008fdd8486b" name="gga0a00197703c8606641488cfff3f660e6acd3efbc3feaca58b87930008fdd8486b"></a>PWM_DIV_FREE_RUNNING&#160;</td><td class="fielddoc"><p >Free-running counting at rate dictated by fractional divider. </p>
 278 </td></tr>
 279 <tr><td class="fieldname"><a id="gga0a00197703c8606641488cfff3f660e6a186c27a4768fcb0c6930471db51861b7" name="gga0a00197703c8606641488cfff3f660e6a186c27a4768fcb0c6930471db51861b7"></a>PWM_DIV_B_HIGH&#160;</td><td class="fielddoc"><p >Fractional divider is gated by the PWM B pin. </p>
 280 </td></tr>
 281 <tr><td class="fieldname"><a id="gga0a00197703c8606641488cfff3f660e6ad9d2170532c2c9ab4016908544c8ad40" name="gga0a00197703c8606641488cfff3f660e6ad9d2170532c2c9ab4016908544c8ad40"></a>PWM_DIV_B_RISING&#160;</td><td class="fielddoc"><p >Fractional divider advances with each rising edge of the PWM B pin. </p>
 282 </td></tr>
 283 <tr><td class="fieldname"><a id="gga0a00197703c8606641488cfff3f660e6a0b4afcaa75090169d3b7cbec4c0e2012" name="gga0a00197703c8606641488cfff3f660e6a0b4afcaa75090169d3b7cbec4c0e2012"></a>PWM_DIV_B_FALLING&#160;</td><td class="fielddoc"><p >Fractional divider advances with each falling edge of the PWM B pin. </p>
 284 </td></tr>
 285 </table>
 286
 287 </div>
 288 </div>
 289 <h2 class="groupheader">Function Documentation</h2>
 290 <a id="ga98a47b25fcc2f28addf0a28ee3234efd" name="ga98a47b25fcc2f28addf0a28ee3234efd"></a>
 291 <h2 class="memtitle"><span class="permalink"><a href="#ga98a47b25fcc2f28addf0a28ee3234efd">&#9670;&nbsp;</a></span>pwm_advance_count()</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 pwm_advance_count </td>
 301           <td>(</td>
 302           <td class="paramtype">uint&#160;</td>
 303           <td class="paramname"><em>slice_num</em></td><td>)</td>
 304           <td></td>
 305         </tr>
 306       </table>
 307   </td>
 308   <td class="mlabels-right">
 309 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 310   </tr>
 311 </table>
 312 </div><div class="memdoc">
 313
 314 <p>Advance PWM count. </p>
 315 <p >Advance the phase of a running the counter by 1 count.</p>
 316 <p >This function will return once the increment is complete.</p>
 317 <dl class="params"><dt>Parameters</dt><dd>
 318   <table class="params">
 319     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
 320   </table>
 321   </dd>
 322 </dl>
 323
 324 </div>
 325 </div>
 326 <a id="ga8d4482b5e125e30bc166d3ed33d8ba2d" name="ga8d4482b5e125e30bc166d3ed33d8ba2d"></a>
 327 <h2 class="memtitle"><span class="permalink"><a href="#ga8d4482b5e125e30bc166d3ed33d8ba2d">&#9670;&nbsp;</a></span>pwm_clear_irq()</h2>
 328
 329 <div class="memitem">
 330 <div class="memproto">
 331 <table class="mlabels">
 332   <tr>
 333   <td class="mlabels-left">
 334       <table class="memname">
 335         <tr>
 336           <td class="memname">static void pwm_clear_irq </td>
 337           <td>(</td>
 338           <td class="paramtype">uint&#160;</td>
 339           <td class="paramname"><em>slice_num</em></td><td>)</td>
 340           <td></td>
 341         </tr>
 342       </table>
 343   </td>
 344   <td class="mlabels-right">
 345 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 346   </tr>
 347 </table>
 348 </div><div class="memdoc">
 349
 350 <p>Clear a single PWM channel interrupt. </p>
 351 <dl class="params"><dt>Parameters</dt><dd>
 352   <table class="params">
 353     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
 354   </table>
 355   </dd>
 356 </dl>
 357
 358 </div>
 359 </div>
 360 <a id="ga679802450ac829eff368e8f109df387e" name="ga679802450ac829eff368e8f109df387e"></a>
 361 <h2 class="memtitle"><span class="permalink"><a href="#ga679802450ac829eff368e8f109df387e">&#9670;&nbsp;</a></span>pwm_config_set_clkdiv()</h2>
 362
 363 <div class="memitem">
 364 <div class="memproto">
 365 <table class="mlabels">
 366   <tr>
 367   <td class="mlabels-left">
 368       <table class="memname">
 369         <tr>
 370           <td class="memname">static void pwm_config_set_clkdiv </td>
 371           <td>(</td>
 372           <td class="paramtype"><a class="el" href="structpwm__config.html">pwm_config</a> *&#160;</td>
 373           <td class="paramname"><em>c</em>, </td>
 374         </tr>
 375         <tr>
 376           <td class="paramkey"></td>
 377           <td></td>
 378           <td class="paramtype">float&#160;</td>
 379           <td class="paramname"><em>div</em>&#160;</td>
 380         </tr>
 381         <tr>
 382           <td></td>
 383           <td>)</td>
 384           <td></td><td></td>
 385         </tr>
 386       </table>
 387   </td>
 388   <td class="mlabels-right">
 389 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 390   </tr>
 391 </table>
 392 </div><div class="memdoc">
 393
 394 <p>Set PWM clock divider in a PWM configuration. </p>
 395 <dl class="params"><dt>Parameters</dt><dd>
 396   <table class="params">
 397     <tr><td class="paramname">c</td><td>PWM configuration struct to modify </td></tr>
 398     <tr><td class="paramname">div</td><td>Value to divide counting rate by. Must be greater than or equal to 1.</td></tr>
 399   </table>
 400   </dd>
 401 </dl>
 402 <p>If the divide mode is free-running, the PWM counter runs at clk_sys / div. Otherwise, the divider reduces the rate of events seen on the B pin input (level or edge) before passing them on to the PWM counter. </p>
 403
 404 </div>
 405 </div>
 406 <a id="ga1d60d45df884a7abbde52e326586d55a" name="ga1d60d45df884a7abbde52e326586d55a"></a>
 407 <h2 class="memtitle"><span class="permalink"><a href="#ga1d60d45df884a7abbde52e326586d55a">&#9670;&nbsp;</a></span>pwm_config_set_clkdiv_int()</h2>
 408
 409 <div class="memitem">
 410 <div class="memproto">
 411 <table class="mlabels">
 412   <tr>
 413   <td class="mlabels-left">
 414       <table class="memname">
 415         <tr>
 416           <td class="memname">static void pwm_config_set_clkdiv_int </td>
 417           <td>(</td>
 418           <td class="paramtype"><a class="el" href="structpwm__config.html">pwm_config</a> *&#160;</td>
 419           <td class="paramname"><em>c</em>, </td>
 420         </tr>
 421         <tr>
 422           <td class="paramkey"></td>
 423           <td></td>
 424           <td class="paramtype">uint&#160;</td>
 425           <td class="paramname"><em>div</em>&#160;</td>
 426         </tr>
 427         <tr>
 428           <td></td>
 429           <td>)</td>
 430           <td></td><td></td>
 431         </tr>
 432       </table>
 433   </td>
 434   <td class="mlabels-right">
 435 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 436   </tr>
 437 </table>
 438 </div><div class="memdoc">
 439
 440 <p>Set PWM clock divider in a PWM configuration. </p>
 441 <dl class="params"><dt>Parameters</dt><dd>
 442   <table class="params">
 443     <tr><td class="paramname">c</td><td>PWM configuration struct to modify </td></tr>
 444     <tr><td class="paramname">div</td><td>Integer value to reduce counting rate by. Must be greater than or equal to 1.</td></tr>
 445   </table>
 446   </dd>
 447 </dl>
 448 <p>If the divide mode is free-running, the PWM counter runs at clk_sys / div. Otherwise, the divider reduces the rate of events seen on the B pin input (level or edge) before passing them on to the PWM counter. </p>
 449
 450 </div>
 451 </div>
 452 <a id="ga3b0d7a6e493b4dc9ded8f53fb9be474c" name="ga3b0d7a6e493b4dc9ded8f53fb9be474c"></a>
 453 <h2 class="memtitle"><span class="permalink"><a href="#ga3b0d7a6e493b4dc9ded8f53fb9be474c">&#9670;&nbsp;</a></span>pwm_config_set_clkdiv_int_frac()</h2>
 454
 455 <div class="memitem">
 456 <div class="memproto">
 457 <table class="mlabels">
 458   <tr>
 459   <td class="mlabels-left">
 460       <table class="memname">
 461         <tr>
 462           <td class="memname">static void pwm_config_set_clkdiv_int_frac </td>
 463           <td>(</td>
 464           <td class="paramtype"><a class="el" href="structpwm__config.html">pwm_config</a> *&#160;</td>
 465           <td class="paramname"><em>c</em>, </td>
 466         </tr>
 467         <tr>
 468           <td class="paramkey"></td>
 469           <td></td>
 470           <td class="paramtype">uint8_t&#160;</td>
 471           <td class="paramname"><em>integer</em>, </td>
 472         </tr>
 473         <tr>
 474           <td class="paramkey"></td>
 475           <td></td>
 476           <td class="paramtype">uint8_t&#160;</td>
 477           <td class="paramname"><em>fract</em>&#160;</td>
 478         </tr>
 479         <tr>
 480           <td></td>
 481           <td>)</td>
 482           <td></td><td></td>
 483         </tr>
 484       </table>
 485   </td>
 486   <td class="mlabels-right">
 487 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 488   </tr>
 489 </table>
 490 </div><div class="memdoc">
 491
 492 <p>Set PWM clock divider in a PWM configuration using an 8:4 fractional value. </p>
 493 <dl class="params"><dt>Parameters</dt><dd>
 494   <table class="params">
 495     <tr><td class="paramname">c</td><td>PWM configuration struct to modify </td></tr>
 496     <tr><td class="paramname">integer</td><td>8 bit integer part of the clock divider. Must be greater than or equal to 1. </td></tr>
 497     <tr><td class="paramname">fract</td><td>4 bit fractional part of the clock divider</td></tr>
 498   </table>
 499   </dd>
 500 </dl>
 501 <p>If the divide mode is free-running, the PWM counter runs at clk_sys / div. Otherwise, the divider reduces the rate of events seen on the B pin input (level or edge) before passing them on to the PWM counter. </p>
 502
 503 </div>
 504 </div>
 505 <a id="ga27a86a921b2ad2ebd811db1255d34d06" name="ga27a86a921b2ad2ebd811db1255d34d06"></a>
 506 <h2 class="memtitle"><span class="permalink"><a href="#ga27a86a921b2ad2ebd811db1255d34d06">&#9670;&nbsp;</a></span>pwm_config_set_clkdiv_mode()</h2>
 507
 508 <div class="memitem">
 509 <div class="memproto">
 510 <table class="mlabels">
 511   <tr>
 512   <td class="mlabels-left">
 513       <table class="memname">
 514         <tr>
 515           <td class="memname">static void pwm_config_set_clkdiv_mode </td>
 516           <td>(</td>
 517           <td class="paramtype"><a class="el" href="structpwm__config.html">pwm_config</a> *&#160;</td>
 518           <td class="paramname"><em>c</em>, </td>
 519         </tr>
 520         <tr>
 521           <td class="paramkey"></td>
 522           <td></td>
 523           <td class="paramtype">enum <a class="el" href="group__hardware__pwm.html#ga0a00197703c8606641488cfff3f660e6">pwm_clkdiv_mode</a>&#160;</td>
 524           <td class="paramname"><em>mode</em>&#160;</td>
 525         </tr>
 526         <tr>
 527           <td></td>
 528           <td>)</td>
 529           <td></td><td></td>
 530         </tr>
 531       </table>
 532   </td>
 533   <td class="mlabels-right">
 534 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 535   </tr>
 536 </table>
 537 </div><div class="memdoc">
 538
 539 <p>Set PWM counting mode in a PWM configuration. </p>
 540 <dl class="params"><dt>Parameters</dt><dd>
 541   <table class="params">
 542     <tr><td class="paramname">c</td><td>PWM configuration struct to modify </td></tr>
 543     <tr><td class="paramname">mode</td><td>PWM divide/count mode</td></tr>
 544   </table>
 545   </dd>
 546 </dl>
 547 <p>Configure which event gates the operation of the fractional divider. The default is always-on (free-running PWM). Can also be configured to count on high level, rising edge or falling edge of the B pin input. </p>
 548
 549 </div>
 550 </div>
 551 <a id="gab459185e217d5e215dae3cfb3d6de1b5" name="gab459185e217d5e215dae3cfb3d6de1b5"></a>
 552 <h2 class="memtitle"><span class="permalink"><a href="#gab459185e217d5e215dae3cfb3d6de1b5">&#9670;&nbsp;</a></span>pwm_config_set_output_polarity()</h2>
 553
 554 <div class="memitem">
 555 <div class="memproto">
 556 <table class="mlabels">
 557   <tr>
 558   <td class="mlabels-left">
 559       <table class="memname">
 560         <tr>
 561           <td class="memname">static void pwm_config_set_output_polarity </td>
 562           <td>(</td>
 563           <td class="paramtype"><a class="el" href="structpwm__config.html">pwm_config</a> *&#160;</td>
 564           <td class="paramname"><em>c</em>, </td>
 565         </tr>
 566         <tr>
 567           <td class="paramkey"></td>
 568           <td></td>
 569           <td class="paramtype">bool&#160;</td>
 570           <td class="paramname"><em>a</em>, </td>
 571         </tr>
 572         <tr>
 573           <td class="paramkey"></td>
 574           <td></td>
 575           <td class="paramtype">bool&#160;</td>
 576           <td class="paramname"><em>b</em>&#160;</td>
 577         </tr>
 578         <tr>
 579           <td></td>
 580           <td>)</td>
 581           <td></td><td></td>
 582         </tr>
 583       </table>
 584   </td>
 585   <td class="mlabels-right">
 586 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 587   </tr>
 588 </table>
 589 </div><div class="memdoc">
 590
 591 <p>Set output polarity in a PWM configuration. </p>
 592 <dl class="params"><dt>Parameters</dt><dd>
 593   <table class="params">
 594     <tr><td class="paramname">c</td><td>PWM configuration struct to modify </td></tr>
 595     <tr><td class="paramname">a</td><td>true to invert output A </td></tr>
 596     <tr><td class="paramname">b</td><td>true to invert output B </td></tr>
 597   </table>
 598   </dd>
 599 </dl>
 600
 601 </div>
 602 </div>
 603 <a id="ga031fe8a502c9640ed4f5fab74d6248ae" name="ga031fe8a502c9640ed4f5fab74d6248ae"></a>
 604 <h2 class="memtitle"><span class="permalink"><a href="#ga031fe8a502c9640ed4f5fab74d6248ae">&#9670;&nbsp;</a></span>pwm_config_set_phase_correct()</h2>
 605
 606 <div class="memitem">
 607 <div class="memproto">
 608 <table class="mlabels">
 609   <tr>
 610   <td class="mlabels-left">
 611       <table class="memname">
 612         <tr>
 613           <td class="memname">static void pwm_config_set_phase_correct </td>
 614           <td>(</td>
 615           <td class="paramtype"><a class="el" href="structpwm__config.html">pwm_config</a> *&#160;</td>
 616           <td class="paramname"><em>c</em>, </td>
 617         </tr>
 618         <tr>
 619           <td class="paramkey"></td>
 620           <td></td>
 621           <td class="paramtype">bool&#160;</td>
 622           <td class="paramname"><em>phase_correct</em>&#160;</td>
 623         </tr>
 624         <tr>
 625           <td></td>
 626           <td>)</td>
 627           <td></td><td></td>
 628         </tr>
 629       </table>
 630   </td>
 631   <td class="mlabels-right">
 632 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 633   </tr>
 634 </table>
 635 </div><div class="memdoc">
 636
 637 <p>Set phase correction in a PWM configuration. </p>
 638 <dl class="params"><dt>Parameters</dt><dd>
 639   <table class="params">
 640     <tr><td class="paramname">c</td><td>PWM configuration struct to modify </td></tr>
 641     <tr><td class="paramname">phase_correct</td><td>true to set phase correct modulation, false to set trailing edge</td></tr>
 642   </table>
 643   </dd>
 644 </dl>
 645 <p>Setting phase control to true means that instead of wrapping back to zero when the wrap point is reached, the PWM starts counting back down. The output frequency is halved when phase-correct mode is enabled. </p>
 646
 647 </div>
 648 </div>
 649 <a id="gad6cf6d9237144234732a50eb6d5e4fe9" name="gad6cf6d9237144234732a50eb6d5e4fe9"></a>
 650 <h2 class="memtitle"><span class="permalink"><a href="#gad6cf6d9237144234732a50eb6d5e4fe9">&#9670;&nbsp;</a></span>pwm_config_set_wrap()</h2>
 651
 652 <div class="memitem">
 653 <div class="memproto">
 654 <table class="mlabels">
 655   <tr>
 656   <td class="mlabels-left">
 657       <table class="memname">
 658         <tr>
 659           <td class="memname">static void pwm_config_set_wrap </td>
 660           <td>(</td>
 661           <td class="paramtype"><a class="el" href="structpwm__config.html">pwm_config</a> *&#160;</td>
 662           <td class="paramname"><em>c</em>, </td>
 663         </tr>
 664         <tr>
 665           <td class="paramkey"></td>
 666           <td></td>
 667           <td class="paramtype">uint16_t&#160;</td>
 668           <td class="paramname"><em>wrap</em>&#160;</td>
 669         </tr>
 670         <tr>
 671           <td></td>
 672           <td>)</td>
 673           <td></td><td></td>
 674         </tr>
 675       </table>
 676   </td>
 677   <td class="mlabels-right">
 678 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 679   </tr>
 680 </table>
 681 </div><div class="memdoc">
 682
 683 <p>Set PWM counter wrap value in a PWM configuration. </p>
 684 <p >Set the highest value the counter will reach before returning to 0. Also known as TOP.</p>
 685 <dl class="params"><dt>Parameters</dt><dd>
 686   <table class="params">
 687     <tr><td class="paramname">c</td><td>PWM configuration struct to modify </td></tr>
 688     <tr><td class="paramname">wrap</td><td>Value to set wrap to </td></tr>
 689   </table>
 690   </dd>
 691 </dl>
 692
 693 </div>
 694 </div>
 695 <a id="ga457ee599e471a8da59c42f5c26710ff6" name="ga457ee599e471a8da59c42f5c26710ff6"></a>
 696 <h2 class="memtitle"><span class="permalink"><a href="#ga457ee599e471a8da59c42f5c26710ff6">&#9670;&nbsp;</a></span>pwm_force_irq()</h2>
 697
 698 <div class="memitem">
 699 <div class="memproto">
 700 <table class="mlabels">
 701   <tr>
 702   <td class="mlabels-left">
 703       <table class="memname">
 704         <tr>
 705           <td class="memname">static void pwm_force_irq </td>
 706           <td>(</td>
 707           <td class="paramtype">uint&#160;</td>
 708           <td class="paramname"><em>slice_num</em></td><td>)</td>
 709           <td></td>
 710         </tr>
 711       </table>
 712   </td>
 713   <td class="mlabels-right">
 714 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 715   </tr>
 716 </table>
 717 </div><div class="memdoc">
 718
 719 <p>Force PWM interrupt. </p>
 720 <dl class="params"><dt>Parameters</dt><dd>
 721   <table class="params">
 722     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
 723   </table>
 724   </dd>
 725 </dl>
 726
 727 </div>
 728 </div>
 729 <a id="ga157c8b11483967714823187725a5ed5a" name="ga157c8b11483967714823187725a5ed5a"></a>
 730 <h2 class="memtitle"><span class="permalink"><a href="#ga157c8b11483967714823187725a5ed5a">&#9670;&nbsp;</a></span>pwm_get_counter()</h2>
 731
 732 <div class="memitem">
 733 <div class="memproto">
 734 <table class="mlabels">
 735   <tr>
 736   <td class="mlabels-left">
 737       <table class="memname">
 738         <tr>
 739           <td class="memname">static uint16_t pwm_get_counter </td>
 740           <td>(</td>
 741           <td class="paramtype">uint&#160;</td>
 742           <td class="paramname"><em>slice_num</em></td><td>)</td>
 743           <td></td>
 744         </tr>
 745       </table>
 746   </td>
 747   <td class="mlabels-right">
 748 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 749   </tr>
 750 </table>
 751 </div><div class="memdoc">
 752
 753 <p>Get PWM counter. </p>
 754 <p >Get current value of PWM counter</p>
 755 <dl class="params"><dt>Parameters</dt><dd>
 756   <table class="params">
 757     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
 758   </table>
 759   </dd>
 760 </dl>
 761 <dl class="section return"><dt>Returns</dt><dd>Current value of the PWM counter </dd></dl>
 762
 763 </div>
 764 </div>
 765 <a id="gad76f94a6dd6133c52284b6be8ae98e16" name="gad76f94a6dd6133c52284b6be8ae98e16"></a>
 766 <h2 class="memtitle"><span class="permalink"><a href="#gad76f94a6dd6133c52284b6be8ae98e16">&#9670;&nbsp;</a></span>pwm_get_default_config()</h2>
 767
 768 <div class="memitem">
 769 <div class="memproto">
 770 <table class="mlabels">
 771   <tr>
 772   <td class="mlabels-left">
 773       <table class="memname">
 774         <tr>
 775           <td class="memname">static <a class="el" href="structpwm__config.html">pwm_config</a> pwm_get_default_config </td>
 776           <td>(</td>
 777           <td class="paramtype">void&#160;</td>
 778           <td class="paramname"></td><td>)</td>
 779           <td></td>
 780         </tr>
 781       </table>
 782   </td>
 783   <td class="mlabels-right">
 784 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 785   </tr>
 786 </table>
 787 </div><div class="memdoc">
 788
 789 <p>Get a set of default values for PWM configuration. </p>
 790 <p >PWM config is free-running at system clock speed, no phase correction, wrapping at 0xffff, with standard polarities for channels A and B.</p>
 791 <dl class="section return"><dt>Returns</dt><dd>Set of default values. </dd></dl>
 792
 793 </div>
 794 </div>
 795 <a id="ga2f600a7192ecd69a8680be367e8d0a00" name="ga2f600a7192ecd69a8680be367e8d0a00"></a>
 796 <h2 class="memtitle"><span class="permalink"><a href="#ga2f600a7192ecd69a8680be367e8d0a00">&#9670;&nbsp;</a></span>pwm_get_dreq()</h2>
 797
 798 <div class="memitem">
 799 <div class="memproto">
 800 <table class="mlabels">
 801   <tr>
 802   <td class="mlabels-left">
 803       <table class="memname">
 804         <tr>
 805           <td class="memname">static uint pwm_get_dreq </td>
 806           <td>(</td>
 807           <td class="paramtype">uint&#160;</td>
 808           <td class="paramname"><em>slice_num</em></td><td>)</td>
 809           <td></td>
 810         </tr>
 811       </table>
 812   </td>
 813   <td class="mlabels-right">
 814 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 815   </tr>
 816 </table>
 817 </div><div class="memdoc">
 818
 819 <p>Return the DREQ to use for pacing transfers to a particular PWM slice. </p>
 820 <dl class="params"><dt>Parameters</dt><dd>
 821   <table class="params">
 822     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
 823   </table>
 824   </dd>
 825 </dl>
 826
 827 </div>
 828 </div>
 829 <a id="ga565a6b6d19b60b10f5a91b11152cc8c2" name="ga565a6b6d19b60b10f5a91b11152cc8c2"></a>
 830 <h2 class="memtitle"><span class="permalink"><a href="#ga565a6b6d19b60b10f5a91b11152cc8c2">&#9670;&nbsp;</a></span>pwm_get_irq_status_mask()</h2>
 831
 832 <div class="memitem">
 833 <div class="memproto">
 834 <table class="mlabels">
 835   <tr>
 836   <td class="mlabels-left">
 837       <table class="memname">
 838         <tr>
 839           <td class="memname">static uint32_t pwm_get_irq_status_mask </td>
 840           <td>(</td>
 841           <td class="paramtype">void&#160;</td>
 842           <td class="paramname"></td><td>)</td>
 843           <td></td>
 844         </tr>
 845       </table>
 846   </td>
 847   <td class="mlabels-right">
 848 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 849   </tr>
 850 </table>
 851 </div><div class="memdoc">
 852
 853 <p>Get PWM interrupt status, raw. </p>
 854 <dl class="section return"><dt>Returns</dt><dd>Bitmask of all PWM interrupts currently set </dd></dl>
 855
 856 </div>
 857 </div>
 858 <a id="ga96ba504fe00cb8e0d88f0730cdfdaafc" name="ga96ba504fe00cb8e0d88f0730cdfdaafc"></a>
 859 <h2 class="memtitle"><span class="permalink"><a href="#ga96ba504fe00cb8e0d88f0730cdfdaafc">&#9670;&nbsp;</a></span>pwm_gpio_to_channel()</h2>
 860
 861 <div class="memitem">
 862 <div class="memproto">
 863 <table class="mlabels">
 864   <tr>
 865   <td class="mlabels-left">
 866       <table class="memname">
 867         <tr>
 868           <td class="memname">static uint pwm_gpio_to_channel </td>
 869           <td>(</td>
 870           <td class="paramtype">uint&#160;</td>
 871           <td class="paramname"><em>gpio</em></td><td>)</td>
 872           <td></td>
 873         </tr>
 874       </table>
 875   </td>
 876   <td class="mlabels-right">
 877 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 878   </tr>
 879 </table>
 880 </div><div class="memdoc">
 881
 882 <p>Determine the PWM channel that is attached to the specified GPIO. </p>
 883 <p >Each slice 0 to 7 has two channels, A and B.</p>
 884 <dl class="section return"><dt>Returns</dt><dd>The PWM channel that controls the specified GPIO. </dd></dl>
 885
 886 </div>
 887 </div>
 888 <a id="ga8b2117d67a544f64c001f4f32c723eef" name="ga8b2117d67a544f64c001f4f32c723eef"></a>
 889 <h2 class="memtitle"><span class="permalink"><a href="#ga8b2117d67a544f64c001f4f32c723eef">&#9670;&nbsp;</a></span>pwm_gpio_to_slice_num()</h2>
 890
 891 <div class="memitem">
 892 <div class="memproto">
 893 <table class="mlabels">
 894   <tr>
 895   <td class="mlabels-left">
 896       <table class="memname">
 897         <tr>
 898           <td class="memname">static uint pwm_gpio_to_slice_num </td>
 899           <td>(</td>
 900           <td class="paramtype">uint&#160;</td>
 901           <td class="paramname"><em>gpio</em></td><td>)</td>
 902           <td></td>
 903         </tr>
 904       </table>
 905   </td>
 906   <td class="mlabels-right">
 907 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 908   </tr>
 909 </table>
 910 </div><div class="memdoc">
 911
 912 <p>Determine the PWM slice that is attached to the specified GPIO. </p>
 913 <dl class="section return"><dt>Returns</dt><dd>The PWM slice number that controls the specified GPIO. </dd></dl>
 914
 915 </div>
 916 </div>
 917 <a id="ga01d3e90bb7aa9a8b6884eddbfbebc175" name="ga01d3e90bb7aa9a8b6884eddbfbebc175"></a>
 918 <h2 class="memtitle"><span class="permalink"><a href="#ga01d3e90bb7aa9a8b6884eddbfbebc175">&#9670;&nbsp;</a></span>pwm_init()</h2>
 919
 920 <div class="memitem">
 921 <div class="memproto">
 922 <table class="mlabels">
 923   <tr>
 924   <td class="mlabels-left">
 925       <table class="memname">
 926         <tr>
 927           <td class="memname">static void pwm_init </td>
 928           <td>(</td>
 929           <td class="paramtype">uint&#160;</td>
 930           <td class="paramname"><em>slice_num</em>, </td>
 931         </tr>
 932         <tr>
 933           <td class="paramkey"></td>
 934           <td></td>
 935           <td class="paramtype"><a class="el" href="structpwm__config.html">pwm_config</a> *&#160;</td>
 936           <td class="paramname"><em>c</em>, </td>
 937         </tr>
 938         <tr>
 939           <td class="paramkey"></td>
 940           <td></td>
 941           <td class="paramtype">bool&#160;</td>
 942           <td class="paramname"><em>start</em>&#160;</td>
 943         </tr>
 944         <tr>
 945           <td></td>
 946           <td>)</td>
 947           <td></td><td></td>
 948         </tr>
 949       </table>
 950   </td>
 951   <td class="mlabels-right">
 952 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 953   </tr>
 954 </table>
 955 </div><div class="memdoc">
 956
 957 <p>Initialise a PWM with settings from a configuration object. </p>
 958 <p >Use the <a class="el" href="group__hardware__pwm.html#gad76f94a6dd6133c52284b6be8ae98e16">pwm_get_default_config()</a> function to initialise a config structure, make changes as needed using the pwm_config_* functions, then call this function to set up the PWM.</p>
 959 <dl class="params"><dt>Parameters</dt><dd>
 960   <table class="params">
 961     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
 962     <tr><td class="paramname">c</td><td>The configuration to use </td></tr>
 963     <tr><td class="paramname">start</td><td>If true the PWM will be started running once configured. If false you will need to start manually using <a class="el" href="group__hardware__pwm.html#ga216496c331542eb57199018fa86b4408">pwm_set_enabled()</a> or <a class="el" href="group__hardware__pwm.html#ga257ea7fd33fcf33815a01dd279ca578d">pwm_set_mask_enabled()</a> </td></tr>
 964   </table>
 965   </dd>
 966 </dl>
 967
 968 </div>
 969 </div>
 970 <a id="ga0dec65009d8c0738677818b680fd2ad9" name="ga0dec65009d8c0738677818b680fd2ad9"></a>
 971 <h2 class="memtitle"><span class="permalink"><a href="#ga0dec65009d8c0738677818b680fd2ad9">&#9670;&nbsp;</a></span>pwm_retard_count()</h2>
 972
 973 <div class="memitem">
 974 <div class="memproto">
 975 <table class="mlabels">
 976   <tr>
 977   <td class="mlabels-left">
 978       <table class="memname">
 979         <tr>
 980           <td class="memname">static void pwm_retard_count </td>
 981           <td>(</td>
 982           <td class="paramtype">uint&#160;</td>
 983           <td class="paramname"><em>slice_num</em></td><td>)</td>
 984           <td></td>
 985         </tr>
 986       </table>
 987   </td>
 988   <td class="mlabels-right">
 989 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 990   </tr>
 991 </table>
 992 </div><div class="memdoc">
 993
 994 <p>Retard PWM count. </p>
 995 <p >Retard the phase of a running counter by 1 count</p>
 996 <p >This function will return once the retardation is complete.</p>
 997 <dl class="params"><dt>Parameters</dt><dd>
 998   <table class="params">
 999     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1000   </table>
1001   </dd>
1002 </dl>
1003
1004 </div>
1005 </div>
1006 <a id="gae7064c88717eee935e50138f5b0ae2b7" name="gae7064c88717eee935e50138f5b0ae2b7"></a>
1007 <h2 class="memtitle"><span class="permalink"><a href="#gae7064c88717eee935e50138f5b0ae2b7">&#9670;&nbsp;</a></span>pwm_set_both_levels()</h2>
1008
1009 <div class="memitem">
1010 <div class="memproto">
1011 <table class="mlabels">
1012   <tr>
1013   <td class="mlabels-left">
1014       <table class="memname">
1015         <tr>
1016           <td class="memname">static void pwm_set_both_levels </td>
1017           <td>(</td>
1018           <td class="paramtype">uint&#160;</td>
1019           <td class="paramname"><em>slice_num</em>, </td>
1020         </tr>
1021         <tr>
1022           <td class="paramkey"></td>
1023           <td></td>
1024           <td class="paramtype">uint16_t&#160;</td>
1025           <td class="paramname"><em>level_a</em>, </td>
1026         </tr>
1027         <tr>
1028           <td class="paramkey"></td>
1029           <td></td>
1030           <td class="paramtype">uint16_t&#160;</td>
1031           <td class="paramname"><em>level_b</em>&#160;</td>
1032         </tr>
1033         <tr>
1034           <td></td>
1035           <td>)</td>
1036           <td></td><td></td>
1037         </tr>
1038       </table>
1039   </td>
1040   <td class="mlabels-right">
1041 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1042   </tr>
1043 </table>
1044 </div><div class="memdoc">
1045
1046 <p>Set PWM counter compare values. </p>
1047 <p >Set the value of the PWM counter compare values, A and B.</p>
1048 <p >The counter compare register is double-buffered in hardware. This means that, when the PWM is running, a write to the counter compare values does not take effect until the next time the PWM slice wraps (or, in phase-correct mode, the next time the slice reaches 0). If the PWM is not running, the write is latched in immediately.</p>
1049 <dl class="params"><dt>Parameters</dt><dd>
1050   <table class="params">
1051     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1052     <tr><td class="paramname">level_a</td><td>Value to set compare A to. When the counter reaches this value the A output is deasserted </td></tr>
1053     <tr><td class="paramname">level_b</td><td>Value to set compare B to. When the counter reaches this value the B output is deasserted </td></tr>
1054   </table>
1055   </dd>
1056 </dl>
1057
1058 </div>
1059 </div>
1060 <a id="ga18a2b3bbc240d1a9b36526d69c06ec3d" name="ga18a2b3bbc240d1a9b36526d69c06ec3d"></a>
1061 <h2 class="memtitle"><span class="permalink"><a href="#ga18a2b3bbc240d1a9b36526d69c06ec3d">&#9670;&nbsp;</a></span>pwm_set_chan_level()</h2>
1062
1063 <div class="memitem">
1064 <div class="memproto">
1065 <table class="mlabels">
1066   <tr>
1067   <td class="mlabels-left">
1068       <table class="memname">
1069         <tr>
1070           <td class="memname">static void pwm_set_chan_level </td>
1071           <td>(</td>
1072           <td class="paramtype">uint&#160;</td>
1073           <td class="paramname"><em>slice_num</em>, </td>
1074         </tr>
1075         <tr>
1076           <td class="paramkey"></td>
1077           <td></td>
1078           <td class="paramtype">uint&#160;</td>
1079           <td class="paramname"><em>chan</em>, </td>
1080         </tr>
1081         <tr>
1082           <td class="paramkey"></td>
1083           <td></td>
1084           <td class="paramtype">uint16_t&#160;</td>
1085           <td class="paramname"><em>level</em>&#160;</td>
1086         </tr>
1087         <tr>
1088           <td></td>
1089           <td>)</td>
1090           <td></td><td></td>
1091         </tr>
1092       </table>
1093   </td>
1094   <td class="mlabels-right">
1095 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1096   </tr>
1097 </table>
1098 </div><div class="memdoc">
1099
1100 <p>Set the current PWM counter compare value for one channel. </p>
1101 <p >Set the value of the PWM counter compare value, for either channel A or channel B.</p>
1102 <p >The counter compare register is double-buffered in hardware. This means that, when the PWM is running, a write to the counter compare values does not take effect until the next time the PWM slice wraps (or, in phase-correct mode, the next time the slice reaches 0). If the PWM is not running, the write is latched in immediately.</p>
1103 <dl class="params"><dt>Parameters</dt><dd>
1104   <table class="params">
1105     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1106     <tr><td class="paramname">chan</td><td>Which channel to update. 0 for A, 1 for B. </td></tr>
1107     <tr><td class="paramname">level</td><td>new level for the selected output </td></tr>
1108   </table>
1109   </dd>
1110 </dl>
1111
1112 </div>
1113 </div>
1114 <a id="ga94782fc53adb07a3594ae0939d9a2e3e" name="ga94782fc53adb07a3594ae0939d9a2e3e"></a>
1115 <h2 class="memtitle"><span class="permalink"><a href="#ga94782fc53adb07a3594ae0939d9a2e3e">&#9670;&nbsp;</a></span>pwm_set_clkdiv()</h2>
1116
1117 <div class="memitem">
1118 <div class="memproto">
1119 <table class="mlabels">
1120   <tr>
1121   <td class="mlabels-left">
1122       <table class="memname">
1123         <tr>
1124           <td class="memname">static void pwm_set_clkdiv </td>
1125           <td>(</td>
1126           <td class="paramtype">uint&#160;</td>
1127           <td class="paramname"><em>slice_num</em>, </td>
1128         </tr>
1129         <tr>
1130           <td class="paramkey"></td>
1131           <td></td>
1132           <td class="paramtype">float&#160;</td>
1133           <td class="paramname"><em>divider</em>&#160;</td>
1134         </tr>
1135         <tr>
1136           <td></td>
1137           <td>)</td>
1138           <td></td><td></td>
1139         </tr>
1140       </table>
1141   </td>
1142   <td class="mlabels-right">
1143 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1144   </tr>
1145 </table>
1146 </div><div class="memdoc">
1147
1148 <p>Set PWM clock divider. </p>
1149 <p >Set the clock divider. Counter increment will be on sysclock divided by this value, taking into account the gating.</p>
1150 <dl class="params"><dt>Parameters</dt><dd>
1151   <table class="params">
1152     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1153     <tr><td class="paramname">divider</td><td>Floating point clock divider, 1.f &lt;= value &lt; 256.f </td></tr>
1154   </table>
1155   </dd>
1156 </dl>
1157
1158 </div>
1159 </div>
1160 <a id="ga0da8e86adb7de041a6b8607b36aee442" name="ga0da8e86adb7de041a6b8607b36aee442"></a>
1161 <h2 class="memtitle"><span class="permalink"><a href="#ga0da8e86adb7de041a6b8607b36aee442">&#9670;&nbsp;</a></span>pwm_set_clkdiv_int_frac()</h2>
1162
1163 <div class="memitem">
1164 <div class="memproto">
1165 <table class="mlabels">
1166   <tr>
1167   <td class="mlabels-left">
1168       <table class="memname">
1169         <tr>
1170           <td class="memname">static void pwm_set_clkdiv_int_frac </td>
1171           <td>(</td>
1172           <td class="paramtype">uint&#160;</td>
1173           <td class="paramname"><em>slice_num</em>, </td>
1174         </tr>
1175         <tr>
1176           <td class="paramkey"></td>
1177           <td></td>
1178           <td class="paramtype">uint8_t&#160;</td>
1179           <td class="paramname"><em>integer</em>, </td>
1180         </tr>
1181         <tr>
1182           <td class="paramkey"></td>
1183           <td></td>
1184           <td class="paramtype">uint8_t&#160;</td>
1185           <td class="paramname"><em>fract</em>&#160;</td>
1186         </tr>
1187         <tr>
1188           <td></td>
1189           <td>)</td>
1190           <td></td><td></td>
1191         </tr>
1192       </table>
1193   </td>
1194   <td class="mlabels-right">
1195 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1196   </tr>
1197 </table>
1198 </div><div class="memdoc">
1199
1200 <p>Set PWM clock divider using an 8:4 fractional value. </p>
1201 <p >Set the clock divider. Counter increment will be on sysclock divided by this value, taking into account the gating.</p>
1202 <dl class="params"><dt>Parameters</dt><dd>
1203   <table class="params">
1204     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1205     <tr><td class="paramname">integer</td><td>8 bit integer part of the clock divider </td></tr>
1206     <tr><td class="paramname">fract</td><td>4 bit fractional part of the clock divider </td></tr>
1207   </table>
1208   </dd>
1209 </dl>
1210
1211 </div>
1212 </div>
1213 <a id="ga1ee213ebb13b98dc81e60a512f696227" name="ga1ee213ebb13b98dc81e60a512f696227"></a>
1214 <h2 class="memtitle"><span class="permalink"><a href="#ga1ee213ebb13b98dc81e60a512f696227">&#9670;&nbsp;</a></span>pwm_set_clkdiv_mode()</h2>
1215
1216 <div class="memitem">
1217 <div class="memproto">
1218 <table class="mlabels">
1219   <tr>
1220   <td class="mlabels-left">
1221       <table class="memname">
1222         <tr>
1223           <td class="memname">static void pwm_set_clkdiv_mode </td>
1224           <td>(</td>
1225           <td class="paramtype">uint&#160;</td>
1226           <td class="paramname"><em>slice_num</em>, </td>
1227         </tr>
1228         <tr>
1229           <td class="paramkey"></td>
1230           <td></td>
1231           <td class="paramtype">enum <a class="el" href="group__hardware__pwm.html#ga0a00197703c8606641488cfff3f660e6">pwm_clkdiv_mode</a>&#160;</td>
1232           <td class="paramname"><em>mode</em>&#160;</td>
1233         </tr>
1234         <tr>
1235           <td></td>
1236           <td>)</td>
1237           <td></td><td></td>
1238         </tr>
1239       </table>
1240   </td>
1241   <td class="mlabels-right">
1242 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1243   </tr>
1244 </table>
1245 </div><div class="memdoc">
1246
1247 <p>Set PWM divider mode. </p>
1248 <dl class="params"><dt>Parameters</dt><dd>
1249   <table class="params">
1250     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1251     <tr><td class="paramname">mode</td><td>Required divider mode </td></tr>
1252   </table>
1253   </dd>
1254 </dl>
1255
1256 </div>
1257 </div>
1258 <a id="ga5179ec971146ab611b9232587e945769" name="ga5179ec971146ab611b9232587e945769"></a>
1259 <h2 class="memtitle"><span class="permalink"><a href="#ga5179ec971146ab611b9232587e945769">&#9670;&nbsp;</a></span>pwm_set_counter()</h2>
1260
1261 <div class="memitem">
1262 <div class="memproto">
1263 <table class="mlabels">
1264   <tr>
1265   <td class="mlabels-left">
1266       <table class="memname">
1267         <tr>
1268           <td class="memname">static void pwm_set_counter </td>
1269           <td>(</td>
1270           <td class="paramtype">uint&#160;</td>
1271           <td class="paramname"><em>slice_num</em>, </td>
1272         </tr>
1273         <tr>
1274           <td class="paramkey"></td>
1275           <td></td>
1276           <td class="paramtype">uint16_t&#160;</td>
1277           <td class="paramname"><em>c</em>&#160;</td>
1278         </tr>
1279         <tr>
1280           <td></td>
1281           <td>)</td>
1282           <td></td><td></td>
1283         </tr>
1284       </table>
1285   </td>
1286   <td class="mlabels-right">
1287 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1288   </tr>
1289 </table>
1290 </div><div class="memdoc">
1291
1292 <p>Set PWM counter. </p>
1293 <p >Set the value of the PWM counter</p>
1294 <dl class="params"><dt>Parameters</dt><dd>
1295   <table class="params">
1296     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1297     <tr><td class="paramname">c</td><td>Value to set the PWM counter to </td></tr>
1298   </table>
1299   </dd>
1300 </dl>
1301
1302 </div>
1303 </div>
1304 <a id="ga216496c331542eb57199018fa86b4408" name="ga216496c331542eb57199018fa86b4408"></a>
1305 <h2 class="memtitle"><span class="permalink"><a href="#ga216496c331542eb57199018fa86b4408">&#9670;&nbsp;</a></span>pwm_set_enabled()</h2>
1306
1307 <div class="memitem">
1308 <div class="memproto">
1309 <table class="mlabels">
1310   <tr>
1311   <td class="mlabels-left">
1312       <table class="memname">
1313         <tr>
1314           <td class="memname">static void pwm_set_enabled </td>
1315           <td>(</td>
1316           <td class="paramtype">uint&#160;</td>
1317           <td class="paramname"><em>slice_num</em>, </td>
1318         </tr>
1319         <tr>
1320           <td class="paramkey"></td>
1321           <td></td>
1322           <td class="paramtype">bool&#160;</td>
1323           <td class="paramname"><em>enabled</em>&#160;</td>
1324         </tr>
1325         <tr>
1326           <td></td>
1327           <td>)</td>
1328           <td></td><td></td>
1329         </tr>
1330       </table>
1331   </td>
1332   <td class="mlabels-right">
1333 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1334   </tr>
1335 </table>
1336 </div><div class="memdoc">
1337
1338 <p>Enable/Disable PWM. </p>
1339 <p >When a PWM is disabled, it halts its counter, and the output pins are left high or low depending on exactly when the counter is halted. When re-enabled the PWM resumes immediately from where it left off.</p>
1340 <p >If the PWM's output pins need to be low when halted:</p>
1341 <ul>
1342 <li>The counter compare can be set to zero whilst the PWM is enabled, and then the PWM disabled once both pins are seen to be low</li>
1343 <li>The GPIO output overrides can be used to force the actual pins low</li>
1344 <li>The PWM can be run for one cycle (i.e. enabled then immediately disabled) with a TOP of 0, count of 0 and counter compare of 0, to force the pins low when the PWM has already been halted. The same method can be used with a counter compare value of 1 to force a pin high.</li>
1345 </ul>
1346 <p >Note that, when disabled, the PWM can still be advanced one count at a time by pulsing the PH_ADV bit in its CSR. The output pins transition as though the PWM were enabled.</p>
1347 <dl class="params"><dt>Parameters</dt><dd>
1348   <table class="params">
1349     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1350     <tr><td class="paramname">enabled</td><td>true to enable the specified PWM, false to disable. </td></tr>
1351   </table>
1352   </dd>
1353 </dl>
1354
1355 </div>
1356 </div>
1357 <a id="ga279d1ba7dcc8f19619f389317efb41fd" name="ga279d1ba7dcc8f19619f389317efb41fd"></a>
1358 <h2 class="memtitle"><span class="permalink"><a href="#ga279d1ba7dcc8f19619f389317efb41fd">&#9670;&nbsp;</a></span>pwm_set_gpio_level()</h2>
1359
1360 <div class="memitem">
1361 <div class="memproto">
1362 <table class="mlabels">
1363   <tr>
1364   <td class="mlabels-left">
1365       <table class="memname">
1366         <tr>
1367           <td class="memname">static void pwm_set_gpio_level </td>
1368           <td>(</td>
1369           <td class="paramtype">uint&#160;</td>
1370           <td class="paramname"><em>gpio</em>, </td>
1371         </tr>
1372         <tr>
1373           <td class="paramkey"></td>
1374           <td></td>
1375           <td class="paramtype">uint16_t&#160;</td>
1376           <td class="paramname"><em>level</em>&#160;</td>
1377         </tr>
1378         <tr>
1379           <td></td>
1380           <td>)</td>
1381           <td></td><td></td>
1382         </tr>
1383       </table>
1384   </td>
1385   <td class="mlabels-right">
1386 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1387   </tr>
1388 </table>
1389 </div><div class="memdoc">
1390
1391 <p>Helper function to set the PWM level for the slice and channel associated with a GPIO. </p>
1392 <p >Look up the correct slice (0 to 7) and channel (A or B) for a given GPIO, and update the corresponding counter compare field.</p>
1393 <p >This PWM slice should already have been configured and set running. Also be careful of multiple GPIOs mapping to the same slice and channel (if GPIOs have a difference of 16).</p>
1394 <p >The counter compare register is double-buffered in hardware. This means that, when the PWM is running, a write to the counter compare values does not take effect until the next time the PWM slice wraps (or, in phase-correct mode, the next time the slice reaches 0). If the PWM is not running, the write is latched in immediately.</p>
1395 <dl class="params"><dt>Parameters</dt><dd>
1396   <table class="params">
1397     <tr><td class="paramname">gpio</td><td>GPIO to set level of </td></tr>
1398     <tr><td class="paramname">level</td><td>PWM level for this GPIO </td></tr>
1399   </table>
1400   </dd>
1401 </dl>
1402
1403 </div>
1404 </div>
1405 <a id="ga093a3c371dda3aa2291331147337265e" name="ga093a3c371dda3aa2291331147337265e"></a>
1406 <h2 class="memtitle"><span class="permalink"><a href="#ga093a3c371dda3aa2291331147337265e">&#9670;&nbsp;</a></span>pwm_set_irq_enabled()</h2>
1407
1408 <div class="memitem">
1409 <div class="memproto">
1410 <table class="mlabels">
1411   <tr>
1412   <td class="mlabels-left">
1413       <table class="memname">
1414         <tr>
1415           <td class="memname">static void pwm_set_irq_enabled </td>
1416           <td>(</td>
1417           <td class="paramtype">uint&#160;</td>
1418           <td class="paramname"><em>slice_num</em>, </td>
1419         </tr>
1420         <tr>
1421           <td class="paramkey"></td>
1422           <td></td>
1423           <td class="paramtype">bool&#160;</td>
1424           <td class="paramname"><em>enabled</em>&#160;</td>
1425         </tr>
1426         <tr>
1427           <td></td>
1428           <td>)</td>
1429           <td></td><td></td>
1430         </tr>
1431       </table>
1432   </td>
1433   <td class="mlabels-right">
1434 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1435   </tr>
1436 </table>
1437 </div><div class="memdoc">
1438
1439 <p>Enable PWM instance interrupt. </p>
1440 <p >Used to enable a single PWM instance interrupt.</p>
1441 <dl class="params"><dt>Parameters</dt><dd>
1442   <table class="params">
1443     <tr><td class="paramname">slice_num</td><td>PWM block to enable/disable </td></tr>
1444     <tr><td class="paramname">enabled</td><td>true to enable, false to disable </td></tr>
1445   </table>
1446   </dd>
1447 </dl>
1448
1449 </div>
1450 </div>
1451 <a id="gac32a9b468ddbd49bad6ebff6789fd215" name="gac32a9b468ddbd49bad6ebff6789fd215"></a>
1452 <h2 class="memtitle"><span class="permalink"><a href="#gac32a9b468ddbd49bad6ebff6789fd215">&#9670;&nbsp;</a></span>pwm_set_irq_mask_enabled()</h2>
1453
1454 <div class="memitem">
1455 <div class="memproto">
1456 <table class="mlabels">
1457   <tr>
1458   <td class="mlabels-left">
1459       <table class="memname">
1460         <tr>
1461           <td class="memname">static void pwm_set_irq_mask_enabled </td>
1462           <td>(</td>
1463           <td class="paramtype">uint32_t&#160;</td>
1464           <td class="paramname"><em>slice_mask</em>, </td>
1465         </tr>
1466         <tr>
1467           <td class="paramkey"></td>
1468           <td></td>
1469           <td class="paramtype">bool&#160;</td>
1470           <td class="paramname"><em>enabled</em>&#160;</td>
1471         </tr>
1472         <tr>
1473           <td></td>
1474           <td>)</td>
1475           <td></td><td></td>
1476         </tr>
1477       </table>
1478   </td>
1479   <td class="mlabels-right">
1480 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1481   </tr>
1482 </table>
1483 </div><div class="memdoc">
1484
1485 <p>Enable multiple PWM instance interrupts. </p>
1486 <p >Use this to enable multiple PWM interrupts at once.</p>
1487 <dl class="params"><dt>Parameters</dt><dd>
1488   <table class="params">
1489     <tr><td class="paramname">slice_mask</td><td>Bitmask of all the blocks to enable/disable. Channel 0 = bit 0, channel 1 = bit 1 etc. </td></tr>
1490     <tr><td class="paramname">enabled</td><td>true to enable, false to disable </td></tr>
1491   </table>
1492   </dd>
1493 </dl>
1494
1495 </div>
1496 </div>
1497 <a id="ga257ea7fd33fcf33815a01dd279ca578d" name="ga257ea7fd33fcf33815a01dd279ca578d"></a>
1498 <h2 class="memtitle"><span class="permalink"><a href="#ga257ea7fd33fcf33815a01dd279ca578d">&#9670;&nbsp;</a></span>pwm_set_mask_enabled()</h2>
1499
1500 <div class="memitem">
1501 <div class="memproto">
1502 <table class="mlabels">
1503   <tr>
1504   <td class="mlabels-left">
1505       <table class="memname">
1506         <tr>
1507           <td class="memname">static void pwm_set_mask_enabled </td>
1508           <td>(</td>
1509           <td class="paramtype">uint32_t&#160;</td>
1510           <td class="paramname"><em>mask</em></td><td>)</td>
1511           <td></td>
1512         </tr>
1513       </table>
1514   </td>
1515   <td class="mlabels-right">
1516 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1517   </tr>
1518 </table>
1519 </div><div class="memdoc">
1520
1521 <p>Enable/Disable multiple PWM slices simultaneously. </p>
1522 <dl class="params"><dt>Parameters</dt><dd>
1523   <table class="params">
1524     <tr><td class="paramname">mask</td><td>Bitmap of PWMs to enable/disable. Bits 0 to 7 enable slices 0-7 respectively </td></tr>
1525   </table>
1526   </dd>
1527 </dl>
1528
1529 </div>
1530 </div>
1531 <a id="gab12ab09d76aed43a36f973232718fdd6" name="gab12ab09d76aed43a36f973232718fdd6"></a>
1532 <h2 class="memtitle"><span class="permalink"><a href="#gab12ab09d76aed43a36f973232718fdd6">&#9670;&nbsp;</a></span>pwm_set_output_polarity()</h2>
1533
1534 <div class="memitem">
1535 <div class="memproto">
1536 <table class="mlabels">
1537   <tr>
1538   <td class="mlabels-left">
1539       <table class="memname">
1540         <tr>
1541           <td class="memname">static void pwm_set_output_polarity </td>
1542           <td>(</td>
1543           <td class="paramtype">uint&#160;</td>
1544           <td class="paramname"><em>slice_num</em>, </td>
1545         </tr>
1546         <tr>
1547           <td class="paramkey"></td>
1548           <td></td>
1549           <td class="paramtype">bool&#160;</td>
1550           <td class="paramname"><em>a</em>, </td>
1551         </tr>
1552         <tr>
1553           <td class="paramkey"></td>
1554           <td></td>
1555           <td class="paramtype">bool&#160;</td>
1556           <td class="paramname"><em>b</em>&#160;</td>
1557         </tr>
1558         <tr>
1559           <td></td>
1560           <td>)</td>
1561           <td></td><td></td>
1562         </tr>
1563       </table>
1564   </td>
1565   <td class="mlabels-right">
1566 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1567   </tr>
1568 </table>
1569 </div><div class="memdoc">
1570
1571 <p>Set PWM output polarity. </p>
1572 <dl class="params"><dt>Parameters</dt><dd>
1573   <table class="params">
1574     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1575     <tr><td class="paramname">a</td><td>true to invert output A </td></tr>
1576     <tr><td class="paramname">b</td><td>true to invert output B </td></tr>
1577   </table>
1578   </dd>
1579 </dl>
1580
1581 </div>
1582 </div>
1583 <a id="gacb2a1995f0bfdb12345607b903c3f11e" name="gacb2a1995f0bfdb12345607b903c3f11e"></a>
1584 <h2 class="memtitle"><span class="permalink"><a href="#gacb2a1995f0bfdb12345607b903c3f11e">&#9670;&nbsp;</a></span>pwm_set_phase_correct()</h2>
1585
1586 <div class="memitem">
1587 <div class="memproto">
1588 <table class="mlabels">
1589   <tr>
1590   <td class="mlabels-left">
1591       <table class="memname">
1592         <tr>
1593           <td class="memname">static void pwm_set_phase_correct </td>
1594           <td>(</td>
1595           <td class="paramtype">uint&#160;</td>
1596           <td class="paramname"><em>slice_num</em>, </td>
1597         </tr>
1598         <tr>
1599           <td class="paramkey"></td>
1600           <td></td>
1601           <td class="paramtype">bool&#160;</td>
1602           <td class="paramname"><em>phase_correct</em>&#160;</td>
1603         </tr>
1604         <tr>
1605           <td></td>
1606           <td>)</td>
1607           <td></td><td></td>
1608         </tr>
1609       </table>
1610   </td>
1611   <td class="mlabels-right">
1612 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1613   </tr>
1614 </table>
1615 </div><div class="memdoc">
1616
1617 <p>Set PWM phase correct on/off. </p>
1618 <dl class="params"><dt>Parameters</dt><dd>
1619   <table class="params">
1620     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1621     <tr><td class="paramname">phase_correct</td><td>true to set phase correct modulation, false to set trailing edge</td></tr>
1622   </table>
1623   </dd>
1624 </dl>
1625 <p>Setting phase control to true means that instead of wrapping back to zero when the wrap point is reached, the PWM starts counting back down. The output frequency is halved when phase-correct mode is enabled. </p>
1626
1627 </div>
1628 </div>
1629 <a id="ga6f8fe346e6912cfab3d36b00043a3627" name="ga6f8fe346e6912cfab3d36b00043a3627"></a>
1630 <h2 class="memtitle"><span class="permalink"><a href="#ga6f8fe346e6912cfab3d36b00043a3627">&#9670;&nbsp;</a></span>pwm_set_wrap()</h2>
1631
1632 <div class="memitem">
1633 <div class="memproto">
1634 <table class="mlabels">
1635   <tr>
1636   <td class="mlabels-left">
1637       <table class="memname">
1638         <tr>
1639           <td class="memname">static void pwm_set_wrap </td>
1640           <td>(</td>
1641           <td class="paramtype">uint&#160;</td>
1642           <td class="paramname"><em>slice_num</em>, </td>
1643         </tr>
1644         <tr>
1645           <td class="paramkey"></td>
1646           <td></td>
1647           <td class="paramtype">uint16_t&#160;</td>
1648           <td class="paramname"><em>wrap</em>&#160;</td>
1649         </tr>
1650         <tr>
1651           <td></td>
1652           <td>)</td>
1653           <td></td><td></td>
1654         </tr>
1655       </table>
1656   </td>
1657   <td class="mlabels-right">
1658 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
1659   </tr>
1660 </table>
1661 </div><div class="memdoc">
1662
1663 <p>Set the current PWM counter wrap value. </p>
1664 <p >Set the highest value the counter will reach before returning to 0. Also known as TOP.</p>
1665 <p >The counter wrap value is double-buffered in hardware. This means that, when the PWM is running, a write to the counter wrap value does not take effect until after the next time the PWM slice wraps (or, in phase-correct mode, the next time the slice reaches 0). If the PWM is not running, the write is latched in immediately.</p>
1666 <dl class="params"><dt>Parameters</dt><dd>
1667   <table class="params">
1668     <tr><td class="paramname">slice_num</td><td>PWM slice number </td></tr>
1669     <tr><td class="paramname">wrap</td><td>Value to set wrap to </td></tr>
1670   </table>
1671   </dd>
1672 </dl>
1673
1674 </div>
1675 </div>
1676 </div><!-- contents -->
1677 </div><!-- doc-content -->
1678
1679         <script src="main.js"></script>
1680 </body>
1681 </html>