Re: [PATCH net-next v2 6/6] bnxt_fwctl: Add documentation entries
From: Dave Jiang <dave.jiang@intel.com>
Date: 2025-09-24 22:40:51
On 9/23/25 2:58 AM, Pavan Chebbi wrote:
quoted hunk ↗ jump to hunk
Add bnxt_fwctl to the driver and fwctl documentation pages. Reviewed-by: Andy Gospodarek <redacted> Signed-off-by: Pavan Chebbi <pavan.chebbi@broadcom.com> --- .../userspace-api/fwctl/bnxt_fwctl.rst | 27 +++++++++++++++++++ Documentation/userspace-api/fwctl/fwctl.rst | 1 + Documentation/userspace-api/fwctl/index.rst | 1 + 3 files changed, 29 insertions(+) create mode 100644 Documentation/userspace-api/fwctl/bnxt_fwctl.rstdiff --git a/Documentation/userspace-api/fwctl/bnxt_fwctl.rst b/Documentation/userspace-api/fwctl/bnxt_fwctl.rst new file mode 100644 index 000000000000..78f24004af02 --- /dev/null +++ b/Documentation/userspace-api/fwctl/bnxt_fwctl.rst@@ -0,0 +1,27 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================ +fwctl bnxt driver +================ + +:Author: Pavan Chebbi + +Overview +======== + +BNXT driver makes a fwctl service available through an auxiliary_device. +The bnxt_fwctl driver binds to this device and registers itself with the +fwctl subsystem. + +The bnxt_fwctl driver is agnostic to the device firmware internals. It +uses the ULP conduit provided by bnxt to send requests (HWRM commands)
Probably should expand the TLA on first time usage in documentation. What's ULP? What's HWRM?
+to firmware. + +bnxt_fwctl User API +================== + +Each RPC request contains a message request structure (HWRM input) its,
s/) its,/), its /
+legth, optional request timeout, and dma buffers' information if the
s/legth/length/
+command needs any DMA. The request is then put together with the request +data and sent through bnxt's message queue to the firmware, and the results +are returned to the caller.
Would be helpful to explain the ioctls provided and perhaps some sample code for user side.
quoted hunk ↗ jump to hunk
diff --git a/Documentation/userspace-api/fwctl/fwctl.rst b/Documentation/userspace-api/fwctl/fwctl.rst index a74eab8d14c6..e9f345797ca0 100644 --- a/Documentation/userspace-api/fwctl/fwctl.rst +++ b/Documentation/userspace-api/fwctl/fwctl.rst@@ -151,6 +151,7 @@ fwctl User API .. kernel-doc:: include/uapi/fwctl/fwctl.h .. kernel-doc:: include/uapi/fwctl/mlx5.h .. kernel-doc:: include/uapi/fwctl/pds.h +.. kernel-doc:: include/uapi/fwctl/bnxt.h sysfs Class -----------diff --git a/Documentation/userspace-api/fwctl/index.rst b/Documentation/userspace-api/fwctl/index.rst index 316ac456ad3b..c0630d27afeb 100644 --- a/Documentation/userspace-api/fwctl/index.rst +++ b/Documentation/userspace-api/fwctl/index.rst@@ -12,3 +12,4 @@ to securely construct and execute RPCs inside device firmware. fwctl fwctl-cxl pds_fwctl + bnxt_fwctl