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