diff mbox series

Documentation: usb: dwc3: add missing doc for sg

Message ID 20241119020345.30663-1-luis.hernandez093@gmail.com
State New
Headers show
Series Documentation: usb: dwc3: add missing doc for sg | expand

Commit Message

Luis Felipe Hernandez Nov. 19, 2024, 2:03 a.m. UTC
This patch updates the documentation for the dwc3_request struct to
describe the purpose of the sg field. This field is a pointer to a
scatter-gather list used for managing memory buffers in DMA
operations during USB transfers.

- Add description for 'sg' in the doc block for dwc3_request

This change resolves a documentation warning related to the missing
description for this field.

Signed-off-by: Luis Felipe Hernandez <luis.hernandez093@gmail.com>
---
 drivers/usb/dwc3/core.h | 1 +
 1 file changed, 1 insertion(+)
diff mbox series

Patch

diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index ee73789326bc..a53e6e14f27d 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 the sg for this request
  * @start_sg: pointer to the sg which should be queued next
  * @num_pending_sgs: counter to pending sgs
  * @remaining: amount of data remaining