Commit 28bcadf0 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: filesystems: convert sysfs-pci.txt to ReST 



- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/2a9d307753c97d1a843341a2ef1993d43a407ded.1588021877.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent e2975d7c

Documentation/filesystems/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -34,6 +34,7 @@ algorithms work. 
   quota

   seq_file

   sharedsubtree

   sysfs-pci



   automount-support

Documentation/filesystems/sysfs-pci.txt→Documentation/filesystems/sysfs-pci.rst

+15 −8
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



============================================

Accessing PCI device resources through sysfs

--------------------------------------------

============================================



sysfs, usually mounted at /sys, provides access to PCI resources on platforms

that support it.  For example, a given bus might look like this:

that support it.  For example, a given bus might look like this::



     /sys/devices/pci0000:17

     |-- 0000:17:00.0
@@ -30,8 +33,9 @@ This bus contains a single function device in slot 0. The domain and bus 
numbers are reproduced for convenience.  Under the device directory are several

files, each with their own function.



       =================== =====================================================

       file		   function

       ----		   --------

       =================== =====================================================

       class		   PCI class (ascii, ro)

       config		   PCI config space (binary, rw)

       device		   PCI device (ascii, ro)
@@ -40,13 +44,16 @@ files, each with their own function. 
       local_cpus	   nearby CPU mask (cpumask, ro)

       remove		   remove device from kernel's list (ascii, wo)

       resource		   PCI resource host addresses (ascii, ro)

       resource0..N	   PCI resource N, if present (binary, mmap, rw[1])

       resource0..N	   PCI resource N, if present (binary, mmap, rw\ [1]_)

       resource0_wc..N_wc  PCI WC map resource N, if prefetchable (binary, mmap)

       revision		   PCI revision (ascii, ro)

       rom		   PCI ROM resource, if present (binary, ro)

       subsystem_device	   PCI subsystem device (ascii, ro)

       subsystem_vendor	   PCI subsystem vendor (ascii, ro)

       vendor		   PCI vendor (ascii, ro)

       =================== =====================================================



::



  ro - read only file

  rw - file is readable and writable
@@ -56,7 +63,7 @@ files, each with their own function. 
  binary - file contains binary data

  cpumask - file contains a cpumask type



[1] rw for RESOURCE_IO (I/O port) regions only

.. [1] rw for RESOURCE_IO (I/O port) regions only



The read only files are informational, writes to them will be ignored, with

the exception of the 'rom' file.  Writable files can be used to perform
@@ -93,7 +100,7 @@ Accessing legacy resources through sysfs 


Legacy I/O port and ISA memory resources are also provided in sysfs if the

underlying platform supports them.  They're located in the PCI class hierarchy,

e.g.

e.g.::



	/sys/class/pci_bus/0000:17/

	|-- bridge -> ../../../devices/pci0000:17

CRA Git | Maintained and supported by SUSTech CRA and CCSE