From: Vitor Massaru Iha <vitor@massaru.org>
To: linux-doc@vger.kernel.org
Cc: corbet@lwn.net, linux-kernel@vger.kernel.org,
brendanhiggins@google.com, skhan@linuxfoundation.org,
linux-kernel-mentees@lists.linuxfoundation.org
Subject: [PATCH 1/2] Documentation: filesystems: Convert sysfs-pci to ReST
Date: Tue, 31 Mar 2020 19:28:56 -0300 [thread overview]
Message-ID: <637c0379a76fcf4eb6cdde0de3cc727203fd942f.1585693146.git.vitor@massaru.org> (raw)
In-Reply-To: <cover.1585693146.git.vitor@massaru.org>
Signed-off-by: Vitor Massaru Iha <vitor@massaru.org>
---
.../{sysfs-pci.txt => sysfs-pci.rst} | 40 ++++++++++---------
1 file changed, 22 insertions(+), 18 deletions(-)
rename Documentation/filesystems/{sysfs-pci.txt => sysfs-pci.rst} (82%)
diff --git a/Documentation/filesystems/sysfs-pci.txt b/Documentation/filesystems/sysfs-pci.rst
similarity index 82%
rename from Documentation/filesystems/sysfs-pci.txt
rename to Documentation/filesystems/sysfs-pci.rst
index 06f1d64c6f70..9b93e7444b15 100644
--- a/Documentation/filesystems/sysfs-pci.txt
+++ b/Documentation/filesystems/sysfs-pci.rst
@@ -1,5 +1,8 @@
+.. 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:
@@ -30,23 +33,24 @@ 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)
- enable Whether the device is enabled (ascii, rw)
- irq IRQ number (ascii, ro)
- 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_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)
+ file function
+ =================== ======================================================
+ class PCI class (ascii, ro)
+ config PCI config space (binary, rw)
+ device PCI device (ascii, ro)
+ enable Whether the device is enabled (ascii, rw)
+ irq IRQ number (ascii, ro)
+ 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_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
--
2.21.1
next prev parent reply other threads:[~2020-03-31 22:29 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-31 22:28 [PATCH 0/2] Documentation: Convert sysfs-pci to ReST Vitor Massaru Iha
2020-03-31 22:28 ` Vitor Massaru Iha [this message]
2020-03-31 22:57 ` [PATCH 1/2] Documentation: filesystems: " Jonathan Corbet
2020-03-31 23:03 ` Vitor Massaru Iha
2020-03-31 23:08 ` Jonathan Corbet
2020-04-01 2:33 ` [Linux-kernel-mentees] " Bjorn Helgaas
2020-04-01 17:22 ` Vitor Massaru Iha
2020-04-01 0:04 ` Matthew Wilcox
2020-04-01 0:08 ` Vitor Massaru Iha
2020-03-31 22:28 ` [PATCH 2/2] Documentation: filesystems: remove whitespaces Vitor Massaru Iha
2020-03-31 22:49 ` [PATCH 0/2] Documentation: Convert sysfs-pci to ReST Jonathan Corbet
2020-04-01 2:00 ` Joe Perches
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=637c0379a76fcf4eb6cdde0de3cc727203fd942f.1585693146.git.vitor@massaru.org \
--to=vitor@massaru.org \
--cc=brendanhiggins@google.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).