From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-qt1-f169.google.com (mail-qt1-f169.google.com [209.85.160.169]) (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 0B2C2237172 for ; Fri, 26 Sep 2025 14:19:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.160.169 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758896368; cv=none; b=CkJiXLvSLFWjKWtTRIH/Sh1ywiJIrMovyt7ByyU+tA7ntY6+gyxm8rryEA2Vr/dIx15UU9FSm/Mz5zVsTn4S3GbIZUNgUrb/sJ7qE4cVmhI+AYGq/WQcVL+V0Tw0oIrQ1smPYzxn6fu1Xp+ywvR8BajeqL8/2B4iA1juK6vkU1M= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758896368; c=relaxed/simple; bh=qR2a+sIy1dcLg4TApO3hcXxTpdtuA3Glq5C890ldghM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=jf0kkJpCb9H/m73VMVMEjzQYR3foH1raeRrK0oi1Z5IxXmXYJt015aCKSvNTkxa0OrbaDe4pkH608SjFDeLm37VjozhbRKQTBp/7A/0i2TiKONWGFOIFDxEDpjsjLhfgh5hfqHCOwOq/YJHbu0lF6TvqmXOeunbW+DV07gRhSI0= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=PvkrRJjQ; arc=none smtp.client-ip=209.85.160.169 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="PvkrRJjQ" Received: by mail-qt1-f169.google.com with SMTP id d75a77b69052e-4dca66a31f7so16115661cf.3 for ; Fri, 26 Sep 2025 07:19:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1758896363; x=1759501163; darn=vger.kernel.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=9mRRNbCZTXtY9rhLVn7v5LDS/spOOkK98V0GNyagck8=; b=PvkrRJjQ4oNJLZGf5EyCtF68/3fyal4UdAIK5/WTnVfvbkP9leAbCpL2kGz8UDF7B9 WEDAZinJTTJq70pBz1K15VCTWM1zaz8w/z93VUhD0s4YiKQKHalo3fgmKZbZVAgxjhsf vOQBT4zGPW8o2KJsHZQcSfW7bH1eVRfMUBmqCNAYol63ViRoEzoQ2stpsCj0tovp6WHq +kp7jn/bwXjYSZSy/ESPDKsctEmUzqttYsbn83IOLxT18su0sTwjQCGJhRQBEmps5Ixa 4JvBFmuO1tHgor5DBoBkbj8r3c8O9z36Ad/VrWMagw3YU7bpsgEVeaz2Aup4+4uQW8gY wuiA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1758896363; x=1759501163; 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=9mRRNbCZTXtY9rhLVn7v5LDS/spOOkK98V0GNyagck8=; b=QRU/0WTJWsTTlBlL2bPtDIjPEuHQRQhQt+tH7RoLnKjKoz7P+xNIv7AvLHKaNG/CoR jZ0pCZgRt6OZO1fyWelj9rx/ITY69YZ+DrPAEAFuSuL1IMRJ0uz5z+2UwupZxUhXeuNz 3pyXbh7+khkmktfxihugVK7SZwnXo+tjg/xW5zDgWHGfz1UiRcQwZIcdZdQ05rj8LrI6 zXA5S417v6tLjFGCfVTX9R3dXNjc+eflvvd/z3XSAwdLQjqTr8wLMJnfevBA/8t8T4fm vkQ2kKPTDc066uVe6m6ljTRzy1PHTOnes6PEd2pBQIr4xZbd9Oat2D8C3m9Nb88v6nIJ PsXQ== X-Forwarded-Encrypted: i=1; AJvYcCU8pYl0tGHRLbALuO9eoXcGnzKE3I/JLHOpT04aGopBR1o7t+lspcgrDB8EMRzoncrUvyE4awRYxthG@vger.kernel.org X-Gm-Message-State: AOJu0YxNz07MGn05mGI1DonhhRTTBPoOtxknL5CgIf7yKOdz5taBi2ik R7YM6NLmL5Xmh5430Iy+n/QTy6/ym8zzz4WMvczP33Ef12tE26Ka2aME X-Gm-Gg: ASbGncuJuSzBOnwML8xWRPY0cj9uJTCfYqm3V8TgK2ZMhounEVBqaWDkTMcEdjgpcAp plZgCDLKS0dBvqgB56SfXfTPOeAsoR6eYysiFrxeHl+pLtqwJSw1Pre1Rnk2sJ2/P7/n22Y21a7 RhN1HF4AEpIhX8+YFfbhf1BPL30ldAEA2+1f1ReFZgBsrJWOk3dWKVknm+yqzVs1CkoHrxSS/BJ SNjMavdJlAoRDcouv5Iux2KMlu+YC0TdSE2XC+PCiBQkjsvnzsZxlr8Rp8z2r+HvxwKef68ZDIK 4IaxNFKes28eACHJGNfBHTg90WFCACWEXGNGDcZX3bq+X+39NXfTKmpTvD/1uN92yeB3UEeZ2u7 n14Z7UVHXnKLShaFkH8fVNxTluzhlR6AjR3fqOOn9g4LYiJaSnvM8WREhZde8cCvV13oUKOgQXA PPeH+R9ykSV9Jxxw== X-Google-Smtp-Source: AGHT+IEQRquuaaARqWA3ptXlfqCpzgIfaknBU2dPbrE0a9uXyM4/oQ1KfvORDQ1cqWtH62rjngjY+Q== X-Received: by 2002:ac8:5fd3:0:b0:4d3:a453:c503 with SMTP id d75a77b69052e-4da4e099ef0mr105385861cf.84.1758896359975; Fri, 26 Sep 2025 07:19:19 -0700 (PDT) Received: from localhost (modemcable197.17-162-184.mc.videotron.ca. [184.162.17.197]) by smtp.gmail.com with ESMTPSA id d75a77b69052e-4db0b9458e1sm26078801cf.15.2025.09.26.07.19.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 26 Sep 2025 07:19:19 -0700 (PDT) From: =?UTF-8?q?Jean-Fran=C3=A7ois=20Lessard?= To: Andy Shevchenko , Geert Uytterhoeven , Rob Herring , Krzysztof Kozlowski , Conor Dooley Cc: linux-kernel@vger.kernel.org, linux-leds@vger.kernel.org, devicetree@vger.kernel.org Subject: [PATCH v5 3/7] dt-bindings: auxdisplay: add Titan Micro Electronics TM16xx Date: Fri, 26 Sep 2025 10:19:04 -0400 Message-ID: <20250926141913.25919-4-jefflessard3@gmail.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250926141913.25919-1-jefflessard3@gmail.com> References: <20250926141913.25919-1-jefflessard3@gmail.com> Precedence: bulk X-Mailing-List: devicetree@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add documentation for TM16xx-compatible 7-segment LED display controllers with keyscan. Signed-off-by: Jean-François Lessard --- Notes: The 'segments' property is intentionally not vendor-prefixed as it defines a generic hardware description concept applicable to any 7-segment display controller. The property describes the fundamental grid/segment coordinate mapping that is controller-agnostic and could be reused by other LED matrix display bindings. Similar to how 'gpios' describes GPIO connections generically, 'segments' describes segment connections in a standardized way using uint32-matrix format. The property uses explicit coordinate pairs to handle real-world hardware variations. Some board manufacturers use standard layouts (same grid, different segments per digit) while others use transposed layouts (same segment, different grids per digit). The coordinate-pair approach accommodates both patterns without requiring separate arrays or boolean flags, as confirmed acceptable by DT maintainers. .../bindings/auxdisplay/titanmec,tm16xx.yaml | 463 ++++++++++++++++++ MAINTAINERS | 5 + 2 files changed, 468 insertions(+) create mode 100644 Documentation/devicetree/bindings/auxdisplay/titanmec,tm16xx.yaml diff --git a/Documentation/devicetree/bindings/auxdisplay/titanmec,tm16xx.yaml b/Documentation/devicetree/bindings/auxdisplay/titanmec,tm16xx.yaml new file mode 100644 index 000000000000..d324023bbffb --- /dev/null +++ b/Documentation/devicetree/bindings/auxdisplay/titanmec,tm16xx.yaml @@ -0,0 +1,463 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/auxdisplay/titanmec,tm16xx.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Auxiliary displays based on TM16xx and compatible LED controllers + +maintainers: + - Jean-François Lessard + +description: | + LED matrix controllers used in auxiliary display devices that drive individual + LED icons and 7-segment digit groups through a grid/segment addressing scheme. + Controllers manage a matrix of LEDs organized as grids (columns/banks in + vendor datasheets) and segments (rows/bit positions in vendor datasheets). + Maximum brightness and grid/segment indices are controller-specific. + Controller-specific maximum are validated in the driver. + + The controller is agnostic of the display layout. Board-specific LED wiring is + described through child nodes that specify grid/segment coordinates for + individual icons and segment mapping for 7-segment digits. + + The bindings use separate 'leds' and 'digits' containers to accommodate + different addressing schemes: + - LEDs use 2-cell addressing (grid, segment) for matrix coordinates + - Digits use 1-cell addressing with explicit segment mapping + + The controller node exposes a logical LED-like control for the aggregate + display brightness. Child nodes describe individual icons and 7-seg digits. + The top-level control supports only label and brightness-related properties + and does not support other common LED properties such as color or function. + Child LED nodes use the standard LED binding. + + Optional keypad scanning is supported when both 'linux,keymap' and + 'poll-interval' properties are specified. + +properties: + compatible: + oneOf: + - items: + - enum: + - fdhisi,fd628 + - princeton,pt6964 + - wxicore,aip1628 + - const: titanmec,tm1628 + - items: + - enum: + - wxicore,aip1618 + - const: titanmec,tm1618 + - items: + - enum: + - fdhisi,fd650 + - wxicore,aip650 + - const: titanmec,tm1650 + - enum: + - fdhisi,fd620 + - fdhisi,fd655 + - fdhisi,fd6551 + - titanmec,tm1618 + - titanmec,tm1620 + - titanmec,tm1628 + - titanmec,tm1638 + - titanmec,tm1650 + - winrise,hbs658 + + reg: + maxItems: 1 + + label: + description: + The label for the top-level LED. If omitted, the label is taken from the + node name (excluding the unit address). It has to uniquely identify a + device, i.e. no other LED class device can be assigned the same label. + + max-brightness: + minimum: 0 # 0=off + maximum: 8 # Maximum across all TM16xx controllers + description: + Normally the maximum brightness is determined by the hardware and this + property is not required. This property is used to put a software limit + on the brightness apart from what the driver says, as it could happen + that a LED can be made so bright that it gets damaged or causes damage + due to restrictions in a specific system, such as mounting conditions. + + default-brightness: + minimum: 0 # 0=off + maximum: 8 # Maximum across all TM16xx controllers + description: + Brightness to be set if LED's default state is on. Used only during + initialization. If the option is not set then max brightness is used. + + digits: + type: object + description: Container for 7-segment digit group definitions + additionalProperties: false + + properties: + "#address-cells": + const: 1 + "#size-cells": + const: 0 + + patternProperties: + "^digit@[0-9]+$": + type: object + unevaluatedProperties: false + + properties: + reg: + description: + Digit position identifier numbered sequentially left-to-right, + with reg=0 representing the leftmost digit position as displayed + to the user. + maxItems: 1 + + segments: + $ref: /schemas/types.yaml#/definitions/uint32-matrix + description: | + Array of grid/segment coordinate pairs for each 7-segment position. + Each entry is mapping to standard 7-segment positions + in order: a, b, c, d, e, f, g + + Standard 7-segment layout: + aaa + f b + f b + ggg + e c + e c + ddd + items: + items: + - description: Grid index + - description: Segment index + minItems: 7 + maxItems: 7 + + required: + - reg + - segments + + leds: + type: object + description: Container for individual LED icon definitions + additionalProperties: false + + properties: + "#address-cells": + const: 2 + "#size-cells": + const: 0 + + patternProperties: + "^led@[0-9]+,[0-9]+$": + type: object + $ref: /schemas/leds/common.yaml# + unevaluatedProperties: false + + properties: + reg: + description: + Grid and segment indices as of this individual LED icon + + required: + - reg + +dependencies: + poll-interval: + - linux,keymap + linux,keymap: + - poll-interval + autorepeat: + - linux,keymap + - poll-interval + +required: + - compatible + - reg + +allOf: + - $ref: /schemas/leds/common.yaml# + properties: + color: false + function: false + function-enumerator: false + - $ref: /schemas/input/input.yaml# + - $ref: /schemas/input/matrix-keymap.yaml# + # SPI controllers require 3-wire (combined MISO/MOSI line) + - if: + properties: + compatible: + contains: + enum: + - fdhisi,fd620 + - fdhisi,fd628 + - princeton,pt6964 + - titanmec,tm1618 + - titanmec,tm1620 + - titanmec,tm1628 + - titanmec,tm1638 + - wxicore,aip1618 + - wxicore,aip1628 + then: + $ref: /schemas/spi/spi-peripheral-props.yaml# + properties: + spi-3wire: true + required: + - spi-3wire + +unevaluatedProperties: false + +examples: + - | + #include + + // I2C example: Magicsee N5 TV box with fd655 controller + i2c { + #address-cells = <1>; + #size-cells = <0>; + + display@24 { + reg = <0x24>; + compatible = "fdhisi,fd655"; + + digits { + #address-cells = <1>; + #size-cells = <0>; + digit@0 { + reg = <0>; + segments = <1 3>, <1 4>, <1 5>, <1 0>, <1 1>, <1 2>, <1 6>; + }; + digit@1 { + reg = <1>; + segments = <2 3>, <2 4>, <2 5>, <2 0>, <2 1>, <2 2>, <2 6>; + }; + digit@2 { + reg = <2>; + segments = <3 3>, <3 4>, <3 5>, <3 0>, <3 1>, <3 2>, <3 6>; + }; + digit@3 { + reg = <3>; + segments = <4 3>, <4 4>, <4 5>, <4 0>, <4 1>, <4 2>, <4 6>; + }; + }; + + leds { + #address-cells = <2>; + #size-cells = <0>; + led@0,0 { + reg = <0 0>; + function = LED_FUNCTION_ALARM; + }; + led@0,1 { + reg = <0 1>; + function = LED_FUNCTION_USB; + }; + led@0,2 { + reg = <0 2>; + function = "play"; + }; + led@0,3 { + reg = <0 3>; + function = "pause"; + }; + led@0,4 { + reg = <0 4>; + function = "colon"; + }; + led@0,5 { + reg = <0 5>; + function = LED_FUNCTION_LAN; + }; + led@0,6 { + reg = <0 6>; + function = LED_FUNCTION_WLAN; + }; + }; + }; + }; + + - | + #include + + // SPI example: TM1638 module with keypad support + spi { + #address-cells = <1>; + #size-cells = <0>; + + display@0 { + reg = <0>; + compatible = "titanmec,tm1638"; + spi-3wire; + spi-lsb-first; + spi-max-frequency = <500000>; + + label = "tm1638"; + default-brightness = <2>; + max-brightness = <4>; + poll-interval = <100>; + linux,keymap = ; + + digits { + #address-cells = <1>; + #size-cells = <0>; + + digit@0 { + reg = <0>; + segments = <7 0>, <7 1>, <7 2>, <7 3>, <7 4>, <7 5>, <7 6>; + }; + + digit@1 { + reg = <1>; + segments = <6 0>, <6 1>, <6 2>, <6 3>, <6 4>, <6 5>, <6 6>; + }; + + digit@2 { + reg = <2>; + segments = <5 0>, <5 1>, <5 2>, <5 3>, <5 4>, <5 5>, <5 6>; + }; + + digit@3 { + reg = <3>; + segments = <4 0>, <4 1>, <4 2>, <4 3>, <4 4>, <4 5>, <4 6>; + }; + + digit@4 { + reg = <4>; + segments = <3 0>, <3 1>, <3 2>, <3 3>, <3 4>, <3 5>, <3 6>; + }; + + digit@5 { + reg = <5>; + segments = <2 0>, <2 1>, <2 2>, <2 3>, <2 4>, <2 5>, <2 6>; + }; + + digit@6 { + reg = <6>; + segments = <1 0>, <1 1>, <1 2>, <1 3>, <1 4>, <1 5>, <1 6>; + }; + + digit@7 { + reg = <7>; + segments = <0 0>, <0 1>, <0 2>, <0 3>, <0 4>, <0 5>, <0 6>; + }; + }; + + leds { + #address-cells = <2>; + #size-cells = <0>; + + led@0,7 { + reg = <0 7>; + }; + + led@1,7 { + reg = <1 7>; + }; + + led@2,7 { + reg = <2 7>; + }; + + led@3,7 { + reg = <3 7>; + }; + + led@4,7 { + reg = <4 7>; + }; + + led@5,7 { + reg = <5 7>; + }; + + led@6,7 { + reg = <6 7>; + }; + + led@7,7 { + reg = <7 7>; + }; + }; + }; + }; + + - | + #include + + // SPI example: X96 Max with transposed layout (fd628 with tm1628 fallback) + spi { + #address-cells = <1>; + #size-cells = <0>; + + display@0 { + reg = <0>; + compatible = "fdhisi,fd628", "titanmec,tm1628"; + spi-3wire; + spi-lsb-first; + spi-max-frequency = <500000>; + + digits { + #address-cells = <1>; + #size-cells = <0>; + digit@0 { + reg = <0>; + segments = <0 7>, <1 7>, <2 7>, <3 7>, <4 7>, <5 7>, <6 7>; + }; + digit@1 { + reg = <1>; + segments = <0 6>, <1 6>, <2 6>, <3 6>, <4 6>, <5 6>, <6 6>; + }; + digit@2 { + reg = <2>; + segments = <0 5>, <1 5>, <2 5>, <3 5>, <4 5>, <5 5>, <6 5>; + }; + digit@3 { + reg = <3>; + segments = <0 4>, <1 4>, <2 4>, <3 4>, <4 4>, <5 4>, <6 4>; + }; + }; + + leds { + #address-cells = <2>; + #size-cells = <0>; + led@0,3 { + reg = <0 3>; + function = "apps"; + }; + led@1,3 { + reg = <1 3>; + function = "setup"; + }; + led@2,3 { + reg = <2 3>; + function = LED_FUNCTION_USB; + }; + led@3,3 { + reg = <3 3>; + function = LED_FUNCTION_SD; + }; + led@4,3 { + reg = <4 3>; + function = "colon"; + }; + led@5,3 { + reg = <5 3>; + function = "hdmi"; + }; + led@6,3 { + reg = <6 3>; + function = "video"; + }; + }; + }; + }; diff --git a/MAINTAINERS b/MAINTAINERS index f6206963efbf..9449dfc43a15 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -25441,6 +25441,11 @@ W: http://sourceforge.net/projects/tlan/ F: Documentation/networking/device_drivers/ethernet/ti/tlan.rst F: drivers/net/ethernet/ti/tlan.* +TM16XX-COMPATIBLE LED CONTROLLERS DISPLAY DRIVER +M: Jean-François Lessard +S: Maintained +F: Documentation/devicetree/bindings/auxdisplay/titanmec,tm16xx.yaml + TMIO/SDHI MMC DRIVER M: Wolfram Sang L: linux-mmc@vger.kernel.org -- 2.43.0