summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorArnaud Pouliquen <arnaud.pouliquen@foss.st.com>2021-03-11 15:04:10 +0100
committerBjorn Andersson <bjorn.andersson@linaro.org>2021-03-17 14:16:26 -0500
commit809328b40cfb152f75541aa3dcbbe4903098963b (patch)
tree6018046f374e330d315e9f142a93b35dab437731 /include
parent3093c3c7c136458af692d5c3d309a66c3c12d9f4 (diff)
downloadlinux-stable-809328b40cfb152f75541aa3dcbbe4903098963b.tar.gz
linux-stable-809328b40cfb152f75541aa3dcbbe4903098963b.tar.bz2
linux-stable-809328b40cfb152f75541aa3dcbbe4903098963b.zip
rpmsg: Add short description of the IOCTL defined in UAPI.
Add a description of the IOCTLs and provide information on the default value of the source and destination addresses. Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org> Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org> Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com> Link: https://lore.kernel.org/r/20210311140413.31725-4-arnaud.pouliquen@foss.st.com Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
Diffstat (limited to 'include')
-rw-r--r--include/uapi/linux/rpmsg.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/include/uapi/linux/rpmsg.h b/include/uapi/linux/rpmsg.h
index 5e00748da319..f5ca8740f3fb 100644
--- a/include/uapi/linux/rpmsg.h
+++ b/include/uapi/linux/rpmsg.h
@@ -14,8 +14,8 @@
/**
* struct rpmsg_endpoint_info - endpoint info representation
* @name: name of service
- * @src: local address
- * @dst: destination address
+ * @src: local address. To set to RPMSG_ADDR_ANY if not used.
+ * @dst: destination address. To set to RPMSG_ADDR_ANY if not used.
*/
struct rpmsg_endpoint_info {
char name[32];
@@ -23,7 +23,14 @@ struct rpmsg_endpoint_info {
__u32 dst;
};
+/**
+ * Instantiate a new rmpsg char device endpoint.
+ */
#define RPMSG_CREATE_EPT_IOCTL _IOW(0xb5, 0x1, struct rpmsg_endpoint_info)
+
+/**
+ * Destroy a rpmsg char device endpoint created by the RPMSG_CREATE_EPT_IOCTL.
+ */
#define RPMSG_DESTROY_EPT_IOCTL _IO(0xb5, 0x2)
#endif