xref: /freebsd/usr.sbin/ppp/lqr.h (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 1996 - 2001 Brian Somers <brian@Awfulhak.org>
5  *          based on work by Toshiharu OHNO <tony-o@iij.ad.jp>
6  *                           Internet Initiative Japan, Inc (IIJ)
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 /*
34  *  Structure of LQR packet defined in RFC1989
35  */
36 struct lqrdata {
37   u_int32_t MagicNumber;
38   u_int32_t LastOutLQRs;	/* most recently received PeerOutLQRs */
39   u_int32_t LastOutPackets;	/* most recently received PeerOutPackets */
40   u_int32_t LastOutOctets;	/* most recently received PeerOutOctets */
41   u_int32_t PeerInLQRs;		/* Peers SaveInLQRs */
42   u_int32_t PeerInPackets;	/* Peers SaveInPackets */
43   u_int32_t PeerInDiscards;	/* Peers SaveInDiscards */
44   u_int32_t PeerInErrors;	/* Peers SaveInErrors */
45   u_int32_t PeerInOctets;	/* Peers SaveInOctets */
46   u_int32_t PeerOutLQRs;	/* Peers OutLQRs (hdlc.h) */
47   u_int32_t PeerOutPackets;	/* Peers OutPackets (hdlc.h) */
48   u_int32_t PeerOutOctets;	/* Peers OutOctets (hdlc.h) */
49 };
50 
51 struct lqrsavedata {	/* Saved on receipt of an LQR */
52   u_int32_t InLQRs;	/* From ifInLQRs */
53   u_int32_t InPackets;	/* From ifInPackets */
54   u_int32_t InDiscards;	/* From ifInDiscards */
55   u_int32_t InErrors;	/* From ifInErrors */
56   u_int32_t InOctets;	/* From InGoodOctets ! */
57 };
58 
59 /*
60  *  We support LQR and ECHO as LQM method
61  */
62 #define	LQM_LQR	  1
63 #define	LQM_ECHO  2
64 
65 struct mbuf;
66 struct physical;
67 struct lcp;
68 struct fsm;
69 struct hdlc;
70 struct link;
71 struct bundle;
72 
73 extern void lqr_Dump(const char *, const char *, const struct lqrdata *);
74 extern void lqr_Analyse(const struct hdlc *, const struct lqrdata *,
75                         const struct lqrdata *);
76 extern void lqr_ChangeOrder(struct lqrdata *, struct lqrdata *);
77 extern void lqr_Start(struct lcp *);
78 extern void lqr_reStart(struct lcp *);
79 extern void lqr_Stop(struct physical *, int);
80 extern void lqr_StopTimer(struct physical *);
81 extern struct mbuf *lqr_RecvEcho(struct fsm *, struct mbuf *);
82 extern struct mbuf *lqr_Input(struct bundle *, struct link *, struct mbuf *);
83 
84 extern struct layer lqrlayer;
85