WebSVN – HelenOS – Diff – /trunk/kernel/generic/include/ipc/ipc.h

 #ifndef KERN_IPC_H_
 #define KERN_IPC_H_
 /* Length of data being transfered with IPC call */
 /* - the uspace may not be able to utilize full length */
-#define IPC_CALL_LEN    4
+#define IPC_CALL_LEN        4
 /** Maximum active async calls per thread */
 #ifdef CONFIG_DEBUG
-# define IPC_MAX_ASYNC_CALLS  4
+#define IPC_MAX_ASYNC_CALLS 4
 #else
-# define IPC_MAX_ASYNC_CALLS  4000
+#define IPC_MAX_ASYNC_CALLS 4000
 #endif
 /* Flags for calls */
 /** This is answer to a call */
 /** Identify connect_me_to answer */
 #define IPC_CALL_CONN_ME_TO (1 << 4)
 /** Interrupt notification */
 #define IPC_CALL_NOTIF      (1 << 5)
+/*
+ * Bits used in call hashes.
-/* Flags of callid (the addresses are aligned at least to 4,
+ * The addresses are aligned at least to 4 that is why we can use the 2 least
- * that is why we can use bottom 2 bits of the call address
+ * significant bits of the call address.
  */
-/** Type of this msg is 'answer' */
+/** Type of this call is 'answer' */
 #define IPC_CALLID_ANSWERED 1
-/** Type of this msg is 'notification' */
+/** Type of this call is 'notification' */
 #define IPC_CALLID_NOTIFICATION 2
-/* Return values from IPC_ASYNC */
+/* Return values from sys_ipc_call_async(). */
 #define IPC_CALLRET_FATAL   -1
 #define IPC_CALLRET_TEMPORARY   -2
 /* Macros for manipulating calling data */
  *                       the call is accepted and the response is sent back.
  *                     - the allocated phoneid is passed to userspace
  *                       (on the receiving sid) as ARG3 of the call.
  *                     - the caller obtains taskid of the called thread
  */
-#define IPC_M_CONNECT_TO_ME     1
+#define IPC_M_CONNECT_TO_ME 1
 /** Protocol for CONNECT - ME - TO
+ *
  * Calling process asks the callee to create for him a new connection.
  * E.g. the caller wants a name server to connect him to print server.
+ *
  *                     -  otherwise connection refused
  *                     -  recepient may forward message. Forwarding
  *                        system message
+ *
  */
-#define IPC_M_CONNECT_ME_TO     2
+#define IPC_M_CONNECT_ME_TO 2
 /** This message is sent to answerbox when the phone
  * is hung up
  */
-#define IPC_M_PHONE_HUNGUP      3
+#define IPC_M_PHONE_HUNGUP  3
 /** Send as_area over IPC
  * - ARG1 - src as_area base address
  * - ARG2 - size of src as_area (filled automatically by kernel)
  * - ARG3 - flags of the as_area being sent
+ *
  * on answer:
  * - ARG1 - dst as_area base adress
  */
-#define IPC_M_AS_AREA_SEND      5
+#define IPC_M_AS_AREA_SEND  5
 /** Get as_area over IPC
  * - ARG1 - dst as_area base address
  * - ARG2 - dst as_area size
  * - ARG3 - user defined argument
  * on answer, the server must set:
+ *
  * - ARG1 - src as_area base address
  * - ARG2 - flags that will be used for sharing
  */
-#define IPC_M_AS_AREA_RECV      6
+#define IPC_M_AS_AREA_RECV  6
 /* Well-known methods */
-#define IPC_M_LAST_SYSTEM     511
+#define IPC_M_LAST_SYSTEM   511
-#define IPC_M_PING            512
+#define IPC_M_PING      512
 /* User methods */
-#define FIRST_USER_METHOD     1024
+#define FIRST_USER_METHOD   1024
 #ifdef KERNEL
 #define IPC_MAX_PHONES  16
     struct task *task;
     waitq_t wq;
-    /** Phones connected to this answerbox */
+    /** Phones connected to this answerbox. */
     link_t connected_phones;
-    /** Received calls */
+    /** Received calls. */
     link_t calls;
     link_t dispatched_calls;    /* Should be hash table in the future */
-    /** Answered calls */
+    /** Answered calls. */
     link_t answers;
     SPINLOCK_DECLARE(irq_lock);
-    /** Notifications from IRQ handlers */
+    /** Notifications from IRQ handlers. */
     link_t irq_notifs;
     /** IRQs with notifications to this answerbox. */
     link_t irq_head;
 } answerbox_t;
 typedef struct {
     link_t link;
     int flags;
-    /* Identification of the caller */
+    /** Identification of the caller. */
     struct task *sender;
-    /* The caller box is different from sender->answerbox
+    /** The caller box is different from sender->answerbox for synchronous
-     * for synchronous calls
+     *  calls. */
-     */
     answerbox_t *callerbox;
-    /** Private data to internal IPC */
+    /** Private data to internal IPC. */
     unative_t priv;
-    /** Data passed from/to userspace */
+    /** Data passed from/to userspace. */
     ipc_data_t data;
 } call_t;
 extern void ipc_init(void);
 extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/ipc/ipc.h – Rev 2106 → 2471