source: azure_iot_hub_f767zi/trunk/asp_baseplatform/lwip/lwip-2.1.2/src/include/netif/ppp/pppoe.h@ 457

Last change on this file since 457 was 457, checked in by coas-nagasima, 4 years ago

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