Index: fmap.h |
diff --git a/fmap.h b/fmap.h |
new file mode 100644 |
index 0000000000000000000000000000000000000000..1ec6f3bade1548ade0a2733960eb685f259922e8 |
--- /dev/null |
+++ b/fmap.h |
@@ -0,0 +1,89 @@ |
+/* |
+ * Copyright 2010, Google Inc. |
+ * All rights reserved. |
+ * |
+ * Redistribution and use in source and binary forms, with or without |
+ * modification, are permitted provided that the following conditions are |
+ * met: |
+ * |
+ * * Redistributions of source code must retain the above copyright |
+ * notice, this list of conditions and the following disclaimer. |
+ * * Redistributions in binary form must reproduce the above |
+ * copyright notice, this list of conditions and the following disclaimer |
+ * in the documentation and/or other materials provided with the |
+ * distribution. |
+ * * Neither the name of Google Inc. nor the names of its |
+ * contributors may be used to endorse or promote products derived from |
+ * this software without specific prior written permission. |
+ * |
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
+ * |
+ * Alternatively, this software may be distributed under the terms of the |
+ * GNU General Public License ("GPL") version 2 as published by the Free |
+ * Software Foundation. |
+ * |
+ * This is ported from the flashmap utility: http://flashmap.googlecode.com |
+ */ |
+ |
+#ifndef FLASHMAP_LIB_FMAP_H__ |
+#define FLASHMAP_LIB_FMAP_H__ |
+ |
+#include <inttypes.h> |
+ |
+#define FMAP_SIGNATURE "__FMAP__" |
+#define FMAP_VER_MAJOR 1 /* this header's FMAP minor version */ |
+#define FMAP_VER_MINOR 1 /* this header's FMAP minor version */ |
+#define FMAP_STRLEN 32 /* maximum length for strings, */ |
+ /* including null-terminator */ |
+ |
+enum fmap_flags { |
+ FMAP_AREA_STATIC = 1 << 0, |
+ FMAP_AREA_COMPRESSED = 1 << 1, |
+ FMAP_AREA_RO = 1 << 2, |
+}; |
+ |
+struct crypto_algo; /* forward declaration */ |
Louis
2010/12/30 02:57:08
remove this until we need it?
dhendrix
2010/12/31 00:47:02
Done.
|
+ |
+/* Mapping of volatile and static regions in firmware binary */ |
+struct fmap { |
+ uint64_t signature; /* "__FMAP__" (0x5F5F50414D465F5F) */ |
+ uint8_t ver_major; /* major version */ |
+ uint8_t ver_minor; /* minor version */ |
+ uint64_t base; /* address of the firmware binary */ |
+ uint32_t size; /* size of firmware binary in bytes */ |
+ uint8_t name[FMAP_STRLEN]; /* name of this firmware binary */ |
+ uint16_t nareas; /* number of areas described by |
+ fmap_areas[] below */ |
+ struct fmap_area { |
+ uint32_t offset; /* offset relative to base */ |
+ uint32_t size; /* size in bytes */ |
+ uint8_t name[FMAP_STRLEN]; /* descriptive name */ |
+ uint16_t flags; /* flags for this area */ |
+ } __attribute__((packed)) areas[]; |
+} __attribute__((packed)); |
+ |
+/* |
+ * fmap_find - find FMAP signature in a binary image |
+ * |
+ * @image: binary image |
+ * @len: length of binary image |
+ * |
+ * This function does no error checking. The caller is responsible for |
+ * verifying that the contents are sane. |
+ * |
+ * returns offset of FMAP signature to indicate success |
+ * returns <0 to indicate failure |
+ */ |
+extern long int fmap_find(const uint8_t *image, size_t len); |
+ |
+#endif /* FLASHMAP_LIB_FMAP_H__*/ |