@CHIP-RTOS C Library - TCP/IP API

Dev_Close_Interface

Close user device driver/interface.

int Dev_Close_Interface(DevUserIfaceHandle DevHandlePtr,
                int * errorcode);

Parameters

DevHandlePtr

Device handle

errorcode

Output parameter:  Failure code, 0 on success.

Return Value

0: success
-1: See reported errorcode .

Comments

Note that closing a device driver does not remove that device from the system.   Once a device has been installed, there is no mechanism short of a system reset to remove that device from the TCP/IP stack.

Before a device driver program terminates, it is important to call this API on the installed TCP/IP device.   This will allow a subsequent instance of that driver program to successfully use the Dev_Open_Interface() to reestablish the device's operation with connections made to the new program instance.

See Also

Dev_Open_Interface                

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

On SC1x3/SC2x (RTOS version >=1.13, CLIB version >=2.10) there's also a version of this function which uses dynamic linking instead of a software interrupt, which reduces the function's overhead and thus speeds up your application. This function's name is Dev_Close_Interface_Dyn. You should however not use this function directly. Instead you should add the define TCPIP_DYN_LINK_DEV to your program before including the CLIB's header file(s):

#define TCPIP_DYN_LINK_DEV
#include <clib.h>

This will map the original function's name to the dynamic linking version. This way you can also easily switch existing programs to dynamic linking.

Related Topics

Example - Closing device driver

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.10	V1.00	V1.00	V0.90	V1.00