Eric Lee / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit 0e15597ebfe00e28857185f46aba00f400480ffe

Authored by Abhishek Kulkarni
Committed by Eric Van Hensbergen
1 parent 2bb541157f
Exists in master and in 39 other branches 8mp-imx_5.4.70_2.3.0, 8qm-imx_5.4.70_2.3.0, emb_imx_lf-5.15.y, emb_lf-6.1.y, imx_3.0.35_4.1.0, imx_3.10.17_1.0.1_ga, imx_3.10.53_1.1.0_ga, imx_3.14.28_1.0.0_ga, imx_4.1.15_1.0.0_ga, pitx_8mp_lf-5.10.y, rt-smarc-imx_4.1.15_1.0.0_ga, rt_linux_5.15.71, smarc-8m-android-11.0.0_2.0.0, smarc-imx6_4.14.98_2.0.0_ga, smarc-imx6_4.9.88_2.0.0_ga, smarc-imx7_4.14.98_2.0.0_ga, smarc-imx7_4.9.11_1.0.0_ga, smarc-imx7_4.9.88_2.0.0_ga, smarc-imx_3.10.53_1.1.0_ga, smarc-imx_3.14.28_1.0.0_ga, smarc-imx_4.1.15_1.0.0_ga, smarc-imx_4.9.11_1.0.0_ga, smarc-imx_4.9.51_imx8m_ga, smarc-imx_4.9.88_2.0.0_ga, smarc-m6.0.1_2.1.0-ga, smarc-n7.1.2_2.0.0-ga, smarc-rel_imx_4.1.15_1.2.0_ga, smarc_8m_00d0_imx_4.14.98_2.0.0_ga, smarc_8m_imx_4.14.78_1.0.0_ga, smarc_8m_imx_4.14.98_2.0.0_ga, smarc_8m_imx_4.19.35_1.1.0, smarc_8mm_imx_4.14.78_1.0.0_ga, smarc_8mm_imx_4.14.98_2.0.0_ga, smarc_8mm_imx_4.19.35_1.1.0, smarc_8mm_imx_5.4.24_2.1.0, smarc_8mp_lf-5.10.y, smarc_8mq_imx_5.4.24_2.1.0, smarc_8mq_lf-5.10.y, smarc_imx_lf-5.15.y

9p: minor comment fixes 

Fix the comments -- mostly the improper and/or missing descriptions
of function parameters.

Signed-off-by: Abhishek Kulkarni <adkulkar@umail.iu.edu>
Signed-off-by: Eric Van Hensbergen <ericvh@gmail.com>

Showing 5 changed files with 21 additions and 24 deletions Side-by-side Diff

... ... @@ -171,7 +171,6 @@
171 171  
172 172 /**
173 173 * v9fs_blank_wstat - helper function to setup a 9P stat structure
174   - * @v9ses: 9P session info (for determining extended mode)
175 174 * @wstat: structure to initialize
176 175 *
177 176 */
178 177  
... ... @@ -410,9 +409,9 @@
410 409 * @v9ses: session information
411 410 * @dir: directory that dentry is being created in
412 411 * @dentry: dentry that is being created
  412 + * @extension: 9p2000.u extension string to support devices, etc.
413 413 * @perm: create permissions
414 414 * @mode: open mode
415   - * @extension: 9p2000.u extension string to support devices, etc.
416 415 *
417 416 */
418 417 static struct p9_fid *
... ... @@ -60,9 +60,9 @@
60 60 p9_client_rpc(struct p9_client *c, int8_t type, const char *fmt, ...);
61 61  
62 62 /**
63   - * v9fs_parse_options - parse mount options into session structure
64   - * @options: options string passed from mount
65   - * @v9ses: existing v9fs session information
  63 + * parse_options - parse mount options into client structure
  64 + * @opts: options string passed from mount
  65 + * @clnt: existing v9fs client information
66 66 *
67 67 * Return 0 upon success, -ERRNO upon failure
68 68 */
... ... @@ -232,7 +232,7 @@
232 232  
233 233 /**
234 234 * p9_tag_init - setup tags structure and contents
235   - * @tags: tags structure from the client struct
  235 + * @c: v9fs client struct
236 236 *
237 237 * This initializes the tags structure for each client instance.
238 238 *
... ... @@ -258,7 +258,7 @@
258 258  
259 259 /**
260 260 * p9_tag_cleanup - cleans up tags structure and reclaims resources
261   - * @tags: tags structure from the client struct
  261 + * @c: v9fs client struct
262 262 *
263 263 * This frees resources associated with the tags structure
264 264 *
... ... @@ -430,8 +430,8 @@
430 430  
431 431 /**
432 432 * p9_client_flush - flush (cancel) a request
433   - * c: client state
434   - * req: request to cancel
  433 + * @c: client state
  434 + * @oldreq: request to cancel
435 435 *
436 436 * This sents a flush for a particular requests and links
437 437 * the flush request to the original request. The current
... ... @@ -119,8 +119,8 @@
119 119 * @wpos: write position for current frame
120 120 * @wsize: amount of data to write for current frame
121 121 * @wbuf: current write buffer
  122 + * @poll_pending_link: pending links to be polled per conn
122 123 * @poll_wait: array of wait_q's for various worker threads
123   - * @poll_waddr: ????
124 124 * @pt: poll state
125 125 * @rq: current read work
126 126 * @wq: current write work
... ... @@ -700,9 +700,9 @@
700 700 }
701 701  
702 702 /**
703   - * parse_options - parse mount options into session structure
704   - * @options: options string passed from mount
705   - * @opts: transport-specific structure to parse options into
  703 + * parse_opts - parse mount options into p9_fd_opts structure
  704 + * @params: options string passed from mount
  705 + * @opts: fd transport-specific structure to parse options into
706 706 *
707 707 * Returns 0 upon success, -ERRNO upon failure
708 708 */
... ... @@ -67,14 +67,15 @@
67 67 * @pd: Protection Domain pointer
68 68 * @qp: Queue Pair pointer
69 69 * @cq: Completion Queue pointer
  70 + * @dm_mr: DMA Memory Region pointer
70 71 * @lkey: The local access only memory region key
71 72 * @timeout: Number of uSecs to wait for connection management events
72 73 * @sq_depth: The depth of the Send Queue
73 74 * @sq_sem: Semaphore for the SQ
74 75 * @rq_depth: The depth of the Receive Queue.
  76 + * @rq_count: Count of requests in the Receive Queue.
75 77 * @addr: The remote peer's address
76 78 * @req_lock: Protects the active request list
77   - * @send_wait: Wait list when the SQ fills up
78 79 * @cm_done: Completion event for connection management tracking
79 80 */
80 81 struct p9_trans_rdma {
... ... @@ -154,9 +155,9 @@
154 155 };
155 156  
156 157 /**
157   - * parse_options - parse mount options into session structure
158   - * @options: options string passed from mount
159   - * @opts: transport-specific structure to parse options into
  158 + * parse_opts - parse mount options into rdma options structure
  159 + * @params: options string passed from mount
  160 + * @opts: rdma transport-specific structure to parse options into
160 161 *
161 162 * Returns 0 upon success, -ERRNO upon failure
162 163 */
net/9p/trans_virtio.c
Diff comments   View file @ 0e15597
... ... @@ -57,11 +57,9 @@
57 57 * @initialized: whether the channel is initialized
58 58 * @inuse: whether the channel is in use
59 59 * @lock: protects multiple elements within this structure
  60 + * @client: client instance
60 61 * @vdev: virtio dev associated with this channel
61 62 * @vq: virtio queue associated with this channel
62   - * @tagpool: accounting for tag ids (and request slots)
63   - * @reqs: array of request slots
64   - * @max_tag: current number of request_slots allocated
65 63 * @sg: scatter gather list which is used to pack a request (protected?)
66 64 *
67 65 * We keep all per-channel information in a structure.
... ... @@ -92,7 +90,7 @@
92 90  
93 91 /**
94 92 * p9_virtio_close - reclaim resources of a channel
95   - * @trans: transport state
  93 + * @client: client instance
96 94 *
97 95 * This reclaims a channel by freeing its resources and
98 96 * reseting its inuse flag.
... ... @@ -181,9 +179,8 @@
181 179  
182 180 /**
183 181 * p9_virtio_request - issue a request
184   - * @t: transport state
185   - * @tc: &p9_fcall request to transmit
186   - * @rc: &p9_fcall to put reponse into
  182 + * @client: client instance issuing the request
  183 + * @req: request to be issued
187 184 *
188 185 */
189 186