[v2,1/4] usb/gadget: fastboot: add sparse image definitions

Message ID 1403808318-16215-2-git-send-email-srae@broadcom.com
State New
Headers show

Commit Message

Steve Rae June 26, 2014, 6:45 p.m.
- to prepare for the support of fastboot sparse images

Signed-off-by: Steve Rae <srae@broadcom.com>
---
This file is ASIS from:
  https://raw.githubusercontent.com/AOSB/android_system_core/master/libsparse/sparse_format.h
  (commit 28fa5bc347390480fe190294c6c385b6a9f0d68b)
except for the __UBOOT__ conditional include.

Changes in v2: None

 include/sparse_format.h | 58 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 include/sparse_format.h

Comments

Rob Herring Aug. 1, 2014, 2:42 p.m. | #1
On Thu, Jun 26, 2014 at 1:45 PM, Steve Rae <srae@broadcom.com> wrote:
> - to prepare for the support of fastboot sparse images
>
> Signed-off-by: Steve Rae <srae@broadcom.com>
> ---
> This file is ASIS from:
>   https://raw.githubusercontent.com/AOSB/android_system_core/master/libsparse/sparse_format.h
>   (commit 28fa5bc347390480fe190294c6c385b6a9f0d68b)
> except for the __UBOOT__ conditional include.
>
> Changes in v2: None
>
>  include/sparse_format.h | 58 +++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 58 insertions(+)
>  create mode 100644 include/sparse_format.h
>
> diff --git a/include/sparse_format.h b/include/sparse_format.h
> new file mode 100644
> index 0000000..21fbd05
> --- /dev/null
> +++ b/include/sparse_format.h
> @@ -0,0 +1,58 @@
> +/*
> + * Copyright (C) 2010 The Android Open Source Project
> + *
> + * Licensed under the Apache License, Version 2.0 (the "License");
> + * you may not use this file except in compliance with the License.
> + * You may obtain a copy of the License at
> + *
> + *      http://www.apache.org/licenses/LICENSE-2.0
> + *
> + * Unless required by applicable law or agreed to in writing, software
> + * distributed under the License is distributed on an "AS IS" BASIS,
> + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> + * See the License for the specific language governing permissions and
> + * limitations under the License.
> + */

My understanding is Apache license is not compatible with GPL. There
are multiple versions of fastboot files to be found in AOSP with
different licenses, so you need to find this with a BSD license.
Probably the u-boot (in AOSP) or little-kernel tree has it.

Rob
Tom Rini Aug. 1, 2014, 3:36 p.m. | #2
On Fri, Aug 01, 2014 at 09:42:19AM -0500, Rob Herring wrote:
> On Thu, Jun 26, 2014 at 1:45 PM, Steve Rae <srae@broadcom.com> wrote:
> > - to prepare for the support of fastboot sparse images
> >
> > Signed-off-by: Steve Rae <srae@broadcom.com>
> > ---
> > This file is ASIS from:
> >   https://raw.githubusercontent.com/AOSB/android_system_core/master/libsparse/sparse_format.h
> >   (commit 28fa5bc347390480fe190294c6c385b6a9f0d68b)
> > except for the __UBOOT__ conditional include.
> >
> > Changes in v2: None
> >
> >  include/sparse_format.h | 58 +++++++++++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 58 insertions(+)
> >  create mode 100644 include/sparse_format.h
> >
> > diff --git a/include/sparse_format.h b/include/sparse_format.h
> > new file mode 100644
> > index 0000000..21fbd05
> > --- /dev/null
> > +++ b/include/sparse_format.h
> > @@ -0,0 +1,58 @@
> > +/*
> > + * Copyright (C) 2010 The Android Open Source Project
> > + *
> > + * Licensed under the Apache License, Version 2.0 (the "License");
> > + * you may not use this file except in compliance with the License.
> > + * You may obtain a copy of the License at
> > + *
> > + *      http://www.apache.org/licenses/LICENSE-2.0
> > + *
> > + * Unless required by applicable law or agreed to in writing, software
> > + * distributed under the License is distributed on an "AS IS" BASIS,
> > + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> > + * See the License for the specific language governing permissions and
> > + * limitations under the License.
> > + */
> 
> My understanding is Apache license is not compatible with GPL. There
> are multiple versions of fastboot files to be found in AOSP with
> different licenses, so you need to find this with a BSD license.
> Probably the u-boot (in AOSP) or little-kernel tree has it.

You are correct in that Apache-2.0 is not GPL compatible.  However (and
this question came up inside TI as well), as far as I can tell the
sparse file format is NOT available in other licenses (unlike fastboot
itself).  If anyone out there knows who at Google to ask about getting
the file re-licensed that would be great...

Patch

diff --git a/include/sparse_format.h b/include/sparse_format.h
new file mode 100644
index 0000000..21fbd05
--- /dev/null
+++ b/include/sparse_format.h
@@ -0,0 +1,58 @@ 
+/*
+ * Copyright (C) 2010 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef _LIBSPARSE_SPARSE_FORMAT_H_
+#define _LIBSPARSE_SPARSE_FORMAT_H_
+#define __UBOOT__
+#ifndef __UBOOT__
+#include "sparse_defs.h"
+#endif
+
+typedef struct sparse_header {
+  __le32	magic;		/* 0xed26ff3a */
+  __le16	major_version;	/* (0x1) - reject images with higher major versions */
+  __le16	minor_version;	/* (0x0) - allow images with higer minor versions */
+  __le16	file_hdr_sz;	/* 28 bytes for first revision of the file format */
+  __le16	chunk_hdr_sz;	/* 12 bytes for first revision of the file format */
+  __le32	blk_sz;		/* block size in bytes, must be a multiple of 4 (4096) */
+  __le32	total_blks;	/* total blocks in the non-sparse output image */
+  __le32	total_chunks;	/* total chunks in the sparse input image */
+  __le32	image_checksum; /* CRC32 checksum of the original data, counting "don't care" */
+				/* as 0. Standard 802.3 polynomial, use a Public Domain */
+				/* table implementation */
+} sparse_header_t;
+
+#define SPARSE_HEADER_MAGIC	0xed26ff3a
+
+#define CHUNK_TYPE_RAW		0xCAC1
+#define CHUNK_TYPE_FILL		0xCAC2
+#define CHUNK_TYPE_DONT_CARE	0xCAC3
+#define CHUNK_TYPE_CRC32    0xCAC4
+
+typedef struct chunk_header {
+  __le16	chunk_type;	/* 0xCAC1 -> raw; 0xCAC2 -> fill; 0xCAC3 -> don't care */
+  __le16	reserved1;
+  __le32	chunk_sz;	/* in blocks in output image */
+  __le32	total_sz;	/* in bytes of chunk input file including chunk header and data */
+} chunk_header_t;
+
+/* Following a Raw or Fill or CRC32 chunk is data.
+ *  For a Raw chunk, it's the data in chunk_sz * blk_sz.
+ *  For a Fill chunk, it's 4 bytes of the fill data.
+ *  For a CRC32 chunk, it's 4 bytes of CRC32
+ */
+
+#endif