drm/radeon: Finish replacing task queues by Linux work queues
[dragonfly.git] / usr.sbin / pciconf / pciconf.8
blobca2efd88a4406e56884f89529464ae46db16833c
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: src/usr.sbin/pciconf/pciconf.8,v 1.34 2010/09/09 18:51:20 jhb Exp $
27 .\"
28 .Dd March 15, 2013
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
44 The
45 .Nm
46 utility provides a command line interface to functionality provided by the
47 .Xr pci 4
48 .Xr ioctl 2
49 interface.
50 As such, some of the functions are only available to users with write
51 access to
52 .Pa /dev/pci ,
53 normally only the super-user.
54 .Pp
55 With the
56 .Fl l
57 option, it lists all devices found by the boot probe in the following format:
58 .Bd -literal
59 foo0@pci0:0:4:0: class=0x010000 card=0x00000000 chip=0x000f1000 rev=0x01 \
60 hdr=0x00
61 bar0@pci0:0:5:0: class=0x000100 card=0x00000000 chip=0x88c15333 rev=0x00 \
62 hdr=0x00
63 none0@pci0:0:6:0: class=0x020000 card=0x00000000 chip=0x802910ec rev=0x00 \
64 hdr=0x00
65 .Ed
66 .Pp
67 The first column gives the
68 device name, unit number, and
69 .Ar selector .
70 If there is no device configured in the kernel for the
71 .Tn PCI
72 device in question, the device name will be
73 .Dq none .
74 Unit numbers for unconfigured devices start at zero and are incremented for
75 each unconfigured device that is encountered.
76 The
77 .Ar selector
78 is in a form which may directly be used for the other forms of the command.
79 The second column is the class code, with the class byte printed as two
80 hex digits, followed by the sub-class and the interface bytes.
81 The third column gives the contents of the subvendorid register, introduced
82 in revision 2.1 of the
83 .Tn PCI
84 standard.
85 Note that it will be 0 for older cards.
86 The field consists of the card ID in the upper
87 half and the card vendor ID in the lower half of the value.
88 .Pp
89 The fourth column contains the chip device ID, which identifies the chip
90 this card is based on.
91 It consists of two fields, identifying the chip and
92 its vendor, as above.
93 The fifth column prints the chip's revision.
94 The sixth column describes the header type.
95 Currently assigned header types include 0 for most devices,
96 1 for
97 .Tn PCI
99 .Tn PCI
100 bridges, and 2 for
101 .Tn PCI
103 .Tn CardBus
104 bridges.
105 If the most significant bit
106 of the header type register is set for
107 function 0 of a
108 .Tn PCI
109 device, it is a
110 .Em multi-function
111 device, which contains several (similar or independent) functions on
112 one chip.
114 If the
115 .Fl b
116 option is supplied,
118 will list any base address registers
119 .Pq BARs
120 that are assigned resources for each device.
121 Each 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
126 The first value after the
127 .Dq Li bar
128 prefix in the square brackets is the offset of the BAR in config space in
129 hexadecimal.
130 The type of a BAR is one of
131 .Dq Memory ,
132 .Dq Prefetchable Memory ,
134 .Dq I/O Port .
135 The range indicates the maximum address the BAR decodes.
136 The base and size indicate the start and length of the BAR's address window,
137 respectively.
138 Finally, the last flag indicates if the BAR is enabled or disabled.
140 If the
141 .Fl c
142 option is supplied,
144 will list any capabilities supported by each device.
145 Each capability is enumerated via a line in the following format:
146 .Bd -literal
147     cap 10[40] = PCI-Express 1 root port
150 The first value after the
151 .Dq Li cap
152 prefix is the capability ID in hexadecimal.
153 The second value in the square brackets is the offset of the capability
154 in config space in hexadecimal.
155 The format of the text after the equals sign is capability-specific.
157 Each extended capability is enumerated via a line in a similar format:
158 .Bd -literal
159 ecap 0002[100] = VC 1 max VC0
162 The first value after the
163 .Dq Li ecap
164 prefix is the extended capability ID in hexadecimal.
165 The second value in the square brackets is the offset of the extended
166 capability in config space in hexadecimal.
167 The format of the text after the equals sign is capability-specific.
169 If the
170 .Fl v
171 option is supplied,
173 will attempt to load the vendor/device information database, and print
174 vendor, device, class and subclass identification strings for each device.
176 All invocations of
178 except for
179 .Fl l
180 require a
181 .Ar selector
182 of the form
183 .Li pci Ns Va domain Ns \&: Ns Va bus Ns \&: Ns Va device Ns \&: \
184 Ns Va function Ns ,
185 .Li pci Ns Va bus Ns \&: Ns Va device Ns \&: Ns Va function Ns , or
186 .Li pci Ns Va bus Ns \&: Ns Va device Ns .
187 In case of an abridged form, omitted selector components are assumed to be 0.
188 An optional leading device name followed by @ and an optional final colon
189 will be ignored; this is so that the first column in the output of
191 .Fl l
192 can be used without modification.
193 All numbers are base 10.
195 With the
196 .Fl a
197 flag,
199 determines whether any driver has been assigned to the device
200 identified by
201 .Ar selector .
202 An exit status of zero indicates that the device has a driver;
203 non-zero indicates that it does not.
206 .Fl r
207 option reads a configuration space register at byte offset
208 .Ar addr
209 of device
210 .Ar selector
211 and prints out its value in hexadecimal.
212 The optional second address
213 .Ar addr2
214 specifies a range to read.
216 .Fl w
217 option writes the
218 .Ar value
219 into a configuration space register at byte offset
220 .Ar addr
221 of device
222 .Ar selector .
223 For both operations, the flags
224 .Fl b
226 .Fl h
227 select the width of the operation;
228 .Fl b
229 indicates a byte operation, and
230 .Fl h
231 indicates a halfword (two-byte) operation.
232 The default is to read or
233 write a longword (four bytes).
234 .Sh ENVIRONMENT
235 The PCI vendor/device information database is normally read from
236 .Pa /usr/share/misc/pci_vendors .
237 This path can be overridden by setting the environment variable
238 .Ev PCICONF_VENDOR_DATABASE .
239 .Sh SEE ALSO
240 .Xr ioctl 2 ,
241 .Xr pci 4 ,
242 .Xr devinfo 8 ,
243 .Xr kldload 8
244 .Sh HISTORY
247 utility appeared first in
248 .Fx 2.2 .
250 .Fl a
251 option was added for
252 .Tn PCI
253 KLD support in
254 .Fx 3.0 .
255 .Sh AUTHORS
256 .An -nosplit
259 utility was written by
260 .An Stefan Esser
262 .An Garrett Wollman .
263 .Sh BUGS
265 .Fl b
267 .Fl h
268 options are implemented in
269 .Nm ,
270 but not in the underlying
271 .Xr ioctl 2 .
273 It might be useful to give non-root users access to the
274 .Fl a
276 .Fl r
277 options.
278 But only root will be able to execute a
279 .Nm kldload
280 to provide the device with a driver KLD, and reading of configuration space
281 registers may cause a failure in badly designed
282 .Tn PCI
283 chips.