Changeset f8048d1 in mainline for abi


Ignore:
Timestamp:
2018-09-06T10:56:26Z (7 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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • abi/include/abi/ipc/methods.h

    r954c024 rf8048d1  
    157157        /** Receive data from another address space over IPC.
    158158         *
    159          * - ARG1 - destination virtual address in the source address space
    160          * - ARG2 - size of data to be received, may be cropped by the recipient
    161          *
    162          * on answer, the recipient must set:
    163          *
    164          * - ARG1 - source virtual address in the destination address space
    165          * - ARG2 - final size of data to be copied
     159         * Sender:
     160         *  - uspace: arg1 .. sender's destination buffer address
     161         *            arg2 .. sender's destination buffer size
     162         *            arg3 .. flags (IPC_XF_RESTRICT)
     163         *            arg4 .. <unused>
     164         *            arg5 .. <unused>
     165         *
     166         * Recipient:
     167         *  - uspace: arg1 .. recipient's source buffer address
     168         *            arg2 .. recipient's source buffer size
     169         *            arg3 .. <unused>
     170         *            arg4 .. <unused>
     171         *            arg5 .. <unused>
     172         *
    166173         */
    167174        IPC_M_DATA_READ,
    … …  
    169176        /** Send data to another address space over IPC.
    170177         *
    171          * - ARG1 - source address space virtual address
    172          * - ARG2 - size of data to be copied, may be overriden by the recipient
    173          *
    174          * on answer, the recipient must set:
    175          *
    176          * - ARG1 - final destination address space virtual address
    177          * - ARG2 - final size of data to be copied
     178         * Sender:
     179         *  - uspace: arg1 .. sender's source buffer address
     180         *            arg2 .. sender's source buffer size
     181         *            arg3 .. flags (IPC_XF_RESTRICT)
     182         *            arg4 .. <unused>
     183         *            arg5 .. <unused>
     184         *
     185         * Recipient:
     186         *  - uspace: arg1 .. recipient's destination buffer address
     187         *            arg2 .. recipient's destination buffer size
     188         *            arg3 .. <unused>
     189         *            arg4 .. <unused>
     190         *            arg5 .. <unused>
     191         *
    178192         */
    179193        IPC_M_DATA_WRITE,
Note: See TracChangeset for help on using the changeset viewer.