Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/lwip/netif/ppp/fsm.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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