xref: /OK3568_Linux_fs/u-boot/lib/lz4_wrapper.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright 2015 Google Inc.
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * SPDX-License-Identifier: GPL 2.0+ BSD-3-Clause
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <common.h>
8*4882a593Smuzhiyun #include <compiler.h>
9*4882a593Smuzhiyun #include <misc.h>
10*4882a593Smuzhiyun #include <linux/kernel.h>
11*4882a593Smuzhiyun #include <linux/types.h>
12*4882a593Smuzhiyun #include <asm/unaligned.h>
13*4882a593Smuzhiyun 
LZ4_readLE16(const void * src)14*4882a593Smuzhiyun static u16 LZ4_readLE16(const void *src)
15*4882a593Smuzhiyun {
16*4882a593Smuzhiyun 	return get_unaligned_le16(src);
17*4882a593Smuzhiyun }
LZ4_copy4(void * dst,const void * src)18*4882a593Smuzhiyun static void LZ4_copy4(void *dst, const void *src)
19*4882a593Smuzhiyun {
20*4882a593Smuzhiyun 	put_unaligned(get_unaligned((const u32 *)src), (u32 *)dst);
21*4882a593Smuzhiyun }
LZ4_copy8(void * dst,const void * src)22*4882a593Smuzhiyun static void LZ4_copy8(void *dst, const void *src)
23*4882a593Smuzhiyun {
24*4882a593Smuzhiyun 	put_unaligned(get_unaligned((const u64 *)src), (u64 *)dst);
25*4882a593Smuzhiyun }
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun typedef  uint8_t BYTE;
28*4882a593Smuzhiyun typedef uint16_t U16;
29*4882a593Smuzhiyun typedef uint32_t U32;
30*4882a593Smuzhiyun typedef  int32_t S32;
31*4882a593Smuzhiyun typedef uint64_t U64;
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun #define FORCE_INLINE static inline __attribute__((always_inline))
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun /* Unaltered (except removing unrelated code) from github.com/Cyan4973/lz4. */
36*4882a593Smuzhiyun #include "lz4.c"	/* #include for inlining, do not link! */
37*4882a593Smuzhiyun 
lz4_is_valid_header(const unsigned char * h)38*4882a593Smuzhiyun bool lz4_is_valid_header(const unsigned char *h)
39*4882a593Smuzhiyun {
40*4882a593Smuzhiyun 	const struct lz4_frame_header *hdr  = (const struct lz4_frame_header *)h;
41*4882a593Smuzhiyun 	/* We assume there's always only a single, standard frame. */
42*4882a593Smuzhiyun 	if (le32_to_cpu(hdr->magic) != LZ4F_MAGIC || hdr->version != 1)
43*4882a593Smuzhiyun 		return false;        /* unknown format */
44*4882a593Smuzhiyun 	if (hdr->reserved0 || hdr->reserved1 || hdr->reserved2)
45*4882a593Smuzhiyun 		return false; /* reserved must be zero */
46*4882a593Smuzhiyun 	if (!hdr->independent_blocks)
47*4882a593Smuzhiyun 		return false; /* we can't support this yet */
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	return true;
50*4882a593Smuzhiyun }
51*4882a593Smuzhiyun 
ulz4fn(const void * src,size_t srcn,void * dst,size_t * dstn)52*4882a593Smuzhiyun int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn)
53*4882a593Smuzhiyun {
54*4882a593Smuzhiyun 	const void *end = dst + *dstn;
55*4882a593Smuzhiyun 	const void *in = src;
56*4882a593Smuzhiyun 	void *out = dst;
57*4882a593Smuzhiyun 	int has_block_checksum;
58*4882a593Smuzhiyun 	int ret;
59*4882a593Smuzhiyun 	*dstn = 0;
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun #if defined(CONFIG_MISC_DECOMPRESS) && !defined(CONFIG_SPL_BUILD)
62*4882a593Smuzhiyun 	u64 len;
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	ret = misc_decompress_process((ulong)dst, (ulong)src, (ulong)srcn,
65*4882a593Smuzhiyun 				      DECOM_LZ4, false, &len, 0);
66*4882a593Smuzhiyun 	if (!ret) {
67*4882a593Smuzhiyun 		*dstn = len;
68*4882a593Smuzhiyun 		return 0;
69*4882a593Smuzhiyun 	}
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun 	printf("hw ulz4fn failed(%d), fallback to soft ulz4fn\n", ret);
72*4882a593Smuzhiyun #endif
73*4882a593Smuzhiyun 	{ /* With in-place decompression the header may become invalid later. */
74*4882a593Smuzhiyun 		const struct lz4_frame_header *h = in;
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun 		if (srcn < sizeof(*h) + sizeof(u64) + sizeof(u8))
77*4882a593Smuzhiyun 			return -EINVAL;	/* input overrun */
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun 		/* We assume there's always only a single, standard frame. */
80*4882a593Smuzhiyun 		if (le32_to_cpu(h->magic) != LZ4F_MAGIC || h->version != 1)
81*4882a593Smuzhiyun 			return -EPROTONOSUPPORT;	/* unknown format */
82*4882a593Smuzhiyun 		if (h->reserved0 || h->reserved1 || h->reserved2)
83*4882a593Smuzhiyun 			return -EINVAL;	/* reserved must be zero */
84*4882a593Smuzhiyun 		if (!h->independent_blocks)
85*4882a593Smuzhiyun 			return -EPROTONOSUPPORT; /* we can't support this yet */
86*4882a593Smuzhiyun 		has_block_checksum = h->has_block_checksum;
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun 		in += sizeof(*h);
89*4882a593Smuzhiyun 		if (h->has_content_size)
90*4882a593Smuzhiyun 			in += sizeof(u64);
91*4882a593Smuzhiyun 		in += sizeof(u8);
92*4882a593Smuzhiyun 	}
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 	while (1) {
95*4882a593Smuzhiyun 		struct lz4_block_header b;
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun 		b.raw = le32_to_cpu(*(u32 *)in);
98*4882a593Smuzhiyun 		in += sizeof(struct lz4_block_header);
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 		if (in - src + b.size > srcn) {
101*4882a593Smuzhiyun 			ret = -EINVAL;		/* input overrun */
102*4882a593Smuzhiyun 			break;
103*4882a593Smuzhiyun 		}
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun 		if (!b.size) {
106*4882a593Smuzhiyun 			ret = 0;	/* decompression successful */
107*4882a593Smuzhiyun 			break;
108*4882a593Smuzhiyun 		}
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun 		if (b.not_compressed) {
111*4882a593Smuzhiyun 			size_t size = min((ptrdiff_t)b.size, end - out);
112*4882a593Smuzhiyun 			memcpy(out, in, size);
113*4882a593Smuzhiyun 			out += size;
114*4882a593Smuzhiyun 			if (size < b.size) {
115*4882a593Smuzhiyun 				ret = -ENOBUFS;	/* output overrun */
116*4882a593Smuzhiyun 				break;
117*4882a593Smuzhiyun 			}
118*4882a593Smuzhiyun 		} else {
119*4882a593Smuzhiyun 			/* constant folding essential, do not touch params! */
120*4882a593Smuzhiyun 			ret = LZ4_decompress_generic(in, out, b.size,
121*4882a593Smuzhiyun 					end - out, endOnInputSize,
122*4882a593Smuzhiyun 					full, 0, noDict, out, NULL, 0);
123*4882a593Smuzhiyun 			if (ret < 0) {
124*4882a593Smuzhiyun 				ret = -EPROTO;	/* decompression error */
125*4882a593Smuzhiyun 				break;
126*4882a593Smuzhiyun 			}
127*4882a593Smuzhiyun 			out += ret;
128*4882a593Smuzhiyun 		}
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 		in += b.size;
131*4882a593Smuzhiyun 		if (has_block_checksum)
132*4882a593Smuzhiyun 			in += sizeof(u32);
133*4882a593Smuzhiyun 	}
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun 	*dstn = out - dst;
136*4882a593Smuzhiyun 	return ret;
137*4882a593Smuzhiyun }
138