From nobody Wed Dec 17 10:24:10 2025 Received: from mail-ej1-f49.google.com (mail-ej1-f49.google.com [209.85.218.49]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 06B5816C69C for ; Fri, 12 Jul 2024 12:11:53 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.218.49 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720786315; cv=none; b=M4xqUIPEC+i1uXt6RZapqW+UuwNHFGvAKY+sOxTsVvgqEM6kgMSc4yYT1ZbBsBSZnG2+yLwaNeGO+c6LCCKpH0DkKhaWl0ypVp3YvrIqnj9PT0EH2/6p8ytDsOMP2ITxJy93qjBvn95lNVhhCblDNaF7PsmJ4oVCIPN/JBnaRVQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720786315; c=relaxed/simple; bh=peaNIRSDh7na+pItaZXKqhaI1DhMoj12CQLzovOWPhE=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=trRYlHfILitI76wUBrJZQ10WF65SRvUkOz1RgVvmEMwXpF8T13o5LTuraHqd1Hsn2ndDYdx0rvkUfvaOapZREnIF1WO7SfUQ/Ct6jrxF3IqrLrTcV16pbTvWeWpZMOgQs9xsKQjo3b4aCBOuiQ7P1d9G3pKh3soBKgxYkajeaMk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linaro.org; spf=pass smtp.mailfrom=linaro.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b=D2EECQjX; arc=none smtp.client-ip=209.85.218.49 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=linaro.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="D2EECQjX" Received: by mail-ej1-f49.google.com with SMTP id a640c23a62f3a-a77cb7c106dso248175866b.1 for ; Fri, 12 Jul 2024 05:11:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1720786312; x=1721391112; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=1h1g9uMI//zZkOsywKROm75LHzYSQkW5aZxXVlXrI/g=; b=D2EECQjXOUGR4wsWScsfeoYIAyPkEbXkRUZ+/iAbFSnJxw/I4R6fKk392Dub94UhPk tQUsl9G0g/qBsQSTgumzBgloFjLugrLGs676dQPkIQaUQ2F1TzGXCXVME6EWdItQ4Gbd Cna4GktojirDz9/LRr7n5/4dHLm58nfQXhljD0iAIcRjLhqfiZkm+4688s/GCb+9CuaD qhY47DUTH8/v3HtGIoG8wjg/bfvA7CFfMsGkinsakAGWqK73syv4o2hlH+XHNucVEb0D McB3vJtzYGpb9vgfhbZCi7HLnSmp+bdAU3BMU8SQ7NblAwTgWVsjcCeQZ4tPWme25nyw pPKw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720786312; x=1721391112; 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=1h1g9uMI//zZkOsywKROm75LHzYSQkW5aZxXVlXrI/g=; b=oVz6a4gQ7eMnrdTR/1yTNTKCLJDI34VgQ/znw527k7sqgjkWrYvnAMWK8pnPnDfs6D cSGHgNPDusQPavaHB8CRTOPz9KGHljhqDvW99tbx7npHUYuFBlzp8tJsEcX6QQdZ8CRF 9lpHNXutVmrG9/UhzJQDerX4gs1vPVJXXxhG0YLN4ow2UGMWQsBVoPAhgrVXMs3t3sAZ pek8ekTNSfj/76Kf8W562A7RhHjk5gNdyN/+cS2ij3++I2P4h2lJrDfR5QjJkOIjV26H 8kv4fuybSOMfnqdpc/uku2LnvT/ZPDDpYwgat0Fg3IOPr/wJP+Ab3ss+dcc48Ywp15a0 eOFw== X-Forwarded-Encrypted: i=1; AJvYcCX9KUlJeEtZGNXqwDPE+RRQfXtt9Y8cYmIbI5llIdH18YstRADu2TULrABdfqPUjR7UH+Rq20MyKQ11XmjIlPsEh3ZeJTOhVBYZLYUk X-Gm-Message-State: AOJu0YzDE2H+d2prwiGx+5pI67+B79WMCsllcruxqzt+qpmPJmQ+wEv1 Us3IB+CH/irpFRKmkiFN/sJ6hYWkbGtk+Zh2P5QjJCPnEV1ZxrQpbSnkRg/ZKKc= X-Google-Smtp-Source: AGHT+IFlizhopdrciUI5vILUpYCou1a9/j8ia4PSXRPMY/ZkvR4wWaRFwWwG9z9Av85Qbo7akse2wA== X-Received: by 2002:a17:906:7c4d:b0:a77:cdaa:88a3 with SMTP id a640c23a62f3a-a780b6b30f8mr691602766b.27.1720786312302; Fri, 12 Jul 2024 05:11:52 -0700 (PDT) Received: from krzk-bin.. ([178.197.219.137]) by smtp.gmail.com with ESMTPSA id a640c23a62f3a-a780a6e58e0sm339527266b.85.2024.07.12.05.11.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Jul 2024 05:11:51 -0700 (PDT) From: Krzysztof Kozlowski To: Rob Herring , Krzysztof Kozlowski , Conor Dooley , devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Krzysztof Kozlowski , Marek Vasut , Jonathan Cameron , Sebastian Reichel Subject: [PATCH v3] dt-bindings: incomplete-devices: document devices without bindings Date: Fri, 12 Jul 2024 14:11:46 +0200 Message-ID: <20240712121146.90942-1-krzysztof.kozlowski@linaro.org> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" There are devices in the wild with non-updatable firmware coming with ACPI tables with rejected compatibles, e.g. "ltr,ltrf216a". Linux kernel still supports this device via ACPI PRP0001, however the compatible was never accepted to bindings. There are also several early PowerPC or SPARC platforms using compatibles for their OpenFirmware, but without in-tree DTS. Often the legacy compatible is not correct in terms of current Devicetree specification, e.g. missing vendor prefix. Finally there are also Linux-specific tools and test code with compatibles. Add a schema covering above cases purely to satisfy the DT schema and scripts/checkpatch.pl checks for undocumented compatibles. For ltr,ltrf216a this also documents the consensus: compatible is allowed only via ACPI PRP0001, but not bindings. Link: https://lore.kernel.org/all/20240705095047.90558-1-marex@denx.de/ Link: https://lore.kernel.org/lkml/20220731173446.7400bfa8@jic23-huawei/T/#= me55be502302d70424a85368c2645c89f860b7b40 Cc: Marek Vasut Cc: Jonathan Cameron Cc: Sebastian Reichel Signed-off-by: Krzysztof Kozlowski --- Changes in v3: 1. Incorrect->Legacy 2. Drop ohci-littledian 3. Drop unittest Changes in v2: 1. Rename to incomplete-devices.yaml 2. Add many compatibles based on Rob's feedback, rewrite descriptions in the schema. --- .../bindings/incomplete-devices.yaml | 137 ++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100644 Documentation/devicetree/bindings/incomplete-devices.ya= ml diff --git a/Documentation/devicetree/bindings/incomplete-devices.yaml b/Do= cumentation/devicetree/bindings/incomplete-devices.yaml new file mode 100644 index 000000000000..cfc1d39441b1 --- /dev/null +++ b/Documentation/devicetree/bindings/incomplete-devices.yaml @@ -0,0 +1,137 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/incomplete-devices.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Rejected, Legacy or Incomplete Devices + +maintainers: + - Rob Herring + +description: + Some devices will not or should not get a proper Devicetree bindings, but + their compatibles are present in Linux drivers for various reasons. + + Examples are devices using ACPI PRP0001 with non-updatable firmware/ACPI + tables or old PowerPC platforms without in-tree DTS. + + Following list of devices is an incomplete schema with a goal to pass DT= schema + checks on undocumented compatibles but also reject any DTS file using su= ch + un-approved compatible. + + Usage of any of following compatibles is not allowed in Devicetree sourc= es, + even if they come from immutable firmware. + +properties: + compatible: + oneOf: + - description: + Rejected compatibles in Devicetree, but used in ACPI-based devic= es + with non-updatable firmware/ACPI tables (via ACPI PRP0001) + enum: + - broadcom,bcm5241 + - ltr,ltrf216a + + - description: Legacy compatibles used on Macintosh devices + enum: + - adm1030 + - bmac+ + - heathrow-media-bay + - keylargo-media-bay + - lm87cimt + - MAC,adm1030 + - MAC,ds1775 + - max6690 + - ohare-media-bay + - ohare-swim3 + - smu-sat + - swim3 + + - description: Legacy compatibles used on other PowerPC devices + enum: + - 1682m-rng + - IBM,lhca + - IBM,lhea + - IBM,lhea-ethernet + - mpc5200b-fec-phy + - mpc5200-serial + - mpc5200-sram + - ohci-be + - ohci-bigendian + - ohci-le + + - description: Legacy compatibles used on SPARC devices + enum: + - bq4802 + - ds1287 + - isa-m5819p + - isa-m5823p + - m5819 + - sab82532 + - SUNW,bbc-beep + - SUNW,bbc-i2c + - SUNW,CS4231 + - SUNW,ebus-pic16f747-env + - SUNW,kt-cwq + - SUNW,kt-mau + - SUNW,n2-cwq + - SUNW,n2-mau + - SUNW,niusl + - SUNW,smbus-beep + - SUNW,sun4v-console + - SUNW,sun4v-pci + - SUNW,vf-cwq + - SUNW,vf-mau + + - description: Incomplete and/or legacy compatibles for unknown devi= ces + enum: + - electra-cf + - i2cpcf,8584 + - virtio,uml + + - description: Linux kernel unit tests and sample code + enum: + - audio-graph-card2-custom-sample + - compat1 + - compat2 + - compat3 + - linux,spi-loopback-test + - mailbox-test + - regulator-virtual-consumer + + - description: + Devices on MIPS platform, without any DTS users. These are + unlikely to get converted to DT schema. + enum: + - mti,ranchu + + - description: + Devices on PowerPC platform, without any DTS users. These are + unlikely to get converted to DT schema. + enum: + - fujitsu,coral + - fujitsu,lime + - fujitsu,MB86276 + - fujitsu,MB86277 + - fujitsu,MB86293 + - fujitsu,MB86294 + - fujitsu,mint + - ibm,axon-msic + - ibm,pmemory + - ibm,pmemory-v2 + - ibm,power-rng + - ibm,ppc4xx-spi + - ibm,sdram-4xx-ddr2 + - ibm,secureboot + - ibm,secureboot-v1 + - ibm,secureboot-v2 + - ibm,secvar-backend + - sgy,gpio-halt + - wrs,epld-localbus + +required: + - compatible + - broken-usage-of-incorrect-compatible + +additionalProperties: false --=20 2.43.0