@CHIP-RTOS C Library - TCP/IP API

Dev_Notify_Ioctl

Execute specific control functions on a TCP/IP device interface

int Dev_Notify_Ioctl( DevUserIfaceHandle DevHandlePtr,
                      int flag
                      void * optionPtr,
                      int optionLen,
                      int * error

Parameters

DevHandlePtr

Device handle

flag

The flag parameter specifies the requested functionality.
It is formed by ORing one or more of the following:
[0x4 - 0x0100] Device specific flags, other bits are reserved by TCP/IP

optionPtr

Specific parameters

optionLen

Length in bytes of specific parameters.

error

Output parameter:  Failure code, 0 on success.

Return Value

0: success
-1: failed

Comments

This API allows the user to call the driver I/O control function for executing special driver functions.
An example for a special function would be to request the current PHY tranceiver link status for an Ethernet device.

IOCTL Flags already used:
0x0001 : Called by TCPIP to inform about IPv4 configuration.
            optionPtr is a pointer to a structure of type @ref DevIpv4IfaceCfg
0x0002 : Not implemented yet, reserved for IPv6 configuration notification.
0x0200 : Reserved by TCPIP for future use.
0x0400 : Reserved by TCPIP for future use.
0x0800 : The driver should enable a multicast address.
            optionPtr points to a to array of multicast MAC addresses with optionLen addresses.
0x1000 : The driver should enable all multicast entries.
0x2000 : The driver should erase its internal multicast table.
0x4000 : Reserved by TCPIP for future use.
0x8000 : Reserved by Beck IPC for own device driver implementations.

RTOS API

This library function invokes a RTOS software interrupt documentation

Related Topics

TCP/IP Device Driver overview

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.35	V1.35

Supported by @CHIP-RTOS C Library since version

CLIB
V2.18