Received: by 2002:a05:6a10:22f:0:0:0:0 with SMTP id 15csp2132937pxk; Sat, 5 Sep 2020 09:38:24 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzDwD6UBag7rmbFJxMyziD1nEDvbhWyHB6LmM9qJTDtNgHWBKSv6Eypn6tYaHbdGaIK3HuW X-Received: by 2002:a50:fb98:: with SMTP id e24mr13928112edq.130.1599323904597; Sat, 05 Sep 2020 09:38:24 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1599323904; cv=none; d=google.com; s=arc-20160816; b=T3/5ctQSEC8b5AZVCThq8W4B8yQeKkC0a6eoWMfNPyUuUB/fG8u4xMN4bkTCfm2v9T KkKe7XMl1hD1mhNFsNoGQj3BuuMBEruKTK0Ul5tjtM6HMS4Tp0bFRH0HEc8Va1Cn5oKy 4bbsYYx3qlrlGDTx4pGter3CmubR71LRtOajZKEMMHubo/qk7wwpmNJKkCq7GaVSaafN ZDXm2qdfHkrEKFTZrxQCq6dQJbBGGty2Cf83opmzkxGxlHUD4ALw2+IzWOfYTqpVb96L 2/qESS8pGD/POdgycW+wrLgeLhFc+Xv2ikvB6jMkOgweRTxIScELNrUg9v1iwxadrX69 OFdg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from; bh=h86uFkJ1zfbZCUBF27W9NdLKVjUJef/miDXsaiQ0fmk=; b=uLKUWal7kFgPpxKmK2ORcxobyYbzTt+FBhqyLVS8WrYDD/TP8Gt2OH1CPdTajdK1ak 1bxUCQ6Kgep3LCPNkhJs4CvaXJj3hptLhnCW43eSOvUJl2EeJlAWlea+5zfCI3tG7ztq a57wbrd0htwUTZ1qe0YxcUhcaeBDPrhRYWmsz79RKoxymyDWko491RRtgcnH6KOk/P01 zSuscidCzOJ6dMwV5H8GPSpTwKifQB9XDqa4+j/5phpyNqBiZh/NHXhAX1oXAHkKCmA9 EtZ0LLX4KwkUZw58KoI55ftzL/ePb3v2U5v04AL3kwooNbr6bEyR64weLHcUVxvEWJN8 Yvgw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id u22si6001701edy.599.2020.09.05.09.37.59; Sat, 05 Sep 2020 09:38:24 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728323AbgIEQej (ORCPT + 99 others); Sat, 5 Sep 2020 12:34:39 -0400 Received: from relay9-d.mail.gandi.net ([217.70.183.199]:60635 "EHLO relay9-d.mail.gandi.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726468AbgIEQeb (ORCPT ); Sat, 5 Sep 2020 12:34:31 -0400 X-Originating-IP: 195.189.32.242 Received: from pc.localdomain (unknown [195.189.32.242]) (Authenticated sender: contact@artur-rojek.eu) by relay9-d.mail.gandi.net (Postfix) with ESMTPSA id F3D9AFF804; Sat, 5 Sep 2020 16:34:24 +0000 (UTC) From: Artur Rojek To: Dmitry Torokhov , Rob Herring , Mark Rutland , Jonathan Cameron , Paul Cercueil , Andy Shevchenko Cc: Heiko Stuebner , Ezequiel Garcia , linux-input@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, Artur Rojek , Rob Herring Subject: [PATCH v9 1/2] dt-bindings: input: Add docs for ADC driven joystick. Date: Sat, 5 Sep 2020 18:34:02 +0200 Message-Id: <20200905163403.64390-1-contact@artur-rojek.eu> X-Mailer: git-send-email 2.28.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add documentation for the adc-joystick driver, used to provide support for joysticks connected over ADC. Signed-off-by: Artur Rojek Tested-by: Paul Cercueil Reviewed-by: Rob Herring --- Changes: v6-v9: no change .../bindings/input/adc-joystick.yaml | 121 ++++++++++++++++++ 1 file changed, 121 insertions(+) create mode 100644 Documentation/devicetree/bindings/input/adc-joystick.yaml diff --git a/Documentation/devicetree/bindings/input/adc-joystick.yaml b/Documentation/devicetree/bindings/input/adc-joystick.yaml new file mode 100644 index 000000000000..054406bbd22b --- /dev/null +++ b/Documentation/devicetree/bindings/input/adc-joystick.yaml @@ -0,0 +1,121 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +# Copyright 2019-2020 Artur Rojek +%YAML 1.2 +--- +$id: "http://devicetree.org/schemas/input/adc-joystick.yaml#" +$schema: "http://devicetree.org/meta-schemas/core.yaml#" + +title: ADC attached joystick + +maintainers: + - Artur Rojek + +description: > + Bindings for joystick devices connected to ADC controllers supporting + the Industrial I/O subsystem. + +properties: + compatible: + const: adc-joystick + + io-channels: + minItems: 1 + maxItems: 1024 + description: > + List of phandle and IIO specifier pairs. + Each pair defines one ADC channel to which a joystick axis is connected. + See Documentation/devicetree/bindings/iio/iio-bindings.txt for details. + + '#address-cells': + const: 1 + + '#size-cells': + const: 0 + +required: + - compatible + - io-channels + - '#address-cells' + - '#size-cells' + +additionalProperties: false + +patternProperties: + "^axis@[0-9a-f]+$": + type: object + description: > + Represents a joystick axis bound to the given ADC channel. + For each entry in the io-channels list, one axis subnode with a matching + reg property must be specified. + + properties: + reg: + minimum: 0 + maximum: 1023 + description: Index of an io-channels list entry bound to this axis. + + linux,code: + $ref: /schemas/types.yaml#/definitions/uint32 + description: EV_ABS specific event code generated by the axis. + + abs-range: + allOf: + - $ref: /schemas/types.yaml#/definitions/uint32-array + - items: + - description: minimum value + - description: maximum value + description: > + Minimum and maximum values produced by the axis. + For an ABS_X axis this will be the left-most and right-most + inclination of the joystick. If min > max, it is left to userspace to + treat the axis as inverted. + This property is interpreted as two signed 32 bit values. + + abs-fuzz: + $ref: /schemas/types.yaml#/definitions/uint32 + description: > + Amount of noise in the input value. + Omitting this property indicates the axis is precise. + + abs-flat: + $ref: /schemas/types.yaml#/definitions/uint32 + description: > + Axial "deadzone", or area around the center position, where the axis + is considered to be at rest. + Omitting this property indicates the axis always returns to exactly + the center position. + + required: + - reg + - linux,code + - abs-range + + additionalProperties: false + +examples: + - | + #include + #include + + joystick: adc-joystick { + compatible = "adc-joystick"; + io-channels = <&adc INGENIC_ADC_TOUCH_XP>, + <&adc INGENIC_ADC_TOUCH_YP>; + #address-cells = <1>; + #size-cells = <0>; + + axis@0 { + reg = <0>; + linux,code = ; + abs-range = <3300 0>; + abs-fuzz = <4>; + abs-flat = <200>; + }; + axis@1 { + reg = <1>; + linux,code = ; + abs-range = <0 3300>; + abs-fuzz = <4>; + abs-flat = <200>; + }; + }; -- 2.28.0