Document buf argument in get_mem for remoteproc_ops structure

tammyleino · arnopo · commit e4307e142e57 · 2022-04-15T09:20:36.000+02:00
Added a description of the buf parameter to get_mem.
Signed-off-by: Tammy Leino &lt;tammy_leino@mentor.com&gt;
diff --git a/lib/include/openamp/remoteproc.h b/lib/include/openamp/remoteproc.h
@@ -423,6 +423,7 @@ struct remoteproc_ops {
 	 * @da - device address
 	 * @va - virtual address
 	 * @size - memory size
+	 * @buf - pointer to remoteproc_mem struct object to store result
 	 *
 	 * @returns remoteproc memory pointed by buf if success, otherwise NULL
 	 */

Original file line number	Diff line number	Diff line change
`@@ -423,6 +423,7 @@ struct remoteproc_ops {`
`423`	`423`	`* @da - device address`
`424`	`424`	`* @va - virtual address`
`425`	`425`	`* @size - memory size`
	`426`	`+ * @buf - pointer to remoteproc_mem struct object to store result`
`426`	`427`	`*`
`427`	`428`	`* @returns remoteproc memory pointed by buf if success, otherwise NULL`
`428`	`429`	`*/`