SiSK / EthernetInterface

fdsf

Dependents:   sisk_proj_stat MQTT Hello_FXOS8700Q WireFSHandControl ... more

lwip/netif/ppp/ppp.h@0:d7bd7384a37c, 2016-12-07 (annotated)

Committer:
grzemich
Date:
Wed Dec 07 23:47:50 2016 +0000
Revision:
0:d7bd7384a37c
dgd

Who changed what in which revision?

UserRevisionLine numberNew contents of line
grzemich 0:d7bd7384a37c 1 /*****************************************************************************
grzemich 0:d7bd7384a37c 2 * ppp.h - Network Point to Point Protocol header file.
grzemich 0:d7bd7384a37c 3 *
grzemich 0:d7bd7384a37c 4 * Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.
grzemich 0:d7bd7384a37c 5 * portions Copyright (c) 1997 Global Election Systems Inc.
grzemich 0:d7bd7384a37c 6 *
grzemich 0:d7bd7384a37c 7 * The authors hereby grant permission to use, copy, modify, distribute,
grzemich 0:d7bd7384a37c 8 * and license this software and its documentation for any purpose, provided
grzemich 0:d7bd7384a37c 9 * that existing copyright notices are retained in all copies and that this
grzemich 0:d7bd7384a37c 10 * notice and the following disclaimer are included verbatim in any
grzemich 0:d7bd7384a37c 11 * distributions. No written agreement, license, or royalty fee is required
grzemich 0:d7bd7384a37c 12 * for any of the authorized uses.
grzemich 0:d7bd7384a37c 13 *
grzemich 0:d7bd7384a37c 14 * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR
grzemich 0:d7bd7384a37c 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
grzemich 0:d7bd7384a37c 16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
grzemich 0:d7bd7384a37c 17 * IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
grzemich 0:d7bd7384a37c 18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
grzemich 0:d7bd7384a37c 19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
grzemich 0:d7bd7384a37c 20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
grzemich 0:d7bd7384a37c 21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
grzemich 0:d7bd7384a37c 22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
grzemich 0:d7bd7384a37c 23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
grzemich 0:d7bd7384a37c 24 *
grzemich 0:d7bd7384a37c 25 ******************************************************************************
grzemich 0:d7bd7384a37c 26 * REVISION HISTORY
grzemich 0:d7bd7384a37c 27 *
grzemich 0:d7bd7384a37c 28 * 03-01-01 Marc Boucher <marc@mbsi.ca>
grzemich 0:d7bd7384a37c 29 * Ported to lwIP.
grzemich 0:d7bd7384a37c 30 * 97-11-05 Guy Lancaster <glanca@gesn.com>, Global Election Systems Inc.
grzemich 0:d7bd7384a37c 31 * Original derived from BSD codes.
grzemich 0:d7bd7384a37c 32 *****************************************************************************/
grzemich 0:d7bd7384a37c 33
grzemich 0:d7bd7384a37c 34 #ifndef PPP_H
grzemich 0:d7bd7384a37c 35 #define PPP_H
grzemich 0:d7bd7384a37c 36
grzemich 0:d7bd7384a37c 37 #include "lwip/opt.h"
grzemich 0:d7bd7384a37c 38
grzemich 0:d7bd7384a37c 39 #if PPP_SUPPORT /* don't build if not configured for use in lwipopts.h */
grzemich 0:d7bd7384a37c 40
grzemich 0:d7bd7384a37c 41 #include "lwip/def.h"
grzemich 0:d7bd7384a37c 42 #include "lwip/sio.h"
grzemich 0:d7bd7384a37c 43 #include "lwip/stats.h"
grzemich 0:d7bd7384a37c 44 #include "lwip/mem.h"
grzemich 0:d7bd7384a37c 45 #include "lwip/netif.h"
grzemich 0:d7bd7384a37c 46 #include "lwip/sys.h"
grzemich 0:d7bd7384a37c 47 #include "lwip/timers.h"
grzemich 0:d7bd7384a37c 48
grzemich 0:d7bd7384a37c 49 /** Some defines for code we skip compared to the original pppd.
grzemich 0:d7bd7384a37c 50 * These are just here to minimise the use of the ugly "#if 0". */
grzemich 0:d7bd7384a37c 51 #define PPP_ADDITIONAL_CALLBACKS 0
grzemich 0:d7bd7384a37c 52
grzemich 0:d7bd7384a37c 53 /** Some error checks to test for unsupported code */
grzemich 0:d7bd7384a37c 54 #if CBCP_SUPPORT
grzemich 0:d7bd7384a37c 55 #error "CBCP is not supported in lwIP PPP"
grzemich 0:d7bd7384a37c 56 #endif
grzemich 0:d7bd7384a37c 57 #if CCP_SUPPORT
grzemich 0:d7bd7384a37c 58 #error "CCP is not supported in lwIP PPP"
grzemich 0:d7bd7384a37c 59 #endif
grzemich 0:d7bd7384a37c 60
grzemich 0:d7bd7384a37c 61 /*
grzemich 0:d7bd7384a37c 62 * pppd.h - PPP daemon global declarations.
grzemich 0:d7bd7384a37c 63 *
grzemich 0:d7bd7384a37c 64 * Copyright (c) 1989 Carnegie Mellon University.
grzemich 0:d7bd7384a37c 65 * All rights reserved.
grzemich 0:d7bd7384a37c 66 *
grzemich 0:d7bd7384a37c 67 * Redistribution and use in source and binary forms are permitted
grzemich 0:d7bd7384a37c 68 * provided that the above copyright notice and this paragraph are
grzemich 0:d7bd7384a37c 69 * duplicated in all such forms and that any documentation,
grzemich 0:d7bd7384a37c 70 * advertising materials, and other materials related to such
grzemich 0:d7bd7384a37c 71 * distribution and use acknowledge that the software was developed
grzemich 0:d7bd7384a37c 72 * by Carnegie Mellon University. The name of the
grzemich 0:d7bd7384a37c 73 * University may not be used to endorse or promote products derived
grzemich 0:d7bd7384a37c 74 * from this software without specific prior written permission.
grzemich 0:d7bd7384a37c 75 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
grzemich 0:d7bd7384a37c 76 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
grzemich 0:d7bd7384a37c 77 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
grzemich 0:d7bd7384a37c 78 *
grzemich 0:d7bd7384a37c 79 */
grzemich 0:d7bd7384a37c 80 /*
grzemich 0:d7bd7384a37c 81 * ppp_defs.h - PPP definitions.
grzemich 0:d7bd7384a37c 82 *
grzemich 0:d7bd7384a37c 83 * Copyright (c) 1994 The Australian National University.
grzemich 0:d7bd7384a37c 84 * All rights reserved.
grzemich 0:d7bd7384a37c 85 *
grzemich 0:d7bd7384a37c 86 * Permission to use, copy, modify, and distribute this software and its
grzemich 0:d7bd7384a37c 87 * documentation is hereby granted, provided that the above copyright
grzemich 0:d7bd7384a37c 88 * notice appears in all copies. This software is provided without any
grzemich 0:d7bd7384a37c 89 * warranty, express or implied. The Australian National University
grzemich 0:d7bd7384a37c 90 * makes no representations about the suitability of this software for
grzemich 0:d7bd7384a37c 91 * any purpose.
grzemich 0:d7bd7384a37c 92 *
grzemich 0:d7bd7384a37c 93 * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
grzemich 0:d7bd7384a37c 94 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
grzemich 0:d7bd7384a37c 95 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
grzemich 0:d7bd7384a37c 96 * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
grzemich 0:d7bd7384a37c 97 * OF SUCH DAMAGE.
grzemich 0:d7bd7384a37c 98 *
grzemich 0:d7bd7384a37c 99 * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
grzemich 0:d7bd7384a37c 100 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
grzemich 0:d7bd7384a37c 101 * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
grzemich 0:d7bd7384a37c 102 * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
grzemich 0:d7bd7384a37c 103 * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
grzemich 0:d7bd7384a37c 104 * OR MODIFICATIONS.
grzemich 0:d7bd7384a37c 105 */
grzemich 0:d7bd7384a37c 106
grzemich 0:d7bd7384a37c 107 #define TIMEOUT(f, a, t) do { sys_untimeout((f), (a)); sys_timeout((t)*1000, (f), (a)); } while(0)
grzemich 0:d7bd7384a37c 108 #define UNTIMEOUT(f, a) sys_untimeout((f), (a))
grzemich 0:d7bd7384a37c 109
grzemich 0:d7bd7384a37c 110
grzemich 0:d7bd7384a37c 111 #ifndef __u_char_defined
grzemich 0:d7bd7384a37c 112
grzemich 0:d7bd7384a37c 113 /* Type definitions for BSD code. */
grzemich 0:d7bd7384a37c 114 typedef unsigned long u_long;
grzemich 0:d7bd7384a37c 115 typedef unsigned int u_int;
grzemich 0:d7bd7384a37c 116 typedef unsigned short u_short;
grzemich 0:d7bd7384a37c 117 typedef unsigned char u_char;
grzemich 0:d7bd7384a37c 118
grzemich 0:d7bd7384a37c 119 #endif
grzemich 0:d7bd7384a37c 120
grzemich 0:d7bd7384a37c 121 /*
grzemich 0:d7bd7384a37c 122 * Constants and structures defined by the internet system,
grzemich 0:d7bd7384a37c 123 * Per RFC 790, September 1981, and numerous additions.
grzemich 0:d7bd7384a37c 124 */
grzemich 0:d7bd7384a37c 125
grzemich 0:d7bd7384a37c 126 /*
grzemich 0:d7bd7384a37c 127 * The basic PPP frame.
grzemich 0:d7bd7384a37c 128 */
grzemich 0:d7bd7384a37c 129 #define PPP_HDRLEN 4 /* octets for standard ppp header */
grzemich 0:d7bd7384a37c 130 #define PPP_FCSLEN 2 /* octets for FCS */
grzemich 0:d7bd7384a37c 131
grzemich 0:d7bd7384a37c 132
grzemich 0:d7bd7384a37c 133 /*
grzemich 0:d7bd7384a37c 134 * Significant octet values.
grzemich 0:d7bd7384a37c 135 */
grzemich 0:d7bd7384a37c 136 #define PPP_ALLSTATIONS 0xff /* All-Stations broadcast address */
grzemich 0:d7bd7384a37c 137 #define PPP_UI 0x03 /* Unnumbered Information */
grzemich 0:d7bd7384a37c 138 #define PPP_FLAG 0x7e /* Flag Sequence */
grzemich 0:d7bd7384a37c 139 #define PPP_ESCAPE 0x7d /* Asynchronous Control Escape */
grzemich 0:d7bd7384a37c 140 #define PPP_TRANS 0x20 /* Asynchronous transparency modifier */
grzemich 0:d7bd7384a37c 141
grzemich 0:d7bd7384a37c 142 /*
grzemich 0:d7bd7384a37c 143 * Protocol field values.
grzemich 0:d7bd7384a37c 144 */
grzemich 0:d7bd7384a37c 145 #define PPP_IP 0x21 /* Internet Protocol */
grzemich 0:d7bd7384a37c 146 #define PPP_AT 0x29 /* AppleTalk Protocol */
grzemich 0:d7bd7384a37c 147 #define PPP_VJC_COMP 0x2d /* VJ compressed TCP */
grzemich 0:d7bd7384a37c 148 #define PPP_VJC_UNCOMP 0x2f /* VJ uncompressed TCP */
grzemich 0:d7bd7384a37c 149 #define PPP_COMP 0xfd /* compressed packet */
grzemich 0:d7bd7384a37c 150 #define PPP_IPCP 0x8021 /* IP Control Protocol */
grzemich 0:d7bd7384a37c 151 #define PPP_ATCP 0x8029 /* AppleTalk Control Protocol */
grzemich 0:d7bd7384a37c 152 #define PPP_CCP 0x80fd /* Compression Control Protocol */
grzemich 0:d7bd7384a37c 153 #define PPP_LCP 0xc021 /* Link Control Protocol */
grzemich 0:d7bd7384a37c 154 #define PPP_PAP 0xc023 /* Password Authentication Protocol */
grzemich 0:d7bd7384a37c 155 #define PPP_LQR 0xc025 /* Link Quality Report protocol */
grzemich 0:d7bd7384a37c 156 #define PPP_CHAP 0xc223 /* Cryptographic Handshake Auth. Protocol */
grzemich 0:d7bd7384a37c 157 #define PPP_CBCP 0xc029 /* Callback Control Protocol */
grzemich 0:d7bd7384a37c 158
grzemich 0:d7bd7384a37c 159 /*
grzemich 0:d7bd7384a37c 160 * Values for FCS calculations.
grzemich 0:d7bd7384a37c 161 */
grzemich 0:d7bd7384a37c 162 #define PPP_INITFCS 0xffff /* Initial FCS value */
grzemich 0:d7bd7384a37c 163 #define PPP_GOODFCS 0xf0b8 /* Good final FCS value */
grzemich 0:d7bd7384a37c 164 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
grzemich 0:d7bd7384a37c 165
grzemich 0:d7bd7384a37c 166 /*
grzemich 0:d7bd7384a37c 167 * Extended asyncmap - allows any character to be escaped.
grzemich 0:d7bd7384a37c 168 */
grzemich 0:d7bd7384a37c 169 typedef u_char ext_accm[32];
grzemich 0:d7bd7384a37c 170
grzemich 0:d7bd7384a37c 171 /*
grzemich 0:d7bd7384a37c 172 * What to do with network protocol (NP) packets.
grzemich 0:d7bd7384a37c 173 */
grzemich 0:d7bd7384a37c 174 enum NPmode {
grzemich 0:d7bd7384a37c 175 NPMODE_PASS, /* pass the packet through */
grzemich 0:d7bd7384a37c 176 NPMODE_DROP, /* silently drop the packet */
grzemich 0:d7bd7384a37c 177 NPMODE_ERROR, /* return an error */
grzemich 0:d7bd7384a37c 178 NPMODE_QUEUE /* save it up for later. */
grzemich 0:d7bd7384a37c 179 };
grzemich 0:d7bd7384a37c 180
grzemich 0:d7bd7384a37c 181 /*
grzemich 0:d7bd7384a37c 182 * Inline versions of get/put char/short/long.
grzemich 0:d7bd7384a37c 183 * Pointer is advanced; we assume that both arguments
grzemich 0:d7bd7384a37c 184 * are lvalues and will already be in registers.
grzemich 0:d7bd7384a37c 185 * cp MUST be u_char *.
grzemich 0:d7bd7384a37c 186 */
grzemich 0:d7bd7384a37c 187 #define GETCHAR(c, cp) { \
grzemich 0:d7bd7384a37c 188 (c) = *(cp)++; \
grzemich 0:d7bd7384a37c 189 }
grzemich 0:d7bd7384a37c 190 #define PUTCHAR(c, cp) { \
grzemich 0:d7bd7384a37c 191 *(cp)++ = (u_char) (c); \
grzemich 0:d7bd7384a37c 192 }
grzemich 0:d7bd7384a37c 193
grzemich 0:d7bd7384a37c 194
grzemich 0:d7bd7384a37c 195 #define GETSHORT(s, cp) { \
grzemich 0:d7bd7384a37c 196 (s) = *(cp); (cp)++; (s) <<= 8; \
grzemich 0:d7bd7384a37c 197 (s) |= *(cp); (cp)++; \
grzemich 0:d7bd7384a37c 198 }
grzemich 0:d7bd7384a37c 199 #define PUTSHORT(s, cp) { \
grzemich 0:d7bd7384a37c 200 *(cp)++ = (u_char) ((s) >> 8); \
grzemich 0:d7bd7384a37c 201 *(cp)++ = (u_char) (s & 0xff); \
grzemich 0:d7bd7384a37c 202 }
grzemich 0:d7bd7384a37c 203
grzemich 0:d7bd7384a37c 204 #define GETLONG(l, cp) { \
grzemich 0:d7bd7384a37c 205 (l) = *(cp); (cp)++; (l) <<= 8; \
grzemich 0:d7bd7384a37c 206 (l) |= *(cp); (cp)++; (l) <<= 8; \
grzemich 0:d7bd7384a37c 207 (l) |= *(cp); (cp)++; (l) <<= 8; \
grzemich 0:d7bd7384a37c 208 (l) |= *(cp); (cp)++; \
grzemich 0:d7bd7384a37c 209 }
grzemich 0:d7bd7384a37c 210 #define PUTLONG(l, cp) { \
grzemich 0:d7bd7384a37c 211 *(cp)++ = (u_char) ((l) >> 24); \
grzemich 0:d7bd7384a37c 212 *(cp)++ = (u_char) ((l) >> 16); \
grzemich 0:d7bd7384a37c 213 *(cp)++ = (u_char) ((l) >> 8); \
grzemich 0:d7bd7384a37c 214 *(cp)++ = (u_char) (l); \
grzemich 0:d7bd7384a37c 215 }
grzemich 0:d7bd7384a37c 216
grzemich 0:d7bd7384a37c 217
grzemich 0:d7bd7384a37c 218 #define INCPTR(n, cp) ((cp) += (n))
grzemich 0:d7bd7384a37c 219 #define DECPTR(n, cp) ((cp) -= (n))
grzemich 0:d7bd7384a37c 220
grzemich 0:d7bd7384a37c 221 #define BCMP(s0, s1, l) memcmp((u_char *)(s0), (u_char *)(s1), (l))
grzemich 0:d7bd7384a37c 222 #define BCOPY(s, d, l) MEMCPY((d), (s), (l))
grzemich 0:d7bd7384a37c 223 #define BZERO(s, n) memset(s, 0, n)
grzemich 0:d7bd7384a37c 224
grzemich 0:d7bd7384a37c 225 #if PPP_DEBUG
grzemich 0:d7bd7384a37c 226 #define PRINTMSG(m, l) { m[l] = '\0'; LWIP_DEBUGF(LOG_INFO, ("Remote message: %s\n", m)); }
grzemich 0:d7bd7384a37c 227 #else /* PPP_DEBUG */
grzemich 0:d7bd7384a37c 228 #define PRINTMSG(m, l)
grzemich 0:d7bd7384a37c 229 #endif /* PPP_DEBUG */
grzemich 0:d7bd7384a37c 230
grzemich 0:d7bd7384a37c 231 /*
grzemich 0:d7bd7384a37c 232 * MAKEHEADER - Add PPP Header fields to a packet.
grzemich 0:d7bd7384a37c 233 */
grzemich 0:d7bd7384a37c 234 #define MAKEHEADER(p, t) { \
grzemich 0:d7bd7384a37c 235 PUTCHAR(PPP_ALLSTATIONS, p); \
grzemich 0:d7bd7384a37c 236 PUTCHAR(PPP_UI, p); \
grzemich 0:d7bd7384a37c 237 PUTSHORT(t, p); }
grzemich 0:d7bd7384a37c 238
grzemich 0:d7bd7384a37c 239 /*************************
grzemich 0:d7bd7384a37c 240 *** PUBLIC DEFINITIONS ***
grzemich 0:d7bd7384a37c 241 *************************/
grzemich 0:d7bd7384a37c 242
grzemich 0:d7bd7384a37c 243 /* Error codes. */
grzemich 0:d7bd7384a37c 244 #define PPPERR_NONE 0 /* No error. */
grzemich 0:d7bd7384a37c 245 #define PPPERR_PARAM -1 /* Invalid parameter. */
grzemich 0:d7bd7384a37c 246 #define PPPERR_OPEN -2 /* Unable to open PPP session. */
grzemich 0:d7bd7384a37c 247 #define PPPERR_DEVICE -3 /* Invalid I/O device for PPP. */
grzemich 0:d7bd7384a37c 248 #define PPPERR_ALLOC -4 /* Unable to allocate resources. */
grzemich 0:d7bd7384a37c 249 #define PPPERR_USER -5 /* User interrupt. */
grzemich 0:d7bd7384a37c 250 #define PPPERR_CONNECT -6 /* Connection lost. */
grzemich 0:d7bd7384a37c 251 #define PPPERR_AUTHFAIL -7 /* Failed authentication challenge. */
grzemich 0:d7bd7384a37c 252 #define PPPERR_PROTOCOL -8 /* Failed to meet protocol. */
grzemich 0:d7bd7384a37c 253
grzemich 0:d7bd7384a37c 254 /*
grzemich 0:d7bd7384a37c 255 * PPP IOCTL commands.
grzemich 0:d7bd7384a37c 256 */
grzemich 0:d7bd7384a37c 257 /*
grzemich 0:d7bd7384a37c 258 * Get the up status - 0 for down, non-zero for up. The argument must
grzemich 0:d7bd7384a37c 259 * point to an int.
grzemich 0:d7bd7384a37c 260 */
grzemich 0:d7bd7384a37c 261 #define PPPCTLG_UPSTATUS 100 /* Get the up status - 0 down else up */
grzemich 0:d7bd7384a37c 262 #define PPPCTLS_ERRCODE 101 /* Set the error code */
grzemich 0:d7bd7384a37c 263 #define PPPCTLG_ERRCODE 102 /* Get the error code */
grzemich 0:d7bd7384a37c 264 #define PPPCTLG_FD 103 /* Get the fd associated with the ppp */
grzemich 0:d7bd7384a37c 265
grzemich 0:d7bd7384a37c 266 /************************
grzemich 0:d7bd7384a37c 267 *** PUBLIC DATA TYPES ***
grzemich 0:d7bd7384a37c 268 ************************/
grzemich 0:d7bd7384a37c 269
grzemich 0:d7bd7384a37c 270 /*
grzemich 0:d7bd7384a37c 271 * The following struct gives the addresses of procedures to call
grzemich 0:d7bd7384a37c 272 * for a particular protocol.
grzemich 0:d7bd7384a37c 273 */
grzemich 0:d7bd7384a37c 274 struct protent {
grzemich 0:d7bd7384a37c 275 u_short protocol; /* PPP protocol number */
grzemich 0:d7bd7384a37c 276 /* Initialization procedure */
grzemich 0:d7bd7384a37c 277 void (*init) (int unit);
grzemich 0:d7bd7384a37c 278 /* Process a received packet */
grzemich 0:d7bd7384a37c 279 void (*input) (int unit, u_char *pkt, int len);
grzemich 0:d7bd7384a37c 280 /* Process a received protocol-reject */
grzemich 0:d7bd7384a37c 281 void (*protrej) (int unit);
grzemich 0:d7bd7384a37c 282 /* Lower layer has come up */
grzemich 0:d7bd7384a37c 283 void (*lowerup) (int unit);
grzemich 0:d7bd7384a37c 284 /* Lower layer has gone down */
grzemich 0:d7bd7384a37c 285 void (*lowerdown) (int unit);
grzemich 0:d7bd7384a37c 286 /* Open the protocol */
grzemich 0:d7bd7384a37c 287 void (*open) (int unit);
grzemich 0:d7bd7384a37c 288 /* Close the protocol */
grzemich 0:d7bd7384a37c 289 void (*close) (int unit, char *reason);
grzemich 0:d7bd7384a37c 290 #if PPP_ADDITIONAL_CALLBACKS
grzemich 0:d7bd7384a37c 291 /* Print a packet in readable form */
grzemich 0:d7bd7384a37c 292 int (*printpkt) (u_char *pkt, int len,
grzemich 0:d7bd7384a37c 293 void (*printer) (void *, char *, ...),
grzemich 0:d7bd7384a37c 294 void *arg);
grzemich 0:d7bd7384a37c 295 /* Process a received data packet */
grzemich 0:d7bd7384a37c 296 void (*datainput) (int unit, u_char *pkt, int len);
grzemich 0:d7bd7384a37c 297 #endif /* PPP_ADDITIONAL_CALLBACKS */
grzemich 0:d7bd7384a37c 298 int enabled_flag; /* 0 if protocol is disabled */
grzemich 0:d7bd7384a37c 299 char *name; /* Text name of protocol */
grzemich 0:d7bd7384a37c 300 #if PPP_ADDITIONAL_CALLBACKS
grzemich 0:d7bd7384a37c 301 /* Check requested options, assign defaults */
grzemich 0:d7bd7384a37c 302 void (*check_options) (u_long);
grzemich 0:d7bd7384a37c 303 /* Configure interface for demand-dial */
grzemich 0:d7bd7384a37c 304 int (*demand_conf) (int unit);
grzemich 0:d7bd7384a37c 305 /* Say whether to bring up link for this pkt */
grzemich 0:d7bd7384a37c 306 int (*active_pkt) (u_char *pkt, int len);
grzemich 0:d7bd7384a37c 307 #endif /* PPP_ADDITIONAL_CALLBACKS */
grzemich 0:d7bd7384a37c 308 };
grzemich 0:d7bd7384a37c 309
grzemich 0:d7bd7384a37c 310 /*
grzemich 0:d7bd7384a37c 311 * The following structure records the time in seconds since
grzemich 0:d7bd7384a37c 312 * the last NP packet was sent or received.
grzemich 0:d7bd7384a37c 313 */
grzemich 0:d7bd7384a37c 314 struct ppp_idle {
grzemich 0:d7bd7384a37c 315 u_short xmit_idle; /* seconds since last NP packet sent */
grzemich 0:d7bd7384a37c 316 u_short recv_idle; /* seconds since last NP packet received */
grzemich 0:d7bd7384a37c 317 };
grzemich 0:d7bd7384a37c 318
grzemich 0:d7bd7384a37c 319 struct ppp_settings {
grzemich 0:d7bd7384a37c 320
grzemich 0:d7bd7384a37c 321 u_int disable_defaultip : 1; /* Don't use hostname for default IP addrs */
grzemich 0:d7bd7384a37c 322 u_int auth_required : 1; /* Peer is required to authenticate */
grzemich 0:d7bd7384a37c 323 u_int explicit_remote : 1; /* remote_name specified with remotename opt */
grzemich 0:d7bd7384a37c 324 u_int refuse_pap : 1; /* Don't wanna auth. ourselves with PAP */
grzemich 0:d7bd7384a37c 325 u_int refuse_chap : 1; /* Don't wanna auth. ourselves with CHAP */
grzemich 0:d7bd7384a37c 326 u_int usehostname : 1; /* Use hostname for our_name */
grzemich 0:d7bd7384a37c 327 u_int usepeerdns : 1; /* Ask peer for DNS adds */
grzemich 0:d7bd7384a37c 328
grzemich 0:d7bd7384a37c 329 u_short idle_time_limit; /* Shut down link if idle for this long */
grzemich 0:d7bd7384a37c 330 int maxconnect; /* Maximum connect time (seconds) */
grzemich 0:d7bd7384a37c 331
grzemich 0:d7bd7384a37c 332 char user [MAXNAMELEN + 1]; /* Username for PAP */
grzemich 0:d7bd7384a37c 333 char passwd [MAXSECRETLEN + 1]; /* Password for PAP, secret for CHAP */
grzemich 0:d7bd7384a37c 334 char our_name [MAXNAMELEN + 1]; /* Our name for authentication purposes */
grzemich 0:d7bd7384a37c 335 char remote_name[MAXNAMELEN + 1]; /* Peer's name for authentication */
grzemich 0:d7bd7384a37c 336 };
grzemich 0:d7bd7384a37c 337
grzemich 0:d7bd7384a37c 338 struct ppp_addrs {
grzemich 0:d7bd7384a37c 339 ip_addr_t our_ipaddr, his_ipaddr, netmask, dns1, dns2;
grzemich 0:d7bd7384a37c 340 };
grzemich 0:d7bd7384a37c 341
grzemich 0:d7bd7384a37c 342 /*****************************
grzemich 0:d7bd7384a37c 343 *** PUBLIC DATA STRUCTURES ***
grzemich 0:d7bd7384a37c 344 *****************************/
grzemich 0:d7bd7384a37c 345
grzemich 0:d7bd7384a37c 346 /* Buffers for outgoing packets. */
grzemich 0:d7bd7384a37c 347 extern u_char outpacket_buf[NUM_PPP][PPP_MRU+PPP_HDRLEN];
grzemich 0:d7bd7384a37c 348
grzemich 0:d7bd7384a37c 349 extern struct ppp_settings ppp_settings;
grzemich 0:d7bd7384a37c 350
grzemich 0:d7bd7384a37c 351 extern struct protent *ppp_protocols[]; /* Table of pointers to supported protocols */
grzemich 0:d7bd7384a37c 352
grzemich 0:d7bd7384a37c 353
grzemich 0:d7bd7384a37c 354 /***********************
grzemich 0:d7bd7384a37c 355 *** PUBLIC FUNCTIONS ***
grzemich 0:d7bd7384a37c 356 ***********************/
grzemich 0:d7bd7384a37c 357
grzemich 0:d7bd7384a37c 358 /* Initialize the PPP subsystem. */
grzemich 0:d7bd7384a37c 359 void pppInit(void);
grzemich 0:d7bd7384a37c 360
grzemich 0:d7bd7384a37c 361 /* Warning: Using PPPAUTHTYPE_ANY might have security consequences.
grzemich 0:d7bd7384a37c 362 * RFC 1994 says:
grzemich 0:d7bd7384a37c 363 *
grzemich 0:d7bd7384a37c 364 * In practice, within or associated with each PPP server, there is a
grzemich 0:d7bd7384a37c 365 * database which associates "user" names with authentication
grzemich 0:d7bd7384a37c 366 * information ("secrets"). It is not anticipated that a particular
grzemich 0:d7bd7384a37c 367 * named user would be authenticated by multiple methods. This would
grzemich 0:d7bd7384a37c 368 * make the user vulnerable to attacks which negotiate the least secure
grzemich 0:d7bd7384a37c 369 * method from among a set (such as PAP rather than CHAP). If the same
grzemich 0:d7bd7384a37c 370 * secret was used, PAP would reveal the secret to be used later with
grzemich 0:d7bd7384a37c 371 * CHAP.
grzemich 0:d7bd7384a37c 372 *
grzemich 0:d7bd7384a37c 373 * Instead, for each user name there should be an indication of exactly
grzemich 0:d7bd7384a37c 374 * one method used to authenticate that user name. If a user needs to
grzemich 0:d7bd7384a37c 375 * make use of different authentication methods under different
grzemich 0:d7bd7384a37c 376 * circumstances, then distinct user names SHOULD be employed, each of
grzemich 0:d7bd7384a37c 377 * which identifies exactly one authentication method.
grzemich 0:d7bd7384a37c 378 *
grzemich 0:d7bd7384a37c 379 */
grzemich 0:d7bd7384a37c 380 enum pppAuthType {
grzemich 0:d7bd7384a37c 381 PPPAUTHTYPE_NONE,
grzemich 0:d7bd7384a37c 382 PPPAUTHTYPE_ANY,
grzemich 0:d7bd7384a37c 383 PPPAUTHTYPE_PAP,
grzemich 0:d7bd7384a37c 384 PPPAUTHTYPE_CHAP
grzemich 0:d7bd7384a37c 385 };
grzemich 0:d7bd7384a37c 386
grzemich 0:d7bd7384a37c 387 void pppSetAuth(enum pppAuthType authType, const char *user, const char *passwd);
grzemich 0:d7bd7384a37c 388
grzemich 0:d7bd7384a37c 389 /*
grzemich 0:d7bd7384a37c 390 * Open a new PPP connection using the given serial I/O device.
grzemich 0:d7bd7384a37c 391 * This initializes the PPP control block but does not
grzemich 0:d7bd7384a37c 392 * attempt to negotiate the LCP session.
grzemich 0:d7bd7384a37c 393 * Return a new PPP connection descriptor on success or
grzemich 0:d7bd7384a37c 394 * an error code (negative) on failure.
grzemich 0:d7bd7384a37c 395 */
grzemich 0:d7bd7384a37c 396 int pppOverSerialOpen(sio_fd_t fd, void (*linkStatusCB)(void *ctx, int errCode, void *arg), void *linkStatusCtx);
grzemich 0:d7bd7384a37c 397
grzemich 0:d7bd7384a37c 398 /*
grzemich 0:d7bd7384a37c 399 * Open a new PPP Over Ethernet (PPPOE) connection.
grzemich 0:d7bd7384a37c 400 */
grzemich 0:d7bd7384a37c 401 int pppOverEthernetOpen(struct netif *ethif, const char *service_name, const char *concentrator_name, void (*linkStatusCB)(void *ctx, int errCode, void *arg), void *linkStatusCtx);
grzemich 0:d7bd7384a37c 402
grzemich 0:d7bd7384a37c 403 /* for source code compatibility */
grzemich 0:d7bd7384a37c 404 #define pppOpen(fd,cb,ls) pppOverSerialOpen(fd,cb,ls)
grzemich 0:d7bd7384a37c 405
grzemich 0:d7bd7384a37c 406 /*
grzemich 0:d7bd7384a37c 407 * Close a PPP connection and release the descriptor.
grzemich 0:d7bd7384a37c 408 * Any outstanding packets in the queues are dropped.
grzemich 0:d7bd7384a37c 409 * Return 0 on success, an error code on failure.
grzemich 0:d7bd7384a37c 410 */
grzemich 0:d7bd7384a37c 411 int pppClose(int pd);
grzemich 0:d7bd7384a37c 412
grzemich 0:d7bd7384a37c 413 /*
grzemich 0:d7bd7384a37c 414 * Indicate to the PPP process that the line has disconnected.
grzemich 0:d7bd7384a37c 415 */
grzemich 0:d7bd7384a37c 416 void pppSigHUP(int pd);
grzemich 0:d7bd7384a37c 417
grzemich 0:d7bd7384a37c 418 /*
grzemich 0:d7bd7384a37c 419 * Get and set parameters for the given connection.
grzemich 0:d7bd7384a37c 420 * Return 0 on success, an error code on failure.
grzemich 0:d7bd7384a37c 421 */
grzemich 0:d7bd7384a37c 422 int pppIOCtl(int pd, int cmd, void *arg);
grzemich 0:d7bd7384a37c 423
grzemich 0:d7bd7384a37c 424 /*
grzemich 0:d7bd7384a37c 425 * Return the Maximum Transmission Unit for the given PPP connection.
grzemich 0:d7bd7384a37c 426 */
grzemich 0:d7bd7384a37c 427 u_short pppMTU(int pd);
grzemich 0:d7bd7384a37c 428
grzemich 0:d7bd7384a37c 429 /*
grzemich 0:d7bd7384a37c 430 * Write n characters to a ppp link.
grzemich 0:d7bd7384a37c 431 * RETURN: >= 0 Number of characters written, -1 Failed to write to device.
grzemich 0:d7bd7384a37c 432 */
grzemich 0:d7bd7384a37c 433 int pppWrite(int pd, const u_char *s, int n);
grzemich 0:d7bd7384a37c 434
grzemich 0:d7bd7384a37c 435 void pppInProcOverEthernet(int pd, struct pbuf *pb);
grzemich 0:d7bd7384a37c 436
grzemich 0:d7bd7384a37c 437 struct pbuf *pppSingleBuf(struct pbuf *p);
grzemich 0:d7bd7384a37c 438
grzemich 0:d7bd7384a37c 439 void pppLinkTerminated(int pd);
grzemich 0:d7bd7384a37c 440
grzemich 0:d7bd7384a37c 441 void pppLinkDown(int pd);
grzemich 0:d7bd7384a37c 442
grzemich 0:d7bd7384a37c 443 void pppos_input(int pd, u_char* data, int len);
grzemich 0:d7bd7384a37c 444
grzemich 0:d7bd7384a37c 445 /* Configure i/f transmit parameters */
grzemich 0:d7bd7384a37c 446 void ppp_send_config (int, u16_t, u32_t, int, int);
grzemich 0:d7bd7384a37c 447 /* Set extended transmit ACCM */
grzemich 0:d7bd7384a37c 448 void ppp_set_xaccm (int, ext_accm *);
grzemich 0:d7bd7384a37c 449 /* Configure i/f receive parameters */
grzemich 0:d7bd7384a37c 450 void ppp_recv_config (int, int, u32_t, int, int);
grzemich 0:d7bd7384a37c 451 /* Find out how long link has been idle */
grzemich 0:d7bd7384a37c 452 int get_idle_time (int, struct ppp_idle *);
grzemich 0:d7bd7384a37c 453
grzemich 0:d7bd7384a37c 454 /* Configure VJ TCP header compression */
grzemich 0:d7bd7384a37c 455 int sifvjcomp (int, int, u8_t, u8_t);
grzemich 0:d7bd7384a37c 456 /* Configure i/f down (for IP) */
grzemich 0:d7bd7384a37c 457 int sifup (int);
grzemich 0:d7bd7384a37c 458 /* Set mode for handling packets for proto */
grzemich 0:d7bd7384a37c 459 int sifnpmode (int u, int proto, enum NPmode mode);
grzemich 0:d7bd7384a37c 460 /* Configure i/f down (for IP) */
grzemich 0:d7bd7384a37c 461 int sifdown (int);
grzemich 0:d7bd7384a37c 462 /* Configure IP addresses for i/f */
grzemich 0:d7bd7384a37c 463 int sifaddr (int, u32_t, u32_t, u32_t, u32_t, u32_t);
grzemich 0:d7bd7384a37c 464 /* Reset i/f IP addresses */
grzemich 0:d7bd7384a37c 465 int cifaddr (int, u32_t, u32_t);
grzemich 0:d7bd7384a37c 466 /* Create default route through i/f */
grzemich 0:d7bd7384a37c 467 int sifdefaultroute (int, u32_t, u32_t);
grzemich 0:d7bd7384a37c 468 /* Delete default route through i/f */
grzemich 0:d7bd7384a37c 469 int cifdefaultroute (int, u32_t, u32_t);
grzemich 0:d7bd7384a37c 470
grzemich 0:d7bd7384a37c 471 /* Get appropriate netmask for address */
grzemich 0:d7bd7384a37c 472 u32_t GetMask (u32_t);
grzemich 0:d7bd7384a37c 473
grzemich 0:d7bd7384a37c 474 #if LWIP_NETIF_STATUS_CALLBACK
grzemich 0:d7bd7384a37c 475 void ppp_set_netif_statuscallback(int pd, netif_status_callback_fn status_callback);
grzemich 0:d7bd7384a37c 476 #endif /* LWIP_NETIF_STATUS_CALLBACK */
grzemich 0:d7bd7384a37c 477 #if LWIP_NETIF_LINK_CALLBACK
grzemich 0:d7bd7384a37c 478 void ppp_set_netif_linkcallback(int pd, netif_status_callback_fn link_callback);
grzemich 0:d7bd7384a37c 479 #endif /* LWIP_NETIF_LINK_CALLBACK */
grzemich 0:d7bd7384a37c 480
grzemich 0:d7bd7384a37c 481 #endif /* PPP_SUPPORT */
grzemich 0:d7bd7384a37c 482
grzemich 0:d7bd7384a37c 483 #endif /* PPP_H */