| Message ID | 20191228201109.13635-2-linus.walleij@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | None | expand |
On Sat, 28 Dec 2019 21:11:09 +0100 Linus Walleij <linus.walleij@linaro.org> wrote: > This driver handles two different Sharp sensors that have been > proposed for merging to the mainline kernel over the years, and > already has a limited proximity-only driver in the input > subsystem. > > These components are completely different from the confusingly > similarly named Sharp GP2AP020A00F, for which we have a driver > in drivers/iio/light/gp2ap020a00f.c > > The two components GP2AP002A00F and GP2AP002S00F are > distinctively different but similar: they share the same set of > registers but differ slightly in the I2C protocol. > > Instead of the approach by the previous input driver, we create > a combined IIO proximity and light sensor driver. > > The plan is to merge this driver and delete the input driver. > > The pieces for the driver are picked all over the place after > researching and grepping through a few different vendor trees > and driver submissions. > > We merge it under the light sensors because: > > - It has similarities with the Capella CM3605 light sensor and > proximity driver which is there. > > - It is related to the GP2AP020A00F driver which is also there. > > This driver was tested with the Samsung GT-S7710 mobile phone > which has the GP2AP002S00F proximity sensor mounted. > > Cc: Stephan Gerhold <stephan@gerhold.net> > Cc: Donggeun Kim <dg77.kim@samsung.com> > Cc: Minkyu Kang <mk7.kang@samsung.com> > Cc: Paweł Chmiel <pawel.mikolaj.chmiel@gmail.com> > Cc: Jonathan Bakker <xc-racer2@live.ca> > Cc: Oskar Andero <oskar.andero@gmail.com> > Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com> > Signed-off-by: Linus Walleij <linus.walleij@linaro.org> Hi Linus. Happy new year. A few things inline. If at all possible I'd like to discourage use of of specific calls in favour of the generic ones. It's pretty unlikely we'll ever see this driver using anything else, but I'd like to build up a good set of examples to point people at now that functionality is in place. Otherwise, biggest open is probably the one on what exactly the hysteresis binding is and whether it makes sense to put that in firmware. thanks, Jonathan > --- > MAINTAINERS | 8 + > drivers/iio/light/Kconfig | 13 + > drivers/iio/light/Makefile | 1 + > drivers/iio/light/gp2ap002.c | 679 +++++++++++++++++++++++++++++++++++ > 4 files changed, 701 insertions(+) > create mode 100644 drivers/iio/light/gp2ap002.c > > diff --git a/MAINTAINERS b/MAINTAINERS > index 1372b4139ebd..dbd4236fc7f5 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -14893,6 +14893,14 @@ W: http://www.ibm.com/developerworks/linux/linux390/ > S: Supported > F: net/smc/ > > +SHARP GP2AP002A00F/GP2AP002S00F SENSOR DRIVER > +M: Linus Walleij <linus.walleij@linaro.org> > +L: linux-iio@vger.kernel.org > +T: git git://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git > +S: Maintained > +F: drivers/iio/light/gp2ap002.c > +F: Documentation/devicetree/bindings/iio/light/sharp,gp2ap002.yaml > + > SHARP RJ54N1CB0C SENSOR DRIVER > M: Jacopo Mondi <jacopo@jmondi.org> > L: linux-media@vger.kernel.org > diff --git a/drivers/iio/light/Kconfig b/drivers/iio/light/Kconfig > index 9968f982fbc7..8b93b2a78b47 100644 > --- a/drivers/iio/light/Kconfig > +++ b/drivers/iio/light/Kconfig > @@ -159,6 +159,19 @@ config IIO_CROS_EC_LIGHT_PROX > To compile this driver as a module, choose M here: > the module will be called cros_ec_light_prox. > > +config GP2AP002 > + tristate "Sharp GP2AP002 Proximity/ALS sensor" > + depends on I2C > + select REGMAP > + select IIO_BUFFER > + select IIO_TRIGGERED_BUFFER Not using the buffered stuff yet so don't need these.. > + help > + Say Y here if you have a Sharp GP2AP002 proximity/ALS combo-chip > + hooked to an I2C bus. > + > + To compile this driver as a module, choose M here: the > + module will be called gp2ap002. > + > config GP2AP020A00F > tristate "Sharp GP2AP020A00F Proximity/ALS sensor" > depends on I2C > diff --git a/drivers/iio/light/Makefile b/drivers/iio/light/Makefile > index c98d1cefb861..264a76039006 100644 > --- a/drivers/iio/light/Makefile > +++ b/drivers/iio/light/Makefile > @@ -18,6 +18,7 @@ obj-$(CONFIG_CM3323) += cm3323.o > obj-$(CONFIG_CM3605) += cm3605.o > obj-$(CONFIG_CM36651) += cm36651.o > obj-$(CONFIG_IIO_CROS_EC_LIGHT_PROX) += cros_ec_light_prox.o > +obj-$(CONFIG_GP2AP002) += gp2ap002.o > obj-$(CONFIG_GP2AP020A00F) += gp2ap020a00f.o > obj-$(CONFIG_HID_SENSOR_ALS) += hid-sensor-als.o > obj-$(CONFIG_HID_SENSOR_PROX) += hid-sensor-prox.o > diff --git a/drivers/iio/light/gp2ap002.c b/drivers/iio/light/gp2ap002.c > new file mode 100644 > index 000000000000..98553041d63c > --- /dev/null > +++ b/drivers/iio/light/gp2ap002.c > @@ -0,0 +1,679 @@ > +// SPDX-License-Identifier: GPL-2.0-only > +/* > + * These are the two Sharp GP2AP002 variants supported by this driver: > + * GP2AP002A00F Ambient Light and Proximity Sensor > + * GP2AP002S00F Proximity Sensor > + * > + * Copyright (C) 2019 Linaro Ltd. > + * Author: Linus Walleij <linus.walleij@linaro.org> > + * > + * Based partly on the code in Sony Ericssons GP2AP00200F driver by > + * Courtney Cavin and Oskar Andero in drivers/input/misc/gp2ap002a00f.c > + * Based partly on a Samsung misc driver submitted by > + * Donggeun Kim & Minkyu Kang in 2011: > + * https://lore.kernel.org/lkml/1315556546-7445-1-git-send-email-dg77.kim@samsung.com/ > + * Based partly on a submission by > + * Jonathan Bakker and Paweł Chmiel in january 2019: > + * https://lore.kernel.org/linux-input/20190125175045.22576-1-pawel.mikolaj.chmiel@gmail.com/ > + * Based partly on code from the Samsung GT-S7710 by <mjchen@sta.samsung.com> > + * Based partly on the code in LG Electronics GP2AP00200F driver by > + * Kenobi Lee <sungyoung.lee@lge.com> and EunYoung Cho <ey.cho@lge.com> > + */ > +#include <linux/module.h> > +#include <linux/i2c.h> > +#include <linux/regmap.h> > +#include <linux/iio/iio.h> > +#include <linux/iio/sysfs.h> > +#include <linux/iio/events.h> > +#include <linux/iio/consumer.h> /* To get our ADC channel */ > +#include <linux/iio/types.h> /* To deal with our ADC channel */ > +#include <linux/init.h> > +#include <linux/delay.h> > +#include <linux/of.h> > +#include <linux/regulator/consumer.h> > +#include <linux/interrupt.h> > +#include <linux/bits.h> > +#include <linux/math64.h> > +#include <linux/pm.h> > + > +#define GP2AP002_PROX_CHANNEL 0 > +#define GP2AP002_ALS_CHANNEL 1 > + > +/* ------------------------------------------------------------------------ */ > +/* ADDRESS SYMBOL DATA Init R/W */ > +/* D7 D6 D5 D4 D3 D2 D1 D0 */ > +/* ------------------------------------------------------------------------ */ > +/* 0 PROX X X X X X X X VO H'00 R */ > +/* 1 GAIN X X X X LED0 X X X H'00 W */ > +/* 2 HYS HYSD HYSC1 HYSC0 X HYSF3 HYSF2 HYSF1 HYSF0 H'00 W */ > +/* 3 CYCLE X X CYCL2 CYCL1 CYCL0 OSC2 X X H'00 W */ > +/* 4 OPMOD X X X ASD X X VCON SSD H'00 W */ > +/* 6 CON X X X OCON1 OCON0 X X X H'00 W */ > +/* ------------------------------------------------------------------------ */ > +/* VO :Proximity sensing result(0: no detection, 1: detection) */ > +/* LED0 :Select switch for LED driver's On-registence(0:2x higher, 1:normal)*/ > +/* HYSD/HYSF :Adjusts the receiver sensitivity */ > +/* OSC :Select switch internal clocl frequency hoppling(0:effective) */ > +/* CYCL :Determine the detection cycle(typically 8ms, up to 128x) */ > +/* SSD :Software Shutdown function(0:shutdown, 1:operating) */ > +/* VCON :VOUT output method control(0:normal, 1:interrupt) */ > +/* ASD :Select switch for analog sleep function(0:ineffective, 1:effective)*/ > +/* OCON :Select switch for enabling/disabling VOUT (00:enable, 11:disable) */ > + > +#define GP2AP002_PROX 0x00 > +#define GP2AP002_GAIN 0x01 > +#define GP2AP002_HYS 0x02 > +#define GP2AP002_CYCLE 0x03 > +#define GP2AP002_OPMOD 0x04 > +#define GP2AP002_CON 0x06 > + > +#define PROX_VO_DETECT BIT(0) Please prefix all defines. Some are fairly generic so we might have problems one day and I'd like to avoid the possibility from the start. > + > +/* Setting this bit to 0 means 2x higher LED resistance */ > +#define GAIN_LED_NORMAL BIT(3) > + > +/* > + * These bits adjusts the proximity sensitivity, determining characteristics > + * of the detection distance and its hysteresis. > + */ > +#define HYS_HYSD_SHIFT 7 > +#define HYS_HYSD_MASK (0x1 << HYS_HYSD_SHIFT) > +#define HYS_HYSC_SHIFT 5 > +#define HYS_HYSC_MASK (0x3 << HYS_HYSC_SHIFT) > +#define HYS_HYSF_SHIFT 0 > +#define HYS_HYSF_MASK (0xf << HYS_HYSF_SHIFT) > +#define HYS_MASK (HYS_HYSD_MASK | HYS_HYSC_MASK | HYS_HYSF_MASK) > + > +/* > + * These values determine the detection cycle response time > + * 0: 8ms, 1: 16ms, 2: 32ms, 3: 64ms, 4: 128ms, > + * 5: 256ms, 6: 512ms, 7: 1024ms > + */ > +#define CYCLE_CYCL_SHIFT 3 > +#define CYCLE_CYCL_MASK (0x7 << CYCLE_CYCL_SHIFT) > +/* > + * Select switch for internal clock frequency hopping > + * 0: effective, > + * 1: ineffective > + */ > +#define CYCLE_OSC_EFFECTIVE 0 > +#define CYCLE_OSC_INEFFECTIVE BIT(2) > +#define CYCLE_OSC_MASK BIT(2) > + > +/* Analog sleep effective */ > +#define OPMOD_ASD BIT(4) > +/* Enable chip */ > +#define OPMOD_SSD_OPERATING BIT(0) > +/* IRQ mode */ > +#define OPMOD_VCON_IRQ BIT(1) > +#define OPMOD_MASK (BIT(0) | BIT(1) | BIT(4)) > + > +/* > + * Select switch for enabling/disabling Vout pin > + * 0: enable > + * 2: force to go Low > + * 3: force to go High > + */ > +#define CON_OCON_SHIFT 3 > +#define CON_OCON_ENABLE (0x0 << CON_OCON_SHIFT) > +#define CON_OCON_LOW (0x2 << CON_OCON_SHIFT) > +#define CON_OCON_HIGH (0x3 << CON_OCON_SHIFT) > +#define CON_OCON_MASK (0x3 << CON_OCON_SHIFT) Slight preference for GENMASK for the masks where possible. > + > +/** > + * struct gp2ap002 - GP2AP002 state > + * @map: regmap pointer for the i2c regmap > + * @dev: pointer to parent device > + * @vdd: regulator controlling VDD > + * @vio: regulator controlling VIO > + * @alsout: IIO ADC channel to convert the ALSOUT signal > + * @is_gp2ap002s00f: this is the GP2AP002F variant of the chip > + */ > +struct gp2ap002 { > + struct regmap *map; > + struct device *dev; > + struct regulator *vdd; > + struct regulator *vio; > + struct iio_channel *alsout; > + enum iio_event_direction dir; > + u8 hys_far; > + u8 hys_close; > + bool is_gp2ap002s00f; > +}; > + > +static irqreturn_t gp2ap002_prox_irq(int irq, void *d) > +{ > + struct iio_dev *indio_dev = d; > + struct gp2ap002 *gp2ap002 = iio_priv(indio_dev); > + u64 ev; > + int val; > + int ret; > + > + ret = regmap_read(gp2ap002->map, GP2AP002_PROX, &val); > + if (val & PROX_VO_DETECT) { > + /* Close */ > + dev_dbg(gp2ap002->dev, "close\n"); > + ret = regmap_write(gp2ap002->map, GP2AP002_HYS, > + gp2ap002->hys_far); > + if (ret < 0) > + dev_err(gp2ap002->dev, > + "error setting up proximity hysteresis\n"); > + ev = IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, GP2AP002_PROX_CHANNEL, > + IIO_EV_TYPE_THRESH, IIO_EV_DIR_RISING); > + } else { > + /* Far */ > + dev_dbg(gp2ap002->dev, "far\n"); > + ret = regmap_write(gp2ap002->map, GP2AP002_HYS, > + gp2ap002->hys_close); > + if (ret < 0) > + dev_err(gp2ap002->dev, > + "error setting up proximity hysteresis\n"); > + ev = IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, GP2AP002_PROX_CHANNEL, > + IIO_EV_TYPE_THRESH, IIO_EV_DIR_FALLING); > + } > + iio_push_event(indio_dev, ev, iio_get_time_ns(indio_dev)); > + usleep_range(20000, 30000); What is the basis for these timings? > + ret = regmap_write(gp2ap002->map, GP2AP002_CON, CON_OCON_ENABLE); > + if (ret < 0) > + dev_err(gp2ap002->dev, "error setting up VOUT control\n"); > + > + return IRQ_HANDLED; > +} > + > +struct gp2ap002_illuminance { > + unsigned int curr; > + unsigned int lux; > +}; > + > +/* > + * This array maps current and lux. > + * > + * Ambient light sensing range is 3 to 55000 lux. > + * > + * This mapping is based on the following formula. > + * illuminance = 10 ^ (current / 10) > + */ > +const struct gp2ap002_illuminance gp2ap002_illuminance_table[] = { > + { .curr = 5, .lux = 3 }, > + { .curr = 6, .lux = 4 }, > + { .curr = 7, .lux = 5 }, > + { .curr = 8, .lux = 6 }, > + { .curr = 9, .lux = 8 }, > + { .curr = 10, .lux = 10 }, > + { .curr = 11, .lux = 12 }, > + { .curr = 12, .lux = 16 }, > + { .curr = 13, .lux = 20 }, > + { .curr = 14, .lux = 25 }, > + { .curr = 15, .lux = 32 }, > + { .curr = 16, .lux = 40 }, > + { .curr = 17, .lux = 50 }, > + { .curr = 18, .lux = 63 }, > + { .curr = 19, .lux = 79 }, > + { .curr = 20, .lux = 100 }, > + { .curr = 21, .lux = 126 }, > + { .curr = 22, .lux = 158 }, > + { .curr = 23, .lux = 200 }, > + { .curr = 24, .lux = 251 }, > + { .curr = 25, .lux = 316 }, > + { .curr = 26, .lux = 398 }, > + { .curr = 27, .lux = 501 }, > + { .curr = 28, .lux = 631 }, > + { .curr = 29, .lux = 794 }, > + { .curr = 30, .lux = 1000 }, > + { .curr = 31, .lux = 1259 }, > + { .curr = 32, .lux = 1585 }, > + { .curr = 33, .lux = 1995 }, > + { .curr = 34, .lux = 2512 }, > + { .curr = 35, .lux = 3162 }, > + { .curr = 36, .lux = 3981 }, > + { .curr = 37, .lux = 5012 }, > + { .curr = 38, .lux = 6310 }, > + { .curr = 39, .lux = 7943 }, > + { .curr = 40, .lux = 10000 }, > + { .curr = 41, .lux = 12589 }, > + { .curr = 42, .lux = 15849 }, > + { .curr = 43, .lux = 19953 }, > + { .curr = 44, .lux = 25119 }, > + { .curr = 45, .lux = 31623 }, > + { .curr = 46, .lux = 39811 }, > + { .curr = 47, .lux = 50119 }, > +}; > + > +static int gp2ap002_get_lux(struct gp2ap002 *gp2ap002) > +{ > + const struct gp2ap002_illuminance *ill1; > + const struct gp2ap002_illuminance *ill2; > + int ret, res; > + int i; > + > + ret = iio_read_channel_processed(gp2ap002->alsout, &res); > + if (ret < 0) > + return ret; > + > + dev_dbg(gp2ap002->dev, "read %d mA from ADC\n", res); > + > + ill1 = &gp2ap002_illuminance_table[0]; > + if (res < ill1->curr) { > + dev_dbg(gp2ap002->dev, "total darkness\n"); > + return 0; > + } > + for (i = 0; i < ARRAY_SIZE(gp2ap002_illuminance_table) - 1; i++) { > + ill1 = &gp2ap002_illuminance_table[i]; > + ill2 = &gp2ap002_illuminance_table[i+1]; Spaces around that + preferred. > + > + if (res > ill2->curr) > + continue; > + if ((res <= ill1->curr) && (res >= ill2->curr)) > + break; > + } > + if (res > ill2->curr) { > + dev_info_once(gp2ap002->dev, "max current overflow\n"); > + return ill2->curr; > + } > + /* Interpolate and return */ > + dev_info(gp2ap002->dev, "interpolate index %d and %d\n", i, i + 1); > + /* How many steps along the curve */ > + i = res - ill1->curr; /* x - x0 */ > + /* Linear interpolation */ > + return ill1->lux + i * > + ((ill2->lux - ill1->lux) / (ill2->curr - ill1->curr)); > +} > + > +static int gp2ap002_read_raw(struct iio_dev *indio_dev, > + struct iio_chan_spec const *chan, > + int *val, int *val2, long mask) > +{ > + struct gp2ap002 *gp2ap002 = iio_priv(indio_dev); > + int ret; > + > + switch (mask) { > + case IIO_CHAN_INFO_RAW: > + switch (chan->type) { > + case IIO_LIGHT: > + ret = gp2ap002_get_lux(gp2ap002); > + if (ret < 0) > + return ret; > + *val = ret; > + return IIO_VAL_INT; > + default: > + return -EINVAL; > + } > + default: > + return -EINVAL; > + } > +} > + > +static const struct iio_info gp2ap002_info = { > + .read_raw = gp2ap002_read_raw, > +}; > + > +static const struct iio_event_spec gp2ap002_events[] = { > + { > + .type = IIO_EV_TYPE_THRESH, > + .dir = IIO_EV_DIR_EITHER, > + .mask_separate = BIT(IIO_EV_INFO_ENABLE), > + }, > +}; > + > +static const struct iio_chan_spec gp2ap002_channels[] = { > + { > + .type = IIO_PROXIMITY, > + .event_spec = gp2ap002_events, > + .num_event_specs = ARRAY_SIZE(gp2ap002_events), > + }, > + { > + .type = IIO_LIGHT, > + .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), > + .channel = GP2AP002_ALS_CHANNEL, > + }, > +}; > + > +/* > + * We need a special regmap because this hardware expects to > + * write single bytes to registers but read a 16bit word on some > + * variants and discard the lower 8 bits so combine > + * i2c_smbus_read_word_data() with i2c_smbus_write_byte_data() > + * selectively like this. > + */ > +static int gp2ap002a00f_regmap_i2c_read(void *context, unsigned int reg, > + unsigned int *val) > +{ > + struct device *dev = context; > + struct i2c_client *i2c = to_i2c_client(dev); > + int ret; > + > + ret = i2c_smbus_read_byte_data(i2c, reg); > + if (ret < 0) > + return ret; > + *val = ret & 0xff; > + > + return 0; > +} > + > +static int gp2ap002s00f_regmap_i2c_read(void *context, unsigned int reg, > + unsigned int *val) > +{ > + struct device *dev = context; > + struct i2c_client *i2c = to_i2c_client(dev); > + int ret; > + > + ret = i2c_smbus_read_word_data(i2c, reg); > + if (ret < 0) > + return ret; > + > + *val = (ret >> 8) & 0xFF; > + > + return 0; > +} > + > +static int gp2ap002_regmap_i2c_write(void *context, unsigned int reg, > + unsigned int val) > +{ > + struct device *dev = context; > + struct i2c_client *i2c = to_i2c_client(dev); > + > + return i2c_smbus_write_byte_data(i2c, reg, val); > +} > + > +static struct regmap_bus gp2ap002_regmap_bus = { > + .reg_write = gp2ap002_regmap_i2c_write, > +}; > + > + > +static int gp2ap002_init(struct gp2ap002 *gp2ap002) > +{ > + int ret; > + > + /* Set up the IR LED resistance */ > + ret = regmap_write(gp2ap002->map, GP2AP002_GAIN, GAIN_LED_NORMAL); > + if (ret < 0) { I would generally prefer the error checks to be as specific as possible as it let's us clean up a few corners. regmap_write always returns 0 or negative, so if (ret) preferred. A sufficiently clever compiler could notice that _regmap_write has checks against ret != 0 and moan about inconsistency in the error checks and the ability to ignore a postive 'error'... It also lets us... > + dev_err(gp2ap002->dev, "error setting up LED gain\n"); > + return ret; > + } > + ret = regmap_write(gp2ap002->map, GP2AP002_HYS, gp2ap002->hys_far); > + if (ret < 0) { > + dev_err(gp2ap002->dev, > + "error setting up proximity hysteresis\n"); > + return ret; > + } > + > + /* Disable internal frequency hopping */ > + ret = regmap_write(gp2ap002->map, GP2AP002_CYCLE, > + CYCLE_OSC_INEFFECTIVE); > + if (ret < 0) { > + dev_err(gp2ap002->dev, > + "error setting up internal frequency hopping\n"); > + return ret; > + } > + > + /* Enable chip and IRQ, disable analog sleep */ > + ret = regmap_write(gp2ap002->map, GP2AP002_OPMOD, > + OPMOD_SSD_OPERATING | OPMOD_VCON_IRQ); > + if (ret < 0) { > + dev_err(gp2ap002->dev, "error setting up operation mode\n"); > + return ret; > + } > + > + /* Interrupt on VOUT enabled */ > + ret = regmap_write(gp2ap002->map, GP2AP002_CON, CON_OCON_ENABLE); > + if (ret < 0) { > + dev_err(gp2ap002->dev, "error setting up VOUT control\n"); > + return ret; drop this return ret out of the brackets as it's either 0 or negative anyway. > + } > + > + return 0; > +} > + > +static int gp2ap002_probe(struct i2c_client *client, > + const struct i2c_device_id *id) > +{ > + struct gp2ap002 *gp2ap002; > + struct iio_dev *indio_dev; > + struct device *dev = &client->dev; > + struct device_node *np = dev->of_node; > + enum iio_chan_type ch_type; > + static const struct regmap_config config = { > + .reg_bits = 8, > + .val_bits = 8, > + .max_register = GP2AP002_CON, > + }; > + struct regmap *regmap; > + int num_chan; > + u32 val; > + int ret; > + > + indio_dev = devm_iio_device_alloc(dev, sizeof(*gp2ap002)); > + if (!indio_dev) > + return -ENOMEM; > + i2c_set_clientdata(client, indio_dev); > + > + gp2ap002 = iio_priv(indio_dev); > + gp2ap002->dev = dev; > + > + gp2ap002->is_gp2ap002s00f = > + of_device_is_compatible(np, "sharp,gp2ap002s00f"); Hmm. This rather breaks my comment below about trying to avoid making this of specific if we don't need to... I 'think' we could use device_property_read_string There is a bit of precedence for doing so, but it is not common. > + if (gp2ap002->is_gp2ap002s00f) > + gp2ap002_regmap_bus.reg_read = gp2ap002s00f_regmap_i2c_read; Don't write to a global... What if you have one of each of these attached to a given board? One of them ends up broken. Just have two remap_bus and pick between them. > + else > + gp2ap002_regmap_bus.reg_read = gp2ap002a00f_regmap_i2c_read; > + > + regmap = devm_regmap_init(dev, &gp2ap002_regmap_bus, dev, &config); > + if (IS_ERR(regmap)) { > + dev_err(dev, "Failed to register i2c regmap %d\n", > + (int)PTR_ERR(regmap)); > + return PTR_ERR(regmap); > + } > + gp2ap002->map = regmap; > + > + /* Check the device tree for the IR LED hysteresis */ > + ret = of_property_read_u32(np, "sharp,proximity-far-hysteresis", &val); Do these belong in DT at all, or are they more of a policy decision? Without a datasheet I'm kind of guessing what they actually are. We have the option for hysterisis controls on events from sysfs if that make sense. Could use the fwnode_get_property_u32 etc to drop reliance on OF. > + if (ret) { > + dev_err(dev, "missing proximity far setting\n"); > + return -EINVAL; > + } > + if (val > 0xFF) { > + dev_err(dev, "illegal proximity far setting\n"); > + return -EINVAL; > + } > + gp2ap002->hys_far = val; Blank line here would make things a tiny bit easier to read I think... > + ret = of_property_read_u32(np, "sharp,proximity-close-hysteresis", > + &val); > + if (ret) { > + dev_err(dev, "missing proximity close setting\n"); > + return -EINVAL; > + } > + if (val > 0xFF) { > + dev_err(dev, "illegal proximity close setting\n"); > + return -EINVAL; > + } > + gp2ap002->hys_close = val; > + > + /* The GP2AP002A00F has a light sensor too */ > + if (!gp2ap002->is_gp2ap002s00f) { This section is rather 'unusual' and definitely needs some explanatory comments - particularly as I can't find any reference docs for the part. I'm guessing that the light sensor is simply an analog output? As such you need to wire it up to a separate ADC to actually read the light level... > + gp2ap002->alsout = devm_iio_channel_get(dev, "alsout"); > + if (IS_ERR(gp2ap002->alsout)) { > + if (PTR_ERR(gp2ap002->alsout) == -ENODEV) { > + dev_err(dev, "no ADC, deferring...\n"); > + return -EPROBE_DEFER; Hmm. Seems we don't handle deferred probing in the core for doing this. I can't remember if we ever tried to fix that or it it is just a case of this stuff predating deferred probing... > + } > + dev_err(dev, "failed to get ALSOUT ADC channel\n"); > + return PTR_ERR(gp2ap002->alsout); > + } > + ret = iio_get_channel_type(gp2ap002->alsout, &ch_type); > + if (ret < 0) > + return ret; > + if (ch_type != IIO_CURRENT) { > + dev_err(dev, > + "wrong type of IIO channel specified for ALSOUT\n"); > + return -EINVAL; > + } > + } > + > + gp2ap002->vdd = devm_regulator_get(dev, "vdd"); > + if (IS_ERR(gp2ap002->vdd)) { > + dev_err(dev, "failed to get VDD regulator\n"); > + return PTR_ERR(gp2ap002->vdd); > + } > + gp2ap002->vio = devm_regulator_get(dev, "vio"); > + if (IS_ERR(gp2ap002->vio)) { > + dev_err(dev, "failed to get VIO regulator\n"); > + return PTR_ERR(gp2ap002->vio); > + } > + > + /* Operating voltage 2.4V .. 3.6V according to datasheet */ > + ret = regulator_set_voltage(gp2ap002->vdd, 2400000, 3600000); > + if (ret) { > + dev_err(dev, "failed to sett VDD voltage\n"); > + return ret; > + } > + /* VIO should be between 1.65V and VDD */ > + ret = regulator_get_voltage(gp2ap002->vdd); Why get this voltage then throw it away? Left over debug? > + ret = regulator_set_voltage(gp2ap002->vio, 1650000, ret); > + if (ret) { > + dev_err(dev, "failed to sett VIO voltage\n"); > + return ret; > + } > + > + ret = regulator_enable(gp2ap002->vdd); > + if (ret) { > + dev_err(dev, "failed to enable VDD regulator\n"); > + return ret; > + } > + ret = regulator_enable(gp2ap002->vio); > + if (ret) { > + dev_err(dev, "failed to enable VIO regulator\n"); > + goto out_disable_vdd; > + } > + > + msleep(20); > + > + ret = gp2ap002_init(gp2ap002); > + if (ret) { > + dev_err(dev, "initialization failed\n"); > + goto out_disable_vio; > + } > + > + ret = devm_request_threaded_irq(dev, client->irq, NULL, > + gp2ap002_prox_irq, IRQF_ONESHOT, > + "gp2ap002", indio_dev); > + if (ret) { > + dev_err(dev, "unable to request IRQ\n"); > + goto out_disable_vio; > + } > + > + indio_dev->dev.parent = dev; > + indio_dev->info = &gp2ap002_info; > + indio_dev->name = "gp2ap002"; > + indio_dev->channels = gp2ap002_channels; > + /* Skip light channel for the proximity-only sensor */ > + num_chan = ARRAY_SIZE(gp2ap002_channels); > + if (gp2ap002->is_gp2ap002s00f) > + num_chan--; > + indio_dev->num_channels = num_chan; > + indio_dev->modes = INDIO_DIRECT_MODE; > + > + ret = iio_device_register(indio_dev); > + if (ret) > + goto out_disable_vio; > + dev_info(dev, "Sharp GP2AP002 enabled\n"); I'm fairly consistently anti generic prints that don't tell us anything new. Just add noise to the log given how easy it is to see if the module probed correctly. > + > + return 0; > + > +out_disable_vio: > + regulator_disable(gp2ap002->vio); > +out_disable_vdd: > + regulator_disable(gp2ap002->vdd); > + return ret; > +} > + > +static int gp2ap002_remove(struct i2c_client *client) > +{ > + struct iio_dev *indio_dev = i2c_get_clientdata(client); > + struct gp2ap002 *gp2ap002 = iio_priv(indio_dev); > + > + iio_device_unregister(indio_dev); > + regulator_disable(gp2ap002->vio); > + regulator_disable(gp2ap002->vdd); > + > + return 0; > +} > + > +static int __maybe_unused gp2ap002_pm_suspend(struct device *dev) > +{ > + struct iio_dev *indio_dev = dev_get_drvdata(dev); > + struct gp2ap002 *gp2ap002 = iio_priv(indio_dev); > + int ret; > + > + /* Disable chip and IRQ, everything off */ > + ret = regmap_write(gp2ap002->map, GP2AP002_OPMOD, 0x00); > + if (ret < 0) { > + dev_err(gp2ap002->dev, "error setting up operation mode\n"); > + return ret; > + } > + /* > + * As these regulators may be shared, at least we are now in > + * sleep even if the regulators aren't really turned off. > + */ > + regulator_disable(gp2ap002->vio); > + regulator_disable(gp2ap002->vdd); > + > + return 0; > +} > + > +static int __maybe_unused gp2ap002_pm_resume(struct device *dev) > +{ > + struct iio_dev *indio_dev = dev_get_drvdata(dev); > + struct gp2ap002 *gp2ap002 = iio_priv(indio_dev); > + int ret; > + > + ret = regulator_enable(gp2ap002->vdd); > + if (ret) > + dev_err(dev, "failed to enable VDD regulator in resume path\n"); > + ret = regulator_enable(gp2ap002->vio); > + if (ret) > + dev_err(dev, "failed to enable VIO regulator in resume path\n"); > + > + msleep(20); > + > + ret = gp2ap002_init(gp2ap002); > + if (ret) > + dev_err(dev, "re-initialization failed\n"); > + > + return 0; > +} > + > +static const struct dev_pm_ops gp2ap002_dev_pm_ops = { > + SET_SYSTEM_SLEEP_PM_OPS(gp2ap002_pm_suspend, > + gp2ap002_pm_resume) > +}; > + > +static const struct i2c_device_id gp2ap002_id_table[] = { > + { "gp2ap002", 0 }, > + { }, > +}; > +MODULE_DEVICE_TABLE(i2c, gp2ap002_id); > + > +#ifdef CONFIG_OF > +static const struct of_device_id gp2ap002_of_match[] = { > + { .compatible = "sharp,gp2ap002a00f" }, > + { .compatible = "sharp,gp2ap002s00f" }, > + { }, > +}; > +MODULE_DEVICE_TABLE(of, gp2ap002_of_match); > +#endif > + > +static struct i2c_driver gp2ap002_driver = { > + .driver = { > + .name = "gp2ap002", > + .of_match_table = of_match_ptr(gp2ap002_of_match), Hmm. Probably never going to see this on an ACPI device, but from a setting bad precedence point of view, let's support PRP001 DSDT magic by not using of_match_ptr or the ifdef guards around the gp2ap002_of_match table. I'm not really bothered enough about this to go rip them out of existing drivers, but nice not to add any more :) > + .pm = &gp2ap002_dev_pm_ops, > + }, > + .probe = gp2ap002_probe, > + .remove = gp2ap002_remove, > + .id_table = gp2ap002_id_table, > +}; > +module_i2c_driver(gp2ap002_driver); > + > +MODULE_AUTHOR("Linus Walleij <linus.walleij@linaro.org>"); > +MODULE_DESCRIPTION("GP2AP002 ambient light and proximity sensor driver"); > +MODULE_LICENSE("GPL v2");
On Thu, 2 Jan 2020 14:15:33 -0800 Dmitry Torokhov <dmitry.torokhov@gmail.com> wrote: > Hi Jonathan, > > On Mon, Dec 30, 2019 at 05:39:19PM +0000, Jonathan Cameron wrote: > > On Sat, 28 Dec 2019 21:11:09 +0100 > > Linus Walleij <linus.walleij@linaro.org> wrote: > > > > > + /* Enable chip and IRQ, disable analog sleep */ > > > + ret = regmap_write(gp2ap002->map, GP2AP002_OPMOD, > > > + OPMOD_SSD_OPERATING | OPMOD_VCON_IRQ); > > > + if (ret < 0) { > > > + dev_err(gp2ap002->dev, "error setting up operation mode\n"); > > > + return ret; > > > + } > > > + > > > + /* Interrupt on VOUT enabled */ > > > + ret = regmap_write(gp2ap002->map, GP2AP002_CON, CON_OCON_ENABLE); > > > + if (ret < 0) { > > > + dev_err(gp2ap002->dev, "error setting up VOUT control\n"); > > > + return ret; > > > > drop this return ret out of the brackets as it's either 0 or negative anyway. > > Not my subsystem, but $0.02 anyways: I like calling the temp as "error" > and explicitly return 0 in the success path even if it could be > collapsed, as you can easily add more initialization without needing > to go and alter previous blocks. That's a perfectly valid method as long as ret is only ever an error (or good). We've tended to go with ret in IIO, so better to carry on with that. I'm not that fussed about dropping the return ret; out, but definitely prefer explicit if (ret) to make it clear ret is never positive in the good path though. Thanks, Jonathan > > Thanks. >
Hi Jonathan, fixed most of the things and resending as v2 soon-ish, some inline responses, comments: On Mon, Dec 30, 2019 at 6:39 PM Jonathan Cameron <jic23@kernel.org> wrote: > On Sat, 28 Dec 2019 21:11:09 +0100 Linus Walleij <linus.walleij@linaro.org> wrote: > If at all possible I'd like to discourage use of of specific > calls in favour of the generic ones. It's pretty unlikely we'll > ever see this driver using anything else, but I'd like to build > up a good set of examples to point people at now that functionality > is in place. I guess you mean to use fwnode where possible. I comment on this below. > > + iio_push_event(indio_dev, ev, iio_get_time_ns(indio_dev)); > > + usleep_range(20000, 30000); > > What is the basis for these timings? Detection cycle, I explained this with an inline comment. > > + gp2ap002->is_gp2ap002s00f = > > + of_device_is_compatible(np, "sharp,gp2ap002s00f"); > > Hmm. This rather breaks my comment below about trying to avoid making > this of specific if we don't need to... > > I 'think' we could use device_property_read_string > There is a bit of precedence for doing so, but it is not common. This is the real trick. Using device_property_read_string(dev, "compatible", str); isn't going to work as ACPI probes from a unique 4-char ID not a compatible string this will never work on ACPI anyways. I can try to go some extra mile to support a hypothetical ACPI client by adding a struct with one bool member as match data and pass that around if you insist, but I think it's more something appropriate for the first ACPI user to do. It's no problem if you want it, but it will add a bunch of boilerplate just for this. > > + /* Check the device tree for the IR LED hysteresis */ > > + ret = of_property_read_u32(np, "sharp,proximity-far-hysteresis", &val); > > Do these belong in DT at all, or are they more of a policy decision? > Without a datasheet I'm kind of guessing what they actually are. There is a datasheet: https://global.sharp/products/device-china/lineup/data/pdf/datasheet/gp2ap002s00f_appl_e.pdf > We have the option for hysterisis controls on events from sysfs if that > make sense. I don't know, these are two hysteresis settings: one that detects an object close to the sensor and one detecting an object far from the sensor. The two settings are describes as fixed to mode A, B1 and B2 in the datasheet. However there is a vendor driver in one of the phone trees that use "mode B 1.5" not documented in the datasheet (bummer). So given how fluid this all is I opted for just an u8 in the device tree for "close" and "far" hysteresis setting. > Could use the fwnode_get_property_u32 etc to drop reliance on OF. Will do if we must support hypotetical non-DT probe. > > + /* The GP2AP002A00F has a light sensor too */ > > + if (!gp2ap002->is_gp2ap002s00f) { > > This section is rather 'unusual' and definitely needs some explanatory > comments - particularly as I can't find any reference docs for the part. The only reference for the light sensor part in GP2AP002A00F is the submission from Samsung mentioned in the header of the driver submitted by Donggeun Kim & Minkyu Kang in 2011: https://lore.kernel.org/lkml/1315556546-7445-1-git-send-email-dg77.kim@samsung.com/ It also appears in the GPL code from GT-S7710 which seems to derive from a code drop from Sharp. Yep the code is the documentation... > I'm guessing that the light sensor is simply an analog output? As such > you need to wire it up to a separate ADC to actually read the light level... Yep that's the same method as used for drivers/iio/light/cm3605.c Most early Androids do something like that, and all SoCs seem to provide some ADC to do the conversion. Yours, Linus Walleij
On Mon, 6 Jan 2020 10:08:55 +0100 Linus Walleij <linus.walleij@linaro.org> wrote: > Hi Jonathan, > > fixed most of the things and resending as v2 soon-ish, > some inline responses, comments: > > On Mon, Dec 30, 2019 at 6:39 PM Jonathan Cameron <jic23@kernel.org> wrote: > > On Sat, 28 Dec 2019 21:11:09 +0100 Linus Walleij <linus.walleij@linaro.org> wrote: > > > If at all possible I'd like to discourage use of of specific > > calls in favour of the generic ones. It's pretty unlikely we'll > > ever see this driver using anything else, but I'd like to build > > up a good set of examples to point people at now that functionality > > is in place. > > I guess you mean to use fwnode where possible. I comment on this > below. yes, though more specifically PRP0001 usage, which basically puts the DT directly into ACPI. > > > > + iio_push_event(indio_dev, ev, iio_get_time_ns(indio_dev)); > > > + usleep_range(20000, 30000); > > > > What is the basis for these timings? > > Detection cycle, I explained this with an inline comment. > > > > + gp2ap002->is_gp2ap002s00f = > > > + of_device_is_compatible(np, "sharp,gp2ap002s00f"); > > > > Hmm. This rather breaks my comment below about trying to avoid making > > this of specific if we don't need to... > > > > I 'think' we could use device_property_read_string > > There is a bit of precedence for doing so, but it is not common. > > This is the real trick. Using > device_property_read_string(dev, "compatible", str); > isn't going to work as ACPI probes from a unique 4-char > ID not a compatible string this will never work on ACPI > anyways. Is that true for PRP0001? That's the ACPI case we normally care about in cases like this. https://lkml.org/lkml/2019/3/22/1612 Has an explicit "compatible" property. > > I can try to go some extra mile to support a hypothetical > ACPI client by adding a struct with one bool member as > match data and pass that around if you insist, but I think it's > more something appropriate for the first ACPI user to do. > > It's no problem if you want it, but it will add a bunch of > boilerplate just for this. > > > > + /* Check the device tree for the IR LED hysteresis */ > > > + ret = of_property_read_u32(np, "sharp,proximity-far-hysteresis", &val); > > > > Do these belong in DT at all, or are they more of a policy decision? > > Without a datasheet I'm kind of guessing what they actually are. > > There is a datasheet: > https://global.sharp/products/device-china/lineup/data/pdf/datasheet/gp2ap002s00f_appl_e.pdf > > > We have the option for hysterisis controls on events from sysfs if that > > make sense. > > I don't know, these are two hysteresis settings: one that detects an > object close to the sensor and one detecting an object far from > the sensor. > > The two settings are describes as fixed to mode A, B1 and B2 in the > datasheet. However there is a vendor driver in one of the phone > trees that use "mode B 1.5" not documented in the datasheet > (bummer). So given how fluid this all is I opted for just an u8 > in the device tree for "close" and "far" hysteresis setting. OK, lets leave this, but maybe add a comment somewhere to give this bit of detail. > > > Could use the fwnode_get_property_u32 etc to drop reliance on OF. > > Will do if we must support hypotetical non-DT probe. > > > > + /* The GP2AP002A00F has a light sensor too */ > > > + if (!gp2ap002->is_gp2ap002s00f) { > > > > This section is rather 'unusual' and definitely needs some explanatory > > comments - particularly as I can't find any reference docs for the part. > > The only reference for the light sensor part in GP2AP002A00F > is the submission from Samsung mentioned in the header of the > driver submitted by Donggeun Kim & Minkyu Kang in 2011: > https://lore.kernel.org/lkml/1315556546-7445-1-git-send-email-dg77.kim@samsung.com/ > > It also appears in the GPL code from GT-S7710 which seems to > derive from a code drop from Sharp. > > Yep the code is the documentation... :( > > > I'm guessing that the light sensor is simply an analog output? As such > > you need to wire it up to a separate ADC to actually read the light level... > > Yep that's the same method as used for > drivers/iio/light/cm3605.c > Most early Androids do something like that, and all SoCs seem to > provide some ADC to do the conversion. > Fair enough, a few more comments perhaps in the code for when we inevitably forget all this history ;) Thanks, Jonathan > Yours, > Linus Walleij
diff --git a/MAINTAINERS b/MAINTAINERS index 1372b4139ebd..dbd4236fc7f5 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -14893,6 +14893,14 @@ W: http://www.ibm.com/developerworks/linux/linux390/ S: Supported F: net/smc/ +SHARP GP2AP002A00F/GP2AP002S00F SENSOR DRIVER +M: Linus Walleij <linus.walleij@linaro.org> +L: linux-iio@vger.kernel.org +T: git git://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git +S: Maintained +F: drivers/iio/light/gp2ap002.c +F: Documentation/devicetree/bindings/iio/light/sharp,gp2ap002.yaml + SHARP RJ54N1CB0C SENSOR DRIVER M: Jacopo Mondi <jacopo@jmondi.org> L: linux-media@vger.kernel.org diff --git a/drivers/iio/light/Kconfig b/drivers/iio/light/Kconfig index 9968f982fbc7..8b93b2a78b47 100644 --- a/drivers/iio/light/Kconfig +++ b/drivers/iio/light/Kconfig @@ -159,6 +159,19 @@ config IIO_CROS_EC_LIGHT_PROX To compile this driver as a module, choose M here: the module will be called cros_ec_light_prox. +config GP2AP002 + tristate "Sharp GP2AP002 Proximity/ALS sensor" + depends on I2C + select REGMAP + select IIO_BUFFER + select IIO_TRIGGERED_BUFFER + help + Say Y here if you have a Sharp GP2AP002 proximity/ALS combo-chip + hooked to an I2C bus. + + To compile this driver as a module, choose M here: the + module will be called gp2ap002. + config GP2AP020A00F tristate "Sharp GP2AP020A00F Proximity/ALS sensor" depends on I2C diff --git a/drivers/iio/light/Makefile b/drivers/iio/light/Makefile index c98d1cefb861..264a76039006 100644 --- a/drivers/iio/light/Makefile +++ b/drivers/iio/light/Makefile @@ -18,6 +18,7 @@ obj-$(CONFIG_CM3323) += cm3323.o obj-$(CONFIG_CM3605) += cm3605.o obj-$(CONFIG_CM36651) += cm36651.o obj-$(CONFIG_IIO_CROS_EC_LIGHT_PROX) += cros_ec_light_prox.o +obj-$(CONFIG_GP2AP002) += gp2ap002.o obj-$(CONFIG_GP2AP020A00F) += gp2ap020a00f.o obj-$(CONFIG_HID_SENSOR_ALS) += hid-sensor-als.o obj-$(CONFIG_HID_SENSOR_PROX) += hid-sensor-prox.o diff --git a/drivers/iio/light/gp2ap002.c b/drivers/iio/light/gp2ap002.c new file mode 100644 index 000000000000..98553041d63c --- /dev/null +++ b/drivers/iio/light/gp2ap002.c @@ -0,0 +1,679 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * These are the two Sharp GP2AP002 variants supported by this driver: + * GP2AP002A00F Ambient Light and Proximity Sensor + * GP2AP002S00F Proximity Sensor + * + * Copyright (C) 2019 Linaro Ltd. + * Author: Linus Walleij <linus.walleij@linaro.org> + * + * Based partly on the code in Sony Ericssons GP2AP00200F driver by + * Courtney Cavin and Oskar Andero in drivers/input/misc/gp2ap002a00f.c + * Based partly on a Samsung misc driver submitted by + * Donggeun Kim & Minkyu Kang in 2011: + * https://lore.kernel.org/lkml/1315556546-7445-1-git-send-email-dg77.kim@samsung.com/ + * Based partly on a submission by + * Jonathan Bakker and Paweł Chmiel in january 2019: + * https://lore.kernel.org/linux-input/20190125175045.22576-1-pawel.mikolaj.chmiel@gmail.com/ + * Based partly on code from the Samsung GT-S7710 by <mjchen@sta.samsung.com> + * Based partly on the code in LG Electronics GP2AP00200F driver by + * Kenobi Lee <sungyoung.lee@lge.com> and EunYoung Cho <ey.cho@lge.com> + */ +#include <linux/module.h> +#include <linux/i2c.h> +#include <linux/regmap.h> +#include <linux/iio/iio.h> +#include <linux/iio/sysfs.h> +#include <linux/iio/events.h> +#include <linux/iio/consumer.h> /* To get our ADC channel */ +#include <linux/iio/types.h> /* To deal with our ADC channel */ +#include <linux/init.h> +#include <linux/delay.h> +#include <linux/of.h> +#include <linux/regulator/consumer.h> +#include <linux/interrupt.h> +#include <linux/bits.h> +#include <linux/math64.h> +#include <linux/pm.h> + +#define GP2AP002_PROX_CHANNEL 0 +#define GP2AP002_ALS_CHANNEL 1 + +/* ------------------------------------------------------------------------ */ +/* ADDRESS SYMBOL DATA Init R/W */ +/* D7 D6 D5 D4 D3 D2 D1 D0 */ +/* ------------------------------------------------------------------------ */ +/* 0 PROX X X X X X X X VO H'00 R */ +/* 1 GAIN X X X X LED0 X X X H'00 W */ +/* 2 HYS HYSD HYSC1 HYSC0 X HYSF3 HYSF2 HYSF1 HYSF0 H'00 W */ +/* 3 CYCLE X X CYCL2 CYCL1 CYCL0 OSC2 X X H'00 W */ +/* 4 OPMOD X X X ASD X X VCON SSD H'00 W */ +/* 6 CON X X X OCON1 OCON0 X X X H'00 W */ +/* ------------------------------------------------------------------------ */ +/* VO :Proximity sensing result(0: no detection, 1: detection) */ +/* LED0 :Select switch for LED driver's On-registence(0:2x higher, 1:normal)*/ +/* HYSD/HYSF :Adjusts the receiver sensitivity */ +/* OSC :Select switch internal clocl frequency hoppling(0:effective) */ +/* CYCL :Determine the detection cycle(typically 8ms, up to 128x) */ +/* SSD :Software Shutdown function(0:shutdown, 1:operating) */ +/* VCON :VOUT output method control(0:normal, 1:interrupt) */ +/* ASD :Select switch for analog sleep function(0:ineffective, 1:effective)*/ +/* OCON :Select switch for enabling/disabling VOUT (00:enable, 11:disable) */ + +#define GP2AP002_PROX 0x00 +#define GP2AP002_GAIN 0x01 +#define GP2AP002_HYS 0x02 +#define GP2AP002_CYCLE 0x03 +#define GP2AP002_OPMOD 0x04 +#define GP2AP002_CON 0x06 + +#define PROX_VO_DETECT BIT(0) + +/* Setting this bit to 0 means 2x higher LED resistance */ +#define GAIN_LED_NORMAL BIT(3) + +/* + * These bits adjusts the proximity sensitivity, determining characteristics + * of the detection distance and its hysteresis. + */ +#define HYS_HYSD_SHIFT 7 +#define HYS_HYSD_MASK (0x1 << HYS_HYSD_SHIFT) +#define HYS_HYSC_SHIFT 5 +#define HYS_HYSC_MASK (0x3 << HYS_HYSC_SHIFT) +#define HYS_HYSF_SHIFT 0 +#define HYS_HYSF_MASK (0xf << HYS_HYSF_SHIFT) +#define HYS_MASK (HYS_HYSD_MASK | HYS_HYSC_MASK | HYS_HYSF_MASK) + +/* + * These values determine the detection cycle response time + * 0: 8ms, 1: 16ms, 2: 32ms, 3: 64ms, 4: 128ms, + * 5: 256ms, 6: 512ms, 7: 1024ms + */ +#define CYCLE_CYCL_SHIFT 3 +#define CYCLE_CYCL_MASK (0x7 << CYCLE_CYCL_SHIFT) +/* + * Select switch for internal clock frequency hopping + * 0: effective, + * 1: ineffective + */ +#define CYCLE_OSC_EFFECTIVE 0 +#define CYCLE_OSC_INEFFECTIVE BIT(2) +#define CYCLE_OSC_MASK BIT(2) + +/* Analog sleep effective */ +#define OPMOD_ASD BIT(4) +/* Enable chip */ +#define OPMOD_SSD_OPERATING BIT(0) +/* IRQ mode */ +#define OPMOD_VCON_IRQ BIT(1) +#define OPMOD_MASK (BIT(0) | BIT(1) | BIT(4)) + +/* + * Select switch for enabling/disabling Vout pin + * 0: enable + * 2: force to go Low + * 3: force to go High + */ +#define CON_OCON_SHIFT 3 +#define CON_OCON_ENABLE (0x0 << CON_OCON_SHIFT) +#define CON_OCON_LOW (0x2 << CON_OCON_SHIFT) +#define CON_OCON_HIGH (0x3 << CON_OCON_SHIFT) +#define CON_OCON_MASK (0x3 << CON_OCON_SHIFT) + +/** + * struct gp2ap002 - GP2AP002 state + * @map: regmap pointer for the i2c regmap + * @dev: pointer to parent device + * @vdd: regulator controlling VDD + * @vio: regulator controlling VIO + * @alsout: IIO ADC channel to convert the ALSOUT signal + * @is_gp2ap002s00f: this is the GP2AP002F variant of the chip + */ +struct gp2ap002 { + struct regmap *map; + struct device *dev; + struct regulator *vdd; + struct regulator *vio; + struct iio_channel *alsout; + enum iio_event_direction dir; + u8 hys_far; + u8 hys_close; + bool is_gp2ap002s00f; +}; + +static irqreturn_t gp2ap002_prox_irq(int irq, void *d) +{ + struct iio_dev *indio_dev = d; + struct gp2ap002 *gp2ap002 = iio_priv(indio_dev); + u64 ev; + int val; + int ret; + + ret = regmap_read(gp2ap002->map, GP2AP002_PROX, &val); + if (val & PROX_VO_DETECT) { + /* Close */ + dev_dbg(gp2ap002->dev, "close\n"); + ret = regmap_write(gp2ap002->map, GP2AP002_HYS, + gp2ap002->hys_far); + if (ret < 0) + dev_err(gp2ap002->dev, + "error setting up proximity hysteresis\n"); + ev = IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, GP2AP002_PROX_CHANNEL, + IIO_EV_TYPE_THRESH, IIO_EV_DIR_RISING); + } else { + /* Far */ + dev_dbg(gp2ap002->dev, "far\n"); + ret = regmap_write(gp2ap002->map, GP2AP002_HYS, + gp2ap002->hys_close); + if (ret < 0) + dev_err(gp2ap002->dev, + "error setting up proximity hysteresis\n"); + ev = IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, GP2AP002_PROX_CHANNEL, + IIO_EV_TYPE_THRESH, IIO_EV_DIR_FALLING); + } + iio_push_event(indio_dev, ev, iio_get_time_ns(indio_dev)); + usleep_range(20000, 30000); + ret = regmap_write(gp2ap002->map, GP2AP002_CON, CON_OCON_ENABLE); + if (ret < 0) + dev_err(gp2ap002->dev, "error setting up VOUT control\n"); + + return IRQ_HANDLED; +} + +struct gp2ap002_illuminance { + unsigned int curr; + unsigned int lux; +}; + +/* + * This array maps current and lux. + * + * Ambient light sensing range is 3 to 55000 lux. + * + * This mapping is based on the following formula. + * illuminance = 10 ^ (current / 10) + */ +const struct gp2ap002_illuminance gp2ap002_illuminance_table[] = { + { .curr = 5, .lux = 3 }, + { .curr = 6, .lux = 4 }, + { .curr = 7, .lux = 5 }, + { .curr = 8, .lux = 6 }, + { .curr = 9, .lux = 8 }, + { .curr = 10, .lux = 10 }, + { .curr = 11, .lux = 12 }, + { .curr = 12, .lux = 16 }, + { .curr = 13, .lux = 20 }, + { .curr = 14, .lux = 25 }, + { .curr = 15, .lux = 32 }, + { .curr = 16, .lux = 40 }, + { .curr = 17, .lux = 50 }, + { .curr = 18, .lux = 63 }, + { .curr = 19, .lux = 79 }, + { .curr = 20, .lux = 100 }, + { .curr = 21, .lux = 126 }, + { .curr = 22, .lux = 158 }, + { .curr = 23, .lux = 200 }, + { .curr = 24, .lux = 251 }, + { .curr = 25, .lux = 316 }, + { .curr = 26, .lux = 398 }, + { .curr = 27, .lux = 501 }, + { .curr = 28, .lux = 631 }, + { .curr = 29, .lux = 794 }, + { .curr = 30, .lux = 1000 }, + { .curr = 31, .lux = 1259 }, + { .curr = 32, .lux = 1585 }, + { .curr = 33, .lux = 1995 }, + { .curr = 34, .lux = 2512 }, + { .curr = 35, .lux = 3162 }, + { .curr = 36, .lux = 3981 }, + { .curr = 37, .lux = 5012 }, + { .curr = 38, .lux = 6310 }, + { .curr = 39, .lux = 7943 }, + { .curr = 40, .lux = 10000 }, + { .curr = 41, .lux = 12589 }, + { .curr = 42, .lux = 15849 }, + { .curr = 43, .lux = 19953 }, + { .curr = 44, .lux = 25119 }, + { .curr = 45, .lux = 31623 }, + { .curr = 46, .lux = 39811 }, + { .curr = 47, .lux = 50119 }, +}; + +static int gp2ap002_get_lux(struct gp2ap002 *gp2ap002) +{ + const struct gp2ap002_illuminance *ill1; + const struct gp2ap002_illuminance *ill2; + int ret, res; + int i; + + ret = iio_read_channel_processed(gp2ap002->alsout, &res); + if (ret < 0) + return ret; + + dev_dbg(gp2ap002->dev, "read %d mA from ADC\n", res); + + ill1 = &gp2ap002_illuminance_table[0]; + if (res < ill1->curr) { + dev_dbg(gp2ap002->dev, "total darkness\n"); + return 0; + } + for (i = 0; i < ARRAY_SIZE(gp2ap002_illuminance_table) - 1; i++) { + ill1 = &gp2ap002_illuminance_table[i]; + ill2 = &gp2ap002_illuminance_table[i+1]; + + if (res > ill2->curr) + continue; + if ((res <= ill1->curr) && (res >= ill2->curr)) + break; + } + if (res > ill2->curr) { + dev_info_once(gp2ap002->dev, "max current overflow\n"); + return ill2->curr; + } + /* Interpolate and return */ + dev_info(gp2ap002->dev, "interpolate index %d and %d\n", i, i + 1); + /* How many steps along the curve */ + i = res - ill1->curr; /* x - x0 */ + /* Linear interpolation */ + return ill1->lux + i * + ((ill2->lux - ill1->lux) / (ill2->curr - ill1->curr)); +} + +static int gp2ap002_read_raw(struct iio_dev *indio_dev, + struct iio_chan_spec const *chan, + int *val, int *val2, long mask) +{ + struct gp2ap002 *gp2ap002 = iio_priv(indio_dev); + int ret; + + switch (mask) { + case IIO_CHAN_INFO_RAW: + switch (chan->type) { + case IIO_LIGHT: + ret = gp2ap002_get_lux(gp2ap002); + if (ret < 0) + return ret; + *val = ret; + return IIO_VAL_INT; + default: + return -EINVAL; + } + default: + return -EINVAL; + } +} + +static const struct iio_info gp2ap002_info = { + .read_raw = gp2ap002_read_raw, +}; + +static const struct iio_event_spec gp2ap002_events[] = { + { + .type = IIO_EV_TYPE_THRESH, + .dir = IIO_EV_DIR_EITHER, + .mask_separate = BIT(IIO_EV_INFO_ENABLE), + }, +}; + +static const struct iio_chan_spec gp2ap002_channels[] = { + { + .type = IIO_PROXIMITY, + .event_spec = gp2ap002_events, + .num_event_specs = ARRAY_SIZE(gp2ap002_events), + }, + { + .type = IIO_LIGHT, + .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), + .channel = GP2AP002_ALS_CHANNEL, + }, +}; + +/* + * We need a special regmap because this hardware expects to + * write single bytes to registers but read a 16bit word on some + * variants and discard the lower 8 bits so combine + * i2c_smbus_read_word_data() with i2c_smbus_write_byte_data() + * selectively like this. + */ +static int gp2ap002a00f_regmap_i2c_read(void *context, unsigned int reg, + unsigned int *val) +{ + struct device *dev = context; + struct i2c_client *i2c = to_i2c_client(dev); + int ret; + + ret = i2c_smbus_read_byte_data(i2c, reg); + if (ret < 0) + return ret; + *val = ret & 0xff; + + return 0; +} + +static int gp2ap002s00f_regmap_i2c_read(void *context, unsigned int reg, + unsigned int *val) +{ + struct device *dev = context; + struct i2c_client *i2c = to_i2c_client(dev); + int ret; + + ret = i2c_smbus_read_word_data(i2c, reg); + if (ret < 0) + return ret; + + *val = (ret >> 8) & 0xFF; + + return 0; +} + +static int gp2ap002_regmap_i2c_write(void *context, unsigned int reg, + unsigned int val) +{ + struct device *dev = context; + struct i2c_client *i2c = to_i2c_client(dev); + + return i2c_smbus_write_byte_data(i2c, reg, val); +} + +static struct regmap_bus gp2ap002_regmap_bus = { + .reg_write = gp2ap002_regmap_i2c_write, +}; + + +static int gp2ap002_init(struct gp2ap002 *gp2ap002) +{ + int ret; + + /* Set up the IR LED resistance */ + ret = regmap_write(gp2ap002->map, GP2AP002_GAIN, GAIN_LED_NORMAL); + if (ret < 0) { + dev_err(gp2ap002->dev, "error setting up LED gain\n"); + return ret; + } + ret = regmap_write(gp2ap002->map, GP2AP002_HYS, gp2ap002->hys_far); + if (ret < 0) { + dev_err(gp2ap002->dev, + "error setting up proximity hysteresis\n"); + return ret; + } + + /* Disable internal frequency hopping */ + ret = regmap_write(gp2ap002->map, GP2AP002_CYCLE, + CYCLE_OSC_INEFFECTIVE); + if (ret < 0) { + dev_err(gp2ap002->dev, + "error setting up internal frequency hopping\n"); + return ret; + } + + /* Enable chip and IRQ, disable analog sleep */ + ret = regmap_write(gp2ap002->map, GP2AP002_OPMOD, + OPMOD_SSD_OPERATING | OPMOD_VCON_IRQ); + if (ret < 0) { + dev_err(gp2ap002->dev, "error setting up operation mode\n"); + return ret; + } + + /* Interrupt on VOUT enabled */ + ret = regmap_write(gp2ap002->map, GP2AP002_CON, CON_OCON_ENABLE); + if (ret < 0) { + dev_err(gp2ap002->dev, "error setting up VOUT control\n"); + return ret; + } + + return 0; +} + +static int gp2ap002_probe(struct i2c_client *client, + const struct i2c_device_id *id) +{ + struct gp2ap002 *gp2ap002; + struct iio_dev *indio_dev; + struct device *dev = &client->dev; + struct device_node *np = dev->of_node; + enum iio_chan_type ch_type; + static const struct regmap_config config = { + .reg_bits = 8, + .val_bits = 8, + .max_register = GP2AP002_CON, + }; + struct regmap *regmap; + int num_chan; + u32 val; + int ret; + + indio_dev = devm_iio_device_alloc(dev, sizeof(*gp2ap002)); + if (!indio_dev) + return -ENOMEM; + i2c_set_clientdata(client, indio_dev); + + gp2ap002 = iio_priv(indio_dev); + gp2ap002->dev = dev; + + gp2ap002->is_gp2ap002s00f = + of_device_is_compatible(np, "sharp,gp2ap002s00f"); + if (gp2ap002->is_gp2ap002s00f) + gp2ap002_regmap_bus.reg_read = gp2ap002s00f_regmap_i2c_read; + else + gp2ap002_regmap_bus.reg_read = gp2ap002a00f_regmap_i2c_read; + + regmap = devm_regmap_init(dev, &gp2ap002_regmap_bus, dev, &config); + if (IS_ERR(regmap)) { + dev_err(dev, "Failed to register i2c regmap %d\n", + (int)PTR_ERR(regmap)); + return PTR_ERR(regmap); + } + gp2ap002->map = regmap; + + /* Check the device tree for the IR LED hysteresis */ + ret = of_property_read_u32(np, "sharp,proximity-far-hysteresis", &val); + if (ret) { + dev_err(dev, "missing proximity far setting\n"); + return -EINVAL; + } + if (val > 0xFF) { + dev_err(dev, "illegal proximity far setting\n"); + return -EINVAL; + } + gp2ap002->hys_far = val; + ret = of_property_read_u32(np, "sharp,proximity-close-hysteresis", + &val); + if (ret) { + dev_err(dev, "missing proximity close setting\n"); + return -EINVAL; + } + if (val > 0xFF) { + dev_err(dev, "illegal proximity close setting\n"); + return -EINVAL; + } + gp2ap002->hys_close = val; + + /* The GP2AP002A00F has a light sensor too */ + if (!gp2ap002->is_gp2ap002s00f) { + gp2ap002->alsout = devm_iio_channel_get(dev, "alsout"); + if (IS_ERR(gp2ap002->alsout)) { + if (PTR_ERR(gp2ap002->alsout) == -ENODEV) { + dev_err(dev, "no ADC, deferring...\n"); + return -EPROBE_DEFER; + } + dev_err(dev, "failed to get ALSOUT ADC channel\n"); + return PTR_ERR(gp2ap002->alsout); + } + ret = iio_get_channel_type(gp2ap002->alsout, &ch_type); + if (ret < 0) + return ret; + if (ch_type != IIO_CURRENT) { + dev_err(dev, + "wrong type of IIO channel specified for ALSOUT\n"); + return -EINVAL; + } + } + + gp2ap002->vdd = devm_regulator_get(dev, "vdd"); + if (IS_ERR(gp2ap002->vdd)) { + dev_err(dev, "failed to get VDD regulator\n"); + return PTR_ERR(gp2ap002->vdd); + } + gp2ap002->vio = devm_regulator_get(dev, "vio"); + if (IS_ERR(gp2ap002->vio)) { + dev_err(dev, "failed to get VIO regulator\n"); + return PTR_ERR(gp2ap002->vio); + } + + /* Operating voltage 2.4V .. 3.6V according to datasheet */ + ret = regulator_set_voltage(gp2ap002->vdd, 2400000, 3600000); + if (ret) { + dev_err(dev, "failed to sett VDD voltage\n"); + return ret; + } + /* VIO should be between 1.65V and VDD */ + ret = regulator_get_voltage(gp2ap002->vdd); + ret = regulator_set_voltage(gp2ap002->vio, 1650000, ret); + if (ret) { + dev_err(dev, "failed to sett VIO voltage\n"); + return ret; + } + + ret = regulator_enable(gp2ap002->vdd); + if (ret) { + dev_err(dev, "failed to enable VDD regulator\n"); + return ret; + } + ret = regulator_enable(gp2ap002->vio); + if (ret) { + dev_err(dev, "failed to enable VIO regulator\n"); + goto out_disable_vdd; + } + + msleep(20); + + ret = gp2ap002_init(gp2ap002); + if (ret) { + dev_err(dev, "initialization failed\n"); + goto out_disable_vio; + } + + ret = devm_request_threaded_irq(dev, client->irq, NULL, + gp2ap002_prox_irq, IRQF_ONESHOT, + "gp2ap002", indio_dev); + if (ret) { + dev_err(dev, "unable to request IRQ\n"); + goto out_disable_vio; + } + + indio_dev->dev.parent = dev; + indio_dev->info = &gp2ap002_info; + indio_dev->name = "gp2ap002"; + indio_dev->channels = gp2ap002_channels; + /* Skip light channel for the proximity-only sensor */ + num_chan = ARRAY_SIZE(gp2ap002_channels); + if (gp2ap002->is_gp2ap002s00f) + num_chan--; + indio_dev->num_channels = num_chan; + indio_dev->modes = INDIO_DIRECT_MODE; + + ret = iio_device_register(indio_dev); + if (ret) + goto out_disable_vio; + dev_info(dev, "Sharp GP2AP002 enabled\n"); + + return 0; + +out_disable_vio: + regulator_disable(gp2ap002->vio); +out_disable_vdd: + regulator_disable(gp2ap002->vdd); + return ret; +} + +static int gp2ap002_remove(struct i2c_client *client) +{ + struct iio_dev *indio_dev = i2c_get_clientdata(client); + struct gp2ap002 *gp2ap002 = iio_priv(indio_dev); + + iio_device_unregister(indio_dev); + regulator_disable(gp2ap002->vio); + regulator_disable(gp2ap002->vdd); + + return 0; +} + +static int __maybe_unused gp2ap002_pm_suspend(struct device *dev) +{ + struct iio_dev *indio_dev = dev_get_drvdata(dev); + struct gp2ap002 *gp2ap002 = iio_priv(indio_dev); + int ret; + + /* Disable chip and IRQ, everything off */ + ret = regmap_write(gp2ap002->map, GP2AP002_OPMOD, 0x00); + if (ret < 0) { + dev_err(gp2ap002->dev, "error setting up operation mode\n"); + return ret; + } + /* + * As these regulators may be shared, at least we are now in + * sleep even if the regulators aren't really turned off. + */ + regulator_disable(gp2ap002->vio); + regulator_disable(gp2ap002->vdd); + + return 0; +} + +static int __maybe_unused gp2ap002_pm_resume(struct device *dev) +{ + struct iio_dev *indio_dev = dev_get_drvdata(dev); + struct gp2ap002 *gp2ap002 = iio_priv(indio_dev); + int ret; + + ret = regulator_enable(gp2ap002->vdd); + if (ret) + dev_err(dev, "failed to enable VDD regulator in resume path\n"); + ret = regulator_enable(gp2ap002->vio); + if (ret) + dev_err(dev, "failed to enable VIO regulator in resume path\n"); + + msleep(20); + + ret = gp2ap002_init(gp2ap002); + if (ret) + dev_err(dev, "re-initialization failed\n"); + + return 0; +} + +static const struct dev_pm_ops gp2ap002_dev_pm_ops = { + SET_SYSTEM_SLEEP_PM_OPS(gp2ap002_pm_suspend, + gp2ap002_pm_resume) +}; + +static const struct i2c_device_id gp2ap002_id_table[] = { + { "gp2ap002", 0 }, + { }, +}; +MODULE_DEVICE_TABLE(i2c, gp2ap002_id); + +#ifdef CONFIG_OF +static const struct of_device_id gp2ap002_of_match[] = { + { .compatible = "sharp,gp2ap002a00f" }, + { .compatible = "sharp,gp2ap002s00f" }, + { }, +}; +MODULE_DEVICE_TABLE(of, gp2ap002_of_match); +#endif + +static struct i2c_driver gp2ap002_driver = { + .driver = { + .name = "gp2ap002", + .of_match_table = of_match_ptr(gp2ap002_of_match), + .pm = &gp2ap002_dev_pm_ops, + }, + .probe = gp2ap002_probe, + .remove = gp2ap002_remove, + .id_table = gp2ap002_id_table, +}; +module_i2c_driver(gp2ap002_driver); + +MODULE_AUTHOR("Linus Walleij <linus.walleij@linaro.org>"); +MODULE_DESCRIPTION("GP2AP002 ambient light and proximity sensor driver"); +MODULE_LICENSE("GPL v2");
This driver handles two different Sharp sensors that have been proposed for merging to the mainline kernel over the years, and already has a limited proximity-only driver in the input subsystem. These components are completely different from the confusingly similarly named Sharp GP2AP020A00F, for which we have a driver in drivers/iio/light/gp2ap020a00f.c The two components GP2AP002A00F and GP2AP002S00F are distinctively different but similar: they share the same set of registers but differ slightly in the I2C protocol. Instead of the approach by the previous input driver, we create a combined IIO proximity and light sensor driver. The plan is to merge this driver and delete the input driver. The pieces for the driver are picked all over the place after researching and grepping through a few different vendor trees and driver submissions. We merge it under the light sensors because: - It has similarities with the Capella CM3605 light sensor and proximity driver which is there. - It is related to the GP2AP020A00F driver which is also there. This driver was tested with the Samsung GT-S7710 mobile phone which has the GP2AP002S00F proximity sensor mounted. Cc: Stephan Gerhold <stephan@gerhold.net> Cc: Donggeun Kim <dg77.kim@samsung.com> Cc: Minkyu Kang <mk7.kang@samsung.com> Cc: Paweł Chmiel <pawel.mikolaj.chmiel@gmail.com> Cc: Jonathan Bakker <xc-racer2@live.ca> Cc: Oskar Andero <oskar.andero@gmail.com> Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com> Signed-off-by: Linus Walleij <linus.walleij@linaro.org> --- MAINTAINERS | 8 + drivers/iio/light/Kconfig | 13 + drivers/iio/light/Makefile | 1 + drivers/iio/light/gp2ap002.c | 679 +++++++++++++++++++++++++++++++++++ 4 files changed, 701 insertions(+) create mode 100644 drivers/iio/light/gp2ap002.c -- 2.21.0