Received: from smtp4.osuosl.org (smtp4.osuosl.org [140.211.166.137]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (prime256v1) server-digest SHA256) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 918C3606A324 for ; Mon, 26 Oct 2026 13:40:39 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key, unprotected) header.d=lists.u-boot-project.org header.i=@lists.u-boot-project.org header.a=rsa-sha256 header.s=default header.b=ht9WPTjS; dkim=pass (2048-bit key, unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20251104 header.b=mfLMaFHL Received: from localhost (localhost [127.0.0.1]) by smtp4.osuosl.org (Postfix) with ESMTP id 52F1A406E0; Mon, 26 Oct 2026 13:40:39 +0000 (UTC) X-Virus-Scanned: amavis at osuosl.org Received: from smtp4.osuosl.org ([127.0.0.1]) by localhost (smtp4.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP id JobOzieyeR_k; Mon, 26 Oct 2026 13:40:38 +0000 (UTC) ARC-Filter: OpenARC Filter v1.3.2 smtp4.osuosl.org D9A9D40713 Authentication-Results: smtp4.osuosl.org; arc=pass header.oldest-pass=0 smtp.remote-ip=140.211.166.142 ARC-Seal: i=2; d=osuosl.org; s=arc; a=rsa-sha256; cv=pass; t=1793022038; b=dRc3lVHjFPXW+z3zrKf5e1AmWfR9EFJSjDCwv+4cc2sY+IlFGpc5QPDU2OyEaPgE8zk9 J/Uml6hEcTZxpWEHOmMFp61jRXJNfzZ5jeCwJXDkdO6B6TmmYLdJxq5c4nu8KyojfP8AF Eca+omrnDqibdnA3iidFWWMFERH3YUW+hHE6ZWVhzn2dxiQITF19tidmW5RvKgeJJTKAv MymGNEYhfC3thB7NRUSVWPtxx5C26L2mABkFTSo231ex5LKhIJjKhctnFuI39qXPkcpVW J9qxdMTsX9p4oKxlwDA7ZxQdxM6VjgOLb4P0XlGLqTWGoRGzbbvElG6KPjAIpb9Q6iw== ARC-Message-Signature: i=2; d=osuosl.org; s=arc; a=rsa-sha256; c=relaxed/relaxed; t=1793022038; h=X-Comment:DKIM-Signature:X-Original-To:Delivered-To:Received: Received:X-Virus-Scanned:X-Spam-Flag:X-Spam-Score:X-Spam-Level: X-Spam-Status:Received:ARC-Filter:Received-SPF:Received:Received: DKIM-Signature:X-Google-DKIM-Signature:X-Forwarded-Encrypted: X-Gm-Message-State:X-Gm-Gg:X-Received:Received:From:To:Subject:Date: Message-ID:X-Mailer:In-Reply-To:References:MIME-Version: Content-Transfer-Encoding:X-BeenThere:X-Mailman-Version:Precedence: List-Id:List-Unsubscribe:List-Archive:List-Post:List-Help: List-Subscribe:Errors-To; bh=gRL6rdu+J/3sDwWMEayo7B5ZVX99Y+sA4mWM1c6pjJQ=; b=o0xM4z3vsnr9jl8zsgU+9q6flVdYbSWaqW/uzVPF8KnK56fvbFIKUkDwwJF2O6sfBhk8 sj3PDR4lxHB8E8DKJvq86BdBqwNNPJWhk/8+PD3qACoUK59w2VZkm/T7H4KudW5wumrlA NOpFlclqZc4hkHLI5gCJ48z6vKc0W6DwMiT7b27mcpi3UK6PTEWSLsOgIi6Pxmlncl4Z3 +HFYHyFHs9eUAwxUxp09ITjMvysicnKGbMumb3C0tiS42mHuSEMfN7nj3rApijqW0CPMN M6YAXmJYXJU4V34B8NKIEF6iSVePW5sIRIRdleG8inimUgaROhxARjOsgqY8JJdggnQ== ARC-Authentication-Results: i=2; smtp4.osuosl.org; arc=pass header.oldest-pass=0 smtp.remote-ip=140.211.166.142 X-Comment: SPF check N/A for local connections - client-ip=140.211.166.142; helo=lists1.osuosl.org; envelope-from=u-boot-bounces@lists.u-boot-project.org; receiver= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lists.u-boot-project.org; s=default; t=1793022038; bh=gRL6rdu+J/3sDwWMEayo7B5ZVX99Y+sA4mWM1c6pjJQ=; h=From:To:Subject:Date:In-Reply-To:References:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: From; b=ht9WPTjSmsgEpaxuY4hDP7EYpBZhVhWGUxtTp1G9CoP4IRRL+rEi/y8S03gjcxxIo D3Qtzj6y0R4ySYf+rshdAlge9DtfOyXdnLswgtfLu3XA1llqgnDZZQwy5Q0xn/EsoJ A5r+rkcU/n2mwQrjclozeyrrzubd4/sgXgLwlVpNaLWATZifPpLk70dxWADWWCVBlu ZG+/oJ55PXzHPysYQ3w2822ibzjcfEDgqNGDvrb5oADbIKmefkZfOn4wUx1rqWwDTF 1seiCrGoLVEr+dJ5TysI3PdhIi86y8dF/k/0YTaqtq7QODgLjXOyc8yKxeFyBk52n6 6FF8j9PgW/TNA== Received: from lists1.osuosl.org (lists1.osuosl.org [140.211.166.142]) by smtp4.osuosl.org (Postfix) with ESMTP id D9A9D40713; Mon, 26 Oct 2026 13:40:37 +0000 (UTC) Received: from smtp3.osuosl.org (smtp3.osuosl.org [IPv6:2605:bc80:3010::136]) by lists1.osuosl.org (Postfix) with ESMTP id 1FCFE3B6 for ; Mon, 26 Oct 2026 13:40:32 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id 1067160635 for ; Mon, 26 Oct 2026 13:40:32 +0000 (UTC) X-Virus-Scanned: amavis at osuosl.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP id O1wGfIhruFRa for ; Mon, 26 Oct 2026 13:40:31 +0000 (UTC) ARC-Filter: OpenARC Filter v1.3.2 smtp3.osuosl.org 6E3A2605ED Authentication-Results: smtp3.osuosl.org; arc=none smtp.remote-ip="2a00:1450:4864:20::330" ARC-Seal: i=1; d=osuosl.org; s=arc; a=rsa-sha256; cv=none; t=1793022030; b=d10/cnu7LPcEgkQSnWQutoHY48bHQbkre9ZUUD7cRfg/a06/yybxhwTXKCS+OVdW2A92 450qpTmKoO6iYaB2582SkHbN7EMakKYx5BbUe0BvOPoo2l5qVXsASc4w/BzrzS8eR+EcC uN6uKObRHdyP5sb1MYtaQqOTUXHnE9U3bWPQaHlsAkrYNUDGKxk0iVVQxI0fx7QXiXT5M fu93tF48pWFhTvJfAN8szwDGWLu9YG9rD7qmbPyEGzQxTdk8OJGuglmvN24820Awta9A6 X1CQcFIfxmyAPz83sW8DTktvH9AAaL4xDLUspyamVYH9Dsrs1sGJdfms4/ec7a+6bFQ== ARC-Message-Signature: i=1; d=osuosl.org; s=arc; a=rsa-sha256; c=relaxed/relaxed; t=1793022030; h=Received-SPF:Received:DKIM-Signature:X-Google-DKIM-Signature: X-Forwarded-Encrypted:X-Gm-Message-State:X-Gm-Gg:X-Received:Received: From:To:Subject:Date:Message-ID:X-Mailer:In-Reply-To:References: MIME-Version:Content-Transfer-Encoding; bh=gRL6rdu+J/3sDwWMEayo7B5ZVX99Y+sA4mWM1c6pjJQ=; b=q9Vjkui2C836XzT6jsnJFYFidcP8VDXcrcEz3uGRaYO8hOj01JkvBbBKdm6TVN+BZFAh Oaw3pMGGhUsTIf8aIdb4cxyOD6vmWn50ISLzomd7fWTDYQzyVZaIl+dw5M2ulkihI9Dxp EoQDXhilO//f49xqEgtHWKo5WHfrnwUoNEboF8saVLlCRfyzAiSlxOuHXG4kHa0sI4rWA IKdhVRowiqTqkCbhShHbfWyUnbNmIU9jGIMZQSbswqZ3b0LL3pusjimkBGEvf5+HFAtyj s5vvqABqISOxzzmoQeEyl5NTOsR1sU6hjPVpeMYk2+Bj077wrEvaiE+aylvZxePqoUg== ARC-Authentication-Results: i=1; smtp3.osuosl.org; dmarc=pass header.from=gmail.com; dkim=pass header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20251104 header.b=mfLMaFHL; arc=none smtp.remote-ip="2a00:1450:4864:20::330" Received-SPF: Pass (mailfrom) identity=mailfrom; client-ip=2a00:1450:4864:20::330; helo=mail-wm1-x330.google.com; envelope-from=ansuelsmth@gmail.com; receiver= Authentication-Results: smtp3.osuosl.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp3.osuosl.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20251104 header.b=mfLMaFHL Received: from mail-wm1-x330.google.com (mail-wm1-x330.google.com [IPv6:2a00:1450:4864:20::330]) by smtp3.osuosl.org (Postfix) with ESMTPS id 6E3A2605ED for ; Mon, 26 Oct 2026 13:40:30 +0000 (UTC) Received: by mail-wm1-x330.google.com with SMTP id 5b1f17b1804b1-4a208d93758so35161425e9.3 for ; Mon, 26 Oct 2026 06:40:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1793022028; x=1793626828; darn=lists.u-boot-project.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to:content-type; bh=gRL6rdu+J/3sDwWMEayo7B5ZVX99Y+sA4mWM1c6pjJQ=; b=mfLMaFHLwonnvdffa/XYjRS78XzVgxV+kJQCgY9Acb75vBNTV37Sc7sKCk8qAfv+th jru7ImmsYp9y3WnYRvhKeuIj4W6/MvDY80BiSiLZIGoj3na5qnYNHZ/Q5a8zNieLEITe UdUYigE7VFGXaP6RDbq2w/TR9rlmgoSQOIV8d61x0jjZfu5y0VcvnkP3f6horSdtTnHR jiaoBsNaqK/eVHW1cUw9MKfaTRBfnyitxxaXi8bjXNtaq4BfUkaSkaXe4hUmh5Qwf5uh BXSGo+OSTY5MHqVjSi0xrSd6Pm7EUjBC7X/hLL8yTd9q+gEpW4IZyXBWS13Pr16jZdwW WAWw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20260707; t=1793022028; x=1793626828; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-gg:x-gm-message-state:from:to :cc:subject:date:message-id:reply-to:content-type; bh=gRL6rdu+J/3sDwWMEayo7B5ZVX99Y+sA4mWM1c6pjJQ=; b=NQnqVPC3PhSEP/lS4aSKGB6Bb8l/+tUt9wbRkIpmLfjG2gBj4LTDx2wkZW81wWhY+q dU+80oFrkj2Hbz3nrqhWpXdD2f1idVCr/0MqIEwQArd+uoBtYmgMIkNcnEaNhhYrOuyc U8DyS5benzZiG5S1hqPUuuLe5JDs25SzCtKtcRvoYqEWBSyJwUFKL2MLfMaSWuPSs/Tx zR3MDM/aZ5IKzg8DyMrHEVopR3yfUBDBYKeNonSZ/EkxwFeqS/tiP8r10MeEPjNuexag tUE/fryZ7D3nQn3znDtYG2Ypm2odNp9v7nzV2RqLB9m1YmkqUBxE4dQuuFs7PiJGIM/z X0DQ== X-Forwarded-Encrypted: i=1; AKwUvBwdLnKx9cvXpYnVEZnG3XZV0Etd4fByr2xdpCKqR8rqEULkITOmbQWgx2w7Tip0kRNDGXj6Ulo=@lists.u-boot-project.org X-Gm-Message-State: AFq9FYIR+N6YesodGiCYmnIuy/+XxV6mR2g36kiMpGci3mTQJVMAomGX fYb+iOl/MLYeo2SLdLg9xMEj7VfPJvh+wSQGLioxAU32KA4KGwFoviaU X-Gm-Gg: AYBFou1wKBOvoRsQSpqbdgaK7toroHqgPtScsAdieuZcHKRYACaO0Ll9HC8zgKIn4bL oUh2eec1lZLeSx+VEqrRsirHaCc6PVturH7XBRVayhbT+mQmiSKSLzP6xUxk4uUTDFRmOwgu7Ju osDtkNS4FlzYvfPNHeh8x2syyabxECQF08Nb/gyCHDDnzk9oIdo3dIdEY/+DteMxKnQo9FzBZHj LqOZ8V9wwUAL0Qpl58Go54Mns3uthbS+Etz4s3fenO+vWUXN/hVoZ7UpPclgzXCV8n7/LFBUUmj zsphYHg/e0keBuIaCWhQa45t2r9TWkTeJBqUWWjgd0EcTwAvPY8XGP9pxHUqvnCepjLAOatvuVd IMhlhQR0xjuBTXoCUO+X5soGmBncS6jm1/cbgdFWdui0e2ACgIFj0HmJ7P0xe34AU71R4FhkfRs V4LAIaJCY3XL1lAGlob33p0YlsJIcItkT7Q4LfJaS3tbr4F7eLn+Ge7miM7WD1s2Kn6lVMGLh6+ VUIq+Gy7cdcz1WCKXY7QGJgwN1spsKg3ft9wT06GhC9nifQL0F0V3/3uj3T+8yPuwZk6Mi/oc03 HiFVDGAdApRT9HdRu1uIdwZb84d8TId3vf/3M3fZ2t/INMA7YDqC/u2aMnOg X-Received: by 2002:a05:600c:620b:b0:4a1:c6fd:4db0 with SMTP id 5b1f17b1804b1-4a35aca41e4mr107108935e9.19.1793022027915; Mon, 26 Oct 2026 06:40:27 -0700 (PDT) Received: from Ansuel-XPS24.localdomain (93-34-92-187.ip49.fastwebnet.it. [93.34.92.187]) by smtp.googlemail.com with ESMTPSA id 5b1f17b1804b1-4a35a2c0458sm194344375e9.11.2026.10.26.06.40.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Oct 2026 06:40:27 -0700 (PDT) From: Christian Marangi To: Simon Glass , Tom Rini , Mattijs Korpershoek , Marek Vasut , Heiko Schocher , Alexey Charkov , Daniel Golle , Pranav Sanwal , "Markus Schneider-Pargmann (TI.com)" , "Lucien.Jheng" , Christian Marangi , Neil Armstrong , Mehmet Fide , Casey Connolly , Michal Simek , Aristo Chen , Quentin Schulz , Johan Jonker , Anshul Dalal , Mateus Lima Alves , Marcello Sylvester Bauer , Tan Siewert , Yao Zi , Peng Fan , Patrice Chotard , Randolph Sapp , Martin Schwan , Heinrich Schuchardt , u-boot@lists.u-boot-project.org Subject: [PATCH v10 7/8] misc: fw_loader: introduce FIP loader driver Date: Mon, 26 Oct 2026 14:40:00 +0100 Message-ID: <20261026134002.109025-8-ansuelsmth@gmail.com> X-Mailer: git-send-email 2.55.0 In-Reply-To: <20261026134002.109025-1-ansuelsmth@gmail.com> References: <20261026134002.109025-1-ansuelsmth@gmail.com> X-Archived-By: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: u-boot@lists.u-boot-project.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: U-Boot discussion List-Archive: List-Post: List-Help: List-Subscribe: , X-Spam-Status: No, score=-15.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=4.0.1 X-Spam-Checker-Version: SpamAssassin 4.0.1 (2024-03-26) on aws-us-west-2-korg-listserv-alma10-1 Introduce a variant of the FS loader driver to extract images from FIP image. These image can contain additional binary used to init Network accelerator or PHY firmware blob. The way FIP handle image type is with the usage of UUID. This FIP loader driver implement a simple FIP image parser that check every entry for a matching UUID. Similar to FS loader, this driver also support both UBI and Block devices. Also an additional property is added to handle special case with eMMC that doesn't have a GPT partition and require a global offset to reference the FIP partition. An example usage of this driver is the following: Entry in DTS: fw_loader0: fip-loader { bootph-all; compatible = "u-boot,fip-loader"; phandlepart = <&mmc0 0>; partoffset = <0x100>; }; ethernet@1fb50000 { firmware-loader = <&fw_loader0>; } FIP loader user: /* get the FW loader from the ethernet node */ get_fw_loader_from_node(dev_ofnode(dev), &fw_loader); /* read the blob identified by "58704aef-389f-3e52-b475-e0bf2234a6a2" UUID */ request_firmware_into_buf(fw_loader, "58704aef-389f-3e52-b475-e0bf2234a6a2", buf, 261400, 0); Reviewed-by: Simon Glass Signed-off-by: Christian Marangi --- drivers/misc/Kconfig | 23 ++ drivers/misc/fw_loader/Makefile | 1 + drivers/misc/fw_loader/fip_loader.c | 558 ++++++++++++++++++++++++++++ drivers/misc/fw_loader/internal.h | 2 + 4 files changed, 584 insertions(+) create mode 100644 drivers/misc/fw_loader/fip_loader.c diff --git a/drivers/misc/Kconfig b/drivers/misc/Kconfig index 1cab469a3434..f1091e96775e 100644 --- a/drivers/misc/Kconfig +++ b/drivers/misc/Kconfig @@ -624,6 +624,17 @@ config MPC83XX_SERDES config FW_LOADER_UCLASS bool +config FIP_LOADER + bool "Enable loader driver from FIP partition" + select LIB_UUID + select FW_LOADER_UCLASS + help + This is FIP partition generic loader which can be used to load + the file image from the FIP image into target such as memory. + + The consumer driver would then use this loader to program whatever, + ie. the FPGA device/PHY firmware. + config FS_LOADER bool "Enable loader driver for file system" select FW_LOADER_UCLASS @@ -637,6 +648,18 @@ config FS_LOADER config SPL_FW_LOADER_UCLASS bool +config SPL_FIP_LOADER + bool "Enable loader driver from FIP partition in SPL" + select LIB_UUID + select SPL_FW_LOADER_UCLASS + depends on SPL + help + This is FIP partition generic loader which can be used to load + the file image from the FIP image into target such as memory. + + The consumer driver would then use this loader to program whatever, + ie. the FPGA device/PHY firmware. + config SPL_FS_LOADER bool "Enable loader driver for file system in SPL" select SPL_FW_LOADER_UCLASS diff --git a/drivers/misc/fw_loader/Makefile b/drivers/misc/fw_loader/Makefile index f5df0db61c22..120722c4ed17 100644 --- a/drivers/misc/fw_loader/Makefile +++ b/drivers/misc/fw_loader/Makefile @@ -1,4 +1,5 @@ # SPDX-License-Identifier: GPL-2.0+ obj-$(CONFIG_$(PHASE_)FW_LOADER_UCLASS) += fw_loader-uclass.o +obj-$(CONFIG_$(PHASE_)FIP_LOADER) += fip_loader.o obj-$(CONFIG_$(PHASE_)FS_LOADER) += fs_loader.o diff --git a/drivers/misc/fw_loader/fip_loader.c b/drivers/misc/fw_loader/fip_loader.c new file mode 100644 index 000000000000..83c74e60d798 --- /dev/null +++ b/drivers/misc/fw_loader/fip_loader.c @@ -0,0 +1,558 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Copyright (C) 2025 Christian Marangi + * + */ + +#define LOG_CATEGORY UCLASS_FIRMWARE_LOADER + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#if CONFIG_IS_ENABLED(CMD_UBIFS) +#include +#endif + +#include "internal.h" + +#define TOC_HEADER_NAME 0xaa640001 + +/* + * FIP toc and entry is always in the + * native byte order of the system. + */ +struct fip_toc_header { + u32 name; + u32 serial_number; + u64 flags; +} __packed; + +struct fip_toc_entry { + struct uuid uuid; + u64 offset_address; + u64 size; + u64 flags; +} __packed; + +enum fip_storage_interface { + FIP_STORAGE_INTERFACE_BLK, + FIP_STORAGE_INTERFACE_UBI, +}; + +struct fip_storage_info { + enum fip_storage_interface storage_interface; + + /* BLK info */ + struct disk_partition part_info; + struct blk_desc *desc; + unsigned int part_offset; + + /* UBI info */ + char *ubi_volume; +}; + +static bool validate_fip_toc_header(struct fip_toc_header *hdr) +{ + if (hdr->name != TOC_HEADER_NAME) { + log_err("Invalid FIP header\n"); + return false; + } + + return true; +} + +static int firmware_name_to_uuid(struct firmware *firmwarep, + struct uuid *uuid) +{ + const char *uuid_str = firmwarep->name; + int ret; + + ret = uuid_str_to_bin(uuid_str, (unsigned char *)uuid, + UUID_STR_FORMAT_STD); + if (ret) + log_err("Invalid UUID str: %s\n", uuid_str); + + return ret; +} + +static int check_fip_toc_entry(struct fip_toc_entry *ent, + struct uuid *uuid, + struct fip_toc_entry *dent) +{ + struct uuid uuid_null = { }; + + /* NULL uuid. We parsed every entry */ + if (!memcmp(&ent->uuid, &uuid_null, sizeof(uuid_null))) + return -ENOENT; + + /* We found the related uuid */ + if (!memcmp(&ent->uuid, uuid, sizeof(*uuid))) { + log_debug("Found matching FIP entry. offset: 0x%llx size: %lld\n", + ent->offset_address, ent->size); + memcpy(dent, ent, sizeof(*ent)); + return 0; + } + + return -EAGAIN; +} + +static int blk_read_fip_toc_header(struct blk_desc *desc, lbaint_t offset, + char *buf, struct fip_toc_header *hdr) +{ + lbaint_t blkcnt = BLOCK_CNT(sizeof(*hdr), desc); + lbaint_t to_read, read = 0; + int i, ret; + + for (i = 0; i < blkcnt && read < sizeof(*hdr); i++) { + to_read = min_t(lbaint_t, desc->blksz, + (sizeof(*hdr) - read)); + + ret = blk_dread(desc, offset + i, 1, buf); + if (ret != 1) + return -EINVAL; + + memcpy((u8 *)hdr + read, buf, to_read); + read += to_read; + } + + return read; +} + +static int blk_read_fip_toc_entry(struct blk_desc *desc, lbaint_t offset, + int pos, char *buf, + struct fip_toc_entry *ent) +{ + lbaint_t left, consumed, to_read, read = 0; + lbaint_t blkstart, blkcnt; + int i, ret; + + consumed = pos % desc->blksz; + left = desc->blksz - consumed; + to_read = min_t(lbaint_t, left, sizeof(*ent)); + + blkstart = BLOCK_CNT(pos, desc); + blkcnt = BLOCK_CNT(sizeof(*ent) - to_read, desc); + + /* Read data from previous cached block if present */ + if (consumed) { + memcpy(ent, buf + consumed, to_read); + read += to_read; + } + + for (i = 0; i < blkcnt && read < sizeof(*ent); i++) { + to_read = min(desc->blksz, + (lbaint_t)(sizeof(*ent) - read)); + + ret = blk_dread(desc, offset + blkstart + i, 1, buf); + if (ret != 1) + return -EINVAL; + + memcpy((u8 *)ent + read, buf, to_read); + read += to_read; + } + + return read; +} + +static int blk_parse_fip_firmware(struct firmware *firmwarep, + struct blk_desc *desc, + struct disk_partition *part_info, + unsigned int part_offset, + struct fip_toc_entry *dent) +{ + lbaint_t offset = part_info->start + part_offset; + struct fip_toc_header hdr; + struct fip_toc_entry ent; + struct uuid uuid; + unsigned int pos; + char *read_buf; + int ret; + + /* Allocate a Scratch Buffer for FIP parsing */ + read_buf = malloc(desc->blksz); + if (!read_buf) + return -ENOMEM; + + ret = blk_read_fip_toc_header(desc, offset, read_buf, &hdr); + if (ret < 0) { + ret = -EINVAL; + goto out; + } + + pos = ret; + + if (!validate_fip_toc_header(&hdr)) { + ret = -EINVAL; + goto out; + } + + ret = firmware_name_to_uuid(firmwarep, &uuid); + if (ret) + goto out; + + /* Loop for every FIP entry searching for uuid */ + while (true) { + ret = blk_read_fip_toc_entry(desc, offset, pos, + read_buf, &ent); + if (ret < 0) + goto out; + + pos += ret; + + ret = check_fip_toc_entry(&ent, &uuid, dent); + if (ret != -EAGAIN) + break; + } + +out: + free(read_buf); + return ret; +} + +#if CONFIG_IS_ENABLED(CMD_UBIFS) +static int ubi_parse_fip_firmware(struct firmware *firmwarep, + char *ubi_vol, + struct fip_toc_entry *dent) +{ + struct fip_toc_header hdr; + struct fip_toc_entry ent; + struct uuid uuid; + unsigned int pos; + int ret; + + ret = ubi_volume_read(ubi_vol, (char *)&hdr, 0, sizeof(hdr)); + if (ret) + return ret; + + pos = sizeof(hdr); + + if (!validate_fip_toc_header(&hdr)) + return -EINVAL; + + ret = firmware_name_to_uuid(firmwarep, &uuid); + if (ret) + return ret; + + /* Loop for every FIP entry searching for uuid */ + while (true) { + ret = ubi_volume_read(ubi_vol, (char *)&ent, pos, + sizeof(ent)); + if (ret) + return ret; + + ret = check_fip_toc_entry(&ent, &uuid, dent); + if (ret != -EAGAIN) + break; + + pos += sizeof(ent); + } + + return ret; +} +#endif + +static int parse_fip_firmware(struct firmware *firmwarep, + struct fip_storage_info *info, + struct fip_toc_entry *dent) +{ + switch (info->storage_interface) { + case FIP_STORAGE_INTERFACE_BLK: + return blk_parse_fip_firmware(firmwarep, info->desc, + &info->part_info, + info->part_offset, + dent); +#if CONFIG_IS_ENABLED(CMD_UBIFS) + case FIP_STORAGE_INTERFACE_UBI: + return ubi_parse_fip_firmware(firmwarep, + info->ubi_volume, + dent); +#endif + default: + return -EINVAL; + } +} + +static int blk_read_fip_firmware(struct firmware *firmwarep, + struct blk_desc *desc, + struct disk_partition *part_info, + unsigned int part_offset, + const struct fip_toc_entry *ent) +{ + lbaint_t offset = part_info->start + part_offset; + lbaint_t pos, to_read, read = 0; + u64 blkstart, blkcnt; + char *read_buf; + size_t size; + int i, ret; + + read_buf = malloc(desc->blksz); + if (!read_buf) + return -ENOMEM; + + size = min(firmwarep->size, (size_t)ent->size - firmwarep->offset); + blkcnt = BLOCK_CNT(size, desc); + blkstart = ent->offset_address + firmwarep->offset; + pos = do_div(blkstart, desc->blksz); + + /* Read data in the middle of a block */ + if (pos) { + to_read = min_t(lbaint_t, desc->blksz - pos, size); + ret = blk_dread(desc, offset + blkstart, 1, read_buf); + if (ret != 1) { + ret = -EINVAL; + goto out; + } + + memcpy((u8 *)firmwarep->data, read_buf + pos, to_read); + read += to_read; + blkstart++; + } + + /* Consume all the remaining block */ + for (i = 0; i < blkcnt && read < size; i++) { + to_read = min_t(lbaint_t, desc->blksz, size - read); + ret = blk_dread(desc, offset + blkstart + i, 1, read_buf); + if (ret != 1) { + ret = -EINVAL; + goto out; + } + + memcpy((u8 *)firmwarep->data + read, read_buf, to_read); + read += to_read; + } + + ret = read; + +out: + free(read_buf); + return ret; +} + +#if CONFIG_IS_ENABLED(CMD_UBIFS) +static int ubi_read_fip_firmware(struct firmware *firmwarep, + char *ubi_vol, + const struct fip_toc_entry *ent) +{ + unsigned int offset = firmwarep->offset; + size_t size; + int ret; + + size = min(firmwarep->size, (size_t)ent->size - offset); + if (!size) + return 0; + + ret = ubi_volume_read(ubi_vol, + (u8 *)firmwarep->data, + ent->offset_address + offset, + size); + if (ret) + return ret; + + return size; +} +#endif + +static int read_fip_firmware(struct firmware *firmwarep, + struct fip_storage_info *info, + const struct fip_toc_entry *dent) +{ + switch (info->storage_interface) { + case FIP_STORAGE_INTERFACE_BLK: + return blk_read_fip_firmware(firmwarep, info->desc, + &info->part_info, + info->part_offset, + dent); +#if CONFIG_IS_ENABLED(CMD_UBIFS) + case FIP_STORAGE_INTERFACE_UBI: + return ubi_read_fip_firmware(firmwarep, + info->ubi_volume, + dent); +#endif + default: + return -EINVAL; + } +} + +static int fw_parse_storage_info(struct udevice *dev, + struct fip_storage_info *info) +{ + struct fw_loader_plat *plat = dev_get_uclass_plat(dev); + struct fw_loader_env_info env_info = { }; + int ret; + + generic_fw_loader_env_info(&env_info); + info->part_offset = env_get_hex("fw_partoffset", 0); + + if (env_info.storage_interface && env_info.dev_part) { + int part; + + part = part_get_info_by_dev_and_name_or_num(env_info.storage_interface, + env_info.dev_part, + &info->desc, + &info->part_info, 1); + if (part < 0) + return part; + + info->storage_interface = FIP_STORAGE_INTERFACE_BLK; + + return 0; + } + + if (env_info.storage_interface && env_info.ubi_mtdpart && + env_info.ubi_volume) { + if (strcmp("ubi", env_info.storage_interface)) + return -ENODEV; + + ret = generic_fw_loader_ubi_select(env_info.ubi_mtdpart); + if (ret) + return ret; + + info->ubi_volume = env_info.ubi_volume; + info->storage_interface = FIP_STORAGE_INTERFACE_UBI; + + return 0; + } + + info->part_offset = plat->partoffset; + + if (plat->phandlepart.phandle) { + int part; + + ret = generic_fw_loader_get_phandle_desc(plat, &info->desc); + if (ret) + return ret; + + part = plat->phandlepart.partition; + if (part >= 1) + ret = part_get_info(info->desc, part, + &info->part_info); + else + ret = part_get_info_whole_disk(info->desc, + &info->part_info); + + info->storage_interface = FIP_STORAGE_INTERFACE_BLK; + + return ret; + } + + if (plat->mtdpart && plat->ubivol) { + ret = generic_fw_loader_ubi_select(plat->mtdpart); + if (ret) + return ret; + + info->ubi_volume = plat->ubivol; + info->storage_interface = FIP_STORAGE_INTERFACE_UBI; + + return 0; + } + + return -EINVAL; +} + +/** + * fw_get_fip_firmware - load firmware into an allocated buffer. + * @dev: An instance of a driver. + * + * Return: Size of total read, negative value when error. + */ +static int fw_get_fip_firmware(struct udevice *dev) +{ + struct fip_storage_info info = { }; + struct firmware *firmwarep; + struct fip_toc_entry ent; + int ret; + + ret = fw_parse_storage_info(dev, &info); + if (ret) + return ret; + + firmwarep = dev_get_uclass_priv(dev); + if (!firmwarep) + return -EINVAL; + + ret = parse_fip_firmware(firmwarep, &info, &ent); + if (ret) + return ret; + + if (firmwarep->offset > ent.size) { + log_err("Invalid offset. Entry too small\n"); + return -EINVAL; + } + + ret = read_fip_firmware(firmwarep, &info, &ent); + if (ret < 0) + log_err("Failed to read %s from FIP: %d.\n", + firmwarep->name, ret); + + return ret; +} + +/** + * fw_get_fip_firmware_size - get firmware size. + * @dev: An instance of a driver. + * + * Return: Size of firmware, negative value when error. + */ +static int fw_get_fip_firmware_size(struct udevice *dev) +{ + struct fip_storage_info info = { }; + struct firmware *firmwarep; + struct fip_toc_entry ent; + int ret; + + ret = fw_parse_storage_info(dev, &info); + if (ret) + return ret; + + firmwarep = dev_get_uclass_priv(dev); + if (!firmwarep) + return -EINVAL; + + ret = parse_fip_firmware(firmwarep, &info, &ent); + if (ret) + return ret; + + return ent.size - firmwarep->offset; +} + +static const struct fw_loader_ops fip_loader_ops = { + .get_firmware = fw_get_fip_firmware, + .get_size = fw_get_fip_firmware_size, +}; + +static int fip_loader_of_to_plat(struct udevice *dev) +{ + struct fw_loader_plat *plat = dev_get_uclass_plat(dev); + ofnode fw_loader_node; + + fw_loader_node = dev_ofnode(dev); + if (ofnode_valid(fw_loader_node)) { + ofnode_read_u32(fw_loader_node, "partoffset", + &plat->partoffset); + } + + return 0; +} + +static const struct udevice_id fip_loader_ids[] = { + { .compatible = "u-boot,fip-loader"}, + { } +}; + +U_BOOT_DRIVER(fip_loader) = { + .name = "fip-loader", + .id = UCLASS_FIRMWARE_LOADER, + .of_match = fip_loader_ids, + .of_to_plat = fip_loader_of_to_plat, + .ops = &fip_loader_ops, +}; diff --git a/drivers/misc/fw_loader/internal.h b/drivers/misc/fw_loader/internal.h index 1abe7504a81e..5af061321512 100644 --- a/drivers/misc/fw_loader/internal.h +++ b/drivers/misc/fw_loader/internal.h @@ -49,11 +49,13 @@ struct fw_loader_ops { * This holds information about all supported storage devices for driver use. * * @phandlepart: Attribute data for block device. + * @partoffset: Global offset for BLK partition. * @mtdpart: MTD partition for ubi partition. * @ubivol: UBI volume-name for ubifsmount. */ struct fw_loader_plat { struct phandle_part phandlepart; + u32 partoffset; char *mtdpart; char *ubivol; }; -- 2.55.0