1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2022 Richtek Technology Corp.
8 #include <linux/bitops.h>
9 #include <linux/delay.h>
10 #include <linux/i2c.h>
11 #include <linux/kernel.h>
12 #include <linux/mod_devicetable.h>
13 #include <linux/module.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/property.h>
16 #include <linux/regmap.h>
17 #include <linux/sysfs.h>
18 #include <linux/types.h>
19 #include <linux/util_macros.h>
21 #include <linux/iio/buffer.h>
22 #include <linux/iio/iio.h>
23 #include <linux/iio/sysfs.h>
24 #include <linux/iio/trigger_consumer.h>
25 #include <linux/iio/triggered_buffer.h>
27 #define RTQ6056_REG_CONFIG 0x00
28 #define RTQ6056_REG_SHUNTVOLT 0x01
29 #define RTQ6056_REG_BUSVOLT 0x02
30 #define RTQ6056_REG_POWER 0x03
31 #define RTQ6056_REG_CURRENT 0x04
32 #define RTQ6056_REG_CALIBRATION 0x05
33 #define RTQ6056_REG_MASKENABLE 0x06
34 #define RTQ6056_REG_ALERTLIMIT 0x07
35 #define RTQ6056_REG_MANUFACTID 0xFE
36 #define RTQ6056_REG_DIEID 0xFF
38 #define RTQ6056_VENDOR_ID 0x1214
39 #define RTQ6056_DEFAULT_CONFIG 0x4127
40 #define RTQ6056_CONT_ALLON 7
43 RTQ6056_CH_VSHUNT = 0,
61 struct regmap *regmap;
62 struct regmap_field *rm_fields[F_MAX_FIELDS];
63 u32 shunt_resistor_uohm;
69 static const struct reg_field rtq6056_reg_fields[F_MAX_FIELDS] = {
70 [F_OPMODE] = REG_FIELD(RTQ6056_REG_CONFIG, 0, 2),
71 [F_VSHUNTCT] = REG_FIELD(RTQ6056_REG_CONFIG, 3, 5),
72 [F_VBUSCT] = REG_FIELD(RTQ6056_REG_CONFIG, 6, 8),
73 [F_AVG] = REG_FIELD(RTQ6056_REG_CONFIG, 9, 11),
74 [F_RESET] = REG_FIELD(RTQ6056_REG_CONFIG, 15, 15),
77 static const struct iio_chan_spec rtq6056_channels[RTQ6056_MAX_CHANNEL + 1] = {
82 .address = RTQ6056_REG_SHUNTVOLT,
83 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
84 BIT(IIO_CHAN_INFO_SCALE) |
85 BIT(IIO_CHAN_INFO_SAMP_FREQ),
86 .info_mask_separate_available = BIT(IIO_CHAN_INFO_SAMP_FREQ),
87 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
88 .info_mask_shared_by_all_available = BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
94 .endianness = IIO_CPU,
101 .address = RTQ6056_REG_BUSVOLT,
102 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
103 BIT(IIO_CHAN_INFO_SCALE) |
104 BIT(IIO_CHAN_INFO_SAMP_FREQ),
105 .info_mask_separate_available = BIT(IIO_CHAN_INFO_SAMP_FREQ),
106 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
107 .info_mask_shared_by_all_available = BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
113 .endianness = IIO_CPU,
120 .address = RTQ6056_REG_POWER,
121 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
122 BIT(IIO_CHAN_INFO_SCALE) |
123 BIT(IIO_CHAN_INFO_SAMP_FREQ),
124 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
125 .info_mask_shared_by_all_available = BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
131 .endianness = IIO_CPU,
138 .address = RTQ6056_REG_CURRENT,
139 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
140 BIT(IIO_CHAN_INFO_SAMP_FREQ),
141 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
142 .info_mask_shared_by_all_available = BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
148 .endianness = IIO_CPU,
151 IIO_CHAN_SOFT_TIMESTAMP(RTQ6056_MAX_CHANNEL),
154 static int rtq6056_adc_read_channel(struct rtq6056_priv *priv,
155 struct iio_chan_spec const *ch,
158 struct device *dev = priv->dev;
159 unsigned int addr = ch->address;
163 pm_runtime_get_sync(dev);
164 ret = regmap_read(priv->regmap, addr, ®val);
165 pm_runtime_mark_last_busy(dev);
170 /* Power and VBUS is unsigned 16-bit, others are signed 16-bit */
171 if (addr == RTQ6056_REG_BUSVOLT || addr == RTQ6056_REG_POWER)
174 *val = sign_extend32(regval, 16);
179 static int rtq6056_adc_read_scale(struct iio_chan_spec const *ch, int *val,
182 switch (ch->address) {
183 case RTQ6056_REG_SHUNTVOLT:
184 /* VSHUNT lsb 2.5uV */
187 return IIO_VAL_FRACTIONAL;
188 case RTQ6056_REG_BUSVOLT:
189 /* VBUS lsb 1.25mV */
192 return IIO_VAL_FRACTIONAL;
193 case RTQ6056_REG_POWER:
203 * Sample frequency for channel VSHUNT and VBUS. The indices correspond
204 * with the bit value expected by the chip. And it can be found at
205 * https://www.richtek.com/assets/product_file/RTQ6056/DSQ6056-00.pdf
207 static const int rtq6056_samp_freq_list[] = {
208 7194, 4926, 3717, 1904, 964, 485, 243, 122,
211 static int rtq6056_adc_set_samp_freq(struct rtq6056_priv *priv,
212 struct iio_chan_spec const *ch, int val)
214 struct regmap_field *rm_field;
215 unsigned int selector;
218 if (val > 7194 || val < 122)
221 if (ch->address == RTQ6056_REG_SHUNTVOLT) {
222 rm_field = priv->rm_fields[F_VSHUNTCT];
223 ct = &priv->vshuntct_us;
224 } else if (ch->address == RTQ6056_REG_BUSVOLT) {
225 rm_field = priv->rm_fields[F_VBUSCT];
226 ct = &priv->vbusct_us;
230 selector = find_closest_descending(val, rtq6056_samp_freq_list,
231 ARRAY_SIZE(rtq6056_samp_freq_list));
233 ret = regmap_field_write(rm_field, selector);
237 *ct = 1000000 / rtq6056_samp_freq_list[selector];
243 * Available averaging rate for rtq6056. The indices correspond with the bit
244 * value expected by the chip. And it can be found at
245 * https://www.richtek.com/assets/product_file/RTQ6056/DSQ6056-00.pdf
247 static const int rtq6056_avg_sample_list[] = {
248 1, 4, 16, 64, 128, 256, 512, 1024,
251 static int rtq6056_adc_set_average(struct rtq6056_priv *priv, int val)
253 unsigned int selector;
256 if (val > 1024 || val < 1)
259 selector = find_closest(val, rtq6056_avg_sample_list,
260 ARRAY_SIZE(rtq6056_avg_sample_list));
262 ret = regmap_field_write(priv->rm_fields[F_AVG], selector);
266 priv->avg_sample = rtq6056_avg_sample_list[selector];
271 static int rtq6056_adc_get_sample_freq(struct rtq6056_priv *priv,
272 struct iio_chan_spec const *ch, int *val)
276 if (ch->address == RTQ6056_REG_SHUNTVOLT)
277 sample_time = priv->vshuntct_us;
278 else if (ch->address == RTQ6056_REG_BUSVOLT)
279 sample_time = priv->vbusct_us;
281 sample_time = priv->vshuntct_us + priv->vbusct_us;
282 sample_time *= priv->avg_sample;
285 *val = 1000000 / sample_time;
290 static int rtq6056_adc_read_raw(struct iio_dev *indio_dev,
291 struct iio_chan_spec const *chan, int *val,
292 int *val2, long mask)
294 struct rtq6056_priv *priv = iio_priv(indio_dev);
297 case IIO_CHAN_INFO_RAW:
298 return rtq6056_adc_read_channel(priv, chan, val);
299 case IIO_CHAN_INFO_SCALE:
300 return rtq6056_adc_read_scale(chan, val, val2);
301 case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
302 *val = priv->avg_sample;
304 case IIO_CHAN_INFO_SAMP_FREQ:
305 return rtq6056_adc_get_sample_freq(priv, chan, val);
311 static int rtq6056_adc_read_avail(struct iio_dev *indio_dev,
312 struct iio_chan_spec const *chan,
313 const int **vals, int *type, int *length,
317 case IIO_CHAN_INFO_SAMP_FREQ:
318 *vals = rtq6056_samp_freq_list;
320 *length = ARRAY_SIZE(rtq6056_samp_freq_list);
321 return IIO_AVAIL_LIST;
322 case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
323 *vals = rtq6056_avg_sample_list;
325 *length = ARRAY_SIZE(rtq6056_avg_sample_list);
326 return IIO_AVAIL_LIST;
332 static int rtq6056_adc_write_raw(struct iio_dev *indio_dev,
333 struct iio_chan_spec const *chan, int val,
336 struct rtq6056_priv *priv = iio_priv(indio_dev);
339 ret = iio_device_claim_direct_mode(indio_dev);
344 case IIO_CHAN_INFO_SAMP_FREQ:
345 ret = rtq6056_adc_set_samp_freq(priv, chan, val);
347 case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
348 ret = rtq6056_adc_set_average(priv, val);
355 iio_device_release_direct_mode(indio_dev);
360 static const char *rtq6056_channel_labels[RTQ6056_MAX_CHANNEL] = {
361 [RTQ6056_CH_VSHUNT] = "Vshunt",
362 [RTQ6056_CH_VBUS] = "Vbus",
363 [RTQ6056_CH_POWER] = "Power",
364 [RTQ6056_CH_CURRENT] = "Current",
367 static int rtq6056_adc_read_label(struct iio_dev *indio_dev,
368 struct iio_chan_spec const *chan,
371 return sysfs_emit(label, "%s\n", rtq6056_channel_labels[chan->channel]);
374 static int rtq6056_set_shunt_resistor(struct rtq6056_priv *priv,
377 unsigned int calib_val;
380 if (resistor_uohm <= 0) {
381 dev_err(priv->dev, "Invalid resistor [%d]\n", resistor_uohm);
385 /* calibration = 5120000 / (Rshunt (uOhm) * current lsb (1mA)) */
386 calib_val = 5120000 / resistor_uohm;
387 ret = regmap_write(priv->regmap, RTQ6056_REG_CALIBRATION, calib_val);
391 priv->shunt_resistor_uohm = resistor_uohm;
396 static ssize_t shunt_resistor_show(struct device *dev,
397 struct device_attribute *attr, char *buf)
399 struct rtq6056_priv *priv = iio_priv(dev_to_iio_dev(dev));
400 int vals[2] = { priv->shunt_resistor_uohm, 1000000 };
402 return iio_format_value(buf, IIO_VAL_FRACTIONAL, 1, vals);
405 static ssize_t shunt_resistor_store(struct device *dev,
406 struct device_attribute *attr,
407 const char *buf, size_t len)
409 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
410 struct rtq6056_priv *priv = iio_priv(indio_dev);
411 int val, val_fract, ret;
413 ret = iio_device_claim_direct_mode(indio_dev);
417 ret = iio_str_to_fixpoint(buf, 100000, &val, &val_fract);
421 ret = rtq6056_set_shunt_resistor(priv, val * 1000000 + val_fract);
424 iio_device_release_direct_mode(indio_dev);
429 static IIO_DEVICE_ATTR_RW(shunt_resistor, 0);
431 static struct attribute *rtq6056_attributes[] = {
432 &iio_dev_attr_shunt_resistor.dev_attr.attr,
436 static const struct attribute_group rtq6056_attribute_group = {
437 .attrs = rtq6056_attributes,
440 static const struct iio_info rtq6056_info = {
441 .attrs = &rtq6056_attribute_group,
442 .read_raw = rtq6056_adc_read_raw,
443 .read_avail = rtq6056_adc_read_avail,
444 .write_raw = rtq6056_adc_write_raw,
445 .read_label = rtq6056_adc_read_label,
448 static irqreturn_t rtq6056_buffer_trigger_handler(int irq, void *p)
450 struct iio_poll_func *pf = p;
451 struct iio_dev *indio_dev = pf->indio_dev;
452 struct rtq6056_priv *priv = iio_priv(indio_dev);
453 struct device *dev = priv->dev;
455 u16 vals[RTQ6056_MAX_CHANNEL];
456 s64 timestamp __aligned(8);
461 memset(&data, 0, sizeof(data));
463 pm_runtime_get_sync(dev);
465 for_each_set_bit(bit, indio_dev->active_scan_mask, indio_dev->masklength) {
466 unsigned int addr = rtq6056_channels[bit].address;
468 ret = regmap_read(priv->regmap, addr, &raw);
472 data.vals[i++] = raw;
475 iio_push_to_buffers_with_timestamp(indio_dev, &data, iio_get_time_ns(indio_dev));
478 pm_runtime_mark_last_busy(dev);
481 iio_trigger_notify_done(indio_dev->trig);
486 static void rtq6056_enter_shutdown_state(void *dev)
488 struct rtq6056_priv *priv = dev_get_drvdata(dev);
490 /* Enter shutdown state */
491 regmap_field_write(priv->rm_fields[F_OPMODE], 0);
494 static bool rtq6056_is_readable_reg(struct device *dev, unsigned int reg)
497 case RTQ6056_REG_CONFIG ... RTQ6056_REG_ALERTLIMIT:
498 case RTQ6056_REG_MANUFACTID ... RTQ6056_REG_DIEID:
505 static bool rtq6056_is_writeable_reg(struct device *dev, unsigned int reg)
508 case RTQ6056_REG_CONFIG:
509 case RTQ6056_REG_CALIBRATION ... RTQ6056_REG_ALERTLIMIT:
516 static const struct regmap_config rtq6056_regmap_config = {
519 .val_format_endian = REGMAP_ENDIAN_BIG,
520 .max_register = RTQ6056_REG_DIEID,
521 .readable_reg = rtq6056_is_readable_reg,
522 .writeable_reg = rtq6056_is_writeable_reg,
525 static int rtq6056_probe(struct i2c_client *i2c)
527 struct iio_dev *indio_dev;
528 struct rtq6056_priv *priv;
529 struct device *dev = &i2c->dev;
530 struct regmap *regmap;
531 unsigned int vendor_id, shunt_resistor_uohm;
534 if (!i2c_check_functionality(i2c->adapter, I2C_FUNC_SMBUS_WORD_DATA))
537 indio_dev = devm_iio_device_alloc(dev, sizeof(*priv));
541 priv = iio_priv(indio_dev);
543 priv->vshuntct_us = priv->vbusct_us = 1037;
544 priv->avg_sample = 1;
545 i2c_set_clientdata(i2c, priv);
547 regmap = devm_regmap_init_i2c(i2c, &rtq6056_regmap_config);
549 return dev_err_probe(dev, PTR_ERR(regmap),
550 "Failed to init regmap\n");
552 priv->regmap = regmap;
554 ret = regmap_read(regmap, RTQ6056_REG_MANUFACTID, &vendor_id);
556 return dev_err_probe(dev, ret,
557 "Failed to get manufacturer info\n");
559 if (vendor_id != RTQ6056_VENDOR_ID)
560 return dev_err_probe(dev, -ENODEV,
561 "Invalid vendor id 0x%04x\n", vendor_id);
563 ret = devm_regmap_field_bulk_alloc(dev, regmap, priv->rm_fields,
564 rtq6056_reg_fields, F_MAX_FIELDS);
566 return dev_err_probe(dev, ret, "Failed to init regmap field\n");
569 * By default, configure average sample as 1, bus and shunt conversion
570 * time as 1037 microsecond, and operating mode to all on.
572 ret = regmap_write(regmap, RTQ6056_REG_CONFIG, RTQ6056_DEFAULT_CONFIG);
574 return dev_err_probe(dev, ret,
575 "Failed to enable continuous sensing\n");
577 ret = devm_add_action_or_reset(dev, rtq6056_enter_shutdown_state, dev);
581 pm_runtime_set_autosuspend_delay(dev, MSEC_PER_SEC);
582 pm_runtime_use_autosuspend(dev);
583 pm_runtime_set_active(dev);
584 pm_runtime_mark_last_busy(dev);
585 ret = devm_pm_runtime_enable(dev);
587 return dev_err_probe(dev, ret, "Failed to enable pm_runtime\n");
589 /* By default, use 2000 micro-Ohm resistor */
590 shunt_resistor_uohm = 2000;
591 device_property_read_u32(dev, "shunt-resistor-micro-ohms",
592 &shunt_resistor_uohm);
594 ret = rtq6056_set_shunt_resistor(priv, shunt_resistor_uohm);
596 return dev_err_probe(dev, ret,
597 "Failed to init shunt resistor\n");
599 indio_dev->name = "rtq6056";
600 indio_dev->modes = INDIO_DIRECT_MODE;
601 indio_dev->channels = rtq6056_channels;
602 indio_dev->num_channels = ARRAY_SIZE(rtq6056_channels);
603 indio_dev->info = &rtq6056_info;
605 ret = devm_iio_triggered_buffer_setup(dev, indio_dev, NULL,
606 rtq6056_buffer_trigger_handler,
609 return dev_err_probe(dev, ret,
610 "Failed to allocate iio trigger buffer\n");
612 return devm_iio_device_register(dev, indio_dev);
615 static int rtq6056_runtime_suspend(struct device *dev)
617 struct rtq6056_priv *priv = dev_get_drvdata(dev);
619 /* Configure to shutdown mode */
620 return regmap_field_write(priv->rm_fields[F_OPMODE], 0);
623 static int rtq6056_runtime_resume(struct device *dev)
625 struct rtq6056_priv *priv = dev_get_drvdata(dev);
626 int sample_rdy_time_us, ret;
628 ret = regmap_field_write(priv->rm_fields[F_OPMODE], RTQ6056_CONT_ALLON);
632 sample_rdy_time_us = priv->vbusct_us + priv->vshuntct_us;
633 sample_rdy_time_us *= priv->avg_sample;
635 usleep_range(sample_rdy_time_us, sample_rdy_time_us + 100);
640 static DEFINE_RUNTIME_DEV_PM_OPS(rtq6056_pm_ops, rtq6056_runtime_suspend,
641 rtq6056_runtime_resume, NULL);
643 static const struct of_device_id rtq6056_device_match[] = {
644 { .compatible = "richtek,rtq6056" },
647 MODULE_DEVICE_TABLE(of, rtq6056_device_match);
649 static struct i2c_driver rtq6056_driver = {
652 .of_match_table = rtq6056_device_match,
653 .pm = pm_ptr(&rtq6056_pm_ops),
655 .probe = rtq6056_probe,
657 module_i2c_driver(rtq6056_driver);
660 MODULE_DESCRIPTION("Richtek RTQ6056 Driver");
661 MODULE_LICENSE("GPL v2");