From patchwork Thu Feb 13 22:04:04 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Adrian Freihofer X-Patchwork-Id: 57294 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id BF01CC021A4 for ; Thu, 13 Feb 2025 22:04:24 +0000 (UTC) Received: from mail-wm1-f51.google.com (mail-wm1-f51.google.com [209.85.128.51]) by mx.groups.io with SMTP id smtpd.web11.6364.1739484260130640812 for ; Thu, 13 Feb 2025 14:04:20 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=K3C+CzJF; spf=pass (domain: gmail.com, ip: 209.85.128.51, mailfrom: adrian.freihofer@gmail.com) Received: by mail-wm1-f51.google.com with SMTP id 5b1f17b1804b1-4395dddb07dso14824245e9.2 for ; Thu, 13 Feb 2025 14:04:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1739484258; x=1740089058; darn=lists.yoctoproject.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=ZsuRDn54P5d5kTIquC5K7FO4ESsPMqdeSFLXeXVtr6w=; b=K3C+CzJFq4tsayO+EVr3fpJKtOslCWYonbZjFlT6dplqJeS7z8FLjt+r5g+rxp+Vl6 cu0HxQjig3740NccUULbzQJw4AbvajFN0vBFWOp8o0YIpuOxxlrhavKhw6/FzDYt1JJs VemP2srbo27oLLMhtOtIjXpcL9qiP4EDN2P5aYiZ55KMZiuPCb19riDAjw9W3UCFq96e RS1QPBlL7qDImc3FRyetSUXITcPWzj4KRn/6eNWTzS68SN18Y6BVmbg8I3mVuvRJp4g/ xiCXbRpu/CWNQXkLqSqN4isKlzDICa831hMioxjwWbSgxWge2pyDlEY6K8cFuBEEpPhA cgew== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1739484258; x=1740089058; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=ZsuRDn54P5d5kTIquC5K7FO4ESsPMqdeSFLXeXVtr6w=; b=U+0W2TWachhlT+xIV7EuImmKqKfVCYfaFqomwzJBfgtZ2N4XtbI6f2njp3Z8k0Lmmb 460p/uPmRk8nBUG0a9frc3i8rTgrLw4lUlw0pWzS5uB9hmQw+b4NKfS+1GaoC78W0y1e c97KQNfOlTo6R1XQxFnBJK/8yxEaVsxivsEOAtq+TNT/jTR/r8we5L751PLoZvYIJext //MriyUKMm8S9Rk/peLk7G4NxfVnb4AV+dLOx4+MbBn0LSSpDNoBNeHRI5hTXEzoWzUz sw5ruyiUIHBV14AoDj6lY/F1u2RqKuaBp6f9VszGc5oVl25rUqAk86jFfonxq/nwyGgI hpeA== X-Gm-Message-State: AOJu0Ywj/hEuJZalZs0sXYruZ3zIXWoYCH6+KvV/h14TKp3Qel0VvKRQ Hn5m+ctEK0sJufJ2pSsHxlTm9082kBPWS+Xl2oJZSacJASSjKxqOVcN6Bw== X-Gm-Gg: ASbGnct1+vMw1OAqyWANojOVEXK6F3h6QKMLodQJXVs8UeLvnMge/BlNuTIHujSd4ap afHJ2VvK20N4eVf1rmUVAtE0IDFv7IWmXY6V9dh29yvoEBVCT/3MjMAgdEnDYGZfEQsh6KcWCMa RFd5XhU+r55XUaGekfKswgxOqNEchsEGDDCRCWYJaRIWKcvWHxT4sTqRCkNa6OZ1euA3PMJkMIa sVPFNPfTuMipnPtF2Ggg11NXegfXK/liG3oLTDn661G+6NnkbBOYO7uL7a9oLAUbs0QeKtvj3/w tYUYgXgHXAQnsHK/QSM2nVYiFB2yym88jWnEKA== X-Google-Smtp-Source: AGHT+IHOV1ZOND7ixyuI37ArfWvcidOg3cYEnG+mSMG6IaRwOo6eZmpfRil4ItMXQt9i/0EM/p4Fww== X-Received: by 2002:a05:6000:1ac6:b0:385:fd07:8616 with SMTP id ffacd0b85a97d-38dea1beadamr11254016f8f.0.1739484258037; Thu, 13 Feb 2025 14:04:18 -0800 (PST) Received: from wsadrian16.fritz.box ([2a02:169:59a6:0:55c4:f628:91f3:4287]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-38f259d5ee2sm2874191f8f.80.2025.02.13.14.04.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2025 14:04:17 -0800 (PST) From: Adrian Freihofer X-Google-Original-From: Adrian Freihofer To: docs@lists.yoctoproject.org Cc: Adrian Freihofer Subject: [PATCH 1/2] ref-manual: cover UBOOT_ENV variables Date: Thu, 13 Feb 2025 23:04:04 +0100 Message-ID: <20250213220405.3920122-1-adrian.freihofer@siemens.com> X-Mailer: git-send-email 2.47.1 MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 13 Feb 2025 22:04:24 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6364 Signed-off-by: Adrian Freihofer --- documentation/ref-manual/variables.rst | 42 ++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index adbef69d8f3..e44a105c53e 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3180,6 +3180,12 @@ system and gives an overview of their function and contents. The default value for this variable is set to "2048" by the :ref:`ref-classes-kernel-fitimage` class. + :term:`FIT_UBOOT_ENV` + This variable allows to add a u-boot script as a text file to the + fitImage. Such a script can be sourced from the u-boot shell, as + documented here: + `U-Boot source command `__ + :term:`FONT_EXTRA_RDEPENDS` When inheriting the :ref:`ref-classes-fontcache` class, this variable specifies the runtime dependencies for font packages. @@ -9777,6 +9783,42 @@ system and gives an overview of their function and contents. :ref:`ref-classes-kernel-fitimage` class to specify the load address to be used in creating the dtbo sections of Image Tree Source for the FIT image. + :term:`UBOOT_ENV` + Additional environment variables or a script can be installed alongside + U-Boot to be used automatically on boot. + This file, typically ``uEnv.txt`` or ``boot.cmd``, gets packaged along + with U-Boot (installed into /boot) as well as placed in the deploy + directory. + + Machine configurations needing one of these files should include it in + the :term:`SRC_URI` of the U-Boot recipe. + + If the variable :term:`UBOOT_ENV_SUFFIX` is set to ``scr`` the script is + packaged as a uImage (``mkinage -T script..``) othersise it gets + installed as it is. + Some Examples: + + - Adding a script ``boot.cmd`` as an uImage to /boot:: + + UBOOT_ENV = "boot" + UBOOT_ENV_SUFFIX = "scr" + SRC_URI += "file://${UBOOT_ENV}.${UBOOT_ENV_SRC_SUFFIX}" + + - Adding a script ``uEnv.txt`` as a plain text file to /boot:: + + UBOOT_ENV = "uEnv" + SRC_URI += "file://${UBOOT_ENV}.${UBOOT_ENV_SUFFIX}" + + :term:`UBOOT_ENV_SUFFIX` + If this variable is set to ``scr`` the script referred by + :term:`UBOOT_ENV` gets packaged as a uImage before it gets intalled. + The default is ``txt`` which means the script gets installed directly. + + :term:`UBOOT_ENV_SRC_SUFFIX` + If :term:`UBOOT_ENV_SUFFIX` is set to ``scr`` this is the suffix of the + plain text script file as it is referred by the :term:`SRC_URI` of the + U-Boot recipe. + :term:`UBOOT_ENTRYPOINT` Specifies the entry point for the U-Boot image. During U-Boot image creation, the :term:`UBOOT_ENTRYPOINT` variable is passed as a From patchwork Thu Feb 13 22:04:05 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Adrian Freihofer X-Patchwork-Id: 57295 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 99133C021A4 for ; Thu, 13 Feb 2025 22:04:34 +0000 (UTC) Received: from mail-wm1-f50.google.com (mail-wm1-f50.google.com [209.85.128.50]) by mx.groups.io with SMTP id smtpd.web11.6365.1739484267547103187 for ; Thu, 13 Feb 2025 14:04:27 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=LsLnT8Yc; spf=pass (domain: gmail.com, ip: 209.85.128.50, mailfrom: adrian.freihofer@gmail.com) Received: by mail-wm1-f50.google.com with SMTP id 5b1f17b1804b1-439585a067eso14517885e9.3 for ; Thu, 13 Feb 2025 14:04:27 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1739484266; x=1740089066; darn=lists.yoctoproject.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=yavD2BcmgOO7XUHSY7fsZzq0vzDpDqtoOxnWNRfJkRU=; b=LsLnT8YcbxovttmV0RWcxH6UojQJHS1+Vu5RcfP7l/elmUKSxYGzw00ZkBqlsDLKPE Dt3Eh+ITaXG+PH3hYhm3vt/XCnr5N/DeV0/rRpmqIU4HIYoNCCF9mGD3xNNiJr5nK3nw gwnP1ex7LYUfZMAmEJtZDYBzCiJFSIyZnUH0xA+dYa3IrpYCzU2Tcs/YzkuX7juSOfjy pt0ldziNSWeeV8oonWPApTTPY7tPEKtYv7jS8FqrclcqPfU113q34QgZOcvXtWQxXvbw T23Cqbw9/MSne4kqpUdLruCtOWxQbWRDF20y7UoVx/M4VtY/12N1MN/p8crPYNoMonGS D3kA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1739484266; x=1740089066; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=yavD2BcmgOO7XUHSY7fsZzq0vzDpDqtoOxnWNRfJkRU=; b=CEG5LjwSBEEiK7PEiJjy3xWtgtTXh+qbeXoJd2L1pXew6DqoTNPJnRymlRzTw+4Q1N lDsri0pyk25SqZLFvpALfIPrXw1Bo5XmiRZKBP4L7Bhzvq49Q8qlHvlItrLfGRKLrodO +GYZECy0Y/cB8UrbGfiaCuLYkht8uGq2lJKClF8dgjNww2rCuY8SgHQ3vNUKaVeU0smE iu+M9fydAYeEtF3yulV2GDUfJwcvLcZLhHaBxCPbH3j5T5dwgTNCfgV6/qXXxX5nlsx8 xqg4Y8zwsReoitDwQIVnXYyeodZraDWIGM5dDw42XStVihRPRmW4LnZ/W1d5jijA97qG o1zQ== X-Gm-Message-State: AOJu0Yx2TDSeuY7G1BMtj5V+oNzRccvm0nJxNzvcnE0iJIc7qd1m93rc zEGJhynl3nQSl2UzidYVFdYbG5AzKvIwj1GETBgK6hhzIIQeXMJS39wcxg== X-Gm-Gg: ASbGncujCWZgBpCelwpyKwWpD15iZc9Zn7+Y4h1aaxVRYdE6AEaamNSUJnFOzy76F6U 6tvWIEU0dSFdzhDRXHJhyUKq/c4xjkvamgfmHr4n8bxdfxtZyXF7zXLZ7PQBmEHPKLH49o028Gn qWirtxbJOFcb8UWM0LD4dYUQMu1lThJt/186zTrme9o81HhCpbPxK7IITQ9DS/UEfo5qdtjuDjD B6WDBW3yulYl+hSPFPASAduXgNwkRgqs/VtqLTHPkJf09YV8ZmW9QC9ZZIgWQaJOVvQjFaXIzNU +/26h8UZVlfGhkxDZHeNnLPiJxk87ySBYQf7Fg== X-Google-Smtp-Source: AGHT+IHtDcGNr3CeOarymPm77ZMfgFeoantYMLe72dU/Fr6CCcySsS0Jd+l/0GVNaNv7U5A2C3Takg== X-Received: by 2002:a05:6000:1847:b0:38d:d906:dbb0 with SMTP id ffacd0b85a97d-38dea252e94mr9487020f8f.7.1739484265662; Thu, 13 Feb 2025 14:04:25 -0800 (PST) Received: from wsadrian16.fritz.box ([2a02:169:59a6:0:55c4:f628:91f3:4287]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-38f259d5ee2sm2874191f8f.80.2025.02.13.14.04.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2025 14:04:24 -0800 (PST) From: Adrian Freihofer X-Google-Original-From: Adrian Freihofer To: docs@lists.yoctoproject.org Cc: Adrian Freihofer Subject: [PATCH 2/2] migration-guides: cover FIT_UBOOT_ENV Date: Thu, 13 Feb 2025 23:04:05 +0100 Message-ID: <20250213220405.3920122-2-adrian.freihofer@siemens.com> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20250213220405.3920122-1-adrian.freihofer@siemens.com> References: <20250213220405.3920122-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 13 Feb 2025 22:04:34 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6365 Add a hint for users using the UBOOT_ENV variable and the kernel-fitimage.bbclass. Signed-off-by: Adrian Freihofer --- documentation/migration-guides/migration-5.2.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/documentation/migration-guides/migration-5.2.rst b/documentation/migration-guides/migration-5.2.rst index de2ea773e55..e945e17a9df 100644 --- a/documentation/migration-guides/migration-5.2.rst +++ b/documentation/migration-guides/migration-5.2.rst @@ -182,3 +182,7 @@ Miscellaneous changes - :term:`ZSTD_COMPRESSION_LEVEL` is now a plain integer number instead of a dash-prefixed command-line option (e.g. it should be set to ``3`` rather than ``-3``). + +- :term:`UBOOT_ENV` is no longer handled by the ``kernel-fitimage.bbclass``. + There is a new variable :term:`FIT_UBOOT_ENV` which is supposed to be used + for adding a U-Boot script to a ``fitImage``.