2
0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-28 23:23:55 +08:00
linux-next/Documentation/media/uapi/dvb/video-set-system.rst
Mauro Carvalho Chehab cf8076c314 [media] docs-rst: Convert DVB uAPI to use C function references
Name all ioctl references and make them match the ioctls that
are documented. That will improve the cross-reference index,
as it will have all ioctls and syscalls there.

While here, improve the documentation, marking the deprecated
ioctls, and making the non-deprecated ones more like the rest
of the media book.

Also, add a notice for ioctls that still require documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-22 21:23:34 -03:00

78 lines
1.3 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _VIDEO_SET_SYSTEM:
================
VIDEO_SET_SYSTEM
================
Name
----
VIDEO_SET_SYSTEM
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, VIDEO_SET_SYSTEM , video_system_t system)
:name: VIDEO_SET_SYSTEM
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_FORMAT for this command.
- .. row 3
- video_system_t system
- video system of TV output.
Description
-----------
This ioctl sets the television output format. The format (see section
??) may vary from the color format of the displayed MPEG stream. If the
hardware is not able to display the requested format the call will
return an error.
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``
- system is not a valid or supported video system.