general: icm4268x: Refactor ICM42688 driver to ICM4268X

As a first step to enable the similar variants (e.g: ICM42686),
refactor common functionality into icm4268x files. As a result,
applications using the icm42688 will need to have both compatible
properties: "invensense,icm42688" and "invensense,icm4268x" defined.
In-tree boards have been modified to comply with this pattern.

This patch does not contain functional changes. The driver should
work the same as before.

Signed-off-by: Luis Ubieda <luisf@croxel.com>

Author: ubieda

boards/nxp/vmu_rt1170/vmu_rt1170_mimxrt1176_cm7.dts

@@ -250,7 +250,7 @@
 	cs-gpios =<&gpio2 11 GPIO_ACTIVE_LOW>;
 
 	icm42688_0: icm42688p0@0 {
-		compatible = "invensense,icm42688";
+		compatible = "invensense,icm42688", "invensense,icm4268x";
 		reg = <0>;
 		int-gpios = <&gpio3 19 GPIO_ACTIVE_HIGH>;
 		spi-max-frequency = <24000000>;
@@ -272,7 +272,7 @@
 	cs-gpios =<&gpio3 24 GPIO_ACTIVE_LOW>;
 
 	icm42688_1: icm42688p1@0 {
-		compatible = "invensense,icm42688";
+		compatible = "invensense,icm42688", "invensense,icm4268x";
 		reg = <0>;
 		int-gpios = <&gpio2 7 GPIO_ACTIVE_HIGH>;
 		spi-max-frequency = <24000000>;

boards/tdk/robokit1/robokit1-common.dtsi

@@ -101,7 +101,7 @@
 	status = "okay";
 
 	icm42688: icm42688p@0 {
-		compatible = "invensense,icm42688";
+		compatible = "invensense,icm42688", "invensense,icm4268x";
 		reg = <0>;
 		int-gpios = <&pioc 5 GPIO_ACTIVE_HIGH>;
 		spi-max-frequency = <24000000>;

doc/hardware/peripherals/sensor/device_tree.rst

@@ -15,7 +15,7 @@ then be used in a boards devicetree to configure a sensor to its initial state.
        /* SPI bus options here, not shown */
 
        accel_gyro0: icm42688p@0 {
-           compatible = "invensense,icm42688";
+           compatible = "invensense,icm42688", "invensense,icm4268x";
            reg = <0>;
            int-gpios = <&pioc 6 GPIO_ACTIVE_HIGH>; /* SoC specific pin to select for interrupt line */
            spi-max-frequency = <DT_FREQ_M(24)>; /* Maximum SPI bus frequency */

doc/releases/migration-guide-4.2.rst

@@ -312,6 +312,9 @@ Sensors
 
 * Renamed ``CONFIG_NPM1300_CHARGER`` to :kconfig:option:`CONFIG_NPM13XX_CHARGER`
 
+* Nodes with compatible property :dtcompatible:`invensense,icm42688` now additionally need to also
+  include :dtcompatible:`invensense,icm4268x` in order to work.
+
 Serial
 =======
 

drivers/sensor/tdk/CMakeLists.txt

@@ -4,7 +4,7 @@
 # zephyr-keep-sorted-start
 add_subdirectory_ifdef(CONFIG_ICM40627 icm40627)
 add_subdirectory_ifdef(CONFIG_ICM42605 icm42605)
-add_subdirectory_ifdef(CONFIG_ICM42688 icm42688)
+add_subdirectory_ifdef(CONFIG_ICM4268X icm4268x)
 add_subdirectory_ifdef(CONFIG_ICM42X70 icm42x70)
 add_subdirectory_ifdef(CONFIG_ICM45686 icm45686)
 add_subdirectory_ifdef(CONFIG_ICP101XX icp101xx)

drivers/sensor/tdk/Kconfig

@@ -4,7 +4,7 @@
 # zephyr-keep-sorted-start
 source "drivers/sensor/tdk/icm40627/Kconfig"
 source "drivers/sensor/tdk/icm42605/Kconfig"
-source "drivers/sensor/tdk/icm42688/Kconfig"
+source "drivers/sensor/tdk/icm4268x/Kconfig"
 source "drivers/sensor/tdk/icm42x70/Kconfig"
 source "drivers/sensor/tdk/icm45686/Kconfig"
 source "drivers/sensor/tdk/icp101xx/Kconfig"

drivers/sensor/tdk/icm42688/CMakeLists.txt

@@ -0,0 +1,16 @@
+# SPDX-License-Identifier: Apache-2.0
+
+zephyr_library()
+
+zephyr_library_sources(
+    icm4268x.c
+    icm4268x_common.c
+    icm4268x_spi.c
+)
+
+zephyr_library_sources_ifdef(CONFIG_SENSOR_ASYNC_API icm4268x_rtio.c)
+zephyr_library_sources_ifdef(CONFIG_ICM4268X_DECODER icm4268x_decoder.c)
+zephyr_library_sources_ifdef(CONFIG_ICM4268X_STREAM icm4268x_rtio_stream.c)
+zephyr_library_sources_ifdef(CONFIG_ICM4268X_TRIGGER icm4268x_trigger.c)
+zephyr_library_sources_ifdef(CONFIG_EMUL_ICM4268X icm4268x_emul.c)
+zephyr_include_directories_ifdef(CONFIG_EMUL_ICM4268X .)