ENT_SET_MULTI (Set Multicast Address) entioctl Ethernet Device Handler Operation

Kernel and Subsystems Technical Reference, Volume 2

ENT_SET_MULTI (Set Multicast Address) entioctl Ethernet Device Handler Operation

Purpose

Sets the multicast address for the Ethernet device.

Description

The ENT_SET_MULTI operation sets the multicast address for the Ethernet device. For this operation, the arg parameter points to the ent_set_multi_t structure. This structure is defined in the /usr/include/sys/entuser.h file and contains the following fields:

`opcode`	Specifies whether to add or delete a multicast address. When this field is ENT_ADD, the multicast address is added to the multicast entry table. When this field is ENT_DEL, the multicast address is removed from the multicast entry table. Valid Ethernet types are defined in the /usr/include/sys/entuser.h file.
`multi_addr(6)`	Identifies the multicast address array where the `multi_addr(0)` field specifies the most significant byte and the `multi_addr(5)` field specifies the least significant byte.

Note: The Ethernet device handler allows a maximum of 10 multicast addresses.

Execution Environment

An ENT_SET_MULTI operation can be called from the process environment only.

Return Values

The return codes for the ENT_SET_MULTI operation are:

EFAULT	Indicates the specified address is not valid.
EINVAL	Indicates the operation code is not valid.
ENOSPC	Indicates no space was left on the device. The multicast table is full.
ENOTREADY	Indicates the device was not ready. (The first CIO_START operation was not issued and not completed.)
EACCES	Indicates permission was denied. (The device was open in Diagnostic mode.)
EAFNOSUPPORT	Indicates the address family was not supported by protocol. (The multicast bit in the address was not set.)
ENXIO	Indicates no such device exists.

Implementation Specifics

The ENT_SET_MULTI operation functions with an Ethernet High-Performance LAN adapter that has been correctly configured for use on a qualified network. Consult the adapter specifications for more information on configuring the network adapter and network qualifications.

Related Information

The CIO_START entioctl Ethernet Device Handler Operation.