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