Skip to content
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.

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

Add support for MAX31875 #2635

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jemfgeronimo
Copy link

@jemfgeronimo jemfgeronimo commented Oct 27, 2024

PR Description

  • This adds support for the MAX31875 temperature sensor within the MAX31827 driver, along with corresponding device tree bindings.
  • Datasheet: MAX31875
  • Tested on RPI4 with MAX31875EVKIT

PR Type

  • Bug fix (a change that fixes an issue)
  • New feature (a change that adds new functionality)
  • Breaking change (a change that affects other repos or cause CIs to fail)

PR Checklist

  • I have conducted a self-review of my own code changes
  • I have tested the changes on the relevant hardware
  • I have updated the documentation outside this repo accordingly (if there is the case)

@jemfgeronimo jemfgeronimo changed the title Add support for MAX31875 Add support for MAX31875 v2 Oct 27, 2024
@jemfgeronimo jemfgeronimo marked this pull request as ready for review October 27, 2024 09:32
@jemfgeronimo jemfgeronimo changed the title Add support for MAX31875 v2 Add support for MAX31875 Oct 27, 2024
@jemfgeronimo jemfgeronimo mentioned this pull request Oct 28, 2024
6 tasks
@nunojsa
Copy link
Collaborator

nunojsa commented Oct 28, 2024

Why the new PR? Should we close #2600?

@jemfgeronimo
Copy link
Author

Why the new PR? Should we close #2600?

I've created this separate PR that introduces an alternative method to add driver support for the MAX31875. This involves using the existing MAX31827 driver to support the MAX31875.

Copy link
Collaborator

@nunojsa nunojsa left a comment

Choose a reason for hiding this comment

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

I think most of the complexity could go away with a chi_info struture where you have things like different register masks per device. Then accessing it in the code would be for example: st->info->cfg_reg.

Anyways, i think we can support this new device in the existing driver so I'll close the other PR


maintainers:
- Daniel Matyas <daniel.matyas@analog.com>
- John Erasmus Mari Geronimo <johnerasmusmari.geronimo@analog.com>
Copy link
Collaborator

Choose a reason for hiding this comment

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

You should mention this change in the commit message. You'll likely be asked why if we can have a fallback device for this one (one of the devices that the driver already supports). So you should also mention in the commit message why that is not possible.

Also speaking about the commit message, you're only stating the obvious there :). Give a small description of the HW.

Documentation/devicetree/bindings/hwmon/adi,max31827.yaml Outdated Show resolved Hide resolved
Documentation/devicetree/bindings/hwmon/adi,max31827.yaml Outdated Show resolved Hide resolved
drivers/hwmon/max31827.c Show resolved Hide resolved
drivers/hwmon/max31827.c Outdated Show resolved Hide resolved
drivers/hwmon/max31827.c Outdated Show resolved Hide resolved
drivers/hwmon/max31827.c Outdated Show resolved Hide resolved
drivers/hwmon/max31827.c Outdated Show resolved Hide resolved
@jemfgeronimo jemfgeronimo force-pushed the dev/max31875-v2 branch 4 times, most recently from 4b56b21 to 1a82903 Compare November 13, 2024 04:13
@jemfgeronimo
Copy link
Author

V2

  • dt-bindings: reverted enum of adi,fault-q
  • dt-bindings: dropped else branch in adi,fault-q
  • drivers: put error handling of fault queue values before its encoding
  • renamed max31827_chip_info to max31827_hwmon_chip_info
  • add chip_info structure to replace enum chips

@jemfgeronimo jemfgeronimo requested a review from nunojsa November 13, 2024 05:51
Copy link
Collaborator

@nunojsa nunojsa left a comment

Choose a reason for hiding this comment

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

Ok, the chip info structure grew quite a bit but IMHO, it's still better than all the if() else stuff we had before.

Take my inputs and send this upstream.

drivers/hwmon/max31827.c Outdated Show resolved Hide resolved
drivers/hwmon/max31827.c Show resolved Hide resolved
drivers/hwmon/max31827.c Outdated Show resolved Hide resolved
drivers/hwmon/max31827.c Outdated Show resolved Hide resolved
long (*from_16_bit_to_m_dgr)(unsigned int x);
unsigned int (*from_m_dgr_to_16_bit)(long x);
int (*shutdown)(struct max31827_state *st, unsigned int *cnv_rate);
int (*wakeup)(struct max31827_state *st, unsigned int cnv_rate);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Ok, I did not realized at all that this would need so much fields. That said, I think you can make this much better. See some examples below and then see what you can do...

*val = !!uval;
uval = max31827_field_get(st->chip_info->shutdown_mask,
uval);
*val = st->chip_info->is_enabled(uval);
Copy link
Collaborator

Choose a reason for hiding this comment

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

For example... In here, you already have an is_enabled() callback per chip. Hence, just implement it in a different way per chip so that you don't really need config_reg or shutdown_mask per chip_info. Do you see my point? And if the function is pretty much the same for all the variants and you'r worried about code repetition, just implement a core function that accepts a config_reg and a shutdown_mask and build on top of it. Example:

bool __max31827_is_enabled(struct max31827_state *st, unsigned int reg, unsigned int mask)
{
    //core generic implementation
}

// This is the per chip callback
bool maxxxxx_is_enabled(struct max31827_state *st, unsigned int reg, unsigned int mask)
{
    return __max31827_is_enabled(st, MAXXXXX_REG_CFGm MAXXXX_SHUTDOWN_MASK)
}

See the idea? You might be able to reduce the number of fields significantly...

@@ -234,7 +372,7 @@ static int max31827_read(struct device *dev, enum hwmon_sensor_types type,
*/

ret = regmap_update_bits(st->regmap,
MAX31827_CONFIGURATION_REG,
st->chip_info->config_reg,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hmm, I see you still need config_reg in a lot other places but the above point still stands. You could also negate the enable state in proper variant callback (which is the only thing you're doing now in the is_enabled() function which is a bit odd)

Think about it and see if we can reduce the number of fields somehow.

@@ -503,15 +641,19 @@ static int max31827_init_client(struct max31827_state *st,
fwnode = dev_fwnode(dev);

st->enable = true;
res |= MAX31827_DEVICE_ENABLE(1);
res |= st->chip_info->device_enable(1);
Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe an init_client callback per chip (in the same way I explained above) would also reduce things a bit...

…_info

Introduced chip_info structure to replace enum chips

Signed-off-by: John Erasmus Mari Geronimo <johnerasmusmari.geronimo@analog.com>
Add max31875 to dt-bindings of max31827
MAX31875 is low-power I2C temperature sensor similar to MAX31827

Signed-off-by: John Erasmus Mari Geronimo <johnerasmusmari.geronimo@analog.com>
Add support for MAX31875 Low-Power I2C Temperature Sensor in
MAX31827 driver

Signed-off-by: John Erasmus Mari Geronimo <johnerasmusmari.geronimo@analog.com>
@jemfgeronimo
Copy link
Author

V3

  • reduced the fields of the chip_info

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants