diff options
Diffstat (limited to 'src/include/usr/mbox/mboxif.H')
| -rw-r--r-- | src/include/usr/mbox/mboxif.H | 67 |
1 files changed, 40 insertions, 27 deletions
diff --git a/src/include/usr/mbox/mboxif.H b/src/include/usr/mbox/mboxif.H index d427e5e28..a8609a31f 100644 --- a/src/include/usr/mbox/mboxif.H +++ b/src/include/usr/mbox/mboxif.H @@ -1,26 +1,25 @@ -/* IBM_PROLOG_BEGIN_TAG - * This is an automatically generated prolog. - * - * $Source: src/include/usr/mbox/mboxif.H $ - * - * IBM CONFIDENTIAL - * - * COPYRIGHT International Business Machines Corp. 2012 - * - * p1 - * - * Object Code Only (OCO) source materials - * Licensed Internal Code Source Materials - * IBM HostBoot Licensed Internal Code - * - * The source code for this program is not published or other- - * wise divested of its trade secrets, irrespective of what has - * been deposited with the U.S. Copyright Office. - * - * Origin: 30 - * - * IBM_PROLOG_END_TAG - */ +/* IBM_PROLOG_BEGIN_TAG */ +/* This is an automatically generated prolog. */ +/* */ +/* $Source: src/include/usr/mbox/mboxif.H $ */ +/* */ +/* IBM CONFIDENTIAL */ +/* */ +/* COPYRIGHT International Business Machines Corp. 2012,2013 */ +/* */ +/* p1 */ +/* */ +/* Object Code Only (OCO) source materials */ +/* Licensed Internal Code Source Materials */ +/* IBM HostBoot Licensed Internal Code */ +/* */ +/* The source code for this program is not published or otherwise */ +/* divested of its trade secrets, irrespective of what has been */ +/* deposited with the U.S. Copyright Office. */ +/* */ +/* Origin: 30 */ +/* */ +/* IBM_PROLOG_END_TAG */ #ifndef __MBOX_MBOXIF_H #define __MBOX_MBOXIF_H @@ -30,6 +29,11 @@ namespace MBOX { + enum + { + MBOX_NODE_FSP = -1, + }; + /** * Register a message queue to receive mailbox messages * @param[in] i_queueu_id, The queue identifier @@ -50,20 +54,29 @@ namespace MBOX * Send message asynchronously * @param[in] i_q_id id, of the FSP message queue to send the msg to. * @param[in] i_msg. The message to send. + * @param[in] i_node The destination node [0-7] for IPC messages, + * otherwise the default is FSP * * @return errlHndl_t on error. * - * @pre i_msg->extra_data == NULL If there is no extra data is associated - * with the message. + * @note extra_data payload is not supported for interprocessor + * communication(IPC) messages therefore the i_msg->extra_data field + * may be used as another user data field + * + * @pre For FSP mbox messages, i_msg->extra_data must be NULL If there is + * no payload associated with the message. * - * @pre i_msg->extra_data = malloc(size); i_msg->data[1] = size; + * @pre For FSP mbox messages, + * i_msg->extra_data = malloc(size); i_msg->data[1] = size; * Any extra data associated with i_msg was obtained from the heap * using malloc and i_msg->data[1] contains the length of that data. * * @post free(i_msg->extra_dat) was done (if no error) * @post msg_free(i_msg) was done (if no error) */ - errlHndl_t send(queue_id_t i_q_id, msg_t * i_msg); + errlHndl_t send(queue_id_t i_q_id, + msg_t * i_msg, + int i_node = MBOX_NODE_FSP); /** * Send message synchronously |
