1 .. SPDX-License-Identifier: GFDL-1.1-no-invari !! 1 .. Permission is granted to copy, distribute and/or modify this
2 .. c:namespace:: DTV.dmx !! 2 .. document under the terms of the GNU Free Documentation License,
>> 3 .. Version 1.1 or any later version published by the Free Software
>> 4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
>> 5 .. and no Back-Cover Texts. A copy of the license is included at
>> 6 .. Documentation/userspace-api/media/fdl-appendix.rst.
>> 7 ..
>> 8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
3 9
4 .. _dmx-munmap: 10 .. _dmx-munmap:
5 11
6 ************ 12 ************
7 DVB munmap() 13 DVB munmap()
8 ************ 14 ************
9 15
10 Name 16 Name
11 ==== 17 ====
12 18
13 dmx-munmap - Unmap device memory 19 dmx-munmap - Unmap device memory
14 20
15 .. warning:: This API is still experimental. 21 .. warning:: This API is still experimental.
16 22
>> 23
17 Synopsis 24 Synopsis
18 ======== 25 ========
19 26
20 .. code-block:: c 27 .. code-block:: c
21 28
22 #include <unistd.h> 29 #include <unistd.h>
23 #include <sys/mman.h> 30 #include <sys/mman.h>
24 31
>> 32
25 .. c:function:: int munmap( void *start, size_ 33 .. c:function:: int munmap( void *start, size_t length )
>> 34 :name: dmx-munmap
26 35
27 Arguments 36 Arguments
28 ========= 37 =========
29 38
30 ``start`` 39 ``start``
31 Address of the mapped buffer as returned b 40 Address of the mapped buffer as returned by the
32 :c:func:`mmap()` function. !! 41 :ref:`mmap() <dmx-mmap>` function.
33 42
34 ``length`` 43 ``length``
35 Length of the mapped buffer. This must be 44 Length of the mapped buffer. This must be the same value as given to
36 :c:func:`mmap()`. !! 45 :ref:`mmap() <dmx-mmap>`.
>> 46
37 47
38 Description 48 Description
39 =========== 49 ===========
40 50
41 Unmaps a previously with the :c:func:`mmap()` !! 51 Unmaps a previously with the :ref:`mmap() <dmx-mmap>` function mapped
42 buffer and frees it, if possible. 52 buffer and frees it, if possible.
43 53
>> 54
44 Return Value 55 Return Value
45 ============ 56 ============
46 57
47 On success :c:func:`munmap()` returns 0, on fa !! 58 On success :ref:`munmap() <dmx-munmap>` returns 0, on failure -1 and the
48 ``errno`` variable is set appropriately: 59 ``errno`` variable is set appropriately:
49 60
50 EINVAL 61 EINVAL
51 The ``start`` or ``length`` is incorrect, 62 The ``start`` or ``length`` is incorrect, or no buffers have been
52 mapped yet. 63 mapped yet.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.