Commit b41e44b4 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

media: dvb/video.h: get rid of unused APIs



There are a number of other ioctls that aren't used anywhere
inside the Kernel tree.

Get rid of them.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
parent ea8532da
Loading
Loading
Loading
Loading
+0 −61
Original line number Diff line number Diff line
.. -*- coding: utf-8; mode: rst -*-

.. _VIDEO_GET_FRAME_RATE:

====================
VIDEO_GET_FRAME_RATE
====================

Name
----

VIDEO_GET_FRAME_RATE

.. attention:: This ioctl is deprecated.

Synopsis
--------

.. c:function:: int ioctl(int fd, VIDEO_GET_FRAME_RATE, unsigned int *rate)
    :name: VIDEO_GET_FRAME_RATE


Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  int fd

       -  File descriptor returned by a previous call to open().

    -  .. row 2

       -  int request

       -  Equals VIDEO_GET_FRAME_RATE for this command.

    -  .. row 3

       -  unsigned int \*rate

       -  Returns the framerate in number of frames per 1000 seconds.


Description
-----------

This ioctl call asks the Video Device to return the current framerate.


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.
+0 −84
Original line number Diff line number Diff line
.. -*- coding: utf-8; mode: rst -*-

.. _VIDEO_GET_NAVI:

==============
VIDEO_GET_NAVI
==============

Name
----

VIDEO_GET_NAVI

.. attention:: This ioctl is deprecated.

Synopsis
--------

.. c:function:: int ioctl(fd, VIDEO_GET_NAVI , struct video_navi_pack *navipack)
    :name: VIDEO_GET_NAVI


Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  int fd

       -  File descriptor returned by a previous call to open().

    -  .. row 2

       -  int request

       -  Equals VIDEO_GET_NAVI for this command.

    -  .. row 3

       -  video_navi_pack_t \*navipack

       -  PCI or DSI pack (private stream 2) according to section ??.


Description
-----------

This ioctl returns navigational information from the DVD stream. This is
especially needed if an encoded stream has to be decoded by the
hardware.

.. c:type:: video_navi_pack

.. code-block::c

	typedef struct video_navi_pack {
		int length;          /* 0 ... 1024 */
		__u8 data[1024];
	} video_navi_pack_t;

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

       -  ``EFAULT``

       -  driver is not able to return navigational information
+0 −93
Original line number Diff line number Diff line
.. -*- coding: utf-8; mode: rst -*-

.. _VIDEO_SET_ATTRIBUTES:

====================
VIDEO_SET_ATTRIBUTES
====================

Name
----

VIDEO_SET_ATTRIBUTES

.. attention:: This ioctl is deprecated.

Synopsis
--------

.. c:function:: int ioctl(fd, VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
    :name: VIDEO_SET_ATTRIBUTE


Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  int fd

       -  File descriptor returned by a previous call to open().

    -  .. row 2

       -  int request

       -  Equals VIDEO_SET_ATTRIBUTE for this command.

    -  .. row 3

       -  video_attributes_t vattr

       -  video attributes according to section ??.


Description
-----------

This ioctl is intended for DVD playback and allows you to set certain
information about the stream. Some hardware may not need this
information, but the call also tells the hardware to prepare for DVD
playback.

.. c:type:: video_attributes_t

.. code-block::c

	typedef __u16 video_attributes_t;
	/*   bits: descr. */
	/*   15-14 Video compression mode (0=MPEG-1, 1=MPEG-2) */
	/*   13-12 TV system (0=525/60, 1=625/50) */
	/*   11-10 Aspect ratio (0=4:3, 3=16:9) */
	/*    9- 8 permitted display mode on 4:3 monitor (0=both, 1=only pan-sca */
	/*    7    line 21-1 data present in GOP (1=yes, 0=no) */
	/*    6    line 21-2 data present in GOP (1=yes, 0=no) */
	/*    5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */
	/*    2    source letterboxed (1=yes, 0=no) */
	/*    0    film/camera mode (0=camera, 1=film (625/50 only)) */


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

       -  ``EINVAL``

       -  input is not a valid attribute setting.
+0 −86
Original line number Diff line number Diff line
.. -*- coding: utf-8; mode: rst -*-

.. _VIDEO_SET_HIGHLIGHT:

===================
VIDEO_SET_HIGHLIGHT
===================

Name
----

VIDEO_SET_HIGHLIGHT

.. attention:: This ioctl is deprecated.

Synopsis
--------

.. c:function:: int ioctl(fd, VIDEO_SET_HIGHLIGHT, struct video_highlight *vhilite)
    :name: VIDEO_SET_HIGHLIGHT


Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  int fd

       -  File descriptor returned by a previous call to open().

    -  .. row 2

       -  int request

       -  Equals VIDEO_SET_HIGHLIGHT for this command.

    -  .. row 3

       -  video_highlight_t \*vhilite

       -  SPU Highlight information according to section ??.


Description
-----------

This ioctl sets the SPU highlight information for the menu access of a
DVD.

.. c:type:: video_highlight

.. code-block:: c

	typedef
	struct video_highlight {
		int     active;      /*    1=show highlight, 0=hide highlight */
		__u8    contrast1;   /*    7- 4  Pattern pixel contrast */
				/*    3- 0  Background pixel contrast */
		__u8    contrast2;   /*    7- 4  Emphasis pixel-2 contrast */
				/*    3- 0  Emphasis pixel-1 contrast */
		__u8    color1;      /*    7- 4  Pattern pixel color */
				/*    3- 0  Background pixel color */
		__u8    color2;      /*    7- 4  Emphasis pixel-2 color */
				/*    3- 0  Emphasis pixel-1 color */
		__u32    ypos;       /*   23-22  auto action mode */
				/*   21-12  start y */
				/*    9- 0  end y */
		__u32    xpos;       /*   23-22  button color number */
				/*   21-12  start x */
				/*    9- 0  end x */
	} video_highlight_t;



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.
+0 −75
Original line number Diff line number Diff line
.. -*- coding: utf-8; mode: rst -*-

.. _VIDEO_SET_ID:

============
VIDEO_SET_ID
============

Name
----

VIDEO_SET_ID

.. attention:: This ioctl is deprecated.

Synopsis
--------

.. c:function:: int ioctl(int fd, VIDEO_SET_ID, int id)
    :name: VIDEO_SET_ID


Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  int fd

       -  File descriptor returned by a previous call to open().

    -  .. row 2

       -  int request

       -  Equals VIDEO_SET_ID for this command.

    -  .. row 3

       -  int id

       -  video sub-stream id


Description
-----------

This ioctl selects which sub-stream is to be decoded if a program or
system stream is sent to the video device.


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

       -  ``EINVAL``

       -  Invalid sub-stream id.
Loading