linux-kernel - [PATCH v2] usb: dwc3: Fix documentation warning for sg member

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250123151335.15878-1-usmanakinyemi202@gmail.com>
Date: Thu, 23 Jan 2025 20:43:35 +0530
From: Usman Akinyemi <usmanakinyemi202@...il.com>
To: Thinh.Nguyen@...opsys.com
Cc: gregkh@...uxfoundation.org,
	linux-usb@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	Stephen Rothwell <sfr@...b.auug.org.au>
Subject: [PATCH v2] usb: dwc3: Fix documentation warning for sg member

The 'sg' member in struct dwc3_request was undocumented, causing a
documentation warning when building the kernel docs.

This patch adds a description for the 'sg' field, resolving the warning.

Fixes: 61440628a4ff ("usb: dwc3: gadget: Cleanup SG handling")
Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
Signed-off-by: Usman Akinyemi <usmanakinyemi202@...il.com>
---
 drivers/usb/dwc3/core.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index ee73789326bc..0c417a12e6f4 100644
--- a/drivers/usb/dwc3/core.h
+++ b/drivers/usb/dwc3/core.h
@@ -941,6 +941,7 @@ struct dwc3_hwparams {
  * @request: struct usb_request to be transferred
  * @list: a list_head used for request queueing
  * @dep: struct dwc3_ep owning this request
+ * @sg: pointer to a scatterlist for DMA operations
  * @start_sg: pointer to the sg which should be queued next
  * @num_pending_sgs: counter to pending sgs
  * @remaining: amount of data remaining
-- 
2.48.0