xref: /OK3568_Linux_fs/u-boot/include/sparse_format.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * This is from the Android Project,
3*4882a593Smuzhiyun  * Repository: https://android.googlesource.com/platform/system/core
4*4882a593Smuzhiyun  * File: libsparse/sparse_format.h
5*4882a593Smuzhiyun  * Commit: 28fa5bc347390480fe190294c6c385b6a9f0d68b
6*4882a593Smuzhiyun  * Copyright (C) 2010 The Android Open Source Project
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  * SPDX-License-Identifier: BSD-3-Clause
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #ifndef _LIBSPARSE_SPARSE_FORMAT_H_
12*4882a593Smuzhiyun #define _LIBSPARSE_SPARSE_FORMAT_H_
13*4882a593Smuzhiyun #include "sparse_defs.h"
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun typedef struct sparse_header {
16*4882a593Smuzhiyun   __le32	magic;		/* 0xed26ff3a */
17*4882a593Smuzhiyun   __le16	major_version;	/* (0x1) - reject images with higher major versions */
18*4882a593Smuzhiyun   __le16	minor_version;	/* (0x0) - allow images with higer minor versions */
19*4882a593Smuzhiyun   __le16	file_hdr_sz;	/* 28 bytes for first revision of the file format */
20*4882a593Smuzhiyun   __le16	chunk_hdr_sz;	/* 12 bytes for first revision of the file format */
21*4882a593Smuzhiyun   __le32	blk_sz;		/* block size in bytes, must be a multiple of 4 (4096) */
22*4882a593Smuzhiyun   __le32	total_blks;	/* total blocks in the non-sparse output image */
23*4882a593Smuzhiyun   __le32	total_chunks;	/* total chunks in the sparse input image */
24*4882a593Smuzhiyun   __le32	image_checksum; /* CRC32 checksum of the original data, counting "don't care" */
25*4882a593Smuzhiyun 				/* as 0. Standard 802.3 polynomial, use a Public Domain */
26*4882a593Smuzhiyun 				/* table implementation */
27*4882a593Smuzhiyun } sparse_header_t;
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun #define SPARSE_HEADER_MAGIC	0xed26ff3a
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun #define CHUNK_TYPE_RAW		0xCAC1
32*4882a593Smuzhiyun #define CHUNK_TYPE_FILL		0xCAC2
33*4882a593Smuzhiyun #define CHUNK_TYPE_DONT_CARE	0xCAC3
34*4882a593Smuzhiyun #define CHUNK_TYPE_CRC32    0xCAC4
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun typedef struct chunk_header {
37*4882a593Smuzhiyun   __le16	chunk_type;	/* 0xCAC1 -> raw; 0xCAC2 -> fill; 0xCAC3 -> don't care */
38*4882a593Smuzhiyun   __le16	reserved1;
39*4882a593Smuzhiyun   __le32	chunk_sz;	/* in blocks in output image */
40*4882a593Smuzhiyun   __le32	total_sz;	/* in bytes of chunk input file including chunk header and data */
41*4882a593Smuzhiyun } chunk_header_t;
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun /* Following a Raw or Fill or CRC32 chunk is data.
44*4882a593Smuzhiyun  *  For a Raw chunk, it's the data in chunk_sz * blk_sz.
45*4882a593Smuzhiyun  *  For a Fill chunk, it's 4 bytes of the fill data.
46*4882a593Smuzhiyun  *  For a CRC32 chunk, it's 4 bytes of CRC32
47*4882a593Smuzhiyun  */
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun #endif
50