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_REQBUFS: 10 .. _DMX_REQBUFS:
5 11
6 ***************** 12 *****************
7 ioctl DMX_REQBUFS 13 ioctl DMX_REQBUFS
8 ***************** 14 *****************
9 15
10 Name 16 Name
11 ==== 17 ====
12 18
13 DMX_REQBUFS - Initiate Memory Mapping and/or D 19 DMX_REQBUFS - Initiate Memory Mapping and/or DMA buffer I/O
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 .. c:macro:: DMX_REQBUFS !! 27 .. c:function:: int ioctl( int fd, DMX_REQBUFS, struct dmx_requestbuffers *argp )
>> 28 :name: DMX_REQBUFS
21 29
22 ``int ioctl(int fd, DMX_REQBUFS, struct dmx_re <<
23 30
24 Arguments 31 Arguments
25 ========= 32 =========
26 33
27 ``fd`` 34 ``fd``
28 File descriptor returned by :c:func:`open( !! 35 File descriptor returned by :ref:`open() <dmx_fopen>`.
29 36
30 ``argp`` 37 ``argp``
31 Pointer to struct :c:type:`dmx_requestbuff 38 Pointer to struct :c:type:`dmx_requestbuffers`.
32 39
33 Description 40 Description
34 =========== 41 ===========
35 42
36 This ioctl is used to initiate a memory mapped 43 This ioctl is used to initiate a memory mapped or DMABUF based demux I/O.
37 44
38 Memory mapped buffers are located in device me 45 Memory mapped buffers are located in device memory and must be allocated
39 with this ioctl before they can be mapped into 46 with this ioctl before they can be mapped into the application's address
40 space. User buffers are allocated by applicati 47 space. User buffers are allocated by applications themselves, and this
41 ioctl is merely used to switch the driver into 48 ioctl is merely used to switch the driver into user pointer I/O mode and
42 to setup some internal structures. Similarly, 49 to setup some internal structures. Similarly, DMABUF buffers are
43 allocated by applications through a device dri 50 allocated by applications through a device driver, and this ioctl only
44 configures the driver into DMABUF I/O mode wit 51 configures the driver into DMABUF I/O mode without performing any direct
45 allocation. 52 allocation.
46 53
47 To allocate device buffers applications initia 54 To allocate device buffers applications initialize all fields of the
48 struct :c:type:`dmx_requestbuffers` structure. 55 struct :c:type:`dmx_requestbuffers` structure. They set the ``count`` field
49 to the desired number of buffers, and ``size` 56 to the desired number of buffers, and ``size`` to the size of each
50 buffer. 57 buffer.
51 58
52 When the ioctl is called with a pointer to thi 59 When the ioctl is called with a pointer to this structure, the driver will
53 attempt to allocate the requested number of bu 60 attempt to allocate the requested number of buffers and it stores the actual
54 number allocated in the ``count`` field. The ` 61 number allocated in the ``count`` field. The ``count`` can be smaller than the number requested, even zero, when the driver runs out of free memory. A larger
55 number is also possible when the driver requir 62 number is also possible when the driver requires more buffers to
56 function correctly. The actual allocated buffe 63 function correctly. The actual allocated buffer size can is returned
57 at ``size``, and can be smaller than what's re 64 at ``size``, and can be smaller than what's requested.
58 65
59 When this I/O method is not supported, the ioc 66 When this I/O method is not supported, the ioctl returns an ``EOPNOTSUPP``
60 error code. 67 error code.
61 68
62 Applications can call :ref:`DMX_REQBUFS` again 69 Applications can call :ref:`DMX_REQBUFS` again to change the number of
63 buffers, however this cannot succeed when any 70 buffers, however this cannot succeed when any buffers are still mapped.
64 A ``count`` value of zero frees all buffers, a 71 A ``count`` value of zero frees all buffers, after aborting or finishing
65 any DMA in progress. 72 any DMA in progress.
>> 73
66 74
67 Return Value 75 Return Value
68 ============ 76 ============
69 77
70 On success 0 is returned, on error -1 and the 78 On success 0 is returned, on error -1 and the ``errno`` variable is set
71 appropriately. The generic error codes are des 79 appropriately. The generic error codes are described at the
72 :ref:`Generic Error Codes <gen-errors>` chapte 80 :ref:`Generic Error Codes <gen-errors>` chapter.
73 81
74 EOPNOTSUPP 82 EOPNOTSUPP
75 The the requested I/O method is not suppo 83 The the requested I/O method is not supported.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.