source: rtems-libbsd/rtemsbsd/sys/net/ppp_comp.h @ 70fa95a

4.1155-freebsd-126-freebsd-12freebsd-9.3
Last change on this file since 70fa95a was 70fa95a, checked in by Sebastian Huber <sebastian.huber@…>, on Sep 30, 2014 at 12:46:12 PM

ppp: Import from RTEMS sources

  • Property mode set to 100644
File size: 5.5 KB
Line 
1/*
2 * ppp-comp.h - Definitions for doing PPP packet compression.
3 */
4/*
5 * Copyright (c) 1994 The Australian National University.
6 * All rights reserved.
7 *
8 * Permission to use, copy, modify, and distribute this software and its
9 * documentation is hereby granted, provided that the above copyright
10 * notice appears in all copies.  This software is provided without any
11 * warranty, express or implied. The Australian National University
12 * makes no representations about the suitability of this software for
13 * any purpose.
14 *
15 * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
16 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
17 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
18 * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
19 * OF SUCH DAMAGE.
20 *
21 * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
22 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
23 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
24 * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
25 * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
26 * OR MODIFICATIONS.
27 * $FreeBSD: src/sys/net/ppp_comp.h,v 1.12 2005/01/07 01:45:35 imp Exp $
28 */
29
30
31#ifndef _NET_PPP_COMP_H
32#define _NET_PPP_COMP_H
33
34/*
35 * The following symbols control whether we include code for
36 * various compression methods.
37 */
38#ifndef DO_BSD_COMPRESS
39#define DO_BSD_COMPRESS 0       /* by default, include BSD-Compress */
40#endif
41#ifndef DO_DEFLATE
42#define DO_DEFLATE      0       /* by default, include Deflate */
43#endif
44#define DO_PREDICTOR_1  0
45#define DO_PREDICTOR_2  0
46
47/*
48 * Structure giving methods for compression/decompression.
49 */
50#ifdef PACKETPTR
51struct compressor {
52        int     compress_proto; /* CCP compression protocol number */
53
54        /* Allocate space for a compressor (transmit side) */
55        void    *(*comp_alloc)(u_char *options, int opt_len);
56        /* Free space used by a compressor */
57        void    (*comp_free)(void *state);
58        /* Initialize a compressor */
59        int     (*comp_init)(void *state, u_char *options, int opt_len,
60                    int unit, int hdrlen, int debug);
61        /* Reset a compressor */
62        void    (*comp_reset)(void *state);
63        /* Compress a packet */
64        int     (*compress)(void *state, PACKETPTR *mret, PACKETPTR mp,
65                    int orig_len, int max_len);
66        /* Return compression statistics */
67        void    (*comp_stat)(void *state, struct compstat *stats);
68
69        /* Allocate space for a decompressor (receive side) */
70        void    *(*decomp_alloc)(u_char *options, int opt_len);
71        /* Free space used by a decompressor */
72        void    (*decomp_free)(void *state);
73        /* Initialize a decompressor */
74        int     (*decomp_init)(void *state, u_char *options, int opt_len,
75                    int unit, int hdrlen, int mru, int debug);
76        /* Reset a decompressor */
77        void    (*decomp_reset)(void *state);
78        /* Decompress a packet. */
79        int     (*decompress)(void *state, PACKETPTR mp, PACKETPTR *dmpp);
80        /* Update state for an incompressible packet received */
81        void    (*incomp)(void *state, PACKETPTR mp);
82        /* Return decompression statistics */
83        void    (*decomp_stat)(void *state, struct compstat *stats);
84};
85#endif /* PACKETPTR */
86
87/*
88 * Return values for decompress routine.
89 * We need to make these distinctions so that we can disable certain
90 * useful functionality, namely sending a CCP reset-request as a result
91 * of an error detected after decompression.  This is to avoid infringing
92 * a patent held by Motorola.
93 * Don't you just lurve software patents.
94 */
95#define DECOMP_OK               0       /* everything went OK */
96#define DECOMP_ERROR            1       /* error detected before decomp. */
97#define DECOMP_FATALERROR       2       /* error detected after decomp. */
98
99/*
100 * CCP codes.
101 */
102#define CCP_CONFREQ     1
103#define CCP_CONFACK     2
104#define CCP_TERMREQ     5
105#define CCP_TERMACK     6
106#define CCP_RESETREQ    14
107#define CCP_RESETACK    15
108
109/*
110 * Max # bytes for a CCP option
111 */
112#define CCP_MAX_OPTION_LENGTH   32
113
114/*
115 * Parts of a CCP packet.
116 */
117#define CCP_CODE(dp)            ((dp)[0])
118#define CCP_ID(dp)              ((dp)[1])
119#define CCP_LENGTH(dp)          (((dp)[2] << 8) + (dp)[3])
120#define CCP_HDRLEN              4
121
122#define CCP_OPT_CODE(dp)        ((dp)[0])
123#define CCP_OPT_LENGTH(dp)      ((dp)[1])
124#define CCP_OPT_MINLEN          2
125
126/*
127 * Definitions for BSD-Compress.
128 */
129#define CI_BSD_COMPRESS         21      /* config. option for BSD-Compress */
130#define CILEN_BSD_COMPRESS      3       /* length of config. option */
131
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
138#define BSD_MIN_BITS            9       /* smallest code size supported */
139#define BSD_MAX_BITS            15      /* largest code size supported */
140
141/*
142 * Definitions for Deflate.
143 */
144#define CI_DEFLATE              26      /* config option for Deflate */
145#define CI_DEFLATE_DRAFT        24      /* value used in original draft RFC */
146#define CILEN_DEFLATE           4       /* length of its config option */
147
148#define DEFLATE_MIN_SIZE        8
149#define DEFLATE_MAX_SIZE        15
150#define DEFLATE_METHOD_VAL      8
151#define DEFLATE_SIZE(x)         (((x) >> 4) + DEFLATE_MIN_SIZE)
152#define DEFLATE_METHOD(x)       ((x) & 0x0F)
153#define DEFLATE_MAKE_OPT(w)     ((((w) - DEFLATE_MIN_SIZE) << 4) \
154                                 + DEFLATE_METHOD_VAL)
155#define DEFLATE_CHK_SEQUENCE    0
156
157/*
158 * Definitions for other, as yet unsupported, compression methods.
159 */
160#define CI_PREDICTOR_1          1       /* config option for Predictor-1 */
161#define CILEN_PREDICTOR_1       2       /* length of its config option */
162#define CI_PREDICTOR_2          2       /* config option for Predictor-2 */
163#define CILEN_PREDICTOR_2       2       /* length of its config option */
164
165#endif /* _NET_PPP_COMP_H */
Note: See TracBrowser for help on using the repository browser.