begriffs open source - cmsis/blob - main/Core_A/html/using_CMSIS.html

   1 <!-- HTML header for doxygen 1.9.6-->
   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" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Core (Cortex-A): Basic CMSIS Example</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-Core (Cortex-A)
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this, "CMSIS-Core (Cortex-A)");
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('using_CMSIS.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div><div class="header">
 127   <div class="headertitle"><div class="title">Basic CMSIS Example </div></div>
 128 </div><!--header-->
 129 <div class="contents">
 130 <div class="textblock"><p>A typical example for using the CMSIS layer is provided below. The example is based on an unspecific Cortex-A9 Device.</p>
 131 <div class="fragment"><div class="line"><span class="preprocessor">#include &lt;ARMCA9.h&gt;</span>                              <span class="comment">// File name depends on device used</span></div>
 132 <div class="line"> </div>
 133 <div class="line"><span class="keyword">static</span> <span class="keyword">const</span> uint32_t TICK_RATE_HZ = 1000U;</div>
 134 <div class="line"> </div>
 135 <div class="line">uint32_t <span class="keyword">volatile</span> msTicks;                       <span class="comment">// Counter for millisecond Interval</span></div>
 136 <div class="line"> </div>
 137 <div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> SysTick_Handler( <span class="keywordtype">void</span> )</div>
 138 <div class="line">{</div>
 139 <div class="line">  msTicks++;                                     <span class="comment">// Increment Counter</span></div>
 140 <div class="line">}</div>
 141 <div class="line"> </div>
 142 <div class="line"><span class="comment">// We use the Private Tiemer (PTIM) of the Cortex-A9 FVP Model here.</span></div>
 143 <div class="line"><span class="comment">// In general the available Timers are highly vendor specific for Cortex-A processors.</span></div>
 144 <div class="line"><span class="keywordtype">void</span> private_timer_init(<span class="keywordtype">void</span>) {</div>
 145 <div class="line"> </div>
 146 <div class="line">  <a class="code hl_function" href="group__PTM__timer__functions.html#ga30516fed24977be8eecf3efd8b6a2fea">PTIM_SetLoadValue</a> ((<a class="code hl_variable" href="group__system__init__gr.html#gaa3cd3e43291e81e795d642b79b6088e6">SystemCoreClock</a>/TICK_RATE_HZ) - 1U);</div>
 147 <div class="line">  <a class="code hl_function" href="group__PTM__timer__functions.html#gaabc1dba029389fe0e2a6297952df7972">PTIM_SetControl</a> (<a class="code hl_function" href="group__PTM__timer__functions.html#ga34f0ceea142a4be1479cb552bf8bc4d1">PTIM_GetControl</a>() | 7U);</div>
 148 <div class="line"> </div>
 149 <div class="line">  <span class="comment">/* Install SysTick_Handler as the interrupt function for PTIM */</span></div>
 150 <div class="line">  <a class="code hl_function" href="group__irq__ctrl__gr.html#gac1fcc16fb8e488d315cfa496f1d71db3">IRQ_SetHandler</a>((<a class="code hl_typedef" href="irq__ctrl_8h.html#ac62964c04a7fed2c84aeea9e34f415e2">IRQn_ID_t</a>)PrivTimer_IRQn, SysTick_Handler);</div>
 151 <div class="line"> </div>
 152 <div class="line">  <span class="comment">/* Determine number of implemented priority bits */</span></div>
 153 <div class="line">  <a class="code hl_function" href="group__irq__ctrl__gr.html#gaa90aed20ac94420fff4bbbf55c12d4c2">IRQ_SetPriority</a> ((<a class="code hl_typedef" href="irq__ctrl_8h.html#ac62964c04a7fed2c84aeea9e34f415e2">IRQn_ID_t</a>)PrivTimer_IRQn, <a class="code hl_define" href="group__irq__priority__defs.html#gabaa4e91ab84dbe5f669080af6d0d81fa">IRQ_PRIORITY_Msk</a>);</div>
 154 <div class="line"> </div>
 155 <div class="line">  <span class="comment">/* Set lowest priority -1 */</span></div>
 156 <div class="line">  <a class="code hl_function" href="group__irq__ctrl__gr.html#gaa90aed20ac94420fff4bbbf55c12d4c2">IRQ_SetPriority</a> ((<a class="code hl_typedef" href="irq__ctrl_8h.html#ac62964c04a7fed2c84aeea9e34f415e2">IRQn_ID_t</a>)PrivTimer_IRQn, <a class="code hl_function" href="group__GIC__functions.html#ga397048004654f792649742f95bf8ae67">GIC_GetPriority</a>((<a class="code hl_typedef" href="irq__ctrl_8h.html#ac62964c04a7fed2c84aeea9e34f415e2">IRQn_ID_t</a>)PrivTimer_IRQn)-1);</div>
 157 <div class="line"> </div>
 158 <div class="line">  <span class="comment">/* Enable IRQ */</span></div>
 159 <div class="line">  <a class="code hl_function" href="group__irq__ctrl__gr.html#ga4ad780a3dc23a1b6222de8adcd7c20a7">IRQ_Enable</a> ((<a class="code hl_typedef" href="irq__ctrl_8h.html#ac62964c04a7fed2c84aeea9e34f415e2">IRQn_ID_t</a>)PrivTimer_IRQn);</div>
 160 <div class="line">}</div>
 161 <div class="line"> </div>
 162 <div class="line"><span class="comment">/* Delay execution for given amount of ticks */</span></div>
 163 <div class="line"><span class="keywordtype">void</span> Delay(uint32_t ticks)  {</div>
 164 <div class="line">  uint32_t tgtTicks = msTicks + ticks;             <span class="comment">// target tick count to delay execution to</span></div>
 165 <div class="line">  <span class="keywordflow">while</span> (msTicks == tgtTicks)  {</div>
 166 <div class="line">    <a class="code hl_define" href="group__CMSIS__Core__InstructionInterface.html#gaac6cc7dd4325d9cb40d3290fa5244b3d">__WFE</a> ();                                      <span class="comment">// Power-Down until next Event/Interrupt</span></div>
 167 <div class="line">  }</div>
 168 <div class="line">}</div>
 169 <div class="line"> </div>
 170 <div class="line"><span class="comment">/* main function */</span></div>
 171 <div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">void</span>)</div>
 172 <div class="line">{</div>
 173 <div class="line">  <span class="comment">/* Initialize device HAL here */</span></div>
 174 <div class="line">  private_timer_init();</div>
 175 <div class="line"> </div>
 176 <div class="line">  <span class="keyword">static</span> uint8_t ledState = 0;</div>
 177 <div class="line"> </div>
 178 <div class="line">  <span class="comment">/* Infinite loop */</span></div>
 179 <div class="line">  <span class="keywordflow">while</span> (1)</div>
 180 <div class="line">  {</div>
 181 <div class="line">    <span class="comment">/* Add application code here */</span></div>
 182 <div class="line">    ledState = !ledState;</div>
 183 <div class="line">    Delay(500);</div>
 184 <div class="line">  }</div>
 185 <div class="line">}</div>
 186 <div class="ttc" id="agroup__CMSIS__Core__InstructionInterface_html_gaac6cc7dd4325d9cb40d3290fa5244b3d"><div class="ttname"><a href="group__CMSIS__Core__InstructionInterface.html#gaac6cc7dd4325d9cb40d3290fa5244b3d">__WFE</a></div><div class="ttdeci">#define __WFE</div><div class="ttdoc">Wait For Event.</div></div>
 187 <div class="ttc" id="agroup__GIC__functions_html_ga397048004654f792649742f95bf8ae67"><div class="ttname"><a href="group__GIC__functions.html#ga397048004654f792649742f95bf8ae67">GIC_GetPriority</a></div><div class="ttdeci">__STATIC_INLINE uint32_t GIC_GetPriority(IRQn_Type IRQn)</div><div class="ttdoc">Read the current interrupt priority from GIC's IPRIORITYR register.</div><div class="ttdef"><b>Definition:</b> core_ca.h:1668</div></div>
 188 <div class="ttc" id="agroup__PTM__timer__functions_html_ga30516fed24977be8eecf3efd8b6a2fea"><div class="ttname"><a href="group__PTM__timer__functions.html#ga30516fed24977be8eecf3efd8b6a2fea">PTIM_SetLoadValue</a></div><div class="ttdeci">__STATIC_INLINE void PTIM_SetLoadValue(uint32_t value)</div><div class="ttdoc">Set the load value to timers LOAD register.</div><div class="ttdef"><b>Definition:</b> core_ca.h:1949</div></div>
 189 <div class="ttc" id="agroup__PTM__timer__functions_html_ga34f0ceea142a4be1479cb552bf8bc4d1"><div class="ttname"><a href="group__PTM__timer__functions.html#ga34f0ceea142a4be1479cb552bf8bc4d1">PTIM_GetControl</a></div><div class="ttdeci">__STATIC_INLINE uint32_t PTIM_GetControl(void)</div><div class="ttdef"><b>Definition:</b> core_ca.h:1988</div></div>
 190 <div class="ttc" id="agroup__PTM__timer__functions_html_gaabc1dba029389fe0e2a6297952df7972"><div class="ttname"><a href="group__PTM__timer__functions.html#gaabc1dba029389fe0e2a6297952df7972">PTIM_SetControl</a></div><div class="ttdeci">__STATIC_INLINE void PTIM_SetControl(uint32_t value)</div><div class="ttdoc">Configure the timer using its CONTROL register.</div><div class="ttdef"><b>Definition:</b> core_ca.h:1980</div></div>
 191 <div class="ttc" id="agroup__irq__ctrl__gr_html_ga4ad780a3dc23a1b6222de8adcd7c20a7"><div class="ttname"><a href="group__irq__ctrl__gr.html#ga4ad780a3dc23a1b6222de8adcd7c20a7">IRQ_Enable</a></div><div class="ttdeci">int32_t IRQ_Enable(IRQn_ID_t irqn)</div><div class="ttdoc">Enable interrupt.</div></div>
 192 <div class="ttc" id="agroup__irq__ctrl__gr_html_gaa90aed20ac94420fff4bbbf55c12d4c2"><div class="ttname"><a href="group__irq__ctrl__gr.html#gaa90aed20ac94420fff4bbbf55c12d4c2">IRQ_SetPriority</a></div><div class="ttdeci">int32_t IRQ_SetPriority(IRQn_ID_t irqn, uint32_t priority)</div><div class="ttdoc">Set interrupt priority value.</div></div>
 193 <div class="ttc" id="agroup__irq__ctrl__gr_html_gac1fcc16fb8e488d315cfa496f1d71db3"><div class="ttname"><a href="group__irq__ctrl__gr.html#gac1fcc16fb8e488d315cfa496f1d71db3">IRQ_SetHandler</a></div><div class="ttdeci">int32_t IRQ_SetHandler(IRQn_ID_t irqn, IRQHandler_t handler)</div><div class="ttdoc">Register interrupt handler.</div></div>
 194 <div class="ttc" id="agroup__irq__priority__defs_html_gabaa4e91ab84dbe5f669080af6d0d81fa"><div class="ttname"><a href="group__irq__priority__defs.html#gabaa4e91ab84dbe5f669080af6d0d81fa">IRQ_PRIORITY_Msk</a></div><div class="ttdeci">#define IRQ_PRIORITY_Msk</div><div class="ttdoc">Interrupt priority value bit-mask.</div></div>
 195 <div class="ttc" id="agroup__system__init__gr_html_gaa3cd3e43291e81e795d642b79b6088e6"><div class="ttname"><a href="group__system__init__gr.html#gaa3cd3e43291e81e795d642b79b6088e6">SystemCoreClock</a></div><div class="ttdeci">uint32_t SystemCoreClock</div><div class="ttdoc">Variable to hold the system core clock value.</div><div class="ttdef"><b>Definition:</b> Ref_SystemAndClock.txt:67</div></div>
 196 <div class="ttc" id="airq__ctrl_8h_html_ac62964c04a7fed2c84aeea9e34f415e2"><div class="ttname"><a href="irq__ctrl_8h.html#ac62964c04a7fed2c84aeea9e34f415e2">IRQn_ID_t</a></div><div class="ttdeci">int32_t IRQn_ID_t</div><div class="ttdoc">Interrupt ID number data type.</div><div class="ttdef"><b>Definition:</b> irq_ctrl.h:45</div></div>
 197 </div><!-- fragment --><p>CMSIS-Pack provides the <b>#define CMSIS_header_file</b> in <a href="../../Pack/html/pdsc_components_pg.html#RTE_Components_h"><b>RTE_Components.h</b></a> which gives you access to the <b><em>device</em>.h</b> file of a project. This allows you to generate generic software components that use the device selected in a project.</p>
 198 <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;RTE_Components.h&quot;</span>     <span class="comment">// include information about project configuration</span></div>
 199 <div class="line"><span class="preprocessor">#include CMSIS_device_header    </span><span class="comment">// include &lt;device&gt;.h file</span></div>
 200 </div><!-- fragment --> </div></div><!-- contents -->
 201 </div><!-- PageDoc -->
 202 </div><!-- doc-content -->
 203 <!-- start footer part -->
 204 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 205   <ul>
 206     <li class="footer">
 207       <script type="text/javascript">
 208         <!--
 209         writeFooter.call(this);
 210         //-->
 211       </script>
 212     </li>
 213   </ul>
 214 </div>
 215 </body>
 216 </html>