usr.sbin/ppp/hdlc.h

   1 /*-
   2  * Copyright (c) 1996 - 2001 Brian Somers <brian@Awfulhak.org>
   3  *          based on work by Toshiharu OHNO <tony-o@iij.ad.jp>
   4  *                           Internet Initiative Japan, Inc (IIJ)
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD: src/usr.sbin/ppp/hdlc.h,v 1.21.2.1 2001/06/13 21:56:35 brian Exp $
  29  * $DragonFly: src/usr.sbin/ppp/hdlc.h,v 1.2 2003/06/17 04:30:00 dillon Exp $
  30  */
  31
  32 /*
  33  *  Definition for Async HDLC
  34  */
  35 #define HDLC_SYN 0x7e           /* SYNC character */
  36 #define HDLC_ESC 0x7d           /* Escape character */
  37 #define HDLC_XOR 0x20           /* Modifier value */
  38
  39 #define HDLC_ADDR 0xff
  40 #define HDLC_UI   0x03
  41 /*
  42  *  Definition for HDLC Frame Check Sequence
  43  */
  44 #define INITFCS 0xffff          /* Initial value for FCS computation */
  45 #define GOODFCS 0xf0b8          /* Good FCS value */
  46
  47 #define DEF_MRU         1500
  48 #define MAX_MRU         2048
  49 #define MIN_MRU         296
  50
  51 #define DEF_MTU         0       /* whatever peer says */
  52 #define MAX_MTU         2048
  53 #define MIN_MTU         296
  54
  55 struct physical;
  56 struct link;
  57 struct lcp;
  58 struct bundle;
  59 struct mbuf;
  60 struct cmdargs;
  61
  62 struct hdlc {
  63   struct pppTimer ReportTimer;
  64
  65   struct {
  66     int badfcs;
  67     int badaddr;
  68     int badcommand;
  69     int unknownproto;
  70   } laststats, stats;
  71
  72   struct {
  73     struct lcp *owner;                  /* parent LCP */
  74     struct pppTimer timer;              /* When to send */
  75     int method;                         /* bit-mask for LQM_* from lqr.h */
  76
  77     u_int32_t OutPackets;               /* Packets sent by me */
  78     u_int32_t OutOctets;                /* Octets sent by me */
  79     u_int32_t SaveInPackets;            /* Packets received from peer */
  80     u_int32_t SaveInDiscards;           /* Discards */
  81     u_int32_t SaveInErrors;             /* Errors */
  82     u_int32_t SaveInOctets;             /* Octets received from peer */
  83
  84     struct {
  85       u_int32_t OutLQRs;                /* LQRs sent by me */
  86       u_int32_t SaveInLQRs;             /* LQRs received from peer */
  87       struct lqrdata peer;              /* Last LQR from peer */
  88       int peer_timeout;                 /* peers max lqr timeout */
  89       int resent;                       /* Resent last packet `resent' times */
  90     } lqr;
  91
  92     struct {
  93       u_int32_t seq_sent;               /* last echo sent */
  94       u_int32_t seq_recv;               /* last echo received */
  95     } echo;
  96   } lqm;
  97 };
  98
  99
 100 extern void hdlc_Init(struct hdlc *, struct lcp *);
 101 extern void hdlc_StartTimer(struct hdlc *);
 102 extern void hdlc_StopTimer(struct hdlc *);
 103 extern int hdlc_ReportStatus(struct cmdargs const *);
 104 extern const char *hdlc_Protocol2Nam(u_short);
 105 extern void hdlc_DecodePacket(struct bundle *, u_short, struct mbuf *,
 106                               struct link *);
 107
 108 extern u_short hdlc_Fcs(u_char *, size_t);
 109 extern int hdlc_Detect(u_char const **, int, int);
 110 extern int hdlc_WrapperOctets(struct lcp *, u_short);
 111
 112 extern struct layer hdlclayer;