abi/include/ipc/ipc.h

   1 /*
   2  * Copyright (c) 2006 Ondrej Palkovsky
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup genericipc
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef ABI_IPC_IPC_H_
  36 #define ABI_IPC_IPC_H_
  37
  38 /** Length of data being transfered with IPC call
  39  *
  40  * The uspace may not be able to utilize full length
  41  *
  42  */
  43 #define IPC_CALL_LEN  6
  44
  45 /** Maximum active async calls per phone */
  46 #define IPC_MAX_ASYNC_CALLS  4
  47
  48 /* Flags for calls */
  49
  50 /** This is answer to a call */
  51 #define IPC_CALL_ANSWERED  (1 << 0)
  52
  53 /** Answer will not be passed to userspace, will be discarded */
  54 #define IPC_CALL_DISCARD_ANSWER  (1 << 1)
  55
  56 /** Call was forwarded */
  57 #define IPC_CALL_FORWARDED  (1 << 2)
  58
  59 /** Interrupt notification */
  60 #define IPC_CALL_NOTIF  (1 << 3)
  61
  62
  63 /** Bits used in call hashes.
  64  *
  65  * The addresses are aligned at least to 4 that is why we can use the 2 least
  66  * significant bits of the call address.
  67  *
  68  */
  69
  70 /** Type of this call is 'answer' */
  71 #define IPC_CALLID_ANSWERED  1
  72
  73 /** Type of this call is 'notification' */
  74 #define IPC_CALLID_NOTIFICATION  2
  75
  76 /* Return values from sys_ipc_call_async(). */
  77 #define IPC_CALLRET_FATAL      -1
  78 #define IPC_CALLRET_TEMPORARY  -2
  79
  80
  81 /* Macros for manipulating calling data */
  82 #define IPC_SET_RETVAL(data, retval)  ((data).args[0] = (retval))
  83 #define IPC_SET_IMETHOD(data, val)    ((data).args[0] = (val))
  84 #define IPC_SET_ARG1(data, val)       ((data).args[1] = (val))
  85 #define IPC_SET_ARG2(data, val)       ((data).args[2] = (val))
  86 #define IPC_SET_ARG3(data, val)       ((data).args[3] = (val))
  87 #define IPC_SET_ARG4(data, val)       ((data).args[4] = (val))
  88 #define IPC_SET_ARG5(data, val)       ((data).args[5] = (val))
  89
  90 #define IPC_GET_IMETHOD(data)  ((data).args[0])
  91 #define IPC_GET_RETVAL(data)   ((data).args[0])
  92
  93 #define IPC_GET_ARG1(data)  ((data).args[1])
  94 #define IPC_GET_ARG2(data)  ((data).args[2])
  95 #define IPC_GET_ARG3(data)  ((data).args[3])
  96 #define IPC_GET_ARG4(data)  ((data).args[4])
  97 #define IPC_GET_ARG5(data)  ((data).args[5])
  98
  99 /* Forwarding flags. */
 100 #define IPC_FF_NONE  0
 101
 102 /**
 103  * The call will be routed as though it was initially sent via the phone used to
 104  * forward it. This feature is intended to support the situation in which the
 105  * forwarded call needs to be handled by the same connection fibril as any other
 106  * calls that were initially sent by the forwarder to the same destination. This
 107  * flag has no imapct on routing replies.
 108  */
 109 #define IPC_FF_ROUTE_FROM_ME  (1 << 0)
 110
 111 /* Data transfer flags. */
 112 #define IPC_XF_NONE  0
 113
 114 /** Restrict the transfer size if necessary. */
 115 #define IPC_XF_RESTRICT  (1 << 0)
 116
 117 /** User-defined IPC methods */
 118 #define IPC_FIRST_USER_METHOD  1024
 119
 120 #endif
 121
 122 /** @}
 123  */