From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 59888C433E6 for ; Mon, 15 Feb 2021 14:31:42 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 29F2664E51 for ; Mon, 15 Feb 2021 14:31:42 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230073AbhBOObZ (ORCPT ); Mon, 15 Feb 2021 09:31:25 -0500 Received: from mx0a-00128a01.pphosted.com ([148.163.135.77]:38124 "EHLO mx0a-00128a01.pphosted.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229784AbhBOObQ (ORCPT ); Mon, 15 Feb 2021 09:31:16 -0500 Received: from pps.filterd (m0167088.ppops.net [127.0.0.1]) by mx0a-00128a01.pphosted.com (8.16.0.43/8.16.0.43) with SMTP id 11FEUOgX026053; Mon, 15 Feb 2021 09:30:24 -0500 Received: from nwd2mta4.analog.com ([137.71.173.58]) by mx0a-00128a01.pphosted.com with ESMTP id 36p9gaw2a3-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Mon, 15 Feb 2021 09:30:24 -0500 Received: from ASHBMBX9.ad.analog.com (ASHBMBX9.ad.analog.com [10.64.17.10]) by nwd2mta4.analog.com (8.14.7/8.14.7) with ESMTP id 11FEUNws011824 (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128 verify=FAIL); Mon, 15 Feb 2021 09:30:23 -0500 Received: from ASHBMBX9.ad.analog.com (10.64.17.10) by ASHBMBX9.ad.analog.com (10.64.17.10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1779.2; Mon, 15 Feb 2021 09:30:22 -0500 Received: from zeus.spd.analog.com (10.66.68.11) by ASHBMBX9.ad.analog.com (10.64.17.10) with Microsoft SMTP Server id 15.1.1779.2 via Frontend Transport; Mon, 15 Feb 2021 09:30:22 -0500 Received: from localhost.localdomain ([10.48.65.12]) by zeus.spd.analog.com (8.15.1/8.15.1) with ESMTP id 11FEUGbj027532; Mon, 15 Feb 2021 09:30:20 -0500 From: Alexandru Ardelean To: , CC: , , , , , Alexandru Ardelean Subject: [PATCH v3 2/5] Documentation: iio: add doc for high-speed buffer API Date: Mon, 15 Feb 2021 16:32:31 +0200 Message-ID: <20210215143234.3248-3-alexandru.ardelean@analog.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210215143234.3248-1-alexandru.ardelean@analog.com> References: <20210215143234.3248-1-alexandru.ardelean@analog.com> MIME-Version: 1.0 Content-Type: text/plain X-ADIRuleOP-NewSCL: Rule Triggered X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.369,18.0.761 definitions=2021-02-15_08:2021-02-12,2021-02-15 signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 lowpriorityscore=0 bulkscore=0 malwarescore=0 mlxlogscore=770 phishscore=0 clxscore=1015 mlxscore=0 priorityscore=1501 impostorscore=0 adultscore=0 spamscore=0 suspectscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2009150000 definitions=main-2102150117 Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This change takes the comment from the commit that introduces the IIO high-speed buffer API, and formats it into rst format. Signed-off-by: Alexandru Ardelean --- Documentation/iio/iio_high_speed_buffers.rst | 100 +++++++++++++++++++ Documentation/iio/index.rst | 2 + include/uapi/linux/iio/buffer.h | 5 + 3 files changed, 107 insertions(+) create mode 100644 Documentation/iio/iio_high_speed_buffers.rst diff --git a/Documentation/iio/iio_high_speed_buffers.rst b/Documentation/iio/iio_high_speed_buffers.rst new file mode 100644 index 000000000000..f326e68efe49 --- /dev/null +++ b/Documentation/iio/iio_high_speed_buffers.rst @@ -0,0 +1,100 @@ +=================================== +Industrial IO High-Speed Buffer API +=================================== + +1. Overview +=========== + +Industrial IO supports access to buffers via an mmap interface. The +advantage of the mmap based interface compared to the read() based +interface is that it avoids an extra copy of the data between kernel and +userspace. This is particular useful for high-speed devices which produce +several megabytes or even gigabytes of data per second. + +The data for the mmap interface is managed at the granularity of so called +blocks. A block is a contiguous region of memory (at the moment both +physically and virtually contiguous). Reducing the granularity from byte +level to block level is done to reduce the userspace-kernelspace +synchronization overhead since performing syscalls for each byte at a +data-rate of a few megabytes is not feasible. + +This of course leads to a slightly increased latency. For this reason an +application can choose the size of the blocks as well as how many blocks it +allocates. E.g. two blocks would be a traditional double buffering scheme. +But using a higher number might be necessary to avoid underflow/overflow +situations in the presence of scheduling latencies. + +A block can either be owned by kernel space or userspace. When owned by +userspace it is safe to access the data in the block and process it. When +owned by kernel space the block can be in one of 3 states: + +* It can be in the incoming queue where all blocks submitted from userspace + are placed and are waiting to be processed by the kernel driver. +* It can be currently being processed by the kernel driver, this means it is + actively placing capturing data in it (usually using DMA). +* Or it can be in the outgoing queue where all blocks that have been + processed by the kernel are placed. Userspace can dequeue the blocks as + necessary. + +2. Interface +============ + +As part of the interface 5 IOCTLs are used to manage the blocks and exchange +them between userspace and kernelspace. The IOCTLs can be accessed through +a open file descriptor to a IIO device. + +* **IIO_BUFFER_BLOCK_ALLOC_IOCTL(struct iio_buffer_block_alloc_req *)**: + Allocates new blocks. Can be called multiple times if necessary. A newly + allocated block is initially owned by userspace. + +* **IIO_BUFFER_BLOCK_FREE_IOCTL(void)**: + Frees all previously allocated blocks. If the backing memory of a block is + still in use by a kernel driver (i.e. active DMA transfer) it will be + freed once the kernel driver has released it. + +* **IIO_BUFFER_BLOCK_QUERY_IOCTL(struct iio_buffer_block *)**: + Queries information about a block. The id of the block about which + information is to be queried needs to be set by userspace. + +* **IIO_BUFFER_BLOCK_ENQUEUE_IOCTL(struct iio_buffer_block *)**: + Places a block on the incoming queue. This transfers ownership of the + block from userspace to kernelspace. Userspace must populate the id field + of the block to indicate which block to enqueue. + +* **IIO_BUFFER_BLOCK_DEQUEUE_IOCTL(struct iio_buffer_block *)**: + Removes the first block from the outgoing queue. This transfers ownership + of the block from kernelspace to userspace. Kernelspace will populate all + fields of the block. If the queue is empty and the file descriptor is set + to blocking the IOCTL will block until a new block is available on the + outgoing queue. + +3. Usage +======== + +To access the data stored in a block by userspace the block must be mapped +to the process's memory. This is done by calling mmap() on the IIO device +file descriptor. Each block has a unique offset assigned to it which should +be passed to the mmap interface. E.g. + + mmap(0, block.size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, + block.offset); + +A typical workflow for the new interface is: + + BLOCK_ALLOC + + foreach block + BLOCK_QUERY block + mmap block.data.offset + BLOCK_ENQUEUE block + + enable buffer + + while !done + BLOCK_DEQUEUE block + process data + BLOCK_ENQUEUE block + + disable buffer + + BLOCK_FREE diff --git a/Documentation/iio/index.rst b/Documentation/iio/index.rst index 58b7a4ebac51..aaba78770b47 100644 --- a/Documentation/iio/index.rst +++ b/Documentation/iio/index.rst @@ -9,4 +9,6 @@ Industrial I/O iio_configfs + iio_high_speed_buffers + ep93xx_adc diff --git a/include/uapi/linux/iio/buffer.h b/include/uapi/linux/iio/buffer.h index 8c1a2f27e5a2..d8c64210c9cc 100644 --- a/include/uapi/linux/iio/buffer.h +++ b/include/uapi/linux/iio/buffer.h @@ -5,6 +5,11 @@ #ifndef _UAPI_IIO_BUFFER_H_ #define _UAPI_IIO_BUFFER_H_ +/** + * See for more details: + * Documentation/iio/iio_high_speed_buffers.rst + */ + /** * struct iio_buffer_block_alloc_req - Descriptor for allocating IIO buffer blocks * @type: type of block(s) to allocate (currently unused, reserved) -- 2.17.1