Donatien Garnier / lwip_ppp_ethernet

LwIP with PPP & Ethernet integration

Dependents:   NetworkingCoreLib

This is the mbed port of the LwIP stack: http://savannah.nongnu.org/projects/lwip/

It includes contributed content from NXP's port for LPCxxxx devices: http://www.lpcware.com/content/project/lightweight-ip-lwip-networking-stack

Licence

LwIP is licenced under the BSD licence: 

Copyright (c) 2001-2004 Swedish Institute of Computer Science. 
All rights reserved. 
Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met: 
1. Redistributions of source code must retain the above copyright notice, 
this list of conditions and the following disclaimer. 
2. Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution. 
3. The name of the author may not be used to endorse or promote products 
derived from this software without specific prior written permission. 
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
OF SUCH DAMAGE.

src/netif/ppp/fsm.h@0:8e01dca41002, 2012-05-24 (annotated)

Committer:
donatien
Date:
Thu May 24 15:53:48 2012 +0000
Revision:
0:8e01dca41002
Merge with Emilio's LwIp

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:8e01dca41002 1 /*****************************************************************************
donatien 0:8e01dca41002 2 * fsm.h - Network Control Protocol Finite State Machine header file.
donatien 0:8e01dca41002 3 *
donatien 0:8e01dca41002 4 * Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.
donatien 0:8e01dca41002 5 * Copyright (c) 1997 Global Election Systems Inc.
donatien 0:8e01dca41002 6 *
donatien 0:8e01dca41002 7 * The authors hereby grant permission to use, copy, modify, distribute,
donatien 0:8e01dca41002 8 * and license this software and its documentation for any purpose, provided
donatien 0:8e01dca41002 9 * that existing copyright notices are retained in all copies and that this
donatien 0:8e01dca41002 10 * notice and the following disclaimer are included verbatim in any
donatien 0:8e01dca41002 11 * distributions. No written agreement, license, or royalty fee is required
donatien 0:8e01dca41002 12 * for any of the authorized uses.
donatien 0:8e01dca41002 13 *
donatien 0:8e01dca41002 14 * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR
donatien 0:8e01dca41002 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
donatien 0:8e01dca41002 16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
donatien 0:8e01dca41002 17 * IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
donatien 0:8e01dca41002 18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
donatien 0:8e01dca41002 19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
donatien 0:8e01dca41002 20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
donatien 0:8e01dca41002 21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
donatien 0:8e01dca41002 22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
donatien 0:8e01dca41002 23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
donatien 0:8e01dca41002 24 *
donatien 0:8e01dca41002 25 ******************************************************************************
donatien 0:8e01dca41002 26 * REVISION HISTORY
donatien 0:8e01dca41002 27 *
donatien 0:8e01dca41002 28 * 03-01-01 Marc Boucher <marc@mbsi.ca>
donatien 0:8e01dca41002 29 * Ported to lwIP.
donatien 0:8e01dca41002 30 * 97-11-05 Guy Lancaster <glanca@gesn.com>, Global Election Systems Inc.
donatien 0:8e01dca41002 31 * Original based on BSD code.
donatien 0:8e01dca41002 32 *****************************************************************************/
donatien 0:8e01dca41002 33 /*
donatien 0:8e01dca41002 34 * fsm.h - {Link, IP} Control Protocol Finite State Machine definitions.
donatien 0:8e01dca41002 35 *
donatien 0:8e01dca41002 36 * Copyright (c) 1989 Carnegie Mellon University.
donatien 0:8e01dca41002 37 * All rights reserved.
donatien 0:8e01dca41002 38 *
donatien 0:8e01dca41002 39 * Redistribution and use in source and binary forms are permitted
donatien 0:8e01dca41002 40 * provided that the above copyright notice and this paragraph are
donatien 0:8e01dca41002 41 * duplicated in all such forms and that any documentation,
donatien 0:8e01dca41002 42 * advertising materials, and other materials related to such
donatien 0:8e01dca41002 43 * distribution and use acknowledge that the software was developed
donatien 0:8e01dca41002 44 * by Carnegie Mellon University. The name of the
donatien 0:8e01dca41002 45 * University may not be used to endorse or promote products derived
donatien 0:8e01dca41002 46 * from this software without specific prior written permission.
donatien 0:8e01dca41002 47 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
donatien 0:8e01dca41002 48 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
donatien 0:8e01dca41002 49 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
donatien 0:8e01dca41002 50 *
donatien 0:8e01dca41002 51 * $Id: fsm.h,v 1.5 2009/12/31 17:08:08 goldsimon Exp $
donatien 0:8e01dca41002 52 */
donatien 0:8e01dca41002 53
donatien 0:8e01dca41002 54 #ifndef FSM_H
donatien 0:8e01dca41002 55 #define FSM_H
donatien 0:8e01dca41002 56
donatien 0:8e01dca41002 57 /*
donatien 0:8e01dca41002 58 * LCP Packet header = Code, id, length.
donatien 0:8e01dca41002 59 */
donatien 0:8e01dca41002 60 #define HEADERLEN (sizeof (u_char) + sizeof (u_char) + sizeof (u_short))
donatien 0:8e01dca41002 61
donatien 0:8e01dca41002 62
donatien 0:8e01dca41002 63 /*
donatien 0:8e01dca41002 64 * CP (LCP, IPCP, etc.) codes.
donatien 0:8e01dca41002 65 */
donatien 0:8e01dca41002 66 #define CONFREQ 1 /* Configuration Request */
donatien 0:8e01dca41002 67 #define CONFACK 2 /* Configuration Ack */
donatien 0:8e01dca41002 68 #define CONFNAK 3 /* Configuration Nak */
donatien 0:8e01dca41002 69 #define CONFREJ 4 /* Configuration Reject */
donatien 0:8e01dca41002 70 #define TERMREQ 5 /* Termination Request */
donatien 0:8e01dca41002 71 #define TERMACK 6 /* Termination Ack */
donatien 0:8e01dca41002 72 #define CODEREJ 7 /* Code Reject */
donatien 0:8e01dca41002 73
donatien 0:8e01dca41002 74
donatien 0:8e01dca41002 75 /*
donatien 0:8e01dca41002 76 * Each FSM is described by an fsm structure and fsm callbacks.
donatien 0:8e01dca41002 77 */
donatien 0:8e01dca41002 78 typedef struct fsm {
donatien 0:8e01dca41002 79 int unit; /* Interface unit number */
donatien 0:8e01dca41002 80 u_short protocol; /* Data Link Layer Protocol field value */
donatien 0:8e01dca41002 81 int state; /* State */
donatien 0:8e01dca41002 82 int flags; /* Contains option bits */
donatien 0:8e01dca41002 83 u_char id; /* Current id */
donatien 0:8e01dca41002 84 u_char reqid; /* Current request id */
donatien 0:8e01dca41002 85 u_char seen_ack; /* Have received valid Ack/Nak/Rej to Req */
donatien 0:8e01dca41002 86 int timeouttime; /* Timeout time in milliseconds */
donatien 0:8e01dca41002 87 int maxconfreqtransmits; /* Maximum Configure-Request transmissions */
donatien 0:8e01dca41002 88 int retransmits; /* Number of retransmissions left */
donatien 0:8e01dca41002 89 int maxtermtransmits; /* Maximum Terminate-Request transmissions */
donatien 0:8e01dca41002 90 int nakloops; /* Number of nak loops since last ack */
donatien 0:8e01dca41002 91 int maxnakloops; /* Maximum number of nak loops tolerated */
donatien 0:8e01dca41002 92 struct fsm_callbacks* callbacks; /* Callback routines */
donatien 0:8e01dca41002 93 char* term_reason; /* Reason for closing protocol */
donatien 0:8e01dca41002 94 int term_reason_len; /* Length of term_reason */
donatien 0:8e01dca41002 95 } fsm;
donatien 0:8e01dca41002 96
donatien 0:8e01dca41002 97
donatien 0:8e01dca41002 98 typedef struct fsm_callbacks {
donatien 0:8e01dca41002 99 void (*resetci)(fsm*); /* Reset our Configuration Information */
donatien 0:8e01dca41002 100 int (*cilen)(fsm*); /* Length of our Configuration Information */
donatien 0:8e01dca41002 101 void (*addci)(fsm*, u_char*, int*); /* Add our Configuration Information */
donatien 0:8e01dca41002 102 int (*ackci)(fsm*, u_char*, int); /* ACK our Configuration Information */
donatien 0:8e01dca41002 103 int (*nakci)(fsm*, u_char*, int); /* NAK our Configuration Information */
donatien 0:8e01dca41002 104 int (*rejci)(fsm*, u_char*, int); /* Reject our Configuration Information */
donatien 0:8e01dca41002 105 int (*reqci)(fsm*, u_char*, int*, int); /* Request peer's Configuration Information */
donatien 0:8e01dca41002 106 void (*up)(fsm*); /* Called when fsm reaches LS_OPENED state */
donatien 0:8e01dca41002 107 void (*down)(fsm*); /* Called when fsm leaves LS_OPENED state */
donatien 0:8e01dca41002 108 void (*starting)(fsm*); /* Called when we want the lower layer */
donatien 0:8e01dca41002 109 void (*finished)(fsm*); /* Called when we don't want the lower layer */
donatien 0:8e01dca41002 110 void (*protreject)(int); /* Called when Protocol-Reject received */
donatien 0:8e01dca41002 111 void (*retransmit)(fsm*); /* Retransmission is necessary */
donatien 0:8e01dca41002 112 int (*extcode)(fsm*, int, u_char, u_char*, int); /* Called when unknown code received */
donatien 0:8e01dca41002 113 char *proto_name; /* String name for protocol (for messages) */
donatien 0:8e01dca41002 114 } fsm_callbacks;
donatien 0:8e01dca41002 115
donatien 0:8e01dca41002 116
donatien 0:8e01dca41002 117 /*
donatien 0:8e01dca41002 118 * Link states.
donatien 0:8e01dca41002 119 */
donatien 0:8e01dca41002 120 #define LS_INITIAL 0 /* Down, hasn't been opened */
donatien 0:8e01dca41002 121 #define LS_STARTING 1 /* Down, been opened */
donatien 0:8e01dca41002 122 #define LS_CLOSED 2 /* Up, hasn't been opened */
donatien 0:8e01dca41002 123 #define LS_STOPPED 3 /* Open, waiting for down event */
donatien 0:8e01dca41002 124 #define LS_CLOSING 4 /* Terminating the connection, not open */
donatien 0:8e01dca41002 125 #define LS_STOPPING 5 /* Terminating, but open */
donatien 0:8e01dca41002 126 #define LS_REQSENT 6 /* We've sent a Config Request */
donatien 0:8e01dca41002 127 #define LS_ACKRCVD 7 /* We've received a Config Ack */
donatien 0:8e01dca41002 128 #define LS_ACKSENT 8 /* We've sent a Config Ack */
donatien 0:8e01dca41002 129 #define LS_OPENED 9 /* Connection available */
donatien 0:8e01dca41002 130
donatien 0:8e01dca41002 131 /*
donatien 0:8e01dca41002 132 * Flags - indicate options controlling FSM operation
donatien 0:8e01dca41002 133 */
donatien 0:8e01dca41002 134 #define OPT_PASSIVE 1 /* Don't die if we don't get a response */
donatien 0:8e01dca41002 135 #define OPT_RESTART 2 /* Treat 2nd OPEN as DOWN, UP */
donatien 0:8e01dca41002 136 #define OPT_SILENT 4 /* Wait for peer to speak first */
donatien 0:8e01dca41002 137
donatien 0:8e01dca41002 138
donatien 0:8e01dca41002 139 /*
donatien 0:8e01dca41002 140 * Prototypes
donatien 0:8e01dca41002 141 */
donatien 0:8e01dca41002 142 void fsm_init (fsm*);
donatien 0:8e01dca41002 143 void fsm_lowerup (fsm*);
donatien 0:8e01dca41002 144 void fsm_lowerdown (fsm*);
donatien 0:8e01dca41002 145 void fsm_open (fsm*);
donatien 0:8e01dca41002 146 void fsm_close (fsm*, char*);
donatien 0:8e01dca41002 147 void fsm_input (fsm*, u_char*, int);
donatien 0:8e01dca41002 148 void fsm_protreject (fsm*);
donatien 0:8e01dca41002 149 void fsm_sdata (fsm*, u_char, u_char, u_char*, int);
donatien 0:8e01dca41002 150
donatien 0:8e01dca41002 151
donatien 0:8e01dca41002 152 /*
donatien 0:8e01dca41002 153 * Variables
donatien 0:8e01dca41002 154 */
donatien 0:8e01dca41002 155 extern int peer_mru[]; /* currently negotiated peer MRU (per unit) */
donatien 0:8e01dca41002 156
donatien 0:8e01dca41002 157 #endif /* FSM_H */