dt-bindings: iio: light: ltrf216a: Document LTR-308 support
Subsystems (2)
PATCH v2 1/2 dt-bindings: iio: light: ltrf216a: Document LTR-308 support
Document LiteOn LTR-308 support in LTR-F216A bindings.
The two devices seem to have almost identical register map, except that the LTR-308 does not have three CLEAR_DATA registers, which are unused by this driver. Furthermore, LTR-308 and LTR-F216A use different lux calculation constants, 0.6 and 0.45 respectively.
https://optoelectronics.liteon.com/upload/download/DS86-2016-0027/LTR-308ALS_Final_%20DS_V1%201.pdf
https://optoelectronics.liteon.com/upload/download/DS86-2019-0016/LTR-F216A_Final_DS_V1.4.PDF
---
Cc: Conor Dooley <[email protected]>
Cc: Jonathan Cameron <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Lars-Peter Clausen <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Shreeya Patel <[email protected]>
Cc: [email protected]
Cc: [email protected]
--- .../devicetree/bindings/iio/light/liteon,ltrf216a.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/devicetree/bindings/iio/light/liteon,ltrf216a.yaml +3 -1
@@ -14,7 +14,9 @@ description: properties: compatible: - const: liteon,ltrf216a + enum: + - liteon,ltr308 + - liteon,ltrf216a reg: maxItems: 1
Signature · 1 line
2.43.0
PATCH v2 2/2 iio: light: ltrf216a: Add LTR-308 support
Add LiteOn LTR-308 support into LTR-F216A kernel driver.
The two devices seem to have almost identical register map, except that the LTR-308 does not have three CLEAR_DATA registers, which are unused by this driver. Furthermore, LTR-308 and LTR-F216A use different lux calculation constants, 0.6 and 0.45 respectively. Both differences are handled using chip info data.
https://optoelectronics.liteon.com/upload/download/DS86-2016-0027/LTR-308ALS_Final_%20DS_V1%201.pdf
https://optoelectronics.liteon.com/upload/download/DS86-2019-0016/LTR-F216A_Final_DS_V1.4.PDF
---
Cc: Conor Dooley <[email protected]>
Cc: Jonathan Cameron <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Lars-Peter Clausen <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Shreeya Patel <[email protected]>
Cc: [email protected]
Cc: [email protected]
---
V2: - Make chip info static const
- Document the missing registers as non-volatile
- Retain "ltr,ltrf216a" until the discussion whether to drop it or not gets sorted out
--- drivers/iio/light/ltrf216a.c | 53 +++++++++++++++++++++++++++++------- 1 file changed, 43 insertions(+), 10 deletions(-)
drivers/iio/light/ltrf216a.c +43 -10
@@ -68,6 +68,13 @@ static const int ltrf216a_int_time_reg[][2] = { { 25, 0x40 }, }; +struct ltr_chip_info { +/* Chip contains CLEAR_DATA_0/1/2 registers at offset 0xa..0xc */ +bool has_clear_data; +/* Lux calculation multiplier for ALS data */ +int lux_multiplier; +}; +/* * Window Factor is needed when the device is under Window glass * with coated tinted ink. This is to compensate for the light loss
@@ -79,6 +86,7 @@ static const int ltrf216a_int_time_reg[][2] = {struct ltrf216a_data {struct regmap *regmap;struct i2c_client *client; +const struct ltr_chip_info *info;u32 int_time;u16 int_time_fac;u8 als_gain_fac;
@@ -246,7 +254,7 @@ static int ltrf216a_get_lux(struct ltrf216a_data *data)ltrf216a_set_power_state (data, false); - lux = greendata *45 *LTRF216A_WIN_FAC ; + lux = greendata * data->info->lux_multiplier *LTRF216A_WIN_FAC ;return lux; }
@@ -334,15 +342,15 @@ static const struct iio_info ltrf216a_info = {static bool ltrf216a_readable_reg (struct device *dev,unsigned int reg) { +struct iio_dev *indio_dev =i2c_get_clientdata (to_i2c_client (dev)); +struct ltrf216a_data *data =iio_priv (indio_dev); +switch (reg) {case LTRF216A_MAIN_CTRL :case LTRF216A_ALS_MEAS_RES :case LTRF216A_ALS_GAIN :case LTRF216A_PART_ID :case LTRF216A_MAIN_STATUS : -case LTRF216A_ALS_CLEAR_DATA_0 : -case LTRF216A_ALS_CLEAR_DATA_1 : -case LTRF216A_ALS_CLEAR_DATA_2 :case LTRF216A_ALS_DATA_0 :case LTRF216A_ALS_DATA_1 :case LTRF216A_ALS_DATA_2 :
@@ -355,6 +363,10 @@ static bool ltrf216a_readable_reg(struct device *dev, unsigned int reg)case LTRF216A_ALS_THRES_LOW_1 :case LTRF216A_ALS_THRES_LOW_2 :return true; +case LTRF216A_ALS_CLEAR_DATA_0 : +case LTRF216A_ALS_CLEAR_DATA_1 : +case LTRF216A_ALS_CLEAR_DATA_2 : +return data->info->has_clear_data;default :return false; }
@@ -382,15 +394,23 @@ static bool ltrf216a_writable_reg(struct device *dev, unsigned int reg)static bool ltrf216a_volatile_reg (struct device *dev,unsigned int reg) { +struct iio_dev *indio_dev =i2c_get_clientdata (to_i2c_client (dev)); +struct ltrf216a_data *data =iio_priv (indio_dev); +switch (reg) {case LTRF216A_MAIN_STATUS : -case LTRF216A_ALS_CLEAR_DATA_0 : -case LTRF216A_ALS_CLEAR_DATA_1 : -case LTRF216A_ALS_CLEAR_DATA_2 :case LTRF216A_ALS_DATA_0 :case LTRF216A_ALS_DATA_1 :case LTRF216A_ALS_DATA_2 :return true; +/* +* If these registers are not present on a chip (like LTR-308), +* the missing registers are not considered volatile. +*/ +case LTRF216A_ALS_CLEAR_DATA_0 : +case LTRF216A_ALS_CLEAR_DATA_1 : +case LTRF216A_ALS_CLEAR_DATA_2 : +return data->info->has_clear_data;default :return false; }
@@ -433,6 +453,7 @@ static int ltrf216a_probe(struct i2c_client *client)i2c_set_clientdata (client, indio_dev); data->client = client; + data->info =i2c_get_match_data (client);mutex_init (&data->lock);
@@ -520,15 +541,27 @@ static int ltrf216a_runtime_resume(struct device *dev) static DEFINE_RUNTIME_DEV_PM_OPS(ltrf216a_pm_ops, ltrf216a_runtime_suspend, ltrf216a_runtime_resume, NULL); +static const struct ltr_chip_info ltr308_chip_info = { + .has_clear_data = false, + .lux_multiplier =60 , +}; + +static const struct ltr_chip_info ltrf216a_chip_info = { + .has_clear_data = true, + .lux_multiplier =45 , +}; +static const struct i2c_device_id ltrf216a_id[] = { - {"ltrf216a" }, + {"ltr308" , .driver_data = (kernel_ulong_t)<r308_chip_info }, + {"ltrf216a" , .driver_data = (kernel_ulong_t)<rf216a_chip_info }, {} };MODULE_DEVICE_TABLE (i2c, ltrf216a_id);static const struct of_device_id ltrf216a_of_match[] = { - { .compatible ="liteon,ltrf216a" }, - { .compatible ="ltr,ltrf216a" }, + { .compatible ="liteon,ltr308" , .data = <r308_chip_info }, + { .compatible ="liteon,ltrf216a" , .data = <rf216a_chip_info }, + { .compatible ="ltr,ltrf216a" , .data = <rf216a_chip_info }, {} };MODULE_DEVICE_TABLE (of, ltrf216a_of_match);
Signature · 1 line
2.43.0
Quoted 10 lines · Marek Vasut
Document LiteOn LTR-308 support in LTR-F216A bindings.
The two devices seem to have almost identical register map, except that the LTR-308 does not have three
CLEAR_DATAregisters, which are unused by this driver. Furthermore, LTR-308 and LTR-F216A use different lux calculation constants, 0.6 and 0.45 respectively.https://optoelectronics.liteon.com/upload/download/DS86-2016-0027/LTR-308ALS_Final_%20DS_V1%201.pdf
https://optoelectronics.liteon.com/upload/download/DS86-2019-0016/LTR-F216A_Final_DS_V1.4.PDF
Best regards,
Krzysztof
Jonathan Cameron
maintainerQuoted 8 lines · On Tue, 9 Jul 2024 10:26:17 +0200 Krzysztof Kozlowski <[email protected]> wrote:
Quoted 7 lines · Marek Vasut
Document LiteOn LTR-308 support in LTR-F216A bindings.
The two devices seem to have almost identical register map, except that the LTR-308 does not have three
CLEAR_DATAregisters, which are unused by this driver. Furthermore, LTR-308 and LTR-F216A use different lux calculation constants, 0.6 and 0.45 respectively.
Quoted 5 lines
Applied to the testing branch of iio.git which will get rebase on rc1 once available.
One minor request for future series. For any multipatch series it's helpful to have a cover letter even if there isn't a lot to say. It always provides 2 things that are useful:
1) A title for the series in patchwork.
2) A place for people to give tags for the whole series in a fashion that automation like b4 can pick up.
Anyhow, not important for a 2 patch series, but a nice to have!
Jonathan
Quoted 4 lines
Best regards,
Krzysztof
Quoted 16 lines · Jonathan Cameron
Quoted 8 lines · On Tue, 9 Jul 2024 10:26:17 +0200 Krzysztof Kozlowski <[email protected]> wrote:
Quoted 7 lines · Marek Vasut
Document LiteOn LTR-308 support in LTR-F216A bindings.
The two devices seem to have almost identical register map, except that the LTR-308 does not have three
CLEAR_DATAregisters, which are unused by this driver. Furthermore, LTR-308 and LTR-F216A use different lux calculation constants, 0.6 and 0.45 respectively.
Quoted 8 lines
Applied to the testing branch of iio.git which will get rebase on rc1 once available.
One minor request for future series. For any multipatch series it's helpful to have a cover letter even if there isn't a lot to say. It always provides 2 things that are useful:
1) A title for the series in patchwork.
2) A place for people to give tags for the whole series in a fashion that automation like b4 can pick up.
ACK, I really should work on the cover letters, not just here, thanks for the reminder.