pcilib.man

   1 .TH pcilib 7 "@TODAY@" "@VERSION@" "The PCI Utilities"
   2 .SH NAME
   3 pcilib \- a library for accessing PCI devices
   4
   5 .SH DESCRIPTION
   6
   7 The PCI library (also known as \fIpcilib\fP and \fIlibpci\fP) is a portable library
   8 for accessing PCI devices and their configuration space.
   9
  10 .SH ACCESS METHODS
  11
  12 .PP
  13 The library supports a variety of methods to access the configuration space
  14 on different operating systems. By default, the first matching method in this
  15 list is used, but you can specify override the decision (see the \fB-A\fP switch
  16 of \fIlspci\fP).
  17
  18 .TP
  19 .B linux-sysfs
  20 The
  21 .B /sys
  22 filesystem on Linux 2.6 and newer. The standard header of the config space is available
  23 to all users, the rest only to root. Supports extended configuration space, PCI domains,
  24 VPD (from Linux 2.6.26), physical slots (also since Linux 2.6.26) and information on attached
  25 kernel drivers.
  26 .TP
  27 .B linux-proc
  28 The
  29 .B /proc/bus/pci
  30 interface supported by Linux 2.1 and newer. The standard header of the config space is available
  31 to all users, the rest only to root.
  32 .TP
  33 .B intel-conf1
  34 Direct hardware access via Intel configuration mechanism 1. Available on i386 and compatibles
  35 on Linux, Solaris/x86, GNU Hurd, Windows, BeOS and Haiku. Requires root privileges.
  36 .TP
  37 .B intel-conf2
  38 Direct hardware access via Intel configuration mechanism 2. Available on i386 and compatibles
  39 on Linux, Solaris/x86, GNU Hurd, Windows, BeOS and Haiku. Requires root privileges. Warning: This method
  40 is able to address only the first 16 devices on any bus and it seems to be very
  41 unreliable in many cases.
  42 .TP
  43 .B mmio-conf1
  44 Direct hardware access via Intel configuration mechanism 1 via memory-mapped I/O.
  45 Mostly used on non-i386 platforms. Requires root privileges. Warning: This method
  46 needs to be properly configured via the
  47 .B mmio-conf1.addrs
  48 parameter.
  49 .TP
  50 .B mmio-conf1-ext
  51 Direct hardware access via Extended PCIe Intel configuration mechanism 1 via memory-mapped I/O.
  52 Mostly used on non-i386 platforms. Requires root privileges. Warning: This method
  53 needs to be properly configured via the
  54 .B mmio-conf1-ext.addrs
  55 parameter.
  56 .TP
  57 .B fbsd-device
  58 The
  59 .B /dev/pci
  60 device on FreeBSD. Requires root privileges.
  61 .TP
  62 .B aix-device
  63 Access method used on AIX. Requires root privileges.
  64 .TP
  65 .B nbsd-libpci
  66 The
  67 .B /dev/pci0
  68 device on NetBSD accessed using the local libpci library.
  69 .TP
  70 .B obsd-device
  71 The
  72 .B /dev/pci
  73 device on OpenBSD. Requires root privileges.
  74 .TP
  75 .B dump
  76 Read the contents of configuration registers from a file specified in the
  77 .B dump.name
  78 parameter. The format corresponds to the output of \fIlspci\fP \fB-x\fP.
  79 .TP
  80 .B darwin
  81 Access method used on Mac OS X / Darwin. Must be run as root and the system
  82 must have been booted with debug=0x144.
  83 .TP
  84 .B win32-cfgmgr32
  85 Device listing on Windows systems using the Windows Configuration Manager
  86 via cfgmgr32.dll system library. This method does not require any special
  87 Administrator rights or privileges. Configuration Manager provides only basic
  88 information about devices, assigned resources and device tree structure. There
  89 is no access to the PCI configuration space but libpci either tries to use
  90 other access method to access configuration space or it provides read-only
  91 virtual emulation based on information from Configuration Manager. Other
  92 access method can be chosen by the
  93 .B win32.cfgmethod
  94 parameter. By default the first working one is selected (if any). Starting
  95 with Windows 8 (NT 6.2) it is not possible to retrieve resources from 32-bit
  96 application or library on 64-bit system.
  97 .TP
  98 .B win32-sysdbg
  99 Access to the PCI configuration space via NT SysDbg interface on Windows
 100 systems. Process needs to have Debug privilege, which local Administrators
 101 have by default. Not available on 64-bit systems and neither on recent 32-bit
 102 systems. Only devices from the first domain are accessible and only first
 103 256 bytes of the PCI configuration space is accessible via this method.
 104 .TP
 105 .B win32-kldbg
 106 Access to the PCI configuration space via Kernel Local Debugging Driver
 107 kldbgdrv.sys. This driver is not part of the Windows system but is part of
 108 the Microsoft WinDbg tool. It is required to have kldbgdrv.sys driver installed
 109 in the system32 directory or to have windbg.exe or kd.exe binary in PATH.
 110 kldbgdrv.sys driver has some restrictions. Process needs to have Debug privilege
 111 and Windows system has to be booted with Debugging option. Debugging option can
 112 be enabled by calling (takes effect after next boot):
 113 .B bcdedit /debug on
 114 .IP
 115 Download links for WinDbg 6.12.2.633 standalone installer from Microsoft Windows
 116 SDK for Windows 7 and .NET Framework 4:
 117 .br
 118 amd64: https://download.microsoft.com/download/A/6/A/A6AC035D-DA3F-4F0C-ADA4-37C8E5D34E3D/setup/WinSDKDebuggingTools_amd64/dbg_amd64.msi
 119 .br
 120 ia64: https://download.microsoft.com/download/A/6/A/A6AC035D-DA3F-4F0C-ADA4-37C8E5D34E3D/setup/WinSDKDebuggingTools_ia64/dbg_ia64.msi
 121 .br
 122 x86: https://download.microsoft.com/download/A/6/A/A6AC035D-DA3F-4F0C-ADA4-37C8E5D34E3D/setup/WinSDKDebuggingTools/dbg_x86.msi
 123 .IP
 124 Archived download links of previous WinDbg versions:
 125 .br
 126 https://web.archive.org/web/20110221133326/https://www.microsoft.com/whdc/devtools/debugging/installx86.mspx
 127 .br
 128 https://web.archive.org/web/20110214012715/https://www.microsoft.com/whdc/devtools/debugging/install64bit.mspx
 129
 130 .SH PARAMETERS
 131
 132 .PP
 133 The library is controlled by several parameters. They should have sensible default
 134 values, but in case you want to do something unusual (or even something weird),
 135 you can override them (see the \fB-O\fP switch of \fIlspci\fP).
 136
 137 .SS Parameters of specific access methods
 138
 139 .TP
 140 .B dump.name
 141 Name of the bus dump file to read from.
 142 .TP
 143 .B fbsd.path
 144 Path to the FreeBSD PCI device.
 145 .TP
 146 .B nbsd.path
 147 Path to the NetBSD PCI device.
 148 .TP
 149 .B obsd.path
 150 Path to the OpenBSD PCI device.
 151 .TP
 152 .B proc.path
 153 Path to the procfs bus tree.
 154 .TP
 155 .B sysfs.path
 156 Path to the sysfs device tree.
 157 .TP
 158 .B devmem.path
 159 Path to the /dev/mem device.
 160 .TP
 161 .B mmio-conf1.addrs
 162 Physical addresses of memory-mapped I/O ports for Intel configuration mechanism 1.
 163 CF8 (address) and CFC (data) I/O port addresses are separated by slash and
 164 multiple addresses for different PCI domains are separated by commas.
 165 Format: 0xaddr1/0xdata1,0xaddr2/0xdata2,...
 166 .TP
 167 .B mmio-conf1-ext.addrs
 168 Physical addresses of memory-mapped I/O ports for Extended PCIe Intel configuration mechanism 1.
 169 It has same format as
 170 .B mmio-conf1.addrs
 171 parameter.
 172 .TP
 173 .B win32.cfgmethod
 174 Config space access method to use with win32-cfgmgr32 on Windows systems. Value
 175 .I auto
 176 or an empty string selects the first access method which supports access
 177 to the config space on Windows. Value
 178 .I win32-cfgmgr32
 179 only builds a read-only virtual emulated config space with information from the
 180 Configuration Manager.
 181
 182 .SS Parameters for resolving of ID's via DNS
 183 .TP
 184 .B net.domain
 185 DNS domain containing the ID database.
 186 .TP
 187 .B net.cache_name
 188 Name of the file used for caching of resolved ID's.
 189
 190 .SS Parameters for resolving of ID's via UDEV's HWDB
 191 .TP
 192 .B hwdb.disable
 193 Disable use of HWDB if set to a non-zero value.
 194
 195 .SH SEE ALSO
 196
 197 .BR lspci (8),
 198 .BR setpci (8),
 199 .BR pci.ids (5),
 200 .BR update-pciids (8)
 201
 202 .SH AUTHOR
 203 The PCI Utilities are maintained by Martin Mares <mj@ucw.cz>.