]> begriffs open source - cmsis/blob - main/Core_A/html/group__CMSIS__MPIDR.html
Update documentation for branch main
[cmsis] / main / Core_A / html / group__CMSIS__MPIDR.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): Multiprocessor Affinity Register (MPIDR)</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('group__CMSIS__MPIDR.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 class="header">
127   <div class="summary">
128 <a href="#func-members">Functions</a>  </div>
129   <div class="headertitle"><div class="title">Multiprocessor Affinity Register (MPIDR)<div class="ingroups"><a class="el" href="group__CMSIS__core__register.html">Core Register Access</a></div></div></div>
130 </div><!--header-->
131 <div class="contents">
132
133 <p>In a multiprocessor system, the MPIDR provides an additional processor identification mechanism for scheduling purposes, and indicates whether the implementation includes the Multiprocessing Extensions.  
134 <a href="#details">More...</a></p>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
137 Functions</h2></td></tr>
138 <tr class="memitem:ga05394b4cb9fb0ba1329ec6521c76e571"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__armcc_8h.html#ab904513442afdf77d4f8c74f23cbb040">__STATIC_FORCEINLINE</a> uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__MPIDR.html#ga05394b4cb9fb0ba1329ec6521c76e571">__get_MPIDR</a> (void)</td></tr>
139 <tr class="memdesc:ga05394b4cb9fb0ba1329ec6521c76e571"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get MPIDR.  <br /></td></tr>
140 <tr class="separator:ga05394b4cb9fb0ba1329ec6521c76e571"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 </table>
142 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
143 <table class="markdownTable">
144 <tr class="markdownTableHead">
145 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
146 <tr class="markdownTableRowOdd">
147 <td class="markdownTableBodyLeft">[31]   </td><td class="markdownTableBodyLeft">MPEA   </td><td class="markdownTableBodyLeft">Multiprocessing Extensions Available    </td></tr>
148 <tr class="markdownTableRowEven">
149 <td class="markdownTableBodyLeft">[30]   </td><td class="markdownTableBodyLeft">U   </td><td class="markdownTableBodyLeft">Indicates a Uniprocessor system    </td></tr>
150 <tr class="markdownTableRowOdd">
151 <td class="markdownTableBodyLeft">[29:25]   </td><td class="markdownTableBodyLeft">-   </td><td class="markdownTableBodyLeft">Reserved.    </td></tr>
152 <tr class="markdownTableRowEven">
153 <td class="markdownTableBodyLeft">[24]   </td><td class="markdownTableBodyLeft">MT   </td><td class="markdownTableBodyLeft">Indicates whether the lowest level of affinity consists of logical processors that are implemented using a multi-threading type approach.    </td></tr>
154 <tr class="markdownTableRowOdd">
155 <td class="markdownTableBodyLeft">[23:16]   </td><td class="markdownTableBodyLeft">Aff2   </td><td class="markdownTableBodyLeft">Affinity level 2.    </td></tr>
156 <tr class="markdownTableRowEven">
157 <td class="markdownTableBodyLeft">[15:8]   </td><td class="markdownTableBodyLeft">Aff1   </td><td class="markdownTableBodyLeft">Affinity level 1.    </td></tr>
158 <tr class="markdownTableRowOdd">
159 <td class="markdownTableBodyLeft">[7:0]   </td><td class="markdownTableBodyLeft">Aff0   </td><td class="markdownTableBodyLeft">Affinity level 0.   </td></tr>
160 </table>
161 <p>Consider <a class="el" href="group__CMSIS__MPIDR.html#ga05394b4cb9fb0ba1329ec6521c76e571">__get_MPIDR</a> to access this register. </p>
162 <h2 class="groupheader">Function Documentation</h2>
163 <a id="ga05394b4cb9fb0ba1329ec6521c76e571" name="ga05394b4cb9fb0ba1329ec6521c76e571"></a>
164 <h2 class="memtitle"><span class="permalink"><a href="#ga05394b4cb9fb0ba1329ec6521c76e571">&#9670;&#160;</a></span>__get_MPIDR()</h2>
165
166 <div class="memitem">
167 <div class="memproto">
168       <table class="memname">
169         <tr>
170           <td class="memname"><a class="el" href="group__comp__cntrl__gr.html#gaba87361bfad2ae52cfe2f40c1a1dbf9c">__STATIC_INLINE</a> uint32_t __get_MPIDR </td>
171           <td>(</td>
172           <td class="paramtype">void&#160;</td>
173           <td class="paramname"></td><td>)</td>
174           <td></td>
175         </tr>
176       </table>
177 </div><div class="memdoc">
178 <p>This function returns the value of the Multiprocessor Affinity Register.</p>
179 <dl class="section return"><dt>Returns</dt><dd>Multiprocessor Affinity Register value</dd></dl>
180 <p>This function returns the value of the <a class="el" href="group__CMSIS__MPIDR.html">Multiprocessor Affinity Register (MPIDR)</a>. </p>
181
182 </div>
183 </div>
184 </div><!-- contents -->
185 </div><!-- doc-content -->
186 <!-- start footer part -->
187 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
188   <ul>
189     <li class="footer">
190       <script type="text/javascript">
191         <!--
192         writeFooter.call(this);
193         //-->
194       </script> 
195     </li>
196   </ul>
197 </div>
198 </body>
199 </html>