xref: /freebsd/usr.sbin/ppp/hdlc.h (revision 6e8394b8baa7d5d9153ab90de6824bcd19b3b4e1)
1 /*
2  *	    Written by Toshiharu OHNO (tony-o@iij.ad.jp)
3  *
4  *   Copyright (C) 1993, Internet Initiative Japan, Inc. All rights reserverd.
5  *
6  * Redistribution and use in source and binary forms are permitted
7  * provided that the above copyright notice and this paragraph are
8  * duplicated in all such forms and that any documentation,
9  * advertising materials, and other materials related to such
10  * distribution and use acknowledge that the software was developed
11  * by the Internet Initiative Japan.  The name of the
12  * IIJ may not be used to endorse or promote products derived
13  * from this software without specific prior written permission.
14  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
16  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
17  *
18  * $Id: hdlc.h,v 1.16 1999/04/03 11:54:00 brian Exp $
19  *
20  *	TODO:
21  */
22 
23 /*
24  *  Definition for Async HDLC
25  */
26 #define HDLC_SYN 0x7e		/* SYNC character */
27 #define HDLC_ESC 0x7d		/* Escape character */
28 #define HDLC_XOR 0x20		/* Modifier value */
29 
30 #define	HDLC_ADDR 0xff
31 #define	HDLC_UI	  0x03
32 /*
33  *  Definition for HDLC Frame Check Sequence
34  */
35 #define INITFCS 0xffff		/* Initial value for FCS computation */
36 #define GOODFCS 0xf0b8		/* Good FCS value */
37 
38 #define	DEF_MRU		1500
39 #define	MAX_MRU		2048
40 #define	MIN_MRU		296
41 
42 #define	DEF_MTU		0	/* whatever peer says */
43 #define	MAX_MTU		2048
44 #define	MIN_MTU		296
45 
46 /*
47  *  Output priority
48  */
49 /* PRI_NORMAL and PRI_FAST have meaning only on the IP queue.
50  * All IP frames have the same priority once they are compressed.
51  * IP frames stay on the IP queue till they can be sent on the
52  * link. They are compressed at that time.
53 */
54 #define	PRI_NORMAL	0	/* Normal priority */
55 #define	PRI_FAST	1	/* Fast (interractive) */
56 #define	PRI_LINK	1	/* Urgent (LQR packets) */
57 #define	PRI_MAX		1
58 
59 struct physical;
60 struct link;
61 struct lcp;
62 struct bundle;
63 struct mbuf;
64 struct cmdargs;
65 
66 struct hdlc {
67   struct pppTimer ReportTimer;
68 
69   struct {
70     int badfcs;
71     int badaddr;
72     int badcommand;
73     int unknownproto;
74   } laststats, stats;
75 
76   struct {
77     struct lcp *owner;			/* parent LCP */
78     struct pppTimer timer;		/* When to send */
79     int method;				/* bit-mask for LQM_* from lqr.h */
80 
81     u_int32_t OutPackets;		/* Packets sent by me */
82     u_int32_t OutOctets;		/* Octets sent by me */
83     u_int32_t SaveInPackets;		/* Packets received from peer */
84     u_int32_t SaveInDiscards;		/* Discards */
85     u_int32_t SaveInErrors;		/* Errors */
86     u_int32_t SaveInOctets;		/* Octets received from peer */
87 
88     struct {
89       u_int32_t OutLQRs;		/* LQRs sent by me */
90       u_int32_t SaveInLQRs;		/* LQRs received from peer */
91       struct lqrdata peer;		/* Last LQR from peer */
92       int peer_timeout;			/* peers max lqr timeout */
93       int resent;			/* Resent last packet `resent' times */
94     } lqr;
95 
96     struct {
97       u_int32_t seq_sent;		/* last echo sent */
98       u_int32_t seq_recv;		/* last echo received */
99     } echo;
100   } lqm;
101 };
102 
103 
104 extern void hdlc_Init(struct hdlc *, struct lcp *);
105 extern void hdlc_StartTimer(struct hdlc *);
106 extern void hdlc_StopTimer(struct hdlc *);
107 extern int hdlc_ReportStatus(struct cmdargs const *);
108 extern const char *hdlc_Protocol2Nam(u_short);
109 extern void hdlc_DecodePacket(struct bundle *, u_short, struct mbuf *,
110                               struct link *);
111 
112 extern u_short hdlc_Fcs(u_char *, size_t);
113 extern int hdlc_Detect(u_char const **, int, int);
114 extern int hdlc_WrapperOctets(struct lcp *, u_short);
115 
116 extern struct layer hdlclayer;
117