drivers: sensor: mcux_acmp: update dts binding and adapt driver

Update the devicetree binding for the nxp,kinetis-acmp comparator and
move the binding to dts/bindings/comparator.

The update to the binding includes:
- Remove unused io-channel-cells property
- Remove unused sensor-device include
- Adding missing properties dac config, discrete mode config, and
  input configs.
- Rename properties to exclude redundant vendor prefix since props in
  this binding are not inhereted, and as such, don't need to be
  namespaced.
- Deprecate the old names of the renamed properties

The sensor based device driver has been updated to support both the
deprecated and new property names. This allows it to use both
nxp,enable-sample and filter-enable-sample for example.

Additionally, remove the unused io-channel-cells properties from
in-tree nodes of compatible = "nxp,kinetis-acmp"

Signed-off-by: Bjarki Arge Andreasen <[email protected]>

Author: bjarki-andreasen

drivers/sensor/nxp/mcux_acmp/mcux_acmp.c

@@ -41,6 +41,49 @@ BUILD_ASSERT(kACMP_PortInputFromDAC == 0);
 BUILD_ASSERT(kACMP_PortInputFromMux == 1);
 #endif /* MCUX_ACMP_HAS_INPSEL || MCUX_ACMP_HAS_INNSEL */
 
+/*
+ * prop New property name
+ * depr Deprecated property name
+ */
+#define MCUX_ACMP_DT_INST_PROP(inst, prop, depr)						\
+	COND_CODE_1(										\
+		DT_INST_NODE_HAS_PROP(inst, prop),						\
+		(DT_INST_PROP(inst, prop)),							\
+		(DT_INST_PROP(inst, depr))							\
+	)
+
+/*
+ * prop New property name
+ * depr Deprecated property name
+ */
+#define MCUX_ACMP_DT_INST_PROP_OR(inst, prop, depr, default_value)				\
+	COND_CODE_1(										\
+		DT_INST_NODE_HAS_PROP(inst, prop) || DT_INST_NODE_HAS_PROP(inst, depr),		\
+		(MCUX_ACMP_DT_INST_PROP(inst, prop, depr)),					\
+		(default_value)									\
+	)
+
+#define MCUX_ACMP_DT_INST_ENABLE_SAMPLE(inst) \
+	MCUX_ACMP_DT_INST_PROP(inst, filter_enable_sample, nxp_enable_sample)
+
+#define MCUX_ACMP_DT_INST_FILTER_COUNT(inst) \
+	MCUX_ACMP_DT_INST_PROP_OR(inst, filter_count, nxp_filter_count, 0)
+
+#define MCUX_ACMP_DT_INST_FILTER_PERIOD(inst) \
+	MCUX_ACMP_DT_INST_PROP_OR(inst, filter_period, nxp_filter_period, 0)
+
+#define MCUX_ACMP_DT_INST_HIGH_SPEED(inst) \
+	MCUX_ACMP_DT_INST_PROP(inst, enable_high_speed_mode, nxp_high_speed_mode)
+
+#define MCUX_ACMP_DT_INST_USE_UNFILTERED_MODE(inst) \
+	MCUX_ACMP_DT_INST_PROP(inst, use_unfiltered_output, nxp_use_unfiltered_output)
+
+#define MCUX_ACMP_DT_INST_USE_ENABLE_PIN_OUT(inst) \
+	MCUX_ACMP_DT_INST_PROP(inst, enable_pin_out, nxp_enable_output_pin)
+
+#define MCUX_ACMP_DT_INST_ENABLE_WINDOW_MODE(inst) \
+	MCUX_ACMP_DT_INST_PROP(inst, enable_window_mode, nxp_window_mode)
+
 struct mcux_acmp_config {
 	CMP_Type *base;
 	acmp_filter_config_t filter;
@@ -487,18 +530,18 @@ static const struct sensor_driver_api mcux_acmp_driver_api = {
 	.channel_get = mcux_acmp_channel_get,
 };
 
-#define MCUX_ACMP_DECLARE_CONFIG(n, config_func_init)	\
+#define MCUX_ACMP_DECLARE_CONFIG(n, config_func_init)			\
 static const struct mcux_acmp_config mcux_acmp_config_##n = {		\
 	.base = (CMP_Type *)DT_INST_REG_ADDR(n),			\
 	.filter = {							\
-		.enableSample = DT_INST_PROP(n, nxp_enable_sample),	\
-		.filterCount = DT_INST_PROP_OR(n, nxp_filter_count, 0), \
-		.filterPeriod = DT_INST_PROP_OR(n, nxp_filter_period, 0), \
+		.enableSample = MCUX_ACMP_DT_INST_ENABLE_SAMPLE(n),	\
+		.filterCount = MCUX_ACMP_DT_INST_FILTER_COUNT(n),	\
+		.filterPeriod = MCUX_ACMP_DT_INST_FILTER_PERIOD(n),	\
 	},								\
-	.high_speed = DT_INST_PROP(n, nxp_high_speed_mode),		\
-	.unfiltered = DT_INST_PROP(n, nxp_use_unfiltered_output),	\
-	.output = DT_INST_PROP(n, nxp_enable_output_pin),		\
-	.window = DT_INST_PROP(n, nxp_window_mode),			\
+	.high_speed = MCUX_ACMP_DT_INST_HIGH_SPEED(n),			\
+	.unfiltered = MCUX_ACMP_DT_INST_USE_UNFILTERED_MODE(n),		\
+	.output = MCUX_ACMP_DT_INST_USE_ENABLE_PIN_OUT(n),		\
+	.window = MCUX_ACMP_DT_INST_ENABLE_WINDOW_MODE(n),		\
 	.pincfg = PINCTRL_DT_INST_DEV_CONFIG_GET(n),			\
 	config_func_init						\
 }

dts/arm/nxp/nxp_ke1xf.dtsi

@@ -575,7 +575,6 @@
 			interrupts = <40 0>;
 			clocks = <&scg KINETIS_SCG_BUS_CLK>;
 			status = "disabled";
-			#io-channel-cells = <2>;
 		};
 
 		cmp1: cmp@40074000 {
@@ -584,7 +583,6 @@
 			interrupts = <41 0>;
 			clocks = <&scg KINETIS_SCG_BUS_CLK>;
 			status = "disabled";
-			#io-channel-cells = <2>;
 		};
 
 		cmp2: cmp@40075000 {
@@ -593,7 +591,6 @@
 			interrupts = <70 0>;
 			clocks = <&scg KINETIS_SCG_BUS_CLK>;
 			status = "disabled";
-			#io-channel-cells = <2>;
 		};
 
 		flexio1: flexio@4005a000 {

dts/arm/nxp/nxp_ke1xz.dtsi

@@ -419,7 +419,6 @@
 			interrupts = <16 0>;
 			clocks = <&scg KINETIS_SCG_BUS_CLK>;
 			status = "disabled";
-			#io-channel-cells = <2>;
 		};
 
 		lpspi0: spi@4002c000 {

dts/arm/nxp/nxp_rt118x.dtsi

@@ -300,31 +300,27 @@
 		reg = <0x2dc0000 0x4000>;
 		interrupts = <200 0>;
 		status = "disabled";
-		#io-channel-cells = <2>;
 	};
 
 	acmp2: cmp@2dd0000 {
 		compatible = "nxp,kinetis-acmp";
 		reg = <0x2dd0000 0x4000>;
 		interrupts = <201 0>;
 		status = "disabled";
-		#io-channel-cells = <2>;
 	};
 
 	acmp3: cmp@2de0000 {
 		compatible = "nxp,kinetis-acmp";
 		reg = <0x2de0000 0x4000>;
 		interrupts = <202 0>;
 		status = "disabled";
-		#io-channel-cells = <2>;
 	};
 
 	acmp4: cmp@2df0000 {
 		compatible = "nxp,kinetis-acmp";
 		reg = <0x2df0000 0x4000>;
 		interrupts = <203 0>;
 		status = "disabled";
-		#io-channel-cells = <2>;
 	};
 
 	lpadc1: lpadc@2600000 {

dts/arm/nxp/nxp_rt11xx.dtsi

@@ -1011,31 +1011,27 @@
 			reg = <0x401a4000 0x4000>;
 			interrupts = <157 0>;
 			status = "disabled";
-			#io-channel-cells = <2>;
 		};
 
 		acmp2: cmp@401a8000 {
 			compatible = "nxp,kinetis-acmp";
 			reg = <0x401a8000 0x4000>;
 			interrupts = <158 0>;
 			status = "disabled";
-			#io-channel-cells = <2>;
 		};
 
 		acmp3: cmp@401ac000 {
 			compatible = "nxp,kinetis-acmp";
 			reg = <0x401ac000 0x4000>;
 			interrupts = <159 0>;
 			status = "disabled";
-			#io-channel-cells = <2>;
 		};
 
 		acmp4: cmp@401b0000 {
 			compatible = "nxp,kinetis-acmp";
 			reg = <0x401b0000 0x4000>;
 			interrupts = <160 0>;
 			status = "disabled";
-			#io-channel-cells = <2>;
 		};
 
 		anatop: anatop@40c84000 {

dts/bindings/comparator/nxp,kinetis-acmp.yaml

@@ -0,0 +1,195 @@
+# Copyright (c) 2020 Vestas Wind Systems A/S
+# Copyright (c) 2024 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+description: NXP Kinetis ACMP (Analog CoMParator)
+
+compatible: "nxp,kinetis-acmp"
+
+include:
+  - base.yaml
+  - pinctrl-device.yaml
+
+properties:
+  interrupts:
+    required: true
+
+  reg:
+    required: true
+
+  nxp,enable-output-pin:
+    type: boolean
+    deprecated: true
+    description: Deprecated. Please use enable-pin-out instead
+
+  nxp,use-unfiltered-output:
+    type: boolean
+    deprecated: true
+    description: Deprecated. Please use use-unfiltered-output instead
+
+  nxp,high-speed-mode:
+    type: boolean
+    deprecated: true
+    description: Deprecated. Please use enable-high-speed-mode instead
+
+  nxp,enable-sample:
+    type: boolean
+    deprecated: true
+    description: Deprecated. Please use filter-enable-sample instead
+
+  nxp,filter-count:
+    type: int
+    deprecated: true
+    description: Deprecated. Please use filter-count instead
+
+  nxp,filter-period:
+    type: int
+    deprecated: true
+    description: Deprecated. Please use filter-period instead
+
+  nxp,window-mode:
+    type: boolean
+    deprecated: true
+    description: Deprecated. Please use enable-window-mode instead
+
+  offset-mode:
+    type: string
+    enum:
+      - "LEVEL0"
+      - "LEVEL1"
+
+  hysteresis-mode:
+    type: string
+    enum:
+      - "LEVEL0"
+      - "LEVEL1"
+      - "LEVEL2"
+      - "LEVEL3"
+
+  enable-high-speed-mode:
+    type: boolean
+
+  invert-output:
+    type: boolean
+
+  use-unfiltered-output:
+    type: boolean
+
+  enable-pin-out:
+    type: boolean
+
+  enable-window-mode:
+    type: boolean
+
+  positive-mux-input:
+    type: string
+    enum:
+      - IN0
+      - IN1
+      - IN2
+      - IN3
+      - IN4
+      - IN5
+      - IN6
+      - IN7
+
+  negative-mux-input:
+    type: string
+    enum:
+      - IN0
+      - IN1
+      - IN2
+      - IN3
+      - IN4
+      - IN5
+      - IN6
+      - IN7
+
+  positive-port-input:
+    type: string
+    enum:
+      - DAC
+      - MUX
+
+  negative-port-input:
+    type: string
+    enum:
+      - DAC
+      - MUX
+
+  filter-enable-sample:
+    type: boolean
+
+  filter-count:
+    type: int
+    description: Filter sample count (0 to 7).
+
+  filter-period:
+    type: int
+    description: Filter sample period in bus clock cycles (0 to 255).
+
+  dac-vref-source:
+    type: string
+    enum:
+      - "VIN1"
+      - "VIN2"
+
+  dac-value:
+    type: int
+
+  dac-enable:
+    type: boolean
+
+  dac-enable-high-speed:
+    type: boolean
+
+  discrete-mode-enable-positive-channel:
+    type: boolean
+
+  discrete-mode-enable-negative-channel:
+    type: boolean
+
+  discrete-mode-enable-resistor-divider:
+    type: boolean
+
+  discrete-mode-clock-source:
+    type: string
+    enum:
+      - "SLOW"
+      - "FAST"
+
+  discrete-mode-sample-time:
+    type: string
+    enum:
+      - "T1"
+      - "T2"
+      - "T4"
+      - "T8"
+      - "T16"
+      - "T32"
+      - "T64"
+      - "T256"
+
+  discrete-mode-phase1-time:
+    type: string
+    enum:
+      - "ALT0"
+      - "ALT1"
+      - "ALT2"
+      - "ALT3"
+      - "ALT4"
+      - "ALT5"
+      - "ALT6"
+      - "ALT7"
+
+  discrete-mode-phase2-time:
+    type: string
+    enum:
+      - "ALT0"
+      - "ALT1"
+      - "ALT2"
+      - "ALT3"
+      - "ALT4"
+      - "ALT5"
+      - "ALT6"
+      - "ALT7"