This library is deprecated.

Dependents:   HTTPClientStreamingExample HTTPClientExample HTTPServerExample HTTPServerHelloWorld ... more

Committer:
donatien
Date:
Fri Jun 11 16:25:22 2010 +0000
Revision:
0:422060928e37
Child:
5:bc7df6da7589

        

Who changed what in which revision?

UserRevisionLine numberNew 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 0:422060928e37 143 struct pppoe_softc;
donatien 0:422060928e37 144
donatien 0:422060928e37 145
donatien 0:422060928e37 146 void pppoe_init(void);
donatien 0:422060928e37 147
donatien 0:422060928e37 148 err_t pppoe_create(struct netif *ethernetnetif, int pd, void (*linkStatusCB)(int pd, int up), struct pppoe_softc **scptr);
donatien 0:422060928e37 149 err_t pppoe_destroy(struct netif *ifp);
donatien 0:422060928e37 150
donatien 0:422060928e37 151 int pppoe_connect(struct pppoe_softc *sc);
donatien 0:422060928e37 152 void pppoe_disconnect(struct pppoe_softc *sc);
donatien 0:422060928e37 153
donatien 0:422060928e37 154 void pppoe_disc_input(struct netif *netif, struct pbuf *p);
donatien 0:422060928e37 155 void pppoe_data_input(struct netif *netif, struct pbuf *p);
donatien 0:422060928e37 156
donatien 0:422060928e37 157 err_t pppoe_xmit(struct pppoe_softc *sc, struct pbuf *pb);
donatien 0:422060928e37 158
donatien 0:422060928e37 159 /** used in ppp.c */
donatien 0:422060928e37 160 #define PPPOE_HDRLEN (sizeof(struct eth_hdr) + PPPOE_HEADERLEN)
donatien 0:422060928e37 161
donatien 0:422060928e37 162 #endif /* PPPOE_SUPPORT */
donatien 0:422060928e37 163
donatien 0:422060928e37 164 #endif /* PPP_OE_H */