WIP FPC-III support
[linux/fpc-iii.git] / Documentation / userspace-api / media / dvb / dmx-munmap.rst
blob66bbc11e5c402b835c36c162d0bf4b0e123ff4e5
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.dmx
4 .. _dmx-munmap:
6 ************
7 DVB munmap()
8 ************
10 Name
11 ====
13 dmx-munmap - Unmap device memory
15 .. warning:: This API is still experimental.
17 Synopsis
18 ========
20 .. code-block:: c
22     #include <unistd.h>
23     #include <sys/mman.h>
25 .. c:function:: int munmap( void *start, size_t length )
27 Arguments
28 =========
30 ``start``
31     Address of the mapped buffer as returned by the
32     :c:func:`mmap()` function.
34 ``length``
35     Length of the mapped buffer. This must be the same value as given to
36     :c:func:`mmap()`.
38 Description
39 ===========
41 Unmaps a previously with the :c:func:`mmap()` function mapped
42 buffer and frees it, if possible.
44 Return Value
45 ============
47 On success :c:func:`munmap()` returns 0, on failure -1 and the
48 ``errno`` variable is set appropriately:
50 EINVAL
51     The ``start`` or ``length`` is incorrect, or no buffers have been
52     mapped yet.