[ Bottom of Page | Previous Page | Next Page | Contents | Index | Library Home | Legal | Search ]

Technical Reference: Kernel and Subsystems, Volume 2

CIO_HALT (Halt Device) tokioctl Token-Ring Device Handler Operation


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

Ends a session with the token-ring device handler.


The CIO_HALT tokioctl operation ends a session with the token-ring 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.

Data for the specified network ID is no longer received. Data received for the specified network ID, before the halt, is still passed up to a user-mode caller by tokselect and tokread 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:
netid Specifies the network ID. The network ID is placed in the least significant byte of the netid field. When terminating the medium-access control (MAC) frame session, the netid field should be set to TOK_MAC_FRAME_NETID.

The CIO_HALT operation functions with a Token-Ring High Performance Network Adapter that has been correctly configured for use on a qualified network. Consult adapter specifications for more information on configuring the adapter and network qualifications.

Execution Environment

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

Return Values

EFAULT Indicates the specified address is not valid.
EINVAL Indicates a parameter is not valid.
ENOMSG Indicates an error occurred.

Related Information

The ddioctl (CIO_HALT) operation.

The CIO_GET_STAT tokioctl Token-Ring Device Handler Operation, CIO_START tokioctl Token-Ring Device Handler Operation.

The tokselect entry point, tokread entry point, tokioctl entry point.

Common Communications Status and Exception Codes in AIX 5L Version 5.2 Kernel Extensions and Device Support Programming Concepts.

[ Top of Page | Previous Page | Next Page | Contents | Index | Library Home | Legal | Search ]