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.

Arnaud Pouliquen committed 5 years ago

Commit 809328b1 parent 3093c3c1 file · +9 −2Browse files

Showing the changes to include/uapi (1 of 1 file). Show all

Unified · Split

 /**
  * struct rpmsg_endpoint_info - endpoint info representation
  * @name: name of service
- * @src: local address
+ * @src: local address. To set to RPMSG_ADDR_ANY if not used.
- * @dst: destination address
+ * @dst: destination address. To set to RPMSG_ADDR_ANY if not used.
  */
 struct rpmsg_endpoint_info {
 	char name[32];
 	__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

Keyboard shortcuts