Nut/OS  4.10.3
API Reference
_PPPDCB Struct Reference

PPP interface structure. More...

#include <dev/ppp.h>

Collaboration diagram for _PPPDCB:

Data Fields

HANDLE dcb_state_chg
 PPP State event queue. The state machine posts an event to this queue when the network interface becomes ready.
uint8_t dcb_lcp_state
 Current state of the link layer.
uint8_t dcb_reqid
 ID of our last request.
uint8_t dcb_rejid
 ID of our last reject.
uint8_t dcb_acked
 Flag to remember ack received.
uint16_t dcb_loc_mru
 Maximum local receive unit.
uint16_t dcb_rem_mru
 Maximum remote receive unit.
uint32_t dcb_accm
 Asynch control character map. TODO: Pass to ahdlc driver.
uint8_t dcb_compr
 Compression flags. TODO: Pass to ahdlc driver. dcb_useACFC dcb_usePFC.
uint16_t dcb_auth
 Authentication type.
uint32_t dcb_neg_magic
 Magic number to negotiate.
uint32_t dcb_loc_magic
 Local magic number. Used to detect loopback conditions.
uint32_t dcb_rem_magic
 Remote magic number. Used to detect loopback conditions.
uint8_tdcb_user
 User authentication.
uint8_tdcb_pass
 Password authentication.
uint32_t dcb_local_ip
 Local IP address.
uint32_t dcb_remote_ip
 Remote IP address.
uint32_t dcb_ip_mask
 Negotiated IP mask.
uint32_t dcb_ip_dns1
 Negotiated primary DNS.
uint32_t dcb_ip_dns2
 Negotiated secondary DNS.
uint32_t dcb_rejects
 Rejected items.
uint8_t dcb_retries
 LCP/IPCP retransmit counter.
uint8_t dcb_lcp_naks
 LCP NAK counter, avoids endless loops.
uint8_t dcb_lcp_reqid
 Identifier of our last LCP request.
uint8_t dcb_ipcp_state
 Current state of the network layer.
uint8_t dcb_ipcp_naks
 LCP NAK counter, avoids endless loops.
uint8_t dcb_auth_state
 Current authentication state.
int dcb_fd
 File descriptor of physical device.

Detailed Description

PPP interface structure.

Contains information about the PPP device.

Examples:

pppc/pppc.c.

Definition at line 134 of file ppp.h.


Field Documentation

PPP State event queue. The state machine posts an event to this queue when the network interface becomes ready.

Definition at line 139 of file ppp.h.

Referenced by IpcpClose(), IpcpLowerDown(), IpcpRxConfAck(), IpcpRxConfReq(), and NutNetIfConfig2().

Current state of the link layer.

Definition at line 143 of file ppp.h.

Referenced by LcpClose(), LcpLowerDown(), LcpLowerUp(), LcpOpen(), LcpRxProtRej(), LcpTxConfReq(), NutLcpInput(), and NutPppSm().

ID of our last reject.

Definition at line 151 of file ppp.h.

Referenced by LcpTxProtRej().

Flag to remember ack received.

Definition at line 155 of file ppp.h.

Referenced by IpcpRxConfAck(), IpcpTxConfReq(), and LcpTxConfReq().

Maximum local receive unit.

Definition at line 159 of file ppp.h.

Maximum remote receive unit.

Definition at line 163 of file ppp.h.

Asynch control character map. TODO: Pass to ahdlc driver.

Definition at line 168 of file ppp.h.

Compression flags. TODO: Pass to ahdlc driver. dcb_useACFC dcb_usePFC.

Definition at line 173 of file ppp.h.

Authentication type.

Definition at line 177 of file ppp.h.

Magic number to negotiate.

Definition at line 181 of file ppp.h.

Referenced by LcpTxConfReq().

Local magic number. Used to detect loopback conditions.

Definition at line 186 of file ppp.h.

Remote magic number. Used to detect loopback conditions.

Definition at line 191 of file ppp.h.

User authentication.

Definition at line 195 of file ppp.h.

Referenced by PapTxAuthReq().

Password authentication.

Definition at line 199 of file ppp.h.

Referenced by PapTxAuthReq().

Local IP address.

Examples:
pppc/pppc.c.

Definition at line 203 of file ppp.h.

Referenced by IpcpRxConfAck(), IpcpTxConfReq(), and NutNetIfConfig2().

Remote IP address.

Examples:
pppc/pppc.c.

Definition at line 207 of file ppp.h.

Referenced by IpcpRxConfReq(), and NutNetIfConfig2().

Negotiated IP mask.

Definition at line 211 of file ppp.h.

Referenced by NutNetIfConfig2().

Negotiated primary DNS.

Examples:
pppc/pppc.c.

Definition at line 215 of file ppp.h.

Referenced by IpcpRxConfAck(), IpcpRxConfReq(), and IpcpTxConfReq().

Negotiated secondary DNS.

Examples:
pppc/pppc.c.

Definition at line 219 of file ppp.h.

Referenced by IpcpRxConfAck(), IpcpRxConfReq(), and IpcpTxConfReq().

Rejected items.

Definition at line 223 of file ppp.h.

Referenced by IpcpTxConfReq().

LCP/IPCP retransmit counter.

Definition at line 227 of file ppp.h.

Referenced by IpcpRxConfAck(), LcpTxConfReq(), and NutPppSm().

LCP NAK counter, avoids endless loops.

Definition at line 231 of file ppp.h.

Referenced by LcpTxConfReq().

Identifier of our last LCP request.

Definition at line 235 of file ppp.h.

LCP NAK counter, avoids endless loops.

Definition at line 243 of file ppp.h.

Referenced by IpcpRxConfReq(), and IpcpTxConfReq().

Current authentication state.

Definition at line 247 of file ppp.h.

Referenced by NutPppSm(), PapRxAuthAck(), PapRxAuthNak(), and PapTxAuthReq().

File descriptor of physical device.

Definition at line 251 of file ppp.h.

Referenced by IpcpLowerDown(), NutNetIfConfig2(), and NutPppOutput().


The documentation for this struct was generated from the following file: