]> git.ozlabs.org Git - ppp.git/blobdiff - include/net/ppp-comp.h
pppd man page: Update header to refer to pppd 2.5.x
[ppp.git] / include / net / ppp-comp.h
index 0dc5d1d429f3524932bb11a8ad925a3c2a7b048f..c9a0304b3b292c04a8b39e4b5541b6c626905049 100644 (file)
@@ -1,70 +1,96 @@
 /*
  * ppp-comp.h - Definitions for doing PPP packet compression.
  *
- * Copyright (c) 1994 The Australian National University.
- * All rights reserved.
+ * Copyright (c) 1994 Paul Mackerras. All rights reserved.
  *
- * Permission to use, copy, modify, and distribute this software and its
- * documentation is hereby granted, provided that the above copyright
- * notice appears in all copies.  This software is provided without any
- * warranty, express or implied. The Australian National University
- * makes no representations about the suitability of this software for
- * any purpose.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
  *
- * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
- * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
- * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
- * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
- * OF SUCH DAMAGE.
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
  *
- * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
- * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
- * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
- * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
- * OR MODIFICATIONS.
+ * 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.
  *
- * $Id: ppp-comp.h,v 1.5 1994/12/05 00:33:33 paulus Exp $
+ * 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@ozlabs.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.
+ *
+ * $Id: ppp-comp.h,v 1.13 2002/12/06 09:49:15 paulus Exp $
  */
 
+#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
+
 /*
  * 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 *options, int opt_len));
+       void    *(*comp_alloc)(u_char *options, int opt_len);
        /* Free space used by a compressor */
-       void    (*comp_free) __P((void *state));
+       void    (*comp_free)(void *state);
        /* Initialize a compressor */
-       int     (*comp_init) __P((void *state, u_char *options, int opt_len,
-                                 int unit, int debug));
+       int     (*comp_init)(void *state, u_char *options, int opt_len,
+                            int unit, int hdrlen, int debug);
        /* Reset a compressor */
-       void    (*comp_reset) __P((void *state));
+       void    (*comp_reset)(void *state);
        /* Compress a packet */
-       int     (*compress) __P((void *state, PACKETPTR *mret,
-                                PACKETPTR mp, int orig_len, int max_len));
+       int     (*compress)(void *state, PACKETPTR *mret,
+                           PACKETPTR mp, int orig_len, int max_len);
        /* Return compression statistics */
-       void    (*comp_stat) __P((void *state, struct compstat *stats));
+       void    (*comp_stat)(void *state, struct compstat *stats);
 
        /* Allocate space for a decompressor (receive side) */
-       void    *(*decomp_alloc) __P((u_char *options, int opt_len));
+       void    *(*decomp_alloc)(u_char *options, int opt_len);
        /* Free space used by a decompressor */
-       void    (*decomp_free) __P((void *state));
+       void    (*decomp_free)(void *state);
        /* Initialize a decompressor */
-       int     (*decomp_init) __P((void *state, u_char *options, int opt_len,
-                                   int unit, int hdrlen, int mru, int debug));
+       int     (*decomp_init)(void *state, u_char *options, int opt_len,
+                              int unit, int hdrlen, int mru, int debug);
        /* Reset a decompressor */
-       void    (*decomp_reset) __P((void *state));
+       void    (*decomp_reset)(void *state);
        /* Decompress a packet. */
-       int     (*decompress) __P((void *state, PACKETPTR mp,
-                                  PACKETPTR *dmpp));
+       int     (*decompress)(void *state, PACKETPTR mp,
+                             PACKETPTR *dmpp);
        /* Update state for an incompressible packet received */
-       void    (*incomp) __P((void *state, PACKETPTR mp));
+       void    (*incomp)(void *state, PACKETPTR mp);
        /* Return decompression statistics */
-       void    (*decomp_stat) __P((void *state, struct compstat *stats));
+       void    (*decomp_stat)(void *state, struct compstat *stats);
 };
+#endif /* PACKETPTR */
 
 /*
  * Return values for decompress routine.
@@ -105,3 +131,49 @@ struct compressor {
 #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 MPPE.
+ */
+#define CI_MPPE                        18      /* config option for MPPE */
+#define CILEN_MPPE             6       /* length of config option */
+
+/*
+ * 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 */