Received-SPF: pass (google.com: domain of linux-kernel+bounces-194128-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
From: wangshuaijie@awinic.com
To: dmitry.torokhov@gmail.com,
	robh@kernel.org,
	krzk+dt@kernel.org,
	conor+dt@kernel.org,
	jeff@labundy.com,
	linux-input@vger.kernel.org,
	devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org
Cc: wangshuaijie@awinic.com,
	liweilei@awinic.com,
	kangjiajun@awinic.com
Subject: [PATCH V1 1/5] dt-bindings: input: Add YAML to Awinic sar sensor.
Date: Wed, 29 May 2024 13:06:04 +0000
Message-ID: <20240529130608.783624-2-wangshuaijie@awinic.com>
In-Reply-To: <20240529130608.783624-1-wangshuaijie@awinic.com>
References: <20240529130608.783624-1-wangshuaijie@awinic.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

From: shuaijie wang <wangshuaijie@awinic.com>

Add the awinic,aw_sar.yaml file to adapt to the awinic sar sensor driver.

Signed-off-by: shuaijie wang <wangshuaijie@awinic.com>
---
 .../bindings/input/awinic,aw_sar.yaml         | 110 ++++++++++++++++++
 1 file changed, 110 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/awinic,aw_sar.yaml

diff --git a/Documentation/devicetree/bindings/input/awinic,aw_sar.yaml b/Documentation/devicetree/bindings/input/awinic,aw_sar.yaml
new file mode 100644
index 000000000000..ed4ec29c9b4d
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/awinic,aw_sar.yaml
@@ -0,0 +1,110 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/awinic,aw_sar.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Awinic sar sensor driver family
+
+maintainers:
+  - Shuaijie Wang <wangshuaijie@awinic.com>
+
+properties:
+  compatible:
+    enum:
+      - awinic,aw_aw96103
+      - awinic,aw_aw96105
+      - awinic,aw_aw96303
+      - awinic,aw_aw96305
+      - awinic,aw_aw96308
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  sar-num:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      set the index of the sar sensor.
+
+  vcc0-supply:
+    description:
+      Optional regulator for chip, 1.7V-3.6V.
+
+  channel_use_flag:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      The flag of channels used.
+      Configure according to the specific chip channel used.
+      Bit[31:0] Each bit represents a channel.
+      If the customer uses ch0 and ch2, then channel_use_flag=<0x05>
+
+  aw_sar,update_fw:
+    type: boolean
+    description:
+      Choose if you want to update the firmware.
+
+  aw_sar,monitor_esd:
+    type: boolean
+    description:
+      Choose if you want to monitor ESD.
+
+  aw_sar,pin_set_inter_pull-up:
+    type: boolean
+    description:
+      Choose if you want to set the interrupt pin to internal pull-up.
+
+  aw_sar,using_pm_ops:
+    type: boolean
+    description:
+      Choose if you want to use suspend and resume related function.
+
+  aw_sar,use_plug_cail:
+    type: boolean
+    description:
+      Choose If you want to perform calibration when plugging and unplugging the charger.
+
+  start-mode:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      When connecting to aw963xx, select the location where the firmware starts.
+      set 0 if start in rom.
+      set 1 if start in ram
+
+  irq-mux:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      set csx as irq pin. config this field when connect to aw96308/aw96305BFOR
+
+required:
+  - compatible
+  - reg
+  - sar-num
+  - interrupts
+  - channel_use_flag
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        awinic_sar@12 {
+            compatible = "awinic,aw_sar";
+            reg = <0x12>;
+            sar-num = < 0 >;
+            interrupt-parent = < &tlmm >;
+            interrupts = <72 0>;
+            //vcc0-supply = <&pm660l_l4>;
+            channel_use_flag = <0xff>;
+            aw_sar,update_fw;
+            //aw_sar,monitor_esd;
+            start-mode = < 1 >;
+            irq-mux = < 2 >;
+        };
+    };
-- 
2.45.1