Changeset f8048d1 in mainline

Timestamp:

2018-09-06T10:56:26Z (6 years ago)

Author:

Martin Decky <martin@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

d51cca8

Parents:

954c024

Message:

Improve documentation of IPC_M_DATA_READ and IPC_M_DATA_WRITE

Files:

• abi/include/abi/ipc/methods.h (modified) (2 diffs)
• uspace/lib/c/generic/async/server.c (modified) (2 diffs)

abi/include/abi/ipc/methods.h

@@ -157 +157 @@
         /** Receive data from another address space over IPC.
          *
-         * - ARG1 - destination virtual address in the source address space
-         * - ARG2 - size of data to be received, may be cropped by the recipient
-         *
-         * on answer, the recipient must set:
-         *
-         * - ARG1 - source virtual address in the destination address space
-         * - ARG2 - final size of data to be copied
+         * Sender:
+         *  - uspace: arg1 .. sender's destination buffer address
+         *            arg2 .. sender's destination buffer size
+         *            arg3 .. flags (IPC_XF_RESTRICT)
+         *            arg4 .. <unused>
+         *            arg5 .. <unused>
+         *
+         * Recipient:
+         *  - uspace: arg1 .. recipient's source buffer address
+         *            arg2 .. recipient's source buffer size
+         *            arg3 .. <unused>
+         *            arg4 .. <unused>
+         *            arg5 .. <unused>
+         *
          */
         IPC_M_DATA_READ,
@@ -169 +176 @@
         /** Send data to another address space over IPC.
          *
-         * - ARG1 - source address space virtual address
-         * - ARG2 - size of data to be copied, may be overriden by the recipient
-         *
-         * on answer, the recipient must set:
-         *
-         * - ARG1 - final destination address space virtual address
-         * - ARG2 - final size of data to be copied
+         * Sender:
+         *  - uspace: arg1 .. sender's source buffer address
+         *            arg2 .. sender's source buffer size
+         *            arg3 .. flags (IPC_XF_RESTRICT)
+         *            arg4 .. <unused>
+         *            arg5 .. <unused>
+         *
+         * Recipient:
+         *  - uspace: arg1 .. recipient's destination buffer address
+         *            arg2 .. recipient's destination buffer size
+         *            arg3 .. <unused>
+         *            arg4 .. <unused>
+         *            arg5 .. <unused>
+         *
          */
         IPC_M_DATA_WRITE,

uspace/lib/c/generic/async/server.c

@@ -1217 +1217 @@
  * argument.
  *
- * @param call  IPC_M_DATA_READ call to answer.
+ * @param call  IPC_M_SHARE_IN call to answer.
  * @param src   Source address space base.
  * @param flags Flags to be used for sharing. Bits can be only cleared.
@@ -1269 +1269 @@
  * argument.
  *
- * @param call IPC_M_DATA_WRITE call to answer.
+ * @param call IPC_M_SHARE_OUT call to answer.
  * @param dst  Address of the storage for the destination address space area
  *             base address.