// SPDX-License-Identifier: GPL-2.0-or-later /* * APDS9160 sensor driver. * Chip is combined proximity and ambient light sensor. * Author: 2024 Mikael Gonella-Bolduc <m.gonella.bolduc@gmail.com> #include <linux/bits.h>#include <linux/bitfield.h>#include <linux/cleanup.h>#include <linux/delay.h>#include <linux/err.h>#include <linux/i2c.h>#include <linux/interrupt.h>#include <linux/module.h>#include <linux/mutex.h>#include <linux/regmap.h>#include <linux/regulator/consumer.h>#include <linux/types.h>#include <linux/units.h>#include <linux/iio/iio.h>#include <linux/iio/events.h>#include <linux/iio/sysfs.h>#include <linux/unaligned.h>/* Main control register */ #define APDS9160_REG_CTRL 0x00#define APDS9160_CTRL_SWRESET BIT(4) /* 1: Activate reset */ #define APDS9160_CTRL_MODE_RGB BIT(2) /* 0: ALS & IR, 1: RGB & IR */ #define APDS9160_CTRL_EN_ALS BIT(1) /* 1: ALS active */ #define APDS9160_CTLR_EN_PS BIT(0) /* 1: PS active */ /* Status register */ #define APDS9160_SR_LS_INT BIT(4)#define APDS9160_SR_LS_NEW_DATA BIT(3)#define APDS9160_SR_PS_INT BIT(1)#define APDS9160_SR_PS_NEW_DATA BIT(0)/* Interrupt configuration registers */ #define APDS9160_REG_INT_CFG 0x19#define APDS9160_REG_INT_PST 0x1A#define APDS9160_INT_CFG_EN_LS BIT(2) /* LS int enable */ #define APDS9160_INT_CFG_EN_PS BIT(0) /* PS int enable */ /* Proximity registers */ #define APDS9160_REG_PS_LED 0x01#define APDS9160_REG_PS_PULSES 0x02#define APDS9160_REG_PS_MEAS_RATE 0x03#define APDS9160_REG_PS_THRES_HI_LSB 0x1B#define APDS9160_REG_PS_THRES_HI_MSB 0x1C#define APDS9160_REG_PS_THRES_LO_LSB 0x1D#define APDS9160_REG_PS_THRES_LO_MSB 0x1E#define APDS9160_REG_PS_DATA_LSB 0x08#define APDS9160_REG_PS_DATA_MSB 0x09#define APDS9160_REG_PS_CAN_LEVEL_DIG_LSB 0x1F#define APDS9160_REG_PS_CAN_LEVEL_DIG_MSB 0x20#define APDS9160_REG_PS_CAN_LEVEL_ANA_DUR 0x21#define APDS9160_REG_PS_CAN_LEVEL_ANA_CURRENT 0x22/* Light sensor registers */ #define APDS9160_REG_LS_MEAS_RATE 0x04#define APDS9160_REG_LS_GAIN 0x05#define APDS9160_REG_LS_DATA_CLEAR_LSB 0x0A#define APDS9160_REG_LS_DATA_CLEAR 0x0B#define APDS9160_REG_LS_DATA_CLEAR_MSB 0x0C#define APDS9160_REG_LS_DATA_ALS_LSB 0x0D#define APDS9160_REG_LS_DATA_ALS 0x0E#define APDS9160_REG_LS_DATA_ALS_MSB 0x0F#define APDS9160_REG_LS_THRES_UP_LSB 0x24#define APDS9160_REG_LS_THRES_UP 0x25#define APDS9160_REG_LS_THRES_UP_MSB 0x26#define APDS9160_REG_LS_THRES_LO_LSB 0x27#define APDS9160_REG_LS_THRES_LO 0x28#define APDS9160_REG_LS_THRES_LO_MSB 0x29#define APDS9160_REG_LS_THRES_VAR 0x2A/* Part identification number register */ #define APDS9160_REG_ID 0x06/* Status register */ #define APDS9160_REG_SR 0x07#define APDS9160_SR_DATA_ALS BIT(3)#define APDS9160_SR_DATA_PS BIT(0)/* Supported ID:s */ #define APDS9160_PART_ID_0 0x03#define APDS9160_PS_THRES_MAX 0x7FF#define APDS9160_LS_THRES_MAX 0xFFFFF#define APDS9160_CMD_LS_RESOLUTION_25MS 0x04#define APDS9160_CMD_LS_RESOLUTION_50MS 0x03#define APDS9160_CMD_LS_RESOLUTION_100MS 0x02#define APDS9160_CMD_LS_RESOLUTION_200MS 0x01#define APDS9160_PS_DATA_MASK 0x7FF#define APDS9160_DEFAULT_LS_GAIN 3#define APDS9160_DEFAULT_LS_RATE 100#define APDS9160_DEFAULT_PS_RATE 100#define APDS9160_DEFAULT_PS_CANCELLATION_LEVEL 0#define APDS9160_DEFAULT_PS_ANALOG_CANCELLATION 0#define APDS9160_DEFAULT_PS_GAIN 1#define APDS9160_DEFAULT_PS_CURRENT 100#define APDS9160_DEFAULT_PS_RESOLUTION_11BITS 0x03static const struct reg_default apds9160_reg_defaults[] = {/* Sensors disabled by default */ /* 60 kHz frequency, 100 mA */ /* 8 pulses */ /* 100ms */ /* 100ms */ /* 3x */ /* Interrupts disabled */ static const struct regmap_range apds9160_readable_ranges[] = {static const struct regmap_access_table apds9160_readable_table = {static const struct regmap_range apds9160_writeable_ranges[] = {static const struct regmap_access_table apds9160_writeable_table = {static const struct regmap_range apds9160_volatile_ranges[] = {static const struct regmap_access_table apds9160_volatile_table = {static const struct regmap_config apds9160_regmap_config = {"apds9160_regmap" ,true ,true ,static const struct iio_event_spec apds9160_event_spec[] = {static const struct iio_chan_spec apds9160_channels[] = {/* Proximity sensor channel */ /* Proximity sensor led current */ /* Illuminance */ /* Clear channel */ static const struct iio_chan_spec apds9160_channels_without_events[] = {/* Proximity sensor channel */ /* Proximity sensor led current */ /* Illuminance */ /* Clear channel */ static const int apds9160_als_rate_avail[] = {static const int apds9160_als_rate_map[][2] = {static const int apds9160_als_gain_map[][2] = {static const int apds9160_ps_gain_avail[] = {static const int apds9160_ps_gain_map[][2] = {static const int apds9160_ps_rate_avail[] = {static const int apds9160_ps_rate_map[][2] = {static const int apds9160_ps_led_current_avail[] = {static const int apds9160_ps_led_current_map[][2] = {/** * struct apds9160_scale - apds9160 scale mapping definition * * @itime: Integration time in ms * @gain: Gain multiplier * @scale1: lux/count resolution * @scale2: micro lux/count struct apds9160_scale {int itime;int gain;int scale1;int scale2;/* Scale mapping extracted from datasheet */ static const struct apds9160_scale apds9160_als_scale_map[] = {static const int apds9160_25ms_avail[][2] = {static const int apds9160_50ms_avail[][2] = {static const int apds9160_100ms_avail[][2] = {static const int apds9160_200ms_avail[][2] = {static const struct reg_field apds9160_reg_field_ls_en =static const struct reg_field apds9160_reg_field_ps_en =static const struct reg_field apds9160_reg_field_int_ps =static const struct reg_field apds9160_reg_field_int_als =static const struct reg_field apds9160_reg_field_ps_overflow =static const struct reg_field apds9160_reg_field_als_rate =static const struct reg_field apds9160_reg_field_als_gain =static const struct reg_field apds9160_reg_field_ps_rate =static const struct reg_field apds9160_reg_field_als_res =static const struct reg_field apds9160_reg_field_ps_current =static const struct reg_field apds9160_reg_field_ps_gain =static const struct reg_field apds9160_reg_field_ps_resolution =struct apds9160_chip {struct i2c_client *client;struct regmap *regmap;struct regmap_field *reg_enable_ps;struct regmap_field *reg_enable_als;struct regmap_field *reg_int_ps;struct regmap_field *reg_int_als;struct regmap_field *reg_ps_overflow;struct regmap_field *reg_als_rate;struct regmap_field *reg_als_resolution;struct regmap_field *reg_ps_rate;struct regmap_field *reg_als_gain;struct regmap_field *reg_ps_current;struct regmap_field *reg_ps_gain;struct regmap_field *reg_ps_resolution;struct mutex lock; /* protects state and config data */ /* State data */ int als_int;int ps_int;/* Configuration values */ int als_itime;int als_hwgain;int als_scale1;int als_scale2;int ps_rate;int ps_cancellation_level;int ps_current;int ps_gain;static int apds9160_set_ps_rate(struct apds9160_chip *data, int val)int idx;for (idx = 0; idx < ARRAY_SIZE(apds9160_ps_rate_map); idx++) {int ret;if (apds9160_ps_rate_map[idx][0] != val)continue ;if (ret)return ret;return ret;return -EINVAL;static int apds9160_set_ps_gain(struct apds9160_chip *data, int val)int idx;for (idx = 0; idx < ARRAY_SIZE(apds9160_ps_gain_map); idx++) {int ret;if (apds9160_ps_gain_map[idx][0] != val)continue ;if (ret)return ret;return ret;return -EINVAL;/* * The PS intelligent cancellation level register allows * for an on-chip substraction of the ADC count caused by * unwanted reflected light from PS ADC output. static int apds9160_set_ps_cancellation_level(struct apds9160_chip *data,int val)int ret;if (val < 0 || val > 0xFFFF)return -EINVAL;if (ret)return ret;return ret;/* * This parameter determines the cancellation pulse duration * in each of the PWM pulse. The cancellation is applied during the * integration phase of the PS measurement. * Duration is programmed in half clock cycles * A duration value of 0 or 1 will not generate any cancellation pulse static int apds9160_set_ps_analog_cancellation(struct apds9160_chip *data,int val)if (val < 0 || val > 63)return -EINVAL;return regmap_write(data->regmap, APDS9160_REG_PS_CAN_LEVEL_ANA_DUR,/* * This parameter works in conjunction with the cancellation pulse duration * The value determines the current used for crosstalk cancellation * Coarse value is in steps of 60 nA * Fine value is in steps of 2.4 nA static int apds9160_set_ps_cancellation_current(struct apds9160_chip *data,int coarse_val,int fine_val)int val;if (coarse_val < 0 || coarse_val > 4)return -EINVAL;if (fine_val < 0 || fine_val > 15)return -EINVAL;/* Coarse value at B4:B5 and fine value at B0:B3 */ return regmap_write(data->regmap, APDS9160_REG_PS_CAN_LEVEL_ANA_CURRENT,static int apds9160_ps_init_analog_cancellation(struct device *dev,struct apds9160_chip *data)int ret, duration, picoamp, idx, coarse, fine;"ps-cancellation-duration" , &duration);if (ret || duration == 0) {/* Don't fail since this is not required */ return 0;"ps-cancellation-current-picoamp" , &picoamp);if (ret)return ret;if (picoamp < 60000 || picoamp > 276000 || picoamp % 2400 != 0)return dev_err_probe(dev, -EINVAL,"Invalid cancellation current\n" );/* Compute required coarse and fine value from requested current */ for (idx = 60000; idx < picoamp; idx += 2400) {if (fine == 15) {else {if (picoamp != idx)"Invalid cancellation current %i, rounding to %i\n" ,if (ret)return ret;return apds9160_set_ps_cancellation_current(data, coarse, fine);static int apds9160_set_ps_current(struct apds9160_chip *data, int val)int idx;for (idx = 0; idx < ARRAY_SIZE(apds9160_ps_led_current_map); idx++) {int ret;if (apds9160_ps_led_current_map[idx][0] != val)continue ;if (ret)return ret;return ret;return -EINVAL;static int apds9160_set_als_gain(struct apds9160_chip *data, int gain)int idx;for (idx = 0; idx < ARRAY_SIZE(apds9160_als_gain_map); idx++) {int ret;if (gain != apds9160_als_gain_map[idx][0])continue ;if (ret)return ret;return ret;return -EINVAL;static int apds9160_set_als_scale(struct apds9160_chip *data, int val, int val2)int idx;for (idx = 0; idx < ARRAY_SIZE(apds9160_als_scale_map); idx++) {if (apds9160_als_scale_map[idx].itime == data->als_itime &&int ret = apds9160_set_als_gain(data,if (ret)return ret;return ret;return -EINVAL;static int apds9160_set_als_resolution(struct apds9160_chip *data, int val)switch (val) {case 25:return regmap_field_write(data->reg_als_resolution,case 50:return regmap_field_write(data->reg_als_resolution,case 200:return regmap_field_write(data->reg_als_resolution,default :return regmap_field_write(data->reg_als_resolution,static int apds9160_set_als_rate(struct apds9160_chip *data, int val)int idx;for (idx = 0; idx < ARRAY_SIZE(apds9160_als_rate_map); idx++) {if (apds9160_als_rate_map[idx][0] != val)continue ;return regmap_field_write(data->reg_als_rate,return -EINVAL;/* * Setting the integration time ajusts resolution, rate, scale and gain static int apds9160_set_als_int_time(struct apds9160_chip *data, int val)int ret;int idx;if (ret)return ret;/* Match resolution register with rate */ if (ret)return ret;/* Set the scale minimum gain */ for (idx = 0; idx < ARRAY_SIZE(apds9160_als_scale_map); idx++) {if (data->als_itime != apds9160_als_scale_map[idx].itime)continue ;return apds9160_set_als_scale(data,return -EINVAL;static int apds9160_read_avail(struct iio_dev *indio_dev,struct iio_chan_spec const *chan,const int **vals, int *type, int *length,long mask)struct apds9160_chip *data = iio_priv(indio_dev);switch (mask) {case IIO_CHAN_INFO_INT_TIME:switch (chan->type) {case IIO_LIGHT:const int *)apds9160_als_rate_avail;return IIO_AVAIL_LIST;case IIO_PROXIMITY:const int *)apds9160_ps_rate_avail;return IIO_AVAIL_LIST;default :return -EINVAL;case IIO_CHAN_INFO_SCALE:switch (chan->type) {case IIO_PROXIMITY:const int *)apds9160_ps_gain_avail;return IIO_AVAIL_LIST;case IIO_LIGHT:/* The available scales changes depending on itime */ switch (data->als_itime) {case 25:const int *)apds9160_25ms_avail;return IIO_AVAIL_LIST;case 50:const int *)apds9160_50ms_avail;return IIO_AVAIL_LIST;case 100:const int *)apds9160_100ms_avail;return IIO_AVAIL_LIST;case 200:const int *)apds9160_200ms_avail;return IIO_AVAIL_LIST;default :return -EINVAL;default :return -EINVAL;case IIO_CHAN_INFO_RAW:switch (chan->type) {case IIO_CURRENT:const int *)apds9160_ps_led_current_avail;return IIO_AVAIL_LIST;default :return -EINVAL;default :return -EINVAL;static int apds9160_write_raw_get_fmt(struct iio_dev *indio_dev,struct iio_chan_spec const *chan,long mask)switch (mask) {case IIO_CHAN_INFO_INT_TIME:return IIO_VAL_INT;case IIO_CHAN_INFO_CALIBBIAS:return IIO_VAL_INT;case IIO_CHAN_INFO_HARDWAREGAIN:return IIO_VAL_INT;case IIO_CHAN_INFO_RAW:return IIO_VAL_INT;case IIO_CHAN_INFO_SCALE:return IIO_VAL_INT_PLUS_MICRO;default :return -EINVAL;static int apds9160_read_raw(struct iio_dev *indio_dev,struct iio_chan_spec const *chan, int *val,int *val2, long mask)struct apds9160_chip *data = iio_priv(indio_dev);int ret;switch (mask) {case IIO_CHAN_INFO_RAW:switch (chan->type) {case IIO_PROXIMITY: {if (ret)return ret;/* Remove overflow bits from result */ return IIO_VAL_INT;case IIO_LIGHT:case IIO_INTENSITY: {if (ret)return ret;return IIO_VAL_INT;case IIO_CURRENT:return IIO_VAL_INT;default :return -EINVAL;case IIO_CHAN_INFO_HARDWAREGAIN:switch (chan->type) {case IIO_LIGHT:return IIO_VAL_INT;default :return -EINVAL;case IIO_CHAN_INFO_INT_TIME:switch (chan->type) {case IIO_PROXIMITY:return IIO_VAL_INT;case IIO_LIGHT:return IIO_VAL_INT;default :return -EINVAL;case IIO_CHAN_INFO_CALIBBIAS:switch (chan->type) {case IIO_PROXIMITY:return IIO_VAL_INT;default :return -EINVAL;case IIO_CHAN_INFO_SCALE:switch (chan->type) {case IIO_PROXIMITY:return IIO_VAL_INT;case IIO_LIGHT:return IIO_VAL_INT_PLUS_MICRO;default :return -EINVAL;default :return -EINVAL;static int apds9160_write_raw(struct iio_dev *indio_dev,struct iio_chan_spec const *chan, int val,int val2, long mask)struct apds9160_chip *data = iio_priv(indio_dev);switch (mask) {case IIO_CHAN_INFO_INT_TIME:if (val2 != 0)return -EINVAL;switch (chan->type) {case IIO_PROXIMITY:return apds9160_set_ps_rate(data, val);case IIO_LIGHT:return apds9160_set_als_int_time(data, val);default :return -EINVAL;case IIO_CHAN_INFO_SCALE:switch (chan->type) {case IIO_PROXIMITY:return apds9160_set_ps_gain(data, val);case IIO_LIGHT:return apds9160_set_als_scale(data, val, val2);default :return -EINVAL;case IIO_CHAN_INFO_CALIBBIAS:if (val2 != 0)return -EINVAL;switch (chan->type) {case IIO_PROXIMITY:return apds9160_set_ps_cancellation_level(data, val);default :return -EINVAL;case IIO_CHAN_INFO_RAW:if (val2 != 0)return -EINVAL;switch (chan->type) {case IIO_CURRENT:return apds9160_set_ps_current(data, val);default :return -EINVAL;default :return -EINVAL;static inline int apds9160_get_thres_reg(const struct iio_chan_spec *chan,enum iio_event_direction dir, u8 *reg)switch (dir) {case IIO_EV_DIR_RISING:switch (chan->type) {case IIO_PROXIMITY:break ;case IIO_LIGHT:break ;default :return -EINVAL;break ;case IIO_EV_DIR_FALLING:switch (chan->type) {case IIO_PROXIMITY:break ;case IIO_LIGHT:break ;default :return -EINVAL;break ;default :return -EINVAL;return 0;static int apds9160_read_event(struct iio_dev *indio_dev,const struct iio_chan_spec *chan,enum iio_event_type type,enum iio_event_direction dir,enum iio_event_info info, int *val, int *val2)int ret;struct apds9160_chip *data = iio_priv(indio_dev);if (info != IIO_EV_INFO_VALUE)return -EINVAL;if (ret < 0)return ret;switch (chan->type) {case IIO_PROXIMITY: {if (ret < 0)return ret;return IIO_VAL_INT;case IIO_LIGHT: {if (ret < 0)return ret;return IIO_VAL_INT;default :return -EINVAL;static int apds9160_write_event(struct iio_dev *indio_dev,const struct iio_chan_spec *chan,enum iio_event_type type,enum iio_event_direction dir,enum iio_event_info info, int val, int val2)int ret = 0;struct apds9160_chip *data = iio_priv(indio_dev);if (info != IIO_EV_INFO_VALUE)return -EINVAL;if (ret < 0)return ret;switch (chan->type) {case IIO_PROXIMITY: {if (val < 0 || val > APDS9160_PS_THRES_MAX)return -EINVAL;return regmap_bulk_write(data->regmap, reg, &buf, 2);case IIO_LIGHT: {if (val < 0 || val > APDS9160_LS_THRES_MAX)return -EINVAL;return regmap_bulk_write(data->regmap, reg, &buf, 3);default :return -EINVAL;static int apds9160_read_event_config(struct iio_dev *indio_dev,const struct iio_chan_spec *chan,enum iio_event_type type,enum iio_event_direction dir)struct apds9160_chip *data = iio_priv(indio_dev);switch (chan->type) {case IIO_PROXIMITY:return data->ps_int;case IIO_LIGHT:return data->als_int;default :return -EINVAL;static int apds9160_write_event_config(struct iio_dev *indio_dev,const struct iio_chan_spec *chan,enum iio_event_type type,enum iio_event_direction dir, bool state)struct apds9160_chip *data = iio_priv(indio_dev);int ret;switch (chan->type) {case IIO_PROXIMITY:if (ret)return ret;return 0;case IIO_LIGHT:if (ret)return ret;return 0;default :return -EINVAL;static irqreturn_t apds9160_irq_handler(int irq, void *private )struct iio_dev *indio_dev = private ;struct apds9160_chip *data = iio_priv(indio_dev);int ret, status;/* Reading status register clears the interrupt flag */ if (ret < 0) {"irq status reg read failed\n" );return IRQ_HANDLED;if ((status & APDS9160_SR_LS_INT) &&if ((status & APDS9160_SR_PS_INT) &&return IRQ_HANDLED;static int apds9160_detect(struct apds9160_chip *chip)struct i2c_client *client = chip->client;int ret;if (ret < 0) {"ID read failed\n" );return ret;if (val != APDS9160_PART_ID_0)"Unknown part id %u\n" , val);return 0;static void apds9160_disable(void *chip)struct apds9160_chip *data = chip;int ret;if (ret)return ;static int apds9160_chip_init(struct apds9160_chip *chip)int ret;/* Write default values to interrupt register */ if (ret)return ret;if (ret)return ret;/* Write default values to control register */ if (ret)return ret;if (ret)return ret;/* Write other default values */ if (ret)return ret;/* Write default values to configuration registers */ if (ret)return ret;if (ret)return ret;if (ret)return ret;if (ret)return ret;if (ret)return ret;if (ret)return ret;if (ret)return ret;return devm_add_action_or_reset(&chip->client->dev, apds9160_disable,static int apds9160_regfield_init(struct apds9160_chip *data)struct device *dev = &data->client->dev;struct regmap *regmap = data->regmap;struct regmap_field *tmp;if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);if (IS_ERR(tmp))return PTR_ERR(tmp);return 0;static const struct iio_info apds9160_info = {static const struct iio_info apds9160_info_no_events = {static int apds9160_probe(struct i2c_client *client)struct device *dev = &client->dev;struct apds9160_chip *chip;struct iio_dev *indio_dev;int ret;sizeof (*chip));if (!indio_dev)return -ENOMEM;"vdd" );if (ret)return dev_err_probe(dev, ret, "Failed to enable vdd supply\n" );"apds9160" ;if (IS_ERR(chip->regmap))return dev_err_probe(dev, PTR_ERR(chip->regmap),"regmap initialization failed.\n" );if (ret < 0)return dev_err_probe(dev, ret, "apds9160 not found\n" );if (ret)return ret;if (ret)return ret;if (ret)return ret;if (client->irq > 0) {"apds9160_event" ,if (ret) {return dev_err_probe(dev, ret,"request irq (%d) failed\n" ,else {if (ret)return dev_err_probe(dev, ret,"failed iio device registration\n" );return ret;static const struct of_device_id apds9160_of_match[] = {"brcm,apds9160" },static const struct i2c_device_id apds9160_id[] = {"apds9160" , 0 },static struct i2c_driver apds9160_driver = {"apds9160" ,"APDS9160 combined ALS and proximity sensor" );"Mikael Gonella-Bolduc " );"GPL" );
Messung V0.5 C=95 H=95 G=94
¤ Dauer der Verarbeitung: 0.11 Sekunden
¤ *© Formatika GbR, Deutschland
