Commit cf8076c3 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 41d80465
......@@ -11,11 +11,13 @@ Name
AUDIO_BILINGUAL_CHANNEL_SELECT
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
.. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
:name: AUDIO_BILINGUAL_CHANNEL_SELECT
Arguments
......@@ -25,20 +27,13 @@ Arguments
:header-rows: 0
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_BILINGUAL_CHANNEL_SELECT for this command.
- .. row 3
-
- audio_channel_select_t ch
......
......@@ -11,11 +11,13 @@ Name
AUDIO_CHANNEL_SELECT
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
.. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, audio_channel_select_t)
:name: AUDIO_CHANNEL_SELECT
Arguments
......@@ -26,19 +28,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_CHANNEL_SELECT for this command.
- .. row 3
-
- audio_channel_select_t ch
......
......@@ -11,12 +11,13 @@ Name
AUDIO_CLEAR_BUFFER
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
.. c:function:: int ioctl(int fd, AUDIO_CLEAR_BUFFER)
:name: AUDIO_CLEAR_BUFFER
Arguments
---------
......@@ -32,13 +33,6 @@ Arguments
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_CLEAR_BUFFER for this command.
Description
-----------
......
......@@ -11,11 +11,13 @@ Name
AUDIO_CONTINUE
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CONTINUE)
.. c:function:: int ioctl(int fd, AUDIO_CONTINUE)
:name: AUDIO_CONTINUE
Arguments
......@@ -32,13 +34,6 @@ Arguments
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_CONTINUE for this command.
Description
-----------
......
......@@ -11,11 +11,13 @@ Name
DVB audio close()
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int close(int fd)
:name: dvb-audio-close
Arguments
......
......@@ -11,11 +11,13 @@ Name
DVB audio open()
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
:name: dvb-audio-open
Arguments
......
......@@ -11,11 +11,13 @@ Name
DVB audio write()
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: size_t write(int fd, const void *buf, size_t count)
:name: dvb-audio-write
Arguments
......
......@@ -11,11 +11,13 @@ Name
AUDIO_GET_CAPABILITIES
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap)
.. c:function:: int ioctl(int fd, AUDIO_GET_CAPABILITIES, unsigned int *cap)
:name: AUDIO_GET_CAPABILITIES
Arguments
......@@ -26,19 +28,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_GET_CAPABILITIES for this command.
- .. row 3
-
- unsigned int \*cap
......
......@@ -11,11 +11,13 @@ Name
AUDIO_GET_PTS
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
.. c:function:: int ioctl(int fd, AUDIO_GET_PTS, __u64 *pts)
:name: AUDIO_GET_PTS
Arguments
......@@ -26,19 +28,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_GET_PTS for this command.
- .. row 3
-
- __u64 \*pts
......
......@@ -11,11 +11,13 @@ Name
AUDIO_GET_STATUS
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
.. c:function:: int ioctl(int fd, AUDIO_GET_STATUS, struct audio_status *status)
:name: AUDIO_GET_STATUS
Arguments
......@@ -26,19 +28,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_GET_STATUS for this command.
- .. row 3
-
- struct audio_status \*status
......
......@@ -11,12 +11,13 @@ Name
AUDIO_PAUSE
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
.. c:function:: int ioctl(int fd, AUDIO_PAUSE)
:name: AUDIO_PAUSE
Arguments
---------
......@@ -32,12 +33,6 @@ Arguments
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_PAUSE for this command.
Description
-----------
......
......@@ -11,11 +11,13 @@ Name
AUDIO_PLAY
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PLAY)
.. c:function:: int ioctl(int fd, AUDIO_PLAY)
:name: AUDIO_PLAY
Arguments
......@@ -32,13 +34,6 @@ Arguments
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_PLAY for this command.
Description
-----------
......
......@@ -11,11 +11,13 @@ Name
AUDIO_SELECT_SOURCE
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source)
.. c:function:: int ioctl(int fd, AUDIO_SELECT_SOURCE, audio_stream_source_t source)
:name: AUDIO_SELECT_SOURCE
Arguments
......@@ -26,19 +28,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_SELECT_SOURCE for this command.
- .. row 3
-
- audio_stream_source_t source
......
......@@ -11,12 +11,14 @@ Name
AUDIO_SET_ATTRIBUTES
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
.. c:function:: int ioctl(fd, AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
:name: AUDIO_SET_ATTRIBUTES
Arguments
---------
......@@ -26,19 +28,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_SET_ATTRIBUTES for this command.
- .. row 3
-
- audio_attributes_t attr
......
......@@ -11,11 +11,13 @@ Name
AUDIO_SET_AV_SYNC
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
.. c:function:: int ioctl(int fd, AUDIO_SET_AV_SYNC, boolean state)
:name: AUDIO_SET_AV_SYNC
Arguments
......@@ -26,33 +28,21 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_AV_SYNC for this command.
- .. row 3
-
- boolean state
- Tells the DVB subsystem if A/V synchronization shall be ON or OFF.
- .. row 4
TRUE: AV-sync ON
-
- TRUE AV-sync ON
- .. row 5
-
- FALSE AV-sync OFF
FALSE: AV-sync OFF
Description
......
......@@ -11,12 +11,13 @@ Name
AUDIO_SET_BYPASS_MODE
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
.. c:function:: int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode)
:name: AUDIO_SET_BYPASS_MODE
Arguments
---------
......@@ -26,34 +27,22 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_SET_BYPASS_MODE for this command.
- .. row 3
-
- boolean mode
- Enables or disables the decoding of the current Audio stream in
the DVB subsystem.
- .. row 4
-
- TRUE Bypass is disabled
TRUE: Bypass is disabled
- .. row 5
-
- FALSE Bypass is enabled
FALSE: Bypass is enabled
Description
......
......@@ -11,12 +11,13 @@ Name
AUDIO_SET_EXT_ID
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id)
.. c:function:: int ioctl(fd, AUDIO_SET_EXT_ID, int id)
:name: AUDIO_SET_EXT_ID
Arguments
---------
......@@ -26,19 +27,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_SET_EXT_ID for this command.
- .. row 3
-
- int id
......
......@@ -11,12 +11,13 @@ Name
AUDIO_SET_ID
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id)
.. c:function:: int ioctl(int fd, AUDIO_SET_ID, int id)
:name: AUDIO_SET_ID
Arguments
---------
......@@ -26,19 +27,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_SET_ID for this command.
- .. row 3
-
- int id
......
......@@ -11,11 +11,13 @@ Name
AUDIO_SET_KARAOKE
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
.. c:function:: int ioctl(fd, AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
:name: AUDIO_SET_KARAOKE
Arguments
......@@ -26,19 +28,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_SET_KARAOKE for this command.
- .. row 3
-
- audio_karaoke_t \*karaoke
......
......@@ -11,12 +11,13 @@ Name
AUDIO_SET_MIXER
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix)
.. c:function:: int ioctl(int fd, AUDIO_SET_MIXER, audio_mixer_t *mix)
:name: AUDIO_SET_MIXER
Arguments
---------
......@@ -26,19 +27,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_SET_ID for this command.
- .. row 3
-
- audio_mixer_t \*mix
......
......@@ -11,11 +11,13 @@ Name
AUDIO_SET_MUTE
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)
.. c:function:: int ioctl(int fd, AUDIO_SET_MUTE, boolean state)
:name: AUDIO_SET_MUTE
Arguments
......@@ -26,33 +28,21 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_SET_MUTE for this command.
- .. row 3
-
- boolean state
- Indicates if audio device shall mute or not.
- .. row 4
TRUE: Audio Mute
-
- TRUE Audio Mute
- .. row 5
-
- FALSE Audio Un-mute
FALSE: Audio Un-mute
Description
......
......@@ -11,11 +11,13 @@ Name
AUDIO_SET_STREAMTYPE
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type)
.. c:function:: int ioctl(fd, AUDIO_SET_STREAMTYPE, int type)
:name: AUDIO_SET_STREAMTYPE
Arguments
......@@ -26,19 +28,13 @@ Arguments
:stub-columns: 0
- .. row 1
-
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_SET_STREAMTYPE for this command.
- .. row 3
-
- int type
......
......@@ -11,12 +11,13 @@ Name
AUDIO_STOP
.. attention:: This ioctl is deprecated
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_STOP)
.. c:function:: int ioctl(int fd, AUDIO_STOP)
:name: AUDIO_STOP
Arguments
---------
......@@ -32,12 +33,6 @@ Arguments
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_STOP for this command.
Description
-----------
......
......@@ -16,27 +16,19 @@ Synopsis
--------
.. c:function:: int close(int fd)
:name: dvb-ca-close
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
Description
-----------
This system call closes a previously opened audio device.
This system call closes a previously opened CA device.
Return Value
......
......@@ -15,48 +15,35 @@ DVB CA open()
Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
.. c:function:: int open(const char *name, int flags)
:name: dvb-ca-open
Arguments
---------
``name``
Name of specific DVB CA device.
``flags``
A bit-wise OR of the following flags:
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- const char \*deviceName
- Name of specific video device.
- .. row 2
- int flags
- A bit-wise OR of the following flags:
- .. row 3
-
- O_RDONLY read-only access
- .. row 4
- O_RDONLY
- read-only access
-
- O_RDWR read/write access
- .. row 5
-
- O_NONBLOCK open in non-blocking mode
- .. row 6
- O_RDWR
- read/write access
-
- (blocking mode is the default)
- O_NONBLOCK
- open in non-blocking mode
(blocking mode is the default)
Description
......
......@@ -15,40 +15,24 @@ CA_GET_CAP
Synopsis
--------
.. c:function:: int ioctl(fd, int request = CA_GET_CAP, ca_caps_t *)
.. c:function:: int ioctl(fd, CA_GET_CAP, ca_caps_t *caps)
:name: CA_GET_CAP
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals CA_GET_CAP for this command.
- .. row 3
- ca_caps_t *
- Undocumented.
``caps``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,40 +15,23 @@ CA_GET_DESCR_INFO
Synopsis
--------
.. c:function:: int ioctl(fd, int request = CA_GET_DESCR_INFO, ca_descr_info_t *)
.. c:function:: int ioctl(fd, CA_GET_DESCR_INFO, ca_descr_info_t *desc)
:name: CA_GET_DESCR_INFO
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 CA_GET_DESCR_INFO for this command.
- .. row 3
- ca_descr_info_t \*
``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
- Undocumented.
``desc``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,40 +15,24 @@ CA_GET_MSG
Synopsis
--------
.. c:function:: int ioctl(fd, int request = CA_GET_MSG, ca_msg_t *)
.. c:function:: int ioctl(fd, CA_GET_MSG, ca_msg_t *msg)
:name: CA_GET_MSG
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals CA_GET_MSG for this command.
- .. row 3
- ca_msg_t \*
- Undocumented.
``msg``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,40 +15,24 @@ CA_GET_SLOT_INFO
Synopsis
--------
.. c:function:: int ioctl(fd, int request = CA_GET_SLOT_INFO, ca_slot_info_t *)
.. c:function:: int ioctl(fd, CA_GET_SLOT_INFO, ca_slot_info_t *info)
:name: CA_GET_SLOT_INFO
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals CA_GET_SLOT_INFO for this command.
- .. row 3
- ca_slot_info_t \*
- Undocumented.
``info``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,34 +15,20 @@ CA_RESET
Synopsis
--------
.. c:function:: int ioctl(fd, int request = CA_RESET)
.. c:function:: int ioctl(fd, CA_RESET)
:name: CA_RESET
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 CA_RESET for this command.
``fd``
File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,40 +15,24 @@ CA_SEND_MSG
Synopsis
--------
.. c:function:: int ioctl(fd, int request = CA_SEND_MSG, ca_msg_t *)
.. c:function:: int ioctl(fd, CA_SEND_MSG, ca_msg_t *msg)
:name: CA_SEND_MSG
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals CA_SEND_MSG for this command.
- .. row 3
- ca_msg_t \*
- Undocumented.
``msg``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,40 +15,24 @@ CA_SET_DESCR
Synopsis
--------
.. c:function:: int ioctl(fd, int request = CA_SET_DESCR, ca_descr_t *)
.. c:function:: int ioctl(fd, CA_SET_DESCR, ca_descr_t *desc)
:name:
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals CA_SET_DESCR for this command.
- .. row 3
- ca_descr_t \*
- Undocumented.
``msg``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,40 +15,24 @@ CA_SET_PID
Synopsis
--------
.. c:function:: int ioctl(fd, int request = CA_SET_PID, ca_pid_t *)
.. c:function:: int ioctl(fd, CA_SET_PID, ca_pid_t *pid)
:name: CA_SET_PID
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals CA_SET_PID for this command.
- .. row 3
- ca_pid_t \*
- Undocumented.
``pid``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,34 +15,18 @@ DMX_ADD_PID
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *)
.. c:function:: int ioctl(fd, DMX_ADD_PID, __u16 *pid)
:name: DMX_ADD_PID
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals DMX_ADD_PID for this command.
- .. row 3
- __u16 *
- PID number to be filtered.
``pid``
PID number to be filtered.
Description
......
......@@ -16,22 +16,14 @@ Synopsis
--------
.. c:function:: int close(int fd)
:name: dvb-dmx-close
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
Description
-----------
......
......@@ -16,42 +16,33 @@ Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
:name: dvb-dmx-open
Arguments
---------
``name``
Name of specific DVB demux device.
``flags``
A bit-wise OR of the following flags:
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- const char \*deviceName
- Name of demux device.
- .. row 2
- int flags
- A bit-wise OR of the following flags:
- .. row 3
-
- O_RDWR read/write access
- .. row 4
- O_RDONLY
- read-only access
-
- O_NONBLOCK open in non-blocking mode
- .. row 5
- O_RDWR
- read/write access
-
- (blocking mode is the default)
- O_NONBLOCK
- open in non-blocking mode
(blocking mode is the default)
Description
......
......@@ -16,34 +16,19 @@ Synopsis
--------
.. c:function:: size_t read(int fd, void *buf, size_t count)
:name: dvb-dmx-read
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- void \*buf
- Pointer to the buffer to be used for returned filtered data.
- .. row 3
- size_t count
``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
- Size of buf.
``buf``
Buffer to be filled
``count``
Max number of bytes to read
Description
-----------
......
......@@ -16,34 +16,19 @@ Synopsis
--------
.. c:function:: ssize_t write(int fd, const void *buf, size_t count)
:name: dvb-dmx-write
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
``buf``
Buffer with data to be written
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- void \*buf
- Pointer to the buffer containing the Transport Stream.
- .. row 3
- size_t count
- Size of buf.
``count``
Number of bytes at the buffer
Description
-----------
......@@ -65,7 +50,6 @@ Return Value
:header-rows: 0
:stub-columns: 0
- .. row 1
- ``EWOULDBLOCK``
......
......@@ -15,40 +15,23 @@ DMX_GET_CAPS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
.. c:function:: int ioctl(fd, DMX_GET_CAPS, dmx_caps_t *caps)
:name: DMX_GET_CAPS
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 DMX_GET_CAPS for this command.
- .. row 3
- dmx_caps_t *
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
- Undocumented.
``caps``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,34 +15,18 @@ DMX_GET_EVENT
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
.. c:function:: int ioctl( int fd, DMX_GET_EVENT, struct dmx_event *ev)
:name: DMX_GET_EVENT
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 DMX_GET_EVENT for this command.
- .. row 3
- struct dmx_event \*ev
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
- Pointer to the location where the event is to be stored.
``ev``
Pointer to the location where the event is to be stored.
Description
......
......@@ -15,40 +15,23 @@ DMX_GET_PES_PIDS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
.. c:function:: int ioctl(fd, DMX_GET_PES_PIDS, __u16 pids[5])
:name: DMX_GET_PES_PIDS
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 DMX_GET_PES_PIDS for this command.
- .. row 3
- __u16[5]
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
- Undocumented.
``pids``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,34 +15,17 @@ DMX_GET_STC
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
.. c:function:: int ioctl( int fd, DMX_GET_STC, struct dmx_stc *stc)
:name: DMX_GET_STC
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- int fd
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals DMX_GET_STC for this command.
- .. row 3
- struct dmx_stc \*stc
- Pointer to the location where the stc is to be stored.
``stc``
Pointer to the location where the stc is to be stored.
Description
......@@ -63,8 +46,6 @@ 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
......
......@@ -15,34 +15,18 @@ DMX_REMOVE_PID
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
.. c:function:: int ioctl(fd, DMX_REMOVE_PID, __u16 *pid)
:name: DMX_REMOVE_PID
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals DMX_REMOVE_PID for this command.
- .. row 3
- __u16 *
- PID of the PES filter to be removed.
``pid``
PID of the PES filter to be removed.
Description
......
......@@ -15,35 +15,18 @@ DMX_SET_BUFFER_SIZE
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
.. c:function:: int ioctl( int fd, DMX_SET_BUFFER_SIZE, unsigned long size)
:name: DMX_SET_BUFFER_SIZE
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 DMX_SET_BUFFER_SIZE for this command.
- .. row 3
- unsigned long size
- Size of circular buffer.
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
``size``
Unsigned long size
Description
-----------
......
......@@ -15,34 +15,18 @@ DMX_SET_FILTER
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params)
.. c:function:: int ioctl( int fd, DMX_SET_FILTER, struct dmx_sct_filter_params *params)
:name: DMX_SET_FILTER
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 DMX_SET_FILTER for this command.
- .. row 3
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
- struct dmx_sct_filter_params \*params
``params``
- Pointer to structure containing filter parameters.
Pointer to structure containing filter parameters.
Description
......
......@@ -15,34 +15,19 @@ DMX_SET_PES_FILTER
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
.. c:function:: int ioctl( int fd, DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
:name: DMX_SET_PES_FILTER
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 DMX_SET_PES_FILTER for this command.
- .. row 3
- struct dmx_pes_filter_params \*params
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
- Pointer to structure containing filter parameters.
``params``
Pointer to structure containing filter parameters.
Description
......
......@@ -15,40 +15,25 @@ DMX_SET_SOURCE
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *)
.. c:function:: int ioctl(fd, DMX_SET_SOURCE, dmx_source_t *src)
:name: DMX_SET_SOURCE
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals DMX_SET_SOURCE for this command.
- .. row 3
- dmx_source_t *
- Undocumented.
``src``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
......
......@@ -15,29 +15,15 @@ DMX_START
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_START)
.. c:function:: int ioctl( int fd, DMX_START)
:name: DMX_START
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 DMX_START for this command.
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
Description
-----------
......
......@@ -15,29 +15,15 @@ DMX_STOP
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_STOP)
.. c:function:: int ioctl( int fd, DMX_STOP)
:name: DMX_STOP
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 DMX_STOP for this command.
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
Description
-----------
......
......@@ -15,7 +15,8 @@ FE_DISEQC_RECV_SLAVE_REPLY - Receives reply from a DiSEqC 2.0 command
Synopsis
========
.. c:function:: int ioctl( int fd, int request, struct dvb_diseqc_slave_reply *argp )
.. c:function:: int ioctl( int fd, FE_DISEQC_RECV_SLAVE_REPLY, struct dvb_diseqc_slave_reply *argp )
:name: FE_DISEQC_RECV_SLAVE_REPLY
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_DISEQC_RECV_SLAVE_REPLY
``argp``
pointer to struct
:ref:`dvb_diseqc_slave_reply <dvb-diseqc-slave-reply>`
......
......@@ -15,7 +15,8 @@ FE_DISEQC_RESET_OVERLOAD - Restores the power to the antenna subsystem, if it wa
Synopsis
========
.. c:function:: int ioctl( int fd, int request, NULL )
.. c:function:: int ioctl( int fd, FE_DISEQC_RESET_OVERLOAD, NULL )
:name: FE_DISEQC_RESET_OVERLOAD
Arguments
......@@ -24,10 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_DISEQC_RESET_OVERLOAD
Description
===========
......
......@@ -15,7 +15,8 @@ FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite se
Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
.. c:function:: int ioctl( int fd, FE_DISEQC_SEND_BURST, enum fe_sec_mini_cmd *tone )
:name: FE_DISEQC_SEND_BURST
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_DISEQC_SEND_BURST
``tone``
pointer to enum :ref:`fe_sec_mini_cmd <fe-sec-mini-cmd>`
......
......@@ -15,7 +15,8 @@ FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command
Synopsis
========
.. c:function:: int ioctl( int fd, int request, struct dvb_diseqc_master_cmd *argp )
.. c:function:: int ioctl( int fd, FE_DISEQC_SEND_MASTER_CMD, struct dvb_diseqc_master_cmd *argp )
:name: FE_DISEQC_SEND_MASTER_CMD
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_DISEQC_SEND_MASTER_CMD
``argp``
pointer to struct
:ref:`dvb_diseqc_master_cmd <dvb-diseqc-master-cmd>`
......
......@@ -15,22 +15,18 @@ FE_DISHNETWORK_SEND_LEGACY_CMD
Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)
.. c:function:: int ioctl(int fd, FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)
:name: FE_DISHNETWORK_SEND_LEGACY_CMD
Arguments
=========
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
- .. row 1
- unsigned long cmd
- sends the specified raw cmd to the dish via DISEqC.
``cmd``
Sends the specified raw cmd to the dish via DISEqC.
Description
......
......@@ -15,7 +15,8 @@ FE_ENABLE_HIGH_LNB_VOLTAGE - Select output DC level between normal LNBf voltages
Synopsis
========
.. c:function:: int ioctl( int fd, int request, unsigned int high )
.. c:function:: int ioctl( int fd, FE_ENABLE_HIGH_LNB_VOLTAGE, unsigned int high )
:name: FE_ENABLE_HIGH_LNB_VOLTAGE
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_ENABLE_HIGH_LNB_VOLTAGE
``high``
Valid flags:
......
......@@ -11,43 +11,24 @@ Name
FE_GET_EVENT
.. attention:: This ioctl is deprecated.
Synopsis
========
.. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)
.. c:function:: int ioctl(int fd, FE_GET_EVENT, struct dvb_frontend_event *ev)
:name: FE_GET_EVENT
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 :ref:`FE_GET_EVENT` for this command.
- .. row 3
- struct dvb_frontend_event \*ev
- Points to the location where the event,
- .. row 4
``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
-
- if any, is to be stored.
``ev``
Points to the location where the event, if any, is to be stored.
Description
......
......@@ -11,39 +11,25 @@ Name
FE_GET_FRONTEND
.. attention:: This ioctl is deprecated.
Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
.. c:function:: int ioctl(int fd, FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
:name: FE_GET_FRONTEND
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 :ref:`FE_SET_FRONTEND` for this
command.
- .. row 3
``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
- struct dvb_frontend_parameters \*p
- Points to parameters for tuning operation.
``p``
Points to parameters for tuning operation.
Description
......
......@@ -15,7 +15,8 @@ FE_GET_INFO - Query DVB frontend capabilities and returns information about the
Synopsis
========
.. c:function:: int ioctl( int fd, int request, struct dvb_frontend_info *argp )
.. c:function:: int ioctl( int fd, FE_GET_INFO, struct dvb_frontend_info *argp )
:name: FE_GET_INFO
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_GET_INFO
``argp``
pointer to struct struct
:ref:`dvb_frontend_info <dvb-frontend-info>`
......
......@@ -15,7 +15,11 @@ FE_SET_PROPERTY - FE_GET_PROPERTY - FE_SET_PROPERTY sets one or more frontend pr
Synopsis
========
.. c:function:: int ioctl( int fd, int request, struct dtv_properties *argp )
.. c:function:: int ioctl( int fd, FE_GET_PROPERTY, struct dtv_properties *argp )
:name: FE_GET_PROPERTY
.. c:function:: int ioctl( int fd, FE_SET_PROPERTY, struct dtv_properties *argp )
:name: FE_SET_PROPERTY
Arguments
......@@ -24,9 +28,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_SET_PROPERTY, FE_GET_PROPERTY
``argp``
pointer to struct :ref:`dtv_properties <dtv-properties>`
......
......@@ -11,37 +11,23 @@ Name
FE_READ_BER
.. attention:: This ioctl is deprecated.
Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
.. c:function:: int ioctl(int fd, FE_READ_BER, uint32_t *ber)
:name: FE_READ_BER
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 :ref:`FE_READ_BER` for this command.
- .. row 3
- uint32_t \*ber
``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
- The bit error rate is stored into \*ber.
``ber``
The bit error rate is stored into \*ber.
Description
......
......@@ -11,40 +11,23 @@ Name
FE_READ_SIGNAL_STRENGTH
.. attention:: This ioctl is deprecated.
Synopsis
========
.. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
.. c:function:: int ioctl( int fd, FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
:name: FE_READ_SIGNAL_STRENGTH
Arguments
=========
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals
:ref:`FE_READ_SIGNAL_STRENGTH`
for this command.
- .. row 3
- uint16_t \*strength
- The signal strength value is stored into \*strength.
``strength``
The signal strength value is stored into \*strength.
Description
......
......@@ -11,38 +11,23 @@ Name
FE_READ_SNR
.. attention:: This ioctl is deprecated.
Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)
.. c:function:: int ioctl(int fd, FE_READ_SNR, int16_t *snr)
:name: FE_READ_SNR
Arguments
=========
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals :ref:`FE_READ_SNR` for this command.
- .. row 3
- uint16_t \*snr
- The signal-to-noise ratio is stored into \*snr.
``snr``
The signal-to-noise ratio is stored into \*snr.
Description
......
......@@ -15,7 +15,8 @@ FE_READ_STATUS - Returns status information about the front-end. This call only
Synopsis
========
.. c:function:: int ioctl( int fd, int request, unsigned int *status )
.. c:function:: int ioctl( int fd, FE_READ_STATUS, unsigned int *status )
:name: FE_READ_STATUS
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_READ_STATUS
``status``
pointer to a bitmask integer filled with the values defined by enum
:ref:`fe_status <fe-status>`.
......
......@@ -11,40 +11,23 @@ Name
FE_READ_UNCORRECTED_BLOCKS
.. attention:: This ioctl is deprecated.
Synopsis
========
.. c:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
.. c:function:: int ioctl( int fd, FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
:name: FE_READ_UNCORRECTED_BLOCKS
Arguments
=========
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals
:ref:`FE_READ_UNCORRECTED_BLOCKS`
for this command.
- .. row 3
- uint32_t \*ublocks
- The total number of uncorrected blocks seen by the driver so far.
``ublocks``
The total number of uncorrected blocks seen by the driver so far.
Description
......
......@@ -15,7 +15,8 @@ FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
Synopsis
========
.. c:function:: int ioctl( int fd, int request, unsigned int flags )
.. c:function:: int ioctl( int fd, FE_SET_FRONTEND_TUNE_MODE, unsigned int flags )
:name: FE_SET_FRONTEND_TUNE_MODE
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_SET_FRONTEND_TUNE_MODE
``flags``
Valid flags:
......
......@@ -6,6 +6,8 @@
FE_SET_FRONTEND
***************
.. attention:: This ioctl is deprecated.
Name
====
......@@ -15,35 +17,18 @@ FE_SET_FRONTEND
Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
.. c:function:: int ioctl(int fd, FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
:name: FE_SET_FRONTEND
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 :ref:`FE_SET_FRONTEND` for this
command.
- .. row 3
- struct dvb_frontend_parameters \*p
``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
- Points to parameters for tuning operation.
``p``
Points to parameters for tuning operation.
Description
......
......@@ -15,7 +15,8 @@ FE_SET_TONE - Sets/resets the generation of the continuous 22kHz tone.
Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_tone_mode *tone )
.. c:function:: int ioctl( int fd, FE_SET_TONE, enum fe_sec_tone_mode *tone )
:name: FE_SET_TONE
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_SET_TONE
``tone``
pointer to enum :ref:`fe_sec_tone_mode <fe-sec-tone-mode>`
......
......@@ -15,7 +15,8 @@ FE_SET_VOLTAGE - Allow setting the DC level sent to the antenna subsystem.
Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_voltage *voltage )
.. c:function:: int ioctl( int fd, FE_SET_VOLTAGE, enum fe_sec_voltage *voltage )
:name: FE_SET_VOLTAGE
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_SET_VOLTAGE
``voltage``
pointer to enum :ref:`fe_sec_voltage <fe-sec-voltage>`
......
......@@ -21,13 +21,13 @@ Synopsis
.. c:function:: int close( int fd )
:name: dvb-fe-close
Arguments
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
Description
......
......@@ -21,7 +21,7 @@ Synopsis
.. c:function:: int open( const char *device_name, int flags )
:name: dvb-fe-open
Arguments
=========
......
......@@ -15,7 +15,8 @@ NET_ADD_IF - Creates a new network interface for a given Packet ID.
Synopsis
========
.. c:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
.. c:function:: int ioctl( int fd, NET_ADD_IF, struct dvb_net_if *net_if )
:name: NET_ADD_IF
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_SET_TONE
``net_if``
pointer to struct :ref:`dvb_net_if <dvb-net-if>`
......
......@@ -15,7 +15,8 @@ NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET
Synopsis
========
.. c:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
.. c:function:: int ioctl( int fd, NET_GET_IF, struct dvb_net_if *net_if )
:name: NET_GET_IF
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_SET_TONE
``net_if``
pointer to struct :ref:`dvb_net_if <dvb-net-if>`
......
......@@ -15,7 +15,8 @@ NET_REMOVE_IF - Removes a network interface.
Synopsis
========
.. c:function:: int ioctl( int fd, int request, int ifnum )
.. c:function:: int ioctl( int fd, NET_REMOVE_IF, int ifnum )
:name: NET_REMOVE_IF
Arguments
......@@ -24,9 +25,6 @@ Arguments
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``request``
FE_SET_TONE
``net_if``
number of the interface to be removed
......
......@@ -11,11 +11,13 @@ Name
VIDEO_CLEAR_BUFFER
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER)
.. c:function:: int ioctl(fd, VIDEO_CLEAR_BUFFER)
:name: VIDEO_CLEAR_BUFFER
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_COMMAND
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
.. c:function:: int ioctl(int fd, VIDEO_COMMAND, struct video_command *cmd)
:name: VIDEO_COMMAND
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_CONTINUE
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_CONTINUE)
.. c:function:: int ioctl(fd, VIDEO_CONTINUE)
:name: VIDEO_CONTINUE
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_FAST_FORWARD
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames)
.. c:function:: int ioctl(fd, VIDEO_FAST_FORWARD, int nFrames)
:name: VIDEO_FAST_FORWARD
Arguments
......
......@@ -11,6 +11,7 @@ Name
dvb video close()
.. attention:: This ioctl is deprecated.
Synopsis
--------
......
......@@ -11,6 +11,7 @@ Name
dvb video open()
.. attention:: This ioctl is deprecated.
Synopsis
--------
......
......@@ -11,11 +11,13 @@ Name
VIDEO_FREEZE
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FREEZE)
.. c:function:: int ioctl(fd, VIDEO_FREEZE)
:name: VIDEO_FREEZE
Arguments
......
......@@ -11,6 +11,7 @@ Name
dvb video write()
.. attention:: This ioctl is deprecated.
Synopsis
--------
......
......@@ -11,11 +11,13 @@ Name
VIDEO_GET_CAPABILITIES
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
.. c:function:: int ioctl(fd, VIDEO_GET_CAPABILITIES, unsigned int *cap)
:name: VIDEO_GET_CAPABILITIES
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_GET_EVENT
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
.. c:function:: int ioctl(fd, VIDEO_GET_EVENT, struct video_event *ev)
:name: VIDEO_GET_EVENT
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_GET_FRAME_COUNT
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
.. c:function:: int ioctl(int fd, VIDEO_GET_FRAME_COUNT, __u64 *pts)
:name: VIDEO_GET_FRAME_COUNT
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_GET_FRAME_RATE
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
.. c:function:: int ioctl(int fd, VIDEO_GET_FRAME_RATE, unsigned int *rate)
:name: VIDEO_GET_FRAME_RATE
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_GET_NAVI
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
.. c:function:: int ioctl(fd, VIDEO_GET_NAVI , video_navi_pack_t *navipack)
:name: VIDEO_GET_NAVI
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_GET_PTS
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts)
.. c:function:: int ioctl(int fd, VIDEO_GET_PTS, __u64 *pts)
:name: VIDEO_GET_PTS
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_GET_SIZE
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size)
.. c:function:: int ioctl(int fd, VIDEO_GET_SIZE, video_size_t *size)
:name: VIDEO_GET_SIZE
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_GET_STATUS
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status)
.. c:function:: int ioctl(fd, VIDEO_GET_STATUS, struct video_status *status)
:name: VIDEO_GET_STATUS
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_PLAY
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_PLAY)
.. c:function:: int ioctl(fd, VIDEO_PLAY)
:name: VIDEO_PLAY
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SELECT_SOURCE
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
.. c:function:: int ioctl(fd, VIDEO_SELECT_SOURCE, video_stream_source_t source)
:name: VIDEO_SELECT_SOURCE
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SET_ATTRIBUTES
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
.. c:function:: int ioctl(fd, VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
:name: VIDEO_SET_ATTRIBUTE
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SET_BLANK
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
.. c:function:: int ioctl(fd, VIDEO_SET_BLANK, boolean mode)
:name: VIDEO_SET_BLANK
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SET_DISPLAY_FORMAT
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
.. c:function:: int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
:name: VIDEO_SET_DISPLAY_FORMAT
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SET_FORMAT
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
.. c:function:: int ioctl(fd, VIDEO_SET_FORMAT, video_format_t format)
:name: VIDEO_SET_FORMAT
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SET_HIGHLIGHT
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
.. c:function:: int ioctl(fd, VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
:name: VIDEO_SET_HIGHLIGHT
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SET_ID
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id)
.. c:function:: int ioctl(int fd, VIDEO_SET_ID, int id)
:name: VIDEO_SET_ID
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SET_SPU_PALETTE
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
.. c:function:: int ioctl(fd, VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
:name: VIDEO_SET_SPU_PALETTE
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SET_SPU
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
.. c:function:: int ioctl(fd, VIDEO_SET_SPU , video_spu_t *spu)
:name: VIDEO_SET_SPU
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SET_STREAMTYPE
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type)
.. c:function:: int ioctl(fd, VIDEO_SET_STREAMTYPE, int type)
:name: VIDEO_SET_STREAMTYPE
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SET_SYSTEM
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system)
.. c:function:: int ioctl(fd, VIDEO_SET_SYSTEM , video_system_t system)
:name: VIDEO_SET_SYSTEM
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_SLOWMOTION
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames)
.. c:function:: int ioctl(fd, VIDEO_SLOWMOTION, int nFrames)
:name: VIDEO_SLOWMOTION
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_STILLPICTURE
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
.. c:function:: int ioctl(fd, VIDEO_STILLPICTURE, struct video_still_picture *sp)
:name: VIDEO_STILLPICTURE
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_STOP
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
.. c:function:: int ioctl(fd, VIDEO_STOP, boolean mode)
:name: VIDEO_STOP
Arguments
......
......@@ -11,11 +11,13 @@ Name
VIDEO_TRY_COMMAND
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
.. c:function:: int ioctl(int fd, VIDEO_TRY_COMMAND, struct video_command *cmd)
:name: VIDEO_TRY_COMMAND
Arguments
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment