Debian Codegraph @

doc/doxygen-doc/man/man3/hwlocality_components_pcifind.3

raw
1 .TH "hwlocality_components_pcifind" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_components_pcifind \- Components and Plugins: finding PCI objects during other discoveries
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Functions"
10
11 .in +1c
12 .ti -1c
13 .RI "struct \fBhwloc_obj\fP * \fBhwloc_pci_find_parent_by_busid\fP (struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)"
14 .br
15 .ti -1c
16 .RI "struct \fBhwloc_obj\fP * \fBhwloc_pci_find_by_busid\fP (struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)"
17 .br
18 .in -1c
19 .SH "Detailed Description"
20 .PP
21
22 .PP
23 \fBNote\fP
24 .RS 4
25 These structures and functions may change when \fBHWLOC_COMPONENT_ABI\fP is modified\&.
26 .RE
27 .PP
28
29 .SH "Function Documentation"
30 .PP
31 .SS "struct \fBhwloc_obj\fP * hwloc_pci_find_by_busid (struct hwloc_topology * topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)"
32
33 .PP
34 Find the PCI device or bridge matching a PCI bus ID exactly\&. This is useful for adding specific information about some objects based on their PCI id\&. When it comes to attaching objects based on PCI locality, \fBhwloc_pci_find_parent_by_busid()\fP should be preferred\&.
35 .SS "struct \fBhwloc_obj\fP * hwloc_pci_find_parent_by_busid (struct hwloc_topology * topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)"
36
37 .PP
38 Find the object or a parent of a PCI bus ID\&. When attaching a new object (typically an OS device) whose locality is specified by PCI bus ID, this function returns the PCI object to use as a parent for attaching\&.
39
40 .PP
41 If the exact PCI device with this bus ID exists, it is returned\&. Otherwise (for instance if it was filtered out), the function returns another object with similar locality (for instance a parent bridge, or the local CPU Package)\&.
42 .SH "Author"
43 .PP
44 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.