xref: /freebsd/sys/net/mppc.h (revision 3c4ba5f55438f7afd4f4b0b56f88f2bb505fd6a6)
1 /*-
2  * Copyright (c) 2007 Alexander Motin <mav@freebsd.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 /*
31  * MPPC decompression library.
32  * Version 1.0
33  *
34  * Note that Hi/Fn (later acquired by Exar Corporation) held US patents
35  * on some implementation-critical aspects of MPPC compression.
36  * These patents lapsed due to non-payment of fees in 2007 and by 2015
37  * expired altogether.
38  */
39 
40 #ifndef _NET_MPPC_H_
41 #define	_NET_MPPC_H_
42 
43 #define	MPPC_MANDATORY_COMPRESS_FLAGS 0
44 #define	MPPC_MANDATORY_DECOMPRESS_FLAGS 0
45 
46 #define	MPPC_SAVE_HISTORY 1
47 
48 #define	MPPC_OK 5
49 #define	MPPC_EXPANDED 8
50 #define	MPPC_RESTART_HISTORY 16
51 #define	MPPC_DEST_EXHAUSTED 32
52 
53 extern size_t MPPC_SizeOfCompressionHistory(void);
54 extern size_t MPPC_SizeOfDecompressionHistory(void);
55 
56 extern void MPPC_InitCompressionHistory(char *history);
57 extern void MPPC_InitDecompressionHistory(char *history);
58 
59 extern int MPPC_Compress(u_char **src, u_char **dst, u_long *srcCnt, u_long *dstCnt, char *history, int flags, int undef);
60 extern int MPPC_Decompress(u_char **src, u_char **dst, u_long *srcCnt, u_long *dstCnt, char *history, int flags);
61 
62 #endif
63