Eric Wellmon / Http_Wifi_Fileserver

Serves a webpage and saves the user entered data in a .txt file all on the MBED

Dependents:   HTTPServerCustom

Fork of EthernetNetIf by Donatien Garnier

LPC2368/lwip/netif/ppp/ppp.h@6:5ff4a18d103e, 2014-09-29 (annotated)

Committer:
wellmon7
Date:
Mon Sep 29 23:43:13 2014 +0000
Revision:
6:5ff4a18d103e
Parent:
0:422060928e37 
I don't know what this is asking for...we made slight changes to make the router and mbed applicable

Who changed what in which revision?

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