system_c_pg.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>System Configuration Files system_&lt;device&gt;.c and system_&lt;device&gt;.h</title>
  7. <title>CMSIS-CORE: System Configuration Files system_&lt;device&gt;.c and system_&lt;device&gt;.h</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.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="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-CORE
  35. &#160;<span id="projectnumber">Version 5.0.1</span>
  36. </div>
  37. <div id="projectbrief">CMSIS-CORE support for Cortex-M processor-based devices</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('system_c_pg.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="headertitle">
  109. <div class="title">System Configuration Files system_&lt;device&gt;.c and system_&lt;device&gt;.h </div> </div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <div class="textblock"><p>The <a class="el" href="system_c_pg.html">System Configuration Files system_&lt;device&gt;.c and system_&lt;device&gt;.h</a> provides as a minimum the functions described under <a class="el" href="group__system__init__gr.html">System and Clock Configuration</a>. These functions are device specific and need adaptations. In addition, the file might have configuration settings for the device such as XTAL frequency or PLL prescaler settings.</p>
  113. <p>For devices with external memory BUS the system_&lt;device&gt;.c also configures the BUS system.</p>
  114. <p>The silicon vendor might expose other functions (i.e. for power configuration) in the system_&lt;device&gt;.c file. In case of additional features the function prototypes need to be added to the system_&lt;device&gt;.h header file.</p>
  115. <h1><a class="anchor" id="system_Device_sec"></a>
  116. system_Device.c Template File</h1>
  117. <p>The <a class="el" href="system_c_pg.html#system_Device_sec">system_Device.c Template File</a> for the Cortex-M3 is shown below.</p>
  118. <pre class="fragment">/**************************************************************************//**
  119. * @file system_&lt;Device&gt;.c
  120. * @brief CMSIS Cortex-M# Device Peripheral Access Layer Source File for
  121. * Device &lt;Device&gt;
  122. * @version V5.00
  123. * @date 28. September 2016
  124. ******************************************************************************/
  125. /*
  126. * Copyright (c) 2009-2016 ARM Limited. All rights reserved.
  127. *
  128. * SPDX-License-Identifier: Apache-2.0
  129. *
  130. * Licensed under the Apache License, Version 2.0 (the License); you may
  131. * not use this file except in compliance with the License.
  132. * You may obtain a copy of the License at
  133. *
  134. * www.apache.org/licenses/LICENSE-2.0
  135. *
  136. * Unless required by applicable law or agreed to in writing, software
  137. * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  138. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  139. * See the License for the specific language governing permissions and
  140. * limitations under the License.
  141. */
  142. #include &lt;stdint.h&gt;
  143. #include "&lt;Device&gt;.h"
  144. /*----------------------------------------------------------------------------
  145. Define clocks
  146. *----------------------------------------------------------------------------*/
  147. /* ToDo: add here your necessary defines for device initialization
  148. following is an example for different system frequencies */
  149. #define XTAL (12000000U) /* Oscillator frequency */
  150. #define SYSTEM_CLOCK (5 * XTAL)
  151. /*----------------------------------------------------------------------------
  152. System Core Clock Variable
  153. *----------------------------------------------------------------------------*/
  154. /* ToDo: initialize SystemCoreClock with the system core clock frequency value
  155. achieved after system intitialization.
  156. This means system core clock frequency after call to SystemInit() */
  157. uint32_t SystemCoreClock = SYSTEM_CLOCK; /* System Clock Frequency (Core Clock)*/
  158. /*----------------------------------------------------------------------------
  159. Clock functions
  160. *----------------------------------------------------------------------------*/
  161. void SystemCoreClockUpdate (void) /* Get Core Clock Frequency */
  162. {
  163. /* ToDo: add code to calculate the system frequency based upon the current
  164. register settings.
  165. This function can be used to retrieve the system core clock frequeny
  166. after user changed register sittings. */
  167. SystemCoreClock = SYSTEM_CLOCK;
  168. }
  169. void SystemInit (void)
  170. {
  171. /* ToDo: add code to initialize the system
  172. do not use global variables because this function is called before
  173. reaching pre-main. RW section maybe overwritten afterwards. */
  174. SystemCoreClock = SYSTEM_CLOCK;
  175. }
  176. </pre><h1><a class="anchor" id="system_Device_h_sec"></a>
  177. system_Device.h Template File</h1>
  178. <p>The system_&lt;device&gt;.h header file contains prototypes to access the public functions in the system_&lt;device&gt;.c file. The <a class="el" href="system_c_pg.html#system_Device_h_sec">system_Device.h Template File</a> is shown below.</p>
  179. <pre class="fragment">/**************************************************************************//**
  180. * @file system_&lt;Device&gt;.h
  181. * @brief CMSIS Cortex-M# Device Peripheral Access Layer Header File for
  182. * Device &lt;Device&gt;
  183. * @version V5.00
  184. * @date 02. March 2016
  185. ******************************************************************************/
  186. /*
  187. * Copyright (c) 2009-2016 ARM Limited. All rights reserved.
  188. *
  189. * SPDX-License-Identifier: Apache-2.0
  190. *
  191. * Licensed under the Apache License, Version 2.0 (the License); you may
  192. * not use this file except in compliance with the License.
  193. * You may obtain a copy of the License at
  194. *
  195. * www.apache.org/licenses/LICENSE-2.0
  196. *
  197. * Unless required by applicable law or agreed to in writing, software
  198. * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  199. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  200. * See the License for the specific language governing permissions and
  201. * limitations under the License.
  202. */
  203. #ifndef SYSTEM_&lt;Device&gt;_H /* ToDo: replace '&lt;Device&gt;' with your device name */
  204. #define SYSTEM_&lt;Device&gt;_H
  205. #ifdef __cplusplus
  206. extern "C" {
  207. #endif
  208. #include &lt;stdint.h&gt;
  209. extern uint32_t SystemCoreClock; /*!&lt; System Clock Frequency (Core Clock) */
  210. /**
  211. \brief Setup the microcontroller system.
  212. Initialize the System and update the SystemCoreClock variable.
  213. */
  214. extern void SystemInit (void);
  215. /**
  216. \brief Update SystemCoreClock variable.
  217. Updates the SystemCoreClock with current core Clock retrieved from cpu registers.
  218. */
  219. extern void SystemCoreClockUpdate (void);
  220. #ifdef __cplusplus
  221. }
  222. #endif
  223. #endif /* SYSTEM_&lt;Device&gt;_H */
  224. </pre> </div></div><!-- contents -->
  225. </div><!-- doc-content -->
  226. <!-- start footer part -->
  227. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  228. <ul>
  229. <li class="navelem"><a class="el" href="templates_pg.html">CMSIS-Core Device Templates</a></li>
  230. <li class="footer">Generated on Wed Feb 8 2017 10:20:41 for CMSIS-CORE by ARM Ltd. All rights reserved.
  231. <!--
  232. <a href="http://www.doxygen.org/index.html">
  233. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  234. -->
  235. </li>
  236. </ul>
  237. </div>
  238. </body>
  239. </html>