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/lcp.h@0:bd5343539e38, 2012-08-17 (annotated)

Committer:
donatien
Date:
Fri Aug 17 15:21:55 2012 +0000
Revision:
0:bd5343539e38
Initial public commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:bd5343539e38 1 /*****************************************************************************
donatien 0:bd5343539e38 2 * lcp.h - Network Link Control Protocol header file.
donatien 0:bd5343539e38 3 *
donatien 0:bd5343539e38 4 * Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.
donatien 0:bd5343539e38 5 * portions 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 derived from BSD codes.
donatien 0:bd5343539e38 32 *****************************************************************************/
donatien 0:bd5343539e38 33 /*
donatien 0:bd5343539e38 34 * lcp.h - Link Control Protocol 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: lcp.h,v 1.4 2010/01/18 20:49:43 goldsimon Exp $
donatien 0:bd5343539e38 52 */
donatien 0:bd5343539e38 53
donatien 0:bd5343539e38 54 #ifndef LCP_H
donatien 0:bd5343539e38 55 #define LCP_H
donatien 0:bd5343539e38 56 /*
donatien 0:bd5343539e38 57 * Options.
donatien 0:bd5343539e38 58 */
donatien 0:bd5343539e38 59 #define CI_MRU 1 /* Maximum Receive Unit */
donatien 0:bd5343539e38 60 #define CI_ASYNCMAP 2 /* Async Control Character Map */
donatien 0:bd5343539e38 61 #define CI_AUTHTYPE 3 /* Authentication Type */
donatien 0:bd5343539e38 62 #define CI_QUALITY 4 /* Quality Protocol */
donatien 0:bd5343539e38 63 #define CI_MAGICNUMBER 5 /* Magic Number */
donatien 0:bd5343539e38 64 #define CI_PCOMPRESSION 7 /* Protocol Field Compression */
donatien 0:bd5343539e38 65 #define CI_ACCOMPRESSION 8 /* Address/Control Field Compression */
donatien 0:bd5343539e38 66 #define CI_CALLBACK 13 /* callback */
donatien 0:bd5343539e38 67 #define CI_MRRU 17 /* max reconstructed receive unit; multilink */
donatien 0:bd5343539e38 68 #define CI_SSNHF 18 /* short sequence numbers for multilink */
donatien 0:bd5343539e38 69 #define CI_EPDISC 19 /* endpoint discriminator */
donatien 0:bd5343539e38 70
donatien 0:bd5343539e38 71 /*
donatien 0:bd5343539e38 72 * LCP-specific packet types (code numbers).
donatien 0:bd5343539e38 73 */
donatien 0:bd5343539e38 74 #define PROTREJ 8 /* Protocol Reject */
donatien 0:bd5343539e38 75 #define ECHOREQ 9 /* Echo Request */
donatien 0:bd5343539e38 76 #define ECHOREP 10 /* Echo Reply */
donatien 0:bd5343539e38 77 #define DISCREQ 11 /* Discard Request */
donatien 0:bd5343539e38 78 #define CBCP_OPT 6 /* Use callback control protocol */
donatien 0:bd5343539e38 79
donatien 0:bd5343539e38 80 /*
donatien 0:bd5343539e38 81 * The state of options is described by an lcp_options structure.
donatien 0:bd5343539e38 82 */
donatien 0:bd5343539e38 83 typedef struct lcp_options {
donatien 0:bd5343539e38 84 u_int passive : 1; /* Don't die if we don't get a response */
donatien 0:bd5343539e38 85 u_int silent : 1; /* Wait for the other end to start first */
donatien 0:bd5343539e38 86 u_int restart : 1; /* Restart vs. exit after close */
donatien 0:bd5343539e38 87 u_int neg_mru : 1; /* Negotiate the MRU? */
donatien 0:bd5343539e38 88 u_int neg_asyncmap : 1; /* Negotiate the async map? */
donatien 0:bd5343539e38 89 u_int neg_upap : 1; /* Ask for UPAP authentication? */
donatien 0:bd5343539e38 90 u_int neg_chap : 1; /* Ask for CHAP authentication? */
donatien 0:bd5343539e38 91 u_int neg_magicnumber : 1; /* Ask for magic number? */
donatien 0:bd5343539e38 92 u_int neg_pcompression : 1; /* HDLC Protocol Field Compression? */
donatien 0:bd5343539e38 93 u_int neg_accompression : 1; /* HDLC Address/Control Field Compression? */
donatien 0:bd5343539e38 94 u_int neg_lqr : 1; /* Negotiate use of Link Quality Reports */
donatien 0:bd5343539e38 95 u_int neg_cbcp : 1; /* Negotiate use of CBCP */
donatien 0:bd5343539e38 96 #ifdef PPP_MULTILINK
donatien 0:bd5343539e38 97 u_int neg_mrru : 1; /* Negotiate multilink MRRU */
donatien 0:bd5343539e38 98 u_int neg_ssnhf : 1; /* Negotiate short sequence numbers */
donatien 0:bd5343539e38 99 u_int neg_endpoint : 1; /* Negotiate endpoint discriminator */
donatien 0:bd5343539e38 100 #endif
donatien 0:bd5343539e38 101 u_short mru; /* Value of MRU */
donatien 0:bd5343539e38 102 #ifdef PPP_MULTILINK
donatien 0:bd5343539e38 103 u_short mrru; /* Value of MRRU, and multilink enable */
donatien 0:bd5343539e38 104 #endif
donatien 0:bd5343539e38 105 u_char chap_mdtype; /* which MD type (hashing algorithm) */
donatien 0:bd5343539e38 106 u32_t asyncmap; /* Value of async map */
donatien 0:bd5343539e38 107 u32_t magicnumber;
donatien 0:bd5343539e38 108 int numloops; /* Number of loops during magic number neg. */
donatien 0:bd5343539e38 109 u32_t lqr_period; /* Reporting period for LQR 1/100ths second */
donatien 0:bd5343539e38 110 #ifdef PPP_MULTILINK
donatien 0:bd5343539e38 111 struct epdisc endpoint; /* endpoint discriminator */
donatien 0:bd5343539e38 112 #endif
donatien 0:bd5343539e38 113 } lcp_options;
donatien 0:bd5343539e38 114
donatien 0:bd5343539e38 115 /*
donatien 0:bd5343539e38 116 * Values for phase from BSD pppd.h based on RFC 1661.
donatien 0:bd5343539e38 117 */
donatien 0:bd5343539e38 118 typedef enum {
donatien 0:bd5343539e38 119 PHASE_DEAD = 0,
donatien 0:bd5343539e38 120 PHASE_INITIALIZE,
donatien 0:bd5343539e38 121 PHASE_ESTABLISH,
donatien 0:bd5343539e38 122 PHASE_AUTHENTICATE,
donatien 0:bd5343539e38 123 PHASE_CALLBACK,
donatien 0:bd5343539e38 124 PHASE_NETWORK,
donatien 0:bd5343539e38 125 PHASE_TERMINATE
donatien 0:bd5343539e38 126 } LinkPhase;
donatien 0:bd5343539e38 127
donatien 0:bd5343539e38 128
donatien 0:bd5343539e38 129
donatien 0:bd5343539e38 130 extern LinkPhase lcp_phase[NUM_PPP]; /* Phase of link session (RFC 1661) */
donatien 0:bd5343539e38 131 extern lcp_options lcp_wantoptions[];
donatien 0:bd5343539e38 132 extern lcp_options lcp_gotoptions[];
donatien 0:bd5343539e38 133 extern lcp_options lcp_allowoptions[];
donatien 0:bd5343539e38 134 extern lcp_options lcp_hisoptions[];
donatien 0:bd5343539e38 135 extern ext_accm xmit_accm[];
donatien 0:bd5343539e38 136
donatien 0:bd5343539e38 137
donatien 0:bd5343539e38 138 void lcp_init (int);
donatien 0:bd5343539e38 139 void lcp_open (int);
donatien 0:bd5343539e38 140 void lcp_close (int, char *);
donatien 0:bd5343539e38 141 void lcp_lowerup (int);
donatien 0:bd5343539e38 142 void lcp_lowerdown(int);
donatien 0:bd5343539e38 143 void lcp_sprotrej (int, u_char *, int); /* send protocol reject */
donatien 0:bd5343539e38 144
donatien 0:bd5343539e38 145 extern struct protent lcp_protent;
donatien 0:bd5343539e38 146
donatien 0:bd5343539e38 147 /* Default number of times we receive our magic number from the peer
donatien 0:bd5343539e38 148 before deciding the link is looped-back. */
donatien 0:bd5343539e38 149 #define DEFLOOPBACKFAIL 10
donatien 0:bd5343539e38 150
donatien 0:bd5343539e38 151 #endif /* LCP_H */