Pranav Sawant / EthernetNetIf

12Oct2012MbedLab

Dependents:   Lab3_VoiceMeter

Fork of EthernetNetIf by Donatien Garnier

LPC1768/lwip/netif/ppp/fsm.h@6:22ce63eddd2b, 2012-10-12 (annotated)

Committer:
psawant9
Date:
Fri Oct 12 16:02:00 2012 +0000
Revision:
6:22ce63eddd2b
Parent:
0:422060928e37 
Done

Who changed what in which revision?

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