From: Dave Jiang <dave.jiang@intel.com>
To: linux-cxl@vger.kernel.org
Cc: dan.j.williams@intel.com, ira.weiny@intel.com,
vishal.l.verma@intel.com, alison.schofield@intel.com,
Jonathan.Cameron@huawei.com, dave@stgolabs.net, jgg@nvidia.com,
shiju.jose@huawei.com
Subject: [RFC PATCH v2 19/20] fwctl: Move fwctl documentation to its own directory
Date: Fri, 15 Nov 2024 14:25:52 -0700 [thread overview]
Message-ID: <20241115212745.869552-20-dave.jiang@intel.com> (raw)
In-Reply-To: <20241115212745.869552-1-dave.jiang@intel.com>
Move fwctl.rst to its own directory in prepraration for adding more
documentation.
Signed-off-by: Dave Jiang <dave.jiang@intel.com>
---
Documentation/userspace-api/{ => fwctl}/fwctl.rst | 0
Documentation/userspace-api/fwctl/index.rst | 12 ++++++++++++
Documentation/userspace-api/index.rst | 2 +-
MAINTAINERS | 2 +-
4 files changed, 14 insertions(+), 2 deletions(-)
rename Documentation/userspace-api/{ => fwctl}/fwctl.rst (100%)
create mode 100644 Documentation/userspace-api/fwctl/index.rst
diff --git a/Documentation/userspace-api/fwctl.rst b/Documentation/userspace-api/fwctl/fwctl.rst
similarity index 100%
rename from Documentation/userspace-api/fwctl.rst
rename to Documentation/userspace-api/fwctl/fwctl.rst
diff --git a/Documentation/userspace-api/fwctl/index.rst b/Documentation/userspace-api/fwctl/index.rst
new file mode 100644
index 000000000000..06959fbf1547
--- /dev/null
+++ b/Documentation/userspace-api/fwctl/index.rst
@@ -0,0 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Firmware Control (FWCTL) Userspace API
+======================================
+
+A framework that define a common set of limited rules that allows user space
+to securely construct and execute RPCs inside device firmware.
+
+.. toctree::
+ :maxdepth: 1
+
+ fwctl
diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst
index 2bc43a658074..c2f067b3de01 100644
--- a/Documentation/userspace-api/index.rst
+++ b/Documentation/userspace-api/index.rst
@@ -44,7 +44,7 @@ Devices and I/O
accelerators/ocxl
dma-buf-alloc-exchange
- fwctl
+ fwctl/index
gpio/index
iommufd
media/index
diff --git a/MAINTAINERS b/MAINTAINERS
index 6b52c4168b94..1699316f86ae 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9377,7 +9377,7 @@ FWCTL SUBSYSTEM
M: Jason Gunthorpe <jgg@nvidia.com>
M: Saeed Mahameed <saeedm@nvidia.com>
S: Maintained
-F: Documentation/userspace-api/fwctl.rst
+F: Documentation/userspace-api/fwctl/
F: drivers/fwctl/
F: include/linux/fwctl.h
F: include/uapi/fwctl/
--
2.47.0
next prev parent reply other threads:[~2024-11-15 21:28 UTC|newest]
Thread overview: 79+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-11-15 21:25 [RFC PATCH v2 0/20] fwctl/cxl: Add CXL feature commands support via fwctl Dave Jiang
2024-11-15 21:25 ` [RFC PATCH v2 01/20] cxl: Refactor user ioctl command path from mds to mailbox Dave Jiang
2024-11-21 17:33 ` Jonathan Cameron
2024-12-06 0:00 ` Dan Williams
2024-11-15 21:25 ` [RFC PATCH v2 02/20] cxl: Add Get Supported Features command for kernel usage Dave Jiang
2024-11-21 17:42 ` Jonathan Cameron
2024-12-06 0:33 ` Dan Williams
2024-12-09 12:20 ` Shiju Jose
2024-11-15 21:25 ` [RFC PATCH v2 03/20] cxl/test: Add Get Supported Features mailbox command support Dave Jiang
2024-11-21 17:45 ` Jonathan Cameron
2024-12-06 0:36 ` Dan Williams
2024-11-15 21:25 ` [RFC PATCH v2 04/20] cxl/mbox: Add GET_FEATURE mailbox command Dave Jiang
2024-12-06 0:44 ` Dan Williams
2024-12-09 12:20 ` Shiju Jose
2024-11-15 21:25 ` [RFC PATCH v2 05/20] cxl: Add Get Feature command support for user submission Dave Jiang
2024-11-21 17:47 ` Jonathan Cameron
2024-11-22 20:14 ` Dave Jiang
2024-11-25 20:14 ` Shiju Jose
2024-12-06 0:45 ` Dan Williams
2024-11-15 21:25 ` [RFC PATCH v2 06/20] cxl/mbox: Add SET_FEATURE mailbox command Dave Jiang
2024-12-06 0:48 ` Dan Williams
2024-12-09 12:20 ` Shiju Jose
2024-11-15 21:25 ` [RFC PATCH v2 07/20] cxl: Add Set Feature command support for user submission Dave Jiang
2024-11-21 17:49 ` Jonathan Cameron
2024-11-21 18:08 ` Dave Jiang
2024-11-22 14:17 ` Jonathan Cameron
2024-12-06 0:53 ` Dan Williams
2024-11-15 21:25 ` [RFC PATCH v2 08/20] cxl: Move cxl_driver related bits to be usable by external drivers Dave Jiang
2024-11-21 17:55 ` Jonathan Cameron
2024-11-15 21:25 ` [RFC PATCH v2 09/20] fwctl/cxl: Add driver for CXL mailbox for handling CXL features commands Dave Jiang
2024-11-20 18:01 ` Jason Gunthorpe
2024-11-20 18:35 ` Dave Jiang
2024-11-21 18:02 ` Jonathan Cameron
2024-12-06 1:21 ` Dan Williams
2024-12-09 13:30 ` Jason Gunthorpe
2024-12-09 20:35 ` Dan Williams
2024-12-10 13:40 ` Jason Gunthorpe
2024-11-15 21:25 ` [RFC PATCH v2 10/20] fwctl/cxl: Add support for get driver information Dave Jiang
2024-11-20 18:05 ` Jason Gunthorpe
2024-11-21 18:11 ` Jonathan Cameron
2024-11-22 23:22 ` Dave Jiang
2024-11-25 18:06 ` Jonathan Cameron
2024-12-06 5:15 ` Dan Williams
2024-11-15 21:25 ` [RFC PATCH v2 11/20] fwctl: FWCTL_HW_INFO to return hardware information Dave Jiang
2024-11-20 18:53 ` Jason Gunthorpe
2024-11-21 18:20 ` Jonathan Cameron
2024-11-22 22:42 ` Dave Jiang
2024-12-06 5:32 ` Dan Williams
2024-12-06 18:39 ` Dave Jiang
2024-12-09 13:32 ` Jason Gunthorpe
2024-11-15 21:25 ` [RFC PATCH v2 12/20] cxl: Save Command Effects Log (CEL) effects for enabled commands Dave Jiang
2024-11-21 18:22 ` Jonathan Cameron
2024-11-15 21:25 ` [RFC PATCH v2 13/20] fwctl/cxl: Add hw_info callback Dave Jiang
2024-11-21 18:26 ` Jonathan Cameron
2024-12-06 5:40 ` Dan Williams
2024-11-15 21:25 ` [RFC PATCH v2 14/20] cxl: Move defines and error codes from cxlmem.h to cxl/mailbox.h Dave Jiang
2024-11-21 18:31 ` Jonathan Cameron
2024-12-06 5:50 ` Dan Williams
2024-11-15 21:25 ` [RFC PATCH v2 15/20] fwctl/cxl: Add support for fwctl RPC command to enable CXL feature commands Dave Jiang
2024-11-20 18:42 ` Jason Gunthorpe
2024-11-22 14:49 ` Jonathan Cameron
2024-12-06 6:13 ` Dan Williams
2024-11-15 21:25 ` [RFC PATCH v2 16/20] fwctl/cxl: Add support to filter exclusive features Dave Jiang
2024-11-22 15:05 ` Jonathan Cameron
2024-12-03 18:06 ` Dave Jiang
2024-11-15 21:25 ` [RFC PATCH v2 17/20] cxl/test: Add Get Feature support to cxl_test Dave Jiang
2024-11-22 15:19 ` Jonathan Cameron
2024-11-15 21:25 ` [RFC PATCH v2 18/20] cxl/test: Add Set " Dave Jiang
2024-11-22 15:20 ` Jonathan Cameron
2024-11-15 21:25 ` Dave Jiang [this message]
2024-11-20 17:52 ` [RFC PATCH v2 19/20] fwctl: Move fwctl documentation to its own directory Jason Gunthorpe
2024-11-15 21:25 ` [RFC PATCH v2 20/20] fwctl/cxl: Add documentation to FWCTL CXL Dave Jiang
2024-11-22 15:26 ` Jonathan Cameron
2024-12-03 21:07 ` Dave Jiang
2024-12-06 21:10 ` Dan Williams
2024-11-20 18:57 ` [RFC PATCH v2 0/20] fwctl/cxl: Add CXL feature commands support via fwctl Jason Gunthorpe
2024-11-21 18:38 ` Jonathan Cameron
2025-01-21 20:30 ` Jason Gunthorpe
2025-01-21 20:34 ` Dave Jiang
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=20241115212745.869552-20-dave.jiang@intel.com \
--to=dave.jiang@intel.com \
--cc=Jonathan.Cameron@huawei.com \
--cc=alison.schofield@intel.com \
--cc=dan.j.williams@intel.com \
--cc=dave@stgolabs.net \
--cc=ira.weiny@intel.com \
--cc=jgg@nvidia.com \
--cc=linux-cxl@vger.kernel.org \
--cc=shiju.jose@huawei.com \
--cc=vishal.l.verma@intel.com \
/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