Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/lwip/include/netif/ppp_oe.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ninoderkinderen 0:8d87bc453349 1 /*****************************************************************************
ninoderkinderen 0:8d87bc453349 2 * ppp_oe.h - PPP Over Ethernet implementation for lwIP.
ninoderkinderen 0:8d87bc453349 3 *
ninoderkinderen 0:8d87bc453349 4 * Copyright (c) 2006 by Marc Boucher, Services Informatiques (MBSI) inc.
ninoderkinderen 0:8d87bc453349 5 *
ninoderkinderen 0:8d87bc453349 6 * The authors hereby grant permission to use, copy, modify, distribute,
ninoderkinderen 0:8d87bc453349 7 * and license this software and its documentation for any purpose, provided
ninoderkinderen 0:8d87bc453349 8 * that existing copyright notices are retained in all copies and that this
ninoderkinderen 0:8d87bc453349 9 * notice and the following disclaimer are included verbatim in any
ninoderkinderen 0:8d87bc453349 10 * distributions. No written agreement, license, or royalty fee is required
ninoderkinderen 0:8d87bc453349 11 * for any of the authorized uses.
ninoderkinderen 0:8d87bc453349 12 *
ninoderkinderen 0:8d87bc453349 13 * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR
ninoderkinderen 0:8d87bc453349 14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
ninoderkinderen 0:8d87bc453349 15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
ninoderkinderen 0:8d87bc453349 16 * IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
ninoderkinderen 0:8d87bc453349 17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
ninoderkinderen 0:8d87bc453349 18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
ninoderkinderen 0:8d87bc453349 19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
ninoderkinderen 0:8d87bc453349 20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
ninoderkinderen 0:8d87bc453349 21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
ninoderkinderen 0:8d87bc453349 22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
ninoderkinderen 0:8d87bc453349 23 *
ninoderkinderen 0:8d87bc453349 24 ******************************************************************************
ninoderkinderen 0:8d87bc453349 25 * REVISION HISTORY
ninoderkinderen 0:8d87bc453349 26 *
ninoderkinderen 0:8d87bc453349 27 * 06-01-01 Marc Boucher <marc@mbsi.ca>
ninoderkinderen 0:8d87bc453349 28 * Ported to lwIP.
ninoderkinderen 0:8d87bc453349 29 *****************************************************************************/
ninoderkinderen 0:8d87bc453349 30
ninoderkinderen 0:8d87bc453349 31
ninoderkinderen 0:8d87bc453349 32
ninoderkinderen 0:8d87bc453349 33 /* based on NetBSD: if_pppoe.c,v 1.64 2006/01/31 23:50:15 martin Exp */
ninoderkinderen 0:8d87bc453349 34
ninoderkinderen 0:8d87bc453349 35 /*-
ninoderkinderen 0:8d87bc453349 36 * Copyright (c) 2002 The NetBSD Foundation, Inc.
ninoderkinderen 0:8d87bc453349 37 * All rights reserved.
ninoderkinderen 0:8d87bc453349 38 *
ninoderkinderen 0:8d87bc453349 39 * This code is derived from software contributed to The NetBSD Foundation
ninoderkinderen 0:8d87bc453349 40 * by Martin Husemann <martin@NetBSD.org>.
ninoderkinderen 0:8d87bc453349 41 *
ninoderkinderen 0:8d87bc453349 42 * Redistribution and use in source and binary forms, with or without
ninoderkinderen 0:8d87bc453349 43 * modification, are permitted provided that the following conditions
ninoderkinderen 0:8d87bc453349 44 * are met:
ninoderkinderen 0:8d87bc453349 45 * 1. Redistributions of source code must retain the above copyright
ninoderkinderen 0:8d87bc453349 46 * notice, this list of conditions and the following disclaimer.
ninoderkinderen 0:8d87bc453349 47 * 2. Redistributions in binary form must reproduce the above copyright
ninoderkinderen 0:8d87bc453349 48 * notice, this list of conditions and the following disclaimer in the
ninoderkinderen 0:8d87bc453349 49 * documentation and/or other materials provided with the distribution.
ninoderkinderen 0:8d87bc453349 50 * 3. All advertising materials mentioning features or use of this software
ninoderkinderen 0:8d87bc453349 51 * must display the following acknowledgement:
ninoderkinderen 0:8d87bc453349 52 * This product includes software developed by the NetBSD
ninoderkinderen 0:8d87bc453349 53 * Foundation, Inc. and its contributors.
ninoderkinderen 0:8d87bc453349 54 * 4. Neither the name of The NetBSD Foundation nor the names of its
ninoderkinderen 0:8d87bc453349 55 * contributors may be used to endorse or promote products derived
ninoderkinderen 0:8d87bc453349 56 * from this software without specific prior written permission.
ninoderkinderen 0:8d87bc453349 57 *
ninoderkinderen 0:8d87bc453349 58 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
ninoderkinderen 0:8d87bc453349 59 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
ninoderkinderen 0:8d87bc453349 60 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
ninoderkinderen 0:8d87bc453349 61 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
ninoderkinderen 0:8d87bc453349 62 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
ninoderkinderen 0:8d87bc453349 63 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
ninoderkinderen 0:8d87bc453349 64 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
ninoderkinderen 0:8d87bc453349 65 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
ninoderkinderen 0:8d87bc453349 66 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ninoderkinderen 0:8d87bc453349 67 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
ninoderkinderen 0:8d87bc453349 68 * POSSIBILITY OF SUCH DAMAGE.
ninoderkinderen 0:8d87bc453349 69 */
ninoderkinderen 0:8d87bc453349 70 #ifndef PPP_OE_H
ninoderkinderen 0:8d87bc453349 71 #define PPP_OE_H
ninoderkinderen 0:8d87bc453349 72
ninoderkinderen 0:8d87bc453349 73 #include "lwip/opt.h"
ninoderkinderen 0:8d87bc453349 74
ninoderkinderen 0:8d87bc453349 75 #if PPPOE_SUPPORT > 0
ninoderkinderen 0:8d87bc453349 76
ninoderkinderen 0:8d87bc453349 77 #include "netif/etharp.h"
ninoderkinderen 0:8d87bc453349 78
ninoderkinderen 0:8d87bc453349 79 #ifdef PACK_STRUCT_USE_INCLUDES
ninoderkinderen 0:8d87bc453349 80 # include "arch/bpstruct.h"
ninoderkinderen 0:8d87bc453349 81 #endif
ninoderkinderen 0:8d87bc453349 82 PACK_STRUCT_BEGIN
ninoderkinderen 0:8d87bc453349 83 struct pppoehdr {
ninoderkinderen 0:8d87bc453349 84 PACK_STRUCT_FIELD(u8_t vertype);
ninoderkinderen 0:8d87bc453349 85 PACK_STRUCT_FIELD(u8_t code);
ninoderkinderen 0:8d87bc453349 86 PACK_STRUCT_FIELD(u16_t session);
ninoderkinderen 0:8d87bc453349 87 PACK_STRUCT_FIELD(u16_t plen);
ninoderkinderen 0:8d87bc453349 88 } PACK_STRUCT_STRUCT;
ninoderkinderen 0:8d87bc453349 89 PACK_STRUCT_END
ninoderkinderen 0:8d87bc453349 90 #ifdef PACK_STRUCT_USE_INCLUDES
ninoderkinderen 0:8d87bc453349 91 # include "arch/epstruct.h"
ninoderkinderen 0:8d87bc453349 92 #endif
ninoderkinderen 0:8d87bc453349 93
ninoderkinderen 0:8d87bc453349 94 #ifdef PACK_STRUCT_USE_INCLUDES
ninoderkinderen 0:8d87bc453349 95 # include "arch/bpstruct.h"
ninoderkinderen 0:8d87bc453349 96 #endif
ninoderkinderen 0:8d87bc453349 97 PACK_STRUCT_BEGIN
ninoderkinderen 0:8d87bc453349 98 struct pppoetag {
ninoderkinderen 0:8d87bc453349 99 PACK_STRUCT_FIELD(u16_t tag);
ninoderkinderen 0:8d87bc453349 100 PACK_STRUCT_FIELD(u16_t len);
ninoderkinderen 0:8d87bc453349 101 } PACK_STRUCT_STRUCT;
ninoderkinderen 0:8d87bc453349 102 PACK_STRUCT_END
ninoderkinderen 0:8d87bc453349 103 #ifdef PACK_STRUCT_USE_INCLUDES
ninoderkinderen 0:8d87bc453349 104 # include "arch/epstruct.h"
ninoderkinderen 0:8d87bc453349 105 #endif
ninoderkinderen 0:8d87bc453349 106
ninoderkinderen 0:8d87bc453349 107
ninoderkinderen 0:8d87bc453349 108 #define PPPOE_STATE_INITIAL 0
ninoderkinderen 0:8d87bc453349 109 #define PPPOE_STATE_PADI_SENT 1
ninoderkinderen 0:8d87bc453349 110 #define PPPOE_STATE_PADR_SENT 2
ninoderkinderen 0:8d87bc453349 111 #define PPPOE_STATE_SESSION 3
ninoderkinderen 0:8d87bc453349 112 #define PPPOE_STATE_CLOSING 4
ninoderkinderen 0:8d87bc453349 113 /* passive */
ninoderkinderen 0:8d87bc453349 114 #define PPPOE_STATE_PADO_SENT 1
ninoderkinderen 0:8d87bc453349 115
ninoderkinderen 0:8d87bc453349 116 #define PPPOE_HEADERLEN sizeof(struct pppoehdr)
ninoderkinderen 0:8d87bc453349 117 #define PPPOE_VERTYPE 0x11 /* VER=1, TYPE = 1 */
ninoderkinderen 0:8d87bc453349 118
ninoderkinderen 0:8d87bc453349 119 #define PPPOE_TAG_EOL 0x0000 /* end of list */
ninoderkinderen 0:8d87bc453349 120 #define PPPOE_TAG_SNAME 0x0101 /* service name */
ninoderkinderen 0:8d87bc453349 121 #define PPPOE_TAG_ACNAME 0x0102 /* access concentrator name */
ninoderkinderen 0:8d87bc453349 122 #define PPPOE_TAG_HUNIQUE 0x0103 /* host unique */
ninoderkinderen 0:8d87bc453349 123 #define PPPOE_TAG_ACCOOKIE 0x0104 /* AC cookie */
ninoderkinderen 0:8d87bc453349 124 #define PPPOE_TAG_VENDOR 0x0105 /* vendor specific */
ninoderkinderen 0:8d87bc453349 125 #define PPPOE_TAG_RELAYSID 0x0110 /* relay session id */
ninoderkinderen 0:8d87bc453349 126 #define PPPOE_TAG_SNAME_ERR 0x0201 /* service name error */
ninoderkinderen 0:8d87bc453349 127 #define PPPOE_TAG_ACSYS_ERR 0x0202 /* AC system error */
ninoderkinderen 0:8d87bc453349 128 #define PPPOE_TAG_GENERIC_ERR 0x0203 /* gerneric error */
ninoderkinderen 0:8d87bc453349 129
ninoderkinderen 0:8d87bc453349 130 #define PPPOE_CODE_PADI 0x09 /* Active Discovery Initiation */
ninoderkinderen 0:8d87bc453349 131 #define PPPOE_CODE_PADO 0x07 /* Active Discovery Offer */
ninoderkinderen 0:8d87bc453349 132 #define PPPOE_CODE_PADR 0x19 /* Active Discovery Request */
ninoderkinderen 0:8d87bc453349 133 #define PPPOE_CODE_PADS 0x65 /* Active Discovery Session confirmation */
ninoderkinderen 0:8d87bc453349 134 #define PPPOE_CODE_PADT 0xA7 /* Active Discovery Terminate */
ninoderkinderen 0:8d87bc453349 135
ninoderkinderen 0:8d87bc453349 136 #ifndef ETHERMTU
ninoderkinderen 0:8d87bc453349 137 #define ETHERMTU 1500
ninoderkinderen 0:8d87bc453349 138 #endif
ninoderkinderen 0:8d87bc453349 139
ninoderkinderen 0:8d87bc453349 140 /* two byte PPP protocol discriminator, then IP data */
ninoderkinderen 0:8d87bc453349 141 #define PPPOE_MAXMTU (ETHERMTU-PPPOE_HEADERLEN-2)
ninoderkinderen 0:8d87bc453349 142
ninoderkinderen 0:8d87bc453349 143 #ifndef PPPOE_MAX_AC_COOKIE_LEN
ninoderkinderen 0:8d87bc453349 144 #define PPPOE_MAX_AC_COOKIE_LEN 64
ninoderkinderen 0:8d87bc453349 145 #endif
ninoderkinderen 0:8d87bc453349 146
ninoderkinderen 0:8d87bc453349 147 struct pppoe_softc {
ninoderkinderen 0:8d87bc453349 148 struct pppoe_softc *next;
ninoderkinderen 0:8d87bc453349 149 struct netif *sc_ethif; /* ethernet interface we are using */
ninoderkinderen 0:8d87bc453349 150 int sc_pd; /* ppp unit number */
ninoderkinderen 0:8d87bc453349 151 void (*sc_linkStatusCB)(int pd, int up);
ninoderkinderen 0:8d87bc453349 152
ninoderkinderen 0:8d87bc453349 153 int sc_state; /* discovery phase or session connected */
ninoderkinderen 0:8d87bc453349 154 struct eth_addr sc_dest; /* hardware address of concentrator */
ninoderkinderen 0:8d87bc453349 155 u16_t sc_session; /* PPPoE session id */
ninoderkinderen 0:8d87bc453349 156
ninoderkinderen 0:8d87bc453349 157 #ifdef PPPOE_TODO
ninoderkinderen 0:8d87bc453349 158 char *sc_service_name; /* if != NULL: requested name of service */
ninoderkinderen 0:8d87bc453349 159 char *sc_concentrator_name; /* if != NULL: requested concentrator id */
ninoderkinderen 0:8d87bc453349 160 #endif /* PPPOE_TODO */
ninoderkinderen 0:8d87bc453349 161 u8_t sc_ac_cookie[PPPOE_MAX_AC_COOKIE_LEN]; /* content of AC cookie we must echo back */
ninoderkinderen 0:8d87bc453349 162 size_t sc_ac_cookie_len; /* length of cookie data */
ninoderkinderen 0:8d87bc453349 163 #ifdef PPPOE_SERVER
ninoderkinderen 0:8d87bc453349 164 u8_t *sc_hunique; /* content of host unique we must echo back */
ninoderkinderen 0:8d87bc453349 165 size_t sc_hunique_len; /* length of host unique */
ninoderkinderen 0:8d87bc453349 166 #endif
ninoderkinderen 0:8d87bc453349 167 int sc_padi_retried; /* number of PADI retries already done */
ninoderkinderen 0:8d87bc453349 168 int sc_padr_retried; /* number of PADR retries already done */
ninoderkinderen 0:8d87bc453349 169 };
ninoderkinderen 0:8d87bc453349 170
ninoderkinderen 0:8d87bc453349 171
ninoderkinderen 0:8d87bc453349 172 #define pppoe_init() /* compatibility define, no initialization needed */
ninoderkinderen 0:8d87bc453349 173
ninoderkinderen 0:8d87bc453349 174 err_t pppoe_create(struct netif *ethif, int pd, void (*linkStatusCB)(int pd, int up), struct pppoe_softc **scptr);
ninoderkinderen 0:8d87bc453349 175 err_t pppoe_destroy(struct netif *ifp);
ninoderkinderen 0:8d87bc453349 176
ninoderkinderen 0:8d87bc453349 177 int pppoe_connect(struct pppoe_softc *sc);
ninoderkinderen 0:8d87bc453349 178 void pppoe_disconnect(struct pppoe_softc *sc);
ninoderkinderen 0:8d87bc453349 179
ninoderkinderen 0:8d87bc453349 180 void pppoe_disc_input(struct netif *netif, struct pbuf *p);
ninoderkinderen 0:8d87bc453349 181 void pppoe_data_input(struct netif *netif, struct pbuf *p);
ninoderkinderen 0:8d87bc453349 182
ninoderkinderen 0:8d87bc453349 183 err_t pppoe_xmit(struct pppoe_softc *sc, struct pbuf *pb);
ninoderkinderen 0:8d87bc453349 184
ninoderkinderen 0:8d87bc453349 185 /** used in ppp.c */
ninoderkinderen 0:8d87bc453349 186 #define PPPOE_HDRLEN (sizeof(struct eth_hdr) + PPPOE_HEADERLEN)
ninoderkinderen 0:8d87bc453349 187
ninoderkinderen 0:8d87bc453349 188 #endif /* PPPOE_SUPPORT */
ninoderkinderen 0:8d87bc453349 189
ninoderkinderen 0:8d87bc453349 190 #endif /* PPP_OE_H */