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