iucv.h

来自「LINUX 2.6.17.4的源码」· C头文件 代码 · 共 850 行 · 第 1/3 页

 *          The array identifies a list of addresses and lengths of
 *          discontiguous buffers that contains the reply data.
 * Input: pathid - Path identification number
 *        msgid - Specifies the message ID.
 *        trgcls - Specifies target class.
 *        flags1 - Option for path.
 *          IPPRTY- 0x20, Specifies if you want to send priority message.
 *        buffer - Address of array of reply buffers.
 *        buflen - Total length of reply buffers.
 * Output: residual_buffer - Address of buffer which IUCV is currently working on.
 *         residual_length - Contains one of the following values:
 *              If the answer buffer is the same length as the reply, this field
 *               contains zero.
 *              If the answer buffer is longer than the reply, this field contains
 *               the number of bytes remaining in the buffer.
 *              If the answer buffer is shorter than the reply, this field contains
 *               a residual count (that is, the number of bytes remianing in the
 *               reply that does not fit into the buffer. In this
 *               case b2f0_result = 5.
 * Return: Return code from CP IUCV call.
 *         (-EINVAL) - Buffer address is NULL.
*/
int iucv_reply_array (u16 pathid,
		      u32 msgid,
		      u32 trgcls,
		      int flags1,
		      iucv_array_t * buffer,
		      ulong buflen, ulong * residual_address,
		      ulong * residual_length);

/*
 * Name: iucv_reply_prmmsg
 * Purpose: This function responds to the two-way messages that you
 *          receive. You must identify completely the message to
 *          which you wish to reply. ie, pathid, msgid, and trgcls.
 *          Prmmsg signifies the data is moved into the
 *          parameter list.
 * Input: pathid - Path identification number.
 *        msgid - Specifies the message ID.
 *        trgcls - Specifies target class.
 *        flags1 - Option for path.
 *          IPPRTY- 0x20 Specifies if you want to send priority message.
 *        prmmsg - 8-bytes of data to be placed into the parameter.
 *                 list.
 * Output: NA
 * Return: Return code from CP IUCV call.
*/
int iucv_reply_prmmsg (u16 pathid,
		       u32 msgid, u32 trgcls, int flags1, uchar prmmsg[8]);

/*
 * Name: iucv_resume
 * Purpose: This function restores communications over a quiesced path
 * Input: pathid - Path identification number.
 *        user_data  - 16-bytes of user data.
 * Output: NA
 * Return: Return code from CP IUCV call.
*/
int iucv_resume (u16 pathid, uchar user_data[16]);

/*
 * Name: iucv_send
 * Purpose: This function transmits data to another application.
 *          Data to be transmitted is in a buffer and this is a
 *          one-way message and the receiver will not reply to the
 *          message.
 * Input: pathid - Path identification number.
 *        trgcls - Specifies target class.
 *        srccls - Specifies the source message class.
 *        msgtag - Specifies a tag to be associated with the message.
 *        flags1 - Option for path.
 *          IPPRTY- 0x20 Specifies if you want to send priority message.
 *        buffer - Address of send buffer.
 *        buflen - Length of send buffer.
 * Output: msgid - Specifies the message ID.
 * Return: Return code from CP IUCV call.
 *         (-EINVAL) - Buffer address is NULL.
*/
int iucv_send (u16 pathid,
	       u32 * msgid,
	       u32 trgcls,
	       u32 srccls, u32 msgtag, int flags1, void *buffer, ulong buflen);

/*
 * Name: iucv_send_array
 * Purpose: This function transmits data to another application.
 *          The contents of buffer is the address of the array of
 *          addresses and lengths of discontiguous buffers that hold
 *          the message text. This is a one-way message and the
 *          receiver will not reply to the message.
 * Input: pathid - Path identification number.
 *        trgcls - Specifies target class.
 *        srccls - Specifies the source message class.
 *        msgtag - Specifies a tag to be associated witht the message.
 *        flags1 - Option for path.
 *          IPPRTY- specifies if you want to send priority message.
 *        buffer - Address of array of send buffers.
 *        buflen - Total length of send buffers.
 * Output: msgid - Specifies the message ID.
 * Return: Return code from CP IUCV call.
 *         (-EINVAL) - Buffer address is NULL.
*/
int iucv_send_array (u16 pathid,
		     u32 * msgid,
		     u32 trgcls,
		     u32 srccls,
		     u32 msgtag,
		     int flags1, iucv_array_t * buffer, ulong buflen);

/*
 * Name: iucv_send_prmmsg
 * Purpose: This function transmits data to another application.
 *          Prmmsg specifies that the 8-bytes of data are to be moved
 *          into the parameter list. This is a one-way message and the
 *          receiver will not reply to the message.
 * Input: pathid - Path identification number.
 *        trgcls - Specifies target class.
 *        srccls - Specifies the source message class.
 *        msgtag - Specifies a tag to be associated with the message.
 *        flags1 - Option for path.
 *          IPPRTY- 0x20 specifies if you want to send priority message.
 *        prmmsg - 8-bytes of data to be placed into parameter list.
 * Output: msgid - Specifies the message ID.
 * Return: Return code from CP IUCV call.
*/
int iucv_send_prmmsg (u16 pathid,
		      u32 * msgid,
		      u32 trgcls,
		      u32 srccls, u32 msgtag, int flags1, uchar prmmsg[8]);

/*
 * Name: iucv_send2way
 * Purpose: This function transmits data to another application.
 *          Data to be transmitted is in a buffer. The receiver
 *          of the send is expected to reply to the message and
 *          a buffer is provided into which IUCV moves the reply
 *          to this message.
 * Input: pathid - Path identification number.
 *        trgcls - Specifies target class.
 *        srccls - Specifies the source message class.
 *        msgtag - Specifies a tag associated with the message.
 *        flags1 - Option for path.
 *          IPPRTY- 0x20 Specifies if you want to send priority message.
 *        buffer - Address of send buffer.
 *        buflen - Length of send buffer.
 *        ansbuf - Address of buffer into which IUCV moves the reply of
 *                 this message.
 *        anslen - Address of length of buffer.
 * Output: msgid - Specifies the message ID.
 * Return: Return code from CP IUCV call.
 *         (-EINVAL) - Buffer or ansbuf address is NULL.
*/
int iucv_send2way (u16 pathid,
		   u32 * msgid,
		   u32 trgcls,
		   u32 srccls,
		   u32 msgtag,
		   int flags1,
		   void *buffer, ulong buflen, void *ansbuf, ulong anslen);

/*
 * Name: iucv_send2way_array
 * Purpose: This function transmits data to another application.
 *          The contents of buffer is the address of the array of
 *          addresses and lengths of discontiguous buffers that hold
 *          the message text. The receiver of the send is expected to
 *          reply to the message and a buffer is provided into which
 *          IUCV moves the reply to this message.
 * Input: pathid - Path identification number.
 *        trgcls - Specifies target class.
 *        srccls - Specifies the source message class.
 *        msgtag - Specifies a tag to be associated with the message.
 *        flags1 - Option for path.
 *          IPPRTY- 0x20 Specifies if you want to send priority message.
 *        buffer - Sddress of array of send buffers.
 *        buflen - Total length of send buffers.
 *        ansbuf - Address of array of buffer into which IUCV moves the reply
 *                 of this message.
 *        anslen - Address of length reply buffers.
 * Output: msgid - Specifies the message ID.
 * Return: Return code from CP IUCV call.
 *         (-EINVAL) - Buffer address is NULL.
*/
int iucv_send2way_array (u16 pathid,
			 u32 * msgid,
			 u32 trgcls,
			 u32 srccls,
			 u32 msgtag,
			 int flags1,
			 iucv_array_t * buffer,
			 ulong buflen, iucv_array_t * ansbuf, ulong anslen);

/*
 * Name: iucv_send2way_prmmsg
 * Purpose: This function transmits data to another application.
 *          Prmmsg specifies that the 8-bytes of data are to be moved
 *          into the parameter list. This is a two-way message and the
 *          receiver of the message is expected to reply. A buffer
 *          is provided into which IUCV moves the reply to this
 *          message.
 * Input: pathid - Rath identification number.
 *        trgcls - Specifies target class.
 *        srccls - Specifies the source message class.
 *        msgtag - Specifies a tag to be associated with the message.
 *        flags1 - Option for path.
 *          IPPRTY- 0x20 Specifies if you want to send priority message.
 *        prmmsg - 8-bytes of data to be placed in parameter list.
 *        ansbuf - Address of buffer into which IUCV moves the reply of
 *                 this message.
 *        anslen - Address of length of buffer.
 * Output: msgid - Specifies the message ID.
 * Return: Return code from CP IUCV call.
 *         (-EINVAL) - Buffer address is NULL.
*/
int iucv_send2way_prmmsg (u16 pathid,
			  u32 * msgid,
			  u32 trgcls,
			  u32 srccls,
			  u32 msgtag,
			  ulong flags1,
			  uchar prmmsg[8], void *ansbuf, ulong anslen);

/*
 * Name: iucv_send2way_prmmsg_array
 * Purpose: This function transmits data to another application.
 *          Prmmsg specifies that the 8-bytes of data are to be moved
 *          into the parameter list. This is a two-way message and the
 *          receiver of the message is expected to reply. A buffer
 *          is provided into which IUCV moves the reply to this
 *          message. The contents of ansbuf is the address of the
 *          array of addresses and lengths of discontiguous buffers
 *          that contain the reply.
 * Input: pathid - Path identification number.
 *        trgcls - Specifies target class.
 *        srccls - Specifies the source message class.
 *        msgtag - Specifies a tag to be associated with the message.
 *        flags1 - Option for path.
 *          IPPRTY- 0x20 specifies if you want to send priority message.
 *        prmmsg - 8-bytes of data to be placed into the parameter list.
 *        ansbuf - Address of array of buffer into which IUCV moves the reply
 *                 of this message.
 *        anslen - Address of length of reply buffers.
 * Output: msgid - Specifies the message ID.
 * Return: Return code from CP IUCV call.
 *         (-EINVAL) - Ansbuf address is NULL.
*/
int iucv_send2way_prmmsg_array (u16 pathid,
				u32 * msgid,
				u32 trgcls,
				u32 srccls,
				u32 msgtag,
				int flags1,
				uchar prmmsg[8],
				iucv_array_t * ansbuf, ulong anslen);

/*
 * Name: iucv_setmask
 * Purpose: This function enables or disables the following IUCV
 *          external interruptions: Nonpriority and priority message
 *          interrupts, nonpriority and priority reply interrupts.
 * Input: SetMaskFlag - options for interrupts
 *           0x80 - Nonpriority_MessagePendingInterruptsFlag
 *           0x40 - Priority_MessagePendingInterruptsFlag
 *           0x20 - Nonpriority_MessageCompletionInterruptsFlag
 *           0x10 - Priority_MessageCompletionInterruptsFlag
 *           0x08 - IUCVControlInterruptsFlag
 * Output: NA
 * Return: Return code from CP IUCV call.
*/
int iucv_setmask (int SetMaskFlag);

/*
 * Name: iucv_sever
 * Purpose: This function terminates an IUCV path.
 * Input: pathid - Path identification number.
 *        user_data - 16-bytes of user data.
 * Output: NA
 * Return: Return code from CP IUCV call.
 *         (-EINVAL) - Interal error, wild pointer.
*/
int iucv_sever (u16 pathid, uchar user_data[16]);