IXB28504XGBEFS Intel, IXB28504XGBEFS Datasheet - Page 294

• Manufacturer Part Number: IXB28504XGBEFS
• Manufacturer: Intel

Specifications of IXB28504XGBEFS

• Lead Free Status / Rohs Status: Compliant

E.2.1.3
Intel NetStructure
TPS
294
®
GbEMAC_Ioctl( )
Name
GbEMAC_Ioctl( )
Synopsis
void
(
)
Description
This function performs IOCTL operation on the driver.
Parameters
Returns
Note
The handle is used by the driver to check if the caller has the rights to operate the
device, (that is, whether it previously opened the ports).
The parameter arg_IoctlCommand specifies which operation to perform. The
arg_pIoctlStruct parameter structure specifies the port to be operated on in addition
to a pointer to a storage variable. This variable contains either the value used by a
change operation or the returned value at the completion of the operation.
The driver performs validation of the parameters and performs all set up actions
required for the operation (for example, resets, related registers check, etc.). The ioctl
commands that pertain to the global device registers ignore port numbers specified
within the arg_pIoctlStruct parameter structure.
Type
IN
IN
IN/OUT
Return Code
SUCCESS (=0)
ERROR_INVALID_HANDLE
IOCTL_BUFFER_POINTER_NULL
IOCLT_ERROR_INPUT_PORT_NUMBER_INVALID
ERROR_MAC_NOT_INITIALIZED
IOCTL_PORT_NOT_OPEN
IOCTL_ERROR_UNKNOWN_IOCTL_CODE
MODE_ALREADY_SET_IN_SPECIFIED_DUPLEX_MODE
ERROR_INVALID_DUPLEX_MODE
IXB2850 Packet Processing Boards
unsigned int *arg_Handle,
unsigned int arg_IoctlCommand,
void *arg_pIoctlStruct
GbEMAC_Ioctl
Name
arg_Handle
arg_IoctlCommand
arg_pIoctlStruct
Description
Pointer to handle obtained during device open call
IOCTL command to be executed
IOCTL structure that holds values that are read or should be written
from/to the driver
Description
Success
Invalid arg_Handle parameter
Parameter arg_pIoctlStruc is NULL
Port number in structure arg_pIoctlStruc is
invalid
Device was not initialized
Given port was not opened
Parameter arg_IoctlCommand is invalid
Specified duplex mode already set
Invalid duplex mode
IXB2850—Driver API Reference
Document Number: 05-2443-006
January 2007