[PATCH v3 1/2] dt-bindings:iio:proximity: Add hx9023s binding
From: Yasin Lee
Date: Wed May 29 2024 - 00:58:44 EST
From: Yasin Lee <yasin.lee.x@xxxxxxxxx>
A capacitive proximity sensor
Signed-off-by: Yasin Lee <yasin.lee.x@xxxxxxxxx>
---
.../bindings/iio/proximity/tyhx,hx9023s.yaml | 106 ++++++++++++++++++
.../devicetree/bindings/vendor-prefixes.yaml | 2 +
2 files changed, 108 insertions(+)
create mode 100644 Documentation/devicetree/bindings/iio/proximity/tyhx,hx9023s.yaml
diff --git a/Documentation/devicetree/bindings/iio/proximity/tyhx,hx9023s.yaml b/Documentation/devicetree/bindings/iio/proximity/tyhx,hx9023s.yaml
new file mode 100644
index 000000000000..ba4d7343bb30
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/proximity/tyhx,hx9023s.yaml
@@ -0,0 +1,106 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/proximity/tyhx,hx9023s.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TYHX HX9023S capacitive proximity sensor
+
+maintainers:
+ - Yasin Lee <yasin.lee.x@xxxxxxxxx>
+
+description: |
+ TYHX HX9023S proximity sensor
+
+allOf:
+ - $ref: /schemas/iio/iio.yaml#
+
+properties:
+ compatible:
+ const: tyhx,hx9023s
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ description: |
+ Generated by device to announce preceding read request has finished
+ and data is available or that a close/far proximity event has happened.
+ maxItems: 1
+
+ vdd-supply:
+ description: Main power supply
+
+ accuracy:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Accuracy level of the sensor
+
+ channel-used-flag:
+ description: Bit flag indicating which channels are used
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ odr:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Set ODR for all channenls.
+
+ integration-sample:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Set Integration number and Sample number for each channenl.
+
+ osr:
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ description: Set number of OSR for each channenl.
+
+ avg:
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ description: Set number of AVG for each channenl.
+
+ lp-alpha:
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ description: Set lp-alpha for each channenl.
+
+ cs-position:
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ description: |
+ Position of the CS pins.
+ Indicates the corresponding bit for each CS pin in the register.
+
+ channel-positive:
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ description: Positive channel assignments. Use 255 for not connected
+
+ channel-negative:
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ description: |
+ Negative channel assignments. Use 255 for not connected
+
+required:
+ - compatible
+ - reg
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/irq.h>
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ hx9023s@2a {
+ compatible = "tyhx,hx9023s";
+ reg = <0x2a>;
+ interrupt-parent = <&pio>;
+ interrupts = <16 IRQ_TYPE_EDGE_FALLING>;
+ vdd-supply = <&pp1800_prox>;
+ accuracy = <16>;
+ channel-used-flag = <0x1F>;
+ odr = <0x17>;
+ integration-sample = <0x0065>;
+ osr = <0x4 0x4 0x4 0x0 0x0>;
+ avg = <0x3 0x3 0x3 0x0 0x0>;
+ lp-alpha = <0x8 0x8 0x8 0x8 0x2>;
+ cs-position = <0 2 4 6 8>;
+ channel-positive = <0 1 2 3 4>;
+ channel-negative = <255 255 255 255 255>;
+ };
+ };
diff --git a/Documentation/devicetree/bindings/vendor-prefixes.yaml b/Documentation/devicetree/bindings/vendor-prefixes.yaml
index b97d298b3eb6..e2224eea9ab9 100644
--- a/Documentation/devicetree/bindings/vendor-prefixes.yaml
+++ b/Documentation/devicetree/bindings/vendor-prefixes.yaml
@@ -1507,6 +1507,8 @@ patternProperties:
description: Turing Machines, Inc.
"^tyan,.*":
description: Tyan Computer Corporation
+ "^tyhx,.*":
+ description: NanjingTianyihexin Electronics Ltd.
"^u-blox,.*":
description: u-blox
"^u-boot,.*":
--
2.25.1