git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP_130/src/netif/ppp/ppp.h

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