| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 |
<meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| 6 |
<meta name="generator" content="Doxygen 1.15.0"/> |
| 7 |
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 |
<title>Hardware Locality (hwloc): Components and Plugins: helpers for PCI discovery</title> |
| 9 |
<link href="tabs.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="clipboard.js"></script> |
| 13 |
<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 14 |
</head> |
| 15 |
<body> |
| 16 |
<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 17 |
<div id="titlearea"> |
| 18 |
<table cellspacing="0" cellpadding="0"> |
| 19 |
<tbody> |
| 20 |
<tr id="projectrow"> |
| 21 |
<td id="projectalign"> |
| 22 |
<div id="projectname">Hardware Locality (hwloc)<span id="projectnumber"> 2.14.0</span> |
| 23 |
</div> |
| 24 |
</td> |
| 25 |
</tr> |
| 26 |
</tbody> |
| 27 |
</table> |
| 28 |
</div> |
| 29 |
<!-- end header part --> |
| 30 |
<!-- Generated by Doxygen 1.15.0 --> |
| 31 |
<script type="text/javascript"> |
| 32 |
$(function() { codefold.init(); }); |
| 33 |
</script> |
| 34 |
<script type="text/javascript" src="menudata.js"></script> |
| 35 |
<script type="text/javascript" src="menu.js"></script> |
| 36 |
<script type="text/javascript"> |
| 37 |
$(function() { |
| 38 |
initMenu('',false,false,'search.php','Search',false); |
| 39 |
}); |
| 40 |
</script> |
| 41 |
<div id="main-nav"></div> |
| 42 |
</div><!-- top --> |
| 43 |
<div id="doc-content"> |
| 44 |
<div class="header"> |
| 45 |
<div class="summary"> |
| 46 |
<a href="#func-members">Functions</a> </div> |
| 47 |
<div class="headertitle"><div class="title">Components and Plugins: helpers for PCI discovery </div></div> |
| 48 |
</div><!--header--> |
| 49 |
<div class="contents"> |
| 50 |
<table class="memberdecls"> |
| 51 |
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a> |
| 52 |
Functions</h2></td></tr> |
| 53 |
<tr class="memitem:ga706f71cfea09d547d2cbafa642d6e03b" id="r_ga706f71cfea09d547d2cbafa642d6e03b"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga706f71cfea09d547d2cbafa642d6e03b">hwloc_pcidisc_find_cap</a> (const unsigned char *config, unsigned cap)</td></tr> |
| 54 |
<tr class="memitem:ga51d1ebcbf9729987c9d17df3aa57d209" id="r_ga51d1ebcbf9729987c9d17df3aa57d209"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga51d1ebcbf9729987c9d17df3aa57d209">hwloc_pcidisc_find_linkspeed</a> (const unsigned char *config, unsigned offset, float *linkspeed)</td></tr> |
| 55 |
<tr class="memitem:ga6c55fb80c3d0c8c8e61078b3f38adde8" id="r_ga6c55fb80c3d0c8c8e61078b3f38adde8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6c55fb80c3d0c8c8e61078b3f38adde8">hwloc_pcidisc_check_bridge_type</a> (unsigned device_class, const unsigned char *config)</td></tr> |
| 56 |
<tr class="memitem:ga95acf6822a49447c11067d0b843965ba" id="r_ga95acf6822a49447c11067d0b843965ba"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga95acf6822a49447c11067d0b843965ba">hwloc_pcidisc_find_bridge_buses</a> (unsigned domain, unsigned bus, unsigned dev, unsigned func, unsigned *secondary_busp, unsigned *subordinate_busp, const unsigned char *config)</td></tr> |
| 57 |
<tr class="memitem:gab76ddc4f55db8101ef0d44317965128c" id="r_gab76ddc4f55db8101ef0d44317965128c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab76ddc4f55db8101ef0d44317965128c">hwloc_pcidisc_tree_insert_by_busid</a> (struct <a class="el" href="a00224.html">hwloc_obj</a> **treep, struct <a class="el" href="a00224.html">hwloc_obj</a> *obj)</td></tr> |
| 58 |
<tr class="memitem:gabda1d6c1799e50b9226f8a4da9bd29ea" id="r_gabda1d6c1799e50b9226f8a4da9bd29ea"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabda1d6c1799e50b9226f8a4da9bd29ea">hwloc_pcidisc_tree_attach</a> (struct hwloc_topology *topology, struct <a class="el" href="a00224.html">hwloc_obj</a> *tree)</td></tr> |
| 59 |
</table> |
| 60 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 61 |
<dl class="section note"><dt>Note</dt><dd>These structures and functions may change when <a class="el" href="a00165.html#gaac5bc1f46f55e10ef0141a68ce70e21f" title="Current component and plugin ABI version (see hwloc/plugins.h).">HWLOC_COMPONENT_ABI</a> is modified. </dd></dl> |
| 62 |
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2> |
| 63 |
<a id="ga6c55fb80c3d0c8c8e61078b3f38adde8" name="ga6c55fb80c3d0c8c8e61078b3f38adde8"></a> |
| 64 |
<h2 class="memtitle"><span class="permalink"><a href="#ga6c55fb80c3d0c8c8e61078b3f38adde8">◆ </a></span>hwloc_pcidisc_check_bridge_type()</h2> |
| 65 |
|
| 66 |
<div class="memitem"> |
| 67 |
<div class="memproto"> |
| 68 |
<table class="memname"> |
| 69 |
<tr> |
| 70 |
<td class="memname"><a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> hwloc_pcidisc_check_bridge_type </td> |
| 71 |
<td>(</td> |
| 72 |
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>device_class</em></span>, </td> |
| 73 |
</tr> |
| 74 |
<tr> |
| 75 |
<td class="paramkey"></td> |
| 76 |
<td></td> |
| 77 |
<td class="paramtype">const unsigned char *</td> <td class="paramname"><span class="paramname"><em>config</em></span> )</td> |
| 78 |
</tr> |
| 79 |
</table> |
| 80 |
</div><div class="memdoc"> |
| 81 |
|
| 82 |
<p>Return the hwloc object type (PCI device or Bridge) for the given class and configuration space. </p> |
| 83 |
<p>This function requires 16 bytes of common configuration header at the beginning of config. </p> |
| 84 |
|
| 85 |
</div> |
| 86 |
</div> |
| 87 |
<a id="ga95acf6822a49447c11067d0b843965ba" name="ga95acf6822a49447c11067d0b843965ba"></a> |
| 88 |
<h2 class="memtitle"><span class="permalink"><a href="#ga95acf6822a49447c11067d0b843965ba">◆ </a></span>hwloc_pcidisc_find_bridge_buses()</h2> |
| 89 |
|
| 90 |
<div class="memitem"> |
| 91 |
<div class="memproto"> |
| 92 |
<table class="memname"> |
| 93 |
<tr> |
| 94 |
<td class="memname">int hwloc_pcidisc_find_bridge_buses </td> |
| 95 |
<td>(</td> |
| 96 |
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>domain</em></span>, </td> |
| 97 |
</tr> |
| 98 |
<tr> |
| 99 |
<td class="paramkey"></td> |
| 100 |
<td></td> |
| 101 |
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>bus</em></span>, </td> |
| 102 |
</tr> |
| 103 |
<tr> |
| 104 |
<td class="paramkey"></td> |
| 105 |
<td></td> |
| 106 |
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>dev</em></span>, </td> |
| 107 |
</tr> |
| 108 |
<tr> |
| 109 |
<td class="paramkey"></td> |
| 110 |
<td></td> |
| 111 |
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td> |
| 112 |
</tr> |
| 113 |
<tr> |
| 114 |
<td class="paramkey"></td> |
| 115 |
<td></td> |
| 116 |
<td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>secondary_busp</em></span>, </td> |
| 117 |
</tr> |
| 118 |
<tr> |
| 119 |
<td class="paramkey"></td> |
| 120 |
<td></td> |
| 121 |
<td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>subordinate_busp</em></span>, </td> |
| 122 |
</tr> |
| 123 |
<tr> |
| 124 |
<td class="paramkey"></td> |
| 125 |
<td></td> |
| 126 |
<td class="paramtype">const unsigned char *</td> <td class="paramname"><span class="paramname"><em>config</em></span> )</td> |
| 127 |
</tr> |
| 128 |
</table> |
| 129 |
</div><div class="memdoc"> |
| 130 |
|
| 131 |
<p>Fills the attributes of the given PCI bridge using the given PCI config space. </p> |
| 132 |
<p>This function requires 32 bytes of common configuration header at the beginning of config.</p> |
| 133 |
<p>Returns -1 and destroys /p obj if bridge fields are invalid. </p> |
| 134 |
|
| 135 |
</div> |
| 136 |
</div> |
| 137 |
<a id="ga706f71cfea09d547d2cbafa642d6e03b" name="ga706f71cfea09d547d2cbafa642d6e03b"></a> |
| 138 |
<h2 class="memtitle"><span class="permalink"><a href="#ga706f71cfea09d547d2cbafa642d6e03b">◆ </a></span>hwloc_pcidisc_find_cap()</h2> |
| 139 |
|
| 140 |
<div class="memitem"> |
| 141 |
<div class="memproto"> |
| 142 |
<table class="memname"> |
| 143 |
<tr> |
| 144 |
<td class="memname">unsigned hwloc_pcidisc_find_cap </td> |
| 145 |
<td>(</td> |
| 146 |
<td class="paramtype">const unsigned char *</td> <td class="paramname"><span class="paramname"><em>config</em></span>, </td> |
| 147 |
</tr> |
| 148 |
<tr> |
| 149 |
<td class="paramkey"></td> |
| 150 |
<td></td> |
| 151 |
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>cap</em></span> )</td> |
| 152 |
</tr> |
| 153 |
</table> |
| 154 |
</div><div class="memdoc"> |
| 155 |
|
| 156 |
<p>Return the offset of the given capability in the PCI config space buffer. </p> |
| 157 |
<p>This function requires a 256-bytes config space. Unknown/unavailable bytes should be set to 0xff. </p> |
| 158 |
|
| 159 |
</div> |
| 160 |
</div> |
| 161 |
<a id="ga51d1ebcbf9729987c9d17df3aa57d209" name="ga51d1ebcbf9729987c9d17df3aa57d209"></a> |
| 162 |
<h2 class="memtitle"><span class="permalink"><a href="#ga51d1ebcbf9729987c9d17df3aa57d209">◆ </a></span>hwloc_pcidisc_find_linkspeed()</h2> |
| 163 |
|
| 164 |
<div class="memitem"> |
| 165 |
<div class="memproto"> |
| 166 |
<table class="memname"> |
| 167 |
<tr> |
| 168 |
<td class="memname">int hwloc_pcidisc_find_linkspeed </td> |
| 169 |
<td>(</td> |
| 170 |
<td class="paramtype">const unsigned char *</td> <td class="paramname"><span class="paramname"><em>config</em></span>, </td> |
| 171 |
</tr> |
| 172 |
<tr> |
| 173 |
<td class="paramkey"></td> |
| 174 |
<td></td> |
| 175 |
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>offset</em></span>, </td> |
| 176 |
</tr> |
| 177 |
<tr> |
| 178 |
<td class="paramkey"></td> |
| 179 |
<td></td> |
| 180 |
<td class="paramtype">float *</td> <td class="paramname"><span class="paramname"><em>linkspeed</em></span> )</td> |
| 181 |
</tr> |
| 182 |
</table> |
| 183 |
</div><div class="memdoc"> |
| 184 |
|
| 185 |
<p>Fill linkspeed by reading the PCI config space where PCI_CAP_ID_EXP is at position offset. </p> |
| 186 |
<p>Needs 20 bytes of EXP capability block starting at offset in the config space for registers up to link status. </p> |
| 187 |
|
| 188 |
</div> |
| 189 |
</div> |
| 190 |
<a id="gabda1d6c1799e50b9226f8a4da9bd29ea" name="gabda1d6c1799e50b9226f8a4da9bd29ea"></a> |
| 191 |
<h2 class="memtitle"><span class="permalink"><a href="#gabda1d6c1799e50b9226f8a4da9bd29ea">◆ </a></span>hwloc_pcidisc_tree_attach()</h2> |
| 192 |
|
| 193 |
<div class="memitem"> |
| 194 |
<div class="memproto"> |
| 195 |
<table class="memname"> |
| 196 |
<tr> |
| 197 |
<td class="memname">int hwloc_pcidisc_tree_attach </td> |
| 198 |
<td>(</td> |
| 199 |
<td class="paramtype">struct hwloc_topology *</td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td> |
| 200 |
</tr> |
| 201 |
<tr> |
| 202 |
<td class="paramkey"></td> |
| 203 |
<td></td> |
| 204 |
<td class="paramtype">struct <a class="el" href="a00224.html">hwloc_obj</a> *</td> <td class="paramname"><span class="paramname"><em>tree</em></span> )</td> |
| 205 |
</tr> |
| 206 |
</table> |
| 207 |
</div><div class="memdoc"> |
| 208 |
|
| 209 |
<p>Add some hostbridges on top of the given tree of PCI objects and attach them to the topology. </p> |
| 210 |
<p>Other backends may lookup PCI objects or localities (for instance to attach OS devices) by using <a class="el" href="a00219.html#ga1779bc839369b3edcea1545a04ea123c" title="Find the PCI device or bridge matching a PCI bus ID exactly.">hwloc_pci_find_by_busid()</a> or hwloc_pci_find_busid_parent(). </p> |
| 211 |
|
| 212 |
</div> |
| 213 |
</div> |
| 214 |
<a id="gab76ddc4f55db8101ef0d44317965128c" name="gab76ddc4f55db8101ef0d44317965128c"></a> |
| 215 |
<h2 class="memtitle"><span class="permalink"><a href="#gab76ddc4f55db8101ef0d44317965128c">◆ </a></span>hwloc_pcidisc_tree_insert_by_busid()</h2> |
| 216 |
|
| 217 |
<div class="memitem"> |
| 218 |
<div class="memproto"> |
| 219 |
<table class="memname"> |
| 220 |
<tr> |
| 221 |
<td class="memname">void hwloc_pcidisc_tree_insert_by_busid </td> |
| 222 |
<td>(</td> |
| 223 |
<td class="paramtype">struct <a class="el" href="a00224.html">hwloc_obj</a> **</td> <td class="paramname"><span class="paramname"><em>treep</em></span>, </td> |
| 224 |
</tr> |
| 225 |
<tr> |
| 226 |
<td class="paramkey"></td> |
| 227 |
<td></td> |
| 228 |
<td class="paramtype">struct <a class="el" href="a00224.html">hwloc_obj</a> *</td> <td class="paramname"><span class="paramname"><em>obj</em></span> )</td> |
| 229 |
</tr> |
| 230 |
</table> |
| 231 |
</div><div class="memdoc"> |
| 232 |
|
| 233 |
<p>Insert a PCI object in the given PCI tree by looking at PCI bus IDs. </p> |
| 234 |
<p>If <code class="param">treep</code> points to <code>NULL</code>, the new object is inserted there. </p> |
| 235 |
|
| 236 |
</div> |
| 237 |
</div> |
| 238 |
</div><!-- contents --> |
| 239 |
<!-- start footer part --> |
| 240 |
<hr class="footer"/><address class="footer"><small> |
| 241 |
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 |
| 242 |
</small></address> |
| 243 |
</div><!-- doc-content --> |
| 244 |
</body> |
| 245 |
</html> |