Commit | Line | Data |
---|---|---|
5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
af4a4d0d | 3 | .. _VIDIOC_QUERYBUF: |
5377d91f MH |
4 | |
5 | ********************* | |
6 | ioctl VIDIOC_QUERYBUF | |
7 | ********************* | |
8 | ||
15e7d615 | 9 | Name |
586027ce | 10 | ==== |
5377d91f | 11 | |
586027ce | 12 | VIDIOC_QUERYBUF - Query the status of a buffer |
5377d91f | 13 | |
15e7d615 MCC |
14 | |
15 | Synopsis | |
5377d91f MH |
16 | ======== |
17 | ||
b7e67f6c | 18 | .. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp ) |
5377d91f | 19 | |
586027ce | 20 | |
15e7d615 | 21 | Arguments |
5377d91f MH |
22 | ========= |
23 | ||
24 | ``fd`` | |
25 | File descriptor returned by :ref:`open() <func-open>`. | |
26 | ||
27 | ``request`` | |
28 | VIDIOC_QUERYBUF | |
29 | ||
30 | ``argp`` | |
31 | ||
32 | ||
15e7d615 | 33 | Description |
5377d91f MH |
34 | =========== |
35 | ||
36 | This ioctl is part of the :ref:`streaming <mmap>` I/O method. It can | |
37 | be used to query the status of a buffer at any time after buffers have | |
7347081e | 38 | been allocated with the :ref:`VIDIOC_REQBUFS` ioctl. |
5377d91f MH |
39 | |
40 | Applications set the ``type`` field of a struct | |
41 | :ref:`v4l2_buffer <v4l2-buffer>` to the same buffer type as was | |
42 | previously used with struct :ref:`v4l2_format <v4l2-format>` ``type`` | |
43 | and struct :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``type``, | |
44 | and the ``index`` field. Valid index numbers range from zero to the | |
45 | number of buffers allocated with | |
7347081e | 46 | :ref:`VIDIOC_REQBUFS` (struct |
5377d91f MH |
47 | :ref:`v4l2_requestbuffers <v4l2-requestbuffers>` ``count``) minus |
48 | one. The ``reserved`` and ``reserved2`` fields must be set to 0. When | |
49 | using the :ref:`multi-planar API <planar-apis>`, the ``m.planes`` | |
50 | field must contain a userspace pointer to an array of struct | |
51 | :ref:`v4l2_plane <v4l2-plane>` and the ``length`` field has to be set | |
52 | to the number of elements in that array. After calling | |
2212ff25 | 53 | :ref:`VIDIOC_QUERYBUF` with a pointer to this structure drivers return an |
5377d91f MH |
54 | error code or fill the rest of the structure. |
55 | ||
56 | In the ``flags`` field the ``V4L2_BUF_FLAG_MAPPED``, | |
57 | ``V4L2_BUF_FLAG_PREPARED``, ``V4L2_BUF_FLAG_QUEUED`` and | |
58 | ``V4L2_BUF_FLAG_DONE`` flags will be valid. The ``memory`` field will be | |
59 | set to the current I/O method. For the single-planar API, the | |
60 | ``m.offset`` contains the offset of the buffer from the start of the | |
61 | device memory, the ``length`` field its size. For the multi-planar API, | |
62 | fields ``m.mem_offset`` and ``length`` in the ``m.planes`` array | |
63 | elements will be used instead and the ``length`` field of struct | |
64 | :ref:`v4l2_buffer <v4l2-buffer>` is set to the number of filled-in | |
65 | array elements. The driver may or may not set the remaining fields and | |
66 | flags, they are meaningless in this context. | |
67 | ||
acf309a2 | 68 | The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in |
5377d91f MH |
69 | :ref:`buffer`. |
70 | ||
71 | ||
15e7d615 | 72 | Return Value |
5377d91f MH |
73 | ============ |
74 | ||
75 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
76 | appropriately. The generic error codes are described at the | |
77 | :ref:`Generic Error Codes <gen-errors>` chapter. | |
78 | ||
79 | EINVAL | |
80 | The buffer ``type`` is not supported, or the ``index`` is out of | |
81 | bounds. |