iio: accel: bma400: add PM_SLEEP support
Subsystems (2)
Dan Robertson
maintainercover iio: accel: bma400: add PM_SLEEP support
The following patch adds support for PM_SLEEP. I also added an attribute for manually setting the power mode similar to what the BMA180 driver provides. Feedback on this would be appreciated.
Cheers,
- Dan
Dan Robertson (1):
iio: accel: bma400: add PM_SLEEP support
drivers/iio/accel/bma400.h | 3 + drivers/iio/accel/bma400_core.c | 132 ++++++++++++++++++++++++-------- drivers/iio/accel/bma400_i2c.c | 1 + drivers/iio/accel/bma400_spi.c | 1 + 4 files changed, 107 insertions(+), 30 deletions(-)
Dan Robertson
maintainerPATCH 1/1 iio: accel: bma400: add PM_SLEEP support
- Add system sleep ops if CONFIG_PM_SLEEP is set.
- Add attribute for setting the power mode of the device.
--- drivers/iio/accel/bma400.h | 3 + drivers/iio/accel/bma400_core.c | 132 ++++++++++++++++++++++++-------- drivers/iio/accel/bma400_i2c.c | 1 + drivers/iio/accel/bma400_spi.c | 1 + 4 files changed, 107 insertions(+), 30 deletions(-)
drivers/iio/accel/bma400.h +3 -0
@@ -10,6 +10,7 @@#define _BMA400_H_#include <linux/bits.h> +#include <linux/pm_runtime.h> #include <linux/regmap.h> /*
@@ -96,4 +97,6 @@ int bma400_probe(struct device *dev, struct regmap *regmap, const char *name);int bma400_remove (struct device *dev); +extern const struct dev_pm_ops bma400_pm_ops; +#endif
drivers/iio/accel/bma400_core.c +102 -30
150 lines not on this page · raw message
drivers/iio/accel/bma400_i2c.c +1 -0
@@ -48,6 +48,7 @@ static struct i2c_driver bma400_i2c_driver = { .driver = { .name = "bma400", .of_match_table = bma400_of_i2c_match, + .pm = &bma400_pm_ops }, .probe = bma400_i2c_probe, .remove = bma400_i2c_remove,
drivers/iio/accel/bma400_spi.c +1 -0
@@ -108,6 +108,7 @@ static struct spi_driver bma400_spi_driver = { .driver = { .name = "bma400", .of_match_table = bma400_of_spi_match, + .pm = &bma400_pm_ops }, .probe = bma400_spi_probe, .remove = bma400_spi_remove,
Quoted 4 lines · Dan Robertson
- Add system sleep ops if
CONFIG_PM_SLEEPis set.
- Add attribute for setting the power mode of the device.
...
drivers/iio/accel/bma400_core.c bma400_accel_get_mount_matrix(const struct iio_dev *indio_dev, · line 179
Quoted 12 lines
drivers/iio/accel/bma400_core.c +0
-9-static const struct iio_chan_spec_ext_info bma400_ext_info[] = { -}; - -#define BMA400_ACC_CHANNEL (_axis) { \ -} - -static const struct iio_chan_spec bma400_channels[] = { -}; -
I'm not sure how this part is related.
...
drivers/iio/accel/bma400_core.c static int bma400_set_power_mode(struct bma400_data *data, · line 518
Quoted 4 lines
drivers/iio/accel/bma400_core.c +4
-0+static const char *const bma400_power_modes[] = { +"sleep" , +"low-power" , +"normal"
Missed comma.
Quoted 1 line
+};
...
Quoted 1 line
+#ifdef
CONFIG_PM_SLEEP
__maybe_unused looks better.
Quoted 4 lines
drivers/iio/accel/bma400_core.c +3
-0+static int bma400_suspend (struct device *dev) +{ +}
drivers/iio/accel/bma400_core.c int bma400_remove(struct device *dev) · line 917
Quoted 10 lines
drivers/iio/accel/bma400_core.c +8
-0+ +static int bma400_resume (struct device *dev) +{ +} +#endif + +const struct dev_pm_ops bma400_pm_ops = { +#ifdef CONFIG_PM_SLEEP
Why?
Quoted 4 lines
drivers/iio/accel/bma400_core.c +4
-0+ SET_SYSTEM_SLEEP_PM_OPS(bma400_suspend, bma400_resume) +#endif +}; +EXPORT_SYMBOL (bma400_pm_ops);
...
Quoted 4 lines
.driver = { .name = "bma400", .of_match_table = bma400_of_i2c_match,+ .pm =
&bma400_pm_ops
Missed comma.
Quoted 1 line
},
...
Quoted 4 lines
.driver = { .name = "bma400", .of_match_table = bma400_of_spi_match,+ .pm =
&bma400_pm_ops
Ditto.
Quoted 1 line
},
Signature · 2 lines
With Best Regards, Andy Shevchenko
Dan Robertson
maintainerQuoted 18 lines · Andy Shevchenko
Quoted 4 lines · Dan Robertson
- Add system sleep ops if
CONFIG_PM_SLEEPis set.
- Add attribute for setting the power mode of the device....
Quoted 9 lines
drivers/iio/accel/bma400_core.c +0
-7-static const struct iio_chan_spec_ext_info bma400_ext_info[] = { -}; - -#define BMA400_ACC_CHANNEL (_axis) { \ -} - -static const struct iio_chan_spec bma400_channels[] = {
Quoted 6 lines
Review
Quoted 2 lines
(quoted diff) +0
-2-}; -I'm not sure how this part is related.
...
Moving things around for the power mode switching endpoint.
Quoted 7 lines
drivers/iio/accel/bma400_core.c static int bma400_set_power_mode(struct bma400_data *data, · line 518
Quoted 4 lines
drivers/iio/accel/bma400_core.c +4
-0+static const char *const bma400_power_modes[] = { +"sleep" , +"low-power" , +"normal" Missed comma.
Quoted 7 lines
Quoted 1 line
+};
...
Quoted 1 line
+#ifdef
CONFIG_PM_SLEEP
__maybe_unusedlooks better.
Good point.
Thanks for the review! I'll address your comments in v2 of the patchset.
Cheers,
- Dan
Jonathan Cameron
maintainerQuoted 3 lines · On Wed, 15 Jul 2020 01:02:26 -0400 Dan Robertson <[email protected]> wrote:
- Add system sleep ops if
CONFIG_PM_SLEEPis set.
- Add attribute for setting the power mode of the device.
This second part is a problem because power modes tend to be extremely device specific. Hence generic userspace is near impossible.
So what we try to do is to map these as much as possible to things that the driver can figure out for itself, such as switching parameters of how things are captured (sampling frequency etc) or runtime pm.
Whilst this may not cover 'all' usecases, it will cover a lot more than implementing a custom attribute.
As a side note, a custom attribute also need Docs
in Documentation/ABI/testing/sysfs-bus-iio-*
Thanks,
Jonathan
Quoted 33 lines
Signed-off-by Dan Robertson <[email protected]>--- drivers/iio/accel/bma400.h | 3 + drivers/iio/accel/bma400_core.c | 132 ++++++++++++++++++++++++-------- drivers/iio/accel/bma400_i2c.c | 1 + drivers/iio/accel/bma400_spi.c | 1 + 4 files changed, 107 insertions(+), 30 deletions(-)drivers/iio/accel/bma400.h +3
-0@@ -10,6 +10,7 @@#define _BMA400_H_#include <linux/bits.h> +#include <linux/pm_runtime.h> #include <linux/regmap.h> /* @@ -96,4 +97,6 @@ int bma400_probe(struct device *dev, struct regmap *regmap, const char *name);int bma400_remove (struct device *dev); +extern const struct dev_pm_ops bma400_pm_ops; +#endif drivers/iio/accel/bma400_core.c +0
-0
drivers/iio/accel/bma400_core.c bma400_accel_get_mount_matrix(const struct iio_dev *indio_dev, · line 153
Quoted 7 lines
drivers/iio/accel/bma400_core.c +0
-4@@ -147,36 +147,6 @@ bma400_accel_get_mount_matrix(const struct iio_dev *indio_dev,return &data->orientation; } -static const struct iio_chan_spec_ext_info bma400_ext_info[] = { -IIO_MOUNT_MATRIX (IIO_SHARED_BY_DIR , bma400_accel_get_mount_matrix), - { } -};
It would be helpful to do this reorganizing as a precursor patch where
nothing functional changes. Then we can see very quickly what is new
in the functional changes.
Quoted 104 lines
drivers/iio/accel/bma400_core.c +67
-26- -#define BMA400_ACC_CHANNEL (_axis) { \ - .type = IIO_ACCEL, \ - .modified = 1, \ - .channel2 = IIO_MOD_##_axis, \ - .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \ - .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \ - BIT(IIO_CHAN_INFO_SCALE) | \ - BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \ - .info_mask_shared_by_type_available = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \ - BIT(IIO_CHAN_INFO_SCALE) | \ - BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \ - .ext_info = bma400_ext_info, \ -} - -static const struct iio_chan_spec bma400_channels[] = { -BMA400_ACC_CHANNEL (X ), -BMA400_ACC_CHANNEL (Y ), -BMA400_ACC_CHANNEL (Z ), - { - .type =IIO_TEMP , - .info_mask_separate =BIT (IIO_CHAN_INFO_PROCESSED ), - .info_mask_shared_by_type =BIT (IIO_CHAN_INFO_SAMP_FREQ ), - }, -}; -static int bma400_get_temp_reg (struct bma400_data *data,int *val,int *val2) {unsigned int raw_temp;@@ -542,6 +512,73 @@ static int bma400_set_power_mode(struct bma400_data *data,return 0 ; } +static const char *const bma400_power_modes[] = { +"sleep" , +"low-power" , +"normal" +}; + +int bma400_power_mode_enum_get (struct iio_dev *dev, +const struct iio_chan_spec *chan) +{ +struct bma400_data *data =iio_priv (dev); + +return data->power_mode; +} + +int bma400_power_mode_enum_set (struct iio_dev *dev, +const struct iio_chan_spec *chan, +unsigned int mode) +{ +struct bma400_data *data =iio_priv (dev); +int ret; + +mutex_lock (&data->mutex); + ret =bma400_set_power_mode (data, mode); +mutex_unlock (&data->mutex); + +return ret; +} + +static const struct iio_enum bma400_power_mode_enum = { + .items = bma400_power_modes, + .num_items =ARRAY_SIZE (bma400_power_modes), + .get = bma400_power_mode_enum_get, + .set = bma400_power_mode_enum_set, +}; + +static const struct iio_chan_spec_ext_info bma400_ext_info[] = { +IIO_ENUM ("power_mode" , true, &bma400_power_mode_enum), +IIO_ENUM_AVAILABLE ("power_mode" , &bma400_power_mode_enum), +IIO_MOUNT_MATRIX (IIO_SHARED_BY_DIR , bma400_accel_get_mount_matrix), + { } +}; + +#define BMA400_ACC_CHANNEL (_axis) { \ + .type = IIO_ACCEL, \ + .modified = 1, \ + .channel2 = IIO_MOD_##_axis, \ + .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \ + .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \ + BIT(IIO_CHAN_INFO_SCALE) | \ + BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \ + .info_mask_shared_by_type_available = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \ + BIT(IIO_CHAN_INFO_SCALE) | \ + BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \ + .ext_info = bma400_ext_info, \ +} + +static const struct iio_chan_spec bma400_channels[] = { +BMA400_ACC_CHANNEL (X ), +BMA400_ACC_CHANNEL (Y ), +BMA400_ACC_CHANNEL (Z ), + { + .type =IIO_TEMP , + .info_mask_separate =BIT (IIO_CHAN_INFO_PROCESSED ), + .info_mask_shared_by_type =BIT (IIO_CHAN_INFO_SAMP_FREQ ), + }, +}; +static void bma400_init_tables (void ) {int raw;
drivers/iio/accel/bma400_core.c int bma400_remove(struct device *dev) · line 888
Quoted 4 lines
drivers/iio/accel/bma400_core.c +1
-0@@ -848,6 +885,41 @@ int bma400_remove(struct device *dev) }EXPORT_SYMBOL (bma400_remove); +#ifdef CONFIG_PM_SLEEP
Ifdef protections around PM functions tend to go wrong so usually better to just mark them __maybe_unused and rely on the linker removing them if they aren't.
Quoted 62 lines
drivers/iio/accel/bma400_core.c +34
-0+static int bma400_suspend (struct device *dev) +{ +struct iio_dev *indio_dev =dev_get_drvdata (dev); +struct bma400_data *data =iio_priv (indio_dev); +int ret; + +mutex_lock (&data->mutex); + ret =bma400_set_power_mode (data,POWER_MODE_SLEEP ); +mutex_unlock (&data->mutex); + +return ret; +} + +static int bma400_resume (struct device *dev) +{ +struct iio_dev *indio_dev =dev_get_drvdata (dev); +struct bma400_data *data =iio_priv (indio_dev); +int ret; + +mutex_lock (&data->mutex); + ret =bma400_set_power_mode (data,POWER_MODE_NORMAL ); +mutex_unlock (&data->mutex); + +return ret; +} +#endif + +const struct dev_pm_ops bma400_pm_ops = { +#ifdef CONFIG_PM_SLEEP + SET_SYSTEM_SLEEP_PM_OPS(bma400_suspend, bma400_resume) +#endif +}; +EXPORT_SYMBOL (bma400_pm_ops); +MODULE_AUTHOR ("Dan Robertson <[email protected]>" );MODULE_DESCRIPTION ("Bosch BMA400 triaxial acceleration sensor core" );MODULE_LICENSE ("GPL" );drivers/iio/accel/bma400_i2c.c +1
-0@@ -48,6 +48,7 @@ static struct i2c_driver bma400_i2c_driver = { .driver = { .name = "bma400", .of_match_table = bma400_of_i2c_match, + .pm = &bma400_pm_ops }, .probe = bma400_i2c_probe, .remove = bma400_i2c_remove,drivers/iio/accel/bma400_spi.c +1
-0@@ -108,6 +108,7 @@ static struct spi_driver bma400_spi_driver = { .driver = { .name = "bma400", .of_match_table = bma400_of_spi_match, + .pm = &bma400_pm_ops }, .probe = bma400_spi_probe, .remove = bma400_spi_remove,
Dan Robertson
maintainerQuoted 10 lines · Jonathan Cameron
Quoted 3 lines · On Wed, 15 Jul 2020 01:02:26 -0400 Dan Robertson <[email protected]> wrote:
- Add system sleep ops if
CONFIG_PM_SLEEPis set.
- Add attribute for setting the power mode of the device.This second part is a problem because power modes tend to be extremely device specific. Hence generic userspace is near impossible.
Quoted 7 lines
So what we try to do is to map these as much as possible to things that the driver can figure out for itself, such as switching parameters of how things are captured (sampling frequency etc) or runtime pm.
Whilst this may not cover 'all' usecases, it will cover a lot more than implementing a custom attribute.
That makes sense. I'll drop this for now and think about it a bit, but I think runtime pm would make sense.
Quoted 45 lines
As a side note, a custom attribute also need Docs
inDocumentation/ABI/testing/sysfs-bus-iio-*Thanks,
Jonathan
Quoted 36 lines
Signed-off-by Dan Robertson <[email protected]>--- drivers/iio/accel/bma400.h | 3 + drivers/iio/accel/bma400_core.c | 132 ++++++++++++++++++++++++-------- drivers/iio/accel/bma400_i2c.c | 1 + drivers/iio/accel/bma400_spi.c | 1 + 4 files changed, 107 insertions(+), 30 deletions(-)drivers/iio/accel/bma400.h +3
-0@@ -10,6 +10,7 @@#define _BMA400_H_#include <linux/bits.h> +#include <linux/pm_runtime.h> #include <linux/regmap.h> /* @@ -96,4 +97,6 @@ int bma400_probe(struct device *dev, struct regmap *regmap, const char *name);int bma400_remove (struct device *dev); +extern const struct dev_pm_ops bma400_pm_ops; +#endif drivers/iio/accel/bma400_core.c +0
-0@@ -147,36 +147,6 @@ bma400_accel_get_mount_matrix(const struct iio_dev *indio_dev,return &data->orientation; }
Quoted 8 lines
drivers/iio/accel/bma400_core.c bma400_accel_get_mount_matrix(const struct iio_dev *indio_dev, · line 153
Quoted 4 lines
drivers/iio/accel/bma400_core.c +0
-4-static const struct iio_chan_spec_ext_info bma400_ext_info[] = { -IIO_MOUNT_MATRIX (IIO_SHARED_BY_DIR , bma400_accel_get_mount_matrix), - { } -};It would be helpful to do this reorganizing as a precursor patch where
nothing functional changes. Then we can see very quickly what is new
in the functional changes.
I'll drop it for now. It isn't needed without the custom attribute.
Quoted 107 lines
Quoted 107 lines
drivers/iio/accel/bma400_core.c +67
-26- -#define BMA400_ACC_CHANNEL (_axis) { \ - .type = IIO_ACCEL, \ - .modified = 1, \ - .channel2 = IIO_MOD_##_axis, \ - .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \ - .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \ - BIT(IIO_CHAN_INFO_SCALE) | \ - BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \ - .info_mask_shared_by_type_available = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \ - BIT(IIO_CHAN_INFO_SCALE) | \ - BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \ - .ext_info = bma400_ext_info, \ -} - -static const struct iio_chan_spec bma400_channels[] = { -BMA400_ACC_CHANNEL (X ), -BMA400_ACC_CHANNEL (Y ), -BMA400_ACC_CHANNEL (Z ), - { - .type =IIO_TEMP , - .info_mask_separate =BIT (IIO_CHAN_INFO_PROCESSED ), - .info_mask_shared_by_type =BIT (IIO_CHAN_INFO_SAMP_FREQ ), - }, -}; -static int bma400_get_temp_reg (struct bma400_data *data,int *val,int *val2) {unsigned int raw_temp;@@ -542,6 +512,73 @@ static int bma400_set_power_mode(struct bma400_data *data,return 0 ; } +static const char *const bma400_power_modes[] = { +"sleep" , +"low-power" , +"normal" +}; + +int bma400_power_mode_enum_get (struct iio_dev *dev, +const struct iio_chan_spec *chan) +{ +struct bma400_data *data =iio_priv (dev); + +return data->power_mode; +} + +int bma400_power_mode_enum_set (struct iio_dev *dev, +const struct iio_chan_spec *chan, +unsigned int mode) +{ +struct bma400_data *data =iio_priv (dev); +int ret; + +mutex_lock (&data->mutex); + ret =bma400_set_power_mode (data, mode); +mutex_unlock (&data->mutex); + +return ret; +} + +static const struct iio_enum bma400_power_mode_enum = { + .items = bma400_power_modes, + .num_items =ARRAY_SIZE (bma400_power_modes), + .get = bma400_power_mode_enum_get, + .set = bma400_power_mode_enum_set, +}; + +static const struct iio_chan_spec_ext_info bma400_ext_info[] = { +IIO_ENUM ("power_mode" , true, &bma400_power_mode_enum), +IIO_ENUM_AVAILABLE ("power_mode" , &bma400_power_mode_enum), +IIO_MOUNT_MATRIX (IIO_SHARED_BY_DIR , bma400_accel_get_mount_matrix), + { } +}; + +#define BMA400_ACC_CHANNEL (_axis) { \ + .type = IIO_ACCEL, \ + .modified = 1, \ + .channel2 = IIO_MOD_##_axis, \ + .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \ + .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \ + BIT(IIO_CHAN_INFO_SCALE) | \ + BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \ + .info_mask_shared_by_type_available = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \ + BIT(IIO_CHAN_INFO_SCALE) | \ + BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \ + .ext_info = bma400_ext_info, \ +} + +static const struct iio_chan_spec bma400_channels[] = { +BMA400_ACC_CHANNEL (X ), +BMA400_ACC_CHANNEL (Y ), +BMA400_ACC_CHANNEL (Z ), + { + .type =IIO_TEMP , + .info_mask_separate =BIT (IIO_CHAN_INFO_PROCESSED ), + .info_mask_shared_by_type =BIT (IIO_CHAN_INFO_SAMP_FREQ ), + }, +}; +static void bma400_init_tables (void ) {int raw;@@ -848,6 +885,41 @@ int bma400_remove(struct device *dev) }EXPORT_SYMBOL (bma400_remove);
Quoted 5 lines
drivers/iio/accel/bma400_core.c int bma400_remove(struct device *dev) · line 888
Quoted 1 line
drivers/iio/accel/bma400_core.c +1
-0+#ifdef CONFIG_PM_SLEEP Ifdef protections around PM functions tend to go wrong so usually better to just mark them
__maybe_unusedand rely on the linker removing them if they aren't.
Sounds good.
Cheers,
- Dan