ppp-comp.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:6k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  * ppp-comp.h - Definitions for doing PPP packet compression.
  3.  *
  4.  * Copyright (c) 1994 The Australian National University.
  5.  * All rights reserved.
  6.  *
  7.  * Permission to use, copy, modify, and distribute this software and its
  8.  * documentation is hereby granted, provided that the above copyright
  9.  * notice appears in all copies.  This software is provided without any
  10.  * warranty, express or implied. The Australian National University
  11.  * makes no representations about the suitability of this software for
  12.  * any purpose.
  13.  *
  14.  * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
  15.  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  16.  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
  17.  * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
  18.  * OF SUCH DAMAGE.
  19.  *
  20.  * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  21.  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  22.  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  23.  * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
  24.  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
  25.  * OR MODIFICATIONS.
  26.  *
  27.  * $Id: ppp-comp.h,v 1.6 1997/11/27 06:04:44 paulus Exp $
  28.  */
  29. /*
  30.  *  ==FILEVERSION 980319==
  31.  *
  32.  *  NOTE TO MAINTAINERS:
  33.  *     If you modify this file at all, please set the above date.
  34.  *     ppp-comp.h is shipped with a PPP distribution as well as with the kernel;
  35.  *     if everyone increases the FILEVERSION number above, then scripts
  36.  *     can do the right thing when deciding whether to install a new ppp-comp.h
  37.  *     file.  Don't change the format of that line otherwise, so the
  38.  *     installation script can recognize it.
  39.  */
  40. #ifndef _NET_PPP_COMP_H
  41. #define _NET_PPP_COMP_H
  42. /*
  43.  * The following symbols control whether we include code for
  44.  * various compression methods.
  45.  */
  46. #ifndef DO_BSD_COMPRESS
  47. #define DO_BSD_COMPRESS 1 /* by default, include BSD-Compress */
  48. #endif
  49. #ifndef DO_DEFLATE
  50. #define DO_DEFLATE 1 /* by default, include Deflate */
  51. #endif
  52. #define DO_PREDICTOR_1 0
  53. #define DO_PREDICTOR_2 0
  54. /*
  55.  * Structure giving methods for compression/decompression.
  56.  */
  57. struct compressor {
  58. int compress_proto; /* CCP compression protocol number */
  59. /* Allocate space for a compressor (transmit side) */
  60. void *(*comp_alloc) (unsigned char *options, int opt_len);
  61. /* Free space used by a compressor */
  62. void (*comp_free) (void *state);
  63. /* Initialize a compressor */
  64. int (*comp_init) (void *state, unsigned char *options,
  65.       int opt_len, int unit, int opthdr, int debug);
  66. /* Reset a compressor */
  67. void (*comp_reset) (void *state);
  68. /* Compress a packet */
  69. int     (*compress) (void *state, unsigned char *rptr,
  70.       unsigned char *obuf, int isize, int osize);
  71. /* Return compression statistics */
  72. void (*comp_stat) (void *state, struct compstat *stats);
  73. /* Allocate space for a decompressor (receive side) */
  74. void *(*decomp_alloc) (unsigned char *options, int opt_len);
  75. /* Free space used by a decompressor */
  76. void (*decomp_free) (void *state);
  77. /* Initialize a decompressor */
  78. int (*decomp_init) (void *state, unsigned char *options,
  79. int opt_len, int unit, int opthdr, int mru,
  80. int debug);
  81. /* Reset a decompressor */
  82. void (*decomp_reset) (void *state);
  83. /* Decompress a packet. */
  84. int (*decompress) (void *state, unsigned char *ibuf, int isize,
  85. unsigned char *obuf, int osize);
  86. /* Update state for an incompressible packet received */
  87. void (*incomp) (void *state, unsigned char *ibuf, int icnt);
  88. /* Return decompression statistics */
  89. void (*decomp_stat) (void *state, struct compstat *stats);
  90. };
  91. /*
  92.  * The return value from decompress routine is the length of the
  93.  * decompressed packet if successful, otherwise DECOMP_ERROR
  94.  * or DECOMP_FATALERROR if an error occurred.
  95.  * 
  96.  * We need to make this distinction so that we can disable certain
  97.  * useful functionality, namely sending a CCP reset-request as a result
  98.  * of an error detected after decompression.  This is to avoid infringing
  99.  * a patent held by Motorola.
  100.  * Don't you just lurve software patents.
  101.  */
  102. #define DECOMP_ERROR -1 /* error detected before decomp. */
  103. #define DECOMP_FATALERROR -2 /* error detected after decomp. */
  104. /*
  105.  * CCP codes.
  106.  */
  107. #define CCP_CONFREQ 1
  108. #define CCP_CONFACK 2
  109. #define CCP_TERMREQ 5
  110. #define CCP_TERMACK 6
  111. #define CCP_RESETREQ 14
  112. #define CCP_RESETACK 15
  113. /*
  114.  * Max # bytes for a CCP option
  115.  */
  116. #define CCP_MAX_OPTION_LENGTH 32
  117. /*
  118.  * Parts of a CCP packet.
  119.  */
  120. #define CCP_CODE(dp) ((dp)[0])
  121. #define CCP_ID(dp) ((dp)[1])
  122. #define CCP_LENGTH(dp) (((dp)[2] << 8) + (dp)[3])
  123. #define CCP_HDRLEN 4
  124. #define CCP_OPT_CODE(dp) ((dp)[0])
  125. #define CCP_OPT_LENGTH(dp) ((dp)[1])
  126. #define CCP_OPT_MINLEN 2
  127. /*
  128.  * Definitions for BSD-Compress.
  129.  */
  130. #define CI_BSD_COMPRESS 21 /* config. option for BSD-Compress */
  131. #define CILEN_BSD_COMPRESS 3 /* length of config. option */
  132. /* Macros for handling the 3rd byte of the BSD-Compress config option. */
  133. #define BSD_NBITS(x) ((x) & 0x1F) /* number of bits requested */
  134. #define BSD_VERSION(x) ((x) >> 5) /* version of option format */
  135. #define BSD_CURRENT_VERSION 1 /* current version number */
  136. #define BSD_MAKE_OPT(v, n) (((v) << 5) | (n))
  137. #define BSD_MIN_BITS 9 /* smallest code size supported */
  138. #define BSD_MAX_BITS 15 /* largest code size supported */
  139. /*
  140.  * Definitions for Deflate.
  141.  */
  142. #define CI_DEFLATE 26 /* config option for Deflate */
  143. #define CI_DEFLATE_DRAFT 24 /* value used in original draft RFC */
  144. #define CILEN_DEFLATE 4 /* length of its config option */
  145. #define DEFLATE_MIN_SIZE 8
  146. #define DEFLATE_MAX_SIZE 15
  147. #define DEFLATE_METHOD_VAL 8
  148. #define DEFLATE_SIZE(x) (((x) >> 4) + DEFLATE_MIN_SIZE)
  149. #define DEFLATE_METHOD(x) ((x) & 0x0F)
  150. #define DEFLATE_MAKE_OPT(w) ((((w) - DEFLATE_MIN_SIZE) << 4) 
  151.  + DEFLATE_METHOD_VAL)
  152. #define DEFLATE_CHK_SEQUENCE 0
  153. /*
  154.  * Definitions for other, as yet unsupported, compression methods.
  155.  */
  156. #define CI_PREDICTOR_1 1 /* config option for Predictor-1 */
  157. #define CILEN_PREDICTOR_1 2 /* length of its config option */
  158. #define CI_PREDICTOR_2 2 /* config option for Predictor-2 */
  159. #define CILEN_PREDICTOR_2 2 /* length of its config option */
  160. #ifdef __KERNEL__
  161. extern int ppp_register_compressor(struct compressor *);
  162. extern void ppp_unregister_compressor(struct compressor *);
  163. #endif /* __KERNEL__ */
  164. #endif /* _NET_PPP_COMP_H */