Annotation of kernel/bsd/netccitt/hdlc.h, revision 1.1.1.1

1.1       root        1: /*
                      2:  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
                      3:  *
                      4:  * @APPLE_LICENSE_HEADER_START@
                      5:  * 
                      6:  * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
                      7:  * Reserved.  This file contains Original Code and/or Modifications of
                      8:  * Original Code as defined in and that are subject to the Apple Public
                      9:  * Source License Version 1.1 (the "License").  You may not use this file
                     10:  * except in compliance with the License.  Please obtain a copy of the
                     11:  * License at http://www.apple.com/publicsource and read it before using
                     12:  * this file.
                     13:  * 
                     14:  * The Original Code and all software distributed under the License are
                     15:  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
                     16:  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
                     17:  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
                     18:  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
                     19:  * License for the specific language governing rights and limitations
                     20:  * under the License.
                     21:  * 
                     22:  * @APPLE_LICENSE_HEADER_END@
                     23:  */
                     24: 
                     25: /*-
                     26:  * Copyright (c) University of British Columbia, 1984
                     27:  * Copyright (c) 1991, 1993
                     28:  *     The Regents of the University of California.  All rights reserved.
                     29:  *
                     30:  * This code is derived from software contributed to Berkeley by the
                     31:  * Laboratory for Computation Vision and the Computer Science Department
                     32:  * of the University of British Columbia.
                     33:  *
                     34:  * Redistribution and use in source and binary forms, with or without
                     35:  * modification, are permitted provided that the following conditions
                     36:  * are met:
                     37:  * 1. Redistributions of source code must retain the above copyright
                     38:  *    notice, this list of conditions and the following disclaimer.
                     39:  * 2. Redistributions in binary form must reproduce the above copyright
                     40:  *    notice, this list of conditions and the following disclaimer in the
                     41:  *    documentation and/or other materials provided with the distribution.
                     42:  * 3. All advertising materials mentioning features or use of this software
                     43:  *    must display the following acknowledgement:
                     44:  *     This product includes software developed by the University of
                     45:  *     California, Berkeley and its contributors.
                     46:  * 4. Neither the name of the University nor the names of its contributors
                     47:  *    may be used to endorse or promote products derived from this software
                     48:  *    without specific prior written permission.
                     49:  *
                     50:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     51:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     52:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     53:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     54:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     55:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     56:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     57:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     58:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     59:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     60:  * SUCH DAMAGE.
                     61:  *
                     62:  *     @(#)hdlc.h      8.1 (Berkeley) 6/10/93
                     63:  */
                     64: 
                     65: #ifndef ORDER4
                     66: #define FALSE   0
                     67: #define TRUE    1
                     68: typedef u_char octet;
                     69: typedef char    bool;
                     70: 
                     71: /*
                     72:  *  HDLC Packet format definitions
                     73:  *  This will eventually have to be rewritten without reference
                     74:  *  to bit fields, to be compliant with ANSI C and alignment safe.
                     75:  */
                     76: 
                     77: #if BYTE_ORDER == BIG_ENDIAN
                     78: #define ORDER4(a, b, c, d) a , b , c , d
                     79: #define ORDER5(a, b, c, d, e) a , b , c , d , e
                     80: #endif
                     81: 
                     82: #if BYTE_ORDER == LITTLE_ENDIAN
                     83: #define ORDER4(a, b, c, d) d , c , b , a
                     84: #define ORDER5(a, b, c, d, e) e , d , c , b , a
                     85: #endif
                     86: #endif
                     87: 
                     88: #define MAX_INFO_LEN    4096+3+4
                     89: #define ADDRESS_A       3      /* B'00000011' */
                     90: #define ADDRESS_B       1      /* B'00000001' */
                     91: 
                     92: struct Hdlc_iframe {
                     93:        octet   address;
                     94:        octet   ORDER4(nr:3, pf:1, ns:3, hdlc_0:1);
                     95:        octet    i_field[MAX_INFO_LEN];
                     96: };
                     97: 
                     98: struct Hdlc_sframe {
                     99:        octet   address;
                    100:        octet   ORDER4(nr:3, pf:1, s2:2, hdlc_01:2);
                    101: };
                    102: 
                    103: struct Hdlc_uframe {
                    104:        octet   address;
                    105:        octet   ORDER4(m3:3, pf:1, m2:2, hdlc_11:2);
                    106: };
                    107: 
                    108: struct Frmr_frame {
                    109:        octet   address;
                    110:        octet   control;
                    111:        octet   frmr_control;
                    112:        octet   ORDER4(frmr_nr:3, frmr_f1_0:1, frmr_ns:3, frmr_f2_0:1);
                    113:        octet   ORDER5(frmr_0000:4, frmr_z:1, frmr_y:1, frmr_x:1, frmr_w:1);
                    114: };
                    115: 
                    116: #define HDHEADERLN     2
                    117: #define MINFRLN                2               /* Minimum frame length. */
                    118: 
                    119: struct Hdlc_frame {
                    120:        octet   address;
                    121:        octet   control;
                    122:        octet   info[3];        /* min for FRMR */
                    123: };
                    124: 
                    125: #define SABM_CONTROL 057       /* B'00101111' */
                    126: #define UA_CONTROL   0143      /* B'01100011' */
                    127: #define DISC_CONTROL 0103      /* B'01000011' */
                    128: #define DM_CONTROL   017       /* B'00001111' */
                    129: #define FRMR_CONTROL 0207      /* B'10000111' */
                    130: #define RR_CONTROL   01                /* B'00000001' */
                    131: #define RNR_CONTROL  05                /* B'00000101' */
                    132: #define REJ_CONTROL  011       /* B'00001001' */
                    133: 
                    134: #define POLLOFF  0
                    135: #define POLLON   1
                    136: 
                    137: /* Define Link State constants. */
                    138: 
                    139: #define INIT           0
                    140: #define DM_SENT                1
                    141: #define SABM_SENT      2
                    142: #define ABM            3
                    143: #define WAIT_SABM      4
                    144: #define WAIT_UA                5
                    145: #define DISC_SENT      6
                    146: #define DISCONNECTED   7
                    147: #define MAXSTATE       8
                    148: 
                    149: /* The following constants are used in a switch statement to process
                    150:    frames read from the communications line. */
                    151: 
                    152: #define SABM     0 * MAXSTATE
                    153: #define DM       1 * MAXSTATE
                    154: #define DISC     2 * MAXSTATE
                    155: #define UA       3 * MAXSTATE
                    156: #define FRMR     4 * MAXSTATE
                    157: #define RR       5 * MAXSTATE
                    158: #define RNR      6 * MAXSTATE
                    159: #define REJ      7 * MAXSTATE
                    160: #define IFRAME   8 * MAXSTATE
                    161: #define ILLEGAL  9 * MAXSTATE
                    162: 
                    163: #define T1     (3 * PR_SLOWHZ)         /*  IFRAME TIMEOUT - 3 seconds */
                    164: #define T3     (T1 / 2)                /*  RR generate timeout - 1.5 seconds */
                    165: #define N2     10
                    166: #define MODULUS 8
                    167: #define MAX_WINDOW_SIZE 7
                    168: 
                    169: #define Z  0
                    170: #define Y  1
                    171: #define X  2
                    172: #define W  3
                    173: #define A  4
                    174: 
                    175: #define TX 0
                    176: #define RX 1
                    177: 
                    178: bool   range_check ();
                    179: bool   valid_nr ();
                    180: struct mbuf *hd_remove ();

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.