^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * ACPI Ambient Light Sensor Driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Based on ALS driver:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (C) 2009 Zhang Rui <rui.zhang@intel.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * Rework for IIO subsystem:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * Copyright (C) 2012-2013 Martin Liska <marxin.liska@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) * Final cleanup and debugging:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) * Copyright (C) 2013-2014 Marek Vasut <marex@denx.de>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) * Copyright (C) 2015 Gabriele Mazzotta <gabriele.mzt@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <linux/acpi.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include <linux/err.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #include <linux/mutex.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #include <linux/iio/iio.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #include <linux/iio/buffer.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #include <linux/iio/kfifo_buf.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) #define ACPI_ALS_CLASS "als"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define ACPI_ALS_DEVICE_NAME "acpi-als"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #define ACPI_ALS_NOTIFY_ILLUMINANCE 0x80
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) ACPI_MODULE_NAME("acpi-als");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) * So far, there's only one channel in here, but the specification for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) * ACPI0008 says there can be more to what the block can report. Like
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) * chromaticity and such. We are ready for incoming additions!
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) static const struct iio_chan_spec acpi_als_channels[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) .type = IIO_LIGHT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) .scan_type = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) .sign = 's',
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) .realbits = 32,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) .storagebits = 32,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) /* _RAW is here for backward ABI compatibility */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) BIT(IIO_CHAN_INFO_PROCESSED),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) * The event buffer contains timestamp and all the data from
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) * the ACPI0008 block. There are multiple, but so far we only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) * support _ALI (illuminance). Once someone adds new channels
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) * to acpi_als_channels[], the evt_buffer below will grow
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) * automatically.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) #define ACPI_ALS_EVT_NR_SOURCES ARRAY_SIZE(acpi_als_channels)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) #define ACPI_ALS_EVT_BUFFER_SIZE \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) (sizeof(s64) + (ACPI_ALS_EVT_NR_SOURCES * sizeof(s32)))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) struct acpi_als {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) struct acpi_device *device;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) struct mutex lock;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) s32 evt_buffer[ACPI_ALS_EVT_BUFFER_SIZE];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) * All types of properties the ACPI0008 block can report. The ALI, ALC, ALT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) * and ALP can all be handled by acpi_als_read_value() below, while the ALR is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) * special.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) * The _ALR property returns tables that can be used to fine-tune the values
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) * reported by the other props based on the particular hardware type and it's
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) * location (it contains tables for "rainy", "bright inhouse lighting" etc.).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) * So far, we support only ALI (illuminance).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) #define ACPI_ALS_ILLUMINANCE "_ALI"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) #define ACPI_ALS_CHROMATICITY "_ALC"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) #define ACPI_ALS_COLOR_TEMP "_ALT"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) #define ACPI_ALS_POLLING "_ALP"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) #define ACPI_ALS_TABLES "_ALR"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) static int acpi_als_read_value(struct acpi_als *als, char *prop, s32 *val)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) unsigned long long temp_val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) acpi_status status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) status = acpi_evaluate_integer(als->device->handle, prop, NULL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) &temp_val);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) if (ACPI_FAILURE(status)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) ACPI_EXCEPTION((AE_INFO, status, "Error reading ALS %s", prop));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) return -EIO;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) *val = temp_val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) static void acpi_als_notify(struct acpi_device *device, u32 event)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) struct iio_dev *indio_dev = acpi_driver_data(device);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) struct acpi_als *als = iio_priv(indio_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) s32 *buffer = als->evt_buffer;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) s64 time_ns = iio_get_time_ns(indio_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) s32 val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) mutex_lock(&als->lock);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) memset(buffer, 0, ACPI_ALS_EVT_BUFFER_SIZE);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) switch (event) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) case ACPI_ALS_NOTIFY_ILLUMINANCE:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) ret = acpi_als_read_value(als, ACPI_ALS_ILLUMINANCE, &val);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) if (ret < 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) goto out;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) *buffer++ = val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) default:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) /* Unhandled event */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) dev_dbg(&device->dev, "Unhandled ACPI ALS event (%08x)!\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) event);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) goto out;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) iio_push_to_buffers_with_timestamp(indio_dev, als->evt_buffer, time_ns);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) out:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) mutex_unlock(&als->lock);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) static int acpi_als_read_raw(struct iio_dev *indio_dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) struct iio_chan_spec const *chan, int *val,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) int *val2, long mask)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) struct acpi_als *als = iio_priv(indio_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) s32 temp_val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) if ((mask != IIO_CHAN_INFO_PROCESSED) && (mask != IIO_CHAN_INFO_RAW))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) return -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) /* we support only illumination (_ALI) so far. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) if (chan->type != IIO_LIGHT)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) return -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) ret = acpi_als_read_value(als, ACPI_ALS_ILLUMINANCE, &temp_val);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) if (ret < 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) *val = temp_val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) return IIO_VAL_INT;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) static const struct iio_info acpi_als_info = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) .read_raw = acpi_als_read_raw,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) static int acpi_als_add(struct acpi_device *device)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) struct acpi_als *als;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) struct iio_dev *indio_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) struct iio_buffer *buffer;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) indio_dev = devm_iio_device_alloc(&device->dev, sizeof(*als));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) if (!indio_dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) als = iio_priv(indio_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) device->driver_data = indio_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) als->device = device;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) mutex_init(&als->lock);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) indio_dev->name = ACPI_ALS_DEVICE_NAME;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) indio_dev->info = &acpi_als_info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) indio_dev->modes = INDIO_BUFFER_SOFTWARE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) indio_dev->channels = acpi_als_channels;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) indio_dev->num_channels = ARRAY_SIZE(acpi_als_channels);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) buffer = devm_iio_kfifo_allocate(&device->dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) if (!buffer)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) iio_device_attach_buffer(indio_dev, buffer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) return devm_iio_device_register(&device->dev, indio_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) static const struct acpi_device_id acpi_als_device_ids[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) {"ACPI0008", 0},
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) {},
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) MODULE_DEVICE_TABLE(acpi, acpi_als_device_ids);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) static struct acpi_driver acpi_als_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) .name = "acpi_als",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) .class = ACPI_ALS_CLASS,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) .ids = acpi_als_device_ids,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) .ops = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) .add = acpi_als_add,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) .notify = acpi_als_notify,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) module_acpi_driver(acpi_als_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) MODULE_AUTHOR("Zhang Rui <rui.zhang@intel.com>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) MODULE_AUTHOR("Martin Liska <marxin.liska@gmail.com>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) MODULE_DESCRIPTION("ACPI Ambient Light Sensor Driver");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) MODULE_LICENSE("GPL");