1 // SPDX-License-Identifier: GPL-2.0-only
3 * AFE4403 Heart Rate Monitors and Low-Cost Pulse Oximeters
5 * Copyright (C) 2015-2016 Texas Instruments Incorporated - https://www.ti.com/
6 * Andrew F. Davis <afd@ti.com>
9 #include <linux/device.h>
10 #include <linux/err.h>
11 #include <linux/interrupt.h>
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/regmap.h>
15 #include <linux/spi/spi.h>
16 #include <linux/sysfs.h>
17 #include <linux/regulator/consumer.h>
19 #include <linux/iio/iio.h>
20 #include <linux/iio/sysfs.h>
21 #include <linux/iio/buffer.h>
22 #include <linux/iio/trigger.h>
23 #include <linux/iio/triggered_buffer.h>
24 #include <linux/iio/trigger_consumer.h>
26 #include <asm/unaligned.h>
30 #define AFE4403_DRIVER_NAME "afe4403"
32 /* AFE4403 Registers */
33 #define AFE4403_TIAGAIN 0x20
34 #define AFE4403_TIA_AMB_GAIN 0x21
48 static const struct reg_field afe4403_reg_fields[] = {
50 [F_RF_LED1] = REG_FIELD(AFE4403_TIAGAIN, 0, 2),
51 [F_CF_LED1] = REG_FIELD(AFE4403_TIAGAIN, 3, 7),
52 [F_RF_LED] = REG_FIELD(AFE4403_TIA_AMB_GAIN, 0, 2),
53 [F_CF_LED] = REG_FIELD(AFE4403_TIA_AMB_GAIN, 3, 7),
55 [F_ILED1] = REG_FIELD(AFE440X_LEDCNTRL, 0, 7),
56 [F_ILED2] = REG_FIELD(AFE440X_LEDCNTRL, 8, 15),
60 * struct afe4403_data - AFE4403 device instance data
61 * @dev: Device structure
62 * @spi: SPI device handle
63 * @regmap: Register map of the device
64 * @fields: Register fields of the device
65 * @regulator: Pointer to the regulator for the IC
66 * @trig: IIO trigger for this device
67 * @irq: ADC_RDY line interrupt number
68 * @buffer: Used to construct data layout to push into IIO buffer.
72 struct spi_device *spi;
73 struct regmap *regmap;
74 struct regmap_field *fields[F_MAX_FIELDS];
75 struct regulator *regulator;
76 struct iio_trigger *trig;
78 /* Ensure suitable alignment for timestamp */
79 s32 buffer[8] __aligned(8);
82 enum afe4403_chan_id {
91 static const unsigned int afe4403_channel_values[] = {
92 [LED2] = AFE440X_LED2VAL,
93 [ALED2] = AFE440X_ALED2VAL,
94 [LED1] = AFE440X_LED1VAL,
95 [ALED1] = AFE440X_ALED1VAL,
96 [LED2_ALED2] = AFE440X_LED2_ALED2VAL,
97 [LED1_ALED1] = AFE440X_LED1_ALED1VAL,
100 static const unsigned int afe4403_channel_leds[] = {
105 static const struct iio_chan_spec afe4403_channels[] = {
107 AFE440X_INTENSITY_CHAN(LED2, 0),
108 AFE440X_INTENSITY_CHAN(ALED2, 0),
109 AFE440X_INTENSITY_CHAN(LED1, 0),
110 AFE440X_INTENSITY_CHAN(ALED1, 0),
111 AFE440X_INTENSITY_CHAN(LED2_ALED2, 0),
112 AFE440X_INTENSITY_CHAN(LED1_ALED1, 0),
114 AFE440X_CURRENT_CHAN(LED2),
115 AFE440X_CURRENT_CHAN(LED1),
118 static const struct afe440x_val_table afe4403_res_table[] = {
119 { 500000 }, { 250000 }, { 100000 }, { 50000 },
120 { 25000 }, { 10000 }, { 1000000 }, { 0 },
122 AFE440X_TABLE_ATTR(in_intensity_resistance_available, afe4403_res_table);
124 static const struct afe440x_val_table afe4403_cap_table[] = {
125 { 0, 5000 }, { 0, 10000 }, { 0, 20000 }, { 0, 25000 },
126 { 0, 30000 }, { 0, 35000 }, { 0, 45000 }, { 0, 50000 },
127 { 0, 55000 }, { 0, 60000 }, { 0, 70000 }, { 0, 75000 },
128 { 0, 80000 }, { 0, 85000 }, { 0, 95000 }, { 0, 100000 },
129 { 0, 155000 }, { 0, 160000 }, { 0, 170000 }, { 0, 175000 },
130 { 0, 180000 }, { 0, 185000 }, { 0, 195000 }, { 0, 200000 },
131 { 0, 205000 }, { 0, 210000 }, { 0, 220000 }, { 0, 225000 },
132 { 0, 230000 }, { 0, 235000 }, { 0, 245000 }, { 0, 250000 },
134 AFE440X_TABLE_ATTR(in_intensity_capacitance_available, afe4403_cap_table);
136 static ssize_t afe440x_show_register(struct device *dev,
137 struct device_attribute *attr,
140 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
141 struct afe4403_data *afe = iio_priv(indio_dev);
142 struct afe440x_attr *afe440x_attr = to_afe440x_attr(attr);
143 unsigned int reg_val;
147 ret = regmap_field_read(afe->fields[afe440x_attr->field], ®_val);
151 if (reg_val >= afe440x_attr->table_size)
154 vals[0] = afe440x_attr->val_table[reg_val].integer;
155 vals[1] = afe440x_attr->val_table[reg_val].fract;
157 return iio_format_value(buf, IIO_VAL_INT_PLUS_MICRO, 2, vals);
160 static ssize_t afe440x_store_register(struct device *dev,
161 struct device_attribute *attr,
162 const char *buf, size_t count)
164 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
165 struct afe4403_data *afe = iio_priv(indio_dev);
166 struct afe440x_attr *afe440x_attr = to_afe440x_attr(attr);
167 int val, integer, fract, ret;
169 ret = iio_str_to_fixpoint(buf, 100000, &integer, &fract);
173 for (val = 0; val < afe440x_attr->table_size; val++)
174 if (afe440x_attr->val_table[val].integer == integer &&
175 afe440x_attr->val_table[val].fract == fract)
177 if (val == afe440x_attr->table_size)
180 ret = regmap_field_write(afe->fields[afe440x_attr->field], val);
187 static AFE440X_ATTR(in_intensity1_resistance, F_RF_LED, afe4403_res_table);
188 static AFE440X_ATTR(in_intensity1_capacitance, F_CF_LED, afe4403_cap_table);
190 static AFE440X_ATTR(in_intensity2_resistance, F_RF_LED, afe4403_res_table);
191 static AFE440X_ATTR(in_intensity2_capacitance, F_CF_LED, afe4403_cap_table);
193 static AFE440X_ATTR(in_intensity3_resistance, F_RF_LED1, afe4403_res_table);
194 static AFE440X_ATTR(in_intensity3_capacitance, F_CF_LED1, afe4403_cap_table);
196 static AFE440X_ATTR(in_intensity4_resistance, F_RF_LED1, afe4403_res_table);
197 static AFE440X_ATTR(in_intensity4_capacitance, F_CF_LED1, afe4403_cap_table);
199 static struct attribute *afe440x_attributes[] = {
200 &dev_attr_in_intensity_resistance_available.attr,
201 &dev_attr_in_intensity_capacitance_available.attr,
202 &afe440x_attr_in_intensity1_resistance.dev_attr.attr,
203 &afe440x_attr_in_intensity1_capacitance.dev_attr.attr,
204 &afe440x_attr_in_intensity2_resistance.dev_attr.attr,
205 &afe440x_attr_in_intensity2_capacitance.dev_attr.attr,
206 &afe440x_attr_in_intensity3_resistance.dev_attr.attr,
207 &afe440x_attr_in_intensity3_capacitance.dev_attr.attr,
208 &afe440x_attr_in_intensity4_resistance.dev_attr.attr,
209 &afe440x_attr_in_intensity4_capacitance.dev_attr.attr,
213 static const struct attribute_group afe440x_attribute_group = {
214 .attrs = afe440x_attributes
217 static int afe4403_read(struct afe4403_data *afe, unsigned int reg, u32 *val)
219 u8 tx[4] = {AFE440X_CONTROL0, 0x0, 0x0, AFE440X_CONTROL0_READ};
223 /* Enable reading from the device */
224 ret = spi_write_then_read(afe->spi, tx, 4, NULL, 0);
228 ret = spi_write_then_read(afe->spi, ®, 1, rx, sizeof(rx));
232 *val = get_unaligned_be24(&rx[0]);
234 /* Disable reading from the device */
235 tx[3] = AFE440X_CONTROL0_WRITE;
236 ret = spi_write_then_read(afe->spi, tx, 4, NULL, 0);
243 static int afe4403_read_raw(struct iio_dev *indio_dev,
244 struct iio_chan_spec const *chan,
245 int *val, int *val2, long mask)
247 struct afe4403_data *afe = iio_priv(indio_dev);
248 unsigned int reg = afe4403_channel_values[chan->address];
249 unsigned int field = afe4403_channel_leds[chan->address];
252 switch (chan->type) {
255 case IIO_CHAN_INFO_RAW:
256 ret = afe4403_read(afe, reg, val);
264 case IIO_CHAN_INFO_RAW:
265 ret = regmap_field_read(afe->fields[field], val);
269 case IIO_CHAN_INFO_SCALE:
272 return IIO_VAL_INT_PLUS_MICRO;
282 static int afe4403_write_raw(struct iio_dev *indio_dev,
283 struct iio_chan_spec const *chan,
284 int val, int val2, long mask)
286 struct afe4403_data *afe = iio_priv(indio_dev);
287 unsigned int field = afe4403_channel_leds[chan->address];
289 switch (chan->type) {
292 case IIO_CHAN_INFO_RAW:
293 return regmap_field_write(afe->fields[field], val);
303 static const struct iio_info afe4403_iio_info = {
304 .attrs = &afe440x_attribute_group,
305 .read_raw = afe4403_read_raw,
306 .write_raw = afe4403_write_raw,
309 static irqreturn_t afe4403_trigger_handler(int irq, void *private)
311 struct iio_poll_func *pf = private;
312 struct iio_dev *indio_dev = pf->indio_dev;
313 struct afe4403_data *afe = iio_priv(indio_dev);
315 u8 tx[4] = {AFE440X_CONTROL0, 0x0, 0x0, AFE440X_CONTROL0_READ};
318 /* Enable reading from the device */
319 ret = spi_write_then_read(afe->spi, tx, 4, NULL, 0);
323 for_each_set_bit(bit, indio_dev->active_scan_mask,
324 indio_dev->masklength) {
325 ret = spi_write_then_read(afe->spi,
326 &afe4403_channel_values[bit], 1,
331 afe->buffer[i++] = get_unaligned_be24(&rx[0]);
334 /* Disable reading from the device */
335 tx[3] = AFE440X_CONTROL0_WRITE;
336 ret = spi_write_then_read(afe->spi, tx, 4, NULL, 0);
340 iio_push_to_buffers_with_timestamp(indio_dev, afe->buffer,
343 iio_trigger_notify_done(indio_dev->trig);
348 static const struct iio_trigger_ops afe4403_trigger_ops = {
351 #define AFE4403_TIMING_PAIRS \
352 { AFE440X_LED2STC, 0x000050 }, \
353 { AFE440X_LED2ENDC, 0x0003e7 }, \
354 { AFE440X_LED1LEDSTC, 0x0007d0 }, \
355 { AFE440X_LED1LEDENDC, 0x000bb7 }, \
356 { AFE440X_ALED2STC, 0x000438 }, \
357 { AFE440X_ALED2ENDC, 0x0007cf }, \
358 { AFE440X_LED1STC, 0x000820 }, \
359 { AFE440X_LED1ENDC, 0x000bb7 }, \
360 { AFE440X_LED2LEDSTC, 0x000000 }, \
361 { AFE440X_LED2LEDENDC, 0x0003e7 }, \
362 { AFE440X_ALED1STC, 0x000c08 }, \
363 { AFE440X_ALED1ENDC, 0x000f9f }, \
364 { AFE440X_LED2CONVST, 0x0003ef }, \
365 { AFE440X_LED2CONVEND, 0x0007cf }, \
366 { AFE440X_ALED2CONVST, 0x0007d7 }, \
367 { AFE440X_ALED2CONVEND, 0x000bb7 }, \
368 { AFE440X_LED1CONVST, 0x000bbf }, \
369 { AFE440X_LED1CONVEND, 0x009c3f }, \
370 { AFE440X_ALED1CONVST, 0x000fa7 }, \
371 { AFE440X_ALED1CONVEND, 0x001387 }, \
372 { AFE440X_ADCRSTSTCT0, 0x0003e8 }, \
373 { AFE440X_ADCRSTENDCT0, 0x0003eb }, \
374 { AFE440X_ADCRSTSTCT1, 0x0007d0 }, \
375 { AFE440X_ADCRSTENDCT1, 0x0007d3 }, \
376 { AFE440X_ADCRSTSTCT2, 0x000bb8 }, \
377 { AFE440X_ADCRSTENDCT2, 0x000bbb }, \
378 { AFE440X_ADCRSTSTCT3, 0x000fa0 }, \
379 { AFE440X_ADCRSTENDCT3, 0x000fa3 }, \
380 { AFE440X_PRPCOUNT, 0x009c3f }, \
381 { AFE440X_PDNCYCLESTC, 0x001518 }, \
382 { AFE440X_PDNCYCLEENDC, 0x00991f }
384 static const struct reg_sequence afe4403_reg_sequences[] = {
385 AFE4403_TIMING_PAIRS,
386 { AFE440X_CONTROL1, AFE440X_CONTROL1_TIMEREN },
387 { AFE4403_TIAGAIN, AFE440X_TIAGAIN_ENSEPGAIN },
390 static const struct regmap_range afe4403_yes_ranges[] = {
391 regmap_reg_range(AFE440X_LED2VAL, AFE440X_LED1_ALED1VAL),
394 static const struct regmap_access_table afe4403_volatile_table = {
395 .yes_ranges = afe4403_yes_ranges,
396 .n_yes_ranges = ARRAY_SIZE(afe4403_yes_ranges),
399 static const struct regmap_config afe4403_regmap_config = {
403 .max_register = AFE440X_PDNCYCLEENDC,
404 .cache_type = REGCACHE_RBTREE,
405 .volatile_table = &afe4403_volatile_table,
408 static const struct of_device_id afe4403_of_match[] = {
409 { .compatible = "ti,afe4403", },
412 MODULE_DEVICE_TABLE(of, afe4403_of_match);
414 static int __maybe_unused afe4403_suspend(struct device *dev)
416 struct iio_dev *indio_dev = spi_get_drvdata(to_spi_device(dev));
417 struct afe4403_data *afe = iio_priv(indio_dev);
420 ret = regmap_update_bits(afe->regmap, AFE440X_CONTROL2,
421 AFE440X_CONTROL2_PDN_AFE,
422 AFE440X_CONTROL2_PDN_AFE);
426 ret = regulator_disable(afe->regulator);
428 dev_err(dev, "Unable to disable regulator\n");
435 static int __maybe_unused afe4403_resume(struct device *dev)
437 struct iio_dev *indio_dev = spi_get_drvdata(to_spi_device(dev));
438 struct afe4403_data *afe = iio_priv(indio_dev);
441 ret = regulator_enable(afe->regulator);
443 dev_err(dev, "Unable to enable regulator\n");
447 ret = regmap_update_bits(afe->regmap, AFE440X_CONTROL2,
448 AFE440X_CONTROL2_PDN_AFE, 0);
455 static SIMPLE_DEV_PM_OPS(afe4403_pm_ops, afe4403_suspend, afe4403_resume);
457 static int afe4403_probe(struct spi_device *spi)
459 struct iio_dev *indio_dev;
460 struct afe4403_data *afe;
463 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*afe));
467 afe = iio_priv(indio_dev);
468 spi_set_drvdata(spi, indio_dev);
470 afe->dev = &spi->dev;
474 afe->regmap = devm_regmap_init_spi(spi, &afe4403_regmap_config);
475 if (IS_ERR(afe->regmap)) {
476 dev_err(afe->dev, "Unable to allocate register map\n");
477 return PTR_ERR(afe->regmap);
480 for (i = 0; i < F_MAX_FIELDS; i++) {
481 afe->fields[i] = devm_regmap_field_alloc(afe->dev, afe->regmap,
482 afe4403_reg_fields[i]);
483 if (IS_ERR(afe->fields[i])) {
484 dev_err(afe->dev, "Unable to allocate regmap fields\n");
485 return PTR_ERR(afe->fields[i]);
489 afe->regulator = devm_regulator_get(afe->dev, "tx_sup");
490 if (IS_ERR(afe->regulator)) {
491 dev_err(afe->dev, "Unable to get regulator\n");
492 return PTR_ERR(afe->regulator);
494 ret = regulator_enable(afe->regulator);
496 dev_err(afe->dev, "Unable to enable regulator\n");
500 ret = regmap_write(afe->regmap, AFE440X_CONTROL0,
501 AFE440X_CONTROL0_SW_RESET);
503 dev_err(afe->dev, "Unable to reset device\n");
504 goto err_disable_reg;
507 ret = regmap_multi_reg_write(afe->regmap, afe4403_reg_sequences,
508 ARRAY_SIZE(afe4403_reg_sequences));
510 dev_err(afe->dev, "Unable to set register defaults\n");
511 goto err_disable_reg;
514 indio_dev->modes = INDIO_DIRECT_MODE;
515 indio_dev->channels = afe4403_channels;
516 indio_dev->num_channels = ARRAY_SIZE(afe4403_channels);
517 indio_dev->name = AFE4403_DRIVER_NAME;
518 indio_dev->info = &afe4403_iio_info;
521 afe->trig = devm_iio_trigger_alloc(afe->dev,
524 iio_device_id(indio_dev));
526 dev_err(afe->dev, "Unable to allocate IIO trigger\n");
528 goto err_disable_reg;
531 iio_trigger_set_drvdata(afe->trig, indio_dev);
533 afe->trig->ops = &afe4403_trigger_ops;
535 ret = iio_trigger_register(afe->trig);
537 dev_err(afe->dev, "Unable to register IIO trigger\n");
538 goto err_disable_reg;
541 ret = devm_request_threaded_irq(afe->dev, afe->irq,
542 iio_trigger_generic_data_rdy_poll,
547 dev_err(afe->dev, "Unable to request IRQ\n");
552 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
553 afe4403_trigger_handler, NULL);
555 dev_err(afe->dev, "Unable to setup buffer\n");
559 ret = iio_device_register(indio_dev);
561 dev_err(afe->dev, "Unable to register IIO device\n");
568 iio_triggered_buffer_cleanup(indio_dev);
571 iio_trigger_unregister(afe->trig);
573 regulator_disable(afe->regulator);
578 static int afe4403_remove(struct spi_device *spi)
580 struct iio_dev *indio_dev = spi_get_drvdata(spi);
581 struct afe4403_data *afe = iio_priv(indio_dev);
584 iio_device_unregister(indio_dev);
586 iio_triggered_buffer_cleanup(indio_dev);
589 iio_trigger_unregister(afe->trig);
591 ret = regulator_disable(afe->regulator);
593 dev_err(afe->dev, "Unable to disable regulator\n");
600 static const struct spi_device_id afe4403_ids[] = {
604 MODULE_DEVICE_TABLE(spi, afe4403_ids);
606 static struct spi_driver afe4403_spi_driver = {
608 .name = AFE4403_DRIVER_NAME,
609 .of_match_table = afe4403_of_match,
610 .pm = &afe4403_pm_ops,
612 .probe = afe4403_probe,
613 .remove = afe4403_remove,
614 .id_table = afe4403_ids,
616 module_spi_driver(afe4403_spi_driver);
618 MODULE_AUTHOR("Andrew F. Davis <afd@ti.com>");
619 MODULE_DESCRIPTION("TI AFE4403 Heart Rate Monitor and Pulse Oximeter AFE");
620 MODULE_LICENSE("GPL v2");