xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/dvb/fe-get-event.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun.. c:namespace:: DTV.fe
3*4882a593Smuzhiyun
4*4882a593Smuzhiyun.. _FE_GET_EVENT:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun************
7*4882a593SmuzhiyunFE_GET_EVENT
8*4882a593Smuzhiyun************
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunName
11*4882a593Smuzhiyun====
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunFE_GET_EVENT
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun.. attention:: This ioctl is deprecated.
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunSynopsis
18*4882a593Smuzhiyun========
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun.. c:macro:: FE_GET_EVENT
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun``int ioctl(int fd, FE_GET_EVENT, struct dvb_frontend_event *ev)``
23*4882a593Smuzhiyun
24*4882a593SmuzhiyunArguments
25*4882a593Smuzhiyun=========
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun``fd``
28*4882a593Smuzhiyun    File descriptor returned by :c:func:`open()`.
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun``ev``
31*4882a593Smuzhiyun    Points to the location where the event, if any, is to be stored.
32*4882a593Smuzhiyun
33*4882a593SmuzhiyunDescription
34*4882a593Smuzhiyun===========
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunThis ioctl call returns a frontend event if available. If an event is
37*4882a593Smuzhiyunnot available, the behavior depends on whether the device is in blocking
38*4882a593Smuzhiyunor non-blocking mode. In the latter case, the call fails immediately
39*4882a593Smuzhiyunwith errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
40*4882a593Smuzhiyunan event becomes available.
41*4882a593Smuzhiyun
42*4882a593SmuzhiyunReturn Value
43*4882a593Smuzhiyun============
44*4882a593Smuzhiyun
45*4882a593SmuzhiyunOn success 0 is returned.
46*4882a593Smuzhiyun
47*4882a593SmuzhiyunOn error -1 is returned, and the ``errno`` variable is set
48*4882a593Smuzhiyunappropriately.
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun.. flat-table::
51*4882a593Smuzhiyun    :header-rows:  0
52*4882a593Smuzhiyun    :stub-columns: 0
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun    -  .. row 1
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun       -  ``EWOULDBLOCK``
57*4882a593Smuzhiyun
58*4882a593Smuzhiyun       -  There is no event pending, and the device is in non-blocking mode.
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun    -  .. row 2
61*4882a593Smuzhiyun
62*4882a593Smuzhiyun       -  ``EOVERFLOW``
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun       -  Overflow in event queue - one or more events were lost.
65*4882a593Smuzhiyun
66*4882a593SmuzhiyunGeneric error codes are described at the
67*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter.
68