148b66f8fSLars-Peter Clausen // SPDX-License-Identifier: GPL-2.0 248b66f8fSLars-Peter Clausen /* 348b66f8fSLars-Peter Clausen * Copyright 2017 Analog Devices Inc. 448b66f8fSLars-Peter Clausen * Author: Lars-Peter Clausen <lars@metafoo.de> 548b66f8fSLars-Peter Clausen */ 648b66f8fSLars-Peter Clausen 748b66f8fSLars-Peter Clausen #include <linux/err.h> 848b66f8fSLars-Peter Clausen #include <linux/export.h> 948b66f8fSLars-Peter Clausen #include <linux/slab.h> 1048b66f8fSLars-Peter Clausen #include <linux/module.h> 1148b66f8fSLars-Peter Clausen 1248b66f8fSLars-Peter Clausen #include <linux/iio/iio.h> 1348b66f8fSLars-Peter Clausen #include <linux/iio/consumer.h> 1448b66f8fSLars-Peter Clausen #include <linux/iio/hw-consumer.h> 1548b66f8fSLars-Peter Clausen #include <linux/iio/buffer_impl.h> 1648b66f8fSLars-Peter Clausen 1748b66f8fSLars-Peter Clausen /** 1848b66f8fSLars-Peter Clausen * struct iio_hw_consumer - IIO hw consumer block 1948b66f8fSLars-Peter Clausen * @buffers: hardware buffers list head. 2048b66f8fSLars-Peter Clausen * @channels: IIO provider channels. 2148b66f8fSLars-Peter Clausen */ 2248b66f8fSLars-Peter Clausen struct iio_hw_consumer { 2348b66f8fSLars-Peter Clausen struct list_head buffers; 2448b66f8fSLars-Peter Clausen struct iio_channel *channels; 2548b66f8fSLars-Peter Clausen }; 2648b66f8fSLars-Peter Clausen 2748b66f8fSLars-Peter Clausen struct hw_consumer_buffer { 2848b66f8fSLars-Peter Clausen struct list_head head; 2948b66f8fSLars-Peter Clausen struct iio_dev *indio_dev; 3048b66f8fSLars-Peter Clausen struct iio_buffer buffer; 3148b66f8fSLars-Peter Clausen long scan_mask[]; 3248b66f8fSLars-Peter Clausen }; 3348b66f8fSLars-Peter Clausen 3448b66f8fSLars-Peter Clausen static struct hw_consumer_buffer *iio_buffer_to_hw_consumer_buffer( 3548b66f8fSLars-Peter Clausen struct iio_buffer *buffer) 3648b66f8fSLars-Peter Clausen { 3748b66f8fSLars-Peter Clausen return container_of(buffer, struct hw_consumer_buffer, buffer); 3848b66f8fSLars-Peter Clausen } 3948b66f8fSLars-Peter Clausen 4048b66f8fSLars-Peter Clausen static void iio_hw_buf_release(struct iio_buffer *buffer) 4148b66f8fSLars-Peter Clausen { 4248b66f8fSLars-Peter Clausen struct hw_consumer_buffer *hw_buf = 4348b66f8fSLars-Peter Clausen iio_buffer_to_hw_consumer_buffer(buffer); 4448b66f8fSLars-Peter Clausen kfree(hw_buf); 4548b66f8fSLars-Peter Clausen } 4648b66f8fSLars-Peter Clausen 4748b66f8fSLars-Peter Clausen static const struct iio_buffer_access_funcs iio_hw_buf_access = { 4848b66f8fSLars-Peter Clausen .release = &iio_hw_buf_release, 4948b66f8fSLars-Peter Clausen .modes = INDIO_BUFFER_HARDWARE, 5048b66f8fSLars-Peter Clausen }; 5148b66f8fSLars-Peter Clausen 5248b66f8fSLars-Peter Clausen static struct hw_consumer_buffer *iio_hw_consumer_get_buffer( 5348b66f8fSLars-Peter Clausen struct iio_hw_consumer *hwc, struct iio_dev *indio_dev) 5448b66f8fSLars-Peter Clausen { 5548b66f8fSLars-Peter Clausen size_t mask_size = BITS_TO_LONGS(indio_dev->masklength) * sizeof(long); 5648b66f8fSLars-Peter Clausen struct hw_consumer_buffer *buf; 5748b66f8fSLars-Peter Clausen 5848b66f8fSLars-Peter Clausen list_for_each_entry(buf, &hwc->buffers, head) { 5948b66f8fSLars-Peter Clausen if (buf->indio_dev == indio_dev) 6048b66f8fSLars-Peter Clausen return buf; 6148b66f8fSLars-Peter Clausen } 6248b66f8fSLars-Peter Clausen 6348b66f8fSLars-Peter Clausen buf = kzalloc(sizeof(*buf) + mask_size, GFP_KERNEL); 6448b66f8fSLars-Peter Clausen if (!buf) 6548b66f8fSLars-Peter Clausen return NULL; 6648b66f8fSLars-Peter Clausen 6748b66f8fSLars-Peter Clausen buf->buffer.access = &iio_hw_buf_access; 6848b66f8fSLars-Peter Clausen buf->indio_dev = indio_dev; 6948b66f8fSLars-Peter Clausen buf->buffer.scan_mask = buf->scan_mask; 7048b66f8fSLars-Peter Clausen 7148b66f8fSLars-Peter Clausen iio_buffer_init(&buf->buffer); 7248b66f8fSLars-Peter Clausen list_add_tail(&buf->head, &hwc->buffers); 7348b66f8fSLars-Peter Clausen 7448b66f8fSLars-Peter Clausen return buf; 7548b66f8fSLars-Peter Clausen } 7648b66f8fSLars-Peter Clausen 7748b66f8fSLars-Peter Clausen /** 7848b66f8fSLars-Peter Clausen * iio_hw_consumer_alloc() - Allocate IIO hardware consumer 7948b66f8fSLars-Peter Clausen * @dev: Pointer to consumer device. 8048b66f8fSLars-Peter Clausen * 8148b66f8fSLars-Peter Clausen * Returns a valid iio_hw_consumer on success or a ERR_PTR() on failure. 8248b66f8fSLars-Peter Clausen */ 8348b66f8fSLars-Peter Clausen struct iio_hw_consumer *iio_hw_consumer_alloc(struct device *dev) 8448b66f8fSLars-Peter Clausen { 8548b66f8fSLars-Peter Clausen struct hw_consumer_buffer *buf; 8648b66f8fSLars-Peter Clausen struct iio_hw_consumer *hwc; 8748b66f8fSLars-Peter Clausen struct iio_channel *chan; 8848b66f8fSLars-Peter Clausen int ret; 8948b66f8fSLars-Peter Clausen 9048b66f8fSLars-Peter Clausen hwc = kzalloc(sizeof(*hwc), GFP_KERNEL); 9148b66f8fSLars-Peter Clausen if (!hwc) 9248b66f8fSLars-Peter Clausen return ERR_PTR(-ENOMEM); 9348b66f8fSLars-Peter Clausen 9448b66f8fSLars-Peter Clausen INIT_LIST_HEAD(&hwc->buffers); 9548b66f8fSLars-Peter Clausen 9648b66f8fSLars-Peter Clausen hwc->channels = iio_channel_get_all(dev); 9748b66f8fSLars-Peter Clausen if (IS_ERR(hwc->channels)) { 9848b66f8fSLars-Peter Clausen ret = PTR_ERR(hwc->channels); 9948b66f8fSLars-Peter Clausen goto err_free_hwc; 10048b66f8fSLars-Peter Clausen } 10148b66f8fSLars-Peter Clausen 10248b66f8fSLars-Peter Clausen chan = &hwc->channels[0]; 10348b66f8fSLars-Peter Clausen while (chan->indio_dev) { 10448b66f8fSLars-Peter Clausen buf = iio_hw_consumer_get_buffer(hwc, chan->indio_dev); 10548b66f8fSLars-Peter Clausen if (!buf) { 10648b66f8fSLars-Peter Clausen ret = -ENOMEM; 10748b66f8fSLars-Peter Clausen goto err_put_buffers; 10848b66f8fSLars-Peter Clausen } 10948b66f8fSLars-Peter Clausen set_bit(chan->channel->scan_index, buf->buffer.scan_mask); 11048b66f8fSLars-Peter Clausen chan++; 11148b66f8fSLars-Peter Clausen } 11248b66f8fSLars-Peter Clausen 11348b66f8fSLars-Peter Clausen return hwc; 11448b66f8fSLars-Peter Clausen 11548b66f8fSLars-Peter Clausen err_put_buffers: 11648b66f8fSLars-Peter Clausen list_for_each_entry(buf, &hwc->buffers, head) 11748b66f8fSLars-Peter Clausen iio_buffer_put(&buf->buffer); 11848b66f8fSLars-Peter Clausen iio_channel_release_all(hwc->channels); 11948b66f8fSLars-Peter Clausen err_free_hwc: 12048b66f8fSLars-Peter Clausen kfree(hwc); 12148b66f8fSLars-Peter Clausen return ERR_PTR(ret); 12248b66f8fSLars-Peter Clausen } 12348b66f8fSLars-Peter Clausen EXPORT_SYMBOL_GPL(iio_hw_consumer_alloc); 12448b66f8fSLars-Peter Clausen 12548b66f8fSLars-Peter Clausen /** 12648b66f8fSLars-Peter Clausen * iio_hw_consumer_free() - Free IIO hardware consumer 12748b66f8fSLars-Peter Clausen * @hwc: hw consumer to free. 12848b66f8fSLars-Peter Clausen */ 12948b66f8fSLars-Peter Clausen void iio_hw_consumer_free(struct iio_hw_consumer *hwc) 13048b66f8fSLars-Peter Clausen { 13148b66f8fSLars-Peter Clausen struct hw_consumer_buffer *buf, *n; 13248b66f8fSLars-Peter Clausen 13348b66f8fSLars-Peter Clausen iio_channel_release_all(hwc->channels); 13448b66f8fSLars-Peter Clausen list_for_each_entry_safe(buf, n, &hwc->buffers, head) 13548b66f8fSLars-Peter Clausen iio_buffer_put(&buf->buffer); 13648b66f8fSLars-Peter Clausen kfree(hwc); 13748b66f8fSLars-Peter Clausen } 13848b66f8fSLars-Peter Clausen EXPORT_SYMBOL_GPL(iio_hw_consumer_free); 13948b66f8fSLars-Peter Clausen 140b688c18dSArnaud Pouliquen static void devm_iio_hw_consumer_release(struct device *dev, void *res) 141b688c18dSArnaud Pouliquen { 142b688c18dSArnaud Pouliquen iio_hw_consumer_free(*(struct iio_hw_consumer **)res); 143b688c18dSArnaud Pouliquen } 144b688c18dSArnaud Pouliquen 145b688c18dSArnaud Pouliquen static int devm_iio_hw_consumer_match(struct device *dev, void *res, void *data) 146b688c18dSArnaud Pouliquen { 147b688c18dSArnaud Pouliquen struct iio_hw_consumer **r = res; 148b688c18dSArnaud Pouliquen 149b688c18dSArnaud Pouliquen if (!r || !*r) { 150b688c18dSArnaud Pouliquen WARN_ON(!r || !*r); 151b688c18dSArnaud Pouliquen return 0; 152b688c18dSArnaud Pouliquen } 153b688c18dSArnaud Pouliquen return *r == data; 154b688c18dSArnaud Pouliquen } 155b688c18dSArnaud Pouliquen 156b688c18dSArnaud Pouliquen /** 157b688c18dSArnaud Pouliquen * devm_iio_hw_consumer_alloc - Resource-managed iio_hw_consumer_alloc() 158b688c18dSArnaud Pouliquen * @dev: Pointer to consumer device. 159b688c18dSArnaud Pouliquen * 160b688c18dSArnaud Pouliquen * Managed iio_hw_consumer_alloc. iio_hw_consumer allocated with this function 161b688c18dSArnaud Pouliquen * is automatically freed on driver detach. 162b688c18dSArnaud Pouliquen * 163b688c18dSArnaud Pouliquen * If an iio_hw_consumer allocated with this function needs to be freed 164b688c18dSArnaud Pouliquen * separately, devm_iio_hw_consumer_free() must be used. 165b688c18dSArnaud Pouliquen * 166b688c18dSArnaud Pouliquen * returns pointer to allocated iio_hw_consumer on success, NULL on failure. 167b688c18dSArnaud Pouliquen */ 168b688c18dSArnaud Pouliquen struct iio_hw_consumer *devm_iio_hw_consumer_alloc(struct device *dev) 169b688c18dSArnaud Pouliquen { 170b688c18dSArnaud Pouliquen struct iio_hw_consumer **ptr, *iio_hwc; 171b688c18dSArnaud Pouliquen 172b688c18dSArnaud Pouliquen ptr = devres_alloc(devm_iio_hw_consumer_release, sizeof(*ptr), 173b688c18dSArnaud Pouliquen GFP_KERNEL); 174b688c18dSArnaud Pouliquen if (!ptr) 175b688c18dSArnaud Pouliquen return NULL; 176b688c18dSArnaud Pouliquen 177b688c18dSArnaud Pouliquen iio_hwc = iio_hw_consumer_alloc(dev); 178b688c18dSArnaud Pouliquen if (IS_ERR(iio_hwc)) { 179b688c18dSArnaud Pouliquen devres_free(ptr); 180b688c18dSArnaud Pouliquen } else { 181b688c18dSArnaud Pouliquen *ptr = iio_hwc; 182b688c18dSArnaud Pouliquen devres_add(dev, ptr); 183b688c18dSArnaud Pouliquen } 184b688c18dSArnaud Pouliquen 185b688c18dSArnaud Pouliquen return iio_hwc; 186b688c18dSArnaud Pouliquen } 187b688c18dSArnaud Pouliquen EXPORT_SYMBOL_GPL(devm_iio_hw_consumer_alloc); 188b688c18dSArnaud Pouliquen 189b688c18dSArnaud Pouliquen /** 190b688c18dSArnaud Pouliquen * devm_iio_hw_consumer_free - Resource-managed iio_hw_consumer_free() 191b688c18dSArnaud Pouliquen * @dev: Pointer to consumer device. 192b688c18dSArnaud Pouliquen * @hwc: iio_hw_consumer to free. 193b688c18dSArnaud Pouliquen * 194b688c18dSArnaud Pouliquen * Free iio_hw_consumer allocated with devm_iio_hw_consumer_alloc(). 195b688c18dSArnaud Pouliquen */ 196b688c18dSArnaud Pouliquen void devm_iio_hw_consumer_free(struct device *dev, struct iio_hw_consumer *hwc) 197b688c18dSArnaud Pouliquen { 198b688c18dSArnaud Pouliquen int rc; 199b688c18dSArnaud Pouliquen 200b688c18dSArnaud Pouliquen rc = devres_release(dev, devm_iio_hw_consumer_release, 201b688c18dSArnaud Pouliquen devm_iio_hw_consumer_match, hwc); 202b688c18dSArnaud Pouliquen WARN_ON(rc); 203b688c18dSArnaud Pouliquen } 204b688c18dSArnaud Pouliquen EXPORT_SYMBOL_GPL(devm_iio_hw_consumer_free); 205b688c18dSArnaud Pouliquen 20648b66f8fSLars-Peter Clausen /** 20748b66f8fSLars-Peter Clausen * iio_hw_consumer_enable() - Enable IIO hardware consumer 20848b66f8fSLars-Peter Clausen * @hwc: iio_hw_consumer to enable. 20948b66f8fSLars-Peter Clausen * 21048b66f8fSLars-Peter Clausen * Returns 0 on success. 21148b66f8fSLars-Peter Clausen */ 21248b66f8fSLars-Peter Clausen int iio_hw_consumer_enable(struct iio_hw_consumer *hwc) 21348b66f8fSLars-Peter Clausen { 21448b66f8fSLars-Peter Clausen struct hw_consumer_buffer *buf; 21548b66f8fSLars-Peter Clausen int ret; 21648b66f8fSLars-Peter Clausen 21748b66f8fSLars-Peter Clausen list_for_each_entry(buf, &hwc->buffers, head) { 21848b66f8fSLars-Peter Clausen ret = iio_update_buffers(buf->indio_dev, &buf->buffer, NULL); 21948b66f8fSLars-Peter Clausen if (ret) 22048b66f8fSLars-Peter Clausen goto err_disable_buffers; 22148b66f8fSLars-Peter Clausen } 22248b66f8fSLars-Peter Clausen 22348b66f8fSLars-Peter Clausen return 0; 22448b66f8fSLars-Peter Clausen 22548b66f8fSLars-Peter Clausen err_disable_buffers: 22648b66f8fSLars-Peter Clausen list_for_each_entry_continue_reverse(buf, &hwc->buffers, head) 22748b66f8fSLars-Peter Clausen iio_update_buffers(buf->indio_dev, NULL, &buf->buffer); 22848b66f8fSLars-Peter Clausen return ret; 22948b66f8fSLars-Peter Clausen } 23048b66f8fSLars-Peter Clausen EXPORT_SYMBOL_GPL(iio_hw_consumer_enable); 23148b66f8fSLars-Peter Clausen 23248b66f8fSLars-Peter Clausen /** 23348b66f8fSLars-Peter Clausen * iio_hw_consumer_disable() - Disable IIO hardware consumer 23448b66f8fSLars-Peter Clausen * @hwc: iio_hw_consumer to disable. 23548b66f8fSLars-Peter Clausen */ 23648b66f8fSLars-Peter Clausen void iio_hw_consumer_disable(struct iio_hw_consumer *hwc) 23748b66f8fSLars-Peter Clausen { 23848b66f8fSLars-Peter Clausen struct hw_consumer_buffer *buf; 23948b66f8fSLars-Peter Clausen 24048b66f8fSLars-Peter Clausen list_for_each_entry(buf, &hwc->buffers, head) 24148b66f8fSLars-Peter Clausen iio_update_buffers(buf->indio_dev, NULL, &buf->buffer); 24248b66f8fSLars-Peter Clausen } 24348b66f8fSLars-Peter Clausen EXPORT_SYMBOL_GPL(iio_hw_consumer_disable); 24448b66f8fSLars-Peter Clausen 24548b66f8fSLars-Peter Clausen MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>"); 24648b66f8fSLars-Peter Clausen MODULE_DESCRIPTION("Hardware consumer buffer the IIO framework"); 24748b66f8fSLars-Peter Clausen MODULE_LICENSE("GPL v2"); 248