From patchwork Tue Jul 14 14:28:20 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Adrian Schmutzler X-Patchwork-Id: 1328927 X-Patchwork-Delegate: freifunk@adrianschmutzler.de Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.openwrt.org (client-ip=2001:8b0:10b:1231::1; helo=merlin.infradead.org; envelope-from=openwrt-devel-bounces+incoming=patchwork.ozlabs.org@lists.openwrt.org; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=adrianschmutzler.de Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; secure) header.d=lists.infradead.org header.i=@lists.infradead.org header.a=rsa-sha256 header.s=merlin.20170209 header.b=29cWTdt8; dkim-atps=neutral Received: from merlin.infradead.org (merlin.infradead.org [IPv6:2001:8b0:10b:1231::1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4B5jdH4W4gz9sRN for ; Wed, 15 Jul 2020 00:31:47 +1000 (AEST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:List-Subscribe:List-Help:List-Post:List-Archive:List-Unsubscribe :List-Id:MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:To:From: Reply-To:Cc:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=vIdGU0PZcx25bm6Wmfd6U5+lpZhgeuITPaXFTNj/NCQ=; b=29cWTdt8cxMMNL1Ty6KCX6CQ1l PZez8v2DWBn70kNBAeSbIJ5Ds79l19QvvgNTPMcEjcpch7MJ4Kou1wWGCwStLUJk8Hgbmbo2Hl3OQ a8Tqu2IE2BvmGwSUDfPQTuO2ZNlb02SkxE+13vETC5ykI+6rhQGxfMSniHStO9o7y6H1g3rMxv5Kz faBerEUwZW18aSrGOQLtt2RGnDR63bB+2QCa81HLKqBzjPpTvxMVYyrvSAKHRC4qGieGyCR1rZsj/ SmUICVYCOwetqkc3zvi9CiTvgz3Vjden84RLqm5wDlpskCM7HP48f1u/TopxVHvV6v33d463ZQI6c rMu5TN8Q==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jvLvw-0000MP-OT; Tue, 14 Jul 2020 14:29:24 +0000 Received: from mout.kundenserver.de ([212.227.17.24]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jvLvn-0000FS-LB for openwrt-devel@lists.openwrt.org; Tue, 14 Jul 2020 14:29:19 +0000 Received: from buildfff.adridolf.com ([188.192.134.246]) by mrelayeu.kundenserver.de (mreue109 [212.227.15.183]) with ESMTPSA (Nemesis) id 1MOzKk-1kE0s71rVE-00PQ0T for ; Tue, 14 Jul 2020 16:29:11 +0200 From: Adrian Schmutzler To: openwrt-devel@lists.openwrt.org Subject: [PATCH v2 1/6] build: add DEVICE_COMPAT_VERSION and DEVICE_COMPAT_MESSAGE Date: Tue, 14 Jul 2020 16:28:20 +0200 Message-Id: <20200714142825.16889-2-freifunk@adrianschmutzler.de> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200714142825.16889-1-freifunk@adrianschmutzler.de> References: <20200714142825.16889-1-freifunk@adrianschmutzler.de> MIME-Version: 1.0 X-Provags-ID: V03:K1:ID61EaK5vlrVfoceBLSXFhSWWVKsrCmHylyatGFxD7GgmCb0AeV NXp2FAkV/uqNdWCJBNBVW9kc/OMYrFpihUI51Z30jbTMO5/eaSNzBkAAK7begIStQ+cVzpI B/Od0gLwxdLDMbDMTBb+9PkOxsFFhy6OhJY5lUBzTu8C2eSxKhukQYyQhYWfK/aGLK/VWtY iHj3KcuQwdi5Cc5yxXZPg== X-Spam-Flag: NO X-UI-Out-Filterresults: notjunk:1;V03:K0:Blq3xamVcBk=:x9Fr6yj44YfzyDObVEs2cm TJDDqDA8/FTC1KmNd+Yx1IENG7R00cqnTm4giL0NRjft6zAs4UyBdha9XJuRKck/3sMa3sa64 T9I+PseP3NrC+sVLeqFuXmHJK7hL6EKLa3YzqQ2XhBGgr+YiRK7+XmSabOXUurbTYiq2fWvP7 7KFsF8TLjS4lw3sQLMfcrY7NsGh2RJtYKVBC9H4T8TH1WVroVriucY7kKM6mFWUBY01vM0I1P OeJ3kbm/o7T6shHw3ox9zFjLfLfcwu+a+jM5BUZH6Ugadlpn/qZxoJnpOBEtjr9WsgjSwjcU2 XwFBN7+VGjyQVXbaiSgSTqqon0fDw01VpLqtMoxleAt45thR9K5NWZZMS7goI+xgq5cU57FI6 WuAI9PY4QLwb39fA9cKJsHvnY2vMAQymDtclVCtCjy8Rj7JC+0nkAyHgLwEek3Y3AGBBJTLIX wdk7i4KTpr6jhFNoAa6y9v+ZWXi//NuRal1JoVGqJoXmNnUM8gKDJWOwokl5RMayNKEeMFe9l C/9ybeW4JhwPmiwqwNAHK7sQ79tuKeyVBUiitE5s6KVB7yTU6ei80YYeDgxNyn4U0Qc9bPKL7 eS5CZRga1yGtN1Uq5oHR1WjqtI2E+0ZqixWUznFLbKGg13y9H6TfUnvmzsgPVmJTKc3t+ipjO SgTNsgteKUy7IbzLXWMDocovX/bxw/+m9WoRyKzK2YIVkYSYj5vtwWWJQlHM1fAbr6rzc90Oh 6USnoGV/PunX9eOM2heArdb/mVfnIl1ZDKINviOps9US2sX9rChoxqOHZagOKuCOFlommS5li Qonk0VfVI1ylY5D/KsbR+aoDyOcN5pilB6JTNqfvjeLEtAm8mPMDdpHUG5SALYc0Y++ox3eqW C6A2SF705nzxmaj6iulQ== X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200714_102916_047226_E73A490C X-CRM114-Status: GOOD ( 12.11 ) X-Spam-Score: -0.0 (/) X-Spam-Report: SpamAssassin version 3.4.4 on merlin.infradead.org summary: Content analysis details: (-0.0 points) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [212.227.17.24 listed in list.dnswl.org] -0.0 RCVD_IN_MSPIKE_H2 RBL: Average reputation (+2) [212.227.17.24 listed in wl.mailspike.net] -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record X-BeenThere: openwrt-devel@lists.openwrt.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: OpenWrt Development List List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "openwrt-devel" Errors-To: openwrt-devel-bounces+incoming=patchwork.ozlabs.org@lists.openwrt.org We regularly encounter the situation that devices are subject to changes that will make them incompatible to previous versions. Removing SUPPORTED_DEVICES will not really be helpful in most of these cases, as this only helps after a rename. To solve this situation, this patchset introduces a compatibility version for devices. It will be implemented via a per-device Make variable DEVICE_COMPAT_VERSION, which will be set to 1.0 globally by default and then can be overwritten as needed. Furthermore, a variable DEVICE_COMPAT_MESSAGE is added, where a message to be displayed during sysupgrade may be specified optionally. This patch only implements the build variables and adds them to the sysupgrade metadata, the evaluation will be addressed in a subsequent patch. To set it, one would just need to add the following to a device node: define Device/somedevice ... DEVICE_COMPAT_VERSION := 1.1 DEVICE_COMPAT_MESSAGE := Config cannot be migrated from swconfig to DSA endef Signed-off-by: Adrian Schmutzler --- include/image-commands.mk | 7 +++++-- include/image.mk | 3 +++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/include/image-commands.mk b/include/image-commands.mk index e7db7128b4..9da712e733 100644 --- a/include/image-commands.mk +++ b/include/image-commands.mk @@ -384,13 +384,16 @@ define Build/tplink-v2-image rm -rf $@.new endef +compat_version=$(if $(DEVICE_COMPAT_VERSION),$(DEVICE_COMPAT_VERSION),1.0) json_quote=$(subst ','\'',$(subst ",\",$(1))) #")') metadata_devices=$(if $(1),$(subst "$(space)","$(comma)",$(strip $(foreach v,$(1),"$(call json_quote,$(v))")))) metadata_json = \ '{ $(if $(IMAGE_METADATA),$(IMAGE_METADATA)$(comma)) \ "metadata_version": "1.0", \ - "supported_devices":[$(call metadata_devices,$(1))], \ + "compat_version": "$(call json_quote,$(compat_version))", \ + $(if $(DEVICE_COMPAT_MESSAGE),"compat_message": "$(call json_quote,$(DEVICE_COMPAT_MESSAGE))"$(comma)) \ + "supported_devices":[$(call metadata_devices,$(SUPPORTED_DEVICES))], \ "version": { \ "dist": "$(call json_quote,$(VERSION_DIST))", \ "version": "$(call json_quote,$(VERSION_NUMBER))", \ @@ -401,7 +404,7 @@ metadata_json = \ }' define Build/append-metadata - $(if $(SUPPORTED_DEVICES),-echo $(call metadata_json,$(SUPPORTED_DEVICES)) | fwtool -I - $@) + $(if $(SUPPORTED_DEVICES),-echo $(call metadata_json) | fwtool -I - $@) [ ! -s "$(BUILD_KEY)" -o ! -s "$(BUILD_KEY).ucert" -o ! -s "$@" ] || { \ cp "$(BUILD_KEY).ucert" "$@.ucert" ;\ usign -S -m "$@" -s "$(BUILD_KEY)" -x "$@.sig" ;\ diff --git a/include/image.mk b/include/image.mk index 300f7a6619..dbdc820f4d 100644 --- a/include/image.mk +++ b/include/image.mk @@ -419,6 +419,8 @@ define Device/Init BOARD_NAME := UIMAGE_NAME := + DEVICE_COMPAT_VERSION := 1.0 + DEVICE_COMPAT_MESSAGE := SUPPORTED_DEVICES := IMAGE_METADATA := @@ -435,6 +437,7 @@ DEFAULT_DEVICE_VARS := \ VID_HDR_OFFSET UBINIZE_OPTS UBINIZE_PARTS MKUBIFS_OPTS DEVICE_DTS \ DEVICE_DTS_CONFIG DEVICE_DTS_DIR SOC BOARD_NAME UIMAGE_NAME SUPPORTED_DEVICES \ IMAGE_METADATA KERNEL_ENTRY KERNEL_LOADADDR UBOOT_PATH IMAGE_SIZE \ + DEVICE_COMPAT_VERSION DEVICE_COMPAT_MESSAGE \ DEVICE_VENDOR DEVICE_MODEL DEVICE_VARIANT \ DEVICE_ALT0_VENDOR DEVICE_ALT0_MODEL DEVICE_ALT0_VARIANT \ DEVICE_ALT1_VENDOR DEVICE_ALT1_MODEL DEVICE_ALT1_VARIANT \