^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright 2017 Analog Devices Inc.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Author: Lars-Peter Clausen <lars@metafoo.de>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) #include <linux/err.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #include <linux/export.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/iio/iio.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/iio/consumer.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/iio/hw-consumer.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/iio/buffer_impl.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) * struct iio_hw_consumer - IIO hw consumer block
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) * @buffers: hardware buffers list head.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) * @channels: IIO provider channels.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) struct iio_hw_consumer {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) struct list_head buffers;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) struct iio_channel *channels;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) struct hw_consumer_buffer {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) struct list_head head;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) struct iio_dev *indio_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) struct iio_buffer buffer;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) long scan_mask[];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) static struct hw_consumer_buffer *iio_buffer_to_hw_consumer_buffer(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) struct iio_buffer *buffer)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) return container_of(buffer, struct hw_consumer_buffer, buffer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) static void iio_hw_buf_release(struct iio_buffer *buffer)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) struct hw_consumer_buffer *hw_buf =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) iio_buffer_to_hw_consumer_buffer(buffer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) kfree(hw_buf);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) static const struct iio_buffer_access_funcs iio_hw_buf_access = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) .release = &iio_hw_buf_release,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) .modes = INDIO_BUFFER_HARDWARE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) static struct hw_consumer_buffer *iio_hw_consumer_get_buffer(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) struct iio_hw_consumer *hwc, struct iio_dev *indio_dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) size_t mask_size = BITS_TO_LONGS(indio_dev->masklength) * sizeof(long);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) struct hw_consumer_buffer *buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) list_for_each_entry(buf, &hwc->buffers, head) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) if (buf->indio_dev == indio_dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) return buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) buf = kzalloc(sizeof(*buf) + mask_size, GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) if (!buf)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) return NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) buf->buffer.access = &iio_hw_buf_access;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) buf->indio_dev = indio_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) buf->buffer.scan_mask = buf->scan_mask;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) iio_buffer_init(&buf->buffer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) list_add_tail(&buf->head, &hwc->buffers);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) return buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) * iio_hw_consumer_alloc() - Allocate IIO hardware consumer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) * @dev: Pointer to consumer device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) * Returns a valid iio_hw_consumer on success or a ERR_PTR() on failure.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) struct iio_hw_consumer *iio_hw_consumer_alloc(struct device *dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) struct hw_consumer_buffer *buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) struct iio_hw_consumer *hwc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) struct iio_channel *chan;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) hwc = kzalloc(sizeof(*hwc), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) if (!hwc)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) return ERR_PTR(-ENOMEM);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) INIT_LIST_HEAD(&hwc->buffers);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) hwc->channels = iio_channel_get_all(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) if (IS_ERR(hwc->channels)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) ret = PTR_ERR(hwc->channels);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) goto err_free_hwc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) chan = &hwc->channels[0];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) while (chan->indio_dev) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) buf = iio_hw_consumer_get_buffer(hwc, chan->indio_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) if (!buf) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) ret = -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) goto err_put_buffers;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) set_bit(chan->channel->scan_index, buf->buffer.scan_mask);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) chan++;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) return hwc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) err_put_buffers:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) list_for_each_entry(buf, &hwc->buffers, head)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) iio_buffer_put(&buf->buffer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) iio_channel_release_all(hwc->channels);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) err_free_hwc:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) kfree(hwc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) return ERR_PTR(ret);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) EXPORT_SYMBOL_GPL(iio_hw_consumer_alloc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) * iio_hw_consumer_free() - Free IIO hardware consumer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) * @hwc: hw consumer to free.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) void iio_hw_consumer_free(struct iio_hw_consumer *hwc)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) struct hw_consumer_buffer *buf, *n;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) iio_channel_release_all(hwc->channels);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) list_for_each_entry_safe(buf, n, &hwc->buffers, head)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) iio_buffer_put(&buf->buffer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) kfree(hwc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) EXPORT_SYMBOL_GPL(iio_hw_consumer_free);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) static void devm_iio_hw_consumer_release(struct device *dev, void *res)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) iio_hw_consumer_free(*(struct iio_hw_consumer **)res);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) * devm_iio_hw_consumer_alloc - Resource-managed iio_hw_consumer_alloc()
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) * @dev: Pointer to consumer device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) * Managed iio_hw_consumer_alloc. iio_hw_consumer allocated with this function
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) * is automatically freed on driver detach.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) * returns pointer to allocated iio_hw_consumer on success, NULL on failure.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) struct iio_hw_consumer *devm_iio_hw_consumer_alloc(struct device *dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) struct iio_hw_consumer **ptr, *iio_hwc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) ptr = devres_alloc(devm_iio_hw_consumer_release, sizeof(*ptr),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) if (!ptr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) return NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) iio_hwc = iio_hw_consumer_alloc(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) if (IS_ERR(iio_hwc)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) devres_free(ptr);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) *ptr = iio_hwc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) devres_add(dev, ptr);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) return iio_hwc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) EXPORT_SYMBOL_GPL(devm_iio_hw_consumer_alloc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) * iio_hw_consumer_enable() - Enable IIO hardware consumer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) * @hwc: iio_hw_consumer to enable.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) * Returns 0 on success.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) int iio_hw_consumer_enable(struct iio_hw_consumer *hwc)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) struct hw_consumer_buffer *buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) list_for_each_entry(buf, &hwc->buffers, head) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) ret = iio_update_buffers(buf->indio_dev, &buf->buffer, NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) if (ret)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) goto err_disable_buffers;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) err_disable_buffers:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) list_for_each_entry_continue_reverse(buf, &hwc->buffers, head)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) iio_update_buffers(buf->indio_dev, NULL, &buf->buffer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) EXPORT_SYMBOL_GPL(iio_hw_consumer_enable);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) * iio_hw_consumer_disable() - Disable IIO hardware consumer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) * @hwc: iio_hw_consumer to disable.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) void iio_hw_consumer_disable(struct iio_hw_consumer *hwc)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) struct hw_consumer_buffer *buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) list_for_each_entry(buf, &hwc->buffers, head)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) iio_update_buffers(buf->indio_dev, NULL, &buf->buffer);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) EXPORT_SYMBOL_GPL(iio_hw_consumer_disable);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) MODULE_DESCRIPTION("Hardware consumer buffer the IIO framework");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) MODULE_LICENSE("GPL v2");