1.\" Copyright (c) 1997 2.\" Stefan Esser <se@FreeBSD.org>. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd November 7, 2007 29.Dt PCICONF 8 30.Os 31.Sh NAME 32.Nm pciconf 33.Nd diagnostic utility for the PCI bus 34.Sh SYNOPSIS 35.Nm 36.Fl l Op Fl bcv 37.Nm 38.Fl a Ar selector 39.Nm 40.Fl r Oo Fl b | h Oc Ar selector addr Ns Op : Ns Ar addr2 41.Nm 42.Fl w Oo Fl b | h Oc Ar selector addr value 43.Sh DESCRIPTION 44The 45.Nm 46utility provides a command line interface to functionality provided by the 47.Xr pci 4 48.Xr ioctl 2 49interface. 50As such, some of the functions are only available to users with write 51access to 52.Pa /dev/pci , 53normally only the super-user. 54.Pp 55With the 56.Fl l 57option, it lists all devices found by the boot probe in the following format: 58.Bd -literal 59foo0@pci0:0:4:0: class=0x010000 card=0x00000000 chip=0x000f1000 rev=0x01 \ 60hdr=0x00 61bar0@pci0:0:5:0: class=0x000100 card=0x00000000 chip=0x88c15333 rev=0x00 \ 62hdr=0x00 63none0@pci0:0:6:0: class=0x020000 card=0x00000000 chip=0x802910ec rev=0x00 \ 64hdr=0x00 65.Ed 66.Pp 67The first column gives the 68device name, unit number, and 69.Ar selector . 70If there is no device configured in the kernel for the 71.Tn PCI 72device in question, the device name will be 73.Dq none . 74Unit numbers for unconfigured devices start at zero and are incremented for 75each unconfigured device that is encountered. 76The 77.Ar selector 78is in a form which may directly be used for the other forms of the command. 79The second column is the class code, with the class byte printed as two 80hex digits, followed by the sub-class and the interface bytes. 81The third column gives the contents of the subvendorid register, introduced 82in revision 2.1 of the 83.Tn PCI 84standard. 85Note that it will be 0 for older cards. 86The field consists of the card ID in the upper 87half and the card vendor ID in the lower half of the value. 88.Pp 89The fourth column contains the chip device ID, which identifies the chip 90this card is based on. 91It consists of two fields, identifying the chip and 92its vendor, as above. 93The fifth column prints the chip's revision. 94The sixth column describes the header type. 95Currently assigned header types include 0 for most devices, 961 for 97.Tn PCI 98to 99.Tn PCI 100bridges, and 2 for 101.Tn PCI 102to 103.Tn CardBus 104bridges. 105If the most significant bit 106of the header type register is set for 107function 0 of a 108.Tn PCI 109device, it is a 110.Em multi-function 111device, which contains several (similar or independent) functions on 112one chip. 113.Pp 114If the 115.Fl b 116option is supplied, 117.Nm 118will list any base address registers 119.Pq BARs 120that are assigned resources for each device. 121Each BAR will be enumerated via a line in the following format: 122.Bd -literal 123 bar [10] = type Memory, range 32, base 0xda060000, size 131072, enabled 124.Ed 125.Pp 126The first value after the 127.Dq Li bar 128prefix in the square brackets is the offset of the BAR in config space in 129hexadecimal. 130The type of a BAR is one of 131.Dq Memory , 132.Dq Prefetchable Memory , 133or 134.Dq I/O Port . 135The range indicates the maximum address the BAR decodes. 136The base and size indicate the start and length of the BAR's address window, 137respectively. 138Finally, the last flag indicates if the BAR is enabled or disabled. 139.Pp 140If the 141.Fl c 142option is supplied, 143.Nm 144will list any capabilities supported by each device. 145Each capability will be enumerated via a line in the following format: 146.Bd -literal 147 cap 10[40] = PCI-Express 1 root port 148.Ed 149.Pp 150The first value after the 151.Dq Li cap 152prefix is the capability ID in hexadecimal. 153The second value in the square brackets is the offset of the capability 154in config space in hexadecimal. 155The format of the text after the equals sign is capability-specific. 156.Pp 157If the 158.Fl v 159option is supplied, 160.Nm 161will attempt to load the vendor/device information database, and print 162vendor, device, class and subclass identification strings for each device. 163.Pp 164All invocations of 165.Nm 166except for 167.Fl l 168require a 169.Ar selector 170of the form 171.Li pci Ns Va domain Ns \&: Ns Va bus Ns \&: Ns Va device Ns \&: \ 172Ns Va function Ns , 173.Li pci Ns Va bus Ns \&: Ns Va device Ns \&: Ns Va function Ns , or 174.Li pci Ns Va bus Ns \&: Ns Va device Ns . 175In case of an abrigded form, omitted selector components are assumed to be 0. 176An optional leading device name followed by @ and an optional final colon 177will be ignored; this is so that the first column in the output of 178.Nm 179.Fl l 180can be used without modification. 181All numbers are base 10. 182.Pp 183With the 184.Fl a 185flag, 186.Nm 187determines whether any driver has been assigned to the device 188identified by 189.Ar selector . 190An exit status of zero indicates that the device has a driver; 191non-zero indicates that it does not. 192.Pp 193The 194.Fl r 195option reads a configuration space register at byte offset 196.Ar addr 197of device 198.Ar selector 199and prints out its value in hexadecimal. 200The optional second address 201.Ar addr2 202specifies a range to read. 203The 204.Fl w 205option writes the 206.Ar value 207into a configuration space register at byte offset 208.Ar addr 209of device 210.Ar selector . 211For both operations, the flags 212.Fl b 213and 214.Fl h 215select the width of the operation; 216.Fl b 217indicates a byte operation, and 218.Fl h 219indicates a halfword (two-byte) operation. 220The default is to read or 221write a longword (four bytes). 222.Sh ENVIRONMENT 223The PCI vendor/device information database is normally read from 224.Pa /usr/share/misc/pci_vendors . 225This path can be overridden by setting the environment variable 226.Ev PCICONF_VENDOR_DATABASE . 227.Sh SEE ALSO 228.Xr ioctl 2 , 229.\" .Xr pci 4 , 230.Xr devinfo 8 , 231.Xr kldload 8 232.Sh HISTORY 233The 234.Nm 235utility appeared first in 236.Fx 2.2 . 237The 238.Fl a 239option was added for 240.Tn PCI 241KLD support in 242.Fx 3.0 . 243.Sh AUTHORS 244.An -nosplit 245The 246.Nm 247utility was written by 248.An Stefan Esser 249and 250.An Garrett Wollman . 251.Sh BUGS 252The 253.Fl b 254and 255.Fl h 256options are implemented in 257.Nm , 258but not in the underlying 259.Xr ioctl 2 . 260.Pp 261It might be useful to give non-root users access to the 262.Fl a 263and 264.Fl r 265options. 266But only root will be able to execute a 267.Nm kldload 268to provide the device with a driver KLD, and reading of configuration space 269registers may cause a failure in badly designed 270.Tn PCI 271chips. 272