EthernetNetIf -

Users » gbeardall » Code » EthernetNetIf

gavin beardall / Mbed 2 deprecated EthernetNetIf

lwip/include/netif/ppp_oe.h@0:715023d993d6, 2011-10-17 (annotated)

Committer:: gbeardall
Date:: Mon Oct 17 10:39:17 2011 +0000
Revision:: 0:715023d993d6

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed 2 deprecated
Created:	17 Oct 2011
Imports:	79
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	1
Followers:	2

lwip/include/netif/ppp_oe.h@0:715023d993d6, 2011-10-17 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning