Orange Pi5 kernel

^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  1) ===========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  2) HW consumer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  3) ===========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  4) An IIO device can be directly connected to another device in hardware. In this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  5) case the buffers between IIO provider and IIO consumer are handled by hardware.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  6) The Industrial I/O HW consumer offers a way to bond these IIO devices without
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  7) software buffer for data. The implementation can be found under
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  8) :file:`drivers/iio/buffer/hw-consumer.c`
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  9) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) * struct iio_hw_consumer — Hardware consumer structure
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) * :c:func:`iio_hw_consumer_alloc` — Allocate IIO hardware consumer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) * :c:func:`iio_hw_consumer_free` — Free IIO hardware consumer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) * :c:func:`iio_hw_consumer_enable` — Enable IIO hardware consumer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) * :c:func:`iio_hw_consumer_disable` — Disable IIO hardware consumer
^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) HW consumer setup
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) =================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) As standard IIO device the implementation is based on IIO provider/consumer.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) A typical IIO HW consumer setup looks like this::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) 	static struct iio_hw_consumer *hwc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) 	static const struct iio_info adc_info = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) 		.read_raw = adc_read_raw,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) 	};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) 	static int adc_read_raw(struct iio_dev *indio_dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) 				struct iio_chan_spec const *chan, int *val,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) 				int *val2, long mask)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) 	{
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) 		ret = iio_hw_consumer_enable(hwc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) 		/* Acquire data */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) 		ret = iio_hw_consumer_disable(hwc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) 	static int adc_probe(struct platform_device *pdev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) 	{
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) 		hwc = devm_iio_hw_consumer_alloc(&iio->dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) More details
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) ============
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) .. kernel-doc:: drivers/iio/buffer/industrialio-hw-consumer.c
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)    :export:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50)