Adam Green / EthernetInterface

Deprecated fork of old network stack source from github. Please use official library instead: https://mbed.org/users/mbed_official/code/EthernetInterface/

lwip/include/netif/ppp_oe.h@1:eadc868c2acf, 2013-10-26 (annotated)

Committer:
AdamGreen
Date:
Sat Oct 26 08:51:36 2013 +0000
Revision:
1:eadc868c2acf
Parent:
0:3b00827bb0b7 
Fix TCP checksum bug and stranded large TCP segments.

Who changed what in which revision?

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