FreeBSD/Linux Kernel Cross Reference
sys/net/ppp-comp.h

     /*      $NetBSD: ppp-comp.h,v 1.10 2003/07/08 07:13:52 itojun Exp $     */
     
     /*
      * ppp-comp.h - Definitions for doing PPP packet compression.
      *
      * Copyright (c) 1989-2002 Paul Mackerras. All rights reserved.
      *
      * Redistribution and use in source and binary forms, with or without
      * modification, are permitted provided that the following conditions
     * are met:
     *
     * 1. Redistributions of source code must retain the above copyright
     *    notice, this list of conditions and the following disclaimer.
     *
     * 2. Redistributions in binary form must reproduce the above copyright
     *    notice, this list of conditions and the following disclaimer in
     *    the documentation and/or other materials provided with the
     *    distribution.
     *
     * 3. The name(s) of the authors of this software must not be used to
     *    endorse or promote products derived from this software without
     *    prior written permission.
     *
     * 4. Redistributions of any form whatsoever must retain the following
     *    acknowledgment:
     *    "This product includes software developed by Paul Mackerras
     *     <paulus@samba.org>".
     *
     * THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
     * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
     * AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
     * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
     * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
     * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     */
    
    #ifndef _NET_PPP_COMP_H
    #define _NET_PPP_COMP_H
    
    /*
     * The following symbols control whether we include code for
     * various compression methods.
     */
    #ifndef DO_BSD_COMPRESS
    #define DO_BSD_COMPRESS 1       /* by default, include BSD-Compress */
    #endif
    #ifndef DO_DEFLATE
    #define DO_DEFLATE      1       /* by default, include Deflate */
    #endif
    #define DO_PREDICTOR_1  0
    #define DO_PREDICTOR_2  0
    
    /*
     * How many entries to make available in the compressors table
     */
    #ifndef PPP_COMPRESSORS_MAX
    #define PPP_COMPRESSORS_MAX     8
    #endif
    
    /*
     * Structure giving methods for compression/decompression.
     */
    #ifdef PACKETPTR
    struct compressor {
            int     compress_proto; /* CCP compression protocol number */
    
            /* Allocate space for a compressor (transmit side) */
            void    *(*comp_alloc) __P((u_char *, int));
            /* Free space used by a compressor */
            void    (*comp_free) __P((void *));
            /* Initialize a compressor */
            int     (*comp_init) __P((void *, u_char *, int, int, int, int));
            /* Reset a compressor */
            void    (*comp_reset) __P((void *));
            /* Compress a packet */
            int     (*compress) __P((void *, PACKETPTR *, PACKETPTR, int, int));
            /* Return compression statistics */
            void    (*comp_stat) __P((void *, struct compstat *));
    
            /* Allocate space for a decompressor (receive side) */
            void    *(*decomp_alloc) __P((u_char *, int));
            /* Free space used by a decompressor */
            void    (*decomp_free) __P((void *));
            /* Initialize a decompressor */
            int     (*decomp_init) __P((void *, u_char *, int, int, int, int, int));
            /* Reset a decompressor */
            void    (*decomp_reset) __P((void *));
            /* Decompress a packet. */
            int     (*decompress) __P((void *, PACKETPTR, PACKETPTR *));
            /* Update state for an incompressible packet received */
            void    (*incomp) __P((void *, PACKETPTR));
            /* Return decompression statistics */
            void    (*decomp_stat) __P((void *, struct compstat *));
    };
    #endif /* PACKETPTR */
    
    /*
     * Return values for decompress routine.
    * We need to make these distinctions so that we can disable certain
    * useful functionality, namely sending a CCP reset-request as a result
    * of an error detected after decompression.  This is to avoid infringing
    * a patent held by Motorola.
    * Don't you just lurve software patents.
    */
   #define DECOMP_OK               0       /* everything went OK */
   #define DECOMP_ERROR            1       /* error detected before decomp. */
   #define DECOMP_FATALERROR       2       /* error detected after decomp. */
   
   /*
    * CCP codes.
    */
   #define CCP_CONFREQ     1
   #define CCP_CONFACK     2
   #define CCP_CONFNAK     3
   #define CCP_CONFREJ     4
   #define CCP_TERMREQ     5
   #define CCP_TERMACK     6
   #define CCP_RESETREQ    14
   #define CCP_RESETACK    15
   
   /*
    * Max # bytes for a CCP option
    */
   #define CCP_MAX_OPTION_LENGTH   64
   
   /*
    * Parts of a CCP packet.
    */
   #define CCP_CODE(dp)            ((dp)[0])
   #define CCP_ID(dp)              ((dp)[1])
   #define CCP_LENGTH(dp)          (((dp)[2] << 8) + (dp)[3])
   #define CCP_HDRLEN              4
   
   #define CCP_OPT_CODE(dp)        ((dp)[0])
   #define CCP_OPT_LENGTH(dp)      ((dp)[1])
   #define CCP_OPT_MINLEN          2
   
   /*
    * Definitions for BSD-Compress.
    */
   #define CI_BSD_COMPRESS         21      /* config. option for BSD-Compress */
   #define CILEN_BSD_COMPRESS      3       /* length of config. option */
   
   /* Macros for handling the 3rd byte of the BSD-Compress config option. */
   #define BSD_NBITS(x)            ((x) & 0x1F)    /* number of bits requested */
   #define BSD_VERSION(x)          ((x) >> 5)      /* version of option format */
   #define BSD_CURRENT_VERSION     1               /* current version number */
   #define BSD_MAKE_OPT(v, n)      (((v) << 5) | (n))
   
   #define BSD_MIN_BITS            9       /* smallest code size supported */
   #define BSD_MAX_BITS            15      /* largest code size supported */
   
   /*
    * Definitions for Deflate.
    */
   #define CI_DEFLATE              26      /* config option for Deflate */
   #define CI_DEFLATE_DRAFT        24      /* value used in original draft RFC */
   
   #define CILEN_DEFLATE           4       /* length of its config option */
   
   #define DEFLATE_MIN_SIZE        8
   #define DEFLATE_MAX_SIZE        15
   #define DEFLATE_METHOD_VAL      8
   #define DEFLATE_SIZE(x)         (((x) >> 4) + DEFLATE_MIN_SIZE)
   #define DEFLATE_METHOD(x)       ((x) & 0x0F)
   #define DEFLATE_MAKE_OPT(w)     ((((w) - DEFLATE_MIN_SIZE) << 4) \
                                    + DEFLATE_METHOD_VAL)
   #define DEFLATE_CHK_SEQUENCE    0
   
   /*
    * Definitions for other, as yet unsupported, compression methods.
    */
   #define CI_PREDICTOR_1          1       /* config option for Predictor-1 */
   #define CILEN_PREDICTOR_1       2       /* length of its config option */
   #define CI_PREDICTOR_2          2       /* config option for Predictor-2 */
   #define CILEN_PREDICTOR_2       2       /* length of its config option */
   
   #endif /* _NET_PPP_COMP_H */

Cache object: 55661d6170a7bf5408889ff321f0be99