Pranav Sawant / EthernetNetIf

12Oct2012MbedLab

Dependents:   Lab3_VoiceMeter

Fork of EthernetNetIf by Donatien Garnier

LPC2368/lwip/include/netif/ppp_oe.h@6:22ce63eddd2b, 2012-10-12 (annotated)

Committer:
psawant9
Date:
Fri Oct 12 16:02:00 2012 +0000
Revision:
6:22ce63eddd2b
Parent:
5:bc7df6da7589 
Done

Who changed what in which revision?

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