iio: magnetometer: add support for Si7210
Subsystems (2)
v2 cover iio: magnetometer: add support for Si7210
This patch series adds support for the Si7210 Hall effect I2C sensor. The driver currently supports the basic functionalities (i.e. making temperature and magnetic field measurements and changing the measurements scale) but I plan to add support for some other features in the future as well (e.g. the digital output interrupt).
---
Hello,
Thanks for the review. In the v2, I implemented all the necessary improvements, the most important ones being the vdd-supply in DT-binding together with a regulator, changing the temperature measurement scale to milli-celsius and removal of the otp_lock. The lock removal could be done since we read the OTP memory in probe only.
Best regards,
Antoni
Changes since v1:
* dt-binding: add vdd-supply
* si7210: reorder includes in alphabetic order
* si7210: add comment for fetch_lock
* si7210: remove otp_lock
* si7210: fetch_measurement: change result type to __be16
* si7210: use guard(mutex) instead of scoped_guard
* si7210: read_raw: use FIELD_GET to get raw temperature value
* si7210: read_raw: return temperature in milli-celsius
* si7210: use regulator for getting the voltage
* si7210: si7210_device_wake: remove unnecessary cast
* si7210: si7210_device_init: use fsleep instead of usleep_range
* si7210: si7210_probe: remove i2c_set_clientdata()
* si7210: minor alignment and formatting fixes
Antoni Pokusinski (2):
dt-bindings: iio: magnetometer: add binding for Si7210
iio: magnetometer: si7210: add driver for Si7210
.../iio/magnetometer/silabs,si7210.yaml | 48 ++ drivers/iio/magnetometer/Kconfig | 11 + drivers/iio/magnetometer/Makefile | 2 + drivers/iio/magnetometer/si7210.c | 428 ++++++++++++++++++ 4 files changed, 489 insertions(+) create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/silabs,si7210.yaml create mode 100644 drivers/iio/magnetometer/si7210.c
Signature · 1 line
2.25.1
PATCH v2 1/2 dt-bindings: iio: magnetometer: add binding for Si7210
Silicon Labs Si7210 is an I2C Hall effect magnetic position and temperature sensor.
--- .../iio/magnetometer/silabs,si7210.yaml | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/silabs,si7210.yaml
Documentation/devicetree/bindings/iio/magnetometer/silabs,si7210.yaml new file +48 -0
@@ -0,0 +1,48 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/magnetometer/silabs,si7210.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Si7210 magnetic position and temperature sensor + +maintainers: + - Antoni Pokusinski <[email protected]> + +description: | + Silabs Si7210 I2C Hall effect magnetic position and temperature sensor. + https://www.silabs.com/documents/public/data-sheets/si7210-datasheet.pdf + +properties: + compatible: + const: silabs,si7210 + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + vdd-supply: + description: Regulator that provides power to the sensor + +required: + - compatible + - reg + +additionalProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/irq.h> + i2c { + #address-cells = <1>; + #size-cells = <0>; + magnetometer@30 { + compatible = "silabs,si7210"; + reg = <0x30>; + interrupt-parent = <&gpio1>; + interrupts = <4 IRQ_TYPE_EDGE_FALLING>; + vdd-supply = <&vdd_3v3_reg>; + }; + };
Signature · 1 line
2.25.1
Re: [PATCH v2 1/2] dt-bindings: iio: magnetometer: add binding for Si7210
Quoted 5 lines · Antoni Pokusinski
Silicon Labs Si7210 is an I2C Hall effect magnetic position and temperature sensor.
Signed-off-by Antoni Pokusinski <[email protected]>---
Best regards,
Krzysztof
PATCH v2 2/2 iio: magnetometer: si7210: add driver for Si7210
In reply to Antoni PokusinskiSilicon Labs Si7210 is an I2C Hall effect magnetic position and temperature sensor. The driver supports the following functionalities:
* reading the temperature measurements
* reading the magnetic field measurements in a single-shot mode
* choosing the magnetic field measurement scale (20 or 200 mT)
--- drivers/iio/magnetometer/Kconfig | 11 + drivers/iio/magnetometer/Makefile | 2 + drivers/iio/magnetometer/si7210.c | 428 ++++++++++++++++++++++++++++++ 3 files changed, 441 insertions(+) create mode 100644 drivers/iio/magnetometer/si7210.c
drivers/iio/magnetometer/Kconfig +11 -0
@@ -235,6 +235,17 @@ config SENSORS_RM3100_SPI To compile this driver as a module, choose M here: the module will be called rm3100-spi. +config SI7210 + tristate "SI7210 Hall effect sensor" + depends on I2C + select REGMAP_I2C + help + Say Y here to add support for the SI7210 Hall effect sensor. + + This driver can also be compiled as a module. + To compile this driver as a module, choose M here: the module + will be called si7210. + config TI_TMAG5273 tristate "TI TMAG5273 Low-Power Linear 3D Hall-Effect Sensor" depends on I2C
drivers/iio/magnetometer/Makefile +2 -0
@@ -31,6 +31,8 @@ obj-$(CONFIG_SENSORS_RM3100) += rm3100-core.o obj-$(CONFIG_SENSORS_RM3100_I2C) += rm3100-i2c.o obj-$(CONFIG_SENSORS_RM3100_SPI) += rm3100-spi.o +obj-$(CONFIG_SI7210) += si7210.o + obj-$(CONFIG_TI_TMAG5273) += tmag5273.o obj-$(CONFIG_YAMAHA_YAS530) += yamaha-yas530.o
drivers/iio/magnetometer/si7210.c new file +428 -0
428 lines not on this page · raw message
Signature · 1 line
2.25.1
kernel test robot
build botRe: [PATCH v2 2/2] iio: magnetometer: si7210: add driver for Si7210
kernel test robot noticed the following build warnings:
Hi Antoni,
kernel test robot noticed the following build warnings:
[auto build test WARNING on jic23-iio/togreg]
[also build test WARNING on linus/master v6.13-rc6 next-20250110] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Antoni-Pokusinski/dt-bindings-iio-magnetometer-add-binding-for-Si7210/20250109-074641 base: https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git togreg patch link: https://lore.kernel.org/r/20250108234411.882768-3-apokusinski01%40gmail.com patch subject: [PATCH v2 2/2] iio: magnetometer: si7210: add driver for Si7210 config: openrisc-randconfig-r123-20250110 (https://download.01.org/0day-ci/archive/20250110/[email protected]/config) compiler: or1k-linux-gcc (GCC) 14.2.0 reproduce: (https://download.01.org/0day-ci/archive/20250110/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
sparse warnings: (new ones prefixed by >>)
>> drivers/iio/magnetometer/si7210.c:169:16: sparse: sparse: cast from restricted __be16 >> drivers/iio/magnetometer/si7210.c:189:24: sparse: sparse: restricted __be16 degrades to integer >> drivers/iio/magnetometer/si7210.c:206:23: sparse: sparse: cast to restricted __be16
drivers/iio/magnetometer/si7210.c:206:23: sparse: sparse: restricted __be16 degrades to integer drivers/iio/magnetometer/si7210.c:206:23: sparse: sparse: restricted __be16 degrades to integer
vim +169 drivers/iio/magnetometer/si7210.c
143
144 static int si7210_fetch_measurement(struct si7210_data *data,
145 struct iio_chan_spec const *chan,
146 __be16 *buf)
147 {
148 u8 dspsigsel = chan->type == IIO_MAGN ? 0 : 1;
149 int ret;
150
151 guard(mutex)(&data->fetch_lock);
152
153 ret = regmap_update_bits(data->regmap, SI7210_REG_DSPSIGSEL,
154 SI7210_MASK_DSPSIGSEL, dspsigsel);
155 if (ret < 0)
156 return ret;
157
158 ret = regmap_update_bits(data->regmap, SI7210_REG_POWER_CTRL,
159 SI7210_MASK_ONEBURST | SI7210_MASK_STOP,
160 SI7210_MASK_ONEBURST & ~SI7210_MASK_STOP);
161 if (ret < 0)
162 return ret;
163
164 /* Read the contents of the registers containing the result: DSPSIGM, DSPSIGL */
165 ret = regmap_bulk_read(data->regmap, SI7210_REG_DSPSIGM, buf, 2);
166 if (ret < 0)
167 return ret;
168
> 169 *buf = cpu_to_be16(*buf);
170
171 return 0;
172 }
173
174 static int si7210_read_raw(struct iio_dev *indio_dev,
175 struct iio_chan_spec const *chan,
176 int *val, int *val2, long mask)
177 {
178 struct si7210_data *data = iio_priv(indio_dev);
179 long long tmp;
180 __be16 dspsig;
181 int ret;
182
183 switch (mask) {
184 case IIO_CHAN_INFO_RAW:
185 ret = si7210_fetch_measurement(data, chan, &dspsig);
186 if (ret < 0)
187 return ret;
188
> 189 *val = dspsig & GENMASK(14, 0);
190 return IIO_VAL_INT;
191 case IIO_CHAN_INFO_SCALE:
192 *val = 0;
193 if (data->curr_scale == 20)
194 *val2 = 1250;
195 else /* data->curr_scale == 200 */
196 *val2 = 12500;
197 return IIO_VAL_INT_PLUS_MICRO;
198 case IIO_CHAN_INFO_OFFSET:
199 *val = -16384;
200 return IIO_VAL_INT;
201 case IIO_CHAN_INFO_PROCESSED:
202 ret = si7210_fetch_measurement(data, chan, &dspsig);
203 if (ret < 0)
204 return ret;
205
> 206 tmp = FIELD_GET(GENMASK(14, 3), dspsig); 207 tmp = (div_s64(-383 * tmp * tmp, 100) + (160940 * tmp - 279800000));
208 tmp = (1 + (data->temp_gain >> 11)) * tmp + 62500 * data->temp_offset;
209
210 ret = regulator_get_voltage(data->vdd);
211 if (ret < 0)
212 return ret;
213
214 tmp -= 222 * div_s64(ret, 1000);
215
216 *val = div_s64(tmp, 1000);
217
218 return IIO_VAL_INT;
219 default:
220 return -EINVAL;
221 }
222 }
223
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
Re: [PATCH v2 2/2] iio: magnetometer: si7210: add driver for Si7210
In reply to Antoni PokusinskiLe 09/01/2025 à 00:44, Antoni Pokusinski a écrit :
Quoted 5 lines
Silicon Labs Si7210 is an I2C Hall effect magnetic position and temperature sensor. The driver supports the following functionalities:
* reading the temperature measurements
* reading the magnetic field measurements in a single-shot mode
* choosing the magnetic field measurement scale (20 or 200 mT)
...
drivers/iio/magnetometer/Makefile obj-$(CONFIG_SENSORS_RM3100) += rm3100-core.o · line 34
Quoted 9 lines
drivers/iio/magnetometer/Makefile +1
-0@@ -31,6 +31,8 @@ obj-$(CONFIG_SENSORS_RM3100) += rm3100-core.o obj-$(CONFIG_SENSORS_RM3100_I2C) += rm3100-i2c.o obj-$(CONFIG_SENSORS_RM3100_SPI) += rm3100-spi.o +obj-$(CONFIG_SI7210) += si7210.o
Maybe add some tabs, to align?
Quoted 4 lines
drivers/iio/magnetometer/Makefile +1
-0+ obj-$(CONFIG_TI_TMAG5273) += tmag5273.o obj-$(CONFIG_YAMAHA_YAS530) += yamaha-yas530.o
...
drivers/iio/magnetometer/Makefile
Quoted 6 lines
drivers/iio/magnetometer/Makefile +6
-0+static int si7210_read_raw(struct iio_dev *indio_dev, + struct iio_chan_spec const *chan, + int *val, int *val2, long mask) +{ + struct si7210_data *data = iio_priv(indio_dev); + long long tmp;
I think that temp is better than tmp
(temperature vs temporary?)
Quoted 18 lines
drivers/iio/magnetometer/Makefile +18
-0+ __be16 dspsig; + int ret; + + switch (mask) { + case IIO_CHAN_INFO_RAW: + ret = si7210_fetch_measurement(data, chan, &dspsig); + if (ret < 0) + return ret; + + *val = dspsig & GENMASK(14, 0); + return IIO_VAL_INT; + case IIO_CHAN_INFO_SCALE: + *val = 0; + if (data->curr_scale == 20) + *val2 = 1250; + else /* data->curr_scale == 200 */ + *val2 = 12500; + return IIO_VAL_INT_PLUS_MICRO;
drivers/iio/magnetometer/Makefile
Quoted 10 lines
drivers/iio/magnetometer/Makefile +10
-0+ case IIO_CHAN_INFO_OFFSET: + *val = -16384; + return IIO_VAL_INT; + case IIO_CHAN_INFO_PROCESSED: + ret = si7210_fetch_measurement(data, chan, &dspsig); + if (ret < 0) + return ret; + + tmp = FIELD_GET(GENMASK(14, 3), dspsig); + tmp = (div_s64(-383 * tmp * tmp, 100) + (160940 * tmp - 279800000));
I would keep 279800000 outside of the (), or even write it to better match the spec:
tmp = div_s64(-383 * tmp * tmp, 100) + 160940 * tmp - 279800000;
Here, tmp seems to be Temperature_raw from the sepc * 10^6
drivers/iio/magnetometer/Makefile
Quoted 1 line
drivers/iio/magnetometer/Makefile +1
-0+ tmp = (1 + (data->temp_gain >> 11)) * tmp + 62500 * data->temp_offset;
/ 2048 instead of >> 11 to match the formula in the sepc?
Would it be clearer to have 62500 written as (1000000 / 32)
Quoted 20 lines
drivers/iio/magnetometer/Makefile +20
-0+ + ret = regulator_get_voltage(data->vdd); + if (ret < 0) + return ret; + + tmp -= 222 * div_s64(ret, 1000); + + *val = div_s64(tmp, 1000); + + return IIO_VAL_INT; + default: + return -EINVAL; + } +} + +static int si7210_set_scale(struct si7210_data *data, unsigned int scale) +{ + s8 *a_otp_values; + int ret; +
drivers/iio/magnetometer/Makefile
Quoted 10 lines
drivers/iio/magnetometer/Makefile +10
-0+ if (scale == 20) + a_otp_values = data->scale_20_a; + else if (scale == 200) + a_otp_values = data->scale_200_a; + else + return -EINVAL; + + guard(mutex)(&data->fetch_lock); + + /* Write the registers 0xCA - 0xCC*/
Missing space before */
drivers/iio/magnetometer/Makefile
Quoted 5 lines
drivers/iio/magnetometer/Makefile +5
-0+ ret = regmap_bulk_write(data->regmap, SI7210_REG_A0, a_otp_values, 3); + if (ret < 0) + return ret; + + /* Write the registers 0xCE - 0xD0*/
Missing space before */
Quoted 8 lines
drivers/iio/magnetometer/Makefile +8
-0+ ret = regmap_bulk_write(data->regmap, SI7210_REG_A3, &a_otp_values[3], 3); + if (ret < 0) + return ret; + + data->curr_scale = scale; + + return 0; +}
...
drivers/iio/magnetometer/Makefile
Quoted 7 lines
drivers/iio/magnetometer/Makefile +7
-0+static int si7210_device_wake(struct si7210_data *data) +{ + /* + * According to the datasheet, the primary method to wake up a + * device is to send an empty write. However this is not feasible + * using current API so we use the other method i.e. read a single + * byte. The device should respond with 0xFF
Nitpick: Missing ending .
drivers/iio/magnetometer/Makefile
Quoted 3 lines
drivers/iio/magnetometer/Makefile +3
-0+ */ + + int ret = 0;
No need to init.
Quoted 10 lines
drivers/iio/magnetometer/Makefile +10
-0+ + ret = i2c_smbus_read_byte(data->client); + if (ret < 0) + return ret; + + if (ret != 0xFF) + return -EIO; + + return 0; +}
...
drivers/iio/magnetometer/Makefile
Quoted 2 lines
drivers/iio/magnetometer/Makefile +2
-0+MODULE_DESCRIPTION("Silicon Labs Si7210 Hall Effect sensor I2C driver"); +MODULE_LICENSE("Dual BSD/GPL");
This is not consistent with the SPDX tag.
CJ
kernel test robot
build botRe: [PATCH v2 2/2] iio: magnetometer: si7210: add driver for Si7210
In reply to Antoni Pokusinskikernel test robot noticed the following build warnings:
Hi Antoni,
kernel test robot noticed the following build warnings:
[auto build test WARNING on jic23-iio/togreg]
[also build test WARNING on linus/master v6.13-rc6 next-20250110] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Antoni-Pokusinski/dt-bindings-iio-magnetometer-add-binding-for-Si7210/20250109-074641 base: https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git togreg patch link: https://lore.kernel.org/r/20250108234411.882768-3-apokusinski01%40gmail.com patch subject: [PATCH v2 2/2] iio: magnetometer: si7210: add driver for Si7210 config: arc-randconfig-r111-20250111 (https://download.01.org/0day-ci/archive/20250111/[email protected]/config) compiler: arc-elf-gcc (GCC) 13.2.0 reproduce: (https://download.01.org/0day-ci/archive/20250111/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
sparse warnings: (new ones prefixed by >>)
>> drivers/iio/magnetometer/si7210.c:169:16: sparse: sparse: incorrect type in argument 1 (different base types) @@ expected unsigned short [usertype] val @@ got restricted __be16 [usertype] @@
drivers/iio/magnetometer/si7210.c:169:16: sparse: expected unsigned short [usertype] val
drivers/iio/magnetometer/si7210.c:169:16: sparse: got restricted __be16 [usertype]
drivers/iio/magnetometer/si7210.c:169:16: sparse: sparse: cast from restricted __be16 drivers/iio/magnetometer/si7210.c:169:16: sparse: sparse: cast from restricted __be16 drivers/iio/magnetometer/si7210.c:189:24: sparse: sparse: restricted __be16 degrades to integer drivers/iio/magnetometer/si7210.c:206:23: sparse: sparse: cast to restricted __be16 drivers/iio/magnetometer/si7210.c:206:23: sparse: sparse: restricted __be16 degrades to integer drivers/iio/magnetometer/si7210.c:206:23: sparse: sparse: restricted __be16 degrades to integer
vim +169 drivers/iio/magnetometer/si7210.c
143
144 static int si7210_fetch_measurement(struct si7210_data *data,
145 struct iio_chan_spec const *chan,
146 __be16 *buf)
147 {
148 u8 dspsigsel = chan->type == IIO_MAGN ? 0 : 1;
149 int ret;
150
151 guard(mutex)(&data->fetch_lock);
152
153 ret = regmap_update_bits(data->regmap, SI7210_REG_DSPSIGSEL,
154 SI7210_MASK_DSPSIGSEL, dspsigsel);
155 if (ret < 0)
156 return ret;
157
158 ret = regmap_update_bits(data->regmap, SI7210_REG_POWER_CTRL,
159 SI7210_MASK_ONEBURST | SI7210_MASK_STOP,
160 SI7210_MASK_ONEBURST & ~SI7210_MASK_STOP);
161 if (ret < 0)
162 return ret;
163
164 /* Read the contents of the registers containing the result: DSPSIGM, DSPSIGL */
165 ret = regmap_bulk_read(data->regmap, SI7210_REG_DSPSIGM, buf, 2);
166 if (ret < 0)
167 return ret;
168
> 169 *buf = cpu_to_be16(*buf);
170
171 return 0;
172 }
173
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki