From patchwork Thu Apr 19 20:51:36 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sam Protsenko X-Patchwork-Id: 133844 Delivered-To: patch@linaro.org Received: by 10.46.66.142 with SMTP id h14csp1078733ljf; Thu, 19 Apr 2018 13:51:48 -0700 (PDT) X-Google-Smtp-Source: AIpwx4/fcbFpN+qGQUfdySGsmPA9RJ0vuyqmJU6dcwsoEeQV8uW8BIFNQuV9cSjDDxNZzfJ26NBw X-Received: by 10.80.176.70 with SMTP id i64mr10449784edd.186.1524171108103; Thu, 19 Apr 2018 13:51:48 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1524171108; cv=none; d=google.com; s=arc-20160816; b=Ayj/IkjCntUr+uRViwlhL2sPDrkaZ5QT8QGDKoriclbZphfNQthB/OLpHMPTtXcLe5 oMGYxV5deH6iZ4rnoaawRiBSXLlTzAESzkEHUXBq+sIbLIVASItqYIGyIl0yB669Dncd cqNQyedd1NiwpjJcnUDlVhi+MUNe5o32wlnOt/+dciIGuo3BYxIK1BK8eR4B/mYJxAK8 EKdd16evg/AKhoB0BirKXqunbRrVG2sK7RmY6fKVuzmoWABJ1XEhtPaIZorKPFcMw75F ReChZuIBUCEq83m7n3AnzuAgjosiP7QaP80GQRxw2kKwLuW3ao1NYmTHyZiKgO5hIWil QlzQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:mime-version :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:cc:message-id:date:to:from :dkim-signature:arc-authentication-results; bh=jELlufmKrm4tr/ZQiV/ftqAlDL5AxknTEOFBemAB4NY=; b=zcD1ps8NWNDUWHPtMgOQuTbOQlgaYffDKxwecuSCMUm6Aj9UiE9lCj4BOPGV0qex9j B6Famh/Ps07p2FMY0igttOWLfefpxq18x4QtqF7cZPkq4Sz96FB66kEM7Bw/z/JZJRIQ oEJG7gyI6fQcKAgeLaZ6mKcbzBobZ2LrDcZwe9nf92nke/hfXQlNXVb3RTXhwZbYCvVw /R21YioG4IZZ5Ub2pIaR96aAwTxOhh+j+7CUiyxy3yAC422q1GvW12JC/EFC7vcLn5qF MHsSI0DFlex6pDdIq05I07kEnRupwZcIMTJkVj1DA2RE229g8/tllUpSKukAneajwQ5M ZjSA== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=dGnaXPHm; spf=pass (google.com: best guess record for domain of u-boot-bounces@lists.denx.de designates 81.169.180.215 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.denx.de (dione.denx.de. [81.169.180.215]) by mx.google.com with ESMTP id w16si1025372edb.301.2018.04.19.13.51.47; Thu, 19 Apr 2018 13:51:48 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of u-boot-bounces@lists.denx.de designates 81.169.180.215 as permitted sender) client-ip=81.169.180.215; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=dGnaXPHm; spf=pass (google.com: best guess record for domain of u-boot-bounces@lists.denx.de designates 81.169.180.215 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: by lists.denx.de (Postfix, from userid 105) id 3B3DBC21FC2; Thu, 19 Apr 2018 20:51:45 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on lists.denx.de X-Spam-Level: X-Spam-Status: No, score=-0.0 required=5.0 tests=RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, T_DKIM_INVALID autolearn=unavailable autolearn_force=no version=3.4.0 Received: from lists.denx.de (localhost [IPv6:::1]) by lists.denx.de (Postfix) with ESMTP id 5E425C21E2B; Thu, 19 Apr 2018 20:51:42 +0000 (UTC) Received: by lists.denx.de (Postfix, from userid 105) id BC8E7C21C38; Thu, 19 Apr 2018 20:51:40 +0000 (UTC) Received: from mail-lf0-f66.google.com (mail-lf0-f66.google.com [209.85.215.66]) by lists.denx.de (Postfix) with ESMTPS id 3D7CCC21C2F for ; Thu, 19 Apr 2018 20:51:40 +0000 (UTC) Received: by mail-lf0-f66.google.com with SMTP id g203-v6so2087554lfg.11 for ; Thu, 19 Apr 2018 13:51:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=0VtegrUQ7/dWqj9d7keRZ/oxu03LUTq++zYVnrpM8AI=; b=dGnaXPHm5We59DsSk9YLSlB+6YUwp+LIFRL0oLPBbwhvZV9nRnkekt5HBypBpmvYRi MAO5HYzc0pZJF1sU9AWsBcF+YEKsWs2NfGWoHEBnXNkp8QzYtgkG7SB5OlMgVsy+cNc5 ciQIo9KWQo3H6hV7SwpWuFROOyxPs8kPRwSEg= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=0VtegrUQ7/dWqj9d7keRZ/oxu03LUTq++zYVnrpM8AI=; b=BBUhSLUgsWINpPlfRiMCK5dwYBfMtghuAuvDVy+1y4dhzYrFfl8gw7R+CXw+lS4TjL R6rirOLWNqgvJlKjUj0quClxaqUWcOlOFfsqGuXdLIuoOJ/4yAhULpTsBmx7+O7/48Dg lsQDCvX7Kv/7QZS1i55LcOZMknUJvYckcgO81F8Ynp1jAb5RNhqvTArljWcK9miRcHA7 3TvHUw96ZA1uo5nbPSIUjwhce7JbhhszxoXyT7K/9ZmER6FkN6khxSU/zc8BDNwmK5rg fVB8AWeOZXVCsh+PvkJxGkefN2+yKPaPSd+4vdmi/ok+/CsslsHvX9PCz/fuQ8P3Ndy/ 926g== X-Gm-Message-State: ALQs6tAvM7SZREuSWWo0fxkesGhixlPf+X0EbO7vaQw3/DToUrEXs8hp S0UnrXcF4M7vBIieTzCsco35LY5TqRA= X-Received: by 10.46.129.217 with SMTP id s25mr5156297ljg.36.1524171099146; Thu, 19 Apr 2018 13:51:39 -0700 (PDT) Received: from localhost ([195.238.92.132]) by smtp.gmail.com with ESMTPSA id f27-v6sm937094lfb.30.2018.04.19.13.51.37 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 19 Apr 2018 13:51:38 -0700 (PDT) From: Sam Protsenko To: u-boot@lists.denx.de Date: Thu, 19 Apr 2018 23:51:36 +0300 Message-Id: <20180419205137.29182-1-semen.protsenko@linaro.org> X-Mailer: git-send-email 2.17.0 Cc: Amit Pundir , Tom Rini , Praneeth Bajjuri , John Stultz , Sumit Semwal Subject: [U-Boot] [PATCH v2 1/2] common: Add support for Android DT image X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.18 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" Android documentation recommends new image format for storing DTB/DTBO files: [1]. To support that format, two things should be done: 1. Add dt_table.h file from Android (BSD-3 relicensed version): [2]. This header defines structures and constants that we need to work with that DT image format. Changes: - re-licensed from Apache to BSD-3 - removed functions declarations - change the coding style to kernel (make checkpatch happy) 2. Add helper functions for Android DTB/DTBO format. In image-android-dt.* files you can find helper functions to work with Android DT image format, such us routines for: - printing the dump of image structure - getting the address and size of desired dtb/dtbo file [1] https://source.android.com/devices/architecture/dto/partitions [2] https://android.googlesource.com/platform/system/libufdt/+/58a7582180f477032cd6c74f8d9afad0038e74c3/utils/src/dt_table.h Signed-off-by: Sam Protsenko Reviewed-by: Alex Deymo --- common/image-android-dt.c | 157 +++++++++++++++++++++++++++++++++++++ include/dt_table.h | 46 +++++++++++ include/image-android-dt.h | 21 +++++ 3 files changed, 224 insertions(+) create mode 100644 common/image-android-dt.c create mode 100644 include/dt_table.h create mode 100644 include/image-android-dt.h diff --git a/common/image-android-dt.c b/common/image-android-dt.c new file mode 100644 index 0000000000..9b7683faab --- /dev/null +++ b/common/image-android-dt.c @@ -0,0 +1,157 @@ +/* + * (C) Copyright 2018 Linaro Ltd. + * Sam Protsenko + * + * SPDX-License-Identifier: GPL-2.0+ + */ + +#include +#include +#include +#include +#include + +/** + * Check if image header is correct. + * + * @param hdr_addr Start address of DT image + * @return true if header is correct or false if header is incorrect + */ +bool android_dt_check_header(ulong hdr_addr) +{ + const struct dt_table_header *hdr; + u32 magic; + + hdr = map_sysmem(hdr_addr, sizeof(*hdr)); + magic = fdt32_to_cpu(hdr->magic); + unmap_sysmem(hdr); + + return magic == DT_TABLE_MAGIC; +} + +/** + * Get the address of FDT (dtb or dtbo) in memory by its index in image. + * + * @param hdr_addr Start address of DT image + * @param index Index of desired FDT in image (starting from 0) + * @param[out] addr If not NULL, will contain address to specified FDT + * @param[out] size If not NULL, will contain size of specified FDT + * + * @return true on success or false on error + */ +bool android_dt_get_fdt_by_index(ulong hdr_addr, u32 index, ulong *addr, + u32 *size) +{ + const struct dt_table_header *hdr; + const struct dt_table_entry *e; + u32 entry_count, entries_offset, entry_size; + ulong e_addr; + u32 dt_offset, dt_size; + + hdr = map_sysmem(hdr_addr, sizeof(*hdr)); + entry_count = fdt32_to_cpu(hdr->dt_entry_count); + entries_offset = fdt32_to_cpu(hdr->dt_entries_offset); + entry_size = fdt32_to_cpu(hdr->dt_entry_size); + unmap_sysmem(hdr); + + if (index > entry_count) { + printf("Error: index > dt_entry_count (%u > %u)\n", index, + entry_count); + return false; + } + + e_addr = hdr_addr + entries_offset + index * entry_size; + e = map_sysmem(e_addr, sizeof(*e)); + dt_offset = fdt32_to_cpu(e->dt_offset); + dt_size = fdt32_to_cpu(e->dt_size); + unmap_sysmem(e); + + if (addr) + *addr = hdr_addr + dt_offset; + if (size) + *size = dt_size; + + return true; +} + +#if !defined(CONFIG_SPL_BUILD) +static void android_dt_print_fdt_info(const struct fdt_header *fdt) +{ + u32 fdt_size; + int root_node_off; + const char *compatible = NULL; + + fdt_size = fdt_totalsize(fdt); + root_node_off = fdt_path_offset(fdt, "/"); + if (root_node_off < 0) { + printf("Error: Root node not found\n"); + } else { + compatible = fdt_getprop(fdt, root_node_off, "compatible", + NULL); + } + + printf(" (FDT)size = %d\n", fdt_size); + printf(" (FDT)compatible = %s\n", + compatible ? compatible : "(unknown)"); +} + +/** + * Print information about DT image structure. + * + * @param hdr_addr Start address of DT image + */ +void android_dt_print_contents(ulong hdr_addr) +{ + const struct dt_table_header *hdr; + u32 entry_count, entries_offset, entry_size; + u32 i; + + hdr = map_sysmem(hdr_addr, sizeof(*hdr)); + entry_count = fdt32_to_cpu(hdr->dt_entry_count); + entries_offset = fdt32_to_cpu(hdr->dt_entries_offset); + entry_size = fdt32_to_cpu(hdr->dt_entry_size); + + /* Print image header info */ + printf("dt_table_header:\n"); + printf(" magic = %08x\n", fdt32_to_cpu(hdr->magic)); + printf(" total_size = %d\n", fdt32_to_cpu(hdr->total_size)); + printf(" header_size = %d\n", fdt32_to_cpu(hdr->header_size)); + printf(" dt_entry_size = %d\n", entry_size); + printf(" dt_entry_count = %d\n", entry_count); + printf(" dt_entries_offset = %d\n", entries_offset); + printf(" page_size = %d\n", fdt32_to_cpu(hdr->page_size)); + printf(" reserved[0] = %08x\n", fdt32_to_cpu(hdr->reserved[0])); + + unmap_sysmem(hdr); + + /* Print image entries info */ + for (i = 0; i < entry_count; ++i) { + const ulong e_addr = hdr_addr + entries_offset + i * entry_size; + const struct dt_table_entry *e; + const struct fdt_header *fdt; + u32 dt_offset, dt_size; + u32 j; + + e = map_sysmem(e_addr, sizeof(*e)); + dt_offset = fdt32_to_cpu(e->dt_offset); + dt_size = fdt32_to_cpu(e->dt_size); + + printf("dt_table_entry[%d]:\n", i); + printf(" dt_size = %d\n", dt_size); + printf(" dt_offset = %d\n", dt_offset); + printf(" id = %08x\n", fdt32_to_cpu(e->id)); + printf(" rev = %08x\n", fdt32_to_cpu(e->rev)); + for (j = 0; j < 4; ++j) { + printf(" custom[%d] = %08x\n", j, + fdt32_to_cpu(e->custom[j])); + } + + unmap_sysmem(e); + + /* Print FDT info for this entry */ + fdt = map_sysmem(hdr_addr + dt_offset, sizeof(*fdt)); + android_dt_print_fdt_info(fdt); + unmap_sysmem(fdt); + } +} +#endif diff --git a/include/dt_table.h b/include/dt_table.h new file mode 100644 index 0000000000..19cbbeab2a --- /dev/null +++ b/include/dt_table.h @@ -0,0 +1,46 @@ +/* + * This is from the Android Project, + * Repository: https://android.googlesource.com/platform/system/libufdt + * File: utils/src/dt_table.h + * Commit: 58a7582180f477032cd6c74f8d9afad0038e74c3 + * Copyright (C) 2017 The Android Open Source Project + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +#ifndef DT_TABLE_H +#define DT_TABLE_H + +#include + +#define DT_TABLE_MAGIC 0xd7b7ab1e +#define DT_TABLE_DEFAULT_PAGE_SIZE 2048 + +struct dt_table_header { + u32 magic; /* DT_TABLE_MAGIC */ + u32 total_size; /* includes dt_table_header + all dt_table_entry + * and all dtb/dtbo + */ + u32 header_size; /* sizeof(dt_table_header) */ + + u32 dt_entry_size; /* sizeof(dt_table_entry) */ + u32 dt_entry_count; /* number of dt_table_entry */ + u32 dt_entries_offset; /* offset to the first dt_table_entry + * from head of dt_table_header. + * The value will be equal to header_size if + * no padding is appended + */ + u32 page_size; /* flash page size we assume */ + u32 reserved[1]; /* must be zero */ +}; + +struct dt_table_entry { + u32 dt_size; + u32 dt_offset; /* offset from head of dt_table_header */ + + u32 id; /* optional, must be zero if unused */ + u32 rev; /* optional, must be zero if unused */ + u32 custom[4]; /* optional, must be zero if unused */ +}; + +#endif diff --git a/include/image-android-dt.h b/include/image-android-dt.h new file mode 100644 index 0000000000..08b810d461 --- /dev/null +++ b/include/image-android-dt.h @@ -0,0 +1,21 @@ +/* + * (C) Copyright 2018 Linaro Ltd. + * Sam Protsenko + * + * SPDX-License-Identifier: GPL-2.0+ + */ + +#ifndef IMAGE_ANDROID_DT_H +#define IMAGE_ANDROID_DT_H + +#include + +bool android_dt_check_header(ulong hdr_addr); +bool android_dt_get_fdt_by_index(ulong hdr_addr, u32 index, ulong *addr, + u32 *size); + +#if !defined(CONFIG_SPL_BUILD) +void android_dt_print_contents(ulong hdr_addr); +#endif + +#endif /* IMAGE_ANDROID_DT_H */