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">
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-M): D-Cache Functions</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&dn=expat.txt MIT */
28 $(document).ready(function() { init_search(); });
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>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
41 <table cellspacing="0" cellpadding="0">
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-M)
47  <span id="projectnumber"><script type="text/javascript">
49 writeHeader.call(this);
50 writeVersionDropdown.call(this);
55 <div id="projectbrief">CMSIS-Core support for Cortex-M processor-based devices</div>
57 <td> <div id="MSearchBox" class="MSearchBoxInactive">
59 <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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>
69 <!--END !PROJECT_NAME-->
74 <!-- end header part -->
75 <div id="CMSISnav" class="tabs1">
77 <script type="text/javascript">
78 writeComponentTabs.call(this);
82 <script type="text/javascript">
83 writeSubComponentTabs.call(this);
85 <!-- Generated by Doxygen 1.9.6 -->
86 <script type="text/javascript">
87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
88 var searchBox = new SearchBox("searchBox", "search/",'.html');
92 <div id="side-nav" class="ui-resizable side-nav-resizable">
94 <div id="nav-tree-contents">
95 <div id="nav-sync" class="sync"></div>
98 <div id="splitbar" style="-moz-user-select:none;"
99 class="ui-resizable-handle">
102 <script type="text/javascript">
103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
104 $(document).ready(function(){initNavTree('group__Dcache__functions__m7.html',''); initResizable(); });
107 <div id="doc-content">
108 <!-- window showing the filter options -->
109 <div id="MSearchSelectWindow"
110 onmouseover="return searchBox.OnSearchSelectShow()"
111 onmouseout="return searchBox.OnSearchSelectHide()"
112 onkeydown="return searchBox.OnSearchSelectKey(event)">
115 <!-- iframe showing the search results (closed by default) -->
116 <div id="MSearchResultsWindow">
117 <div id="MSearchResults">
120 <div id="SRResults"></div>
121 <div class="SRStatus" id="Loading">Loading...</div>
122 <div class="SRStatus" id="Searching">Searching...</div>
123 <div class="SRStatus" id="NoMatches">No Matches</div>
130 <div class="summary">
131 <a href="#func-members">Functions</a> </div>
132 <div class="headertitle"><div class="title">D-Cache Functions<div class="ingroups"><a class="el" href="group__cache__functions__m7.html">Cache Functions (Level-1)</a></div></div></div>
134 <div class="contents">
136 <p>Functions for the level-1 data cache.
137 <a href="#details">More...</a></p>
138 <table class="memberdecls">
139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
140 Functions</h2></td></tr>
141 <tr class="memitem:ga3861db932100ccb53f994e2cc68ed79c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Dcache__functions__m7.html#ga3861db932100ccb53f994e2cc68ed79c">SCB_EnableDCache</a> (void)</td></tr>
142 <tr class="memdesc:ga3861db932100ccb53f994e2cc68ed79c"><td class="mdescLeft"> </td><td class="mdescRight">Enable D-Cache. <br /></td></tr>
143 <tr class="separator:ga3861db932100ccb53f994e2cc68ed79c"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:gafe64b44d1a61483a947e44a77a9d3287"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Dcache__functions__m7.html#gafe64b44d1a61483a947e44a77a9d3287">SCB_DisableDCache</a> (void)</td></tr>
145 <tr class="memdesc:gafe64b44d1a61483a947e44a77a9d3287"><td class="mdescLeft"> </td><td class="mdescRight">Disable D-Cache. <br /></td></tr>
146 <tr class="separator:gafe64b44d1a61483a947e44a77a9d3287"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:ga99fe43c224644881935de135ceaa2dd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Dcache__functions__m7.html#ga99fe43c224644881935de135ceaa2dd9">SCB_InvalidateDCache</a> (void)</td></tr>
148 <tr class="memdesc:ga99fe43c224644881935de135ceaa2dd9"><td class="mdescLeft"> </td><td class="mdescRight">Invalidate D-Cache. <br /></td></tr>
149 <tr class="separator:ga99fe43c224644881935de135ceaa2dd9"><td class="memSeparator" colspan="2"> </td></tr>
150 <tr class="memitem:gaf5585be5547cc60585d702a6129f4c17"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Dcache__functions__m7.html#gaf5585be5547cc60585d702a6129f4c17">SCB_CleanDCache</a> (void)</td></tr>
151 <tr class="memdesc:gaf5585be5547cc60585d702a6129f4c17"><td class="mdescLeft"> </td><td class="mdescRight">Clean D-Cache. <br /></td></tr>
152 <tr class="separator:gaf5585be5547cc60585d702a6129f4c17"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:ga5b22ca58709fadc326da83197a2f28bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Dcache__functions__m7.html#ga5b22ca58709fadc326da83197a2f28bb">SCB_CleanInvalidateDCache</a> (void)</td></tr>
154 <tr class="memdesc:ga5b22ca58709fadc326da83197a2f28bb"><td class="mdescLeft"> </td><td class="mdescRight">Clean & Invalidate D-Cache. <br /></td></tr>
155 <tr class="separator:ga5b22ca58709fadc326da83197a2f28bb"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:ga31c2439722ab4dbd0c67b196e3377ca7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Dcache__functions__m7.html#ga31c2439722ab4dbd0c67b196e3377ca7">SCB_InvalidateDCache_by_Addr</a> (volatile void *addr, int32_t dsize)</td></tr>
157 <tr class="memdesc:ga31c2439722ab4dbd0c67b196e3377ca7"><td class="mdescLeft"> </td><td class="mdescRight">D-Cache Invalidate by address. <br /></td></tr>
158 <tr class="separator:ga31c2439722ab4dbd0c67b196e3377ca7"><td class="memSeparator" colspan="2"> </td></tr>
159 <tr class="memitem:gabc9e51347dca344c72948c3dba0364fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Dcache__functions__m7.html#gabc9e51347dca344c72948c3dba0364fd">SCB_CleanDCache_by_Addr</a> (volatile void *addr, int32_t dsize)</td></tr>
160 <tr class="memdesc:gabc9e51347dca344c72948c3dba0364fd"><td class="mdescLeft"> </td><td class="mdescRight">D-Cache Clean by address. <br /></td></tr>
161 <tr class="separator:gabc9e51347dca344c72948c3dba0364fd"><td class="memSeparator" colspan="2"> </td></tr>
162 <tr class="memitem:ga83fe294bcc60d3c4f1c279f13477dda7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Dcache__functions__m7.html#ga83fe294bcc60d3c4f1c279f13477dda7">SCB_CleanInvalidateDCache_by_Addr</a> (volatile void *addr, int32_t dsize)</td></tr>
163 <tr class="memdesc:ga83fe294bcc60d3c4f1c279f13477dda7"><td class="mdescLeft"> </td><td class="mdescRight">D-Cache Clean and Invalidate by address. <br /></td></tr>
164 <tr class="separator:ga83fe294bcc60d3c4f1c279f13477dda7"><td class="memSeparator" colspan="2"> </td></tr>
166 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
167 <p>Functions for the level-1 data cache. </p>
168 <p>// close ICache functions</p>
169 <h2 class="groupheader">Function Documentation</h2>
170 <a id="gaf5585be5547cc60585d702a6129f4c17" name="gaf5585be5547cc60585d702a6129f4c17"></a>
171 <h2 class="memtitle"><span class="permalink"><a href="#gaf5585be5547cc60585d702a6129f4c17">◆ </a></span>SCB_CleanDCache()</h2>
173 <div class="memitem">
174 <div class="memproto">
175 <table class="memname">
177 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void SCB_CleanDCache </td>
179 <td class="paramtype">void </td>
180 <td class="paramname"></td><td>)</td>
184 </div><div class="memdoc">
186 <p>Clean D-Cache. </p>
187 <p>The function cleans the entire data cache. </p>
191 <a id="gabc9e51347dca344c72948c3dba0364fd" name="gabc9e51347dca344c72948c3dba0364fd"></a>
192 <h2 class="memtitle"><span class="permalink"><a href="#gabc9e51347dca344c72948c3dba0364fd">◆ </a></span>SCB_CleanDCache_by_Addr()</h2>
194 <div class="memitem">
195 <div class="memproto">
196 <table class="memname">
198 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void SCB_CleanDCache_by_Addr </td>
200 <td class="paramtype">volatile void * </td>
201 <td class="paramname"><em>addr</em>, </td>
204 <td class="paramkey"></td>
206 <td class="paramtype">int32_t </td>
207 <td class="paramname"><em>dsize</em> </td>
215 </div><div class="memdoc">
217 <p>D-Cache Clean by address. </p>
218 <dl class="params"><dt>Parameters</dt><dd>
219 <table class="params">
220 <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>address (aligned to 32-byte boundary) </td></tr>
221 <tr><td class="paramdir">[in]</td><td class="paramname">dsize</td><td>size of memory block (in number of bytes)</td></tr>
225 <p>The function cleans a memory block of size <em>dsize</em> [bytes] starting at address <em>address</em>. The address is aligned to 32-byte boundary. </p>
229 <a id="ga5b22ca58709fadc326da83197a2f28bb" name="ga5b22ca58709fadc326da83197a2f28bb"></a>
230 <h2 class="memtitle"><span class="permalink"><a href="#ga5b22ca58709fadc326da83197a2f28bb">◆ </a></span>SCB_CleanInvalidateDCache()</h2>
232 <div class="memitem">
233 <div class="memproto">
234 <table class="memname">
236 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void SCB_CleanInvalidateDCache </td>
238 <td class="paramtype">void </td>
239 <td class="paramname"></td><td>)</td>
243 </div><div class="memdoc">
245 <p>Clean & Invalidate D-Cache. </p>
246 <p>The function cleans and invalidates the entire data cache. </p>
250 <a id="ga83fe294bcc60d3c4f1c279f13477dda7" name="ga83fe294bcc60d3c4f1c279f13477dda7"></a>
251 <h2 class="memtitle"><span class="permalink"><a href="#ga83fe294bcc60d3c4f1c279f13477dda7">◆ </a></span>SCB_CleanInvalidateDCache_by_Addr()</h2>
253 <div class="memitem">
254 <div class="memproto">
255 <table class="memname">
257 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void SCB_CleanInvalidateDCache_by_Addr </td>
259 <td class="paramtype">volatile void * </td>
260 <td class="paramname"><em>addr</em>, </td>
263 <td class="paramkey"></td>
265 <td class="paramtype">int32_t </td>
266 <td class="paramname"><em>dsize</em> </td>
274 </div><div class="memdoc">
276 <p>D-Cache Clean and Invalidate by address. </p>
277 <dl class="params"><dt>Parameters</dt><dd>
278 <table class="params">
279 <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>address (aligned to 32-byte boundary) </td></tr>
280 <tr><td class="paramdir">[in]</td><td class="paramname">dsize</td><td>size of memory block (in number of bytes)</td></tr>
284 <p>The function invalidates and cleans a memory block of size <em>dsize</em> [bytes] starting at address <em>address</em>. The address is aligned to 32-byte boundary. </p>
288 <a id="gafe64b44d1a61483a947e44a77a9d3287" name="gafe64b44d1a61483a947e44a77a9d3287"></a>
289 <h2 class="memtitle"><span class="permalink"><a href="#gafe64b44d1a61483a947e44a77a9d3287">◆ </a></span>SCB_DisableDCache()</h2>
291 <div class="memitem">
292 <div class="memproto">
293 <table class="memname">
295 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void SCB_DisableDCache </td>
297 <td class="paramtype">void </td>
298 <td class="paramname"></td><td>)</td>
302 </div><div class="memdoc">
304 <p>Disable D-Cache. </p>
305 <p>The function turns off the entire data cache.</p>
306 <dl class="section note"><dt>Note</dt><dd>When disabling the data cache, you must clean (<a class="el" href="group__Dcache__functions__m7.html#gaf5585be5547cc60585d702a6129f4c17">SCB_CleanDCache</a>) the entire cache to ensure that any dirty data is flushed to external memory. </dd></dl>
310 <a id="ga3861db932100ccb53f994e2cc68ed79c" name="ga3861db932100ccb53f994e2cc68ed79c"></a>
311 <h2 class="memtitle"><span class="permalink"><a href="#ga3861db932100ccb53f994e2cc68ed79c">◆ </a></span>SCB_EnableDCache()</h2>
313 <div class="memitem">
314 <div class="memproto">
315 <table class="memname">
317 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void SCB_EnableDCache </td>
319 <td class="paramtype">void </td>
320 <td class="paramname"></td><td>)</td>
324 </div><div class="memdoc">
326 <p>Enable D-Cache. </p>
327 <p>The function turns on the entire data cache. </p><dl class="section note"><dt>Note</dt><dd>Before enabling the data cache, you must invalidate the entire data cache (<a class="el" href="group__Dcache__functions__m7.html#ga99fe43c224644881935de135ceaa2dd9">SCB_InvalidateDCache</a>), because external memory might have changed from when the cache was disabled.</dd>
329 After reset, you must invalidate (<a class="el" href="group__Dcache__functions__m7.html#ga99fe43c224644881935de135ceaa2dd9">SCB_InvalidateDCache</a>) each cache before enabling it. </dd></dl>
333 <a id="ga99fe43c224644881935de135ceaa2dd9" name="ga99fe43c224644881935de135ceaa2dd9"></a>
334 <h2 class="memtitle"><span class="permalink"><a href="#ga99fe43c224644881935de135ceaa2dd9">◆ </a></span>SCB_InvalidateDCache()</h2>
336 <div class="memitem">
337 <div class="memproto">
338 <table class="memname">
340 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void SCB_InvalidateDCache </td>
342 <td class="paramtype">void </td>
343 <td class="paramname"></td><td>)</td>
347 </div><div class="memdoc">
349 <p>Invalidate D-Cache. </p>
350 <p>The function invalidates the entire data cache.</p>
351 <dl class="section note"><dt>Note</dt><dd>After reset, you must invalidate each cache before enabling (<a class="el" href="group__Dcache__functions__m7.html#ga3861db932100ccb53f994e2cc68ed79c">SCB_EnableDCache</a>) it. </dd></dl>
355 <a id="ga31c2439722ab4dbd0c67b196e3377ca7" name="ga31c2439722ab4dbd0c67b196e3377ca7"></a>
356 <h2 class="memtitle"><span class="permalink"><a href="#ga31c2439722ab4dbd0c67b196e3377ca7">◆ </a></span>SCB_InvalidateDCache_by_Addr()</h2>
358 <div class="memitem">
359 <div class="memproto">
360 <table class="memname">
362 <td class="memname"><a class="el" href="group__compiler__conntrol__gr.html#gab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> void SCB_InvalidateDCache_by_Addr </td>
364 <td class="paramtype">volatile void * </td>
365 <td class="paramname"><em>addr</em>, </td>
368 <td class="paramkey"></td>
370 <td class="paramtype">int32_t </td>
371 <td class="paramname"><em>dsize</em> </td>
379 </div><div class="memdoc">
381 <p>D-Cache Invalidate by address. </p>
382 <dl class="params"><dt>Parameters</dt><dd>
383 <table class="params">
384 <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>address (aligned to 32-byte boundary) </td></tr>
385 <tr><td class="paramdir">[in]</td><td class="paramname">dsize</td><td>size of memory block (in number of bytes)</td></tr>
389 <p>The function invalidates a memory block of size <em>dsize</em> [bytes] starting at address <em>address</em>. The address is aligned to 32-byte boundary. </p>
393 </div><!-- contents -->
394 </div><!-- doc-content -->
395 <!-- start footer part -->
396 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
399 <script type="text/javascript">
401 writeFooter.call(this);