|
|
@@ -4,7 +4,7 @@
|
|
|
*
|
|
|
* S390 version
|
|
|
* Copyright (C) 2000 IBM Corporation
|
|
|
- * Author(s):Alan Altmark (Alan_Altmark@us.ibm.com)
|
|
|
+ * Author(s):Alan Altmark (Alan_Altmark@us.ibm.com)
|
|
|
* Xenia Tkatschow (xenia@us.ibm.com)
|
|
|
*
|
|
|
*
|
|
|
@@ -16,17 +16,17 @@
|
|
|
* CP Programming Services book, also available on the web
|
|
|
* thru www.ibm.com/s390/vm/pubs, manual # SC24-5760
|
|
|
*
|
|
|
- * Definition of Return Codes
|
|
|
- * -All positive return codes including zero are reflected back
|
|
|
- * from CP except for iucv_register_program. The definition of each
|
|
|
- * return code can be found in CP Programming Services book.
|
|
|
- * Also available on the web thru www.ibm.com/s390/vm/pubs, manual # SC24-5760
|
|
|
- * - Return Code of:
|
|
|
- * (-EINVAL) Invalid value
|
|
|
- * (-ENOMEM) storage allocation failed
|
|
|
+ * Definition of Return Codes
|
|
|
+ * -All positive return codes including zero are reflected back
|
|
|
+ * from CP except for iucv_register_program. The definition of each
|
|
|
+ * return code can be found in CP Programming Services book.
|
|
|
+ * Also available on the web thru www.ibm.com/s390/vm/pubs, manual # SC24-5760
|
|
|
+ * - Return Code of:
|
|
|
+ * (-EINVAL) Invalid value
|
|
|
+ * (-ENOMEM) storage allocation failed
|
|
|
* pgmask defined in iucv_register_program will be set depending on input
|
|
|
- * paramters.
|
|
|
- *
|
|
|
+ * paramters.
|
|
|
+ *
|
|
|
*/
|
|
|
|
|
|
#include <linux/types.h>
|
|
|
@@ -124,13 +124,13 @@ iucv_hex_dump(unsigned char *buf, size_t len)
|
|
|
#define iucv_handle_t void *
|
|
|
|
|
|
/* flags1:
|
|
|
- * All flags are defined in the field IPFLAGS1 of each function
|
|
|
- * and can be found in CP Programming Services.
|
|
|
- * IPLOCAL - Indicates the connect can only be satisfied on the
|
|
|
- * local system
|
|
|
- * IPPRTY - Indicates a priority message
|
|
|
- * IPQUSCE - Indicates you do not want to receive messages on a
|
|
|
- * path until an iucv_resume is issued
|
|
|
+ * All flags are defined in the field IPFLAGS1 of each function
|
|
|
+ * and can be found in CP Programming Services.
|
|
|
+ * IPLOCAL - Indicates the connect can only be satisfied on the
|
|
|
+ * local system
|
|
|
+ * IPPRTY - Indicates a priority message
|
|
|
+ * IPQUSCE - Indicates you do not want to receive messages on a
|
|
|
+ * path until an iucv_resume is issued
|
|
|
* IPRMDATA - Indicates that the message is in the parameter list
|
|
|
*/
|
|
|
#define IPLOCAL 0x01
|
|
|
@@ -154,14 +154,14 @@ iucv_hex_dump(unsigned char *buf, size_t len)
|
|
|
#define AllInterrupts 0xf8
|
|
|
/*
|
|
|
* Mapping of external interrupt buffers should be used with the corresponding
|
|
|
- * interrupt types.
|
|
|
- * Names: iucv_ConnectionPending -> connection pending
|
|
|
+ * interrupt types.
|
|
|
+ * Names: iucv_ConnectionPending -> connection pending
|
|
|
* iucv_ConnectionComplete -> connection complete
|
|
|
- * iucv_ConnectionSevered -> connection severed
|
|
|
- * iucv_ConnectionQuiesced -> connection quiesced
|
|
|
- * iucv_ConnectionResumed -> connection resumed
|
|
|
- * iucv_MessagePending -> message pending
|
|
|
- * iucv_MessageComplete -> message complete
|
|
|
+ * iucv_ConnectionSevered -> connection severed
|
|
|
+ * iucv_ConnectionQuiesced -> connection quiesced
|
|
|
+ * iucv_ConnectionResumed -> connection resumed
|
|
|
+ * iucv_MessagePending -> message pending
|
|
|
+ * iucv_MessageComplete -> message complete
|
|
|
*/
|
|
|
typedef struct {
|
|
|
u16 ippathid;
|
|
|
@@ -260,16 +260,16 @@ typedef struct {
|
|
|
uchar res2[3];
|
|
|
} iucv_MessageComplete;
|
|
|
|
|
|
-/*
|
|
|
- * iucv_interrupt_ops_t: Is a vector of functions that handle
|
|
|
- * IUCV interrupts.
|
|
|
- * Parameter list:
|
|
|
- * eib - is a pointer to a 40-byte area described
|
|
|
- * with one of the structures above.
|
|
|
- * pgm_data - this data is strictly for the
|
|
|
- * interrupt handler that is passed by
|
|
|
- * the application. This may be an address
|
|
|
- * or token.
|
|
|
+/*
|
|
|
+ * iucv_interrupt_ops_t: Is a vector of functions that handle
|
|
|
+ * IUCV interrupts.
|
|
|
+ * Parameter list:
|
|
|
+ * eib - is a pointer to a 40-byte area described
|
|
|
+ * with one of the structures above.
|
|
|
+ * pgm_data - this data is strictly for the
|
|
|
+ * interrupt handler that is passed by
|
|
|
+ * the application. This may be an address
|
|
|
+ * or token.
|
|
|
*/
|
|
|
typedef struct {
|
|
|
void (*ConnectionPending) (iucv_ConnectionPending * eib,
|
|
|
@@ -287,8 +287,8 @@ typedef struct {
|
|
|
} iucv_interrupt_ops_t;
|
|
|
|
|
|
/*
|
|
|
- *iucv_array_t : Defines buffer array.
|
|
|
- * Inside the array may be 31- bit addresses and 31-bit lengths.
|
|
|
+ *iucv_array_t : Defines buffer array.
|
|
|
+ * Inside the array may be 31- bit addresses and 31-bit lengths.
|
|
|
*/
|
|
|
typedef struct {
|
|
|
u32 address;
|
|
|
@@ -299,19 +299,19 @@ extern struct bus_type iucv_bus;
|
|
|
extern struct device *iucv_root;
|
|
|
|
|
|
/* -prototypes- */
|
|
|
-/*
|
|
|
- * Name: iucv_register_program
|
|
|
- * Purpose: Registers an application with IUCV
|
|
|
- * Input: prmname - user identification
|
|
|
+/*
|
|
|
+ * Name: iucv_register_program
|
|
|
+ * Purpose: Registers an application with IUCV
|
|
|
+ * Input: prmname - user identification
|
|
|
* userid - machine identification
|
|
|
* pgmmask - indicates which bits in the prmname and userid combined will be
|
|
|
* used to determine who is given control
|
|
|
- * ops - address of vector of interrupt handlers
|
|
|
- * pgm_data- application data passed to interrupt handlers
|
|
|
- * Output: NA
|
|
|
- * Return: address of handler
|
|
|
+ * ops - address of vector of interrupt handlers
|
|
|
+ * pgm_data- application data passed to interrupt handlers
|
|
|
+ * Output: NA
|
|
|
+ * Return: address of handler
|
|
|
* (0) - Error occurred, registration not completed.
|
|
|
- * NOTE: Exact cause of failure will be recorded in syslog.
|
|
|
+ * NOTE: Exact cause of failure will be recorded in syslog.
|
|
|
*/
|
|
|
iucv_handle_t iucv_register_program (uchar pgmname[16],
|
|
|
uchar userid[8],
|
|
|
@@ -319,13 +319,13 @@ iucv_handle_t iucv_register_program (uchar pgmname[16],
|
|
|
iucv_interrupt_ops_t * ops,
|
|
|
void *pgm_data);
|
|
|
|
|
|
-/*
|
|
|
- * Name: iucv_unregister_program
|
|
|
- * Purpose: Unregister application with IUCV
|
|
|
- * Input: address of handler
|
|
|
- * Output: NA
|
|
|
- * Return: (0) - Normal return
|
|
|
- * (-EINVAL) - Internal error, wild pointer
|
|
|
+/*
|
|
|
+ * Name: iucv_unregister_program
|
|
|
+ * Purpose: Unregister application with IUCV
|
|
|
+ * Input: address of handler
|
|
|
+ * Output: NA
|
|
|
+ * Return: (0) - Normal return
|
|
|
+ * (-EINVAL) - Internal error, wild pointer
|
|
|
*/
|
|
|
int iucv_unregister_program (iucv_handle_t handle);
|
|
|
|
|
|
@@ -333,7 +333,7 @@ int iucv_unregister_program (iucv_handle_t handle);
|
|
|
* Name: iucv_accept
|
|
|
* Purpose: This function is issued after the user receives a Connection Pending external
|
|
|
* interrupt and now wishes to complete the IUCV communication path.
|
|
|
- * Input: pathid - u16 , Path identification number
|
|
|
+ * Input: pathid - u16 , Path identification number
|
|
|
* msglim_reqstd - u16, The number of outstanding messages requested.
|
|
|
* user_data - uchar[16], Data specified by the iucv_connect function.
|
|
|
* flags1 - int, Contains options for this path.
|
|
|
@@ -358,34 +358,34 @@ int iucv_accept (u16 pathid,
|
|
|
void *pgm_data, int *flags1_out, u16 * msglim);
|
|
|
|
|
|
/*
|
|
|
- * Name: iucv_connect
|
|
|
+ * Name: iucv_connect
|
|
|
* Purpose: This function establishes an IUCV path. Although the connect may complete
|
|
|
- * successfully, you are not able to use the path until you receive an IUCV
|
|
|
- * Connection Complete external interrupt.
|
|
|
- * Input: pathid - u16 *, Path identification number
|
|
|
- * msglim_reqstd - u16, Number of outstanding messages requested
|
|
|
- * user_data - uchar[16], 16-byte user data
|
|
|
+ * successfully, you are not able to use the path until you receive an IUCV
|
|
|
+ * Connection Complete external interrupt.
|
|
|
+ * Input: pathid - u16 *, Path identification number
|
|
|
+ * msglim_reqstd - u16, Number of outstanding messages requested
|
|
|
+ * user_data - uchar[16], 16-byte user data
|
|
|
* userid - uchar[8], User identification
|
|
|
- * system_name - uchar[8], 8-byte identifying the system name
|
|
|
+ * system_name - uchar[8], 8-byte identifying the system name
|
|
|
* flags1 - int, Contains options for this path.
|
|
|
* -IPPRTY - 0x20, Specifies if you want to send priority message.
|
|
|
* -IPRMDATA - 0x80, Specifies whether your program can handle a message
|
|
|
* in the parameter list.
|
|
|
- * -IPQUSCE - 0x40, Specifies whether you want to quiesce the path being
|
|
|
+ * -IPQUSCE - 0x40, Specifies whether you want to quiesce the path being
|
|
|
* established.
|
|
|
- * -IPLOCAL - 0X01, Allows an application to force the partner to be on
|
|
|
+ * -IPLOCAL - 0X01, Allows an application to force the partner to be on
|
|
|
* the local system. If local is specified then target class cannot be
|
|
|
- * specified.
|
|
|
+ * specified.
|
|
|
* flags1_out - int * Contains information about the path
|
|
|
* - IPPRTY - 0x20, Indicates you may send priority messages.
|
|
|
* msglim - * u16, Number of outstanding messages
|
|
|
- * handle - iucv_handle_t, Address of handler
|
|
|
- * pgm_data - void *, Application data passed to interrupt handlers
|
|
|
+ * handle - iucv_handle_t, Address of handler
|
|
|
+ * pgm_data - void *, Application data passed to interrupt handlers
|
|
|
* Output: return code from CP IUCV call
|
|
|
* rc - return code from iucv_declare_buffer
|
|
|
- * -EINVAL - Invalid handle passed by application
|
|
|
- * -EINVAL - Pathid address is NULL
|
|
|
- * add_pathid_result - Return code from internal function add_pathid
|
|
|
+ * -EINVAL - Invalid handle passed by application
|
|
|
+ * -EINVAL - Pathid address is NULL
|
|
|
+ * add_pathid_result - Return code from internal function add_pathid
|
|
|
*/
|
|
|
int
|
|
|
iucv_connect (u16 * pathid,
|
|
|
@@ -397,16 +397,16 @@ int
|
|
|
int *flags1_out,
|
|
|
u16 * msglim, iucv_handle_t handle, void *pgm_data);
|
|
|
|
|
|
-/*
|
|
|
- * Name: iucv_purge
|
|
|
- * Purpose: This function cancels a message that you have sent.
|
|
|
- * Input: pathid - Path identification number.
|
|
|
+/*
|
|
|
+ * Name: iucv_purge
|
|
|
+ * Purpose: This function cancels a message that you have sent.
|
|
|
+ * Input: pathid - Path identification number.
|
|
|
* msgid - Specifies the message ID of the message to be purged.
|
|
|
- * srccls - Specifies the source message class.
|
|
|
- * Output: audit - Contains information about asynchronous error
|
|
|
- * that may have affected the normal completion
|
|
|
- * of this message.
|
|
|
- * Return: Return code from CP IUCV call.
|
|
|
+ * srccls - Specifies the source message class.
|
|
|
+ * Output: audit - Contains information about asynchronous error
|
|
|
+ * that may have affected the normal completion
|
|
|
+ * of this message.
|
|
|
+ * Return: Return code from CP IUCV call.
|
|
|
*/
|
|
|
int iucv_purge (u16 pathid, u32 msgid, u32 srccls, __u32 *audit);
|
|
|
/*
|
|
|
@@ -426,38 +426,38 @@ ulong iucv_query_maxconn (void);
|
|
|
*/
|
|
|
ulong iucv_query_bufsize (void);
|
|
|
|
|
|
-/*
|
|
|
- * Name: iucv_quiesce
|
|
|
- * Purpose: This function temporarily suspends incoming messages on an
|
|
|
- * IUCV path. You can later reactivate the path by invoking
|
|
|
- * the iucv_resume function.
|
|
|
- * Input: pathid - Path identification number
|
|
|
- * user_data - 16-bytes of user data
|
|
|
- * Output: NA
|
|
|
- * Return: Return code from CP IUCV call.
|
|
|
+/*
|
|
|
+ * Name: iucv_quiesce
|
|
|
+ * Purpose: This function temporarily suspends incoming messages on an
|
|
|
+ * IUCV path. You can later reactivate the path by invoking
|
|
|
+ * the iucv_resume function.
|
|
|
+ * Input: pathid - Path identification number
|
|
|
+ * user_data - 16-bytes of user data
|
|
|
+ * Output: NA
|
|
|
+ * Return: Return code from CP IUCV call.
|
|
|
*/
|
|
|
int iucv_quiesce (u16 pathid, uchar user_data[16]);
|
|
|
|
|
|
-/*
|
|
|
- * Name: iucv_receive
|
|
|
- * Purpose: This function receives messages that are being sent to you
|
|
|
+/*
|
|
|
+ * Name: iucv_receive
|
|
|
+ * Purpose: This function receives messages that are being sent to you
|
|
|
* over established paths. Data will be returned in buffer for length of
|
|
|
* buflen.
|
|
|
- * Input:
|
|
|
- * pathid - Path identification number.
|
|
|
- * buffer - Address of buffer to receive.
|
|
|
- * buflen - Length of buffer to receive.
|
|
|
- * msgid - Specifies the message ID.
|
|
|
- * trgcls - Specifies target class.
|
|
|
- * Output:
|
|
|
+ * Input:
|
|
|
+ * pathid - Path identification number.
|
|
|
+ * buffer - Address of buffer to receive.
|
|
|
+ * buflen - Length of buffer to receive.
|
|
|
+ * msgid - Specifies the message ID.
|
|
|
+ * trgcls - Specifies target class.
|
|
|
+ * Output:
|
|
|
* flags1_out: int *, Contains information about this path.
|
|
|
* IPNORPY - 0x10 Specifies this is a one-way message and no reply is
|
|
|
- * expected.
|
|
|
- * IPPRTY - 0x20 Specifies if you want to send priority message.
|
|
|
+ * expected.
|
|
|
+ * IPPRTY - 0x20 Specifies if you want to send priority message.
|
|
|
* IPRMDATA - 0x80 specifies the data is contained in the parameter list
|
|
|
* residual_buffer - address of buffer updated by the number
|
|
|
* of bytes you have received.
|
|
|
- * residual_length -
|
|
|
+ * residual_length -
|
|
|
* Contains one of the following values, if the receive buffer is:
|
|
|
* The same length as the message, this field is zero.
|
|
|
* Longer than the message, this field contains the number of
|
|
|
@@ -466,8 +466,8 @@ int iucv_quiesce (u16 pathid, uchar user_data[16]);
|
|
|
* count (that is, the number of bytes remaining in the
|
|
|
* message that does not fit into the buffer. In this
|
|
|
* case b2f0_result = 5.
|
|
|
- * Return: Return code from CP IUCV call.
|
|
|
- * (-EINVAL) - buffer address is pointing to NULL
|
|
|
+ * Return: Return code from CP IUCV call.
|
|
|
+ * (-EINVAL) - buffer address is pointing to NULL
|
|
|
*/
|
|
|
int iucv_receive (u16 pathid,
|
|
|
u32 msgid,
|
|
|
@@ -477,16 +477,16 @@ int iucv_receive (u16 pathid,
|
|
|
int *flags1_out,
|
|
|
ulong * residual_buffer, ulong * residual_length);
|
|
|
|
|
|
- /*
|
|
|
- * Name: iucv_receive_array
|
|
|
- * Purpose: This function receives messages that are being sent to you
|
|
|
+ /*
|
|
|
+ * Name: iucv_receive_array
|
|
|
+ * Purpose: This function receives messages that are being sent to you
|
|
|
* over established paths. Data will be returned in first buffer for
|
|
|
* length of first buffer.
|
|
|
- * Input: pathid - Path identification number.
|
|
|
+ * Input: pathid - Path identification number.
|
|
|
* msgid - specifies the message ID.
|
|
|
* trgcls - Specifies target class.
|
|
|
- * buffer - Address of array of buffers.
|
|
|
- * buflen - Total length of buffers.
|
|
|
+ * buffer - Address of array of buffers.
|
|
|
+ * buflen - Total length of buffers.
|
|
|
* Output:
|
|
|
* flags1_out: int *, Contains information about this path.
|
|
|
* IPNORPY - 0x10 Specifies this is a one-way message and no reply is
|
|
|
@@ -504,8 +504,8 @@ int iucv_receive (u16 pathid,
|
|
|
* count (that is, the number of bytes remaining in the
|
|
|
* message 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.
|
|
|
+ * Return: Return code from CP IUCV call.
|
|
|
+ * (-EINVAL) - Buffer address is NULL.
|
|
|
*/
|
|
|
int iucv_receive_array (u16 pathid,
|
|
|
u32 msgid,
|
|
|
@@ -515,44 +515,44 @@ int iucv_receive_array (u16 pathid,
|
|
|
int *flags1_out,
|
|
|
ulong * residual_buffer, ulong * residual_length);
|
|
|
|
|
|
-/*
|
|
|
- * Name: iucv_reject
|
|
|
- * Purpose: The reject function refuses a specified message. Between the
|
|
|
- * time you are notified of a message and the time that you
|
|
|
- * complete the message, the message may be rejected.
|
|
|
- * Input: pathid - Path identification number.
|
|
|
- * msgid - Specifies the message ID.
|
|
|
- * trgcls - Specifies target class.
|
|
|
- * Output: NA
|
|
|
- * Return: Return code from CP IUCV call.
|
|
|
+/*
|
|
|
+ * Name: iucv_reject
|
|
|
+ * Purpose: The reject function refuses a specified message. Between the
|
|
|
+ * time you are notified of a message and the time that you
|
|
|
+ * complete the message, the message may be rejected.
|
|
|
+ * Input: pathid - Path identification number.
|
|
|
+ * msgid - Specifies the message ID.
|
|
|
+ * trgcls - Specifies target class.
|
|
|
+ * Output: NA
|
|
|
+ * Return: Return code from CP IUCV call.
|
|
|
*/
|
|
|
int iucv_reject (u16 pathid, u32 msgid, u32 trgcls);
|
|
|
|
|
|
-/*
|
|
|
- * Name: iucv_reply
|
|
|
- * 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.
|
|
|
- * Input: pathid - Path identification number.
|
|
|
- * msgid - Specifies the message ID.
|
|
|
- * trgcls - Specifies target class.
|
|
|
+/*
|
|
|
+ * Name: iucv_reply
|
|
|
+ * 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.
|
|
|
+ * 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 reply buffer.
|
|
|
- * buflen - Length of reply buffer.
|
|
|
- * Output: residual_buffer - Address of buffer updated by the number
|
|
|
- * of bytes you have moved.
|
|
|
+ * IPPRTY- 0x20, Specifies if you want to send priority message.
|
|
|
+ * buffer - Address of reply buffer.
|
|
|
+ * buflen - Length of reply buffer.
|
|
|
+ * Output: residual_buffer - Address of buffer updated by the number
|
|
|
+ * of bytes you have moved.
|
|
|
* 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.
|
|
|
+ * 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.
|
|
|
+ * Return: Return code from CP IUCV call.
|
|
|
+ * (-EINVAL) - Buffer address is NULL.
|
|
|
*/
|
|
|
int iucv_reply (u16 pathid,
|
|
|
u32 msgid,
|
|
|
@@ -561,20 +561,20 @@ int iucv_reply (u16 pathid,
|
|
|
void *buffer, ulong buflen, ulong * residual_buffer,
|
|
|
ulong * residual_length);
|
|
|
|
|
|
-/*
|
|
|
- * Name: iucv_reply_array
|
|
|
- * 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.
|
|
|
- * 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.
|
|
|
+/*
|
|
|
+ * Name: iucv_reply_array
|
|
|
+ * 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.
|
|
|
+ * 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.
|
|
|
+ * 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
|
|
|
@@ -585,8 +585,8 @@ int iucv_reply (u16 pathid,
|
|
|
* 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.
|
|
|
+ * Return: Return code from CP IUCV call.
|
|
|
+ * (-EINVAL) - Buffer address is NULL.
|
|
|
*/
|
|
|
int iucv_reply_array (u16 pathid,
|
|
|
u32 msgid,
|
|
|
@@ -596,77 +596,77 @@ int iucv_reply_array (u16 pathid,
|
|
|
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.
|
|
|
+/*
|
|
|
+ * 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.
|
|
|
+ * 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.
|
|
|
+/*
|
|
|
+ * 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.
|
|
|
+/*
|
|
|
+ * 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.
|
|
|
+ * 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.
|
|
|
+/*
|
|
|
+ * 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.
|
|
|
+ * 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,
|
|
|
@@ -675,48 +675,48 @@ int iucv_send_array (u16 pathid,
|
|
|
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.
|
|
|
+/*
|
|
|
+ * 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.
|
|
|
+ * 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.
|
|
|
+/*
|
|
|
+ * 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.
|
|
|
+ * 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,
|
|
|
@@ -726,28 +726,28 @@ int iucv_send2way (u16 pathid,
|
|
|
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.
|
|
|
+/*
|
|
|
+ * 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.
|
|
|
+ * 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,
|
|
|
@@ -758,27 +758,27 @@ int iucv_send2way_array (u16 pathid,
|
|
|
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.
|
|
|
+/*
|
|
|
+ * 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
|
|
|
+ * 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.
|
|
|
+ * 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,
|
|
|
@@ -788,29 +788,29 @@ int iucv_send2way_prmmsg (u16 pathid,
|
|
|
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.
|
|
|
+/*
|
|
|
+ * 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.
|
|
|
+ * 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.
|
|
|
+ * 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,
|
|
|
@@ -821,29 +821,29 @@ int iucv_send2way_prmmsg_array (u16 pathid,
|
|
|
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.
|
|
|
+/*
|
|
|
+ * 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
|
|
|
+ * 0x80 - Nonpriority_MessagePendingInterruptsFlag
|
|
|
+ * 0x40 - Priority_MessagePendingInterruptsFlag
|
|
|
+ * 0x20 - Nonpriority_MessageCompletionInterruptsFlag
|
|
|
+ * 0x10 - Priority_MessageCompletionInterruptsFlag
|
|
|
* 0x08 - IUCVControlInterruptsFlag
|
|
|
- * Output: NA
|
|
|
- * Return: Return code from CP IUCV call.
|
|
|
+ * 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.
|
|
|
+/*
|
|
|
+ * 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]);
|
Jeff Garzik