z/OS Cryptographic Services ICSF Application Programmer's Guide
Previous topic | Next topic | Contents | Index | Contact z/OS | Library | PDF


Parameters

z/OS Cryptographic Services ICSF Application Programmer's Guide
SA22-7522-16

return_code
Direction: OutputType: Integer

The return code specifies the general result of the callable service. See Appendix A. ICSF and TSS Return and Reason Codes, for a list of return codes.

reason_code
Direction: OutputType: Integer

The reason code specifies the result of the callable service that is returned to the application program. Each return code has different reason codes that indicate specific processing problems. See Appendix A. ICSF and TSS Return and Reason Codes for a list of reason codes.

exit_data_length
Direction: Input/OutputType: Integer

The length of the data that is passed to the installation exit. The length can be from X'00000000' to X'7FFFFFFF' (2 gigabytes). The data is identified in the exit_data parameter.

exit_data
Direction: Input/OutputType: String

The data that is passed to the installation exit.

rule_array_count
Direction: InputType: Integer

The number of keywords you are supplying in rule_array. The value must be 1.

rule_array
Direction: InputType: String

Keyword that provides control information to callable services. The keyword is left-justified in an 8-byte field and padded on the right with blanks. The keyword must be in contiguous storage. These keywords are mutually exclusive:

Table 280. Keywords for PCI Interface Callable Service
KeywordMeaning
ACPOINTSQueries the list of access control points which may be enabled or disabled by a TKE user.
ACTIVECPThis keyword is a request to call the PCI card initialization code to revalidate the PCI cards. When the PCI card initialization is completed, both the 64-bit mask indicating which of the PCI cards are online and 64-bit mask indicating which of the PCI cards are active will be returned. This keyword is used by the TKE workstation code after the ACTIVATE portion of the domain zeroize command. This is to ensure that the status of the PCI card is accurately reflected to the users. See the masks_data parameter description for more information.
APNUMSpecifies the target_pci_coprocessor field to be used.
SERIALNOSpecifies the target_pci_coprocessor_number field to be used
PCIMASKSThis keyword is a request to return both the 64-bit mask indicating which of the PCI cards are online and 64-bit mask indicating which of the PCI cards are active. See the masks_data parameter description for more information.
XCPMASKThis keyword is a request to return both the 64-bit mask indicating which of the PCIXCCs, CEX2Cs, and CEX3Cs are online and the 64-bit mask indicating which of the PCIXCCs, CEX2Cs, and CEX3Cs are active. See the masks_data parameter description for more information.
CX2MASKThis keyword is a request to return both the 64-bit mask indicating which of the CEX2Cs are online and the 64-bit mask indicating which of the CEX2Cs are active. See the masks_data parameter description for more information.
CX3MASKThis keyword is a request to return both the 64-bit mask indicating which of the CEX3Cs are online and the 64-bit mask indicating which of the CEX3Cs are active. See the masks_data parameter description for more information.
Note:
When the PCIMASKS, ACTIVECP, XCPMASK, CX2MASK and CX3MASK keywords are specified, the request_data_block_length, request_data_block, reply_data_block_length, and the reply_data_block parameters are ignored.
target_pci_coprocessor
Direction: InputType: Integer

The PCICC, PCIXCC, CEX2C, or CEX3C card to which this request is directed. Valid values are between 0 and 64.

target_pci_coprocessor_serial_number
Direction: Input/OutputType: String

The PCICC, PCIXCC, CEX2C, or CEX3C card serial number to which the request is directed. This parameter may be used instead of the target_pci_coprocessor. The length is 8 bytes. This parameter is updated with the serial number of the card if the request was successfully processed.

request_block_length
Direction: InputType: Integer

Length of CPRB and the request block in the request_block field. The maximum length allowed is 5,500 bytes.

request_block
Direction: InputType: String

PCICC, PCIXCC, CEX2C, or CEX3C command or query request for the target PCICC, PCIXCC, CEX2C, or CEX3C. This is the complete CPRB and request block to be processed by the PCICC, PCIXCC, CEX2C, or CEX3C.

request_data_block_length
Direction: InputType: Integer

Length of request data block in the request_data_block field. The maximum length allowed is 6,400 bytes. The length field must be a multiple of 4.

request_data_block
Direction: InputType: String

The data that accompanies the request_block field.

reply_block_length
Direction: Input/OutputType: Integer

Length of CPRB and the reply block in the reply_block field. The maximum length allowed is 5,500 bytes. This field is updated on output with the actual length of the reply_block field.

reply_block
Direction: OutputType: String

Reply from the target PCICC, PCIXCC, CEX2C, or CEX3C. This is the CPRB and reply block that has been processed by the PCICC, PCIXCC, CEX2C, or CEX3C.

reply_data_block_length
Direction: Input/OutputType: Integer

Length of reply block in the reply_data_block field. The maximum length allowed is 6,400 bytes. This field is updated on output with the actual length of the reply_data_block field. This length field must be a multiple of 4. For the ACPOINTS keyword, the minimum length is 2572 bytes.

reply_data_block
Direction: OutputType: String

The data that accompanies the reply_block field.

masks_length
Direction: InputType: Integer

Length of the reply data being returned in the masks_data field. The length must be 32 bytes. This field is only valid when the input rule_array keyword is PCIMASKS, ACTIVECP XCPMASK, CX2MASK, CX3MASK. For all other rule_array keywords, this field is ignored.

masks_data
Direction: OutputType: String

The data being returned for all requests. The first 8 bytes indicate the count of the PCI cards online. The second 8 bytes indicate a bit mask of the actual PCI cards brought online. The third 8 bytes indicate the count of the PCI cards active. The fourth 8 bytes indicate a bit mask of the actual PCI cards that are active. For the ACTIVECP keyword, if the PCI card initialization failed, the appropriate return code and reason code is issued and the masks_data field will contain zeros.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014