Skip to content

drivers: tmag5273: Add mag gain correction property #99167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −0
Open

drivers: tmag5273: Add mag gain correction property #99167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions drivers/sensor/ti/tmag5273/tmag5273.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ struct tmag5273_config {
uint8_t temperature_coefficient;
uint8_t angle_magnitude_axis;
uint8_t ch_mag_gain_correction;
uint8_t mag_gain_correction;

uint8_t operation_mode;
uint8_t averaging;
Expand Down Expand Up @@ -1075,6 +1076,13 @@ static inline int tmag5273_init_sensor_settings(const struct tmag5273_config *dr
return -EIO;
}

retval = i2c_reg_write_byte_dt(&drv_cfg->i2c, TMAG5273_REG_MAG_GAIN_CONFIG,
drv_cfg->mag_gain_correction);
if (retval < 0) {
LOG_ERR("error setting MAG_GAIN_CONFIG %d", retval);
return -EIO;
}

return 0;
}

Expand Down Expand Up @@ -1258,6 +1266,7 @@ static DEVICE_API(sensor, tmag5273_driver_api) = {
DT_PROP(DT_INST(inst, compat), temperature_coefficient), \
.angle_magnitude_axis = DT_PROP(DT_INST(inst, compat), angle_magnitude_axis), \
.ch_mag_gain_correction = DT_PROP(DT_INST(inst, compat), ch_mag_gain_correction), \
.mag_gain_correction = DT_PROP(DT_INST(inst, compat), mag_gain_correction), \
.operation_mode = DT_PROP(DT_INST(inst, compat), operation_mode), \
.averaging = DT_PROP(DT_INST(inst, compat), average_mode), \
.trigger_conv_via_int = \
Expand Down
10 changes: 10 additions & 0 deletions dts/bindings/sensor/ti,tmag5273.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,16 @@ properties:

Only active if angle-magnitude-calculation is active.

mag-gain-correction:
type: int
default: 0
Copy link
Member

@MaureenHelm MaureenHelm Nov 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to explain in the description why the default value was selected
https://docs.zephyrproject.org/latest/build/dts/bindings-upstream.html#dt-bindings-default-rules

description: |
Gain value for axis determined by ch-mag-gain-correction.

The value is between 0 and 255, interpreted as a fractional
value between 0 and 1 (mag-gain-correction/256). Gain value of 0
is interpreted as 1.

average-mode:
type: int
default: 1
Expand Down