add ti tmag5273 driver
Subsystems (3)
Gerald Loacker
maintainerv6 cover add ti tmag5273 driver
Hi all,
This patch set adds support for the TI TMAG5273 Low-Power Linear 3D Hall- Effect Sensor. Additionally to temperature and magnetic X, Y and Z-axes the angle and magnitude are reported. The sensor is operating in continuous measurement mode and changes to sleep mode if not used for 5 seconds.
Tests were done on a ROCK3 Model A board using the TMAG5273 evaluation module.
Changes in v6:
- Defined TMAG5273_MAX_REG
- Added comment for wrong device ID
Changes in v5:
- Fixed dev_err_probe
- Removed unnecessary '&' for function pointers
- Removed warning for device tree reading failure as Linux should not validate device tree.
- Added comment for device name
- Added tmag5273_wake_up() and improved comments
- Reformatted pm_ops
Changes in v4:
- Add only struct for IIO_VAL_INT_PLUS_MICRO iio type to iio.h.
- Simplified tmag5273_write_scale()
- Removed unnecessary != 0
- Fixed regmap max_register
- Simplified tmag5273_read_device_property()
- Fixed some line breaks.
Changes in v3:
- Added structs for iio types to iio.h. Using these structs for iio type arrays such as IIO_AVAIL_LIST makes the code more readable than just using (int *). It was suggested by Andy Shevchenko to move these structs to the iio headers to avoid different approaches.
- dt-bindings: dropped quotes from strings
- Added include <linux/bitfield.h>
| Reported-by: kernel test robot <[email protected]>
- Added include <linux/bits.h>
- Removed <asm/unaligned.h>
- Added missing "static const" for tmag5273_avg_table
- Documented Device ID
- Fixed index of tmag5273_scale definition
- Clarify TMAG5273_MAG_CH_EN_X_Y_Z as an index
- Removed unnecessary print
- Introduced tmag5273_write_scale() and tmag5273_write_osr() helper functions
- Use of match_string()
- Format
Changes in v2:
Thanks to Krzysztof, Andy and Jonathan for your detailed review and explanations on the first version. This patch includes all your suggestions and some additional cleanup in the probe function.
Gerald Loacker (3):
iio: add struct declaration for iio types
dt-bindings: iio: magnetometer: add ti tmag5273 documentation file
iio: magnetometer: add ti tmag5273 driver
.../iio/magnetometer/ti,tmag5273.yaml | 75 ++ MAINTAINERS | 7 + drivers/iio/magnetometer/Kconfig | 12 + drivers/iio/magnetometer/Makefile | 2 + drivers/iio/magnetometer/tmag5273.c | 743 ++++++++++++++++++ include/linux/iio/iio.h | 5 + 6 files changed, 844 insertions(+) create mode 100644 .../bindings/iio/magnetometer/ti,tmag5273.yaml create mode 100644 drivers/iio/magnetometer/tmag5273.c
Signature · 1 line
2.37.2
Gerald Loacker
maintainerPATCH v6 1/3 iio: add struct declaration for iio types
Add struct for iio type arrays such as IIO_AVAIL_LIST which can be used instead of int arrays.
---
Changes in v6:
- no changes
Changes in v5:
- no changes
Changes in v4:
- Add only struct for IIO_VAL_INT_PLUS_MICRO iio type.
include/linux/iio/iio.h | 5 +++++ 1 file changed, 5 insertions(+)
include/linux/iio/iio.h +5 -0
@@ -381,6 +381,11 @@ s64 iio_get_time_ns(const struct iio_dev *indio_dev);#define INDIO_MAX_RAW_ELEMENTS 4 +struct iio_val_int_plus_micro { +int integer; +int micro; +}; +struct iio_trigger ;/* forward declaration */ /**
Signature · 1 line
2.37.2
Gerald Loacker
maintainerPATCH v6 2/3 dt-bindings: iio: magnetometer: add ti tmag5273 documentation file
In reply to Gerald LoackerAdd bindings for TI TMAG5273.
---
Changes in v6:
- no changes
Changes in v5:
- no changes
Changes in v4:
- no changes
Changes in v3:
- dropped quotes from strings
Changes in v2:
- Removed nodename
- Changed angle-enable to angle-measurement and used strings
- Added interrupts
- Removed vcc-supply from required properties
- Changed i2c-0 to i2c in examples
.../iio/magnetometer/ti,tmag5273.yaml | 75 +++++++++++++++++++ MAINTAINERS | 6 ++ 2 files changed, 81 insertions(+) create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ti,tmag5273.yaml
Documentation/devicetree/bindings/iio/magnetometer/ti,tmag5273.yaml new file +75 -0
@@ -0,0 +1,75 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/magnetometer/ti,tmag5273.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: TI TMAG5273 Low-Power Linear 3D Hall-Effect Sensor + +maintainers: + - Gerald Loacker <[email protected]> + +description: + The TI TMAG5273 is a low-power linear 3D Hall-effect sensor. This device + integrates three independent Hall-effect sensors in the X, Y, and Z axes. + The device has an integrated temperature sensor available. The TMAG5273 + can be configured through the I2C interface to enable any combination of + magnetic axes and temperature measurements. An integrated angle calculation + engine (CORDIC) provides full 360° angular position information for both + on-axis and off-axis angle measurement topologies. The angle calculation is + performed using two user-selected magnetic axes. + +properties: + compatible: + const: ti,tmag5273 + + reg: + maxItems: 1 + + "#io-channel-cells": + const: 1 + + ti,angle-measurement: + $ref: /schemas/types.yaml#/definitions/string + description: + Enables angle measurement in the selected plane. + If not specified, "x-y" will be anables as default. + enum: + - off + - x-y + - y-z + - x-z + + vcc-supply: + description: + A regulator providing 1.7 V to 3.6 V supply voltage on the VCC pin, + typically 3.3 V. + + interrupts: + description: + The low active interrupt can be configured to be fixed width or latched. + Interrupt events can be configured to be generated from magnetic + thresholds or when a conversion is completed. + maxItems: 1 + +required: + - compatible + - reg + +additionalProperties: false + +examples: + - | + i2c { + #address-cells = <1>; + #size-cells = <0>; + + magnetometer@35 { + compatible = "ti,tmag5273"; + reg = <0x35>; + #io-channel-cells = <1>; + ti,angle-measurement = "x-z"; + vcc-supply = <&vcc3v3>; + }; + }; +...
MAINTAINERS +6 -0
@@ -20613,6 +20613,12 @@ L: [email protected] (moderated for non-subscribers) S: Odd Fixes F: sound/soc/codecs/tas571x* +TI TMAG5273 MAGNETOMETER DRIVER +M: Gerald Loacker <[email protected]> +L: [email protected] +S: Maintained +F: Documentation/devicetree/bindings/iio/magnetometer/ti,tmag5273.yaml + TI TRF7970A NFC DRIVER M: Mark Greer <[email protected]> L: [email protected]
Signature · 1 line
2.37.2
Gerald Loacker
maintainerPATCH v6 3/3 iio: magnetometer: add ti tmag5273 driver
In reply to Gerald LoackerAdd support for TI TMAG5273 Low-Power Linear 3D Hall-Effect Sensor. Additionally to temperature and magnetic X, Y and Z-axes the angle and magnitude are reported.
The sensor is operating in continuous measurement mode and changes to sleep mode if not used for 5 seconds.
Datasheet: https://www.ti.com/lit/gpn/tmag5273
---
Changes in v6:
- Defined TMAG5273_MAX_REG
- Added comment for unknown device ID
Changes in v5:
- Fixed dev_err_probe
- Removed unnecessary '&' for function pointers
- Removed warning for device tree reading failure as Linux should not validate device tree.
- Added comment for device name
- Added tmag5273_wake_up() and improved comments
- Reformatted pm_ops
Changes in v4:
- Renamed struct iio_val_int_plus_micro members
- Simplified tmag5273_write_scale()
- Removed unnecessary != 0
- Fixed regmap max_register
- Simplified tmag5273_read_device_property()
- Fixed some line breaks
Changes in v3:
- Added include <linux/bitfield.h>
| Reported-by: kernel test robot <[email protected]>
- Added include <linux/bits.h>
- Removed <asm/unaligned.h>
- Added missing "static const" for tmag5273_avg_table
- Documented Device ID
- Fixed index of tmag5273_scale definition
- Clarify TMAG5273_MAG_CH_EN_X_Y_Z as an index
- Removed unnecessary print
- Introduced tmag5273_write_scale() and tmag5273_write_osr() helper functions
- Use of match_string()
- Format
Changes in v2:
- Implemented suggestions from review and cleaned up probe function. This results in changes all over the tmag5273.c code.
MAINTAINERS | 1 + drivers/iio/magnetometer/Kconfig | 12 + drivers/iio/magnetometer/Makefile | 2 + drivers/iio/magnetometer/tmag5273.c | 743 ++++++++++++++++++++++++++++ 4 files changed, 758 insertions(+) create mode 100644 drivers/iio/magnetometer/tmag5273.c
MAINTAINERS +1 -0
@@ -20618,6 +20618,7 @@ M: Gerald Loacker <[email protected]> L: [email protected] S: Maintained F: Documentation/devicetree/bindings/iio/magnetometer/ti,tmag5273.yaml +F: drivers/iio/magnetometer/tmag5273.c TI TRF7970A NFC DRIVER M: Mark Greer <[email protected]>
drivers/iio/magnetometer/Kconfig +12 -0
@@ -208,6 +208,18 @@ config SENSORS_RM3100_SPI To compile this driver as a module, choose M here: the module will be called rm3100-spi. +config TI_TMAG5273 + tristate "TI TMAG5273 Low-Power Linear 3D Hall-Effect Sensor" + depends on I2C + select REGMAP_I2C + help + Say Y here to add support for the TI TMAG5273 Low-Power + Linear 3D 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 tmag5273. + config YAMAHA_YAS530 tristate "Yamaha YAS530 family of 3-Axis Magnetometers (I2C)" depends on I2C
drivers/iio/magnetometer/Makefile +2 -0
@@ -29,4 +29,6 @@ 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_TI_TMAG5273) += tmag5273.o + obj-$(CONFIG_YAMAHA_YAS530) += yamaha-yas530.o
drivers/iio/magnetometer/tmag5273.c new file +743 -0
743 lines not on this page · raw message
Signature · 1 line
2.37.2
Jonathan Cameron
maintainerRe: [PATCH v6 3/3] iio: magnetometer: add ti tmag5273 driver
Quoted 10 lines · On Thu, 1 Dec 2022 08:22:20 +0100 Gerald Loacker…
Add support for TI TMAG5273 Low-Power Linear 3D Hall-Effect Sensor. Additionally to temperature and magnetic X, Y and Z-axes the angle and magnitude are reported.
The sensor is operating in continuous measurement mode and changes to sleep mode if not used for 5 seconds.Datasheet: https://www.ti.com/lit/gpn/tmag5273
Signed-off-by Gerald Loacker <[email protected]>Reviewed-by Andy Shevchenko <[email protected]>
drivers/iio/magnetometer/tmag5273.c line 347
Quoted 4 lines
drivers/iio/magnetometer/tmag5273.c new file +4
-0+case IIO_ANGL : +/* +* Angle is in degrees and has four fractional bits, +* therefore use 1/16 * pi/180 to convert to radiants.
typo. radians
I'll fix whilst applying.
Quoted 3 lines
drivers/iio/magnetometer/tmag5273.c new file +2
-0+*/ +}
Jonathan Cameron
maintainerQuoted 9 lines · On Thu, 1 Dec 2022 08:22:17 +0100 Gerald Loacker…
Hi all,
This patch set adds support for the TI TMAG5273 Low-Power Linear 3D Hall- Effect Sensor. Additionally to temperature and magnetic X, Y and Z-axes the angle and magnitude are reported. The sensor is operating in continuous measurement mode and changes to sleep mode if not used for 5 seconds.
Tests were done on a ROCK3 Model A board using the TMAG5273 evaluation module.
Hi Gerald,
Looks good to me (thanks to Andy for his work reviewing!)
Unfortunately timing is such that we are too close to the merge window, so I'm not planning on doing another pull request for this cycle. As such it's the first thing I've queued up for 6.3.
Applied to the togreg branch of iio.git and pushed out as testing for 0-day to take a look at it.
Note I'll probably rebase the tree after rc1 and so it won't push out as togreg (which is meant to be non-rebasing) until after that point.
Thanks,
Jonathan
Quoted 62 lines
Changes in v6:
- DefinedTMAG5273_MAX_REG
- Added comment for wrong device IDChanges in v5:
- Fixeddev_err_probe
- Removed unnecessary '&' for function pointers
- Removed warning for device tree reading failure as Linux should not validate device tree.
- Added comment for device name
- Addedtmag5273_wake_up()and improved comments
- Reformattedpm_opsChanges in v4:
- Add only struct forIIO_VAL_INT_PLUS_MICROiio type toiio.h.
- Simplifiedtmag5273_write_scale()
- Removed unnecessary != 0
- Fixed regmapmax_register
- Simplifiedtmag5273_read_device_property()
- Fixed some line breaks.Changes in v3:
- Added structs for iio types toiio.h. Using these structs for iio type arrays such asIIO_AVAIL_LISTmakes the code more readable than just using (int *). It was suggested by Andy Shevchenko to move these structs to the iio headers to avoid different approaches.
- dt-bindings: dropped quotes from strings
- Added include <linux/bitfield.h>
| Reported-by: kernel test robot <[email protected]>
- Added include <linux/bits.h>
- Removed <asm/unaligned.h>
- Added missing "static const" fortmag5273_avg_table
- Documented Device ID
- Fixed index oftmag5273_scaledefinition
- ClarifyTMAG5273_MAG_CH_EN_X_Y_Zas an index
- Removed unnecessary print
- Introducedtmag5273_write_scale()andtmag5273_write_osr()helper functions
- Use ofmatch_string()
- FormatChanges in v2:
Thanks to Krzysztof, Andy and Jonathan for your detailed review and explanations on the first version. This patch includes all your suggestions and some additional cleanup in the probe function.Gerald Loacker (3):
iio: add struct declaration for iio types
dt-bindings: iio: magnetometer: add ti tmag5273 documentation file
iio: magnetometer: add ti tmag5273 driver.../iio/magnetometer/ti,tmag5273.yaml | 75 ++ MAINTAINERS | 7 + drivers/iio/magnetometer/Kconfig | 12 + drivers/iio/magnetometer/Makefile | 2 + drivers/iio/magnetometer/tmag5273.c | 743 ++++++++++++++++++ include/linux/iio/iio.h | 5 + 6 files changed, 844 insertions(+) create mode 100644 .../bindings/iio/magnetometer/ti,tmag5273.yaml create mode 100644 drivers/iio/magnetometer/tmag5273.c