Donatien Garnier / VodafoneUSBModem

Vodafone K3770/K3772-Z modems driver & networking library

Dependencies:   Socket

This library is deprecated. Please use the newest production branch of the library from https://mbed.org/users/mbed_official/code/VodafoneUSBModem/

lwip/netif/ppp/fsm.h@2:50930edb6eb3, 2012-11-01 (annotated)

Committer:
donatien
Date:
Thu Nov 01 09:57:11 2012 +0000
Revision:
2:50930edb6eb3
Parent:
0:bd5343539e38 
Deprecated library, pointing out to new one

Who changed what in which revision?

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