1 What: /sys/bus/pci/drivers/.../bind
2 What: /sys/devices/pciX/.../bind
3 Date: December 2003
4 Contact: linux-pci@vger.kernel.org
5 Description:
6 Writing a device location to t
7 the driver to attempt to bind
8 this location. This is useful
9 bindings. The format for the
10 That is Domain:Bus:Device.Func
11 found in /sys/bus/pci/devices/
12
13 # echo 0000:00:19.0 > /sys/b
14
15 (Note: kernels before 2.6.28 m
16
17 What: /sys/bus/pci/drivers/.../unbin
18 What: /sys/devices/pciX/.../unbind
19 Date: December 2003
20 Contact: linux-pci@vger.kernel.org
21 Description:
22 Writing a device location to t
23 driver to attempt to unbind fr
24 this location. This may be us
25 bindings. The format for the
26 That is Domain:Bus:Device.Func
27 found in /sys/bus/pci/devices/
28
29 # echo 0000:00:19.0 > /sys/b
30
31 (Note: kernels before 2.6.28 m
32
33 What: /sys/bus/pci/drivers/.../new_i
34 What: /sys/devices/pciX/.../new_id
35 Date: December 2003
36 Contact: linux-pci@vger.kernel.org
37 Description:
38 Writing a device ID to this fi
39 dynamically add a new device I
40 This may allow the driver to s
41 was included in the driver's s
42 table at compile time. The fo
43 VVVV DDDD SVVV SDDD CCCC MMMM
44 Device ID, Subsystem Vendor ID
45 Class, Class Mask, and Private
46 and Device ID fields are requi
47 Upon successfully adding an ID
48 for the device and attempt to
49
50 # echo "8086 10f5" > /sys/bu
51
52 What: /sys/bus/pci/drivers/.../remov
53 What: /sys/devices/pciX/.../remove_i
54 Date: February 2009
55 Contact: Chris Wright <chrisw@sous-sol.o
56 Description:
57 Writing a device ID to this fi
58 that was dynamically added via
59 The format for the device ID i
60 VVVV DDDD SVVV SDDD CCCC MMMM.
61 ID, Subsystem Vendor ID, Subsy
62 and Class Mask. The Vendor ID
63 required, the rest are optiona
64 removing an ID, the driver wil
65 device. This is useful to ens
66 match the driver to the device
67
68 # echo "8086 10f5" > /sys/bu
69
70 What: /sys/bus/pci/rescan
71 Date: January 2009
72 Contact: Linux PCI developers <linux-pci
73 Description:
74 Writing a non-zero value to th
75 force a rescan of all PCI buse
76 re-discover previously removed
77
78 What: /sys/bus/pci/devices/.../msi_b
79 Date: September 2014
80 Contact: Linux PCI developers <linux-pci
81 Description:
82 Writing a zero value to this a
83 MSI-X for any future drivers o
84 is a bridge, MSI and MSI-X wil
85 drivers of all child devices u
86 must be reloaded for the new s
87
88 What: /sys/bus/pci/devices/.../msi_i
89 Date: September, 2011
90 Contact: Neil Horman <nhorman@tuxdriver.
91 Description:
92 The /sys/devices/.../msi_irqs
93 of files, with each file being
94 irq vector allocated to that d
95
96 What: /sys/bus/pci/devices/.../msi_i
97 Date: September 2011
98 Contact: Neil Horman <nhorman@tuxdriver.
99 Description:
100 This attribute indicates the m
101 the file is in (msi vs. msix)
102
103 What: /sys/bus/pci/devices/.../irq
104 Date: August 2021
105 Contact: Linux PCI developers <linux-pci
106 Description:
107 If a driver has enabled MSI (n
108 IRQ of the first MSI vector. O
109 IRQ of the legacy INTx interru
110
111 "irq" being set to 0 indicates
112 capable of generating legacy I
113
114 What: /sys/bus/pci/devices/.../remov
115 Date: January 2009
116 Contact: Linux PCI developers <linux-pci
117 Description:
118 Writing a non-zero value to th
119 hot-remove the PCI device and
120
121 What: /sys/bus/pci/devices/.../pci_b
122 Date: May 2011
123 Contact: Linux PCI developers <linux-pci
124 Description:
125 Writing a non-zero value to th
126 force a rescan of the bus and
127 and re-discover devices remove
128 part of the device tree.
129
130 What: /sys/bus/pci/devices/.../resca
131 Date: January 2009
132 Contact: Linux PCI developers <linux-pci
133 Description:
134 Writing a non-zero value to th
135 force a rescan of the device's
136 child buses, and re-discover d
137 from this part of the device t
138
139 What: /sys/bus/pci/devices/.../reset
140 Date: August 2021
141 Contact: Amey Narkhede <ameynarkhede03@g
142 Description:
143 Some devices allow an individu
144 without affecting other functi
145
146 For devices that have this sup
147 reset_method is present in sys
148 gives names of the supported a
149 their ordering. Writing a spa
150 reset methods sets the reset m
151 used when resetting the device
152 disables the ability to reset
153 "default" enables all supporte
154 default ordering.
155
156 What: /sys/bus/pci/devices/.../reset
157 Date: July 2009
158 Contact: Michael S. Tsirkin <mst@redhat.
159 Description:
160 Some devices allow an individu
161 without affecting other functi
162 For devices that have this sup
163 will be present in sysfs. Wri
164 will perform reset.
165
166 What: /sys/bus/pci/devices/.../vpd
167 Date: February 2008
168 Contact: Ben Hutchings <bwh@kernel.org>
169 Description:
170 A file named vpd in a device d
171 binary file containing the Vit
172 device. It should follow the
173 PCI Specification 2.1 or 2.2,
174 that some devices may have inc
175 If the underlying VPD has a wr
176 corresponding section of this
177
178 What: /sys/bus/pci/devices/.../virtf
179 Date: March 2009
180 Contact: Yu Zhao <yu.zhao@intel.com>
181 Description:
182 This symbolic link appears whe
183 capability and the Physical Fu
184 The symbolic link points to th
185 Virtual Function whose index i
186
187 What: /sys/bus/pci/devices/.../dep_l
188 Date: March 2009
189 Contact: Yu Zhao <yu.zhao@intel.com>
190 Description:
191 This symbolic link appears whe
192 capability and the Physical Fu
193 and this device has vendor spe
194 The symbolic link points to th
195 Physical Function this device
196
197 What: /sys/bus/pci/devices/.../physf
198 Date: March 2009
199 Contact: Yu Zhao <yu.zhao@intel.com>
200 Description:
201 This symbolic link appears whe
202 The symbolic link points to th
203 Physical Function this device
204
205 What: /sys/bus/pci/devices/.../modal
206 Date: May 2005
207 Contact: Greg Kroah-Hartman <gregkh@linu
208 Description:
209 This attribute indicates the P
210
211 That is in the format:
212 pci:vXXXXXXXXdXXXXXXXXsvXXXXXX
213 where:
214
215 - vXXXXXXXX contains the v
216 - dXXXXXXXX contains the d
217 - svXXXXXXXX contains the
218 - sdXXXXXXXX contains the
219 - bcXX contains the device
220 - scXX contains the device
221 - iXX contains the device
222
223 What: /sys/bus/pci/slots/.../module
224 Date: June 2009
225 Contact: linux-pci@vger.kernel.org
226 Description:
227 This symbolic link points to t
228 module that manages the hotplu
229
230 What: /sys/bus/pci/devices/.../label
231 Date: July 2010
232 Contact: Narendra K <narendra_k@dell.com
233 Description:
234 Reading this attribute will pr
235 given name (SMBIOS type 41 str
236 the PCI device. The attribute
237 if the firmware has given a na
238 ACPI _DSM string name will be
239 system firmware provides SMBIO
240 Users:
241 Userspace applications interes
242 firmware assigned name of the
243
244 What: /sys/bus/pci/devices/.../index
245 Date: July 2010
246 Contact: Narendra K <narendra_k@dell.com
247 Description:
248 Reading this attribute will pr
249 number of the PCI device. Dep
250 be for example the SMBIOS type
251 user-defined ID (UID) on s390.
252 only if the firmware has given
253 device and that number is guar
254 device in the system.
255 Users:
256 Userspace applications interes
257 firmware assigned device type
258 device that can help in unders
259 intended order of the PCI devi
260
261 What: /sys/bus/pci/devices/.../acpi_
262 Date: July 2010
263 Contact: Narendra K <narendra_k@dell.com
264 Description:
265 Reading this attribute will pr
266 given instance (ACPI _DSM inst
267 The attribute will be created
268 an instance number to the PCI
269 will be given priority if the
270 type 41 device type instance a
271 Users:
272 Userspace applications interes
273 firmware assigned instance num
274 device that can help in unders
275 intended order of the PCI devi
276
277 What: /sys/bus/pci/devices/.../d3col
278 Date: July 2012
279 Contact: Huang Ying <ying.huang@intel.co
280 Description:
281 d3cold_allowed is bit to contr
282 device can be put into D3Cold
283 device will never be put into
284 device may be put into D3Cold
285 satisfied too. Reading this a
286 value of d3cold_allowed bit.
287 the value of d3cold_allowed bi
288
289 What: /sys/bus/pci/devices/.../sriov
290 Date: November 2012
291 Contact: Donald Dutile <ddutile@redhat.c
292 Description:
293 This file appears when a physi
294 Userspace applications can rea
295 maximum number of Virtual Func
296 function (PF) can support. Typ
297 in the PF's SR-IOV extended ca
298 element. Drivers have the abi
299 value read from this file via
300 function.
301
302 What: /sys/bus/pci/devices/.../sriov
303 Date: November 2012
304 Contact: Donald Dutile <ddutile@redhat.c
305 Description:
306 This file appears when a physi
307 Userspace applications can rea
308 determine and control the enab
309 Functions (VFs) on the physica
310 file will return the number of
311 A number written to this file
312 number of VFs. A userspace app
313 file and check that the value
314 of VFs that should be enabled
315 should be less than or equal t
316 file. A userspace application
317 write a zero to this file. The
318 are written to this file, and
319 valid. For example, writing a
320 is not 0 and not 2 already wil
321 when the value of sriov_totalv
322
323 What: /sys/bus/pci/devices/.../drive
324 Date: April 2014
325 Contact: Alex Williamson <alex.williamso
326 Description:
327 This file allows the driver fo
328 will override standard static
329 specified, only a driver with
330 to driver_override will have a
331 device. The override is speci
332 driver_override file (echo pci
333 may be cleared with an empty s
334 This returns the device to sta
335 Writing to driver_override doe
336 device from its current driver
337 automatically load the specifi
338 matching name is currently loa
339 will not bind to any driver.
340 opt-out of driver binding usin
341 "none". Only a single driver
342 there is no support for parsin
343
344 What: /sys/bus/pci/devices/.../numa_
345 Date: Oct 2014
346 Contact: Prarit Bhargava <prarit@redhat.
347 Description:
348 This file contains the NUMA no
349 attached, or -1 if the node is
350 comes from an ACPI _PXM method
351 source. If that is missing or
352 written to override the node.
353 a firmware bug to the system v
354 taints the kernel with TAINT_F
355 reduces the supportability of
356
357 What: /sys/bus/pci/devices/.../revis
358 Date: November 2016
359 Contact: Emil Velikov <emil.l.velikov@gm
360 Description:
361 This file contains the revisio
362 The value comes from device co
363
364 What: /sys/bus/pci/devices/.../sriov
365 Date: April 2017
366 Contact: Bodong Wang<bodong@mellanox.com
367 Description:
368 This file is associated with t
369 supports SR-IOV. It determine
370 are immediately bound to a dri
371 1, which means the kernel auto
372 compatible driver immediately
373 an application writes 0 to the
374 the kernel will not bind VFs t
375
376 A typical use case is to write
377 VFs, then assign the newly-cre
378 Note that changing this file d
379 enabled VFs. In this scenario
380 the VFs, write 0 to sriov_driv
381 the VFs.
382
383 This is similar to /sys/bus/pc
384 affects only the VFs associate
385
386 What: /sys/bus/pci/devices/.../p2pme
387 Date: November 2017
388 Contact: Logan Gunthorpe <logang@deltate
389 Description:
390 If the device has any Peer-to-
391 file contains the total amount
392 provides (in decimal).
393
394 What: /sys/bus/pci/devices/.../p2pme
395 Date: November 2017
396 Contact: Logan Gunthorpe <logang@deltate
397 Description:
398 If the device has any Peer-to-
399 file contains the amount of me
400 allocated (in decimal).
401
402 What: /sys/bus/pci/devices/.../p2pme
403 Date: November 2017
404 Contact: Logan Gunthorpe <logang@deltate
405 Description:
406 If the device has any Peer-to-
407 file contains a '1' if the mem
408 use outside the driver that ow
409
410 What: /sys/bus/pci/devices/.../p2pme
411 Date: August 2022
412 Contact: Logan Gunthorpe <logang@deltate
413 Description:
414 This file allows mapping p2pme
415 mmap() call on this file, the
416 of Peer-to-Peer memory for use
417 This memory can be used in O_D
418 files for Peer-to-Peer copies.
419
420 What: /sys/bus/pci/devices/.../link/
421 /sys/bus/pci/devices/.../link/
422 /sys/bus/pci/devices/.../link/
423 /sys/bus/pci/devices/.../link/
424 /sys/bus/pci/devices/.../link/
425 /sys/bus/pci/devices/.../link/
426 /sys/bus/pci/devices/.../link/
427 Date: October 2019
428 Contact: Heiner Kallweit <hkallweit1@gma
429 Description: If ASPM is supported for an en
430 used to disable or enable the
431 states. Write y/1/on to enable
432
433 What: /sys/bus/pci/devices/.../power
434 Date: November 2020
435 Contact: Linux PCI developers <linux-pci
436 Description:
437 This file contains the current
438 The value comes from the PCI k
439 of: "unknown", "error", "D0",
440 The file is read only.
441
442 What: /sys/bus/pci/devices/.../sriov
443 Date: January 2021
444 Contact: Leon Romanovsky <leonro@nvidia.
445 Description:
446 This file is associated with a
447 It contains the total number o
448 assignment to all virtual func
449 The value will be zero if the
450 functionality. For supported d
451 constant and won't be changed
452
453 What: /sys/bus/pci/devices/.../sriov
454 Date: January 2021
455 Contact: Leon Romanovsky <leonro@nvidia.
456 Description:
457 This file is associated with a
458 It allows configuration of the
459 the VF. This allows devices th
460 vectors to optimally divide th
461
462 The values accepted are:
463 * > 0 - this number will be r
464 VF's MSI-X capability
465 * < 0 - not valid
466 * = 0 - will reset to the dev
467
468 The file is writable if the PF
469 implements ->sriov_set_msix_ve
470
471 What: /sys/bus/pci/devices/.../resou
472 Date: September 2022
473 Contact: Alex Williamson <alex.williamso
474 Description:
475 These files provide an interfa
476 A file is created for each BAR
477 PCIe Resizable BAR extended ca
478 each file exposes the bitmap o
479
480 # cat resource1_resize
481 00000000000001c0
482
483 The bitmap represents supporte
484 where bit0 = 1MB, bit1 = 2MB,
485 example the device supports 64
486
487 When writing the file, the use
488 the desired resource size, for
489
490 # echo 7 > resource1_resize
491
492 This indicates to set the size
493 128MB. The resulting size is
494 matches the PCIe specification
495
496 In order to make use of resour
497 be unbound from the device and
498 parent bridge may need to be s
499 VGA devices, writing a resize
500 console drivers from the devic
501 resourceN attributes must be t
502 Success of the resizing operat
503
504 What: /sys/bus/pci/devices/.../leds/
505 What: /sys/class/leds/*:enclosure:*/
506 Date: August 2024
507 KernelVersion: 6.12
508 Description:
509 LED indications on PCIe storag
510 through the NPEM interface (Na
511 PCIe r6.1 sec 6.28) are access
512 below /sys/class/leds and belo
513
514 Although these led class devic
515 in practice they are typically
516 application such as ledmon(8).
517
518 The name of a led class device
519 <bdf>:enclosure:<indication>
520 where:
521
522 - <bdf> is the domain, bus, de
523 (e.g. 10000:02:05.0)
524 - <indication> is a short desc
525
526 Valid indications per PCIe r6.
527
528 - ok (drive is functioning nor
529 - locate (drive is being ident
530 - fail (drive is not functioni
531 - rebuild (drive is part of an
532 - pfa (drive is predicted to f
533 - hotspare (drive is marked to
534 - ica (drive is part of an arr
535 - ifa (drive is part of an arr
536 - idt (drive is not the right
537 - disabled (drive is disabled,
538 - specific0 to specific7 (encl
539
540 Broadly, the indications fall
541
542 - to signify drive state (ok,
543 - to signify drive role or sta
544 (rebuild, pfa, hotspare, ica
545 - to signify any other role or
546
547 Mandatory indications per PCIe
548 ok, locate, fail, rebuild. All
549 A led class device is only vis
550 indication is supported by the
551
552 To manipulate the indications,
553 to the "brightness" file. Note
554 may implicitly manipulate othe
555 discretion. E.g. when the user
556 the vendor may choose to autom
557 indication. The current state
558 retrieved by reading its "brig
559
560 The PCIe Base Specification al
561 different colors or blinking p
562 but they typically follow the
563 indication is usually presente
564 4 Hz frequency:
565 https://en.wikipedia.org/wiki/
566
567 PCI Firmware Specification r3.
568 to facilitate shared access by
569 firmware to a device's NPEM re
570 this DSM interface where avail
571 registers directly. The DSM in
572 enclosure-specific indications
573 hence the corresponding led cl
574 the DSM interface is used.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.