xref: /freebsd/sys/net/mppc.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
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 
28 /*
29  * MPPC decompression library.
30  * Version 1.0
31  *
32  * Note that Hi/Fn (later acquired by Exar Corporation) held US patents
33  * on some implementation-critical aspects of MPPC compression.
34  * These patents lapsed due to non-payment of fees in 2007 and by 2015
35  * expired altogether.
36  */
37 
38 #ifndef _NET_MPPC_H_
39 #define	_NET_MPPC_H_
40 
41 #define	MPPC_MANDATORY_COMPRESS_FLAGS 0
42 #define	MPPC_MANDATORY_DECOMPRESS_FLAGS 0
43 
44 #define	MPPC_SAVE_HISTORY 1
45 
46 #define	MPPC_OK 5
47 #define	MPPC_EXPANDED 8
48 #define	MPPC_RESTART_HISTORY 16
49 #define	MPPC_DEST_EXHAUSTED 32
50 
51 extern size_t MPPC_SizeOfCompressionHistory(void);
52 extern size_t MPPC_SizeOfDecompressionHistory(void);
53 
54 extern void MPPC_InitCompressionHistory(char *history);
55 extern void MPPC_InitDecompressionHistory(char *history);
56 
57 extern int MPPC_Compress(u_char **src, u_char **dst, u_long *srcCnt, u_long *dstCnt, char *history, int flags, int undef);
58 extern int MPPC_Decompress(u_char **src, u_char **dst, u_long *srcCnt, u_long *dstCnt, char *history, int flags);
59 
60 #endif
61