Nut/OS  4.10.3
API Reference
ppp_fsm.h File Reference

PPP state machine definitions. More...

#include <stdint.h>
Include dependency graph for ppp_fsm.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  XCPOPT

Defines

#define PPPS_INITIAL   0
 Down, hasn't been opened.
#define PPPS_STARTING   1
 Down, been opened.
#define PPPS_CLOSED   2
 Up, hasn't been opened.
#define PPPS_STOPPED   3
 Open, waiting for down event.
#define PPPS_CLOSING   4
 Terminating the connection, not open.
#define PPPS_STOPPING   5
 Peer is going down.
#define PPPS_REQSENT   6
 We've sent a Config Request.
#define PPPS_ACKRCVD   7
 We've received a Config Ack.
#define PPPS_ACKSENT   8
 We've sent a Config Ack.
#define PPPS_OPENED   9
 Connection available.
#define XCP_CONFREQ   1
 LCP/IPCP Configure-Request Code.
#define XCP_CONFACK   2
 LCP/IPCP Configure-Ack Code.
#define XCP_CONFNAK   3
 LCP/IPCP Configure-Nack Code.
#define XCP_CONFREJ   4
 LCP/IPCP Configure-Reject Code.
#define XCP_TERMREQ   5
 LCP/IPCP Terminate-Request Code.
#define XCP_TERMACK   6
 LCP/IPCP Terminate-Ack Code.
#define XCP_CODEREJ   7
 LCP/IPCP Code-Reject Code.
#define LCP_PROTREJ   8
 LCP Protocol-Reject Code.
#define LCP_ERQ   9
 LCP Echo-Request Code.
#define LCP_ERP   10
 LCP Echo-Response Code.
#define LCP_DRQ   11
 LCP Discard-Request Code.
#define PAPCS_INITIAL   0
 Connection down.
#define PAPCS_CLOSED   1
 Connection up, haven't requested auth.
#define PAPCS_PENDING   2
 Connection down, have requested auth.
#define PAPCS_AUTHREQ   3
 We've sent an Authenticate-Request.
#define PAPCS_OPEN   4
 We've received an Ack.
#define PAPCS_BADAUTH   5
 We've received a Nak.

Functions

void LcpOpen (NUTDEVICE *dev)
 Trigger LCP open event.
void LcpClose (NUTDEVICE *dev)
 Trigger LCP close event.
void LcpLowerUp (NUTDEVICE *dev)
 Trigger LCP lower up event.
void LcpLowerDown (NUTDEVICE *dev)
 Trigger LCP lower down event.
void PapLowerUp (NUTDEVICE *dev)
void PapLowerDown (NUTDEVICE *dev)
void IpcpOpen (NUTDEVICE *dev)
 Trigger IPCP open event.
void IpcpClose (NUTDEVICE *dev)
 Trigger IPCP close event.
void IpcpLowerUp (NUTDEVICE *dev)
void IpcpLowerDown (NUTDEVICE *dev)
void PppOpen (NUTDEVICE *dev)
void PppClose (NUTDEVICE *dev)
int NutPppInitStateMachine (NUTDEVICE *dev)
 Initialize the PPP state machine.

Detailed Description

PPP state machine definitions.

Definition in file ppp_fsm.h.


Define Documentation

#define PPPS_INITIAL   0

Down, hasn't been opened.

Definition at line 119 of file ppp_fsm.h.

Referenced by IpcpClose(), IpcpLowerDown(), IpcpLowerUp(), IpcpOpen(), LcpClose(), LcpLowerDown(), LcpLowerUp(), LcpOpen(), NutIpcpInput(), and NutLcpInput().

#define PPPS_STARTING   1
#define PPPS_CLOSED   2
#define PPPS_STOPPED   3

Open, waiting for down event.

Definition at line 122 of file ppp_fsm.h.

Referenced by IpcpClose(), IpcpLowerDown(), IpcpRxConfAck(), IpcpRxConfReq(), IpcpRxProtRej(), IpcpRxTermAck(), LcpClose(), LcpLowerDown(), LcpRxProtRej(), and NutPppSm().

#define PPPS_CLOSING   4

Terminating the connection, not open.

Definition at line 123 of file ppp_fsm.h.

Referenced by IpcpClose(), IpcpLowerDown(), IpcpOpen(), IpcpRxConfReq(), IpcpRxProtRej(), IpcpRxTermAck(), LcpClose(), LcpLowerDown(), LcpOpen(), LcpRxProtRej(), and NutPppSm().

#define PPPS_STOPPING   5
#define PPPS_ACKRCVD   7
#define PPPS_ACKSENT   8
#define PPPS_OPENED   9
#define XCP_CONFREQ   1

LCP/IPCP Configure-Request Code.

Definition at line 130 of file ppp_fsm.h.

Referenced by IpcpTxConfReq(), LcpTxConfReq(), NutDumpIpcp(), NutDumpLcp(), NutDumpPap(), NutIpcpInput(), NutLcpInput(), NutPapInput(), and PapTxAuthReq().

#define XCP_CONFACK   2

LCP/IPCP Configure-Ack Code.

Definition at line 131 of file ppp_fsm.h.

Referenced by IpcpRxConfReq(), NutDumpIpcp(), NutDumpLcp(), NutDumpPap(), NutIpcpInput(), NutLcpInput(), NutPapInput(), and PapRxAuthReq().

#define XCP_CONFNAK   3

LCP/IPCP Configure-Nack Code.

Definition at line 132 of file ppp_fsm.h.

Referenced by IpcpRxConfReq(), NutDumpIpcp(), NutDumpLcp(), NutDumpPap(), NutIpcpInput(), NutLcpInput(), and NutPapInput().

#define XCP_CONFREJ   4

LCP/IPCP Configure-Reject Code.

Definition at line 133 of file ppp_fsm.h.

Referenced by IpcpRxConfReq(), NutDumpIpcp(), NutDumpLcp(), NutIpcpInput(), and NutLcpInput().

#define XCP_TERMREQ   5

LCP/IPCP Terminate-Request Code.

Definition at line 134 of file ppp_fsm.h.

Referenced by IpcpClose(), IpcpRxProtRej(), LcpClose(), LcpRxProtRej(), NutDumpIpcp(), NutDumpLcp(), NutIpcpInput(), NutLcpInput(), and NutPppSm().

#define XCP_TERMACK   6

LCP/IPCP Terminate-Ack Code.

Definition at line 135 of file ppp_fsm.h.

Referenced by IpcpRxConfAck(), IpcpRxConfReq(), IpcpRxTermReq(), NutDumpIpcp(), NutDumpLcp(), NutIpcpInput(), and NutLcpInput().

#define XCP_CODEREJ   7

LCP/IPCP Code-Reject Code.

Definition at line 136 of file ppp_fsm.h.

Referenced by NutDumpIpcp(), NutDumpLcp(), NutIpcpInput(), and NutLcpInput().

#define LCP_PROTREJ   8

LCP Protocol-Reject Code.

Definition at line 137 of file ppp_fsm.h.

Referenced by LcpTxProtRej(), and NutDumpLcp().

#define LCP_ERQ   9

LCP Echo-Request Code.

Definition at line 138 of file ppp_fsm.h.

Referenced by NutDumpLcp(), and NutLcpInput().

#define LCP_ERP   10

LCP Echo-Response Code.

Definition at line 139 of file ppp_fsm.h.

Referenced by NutDumpLcp(), and NutLcpInput().

#define LCP_DRQ   11

LCP Discard-Request Code.

Definition at line 140 of file ppp_fsm.h.

Referenced by NutDumpLcp(), and NutLcpInput().

#define PAPCS_INITIAL   0

Connection down.

Definition at line 145 of file ppp_fsm.h.

#define PAPCS_CLOSED   1

Connection up, haven't requested auth.

Definition at line 146 of file ppp_fsm.h.

#define PAPCS_PENDING   2

Connection down, have requested auth.

Definition at line 147 of file ppp_fsm.h.

#define PAPCS_AUTHREQ   3

We've sent an Authenticate-Request.

Definition at line 148 of file ppp_fsm.h.

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

#define PAPCS_OPEN   4

We've received an Ack.

Definition at line 149 of file ppp_fsm.h.

Referenced by NutPppInput(), and PapRxAuthAck().

#define PAPCS_BADAUTH   5

We've received a Nak.

Definition at line 150 of file ppp_fsm.h.

Referenced by PapRxAuthNak().


Function Documentation

void PapLowerUp ( NUTDEVICE dev)
void PapLowerDown ( NUTDEVICE dev)
void PppOpen ( NUTDEVICE dev)
void PppClose ( NUTDEVICE dev)