]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
Docs/driver-api/uio-howto: document mmap_prepare callback
authorDoehyun Baek <doehyunbaek@gmail.com>
Mon, 22 Jun 2026 18:18:21 +0000 (18:18 +0000)
committerJonathan Corbet <corbet@lwn.net>
Tue, 23 Jun 2026 20:33:38 +0000 (14:33 -0600)
The UIO howto still documents an mmap callback in struct uio_info.
That field was replaced by mmap_prepare, which takes a struct
vm_area_desc.

A UIO driver following the current howto no longer builds because
struct uio_info has no mmap member. Update the documented callback
signature and matching text to match the current API.

Fixes: 933f05f58ac6 ("uio: replace deprecated mmap hook with mmap_prepare in uio_info")
Signed-off-by: Doehyun Baek <doehyunbaek@gmail.com>
Reviewed-by: Lorenzo Stoakes <ljs@kernel.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260622181821.1195257-1-doehyunbaek@gmail.com>

Documentation/driver-api/uio-howto.rst

index 907ffa3b38f5b7b8ac914893e41b08ce53eec9dd..c08472dfbcfeb3ab9f9670a3ea736bd6ffede318 100644 (file)
@@ -246,10 +246,10 @@ the members are required, others are optional.
    hardware interrupt number. The flags given here will be used in the
    call to :c:func:`request_irq()`.
 
--  ``int (*mmap)(struct uio_info *info, struct vm_area_struct *vma)``:
+-  ``int (*mmap_prepare)(struct uio_info *info, struct vm_area_desc *desc)``:
    Optional. If you need a special :c:func:`mmap()`
    function, you can set it here. If this pointer is not NULL, your
-   :c:func:`mmap()` will be called instead of the built-in one.
+   ``mmap_prepare`` will be called instead of the built-in one.
 
 -  ``int (*open)(struct uio_info *info, struct inode *inode)``:
    Optional. You might want to have your own :c:func:`open()`,