Commit 2889017c authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

media: dmx.h: get rid of GET_DMX_EVENT 



This seems to be a pure fictional API :-)

It only exists at the DVB book, with no code implemeting it.

So, just get rid of it.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 13adefbe

Documentation/media/uapi/dvb/dmx-get-event.rst

deleted100644 → 0
+0 −60
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _DMX_GET_EVENT:



=============

DMX_GET_EVENT

=============



Name

----



DMX_GET_EVENT





Synopsis

--------



.. c:function:: int ioctl( int fd, DMX_GET_EVENT, struct dmx_event *ev)

    :name: DMX_GET_EVENT





Arguments

---------



``fd``

    File descriptor returned by :c:func:`open() <dvb-dmx-open>`.



``ev``

    Pointer to the location where the event is to be stored.





Description

-----------



This ioctl call returns an event if available. If an event is not

available, the behavior depends on whether the device is in blocking or

non-blocking mode. In the latter case, the call fails immediately with

errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an

event becomes available.





Return Value

------------



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the

:ref:`Generic Error Codes <gen-errors>` chapter.







.. flat-table::

    :header-rows:  0

    :stub-columns: 0





    -  .. row 1



       -  ``EWOULDBLOCK``



       -  There is no event pending, and the device is in non-blocking mode.

Documentation/media/uapi/dvb/dmx_fcalls.rst

+0 −1
Original line number Diff line number Diff line
@@ -18,7 +18,6 @@ Demux Function Calls 
    dmx-set-filter

    dmx-set-pes-filter

    dmx-set-buffer-size

    dmx-get-event

    dmx-get-stc

    dmx-get-pes-pids

    dmx-add-pid

Documentation/media/uapi/dvb/dmx_types.rst

+0 −19
Original line number Diff line number Diff line
@@ -166,25 +166,6 @@ struct dmx_pes_filter_params 
	__u32          flags;

    };





struct dmx_event

================



.. c:type:: dmx_event



.. code-block:: c



     struct dmx_event

     {

	 dmx_event_t          event;

	 time_t               timeStamp;

	 union

	 {

	     dmx_scrambling_status_t scrambling;

	 } u;

     };





struct dmx_stc

==============