IPC@CHIP Documentation - SC12 @CHIP-RTOS V1.10

Index page
PPP_Option
Comments
This data structure and associated constants are defined in TCPIPAPI.H header file. It is used to control PPP options for
both the PPP server and client.
typedef struct tag_ppp_option
{
int protocolLevel; // PPP_LCP_PROTOCOL or PPP_IPCP_PROTOCOL
int remoteLocalFlag; // PPP_OPTION_WANT or PPP_OPTION_ALLOW
int optionName; // From constants defined below
const char far *optionValuePtr; // To buffer provided by user
int optionLength; // Number of bytes at *optionValuePtr
} PPP_Option;
// PPP Protocol levels
#define PPP_LCP_PROTOCOL 0x21c0
#define PPP_IPCP_PROTOCOL 0x2180
// For .remoteLocalFlag
#define PPP_OPTION_WANT 0
#define PPP_OPTION_ALLOW 1
// Protocol options for .optionName field
// LCP protocol
#define PPP_LCP_ACCM 2
#define PPP_LCP_PROTO_COMP 7
#define PPP_LCP_ADDRCTRL_COMP 8
// IPCP protocol
#define PPP_IPCP_COMP_PROTOCOL 2
#define PPP_IPCP_DNS_PRI 29
#define PPP_IPCP_DNS_SEC 31
The type of data found at the location referenced by the optionValue member varies depending on the particular PPP
option that is being dealt with.
When manipulating socket options, the protocol_level at which the option resides and the name of the option
(optionName member) must be specified.
The size of the buffer required pointed to by the optionValue member depends on the option. These sizes (in bytes) are
stated at the descriptions list below. The parameters optionValue and optionLength are used to access option values.
The structure member remoteLocalFlag can have two possible values:
PPP_OPTION_WANT or PPP_OPTION_ALLOW.
With remoteLocalFlag set to PPP_OPTION_WANT, the IPC@CHIP sends a PPP configuration request to the connected
peer which contains the specified option.
With remoteLocalFlag set to PPP_OPTION_ALLOW, the IPC@CHIP accepts an incoming PPP configuration request from
the connected peer for the specified option.
The following list specifies the PPP options for the two different protocol levels, including a short description and the length of
the option needed for setting the optionLength member. Protocol level and optionName constants referred to here are
defined in TCPIPAPI.H
protocolLevel=PPP_LCP_PROTOCOL (Link Control Protocol level options)
❍ optionName=PPP_LCP_ADDRCONTROL_COMP: Size: 8 bit, sizeof(char) - Activate/Deactivate address control
compression, default 0: Deactivated
❍ optionName=PPP_LCP_PROTO_COMP: Size: 8 bit, sizeof(char) - Value 1: Protocol field compression, default 0: No
compression
❍ optionName=PPP_LCP_ACCM: Size: 32 bit, sizeof(long) - Set Async control character map. Each bit position of the
unsigned long value represents the corresponding character which should be escaped or not during PPP session.
protocolLevel=PPP_IPCP_PROTOCOL (IpCp level options)
❍ optionName=PPP_IPCP_COMP_PROTOCOL: Size: 16 bit, sizeof(int) - Value 1: VJ TCP/IP header compression,
default 0: No compression
Page 174 / 400