From: Felipe Balbi <felipe.balbi@linux.intel.com>
Date: Tue, 5 Apr 2016 08:33:30 +0000 (+0300)
Subject: UPSTREAM: usb: dwc3: core: document struct dwc3_request
X-Git-Tag: firefly_0821_release~1862
X-Git-Url: http://plrg.eecs.uci.edu/git/?p=firefly-linux-kernel-4.4.55.git;a=commitdiff_plain;h=d72b2a3f3cb467a6645bd35e4ee2849068263593

UPSTREAM: usb: dwc3: core: document struct dwc3_request

No functional changes. Merely adding useful
documentation for future readers.

Change-Id: Ib3ecbad6771a72dbc56bc93e12b1c6f52092c372
Signed-off-by: Felipe Balbi <felipe.balbi@linux.intel.com>
Signed-off-by: Wu Liang feng <wulf@rock-chips.com>
(cherry picked from commit 5ef68c56e169a9249b94645a9ea9ca8d14672d26)
---

diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index 4b79d9c9f5e0..a3a196bd7d2c 100644
--- a/drivers/usb/dwc3/core.h
+++ b/drivers/usb/dwc3/core.h
@@ -622,6 +622,19 @@ struct dwc3_hwparams {
 /* HWPARAMS7 */
 #define DWC3_RAM1_DEPTH(n)	((n) & 0xffff)
 
+/**
+ * struct dwc3_request - representation of a transfer request
+ * @request: struct usb_request to be transferred
+ * @list: a list_head used for request queueing
+ * @dep: struct dwc3_ep owning this request
+ * @first_trb_index: index to first trb used by this request
+ * @epnum: endpoint number to which this request refers
+ * @trb: pointer to struct dwc3_trb
+ * @trb_dma: DMA address of @trb
+ * @direction: IN or OUT direction flag
+ * @mapped: true when request has been dma-mapped
+ * @queued: true when request has been queued to HW
+ */
 struct dwc3_request {
 	struct usb_request	request;
 	struct list_head	list;