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