xref: /rk3399_rockchip-uboot/lib/gunzip.c (revision bb3517579319fea084d64f259b334827c7bbb3b4)
178acc472SPeter Tyser /*
278acc472SPeter Tyser  * (C) Copyright 2000-2006
378acc472SPeter Tyser  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
478acc472SPeter Tyser  *
51a459660SWolfgang Denk  * SPDX-License-Identifier:	GPL-2.0+
678acc472SPeter Tyser  */
778acc472SPeter Tyser 
878acc472SPeter Tyser #include <common.h>
978acc472SPeter Tyser #include <watchdog.h>
1078acc472SPeter Tyser #include <command.h>
1124b852a7SSimon Glass #include <console.h>
1278acc472SPeter Tyser #include <image.h>
1378acc472SPeter Tyser #include <malloc.h>
14d025021eSClemens Gruber #include <memalign.h>
15f7a20b12SJoseph Chen #include <misc.h>
1678acc472SPeter Tyser #include <u-boot/zlib.h>
17918e9ebbSEric Nelson #include <div64.h>
1878acc472SPeter Tyser 
19918e9ebbSEric Nelson #define HEADER0			'\x1f'
20918e9ebbSEric Nelson #define HEADER1			'\x8b'
2178acc472SPeter Tyser #define	ZALLOC_ALIGNMENT	16
2278acc472SPeter Tyser #define HEAD_CRC		2
2378acc472SPeter Tyser #define EXTRA_FIELD		4
2478acc472SPeter Tyser #define ORIG_NAME		8
2578acc472SPeter Tyser #define COMMENT			0x10
2678acc472SPeter Tyser #define RESERVED		0xe0
2778acc472SPeter Tyser #define DEFLATED		8
2878acc472SPeter Tyser 
gzalloc(void * x,unsigned items,unsigned size)29e3ed0575SMike Frysinger void *gzalloc(void *x, unsigned items, unsigned size)
3078acc472SPeter Tyser {
3178acc472SPeter Tyser 	void *p;
3278acc472SPeter Tyser 
3378acc472SPeter Tyser 	size *= items;
3478acc472SPeter Tyser 	size = (size + ZALLOC_ALIGNMENT - 1) & ~(ZALLOC_ALIGNMENT - 1);
3578acc472SPeter Tyser 
3678acc472SPeter Tyser 	p = malloc (size);
3778acc472SPeter Tyser 
3878acc472SPeter Tyser 	return (p);
3978acc472SPeter Tyser }
4078acc472SPeter Tyser 
gzfree(void * x,void * addr,unsigned nb)41e3ed0575SMike Frysinger void gzfree(void *x, void *addr, unsigned nb)
4278acc472SPeter Tyser {
4378acc472SPeter Tyser 	free (addr);
4478acc472SPeter Tyser }
4578acc472SPeter Tyser 
gzip_parse_header(const unsigned char * src,unsigned long len)4619471261SJean-Jacques Hiblot int gzip_parse_header(const unsigned char *src, unsigned long len)
4778acc472SPeter Tyser {
4878acc472SPeter Tyser 	int i, flags;
4978acc472SPeter Tyser 
5078acc472SPeter Tyser 	/* skip header */
5178acc472SPeter Tyser 	i = 10;
5278acc472SPeter Tyser 	flags = src[3];
5378acc472SPeter Tyser 	if (src[2] != DEFLATED || (flags & RESERVED) != 0) {
54bcf5a32aSJoseph Chen 		debug("Error: Bad gzipped data\n");
5578acc472SPeter Tyser 		return (-1);
5678acc472SPeter Tyser 	}
5778acc472SPeter Tyser 	if ((flags & EXTRA_FIELD) != 0)
5878acc472SPeter Tyser 		i = 12 + src[10] + (src[11] << 8);
5978acc472SPeter Tyser 	if ((flags & ORIG_NAME) != 0)
6078acc472SPeter Tyser 		while (src[i++] != 0)
6178acc472SPeter Tyser 			;
6278acc472SPeter Tyser 	if ((flags & COMMENT) != 0)
6378acc472SPeter Tyser 		while (src[i++] != 0)
6478acc472SPeter Tyser 			;
6578acc472SPeter Tyser 	if ((flags & HEAD_CRC) != 0)
6678acc472SPeter Tyser 		i += 2;
6719471261SJean-Jacques Hiblot 	if (i >= len) {
6878acc472SPeter Tyser 		puts ("Error: gunzip out of data in header\n");
6978acc472SPeter Tyser 		return (-1);
7078acc472SPeter Tyser 	}
7119471261SJean-Jacques Hiblot 	return i;
7219471261SJean-Jacques Hiblot }
7378acc472SPeter Tyser 
gunzip(void * dst,int dstlen,unsigned char * src,unsigned long * lenp)7419471261SJean-Jacques Hiblot int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp)
7519471261SJean-Jacques Hiblot {
7619471261SJean-Jacques Hiblot 	int offset = gzip_parse_header(src, *lenp);
7719471261SJean-Jacques Hiblot 
7819471261SJean-Jacques Hiblot 	if (offset < 0)
7919471261SJean-Jacques Hiblot 		return offset;
8019471261SJean-Jacques Hiblot 
81f7a20b12SJoseph Chen #if defined(CONFIG_MISC_DECOMPRESS) && !defined(CONFIG_SPL_BUILD)
82f7a20b12SJoseph Chen 	int ret;
83f7a20b12SJoseph Chen 
84f7a20b12SJoseph Chen 	ret = misc_decompress_process((ulong)dst, (ulong)src, *lenp,
85*bb351757SJoseph Chen 				      DECOM_GZIP, false, (u64 *)lenp, 0);
86f7a20b12SJoseph Chen 	if (!ret)
87f7a20b12SJoseph Chen 		return 0;
88f7a20b12SJoseph Chen 
89f7a20b12SJoseph Chen 	printf("hw gunzip failed(%d), fallback to soft gunzip\n", ret);
90f7a20b12SJoseph Chen #endif
9119471261SJean-Jacques Hiblot 	return zunzip(dst, dstlen, src, lenp, 1, offset);
9278acc472SPeter Tyser }
9378acc472SPeter Tyser 
941811b7d3STom Rini #ifdef CONFIG_CMD_UNZIP
95918e9ebbSEric Nelson __weak
gzwrite_progress_init(u64 expectedsize)96918e9ebbSEric Nelson void gzwrite_progress_init(u64 expectedsize)
97918e9ebbSEric Nelson {
98918e9ebbSEric Nelson 	putc('\n');
99918e9ebbSEric Nelson }
100918e9ebbSEric Nelson 
101918e9ebbSEric Nelson __weak
gzwrite_progress(int iteration,u64 bytes_written,u64 total_bytes)102918e9ebbSEric Nelson void gzwrite_progress(int iteration,
103918e9ebbSEric Nelson 		     u64 bytes_written,
104918e9ebbSEric Nelson 		     u64 total_bytes)
105918e9ebbSEric Nelson {
106918e9ebbSEric Nelson 	if (0 == (iteration & 3))
107918e9ebbSEric Nelson 		printf("%llu/%llu\r", bytes_written, total_bytes);
108918e9ebbSEric Nelson }
109918e9ebbSEric Nelson 
110918e9ebbSEric Nelson __weak
gzwrite_progress_finish(int returnval,u64 bytes_written,u64 total_bytes,u32 expected_crc,u32 calculated_crc)111918e9ebbSEric Nelson void gzwrite_progress_finish(int returnval,
112918e9ebbSEric Nelson 			     u64 bytes_written,
113918e9ebbSEric Nelson 			     u64 total_bytes,
114918e9ebbSEric Nelson 			     u32 expected_crc,
115918e9ebbSEric Nelson 			     u32 calculated_crc)
116918e9ebbSEric Nelson {
117918e9ebbSEric Nelson 	if (0 == returnval) {
118918e9ebbSEric Nelson 		printf("\n\t%llu bytes, crc 0x%08x\n",
119918e9ebbSEric Nelson 		       total_bytes, calculated_crc);
120918e9ebbSEric Nelson 	} else {
121918e9ebbSEric Nelson 		printf("\n\tuncompressed %llu of %llu\n"
122918e9ebbSEric Nelson 		       "\tcrcs == 0x%08x/0x%08x\n",
123918e9ebbSEric Nelson 		       bytes_written, total_bytes,
124918e9ebbSEric Nelson 		       expected_crc, calculated_crc);
125918e9ebbSEric Nelson 	}
126918e9ebbSEric Nelson }
127918e9ebbSEric Nelson 
gzwrite(unsigned char * src,int len,struct blk_desc * dev,unsigned long szwritebuf,u64 startoffs,u64 szexpected)128918e9ebbSEric Nelson int gzwrite(unsigned char *src, int len,
1294101f687SSimon Glass 	    struct blk_desc *dev,
130918e9ebbSEric Nelson 	    unsigned long szwritebuf,
131918e9ebbSEric Nelson 	    u64 startoffs,
132918e9ebbSEric Nelson 	    u64 szexpected)
133918e9ebbSEric Nelson {
134918e9ebbSEric Nelson 	int i, flags;
135918e9ebbSEric Nelson 	z_stream s;
136918e9ebbSEric Nelson 	int r = 0;
137918e9ebbSEric Nelson 	unsigned char *writebuf;
138918e9ebbSEric Nelson 	unsigned crc = 0;
139918e9ebbSEric Nelson 	u64 totalfilled = 0;
140918e9ebbSEric Nelson 	lbaint_t blksperbuf, outblock;
141918e9ebbSEric Nelson 	u32 expected_crc;
142918e9ebbSEric Nelson 	u32 payload_size;
143918e9ebbSEric Nelson 	int iteration = 0;
144918e9ebbSEric Nelson 
145918e9ebbSEric Nelson 	if (!szwritebuf ||
146918e9ebbSEric Nelson 	    (szwritebuf % dev->blksz) ||
147918e9ebbSEric Nelson 	    (szwritebuf < dev->blksz)) {
148918e9ebbSEric Nelson 		printf("%s: size %lu not a multiple of %lu\n",
149918e9ebbSEric Nelson 		       __func__, szwritebuf, dev->blksz);
150918e9ebbSEric Nelson 		return -1;
151918e9ebbSEric Nelson 	}
152918e9ebbSEric Nelson 
153918e9ebbSEric Nelson 	if (startoffs & (dev->blksz-1)) {
154918e9ebbSEric Nelson 		printf("%s: start offset %llu not a multiple of %lu\n",
155918e9ebbSEric Nelson 		       __func__, startoffs, dev->blksz);
156918e9ebbSEric Nelson 		return -1;
157918e9ebbSEric Nelson 	}
158918e9ebbSEric Nelson 
159918e9ebbSEric Nelson 	blksperbuf = szwritebuf / dev->blksz;
160918e9ebbSEric Nelson 	outblock = lldiv(startoffs, dev->blksz);
161918e9ebbSEric Nelson 
162918e9ebbSEric Nelson 	/* skip header */
163918e9ebbSEric Nelson 	i = 10;
164918e9ebbSEric Nelson 	flags = src[3];
165918e9ebbSEric Nelson 	if (src[2] != DEFLATED || (flags & RESERVED) != 0) {
166918e9ebbSEric Nelson 		puts("Error: Bad gzipped data\n");
167918e9ebbSEric Nelson 		return -1;
168918e9ebbSEric Nelson 	}
169918e9ebbSEric Nelson 	if ((flags & EXTRA_FIELD) != 0)
170918e9ebbSEric Nelson 		i = 12 + src[10] + (src[11] << 8);
171918e9ebbSEric Nelson 	if ((flags & ORIG_NAME) != 0)
172918e9ebbSEric Nelson 		while (src[i++] != 0)
173918e9ebbSEric Nelson 			;
174918e9ebbSEric Nelson 	if ((flags & COMMENT) != 0)
175918e9ebbSEric Nelson 		while (src[i++] != 0)
176918e9ebbSEric Nelson 			;
177918e9ebbSEric Nelson 	if ((flags & HEAD_CRC) != 0)
178918e9ebbSEric Nelson 		i += 2;
179918e9ebbSEric Nelson 
180918e9ebbSEric Nelson 	if (i >= len-8) {
181918e9ebbSEric Nelson 		puts("Error: gunzip out of data in header");
182918e9ebbSEric Nelson 		return -1;
183918e9ebbSEric Nelson 	}
184918e9ebbSEric Nelson 
185918e9ebbSEric Nelson 	payload_size = len - i - 8;
186918e9ebbSEric Nelson 
187918e9ebbSEric Nelson 	memcpy(&expected_crc, src + len - 8, sizeof(expected_crc));
188918e9ebbSEric Nelson 	expected_crc = le32_to_cpu(expected_crc);
189918e9ebbSEric Nelson 	u32 szuncompressed;
190918e9ebbSEric Nelson 	memcpy(&szuncompressed, src + len - 4, sizeof(szuncompressed));
191918e9ebbSEric Nelson 	if (szexpected == 0) {
192918e9ebbSEric Nelson 		szexpected = le32_to_cpu(szuncompressed);
193918e9ebbSEric Nelson 	} else if (szuncompressed != (u32)szexpected) {
194918e9ebbSEric Nelson 		printf("size of %llx doesn't match trailer low bits %x\n",
195918e9ebbSEric Nelson 		       szexpected, szuncompressed);
196918e9ebbSEric Nelson 		return -1;
197918e9ebbSEric Nelson 	}
198918e9ebbSEric Nelson 	if (lldiv(szexpected, dev->blksz) > (dev->lba - outblock)) {
199918e9ebbSEric Nelson 		printf("%s: uncompressed size %llu exceeds device size\n",
200918e9ebbSEric Nelson 		       __func__, szexpected);
201918e9ebbSEric Nelson 		return -1;
202918e9ebbSEric Nelson 	}
203918e9ebbSEric Nelson 
204918e9ebbSEric Nelson 	gzwrite_progress_init(szexpected);
205918e9ebbSEric Nelson 
206918e9ebbSEric Nelson 	s.zalloc = gzalloc;
207918e9ebbSEric Nelson 	s.zfree = gzfree;
208918e9ebbSEric Nelson 
209918e9ebbSEric Nelson 	r = inflateInit2(&s, -MAX_WBITS);
210918e9ebbSEric Nelson 	if (r != Z_OK) {
211918e9ebbSEric Nelson 		printf("Error: inflateInit2() returned %d\n", r);
212918e9ebbSEric Nelson 		return -1;
213918e9ebbSEric Nelson 	}
214918e9ebbSEric Nelson 
215918e9ebbSEric Nelson 	s.next_in = src + i;
216918e9ebbSEric Nelson 	s.avail_in = payload_size+8;
217d025021eSClemens Gruber 	writebuf = (unsigned char *)malloc_cache_aligned(szwritebuf);
218918e9ebbSEric Nelson 
219918e9ebbSEric Nelson 	/* decompress until deflate stream ends or end of file */
220918e9ebbSEric Nelson 	do {
221918e9ebbSEric Nelson 		if (s.avail_in == 0) {
222918e9ebbSEric Nelson 			printf("%s: weird termination with result %d\n",
223918e9ebbSEric Nelson 			       __func__, r);
224918e9ebbSEric Nelson 			break;
225918e9ebbSEric Nelson 		}
226918e9ebbSEric Nelson 
227918e9ebbSEric Nelson 		/* run inflate() on input until output buffer not full */
228918e9ebbSEric Nelson 		do {
229918e9ebbSEric Nelson 			unsigned long blocks_written;
230918e9ebbSEric Nelson 			int numfilled;
231918e9ebbSEric Nelson 			lbaint_t writeblocks;
232918e9ebbSEric Nelson 
233918e9ebbSEric Nelson 			s.avail_out = szwritebuf;
234918e9ebbSEric Nelson 			s.next_out = writebuf;
235918e9ebbSEric Nelson 			r = inflate(&s, Z_SYNC_FLUSH);
236918e9ebbSEric Nelson 			if ((r != Z_OK) &&
237918e9ebbSEric Nelson 			    (r != Z_STREAM_END)) {
238918e9ebbSEric Nelson 				printf("Error: inflate() returned %d\n", r);
239918e9ebbSEric Nelson 				goto out;
240918e9ebbSEric Nelson 			}
241918e9ebbSEric Nelson 			numfilled = szwritebuf - s.avail_out;
242918e9ebbSEric Nelson 			crc = crc32(crc, writebuf, numfilled);
243918e9ebbSEric Nelson 			totalfilled += numfilled;
244918e9ebbSEric Nelson 			if (numfilled < szwritebuf) {
245918e9ebbSEric Nelson 				writeblocks = (numfilled+dev->blksz-1)
246918e9ebbSEric Nelson 						/ dev->blksz;
247918e9ebbSEric Nelson 				memset(writebuf+numfilled, 0,
248918e9ebbSEric Nelson 				       dev->blksz-(numfilled%dev->blksz));
249918e9ebbSEric Nelson 			} else {
250918e9ebbSEric Nelson 				writeblocks = blksperbuf;
251918e9ebbSEric Nelson 			}
252918e9ebbSEric Nelson 
253918e9ebbSEric Nelson 			gzwrite_progress(iteration++,
254918e9ebbSEric Nelson 					 totalfilled,
255918e9ebbSEric Nelson 					 szexpected);
2566a3bf3e5SEric Nelson 			blocks_written = blk_dwrite(dev, outblock,
2576a3bf3e5SEric Nelson 						    writeblocks, writebuf);
258918e9ebbSEric Nelson 			outblock += blocks_written;
259918e9ebbSEric Nelson 			if (ctrlc()) {
260918e9ebbSEric Nelson 				puts("abort\n");
261918e9ebbSEric Nelson 				goto out;
262918e9ebbSEric Nelson 			}
263918e9ebbSEric Nelson 			WATCHDOG_RESET();
264918e9ebbSEric Nelson 		} while (s.avail_out == 0);
265918e9ebbSEric Nelson 		/* done when inflate() says it's done */
266918e9ebbSEric Nelson 	} while (r != Z_STREAM_END);
267918e9ebbSEric Nelson 
268918e9ebbSEric Nelson 	if ((szexpected != totalfilled) ||
269918e9ebbSEric Nelson 	    (crc != expected_crc))
270918e9ebbSEric Nelson 		r = -1;
271918e9ebbSEric Nelson 	else
272918e9ebbSEric Nelson 		r = 0;
273918e9ebbSEric Nelson 
274918e9ebbSEric Nelson out:
275918e9ebbSEric Nelson 	gzwrite_progress_finish(r, totalfilled, szexpected,
276918e9ebbSEric Nelson 				expected_crc, crc);
277918e9ebbSEric Nelson 	free(writebuf);
278918e9ebbSEric Nelson 	inflateEnd(&s);
279918e9ebbSEric Nelson 
280918e9ebbSEric Nelson 	return r;
281918e9ebbSEric Nelson }
2821811b7d3STom Rini #endif
283918e9ebbSEric Nelson 
28478acc472SPeter Tyser /*
28578acc472SPeter Tyser  * Uncompress blocks compressed with zlib without headers
28678acc472SPeter Tyser  */
zunzip(void * dst,int dstlen,unsigned char * src,unsigned long * lenp,int stoponerr,int offset)28778acc472SPeter Tyser int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
28878acc472SPeter Tyser 						int stoponerr, int offset)
28978acc472SPeter Tyser {
29078acc472SPeter Tyser 	z_stream s;
2919c55c54fSSimon Glass 	int err = 0;
29278acc472SPeter Tyser 	int r;
29378acc472SPeter Tyser 
294e3ed0575SMike Frysinger 	s.zalloc = gzalloc;
295e3ed0575SMike Frysinger 	s.zfree = gzfree;
29678acc472SPeter Tyser 
29778acc472SPeter Tyser 	r = inflateInit2(&s, -MAX_WBITS);
29878acc472SPeter Tyser 	if (r != Z_OK) {
29978acc472SPeter Tyser 		printf("Error: inflateInit2() returned %d\n", r);
30078acc472SPeter Tyser 		return -1;
30178acc472SPeter Tyser 	}
30278acc472SPeter Tyser 	s.next_in = src + offset;
30378acc472SPeter Tyser 	s.avail_in = *lenp - offset;
30478acc472SPeter Tyser 	s.next_out = dst;
30578acc472SPeter Tyser 	s.avail_out = dstlen;
306f039ada5SCatalin Radu 	do {
30778acc472SPeter Tyser 		r = inflate(&s, Z_FINISH);
308b75650d8SKees Cook 		if (stoponerr == 1 && r != Z_STREAM_END &&
30919346657SStephen Warren 		    (s.avail_in == 0 || s.avail_out == 0 || r != Z_BUF_ERROR)) {
31078acc472SPeter Tyser 			printf("Error: inflate() returned %d\n", r);
3119c55c54fSSimon Glass 			err = -1;
3129c55c54fSSimon Glass 			break;
31378acc472SPeter Tyser 		}
314f039ada5SCatalin Radu 	} while (r == Z_BUF_ERROR);
31578acc472SPeter Tyser 	*lenp = s.next_out - (unsigned char *) dst;
31678acc472SPeter Tyser 	inflateEnd(&s);
31778acc472SPeter Tyser 
3189c55c54fSSimon Glass 	return err;
31978acc472SPeter Tyser }
320