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

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