mirror of
https://github.com/FEX-Emu/linux.git
synced 2024-12-21 00:42:16 +00:00
5ccbb182d7
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 to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
70 lines
1.3 KiB
ReStructuredText
70 lines
1.3 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _media-func-open:
|
|
|
|
************
|
|
media open()
|
|
************
|
|
|
|
Name
|
|
====
|
|
|
|
media-open - Open a media device
|
|
|
|
|
|
Synopsis
|
|
========
|
|
|
|
.. code-block:: c
|
|
|
|
#include <fcntl.h>
|
|
|
|
|
|
.. c:function:: int open( const char *device_name, int flags )
|
|
:name: mc-open
|
|
|
|
Arguments
|
|
=========
|
|
|
|
``device_name``
|
|
Device to be opened.
|
|
|
|
``flags``
|
|
Open flags. Access mode must be either ``O_RDONLY`` or ``O_RDWR``.
|
|
Other flags have no effect.
|
|
|
|
|
|
Description
|
|
===========
|
|
|
|
To open a media device applications call :ref:`open() <media-func-open>` with the
|
|
desired device name. The function has no side effects; the device
|
|
configuration remain unchanged.
|
|
|
|
When the device is opened in read-only mode, attempts to modify its
|
|
configuration will result in an error, and ``errno`` will be set to
|
|
EBADF.
|
|
|
|
|
|
Return Value
|
|
============
|
|
|
|
:ref:`open() <func-open>` returns the new file descriptor on success. On error,
|
|
-1 is returned, and ``errno`` is set appropriately. Possible error codes
|
|
are:
|
|
|
|
EACCES
|
|
The requested access to the file is not allowed.
|
|
|
|
EMFILE
|
|
The process already has the maximum number of files open.
|
|
|
|
ENFILE
|
|
The system limit on the total number of open files has been reached.
|
|
|
|
ENOMEM
|
|
Insufficient kernel memory was available.
|
|
|
|
ENXIO
|
|
No device corresponding to this device special file exists.
|