CIO_HALT (Halt Device) sol_ioctl Serial Optical Link Device Handler Operation

Purpose

Note: This function is supported in AIX® 5.1 and earlier only.

Ends a session with the Serial Optical Link (SOL) device handler.

Description

The CIO_HALT operation ends a session with the SOL device handler. The caller indicates the network ID to halt. This CIO_HALT operation corresponds to the CIO_START operation successfully issued with the specified network ID. A CIO_HALT operation should be issued for each CIO_START operation successfully issued.

Data for the specified network ID is no longer received. Data received for the specified network ID before the halt is passed to a user-mode caller by the sol_select and sol_read entry points. Data is passed back to a kernel-mode caller by the rx_fn routine specified at open time.

For the CIO_HALT operation, the arg parameter points to the session_blk structure. This structure is defined in the /usr/include/sys/comio.h file and contains the following fields:

Field Description
status Returns one of the following status values:
  • CIO_OK
  • CIO_NETID_INV
netid Specifies the network ID. The network ID is placed in the least significant byte of the netid field.

The CIO_HALT operation functions with a Serial Link Adapter and Serial Optical Channel Converter that have been correctly configured for use on a qualified network. Consult hardware specifications for more information on configuring hardware and network qualifications.

Execution Environment

The CIO_HALT operation can be called from the process environment only.

Return Values

Item Description
EFAULT Indicates the specified address is not valid.
EINVAL Indicates the parameter is not valid.
EIO Indicates a general error. If an extension was provided in the call, additional data identifying the cause of the error can be found in the status field.
ENODEV Indicates the specified minor number is not valid.