Dependencies:   mbed

Committer:
robertcook
Date:
Wed Jun 13 18:39:46 2012 +0000
Revision:
0:32a0996dff0f

        

Who changed what in which revision?

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