Donatien Garnier / LwIPNetworking

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:   DebugLib Socket lwip lwip-sys

Dependents:   EthernetInterface

Fork of NetworkingCoreLib by Donatien Garnier

main/lwip/src/netif/ppp/lcp.h@0:013f5d54248c, 2012-05-24 (annotated)

Committer:
donatien
Date:
Thu May 24 14:49:40 2012 +0000
Revision:
0:013f5d54248c
Initial Commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:013f5d54248c 1 /*****************************************************************************
donatien 0:013f5d54248c 2 * lcp.h - Network Link Control Protocol header file.
donatien 0:013f5d54248c 3 *
donatien 0:013f5d54248c 4 * Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.
donatien 0:013f5d54248c 5 * portions Copyright (c) 1997 Global Election Systems Inc.
donatien 0:013f5d54248c 6 *
donatien 0:013f5d54248c 7 * The authors hereby grant permission to use, copy, modify, distribute,
donatien 0:013f5d54248c 8 * and license this software and its documentation for any purpose, provided
donatien 0:013f5d54248c 9 * that existing copyright notices are retained in all copies and that this
donatien 0:013f5d54248c 10 * notice and the following disclaimer are included verbatim in any
donatien 0:013f5d54248c 11 * distributions. No written agreement, license, or royalty fee is required
donatien 0:013f5d54248c 12 * for any of the authorized uses.
donatien 0:013f5d54248c 13 *
donatien 0:013f5d54248c 14 * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR
donatien 0:013f5d54248c 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
donatien 0:013f5d54248c 16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
donatien 0:013f5d54248c 17 * IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
donatien 0:013f5d54248c 18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
donatien 0:013f5d54248c 19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
donatien 0:013f5d54248c 20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
donatien 0:013f5d54248c 21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
donatien 0:013f5d54248c 22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
donatien 0:013f5d54248c 23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
donatien 0:013f5d54248c 24 *
donatien 0:013f5d54248c 25 ******************************************************************************
donatien 0:013f5d54248c 26 * REVISION HISTORY
donatien 0:013f5d54248c 27 *
donatien 0:013f5d54248c 28 * 03-01-01 Marc Boucher <marc@mbsi.ca>
donatien 0:013f5d54248c 29 * Ported to lwIP.
donatien 0:013f5d54248c 30 * 97-11-05 Guy Lancaster <glanca@gesn.com>, Global Election Systems Inc.
donatien 0:013f5d54248c 31 * Original derived from BSD codes.
donatien 0:013f5d54248c 32 *****************************************************************************/
donatien 0:013f5d54248c 33 /*
donatien 0:013f5d54248c 34 * lcp.h - Link Control Protocol definitions.
donatien 0:013f5d54248c 35 *
donatien 0:013f5d54248c 36 * Copyright (c) 1989 Carnegie Mellon University.
donatien 0:013f5d54248c 37 * All rights reserved.
donatien 0:013f5d54248c 38 *
donatien 0:013f5d54248c 39 * Redistribution and use in source and binary forms are permitted
donatien 0:013f5d54248c 40 * provided that the above copyright notice and this paragraph are
donatien 0:013f5d54248c 41 * duplicated in all such forms and that any documentation,
donatien 0:013f5d54248c 42 * advertising materials, and other materials related to such
donatien 0:013f5d54248c 43 * distribution and use acknowledge that the software was developed
donatien 0:013f5d54248c 44 * by Carnegie Mellon University. The name of the
donatien 0:013f5d54248c 45 * University may not be used to endorse or promote products derived
donatien 0:013f5d54248c 46 * from this software without specific prior written permission.
donatien 0:013f5d54248c 47 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
donatien 0:013f5d54248c 48 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
donatien 0:013f5d54248c 49 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
donatien 0:013f5d54248c 50 *
donatien 0:013f5d54248c 51 * $Id: lcp.h,v 1.4 2010/01/18 20:49:43 goldsimon Exp $
donatien 0:013f5d54248c 52 */
donatien 0:013f5d54248c 53
donatien 0:013f5d54248c 54 #ifndef LCP_H
donatien 0:013f5d54248c 55 #define LCP_H
donatien 0:013f5d54248c 56 /*
donatien 0:013f5d54248c 57 * Options.
donatien 0:013f5d54248c 58 */
donatien 0:013f5d54248c 59 #define CI_MRU 1 /* Maximum Receive Unit */
donatien 0:013f5d54248c 60 #define CI_ASYNCMAP 2 /* Async Control Character Map */
donatien 0:013f5d54248c 61 #define CI_AUTHTYPE 3 /* Authentication Type */
donatien 0:013f5d54248c 62 #define CI_QUALITY 4 /* Quality Protocol */
donatien 0:013f5d54248c 63 #define CI_MAGICNUMBER 5 /* Magic Number */
donatien 0:013f5d54248c 64 #define CI_PCOMPRESSION 7 /* Protocol Field Compression */
donatien 0:013f5d54248c 65 #define CI_ACCOMPRESSION 8 /* Address/Control Field Compression */
donatien 0:013f5d54248c 66 #define CI_CALLBACK 13 /* callback */
donatien 0:013f5d54248c 67 #define CI_MRRU 17 /* max reconstructed receive unit; multilink */
donatien 0:013f5d54248c 68 #define CI_SSNHF 18 /* short sequence numbers for multilink */
donatien 0:013f5d54248c 69 #define CI_EPDISC 19 /* endpoint discriminator */
donatien 0:013f5d54248c 70
donatien 0:013f5d54248c 71 /*
donatien 0:013f5d54248c 72 * LCP-specific packet types (code numbers).
donatien 0:013f5d54248c 73 */
donatien 0:013f5d54248c 74 #define PROTREJ 8 /* Protocol Reject */
donatien 0:013f5d54248c 75 #define ECHOREQ 9 /* Echo Request */
donatien 0:013f5d54248c 76 #define ECHOREP 10 /* Echo Reply */
donatien 0:013f5d54248c 77 #define DISCREQ 11 /* Discard Request */
donatien 0:013f5d54248c 78 #define CBCP_OPT 6 /* Use callback control protocol */
donatien 0:013f5d54248c 79
donatien 0:013f5d54248c 80 /*
donatien 0:013f5d54248c 81 * The state of options is described by an lcp_options structure.
donatien 0:013f5d54248c 82 */
donatien 0:013f5d54248c 83 typedef struct lcp_options {
donatien 0:013f5d54248c 84 u_int passive : 1; /* Don't die if we don't get a response */
donatien 0:013f5d54248c 85 u_int silent : 1; /* Wait for the other end to start first */
donatien 0:013f5d54248c 86 u_int restart : 1; /* Restart vs. exit after close */
donatien 0:013f5d54248c 87 u_int neg_mru : 1; /* Negotiate the MRU? */
donatien 0:013f5d54248c 88 u_int neg_asyncmap : 1; /* Negotiate the async map? */
donatien 0:013f5d54248c 89 u_int neg_upap : 1; /* Ask for UPAP authentication? */
donatien 0:013f5d54248c 90 u_int neg_chap : 1; /* Ask for CHAP authentication? */
donatien 0:013f5d54248c 91 u_int neg_magicnumber : 1; /* Ask for magic number? */
donatien 0:013f5d54248c 92 u_int neg_pcompression : 1; /* HDLC Protocol Field Compression? */
donatien 0:013f5d54248c 93 u_int neg_accompression : 1; /* HDLC Address/Control Field Compression? */
donatien 0:013f5d54248c 94 u_int neg_lqr : 1; /* Negotiate use of Link Quality Reports */
donatien 0:013f5d54248c 95 u_int neg_cbcp : 1; /* Negotiate use of CBCP */
donatien 0:013f5d54248c 96 #ifdef PPP_MULTILINK
donatien 0:013f5d54248c 97 u_int neg_mrru : 1; /* Negotiate multilink MRRU */
donatien 0:013f5d54248c 98 u_int neg_ssnhf : 1; /* Negotiate short sequence numbers */
donatien 0:013f5d54248c 99 u_int neg_endpoint : 1; /* Negotiate endpoint discriminator */
donatien 0:013f5d54248c 100 #endif
donatien 0:013f5d54248c 101 u_short mru; /* Value of MRU */
donatien 0:013f5d54248c 102 #ifdef PPP_MULTILINK
donatien 0:013f5d54248c 103 u_short mrru; /* Value of MRRU, and multilink enable */
donatien 0:013f5d54248c 104 #endif
donatien 0:013f5d54248c 105 u_char chap_mdtype; /* which MD type (hashing algorithm) */
donatien 0:013f5d54248c 106 u32_t asyncmap; /* Value of async map */
donatien 0:013f5d54248c 107 u32_t magicnumber;
donatien 0:013f5d54248c 108 int numloops; /* Number of loops during magic number neg. */
donatien 0:013f5d54248c 109 u32_t lqr_period; /* Reporting period for LQR 1/100ths second */
donatien 0:013f5d54248c 110 #ifdef PPP_MULTILINK
donatien 0:013f5d54248c 111 struct epdisc endpoint; /* endpoint discriminator */
donatien 0:013f5d54248c 112 #endif
donatien 0:013f5d54248c 113 } lcp_options;
donatien 0:013f5d54248c 114
donatien 0:013f5d54248c 115 /*
donatien 0:013f5d54248c 116 * Values for phase from BSD pppd.h based on RFC 1661.
donatien 0:013f5d54248c 117 */
donatien 0:013f5d54248c 118 typedef enum {
donatien 0:013f5d54248c 119 PHASE_DEAD = 0,
donatien 0:013f5d54248c 120 PHASE_INITIALIZE,
donatien 0:013f5d54248c 121 PHASE_ESTABLISH,
donatien 0:013f5d54248c 122 PHASE_AUTHENTICATE,
donatien 0:013f5d54248c 123 PHASE_CALLBACK,
donatien 0:013f5d54248c 124 PHASE_NETWORK,
donatien 0:013f5d54248c 125 PHASE_TERMINATE
donatien 0:013f5d54248c 126 } LinkPhase;
donatien 0:013f5d54248c 127
donatien 0:013f5d54248c 128
donatien 0:013f5d54248c 129
donatien 0:013f5d54248c 130 extern LinkPhase lcp_phase[NUM_PPP]; /* Phase of link session (RFC 1661) */
donatien 0:013f5d54248c 131 extern lcp_options lcp_wantoptions[];
donatien 0:013f5d54248c 132 extern lcp_options lcp_gotoptions[];
donatien 0:013f5d54248c 133 extern lcp_options lcp_allowoptions[];
donatien 0:013f5d54248c 134 extern lcp_options lcp_hisoptions[];
donatien 0:013f5d54248c 135 extern ext_accm xmit_accm[];
donatien 0:013f5d54248c 136
donatien 0:013f5d54248c 137
donatien 0:013f5d54248c 138 void lcp_init (int);
donatien 0:013f5d54248c 139 void lcp_open (int);
donatien 0:013f5d54248c 140 void lcp_close (int, char *);
donatien 0:013f5d54248c 141 void lcp_lowerup (int);
donatien 0:013f5d54248c 142 void lcp_lowerdown(int);
donatien 0:013f5d54248c 143 void lcp_sprotrej (int, u_char *, int); /* send protocol reject */
donatien 0:013f5d54248c 144
donatien 0:013f5d54248c 145 extern struct protent lcp_protent;
donatien 0:013f5d54248c 146
donatien 0:013f5d54248c 147 /* Default number of times we receive our magic number from the peer
donatien 0:013f5d54248c 148 before deciding the link is looped-back. */
donatien 0:013f5d54248c 149 #define DEFLOOPBACKFAIL 10
donatien 0:013f5d54248c 150
donatien 0:013f5d54248c 151 #endif /* LCP_H */