Michael Spencer / Mbed 2 deprecated LaOS

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:   mbed

NetServices/lwip/netif/ppp/ppp.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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