Home | History | Annotate | Line # | Download | only in net 
      1  1.15  knakahar /* $NetBSD: if_pppoe.h,v 1.15 2017/10/12 09:50:55 knakahara Exp $ */
      2   1.1    martin 
      3   1.3    martin /*-
      4   1.3    martin  * Copyright (c) 2002 The NetBSD Foundation, Inc.
      5   1.3    martin  * All rights reserved.
      6   1.3    martin  *
      7   1.3    martin  * This code is derived from software contributed to The NetBSD Foundation
      8   1.5    keihan  * by Martin Husemann <martin (at) NetBSD.org>.
      9   1.1    martin  *
     10   1.1    martin  * Redistribution and use in source and binary forms, with or without
     11   1.1    martin  * modification, are permitted provided that the following conditions
     12   1.1    martin  * are met:
     13   1.1    martin  * 1. Redistributions of source code must retain the above copyright
     14   1.1    martin  *    notice, this list of conditions and the following disclaimer.
     15   1.1    martin  * 2. Redistributions in binary form must reproduce the above copyright
     16   1.1    martin  *    notice, this list of conditions and the following disclaimer in the
     17   1.1    martin  *    documentation and/or other materials provided with the distribution.
     18   1.1    martin  *
     19   1.3    martin  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20   1.3    martin  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21   1.3    martin  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22   1.3    martin  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23   1.3    martin  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24   1.3    martin  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25   1.3    martin  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26   1.3    martin  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27   1.3    martin  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28   1.3    martin  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29   1.3    martin  * POSSIBILITY OF SUCH DAMAGE.
     30   1.1    martin  */
     31   1.1    martin 
     32   1.8      elad #ifndef _NET_IF_PPPOE_H_
     33   1.8      elad #define _NET_IF_PPPOE_H_
     34   1.8      elad 
     35  1.12  dholland #include <sys/ioccom.h>
     36  1.12  dholland 
     37   1.1    martin struct pppoediscparms {
     38   1.1    martin 	char	ifname[IFNAMSIZ];	/* pppoe interface name */
     39   1.1    martin 	char	eth_ifname[IFNAMSIZ];	/* external ethernet interface name */
     40   1.7  christos 	const char *ac_name;		/* access concentrator name (or NULL) */
     41   1.1    martin 	size_t	ac_name_len;		/* on write: length of buffer for ac_name */
     42   1.7  christos 	const char *service_name;	/* service name (or NULL) */
     43   1.1    martin 	size_t	service_name_len;	/* on write: length of buffer for service name */
     44   1.1    martin };
     45   1.1    martin 
     46   1.1    martin #define	PPPOESETPARMS	_IOW('i', 110, struct pppoediscparms)
     47   1.2    martin #define	PPPOEGETPARMS	_IOWR('i', 111, struct pppoediscparms)
     48   1.2    martin 
     49   1.2    martin #define PPPOE_STATE_INITIAL	0
     50   1.2    martin #define PPPOE_STATE_PADI_SENT	1
     51   1.2    martin #define	PPPOE_STATE_PADR_SENT	2
     52   1.2    martin #define	PPPOE_STATE_SESSION	3
     53   1.2    martin #define	PPPOE_STATE_CLOSING	4
     54   1.4       oki /* passive */
     55   1.4       oki #define	PPPOE_STATE_PADO_SENT	1
     56   1.2    martin 
     57   1.2    martin struct pppoeconnectionstate {
     58   1.2    martin 	char	ifname[IFNAMSIZ];	/* pppoe interface name */
     59   1.2    martin 	u_int	state;			/* one of the PPPOE_STATE_ states above */
     60   1.2    martin 	u_int	session_id;		/* if state == PPPOE_STATE_SESSION */
     61   1.2    martin 	u_int	padi_retry_no;		/* number of retries already sent */
     62   1.2    martin 	u_int	padr_retry_no;
     63   1.2    martin };
     64   1.2    martin 
     65   1.2    martin #define PPPOEGETSESSION	_IOWR('i', 112, struct pppoeconnectionstate)
     66   1.2    martin 
     67   1.1    martin #ifdef _KERNEL
     68   1.1    martin 
     69  1.13     ozaki void pppoe_input(struct ifnet *, struct mbuf *);
     70  1.13     ozaki void pppoedisc_input(struct ifnet *, struct mbuf *);
     71   1.8      elad #endif /* _KERNEL */
     72  1.14  knakahar /*
     73  1.15  knakahar  * Locking notes:
     74  1.15  knakahar  * + pppoe_softc_list is protected by pppoe_softc_list_lock (an rwlock)
     75  1.15  knakahar  *     pppoe_softc_list is a list of all pppoe_softc, and it is used to
     76  1.15  knakahar  *     find pppoe interface by session id or host unique tag.
     77  1.15  knakahar  * + pppoe_softc is protected by pppoe_softc->sc_lock (an rwlock)
     78  1.15  knakahar  *     pppoe_softc holds session id and parameters to establish the id
     79  1.15  knakahar  *
     80  1.15  knakahar  * Locking order:
     81  1.15  knakahar  *    - pppoe_softc_list_lock => pppoe_softc->sc_lock
     82  1.14  knakahar  */
     83   1.8      elad #endif /* !_NET_IF_PPPOE_H_ */
     84   1.1    martin 
     85