updated for 2.3

[ppp.git] / include / net / ppp-comp.h

diff --git a/include/net/ppp-comp.h b/include/net/ppp-comp.h
index aa158ed16b4b2326d97ede05786443e89ccdca04..61ee35e3cc882ad54924eca35f8b1934cdfd2f67 100644 (file)
--- a/include/net/ppp-comp.h
+++ b/include/net/ppp-comp.h
@@ -24,12 +24,29 @@
  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
  * OR MODIFICATIONS.
  *
  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
  * OR MODIFICATIONS.
  *

- * $Id: ppp-comp.h,v 1.1 1994/08/31 23:55:58 paulus Exp $
+ * $Id: ppp-comp.h,v 1.9 1996/01/18 03:18:39 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.
  */
 /*
  * Structure giving methods for compression/decompression.
  */

+#ifdef PACKETPTR

 struct compressor {
        int     compress_proto; /* CCP compression protocol number */
 
 struct compressor {
        int     compress_proto; /* CCP compression protocol number */
 


@@ -39,12 +56,14 @@ struct compressor {
        void    (*comp_free) __P((void *state));
        /* Initialize a compressor */
        int     (*comp_init) __P((void *state, u_char *options, int opt_len,
        void    (*comp_free) __P((void *state));
        /* Initialize a compressor */
        int     (*comp_init) __P((void *state, u_char *options, int opt_len,

-                                 int unit, int debug));
+                                 int unit, int hdrlen, int debug));

        /* Reset a compressor */
        void    (*comp_reset) __P((void *state));
        /* Compress a packet */
        /* Reset a compressor */
        void    (*comp_reset) __P((void *state));
        /* Compress a packet */

-       int     (*compress) __P((void *state, PACKET **mret,
-                                PACKET *mp, int orig_len, int max_len));
+       int     (*compress) __P((void *state, PACKETPTR *mret,
+                                PACKETPTR mp, int orig_len, int max_len));
+       /* Return compression statistics */
+       void    (*comp_stat) __P((void *state, struct compstat *stats));

 
        /* Allocate space for a decompressor (receive side) */
        void    *(*decomp_alloc) __P((u_char *options, int opt_len));
 
        /* Allocate space for a decompressor (receive side) */
        void    *(*decomp_alloc) __P((u_char *options, int opt_len));


@@ -52,15 +71,30 @@ struct compressor {
        void    (*decomp_free) __P((void *state));
        /* Initialize a decompressor */
        int     (*decomp_init) __P((void *state, u_char *options, int opt_len,
        void    (*decomp_free) __P((void *state));
        /* Initialize a decompressor */
        int     (*decomp_init) __P((void *state, u_char *options, int opt_len,

-                                   int unit, int mru, int debug));
+                                   int unit, int hdrlen, int mru, int debug));

        /* Reset a decompressor */
        void    (*decomp_reset) __P((void *state));
        /* Decompress a packet. */
        /* Reset a decompressor */
        void    (*decomp_reset) __P((void *state));
        /* Decompress a packet. */

-       PACKET  *(*decompress) __P((void *state, PACKET *mp,
-                                        int hdroff));
+       int     (*decompress) __P((void *state, PACKETPTR mp,
+                                  PACKETPTR *dmpp));

        /* Update state for an incompressible packet received */
        /* Update state for an incompressible packet received */

-       void    (*incomp) __P((void *state, PACKET *mp));
+       void    (*incomp) __P((void *state, PACKETPTR mp));
+       /* Return decompression statistics */
+       void    (*decomp_stat) __P((void *state, struct compstat *stats));

 };
 };

+#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.
 
 /*
  * CCP codes.


@@ -89,3 +123,39 @@ struct compressor {
 #define CCP_OPT_LENGTH(dp)     ((dp)[1])
 #define CCP_OPT_MINLEN         2
 
 #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 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 */
+
+#define CI_DEFLATE             24      /* config option for Deflate */
+#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
+
+#endif /* _NET_PPP_COMP_H */