IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


Deprecated List

Global Add_IGMP_Membership

This legacy function can be replaced by AddMulticastIPv4().
It is only left for backward compatibility.

Global AddArpEntry

This legacy function can be replaced by SetArpEntry() and is only left for backward compatibility.

Global AddDefaultGateway

This legacy function can be replaced by SetDefaultGateway() and is only left for backward compatibility.

Global AddDefaultGatewayEx

This legacy function can be replaced by SetDefaultGateway() and is only left for backward compatibility.

Global AddStaticRoute

This legacy function can be replaced by SetStaticRoute() and is only left for backward compatibility.

Global AddStaticRouteEx

This legacy function can be replaced by SetStaticRoute() and is only left for backward compatibility.

Global api_sleep
Use RTX_Sleep_Time() instead

Global BIOS_Connection_Handler
Use RegisterSrvConnCbHandler instead

Global BIOS_Ethernet_State

Use ethGetMode instead

Global BIOS_Get_Device_Names
Use BIOS_Get_Device_NamesEx instead

Global BIOS_Get_Features
This function is only provided for compatibility.

Global BIOS_Get_PPPClient_IP
See PPP_Client_GetIP()

Global BIOS_Get_PPPServer_IP
See PPP_Server_GetIP()

Global BIOS_Install_Error_Handler
See BIOS_Set_Error_Handler()

Global BIOS_Install_UDP_Cfg_Callback
Use RegisterUdpCfgCbHandler instead

Global BIOS_Server_On_Off
Use ServerControl instead

Global BIOS_Server_State
Use ServerState instead

Page CHIP.INI [USB]
This setting has no effect on SC2x3, because the USB host controller of the SC2x3 determines the optimal value itself.

Global DelArpEntryByPhys

This legacy function can be replaced by RemoveArpEntryByPhysAddr() and is only left for backward compatibility.

Global DelDefaultGateway

This legacy function can be replaced by RemoveDefaultGateway() and is only left for backward compatibility.

Global DelStaticRoute

This legacy function can be replaced by RemoveStaticRoute() and is only left for backward compatibility.

Global Dev_Get_Handle_By_Name

This legacy function can be replaced by Dev_Find_Iface_By_Name() and is only left for backward compatibility.

Global DHCP_use
This legacy function can be replaced by Dev_Config_Iface(). The DHCP entry at CHIP.INI is settable by BIOS_Set_Ini_String().
It is only left for backward compatibility.

Global Drop_IGMP_Membership

This legacy function can be replaced by DelMulticastIPv4().
It is only left for backward compatibility.

Global FindAllOpenSockets
Use GetSocketList instead

Global FindAllOpenSockets_IP_All
Use GetSocketList instead

Global Get_DHCP_Status
This legacy function can be replaced by Dev_Get_DHCP_BootData().
It is only left for backward compatibility.

Global Get_DHCP_Status_Ext
This legacy function can be replaced by Dev_Get_DHCP_BootData().
It is only left for backward compatibility.

Global Get_Iface_Entries_Ext
Use Dev_Get_IfaceEntries() instead

Global Get_IPConfig

This legacy function can be replaced by Dev_Get_IP() and DefaultGateway(). It is only left for backward compatibility.

Global Get_IPv6_Iface_Entries
Use Dev_Get_IfaceEntries_IPv6() instead

Global Get_SNMP_DataEx
Use Get_SNMPMibDataBase instead

Global GetDefaultGateway

This legacy function can be replaced by DefaultGateway() and is only left for backward compatibility.

Global GetTcpState
Use GetTcpConnectionState instead

Global GetTcpState_IP_All
Use GetTcpConnectionState instead

Global Iface_Entry_Ext
Use Iface_Device_Entry instead

Global IPMulticast_to_MacAddr

At the SC2x3 RTOS this function is meanwhile superfluous.
It is only left for backward compatibility.

Global opensocket

This legacy function can be replaced by socket() and is only left for backward compatibility.

Global opensocket_ext
Use socket() instead

Global opensocketIPv4v6

This legacy function can be replaced by socket() and is only left for backward compatibility.

Global PPP_Client_GetIP
This legacy function can be replaced by Dev_Get_IP(). It is only left for backward compatibility.

Global PPP_Server_GetIP
This legacy function can be replaced by Dev_Get_IP(). It is only left for backward compatibility.

Global Reconfigure_ethernet
Use ethReStart() instead

Global Register_ARP_User_CB
Use RegisterARPCbHandler instead

Global RegisterCallbackFunction
Use RegisterSocketCB() instead

Global RegisterIPCallbackHandler
Use RegisterIPCbHandler_Recv instead

Global RegisterIPCallbackHandler_Snd
Use RegisterIPCbHandler_Send instead

Global RegisterIPConfigCallback
Use RegisterIPConfigCbHandler instead

Global RTX_FineTickInit

For new programs which require no compatibility with the older Beck systems, direct access to the RtxInternalData and gSysPublicData data is recommended instead of using this deprecated function.

Global RTX_GetTick_us

This inefficient function is provided only for compatibity with earlier Beck 16 bit systems. For new software, the readTB() or readTBx() functions should be used directly instead of using this deprecated function.

Global Set_Blocking_Mode
Use SocketBlockingMode() instead

Global Set_IP_Type_Of_Service

This legacy function should be replaced by calling setsockopt() with protocol_level IP_PROTOIP_LEVEL, optionName IPO_TOS .

Use setsockopt() instead

Global Set_IPConfig

This legacy function can be replaced by Dev_Config_Iface() and SetDefaultGateway(). The IP entries at CHIP.INI are settable by BIOS_Set_Ini_String() .
It is only left for backward compatibility.

Global SetIfaceMTU

This legacy function can be replaced by Dev_Set_IfaceMTU() and is only left for backward compatibility.

Global setlinger

Use setsockopt() with option SO_LINGER instead

Global setreuse

This superfluous function exists only for compatibility to @CHIP-RTOS SC1x and SC1x3/SC2x.
Functionality is provided setsockopt() with protocol_level SOCKET_LEVEL, optionName SO_REUSEADDR .

Global tcp_connect

This superfluous function exists only for compatibility to @CHIP-RTOS SC1x and SC1x3/SC2x.
The functionality is should be implemented by using opensocket(), bind() and connect().

Global usbFreeReceiveBuffer
This legacy function is obsolete and only left for backward compatibility. Receiving data should not be triggered via usbHostIssueToken() anymore, but via usbHostTransfer() or usbHostTransferIso() respectively. These functions expect you to allocate RX buffers yourself, so you can also free them yourself.

Global usbHostIssueToken
This legacy function has been replaced by usbHostTransfer() and usbHostTransferIso() and is only left for backward compatibility.

Global usbSend
This legacy function has been replaced by usbHostTransfer() and usbHostTransferIso() and is only left for backward compatibility.

Global USER_ERROR_HANDLER
See BIOS_ERROR_HANDLER





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:35 2017 by Doxygen 1.6.1