drivers: sensor: max30101: Enable support for multiple instance

The max30101 sensor driver doesn't support multiple instance.
Update Kconfig and maxim,max30101.yaml for instance based
configuration. Propagate changes over existing files.

Signed-off-by: Logan Saint-Germain <[email protected]>

Author: Sokario

boards/nxp/hexiwear/hexiwear_mk64f12.dts

@@ -1,4 +1,9 @@
-/* SPDX-License-Identifier: Apache-2.0 */
+/*
+ * Copyright (c) 2022, NXP
+ * Copyright (c) 2025, CATIE
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
 
 /dts-v1/;
 
@@ -124,6 +129,7 @@
 		status = "disabled";
 		compatible = "maxim,max30101";
 		reg = <0x57>;
+		acq-mode = "multi-led";
 	};
 };
 

drivers/sensor/maxim/max30101/Kconfig

@@ -1,205 +1,12 @@
 # MAX30101 heart rate sensor
-
+#
 # Copyright (c) 2017, NXP
+# Copyright (c) 2025, CATIE
+#
 # SPDX-License-Identifier: Apache-2.0
 
-menuconfig MAX30101
+config MAX30101
 	bool "MAX30101 Pulse Oximeter and Heart Rate Sensor"
 	default y
 	depends on DT_HAS_MAXIM_MAX30101_ENABLED
-	select I2C
-
-if MAX30101
-
-config MAX30101_SMP_AVE
-	int "Sample averaging"
-	range 0 7
-	default 0
-	help
-	  To reduce the amount of data throughput, adjacent samples (in each
-	  individual channel) can be averaged and decimated on the chip by
-	  setting this register. Set to 0 for no averaging.
-	  0 = 1 sample (no averaging)
-	  1 = 2 samples
-	  2 = 4 samples
-	  3 = 8 samples
-	  4 = 16 samples
-	  5 = 32 samples
-	  6 = 32 samples
-	  7 = 32 samples
-
-config MAX30101_FIFO_ROLLOVER_EN
-	bool "FIFO rolls on full"
-	help
-	  Controls the behavior of the FIFO when the FIFO becomes completely
-	  filled with data. If set, the FIFO address rolls over to zero and the
-	  FIFO continues to fill with new data. If not set, then the FIFO is
-	  not updated until FIFO_DATA is read or the WRITE/READ pointer
-	  positions are changed.
-
-config MAX30101_FIFO_A_FULL
-	int "FIFO almost full value"
-	range 0 15
-	default 0
-	help
-	  Set the trigger for the FIFO_A_FULL interrupt
-
-choice MAX30101_MODE
-	prompt "Mode control"
-	default MAX30101_MULTI_LED_MODE
-
-config MAX30101_HEART_RATE_MODE
-	bool "Heart rate mode"
-	help
-	  Set to operate in heart rate only mode. The red LED channel is
-	  active.
-
-config MAX30101_SPO2_MODE
-	bool "SpO2 mode"
-	help
-	  Set to operate in SpO2 mode. The red and IR LED channels are active.
-
-config MAX30101_MULTI_LED_MODE
-	bool "Multi-LED mode"
-	help
-	  Set to operate in multi-LED mode. The green, red, and/or IR LED
-	  channels are active.
-
-endchoice
-
-config MAX30101_ADC_RGE
-	int "ADC range control"
-	range 0 3
-	default 2
-	help
-	  Set the ADC's full-scale range.
-	  0 = 7.81 pA/LSB
-	  1 = 15.63 pA/LSB
-	  2 = 31.25 pA/LSB
-	  3 = 62.5 pA/LSB
-
-config MAX30101_SR
-	int "ADC sample rate control"
-	range 0 7
-	default 0
-	help
-	  Set the effective sampling rate with one sample consisting of one
-	  pulse/conversion per active LED channel. In SpO2 mode, these means
-	  one IR pulse/conversion and one red pulse/conversion per sample
-	  period.
-	  0 = 50 Hz
-	  1 = 100 Hz
-	  2 = 200 Hz
-	  3 = 400 Hz
-	  4 = 800 Hz
-	  5 = 1000 Hz
-	  6 = 1600 Hz
-	  7 = 3200 Hz
-
-config MAX30101_LED1_PA
-	hex "LED1 (red) pulse amplitude"
-	range 0 0xff
-	default 0xff
-	help
-	  Set the pulse amplitude to control the LED1 (red) current. The actual
-	  measured LED current for each part can vary significantly due to the
-	  trimming methodology.
-	  0x00 = 0.0 mA
-	  0x01 = 0.2 mA
-	  0x02 = 0.4 mA
-	  0x0f = 3.1 mA
-	  0xff = 50.0 mA
-
-config MAX30101_LED2_PA
-	hex "LED2 (IR) pulse amplitude"
-	range 0 0xff
-	default 0x33
-	help
-	  Set the pulse amplitude to control the LED2 (IR) current. The actual
-	  measured LED current for each part can vary significantly due to the
-	  trimming methodology.
-	  0x00 = 0.0 mA
-	  0x01 = 0.2 mA
-	  0x02 = 0.4 mA
-	  0x0f = 3.1 mA
-	  0xff = 50.0 mA
-
-config MAX30101_LED3_PA
-	hex "LED3 (green) pulse amplitude"
-	range 0 0xff
-	default 0xff
-	help
-	  Set the pulse amplitude to control the LED3 (green) current. The
-	  actual measured LED current for each part can vary significantly due
-	  to the trimming methodology.
-	  0x00 = 0.0 mA
-	  0x01 = 0.2 mA
-	  0x02 = 0.4 mA
-	  0x0f = 3.1 mA
-	  0xff = 50.0 mA
-
-if MAX30101_MULTI_LED_MODE
-
-config MAX30101_SLOT1
-	int "Slot 1"
-	range 0 7
-	default 3
-	help
-	  Set which LED and pulse amplitude are active in time slot 1.
-	  0: None (disabled)
-	  1: LED1 (red), LED1_PA
-	  2: LED2 (IR), LED2_PA
-	  3: LED3 (green), LED3_PA
-	  4: None (disabled)
-	  5: LED1 (red), PILOT_PA
-	  6: LED2 (IR), PILOT_PA
-	  7: LED3 (green), PILOT_PA
-
-config MAX30101_SLOT2
-	int "Slot 2"
-	range 0 7
-	default 0
-	help
-	  Set which LED and pulse amplitude are active in time slot 2.
-	  0: None (disabled)
-	  1: LED1 (red), LED1_PA
-	  2: LED2 (IR), LED2_PA
-	  3: LED3 (green), LED3_PA
-	  4: None (disabled)
-	  5: LED1 (red), PILOT_PA
-	  6: LED2 (IR), PILOT_PA
-	  7: LED3 (green), PILOT_PA
-
-config MAX30101_SLOT3
-	int "Slot 3"
-	range 0 7
-	default 0
-	help
-	  Set which LED and pulse amplitude are active in time slot 3.
-	  0: None (disabled)
-	  1: LED1 (red), LED1_PA
-	  2: LED2 (IR), LED2_PA
-	  3: LED3 (green), LED3_PA
-	  4: None (disabled)
-	  5: LED1 (red), PILOT_PA
-	  6: LED2 (IR), PILOT_PA
-	  7: LED3 (green), PILOT_PA
-
-config MAX30101_SLOT4
-	int "Slot 4"
-	range 0 7
-	default 0
-	help
-	  Set which LED and pulse amplitude are active in time slot 4.
-	  0: None (disabled)
-	  1: LED1 (red), LED1_PA
-	  2: LED2 (IR), LED2_PA
-	  3: LED3 (green), LED3_PA
-	  4: None (disabled)
-	  5: LED1 (red), PILOT_PA
-	  6: LED2 (IR), PILOT_PA
-	  7: LED3 (green), PILOT_PA
-
-endif # MAX30101_MULTI_LED_MODE
-
-endif # MAX30101
+	select I2C if $(dt_compat_on_bus,$(DT_COMPAT_MAXIM_MAX30101),i2c)

drivers/sensor/maxim/max30101/max30101.c

@@ -100,7 +100,6 @@ static int max30101_init(const struct device *dev)
 	uint8_t part_id;
 	uint8_t mode_cfg;
 	uint32_t led_chan;
-	int fifo_chan;
 
 	if (!device_is_ready(config->i2c.bus)) {
 		LOG_ERR("Bus device is not ready");
@@ -142,7 +141,7 @@ static int max30101_init(const struct device *dev)
 
 	/* Write the mode configuration register */
 	if (i2c_reg_write_byte_dt(&config->i2c, MAX30101_REG_MODE_CFG,
-				  config->mode)) {
+				  max30101_mode_convert[config->mode])) {
 		return -EIO;
 	}
 
@@ -165,23 +164,24 @@ static int max30101_init(const struct device *dev)
 				  config->led_pa[2])) {
 		return -EIO;
 	}
+	if (i2c_reg_write_byte_dt(&config->i2c, MAX30101_REG_LED4_PA, config->led_pa[2])) {
+		return -EIO;
+	}
 
-#ifdef CONFIG_MAX30101_MULTI_LED_MODE
-	uint8_t multi_led[2];
+	if (!config->mode) {
+		uint8_t multi_led[2];
 
-	/* Write the multi-LED mode control registers */
-	multi_led[0] = (config->slot[1] << 4) | (config->slot[0]);
-	multi_led[1] = (config->slot[3] << 4) | (config->slot[2]);
+		/* Write the multi-LED mode control registers */
+		multi_led[0] = (config->slot[1] << 4) | (config->slot[0]);
+		multi_led[1] = (config->slot[3] << 4) | (config->slot[2]);
 
-	if (i2c_reg_write_byte_dt(&config->i2c, MAX30101_REG_MULTI_LED,
-				  multi_led[0])) {
-		return -EIO;
-	}
-	if (i2c_reg_write_byte_dt(&config->i2c, MAX30101_REG_MULTI_LED + 1,
-				  multi_led[1])) {
-		return -EIO;
+		if (i2c_reg_write_byte_dt(&config->i2c, MAX30101_REG_MULTI_LED, multi_led[0])) {
+			return -EIO;
+		}
+		if (i2c_reg_write_byte_dt(&config->i2c, MAX30101_REG_MULTI_LED + 1, multi_led[1])) {
+			return -EIO;
+		}
 	}
-#endif
 
 	/* Initialize the channel map and active channel count */
 	data->num_channels = 0U;
@@ -192,9 +192,8 @@ static int max30101_init(const struct device *dev)
 	/* Count the number of active channels and build a map that translates
 	 * the LED channel number (red/ir/green) to the fifo channel number.
 	 */
-	for (fifo_chan = 0; fifo_chan < MAX30101_MAX_NUM_CHANNELS;
-	     fifo_chan++) {
-		led_chan = (config->slot[fifo_chan] & MAX30101_SLOT_LED_MASK)-1;
+	for (int fifo_chan = 0; fifo_chan < MAX30101_MAX_NUM_CHANNELS; fifo_chan++) {
+		led_chan = (config->slot[fifo_chan] & MAX30101_SLOT_LED_MASK) - 1;
 		if (led_chan < MAX30101_MAX_NUM_CHANNELS) {
 			data->map[led_chan] = fifo_chan;
 			data->num_channels++;
@@ -204,47 +203,39 @@ static int max30101_init(const struct device *dev)
 	return 0;
 }
 
-static struct max30101_config max30101_config = {
-	.i2c = I2C_DT_SPEC_INST_GET(0),
-	.fifo = (CONFIG_MAX30101_SMP_AVE << MAX30101_FIFO_CFG_SMP_AVE_SHIFT) |
-#ifdef CONFIG_MAX30101_FIFO_ROLLOVER_EN
-		MAX30101_FIFO_CFG_ROLLOVER_EN_MASK |
-#endif
-		(CONFIG_MAX30101_FIFO_A_FULL <<
-		 MAX30101_FIFO_CFG_FIFO_FULL_SHIFT),
-
-#if defined(CONFIG_MAX30101_HEART_RATE_MODE)
-	.mode = MAX30101_MODE_HEART_RATE,
-	.slot[0] = MAX30101_SLOT_RED_LED1_PA,
-	.slot[1] = MAX30101_SLOT_DISABLED,
-	.slot[2] = MAX30101_SLOT_DISABLED,
-	.slot[3] = MAX30101_SLOT_DISABLED,
-#elif defined(CONFIG_MAX30101_SPO2_MODE)
-	.mode = MAX30101_MODE_SPO2,
-	.slot[0] = MAX30101_SLOT_RED_LED1_PA,
-	.slot[1] = MAX30101_SLOT_IR_LED2_PA,
-	.slot[2] = MAX30101_SLOT_DISABLED,
-	.slot[3] = MAX30101_SLOT_DISABLED,
-#else
-	.mode = MAX30101_MODE_MULTI_LED,
-	.slot[0] = CONFIG_MAX30101_SLOT1,
-	.slot[1] = CONFIG_MAX30101_SLOT2,
-	.slot[2] = CONFIG_MAX30101_SLOT3,
-	.slot[3] = CONFIG_MAX30101_SLOT4,
-#endif
-
-	.spo2 = (CONFIG_MAX30101_ADC_RGE << MAX30101_SPO2_ADC_RGE_SHIFT) |
-		(CONFIG_MAX30101_SR << MAX30101_SPO2_SR_SHIFT) |
-		(MAX30101_PW_18BITS << MAX30101_SPO2_PW_SHIFT),
-
-	.led_pa[0] = CONFIG_MAX30101_LED1_PA,
-	.led_pa[1] = CONFIG_MAX30101_LED2_PA,
-	.led_pa[2] = CONFIG_MAX30101_LED3_PA,
-};
-
-static struct max30101_data max30101_data;
-
-SENSOR_DEVICE_DT_INST_DEFINE(0, max30101_init, NULL,
-		    &max30101_data, &max30101_config,
-		    POST_KERNEL, CONFIG_SENSOR_INIT_PRIORITY,
-		    &max30101_driver_api);
+#define MAX30101_CHECK(n)                                                                          \
+	BUILD_ASSERT(DT_INST_PROP_LEN(n, led_pa) == 3,                                             \
+		     "MAX30101 led-pa property must have exactly 3 elements");                     \
+	BUILD_ASSERT(DT_INST_PROP_LEN(n, led_slot) == 4,                                           \
+		     "MAX30101 led-slot property must have exactly 4 elements")
+
+#define MAX30101_SLOT_CFG(n)                                                                       \
+	COND_CODE_1(DT_INST_ENUM_HAS_VALUE(n, acq_mode, heart_rate), \
+		(MAX30101_HR_SLOTS), \
+		(COND_CODE_1(DT_INST_ENUM_HAS_VALUE(n, acq_mode, spo2), \
+			(MAX30101_SPO2_SLOTS), \
+			(MAX30101_MULTI_LED(n)) \
+		)) \
+	)
+
+#define MAX30101_INIT(n)                                                                           \
+	MAX30101_CHECK(n);                                                                         \
+	static const struct max30101_config max30101_config_##n = {                                \
+		.i2c = I2C_DT_SPEC_INST_GET(n),                                                    \
+		.fifo = (DT_INST_ENUM_IDX(n, smp_ave) << MAX30101_FIFO_CFG_SMP_AVE_SHIFT) |        \
+			(DT_INST_PROP(n, fifo_rollover_en)                                         \
+			 << MAX30101_FIFO_CFG_ROLLOVER_EN_SHIFT) |                                 \
+			(DT_INST_PROP(n, fifo_a_full) << MAX30101_FIFO_CFG_FIFO_FULL_SHIFT),       \
+		.mode = DT_INST_ENUM_IDX(n, acq_mode),                                             \
+		.spo2 = (DT_INST_ENUM_IDX(n, adc_rge) << MAX30101_SPO2_ADC_RGE_SHIFT) |            \
+			(DT_INST_ENUM_IDX(n, smp_sr) << MAX30101_SPO2_SR_SHIFT) |                  \
+			(DT_INST_ENUM_IDX(n, led_pw) << MAX30101_SPO2_PW_SHIFT),                   \
+		.led_pa = DT_INST_PROP(n, led_pa),                                                 \
+		.slot = MAX30101_SLOT_CFG(n),                                                      \
+	};                                                                                         \
+	static struct max30101_data max30101_data_##n;                                             \
+	SENSOR_DEVICE_DT_INST_DEFINE(n, max30101_init, NULL, &max30101_data_##n,                   \
+				     &max30101_config_##n, POST_KERNEL,                            \
+				     CONFIG_SENSOR_INIT_PRIORITY, &max30101_driver_api);
+
+DT_INST_FOREACH_STATUS_OKAY(MAX30101_INIT)