Dependencies:   mbed

Committer:
slowness
Date:
Tue Sep 06 18:10:36 2011 +0000
Revision:
0:cd4c47744fa1

        

Who changed what in which revision?

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