Commit 836cf1db authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] docs-rst exceptions: use C domain references for DVB headers

Now that we moved away from the :ref: type of references,
we need to update the exceptions lists.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 59d44bbe
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
ignore define _DVBAUDIO_H_ ignore define _DVBAUDIO_H_
# Typedef pointing to structs # Typedef pointing to structs
replace typedef audio_karaoke_t audio-karaoke replace typedef audio_karaoke_t :c:type:`audio_karaoke`
# Undocumented audio caps, as this is a deprecated API anyway # Undocumented audio caps, as this is a deprecated API anyway
ignore define AUDIO_CAP_DTS ignore define AUDIO_CAP_DTS
...@@ -16,5 +16,5 @@ ignore define AUDIO_CAP_SDDS ...@@ -16,5 +16,5 @@ ignore define AUDIO_CAP_SDDS
ignore define AUDIO_CAP_AC3 ignore define AUDIO_CAP_AC3
# some typedefs should point to struct/enums # some typedefs should point to struct/enums
replace typedef audio_mixer_t audio-mixer replace typedef audio_mixer_t :c:type:`audio_mixer`
replace typedef audio_status_t audio-status replace typedef audio_status_t :c:type:`audio_status`
...@@ -2,23 +2,23 @@ ...@@ -2,23 +2,23 @@
ignore define _DVBCA_H_ ignore define _DVBCA_H_
# struct ca_slot_info defines # struct ca_slot_info defines
replace define CA_CI ca-slot-info replace define CA_CI :c:type:`ca_slot_info`
replace define CA_CI_LINK ca-slot-info replace define CA_CI_LINK :c:type:`ca_slot_info`
replace define CA_CI_PHYS ca-slot-info replace define CA_CI_PHYS :c:type:`ca_slot_info`
replace define CA_DESCR ca-slot-info replace define CA_DESCR :c:type:`ca_slot_info`
replace define CA_SC ca-slot-info replace define CA_SC :c:type:`ca_slot_info`
replace define CA_CI_MODULE_PRESENT ca-slot-info replace define CA_CI_MODULE_PRESENT :c:type:`ca_slot_info`
replace define CA_CI_MODULE_READY ca-slot-info replace define CA_CI_MODULE_READY :c:type:`ca_slot_info`
# struct ca_descr_info defines # struct ca_descr_info defines
replace define CA_ECD ca-descr-info replace define CA_ECD :c:type:`ca_descr_info`
replace define CA_NDS ca-descr-info replace define CA_NDS :c:type:`ca_descr_info`
replace define CA_DSS ca-descr-info replace define CA_DSS :c:type:`ca_descr_info`
# some typedefs should point to struct/enums # some typedefs should point to struct/enums
replace typedef ca_pid_t ca-pid replace typedef ca_pid_t :c:type:`ca_pid`
replace typedef ca_slot_info_t ca-slot-info replace typedef ca_slot_info_t :c:type:`ca_slot_info`
replace typedef ca_descr_info_t ca-descr-info replace typedef ca_descr_info_t :c:type:`ca_descr_info`
replace typedef ca_caps_t ca-caps replace typedef ca_caps_t :c:type:`ca_caps`
replace typedef ca_msg_t ca-msg replace typedef ca_msg_t :c:type:`ca_msg`
replace typedef ca_descr_t ca-descr replace typedef ca_descr_t :c:type:`ca_descr`
...@@ -4,29 +4,29 @@ ignore define _UAPI_DVBDMX_H_ ...@@ -4,29 +4,29 @@ ignore define _UAPI_DVBDMX_H_
# Ignore limit constants # Ignore limit constants
ignore define DMX_FILTER_SIZE ignore define DMX_FILTER_SIZE
# dmx-pes-type-t enum symbols # dmx_pes_type_t enum symbols
replace enum dmx_ts_pes dmx-pes-type-t replace enum dmx_ts_pes :c:type:`dmx_pes_type`
replace symbol DMX_PES_AUDIO0 dmx-pes-type-t replace symbol DMX_PES_AUDIO0 :c:type:`dmx_pes_type`
replace symbol DMX_PES_VIDEO0 dmx-pes-type-t replace symbol DMX_PES_VIDEO0 :c:type:`dmx_pes_type`
replace symbol DMX_PES_TELETEXT0 dmx-pes-type-t replace symbol DMX_PES_TELETEXT0 :c:type:`dmx_pes_type`
replace symbol DMX_PES_SUBTITLE0 dmx-pes-type-t replace symbol DMX_PES_SUBTITLE0 :c:type:`dmx_pes_type`
replace symbol DMX_PES_PCR0 dmx-pes-type-t replace symbol DMX_PES_PCR0 :c:type:`dmx_pes_type`
replace symbol DMX_PES_AUDIO1 dmx-pes-type-t replace symbol DMX_PES_AUDIO1 :c:type:`dmx_pes_type`
replace symbol DMX_PES_VIDEO1 dmx-pes-type-t replace symbol DMX_PES_VIDEO1 :c:type:`dmx_pes_type`
replace symbol DMX_PES_TELETEXT1 dmx-pes-type-t replace symbol DMX_PES_TELETEXT1 :c:type:`dmx_pes_type`
replace symbol DMX_PES_SUBTITLE1 dmx-pes-type-t replace symbol DMX_PES_SUBTITLE1 :c:type:`dmx_pes_type`
replace symbol DMX_PES_PCR1 dmx-pes-type-t replace symbol DMX_PES_PCR1 :c:type:`dmx_pes_type`
replace symbol DMX_PES_AUDIO2 dmx-pes-type-t replace symbol DMX_PES_AUDIO2 :c:type:`dmx_pes_type`
replace symbol DMX_PES_VIDEO2 dmx-pes-type-t replace symbol DMX_PES_VIDEO2 :c:type:`dmx_pes_type`
replace symbol DMX_PES_TELETEXT2 dmx-pes-type-t replace symbol DMX_PES_TELETEXT2 :c:type:`dmx_pes_type`
replace symbol DMX_PES_SUBTITLE2 dmx-pes-type-t replace symbol DMX_PES_SUBTITLE2 :c:type:`dmx_pes_type`
replace symbol DMX_PES_PCR2 dmx-pes-type-t replace symbol DMX_PES_PCR2 :c:type:`dmx_pes_type`
replace symbol DMX_PES_AUDIO3 dmx-pes-type-t replace symbol DMX_PES_AUDIO3 :c:type:`dmx_pes_type`
replace symbol DMX_PES_VIDEO3 dmx-pes-type-t replace symbol DMX_PES_VIDEO3 :c:type:`dmx_pes_type`
replace symbol DMX_PES_TELETEXT3 dmx-pes-type-t replace symbol DMX_PES_TELETEXT3 :c:type:`dmx_pes_type`
replace symbol DMX_PES_SUBTITLE3 dmx-pes-type-t replace symbol DMX_PES_SUBTITLE3 :c:type:`dmx_pes_type`
replace symbol DMX_PES_PCR3 dmx-pes-type-t replace symbol DMX_PES_PCR3 :c:type:`dmx_pes_type`
replace symbol DMX_PES_OTHER dmx-pes-type-t replace symbol DMX_PES_OTHER :c:type:`dmx_pes_type`
# Ignore obsolete symbols # Ignore obsolete symbols
ignore define DMX_PES_AUDIO ignore define DMX_PES_AUDIO
...@@ -36,28 +36,31 @@ ignore define DMX_PES_SUBTITLE ...@@ -36,28 +36,31 @@ ignore define DMX_PES_SUBTITLE
ignore define DMX_PES_PCR ignore define DMX_PES_PCR
# dmx_input_t symbols # dmx_input_t symbols
replace enum dmx_input dmx-input-t replace enum dmx_input :c:type:`dmx_input`
replace symbol DMX_IN_FRONTEND dmx-input-t replace symbol DMX_IN_FRONTEND :c:type:`dmx_input`
replace symbol DMX_IN_DVR dmx-input-t replace symbol DMX_IN_DVR :c:type:`dmx_input`
# dmx_source_t symbols # dmx_source_t symbols
replace enum dmx_source dmx-source-t replace enum dmx_source :c:type:`dmx_source`
replace symbol DMX_SOURCE_FRONT0 dmx-source-t replace symbol DMX_SOURCE_FRONT0 :c:type:`dmx_source`
replace symbol DMX_SOURCE_FRONT1 dmx-source-t replace symbol DMX_SOURCE_FRONT1 :c:type:`dmx_source`
replace symbol DMX_SOURCE_FRONT2 dmx-source-t replace symbol DMX_SOURCE_FRONT2 :c:type:`dmx_source`
replace symbol DMX_SOURCE_FRONT3 dmx-source-t replace symbol DMX_SOURCE_FRONT3 :c:type:`dmx_source`
replace symbol DMX_SOURCE_DVR0 dmx-source-t replace symbol DMX_SOURCE_DVR0 :c:type:`dmx_source`
replace symbol DMX_SOURCE_DVR1 dmx-source-t replace symbol DMX_SOURCE_DVR1 :c:type:`dmx_source`
replace symbol DMX_SOURCE_DVR2 dmx-source-t replace symbol DMX_SOURCE_DVR2 :c:type:`dmx_source`
replace symbol DMX_SOURCE_DVR3 dmx-source-t replace symbol DMX_SOURCE_DVR3 :c:type:`dmx_source`
# Flags for struct dmx_sct_filter_params # Flags for struct dmx_sct_filter_params
replace define DMX_CHECK_CRC dmx-sct-filter-params replace define DMX_CHECK_CRC :c:type:`dmx_sct_filter_params`
replace define DMX_ONESHOT dmx-sct-filter-params replace define DMX_ONESHOT :c:type:`dmx_sct_filter_params`
replace define DMX_IMMEDIATE_START dmx-sct-filter-params replace define DMX_IMMEDIATE_START :c:type:`dmx_sct_filter_params`
replace define DMX_KERNEL_CLIENT dmx-sct-filter-params replace define DMX_KERNEL_CLIENT :c:type:`dmx_sct_filter_params`
# some typedefs should point to struct/enums # some typedefs should point to struct/enums
replace typedef dmx_caps_t dmx-caps replace typedef dmx_caps_t :c:type:`dmx_caps`
replace typedef dmx_filter_t dmx-filter replace typedef dmx_filter_t :c:type:`dmx_filter`
replace typedef dmx_pes_type_t :c:type:`dmx_pes_type`
replace typedef dmx_input_t :c:type:`dmx_input`
replace typedef dmx_source_t :c:type:`dmx_source`
...@@ -26,22 +26,22 @@ ignore define MAX_DTV_STATS ...@@ -26,22 +26,22 @@ ignore define MAX_DTV_STATS
ignore define DTV_IOCTL_MAX_MSGS ignore define DTV_IOCTL_MAX_MSGS
# Stats enum is documented altogether # Stats enum is documented altogether
replace enum fecap_scale_params frontend-stat-properties replace enum fecap_scale_params :ref:`frontend-stat-properties`
replace symbol FE_SCALE_COUNTER frontend-stat-properties replace symbol FE_SCALE_COUNTER frontend-stat-properties
replace symbol FE_SCALE_DECIBEL frontend-stat-properties replace symbol FE_SCALE_DECIBEL frontend-stat-properties
replace symbol FE_SCALE_NOT_AVAILABLE frontend-stat-properties replace symbol FE_SCALE_NOT_AVAILABLE frontend-stat-properties
replace symbol FE_SCALE_RELATIVE frontend-stat-properties replace symbol FE_SCALE_RELATIVE frontend-stat-properties
# the same reference is used for both get and set ioctls # the same reference is used for both get and set ioctls
replace ioctl FE_SET_PROPERTY FE_GET_PROPERTY replace ioctl FE_SET_PROPERTY :c:type:`FE_GET_PROPERTY`
# Ignore struct used only internally at Kernel # Ignore struct used only internally at Kernel
ignore struct dtv_cmds_h ignore struct dtv_cmds_h
# Typedefs that use the enum reference # Typedefs that use the enum reference
replace typedef fe_sec_voltage_t fe-sec-voltage replace typedef fe_sec_voltage_t :c:type:`fe_sec_voltage`
# Replaces for flag constants # Replaces for flag constants
replace define FE_TUNE_MODE_ONESHOT fe_set_frontend_tune_mode replace define FE_TUNE_MODE_ONESHOT :c:func:`FE_SET_FRONTEND_TUNE_MODE`
replace define LNA_AUTO dtv-lna replace define LNA_AUTO dtv-lna
replace define NO_STREAM_ID_FILTER dtv-stream-id replace define NO_STREAM_ID_FILTER dtv-stream-id
...@@ -30,7 +30,7 @@ divided into five parts. ...@@ -30,7 +30,7 @@ divided into five parts.
called as DVB API, in fact it covers several different video standards called as DVB API, in fact it covers several different video standards
including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S, DTMB, etc. The including DVB-T/T2, DVB-S/S2, DVB-C, ATSC, ISDB-T, ISDB-S, DTMB, etc. The
complete list of supported standards can be found at complete list of supported standards can be found at
:ref:`fe-delivery-system-t`. :c:type:`fe_delivery_system`.
3. The :ref:`third part <remote_controllers>` covers the Remote Controller API. 3. The :ref:`third part <remote_controllers>` covers the Remote Controller API.
......
...@@ -7,5 +7,5 @@ ignore ioctl __NET_GET_IF_OLD ...@@ -7,5 +7,5 @@ ignore ioctl __NET_GET_IF_OLD
ignore struct __dvb_net_if_old ignore struct __dvb_net_if_old
# Macros used at struct dvb_net_if # Macros used at struct dvb_net_if
replace define DVB_NET_FEEDTYPE_MPE dvb-net-if replace define DVB_NET_FEEDTYPE_MPE :c:type:`dvb_net_if`
replace define DVB_NET_FEEDTYPE_ULE dvb-net-if replace define DVB_NET_FEEDTYPE_ULE :c:type:`dvb_net_if`
...@@ -16,7 +16,7 @@ AUDIO_BILINGUAL_CHANNEL_SELECT ...@@ -16,7 +16,7 @@ AUDIO_BILINGUAL_CHANNEL_SELECT
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t) .. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, struct *audio_channel_select)
:name: AUDIO_BILINGUAL_CHANNEL_SELECT :name: AUDIO_BILINGUAL_CHANNEL_SELECT
......
...@@ -16,7 +16,7 @@ AUDIO_CHANNEL_SELECT ...@@ -16,7 +16,7 @@ AUDIO_CHANNEL_SELECT
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, audio_channel_select_t) .. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, struct *audio_channel_select)
:name: AUDIO_CHANNEL_SELECT :name: AUDIO_CHANNEL_SELECT
......
...@@ -16,7 +16,7 @@ AUDIO_SELECT_SOURCE ...@@ -16,7 +16,7 @@ AUDIO_SELECT_SOURCE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_SELECT_SOURCE, audio_stream_source_t source) .. c:function:: int ioctl(int fd, AUDIO_SELECT_SOURCE, struct audio_stream_source *source)
:name: AUDIO_SELECT_SOURCE :name: AUDIO_SELECT_SOURCE
......
...@@ -17,7 +17,7 @@ AUDIO_SET_ATTRIBUTES ...@@ -17,7 +17,7 @@ AUDIO_SET_ATTRIBUTES
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, AUDIO_SET_ATTRIBUTES, audio_attributes_t attr ) .. c:function:: int ioctl(fd, AUDIO_SET_ATTRIBUTES, struct audio_attributes *attr )
:name: AUDIO_SET_ATTRIBUTES :name: AUDIO_SET_ATTRIBUTES
Arguments Arguments
......
...@@ -16,7 +16,7 @@ AUDIO_SET_KARAOKE ...@@ -16,7 +16,7 @@ AUDIO_SET_KARAOKE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke) .. c:function:: int ioctl(fd, AUDIO_SET_KARAOKE, struct audio_karaoke *karaoke)
:name: AUDIO_SET_KARAOKE :name: AUDIO_SET_KARAOKE
......
...@@ -16,7 +16,7 @@ AUDIO_SET_MIXER ...@@ -16,7 +16,7 @@ AUDIO_SET_MIXER
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_SET_MIXER, audio_mixer_t *mix) .. c:function:: int ioctl(int fd, AUDIO_SET_MIXER, struct audio_mixer *mix)
:name: AUDIO_SET_MIXER :name: AUDIO_SET_MIXER
Arguments Arguments
......
...@@ -9,11 +9,7 @@ Audio Data Types ...@@ -9,11 +9,7 @@ Audio Data Types
This section describes the structures, data types and defines used when This section describes the structures, data types and defines used when
talking to the audio device. talking to the audio device.
.. c:type:: audio_stream_source
.. _audio-stream-source-t:
audio_stream_source_t
=====================
The audio stream source is set through the AUDIO_SELECT_SOURCE call The audio stream source is set through the AUDIO_SELECT_SOURCE call
and can take the following values, depending on whether we are replaying and can take the following values, depending on whether we are replaying
...@@ -33,10 +29,7 @@ AUDIO_SOURCE_MEMORY is selected the stream comes from the application ...@@ -33,10 +29,7 @@ AUDIO_SOURCE_MEMORY is selected the stream comes from the application
through the ``write()`` system call. through the ``write()`` system call.
.. _audio-play-state-t: .. c:type:: audio_play_state
audio_play_state_t
==================
The following values can be returned by the AUDIO_GET_STATUS call The following values can be returned by the AUDIO_GET_STATUS call
representing the state of audio playback. representing the state of audio playback.
...@@ -51,10 +44,7 @@ representing the state of audio playback. ...@@ -51,10 +44,7 @@ representing the state of audio playback.
} audio_play_state_t; } audio_play_state_t;
.. _audio-channel-select-t: .. c:type:: audio_channel_select
audio_channel_select_t
======================
The audio channel selected via AUDIO_CHANNEL_SELECT is determined by The audio channel selected via AUDIO_CHANNEL_SELECT is determined by
the following values. the following values.
...@@ -73,9 +63,6 @@ the following values. ...@@ -73,9 +63,6 @@ the following values.
.. c:type:: audio_status .. c:type:: audio_status
struct audio_status
===================
The AUDIO_GET_STATUS call returns the following structure informing The AUDIO_GET_STATUS call returns the following structure informing
about various states of the playback operation. about various states of the playback operation.
...@@ -95,9 +82,6 @@ about various states of the playback operation. ...@@ -95,9 +82,6 @@ about various states of the playback operation.
.. c:type:: audio_mixer .. c:type:: audio_mixer
struct audio_mixer
==================
The following structure is used by the AUDIO_SET_MIXER call to set the The following structure is used by the AUDIO_SET_MIXER call to set the
audio volume. audio volume.
...@@ -131,12 +115,8 @@ following bits set according to the hardwares capabilities. ...@@ -131,12 +115,8 @@ following bits set according to the hardwares capabilities.
#define AUDIO_CAP_SDDS 128 #define AUDIO_CAP_SDDS 128
#define AUDIO_CAP_AC3 256 #define AUDIO_CAP_AC3 256
.. c:type:: audio_karaoke .. c:type:: audio_karaoke
struct audio_karaoke
====================
The ioctl AUDIO_SET_KARAOKE uses the following format: The ioctl AUDIO_SET_KARAOKE uses the following format:
...@@ -155,10 +135,7 @@ into the left channel and Vocal2 into the right channel at 100% each. Ff ...@@ -155,10 +135,7 @@ into the left channel and Vocal2 into the right channel at 100% each. Ff
Melody is non-zero, the melody channel gets mixed into left and right. Melody is non-zero, the melody channel gets mixed into left and right.
.. _audio-attributes-t: .. c:type:: audio_attributes
audio attributes
================
The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES: The following attributes can be set by a call to AUDIO_SET_ATTRIBUTES:
......
...@@ -6,15 +6,12 @@ ...@@ -6,15 +6,12 @@
Demux Data Types Demux Data Types
**************** ****************
.. _dmx-output-t:
Output for the demux Output for the demux
==================== ====================
.. tabularcolumns:: |p{5.0cm}|p{12.5cm}| .. c:type:: dmx_output
.. _dmx-output: .. tabularcolumns:: |p{5.0cm}|p{12.5cm}|
.. flat-table:: enum dmx_output .. flat-table:: enum dmx_output
:header-rows: 1 :header-rows: 1
...@@ -66,12 +63,10 @@ Output for the demux ...@@ -66,12 +63,10 @@ Output for the demux
from the DMX device. from the DMX device.
.. _dmx-input-t:
dmx_input_t dmx_input_t
=========== ===========
.. c:type:: dmx_input
.. code-block:: c .. code-block:: c
...@@ -82,11 +77,11 @@ dmx_input_t ...@@ -82,11 +77,11 @@ dmx_input_t
} dmx_input_t; } dmx_input_t;
.. _dmx-pes-type-t:
dmx_pes_type_t dmx_pes_type_t
============== ==============
.. c:type:: dmx_pes_type
.. code-block:: c .. code-block:: c
...@@ -120,11 +115,10 @@ dmx_pes_type_t ...@@ -120,11 +115,10 @@ dmx_pes_type_t
} dmx_pes_type_t; } dmx_pes_type_t;
.. c:type:: dmx_filter
struct dmx_filter struct dmx_filter
================= =================
.. c:type:: dmx_filter
.. code-block:: c .. code-block:: c
...@@ -157,11 +151,10 @@ struct dmx_sct_filter_params ...@@ -157,11 +151,10 @@ struct dmx_sct_filter_params
}; };
.. c:type:: dmx_pes_filter_params
struct dmx_pes_filter_params struct dmx_pes_filter_params
============================ ============================
.. c:type:: dmx_pes_filter_params
.. code-block:: c .. code-block:: c
...@@ -175,11 +168,10 @@ struct dmx_pes_filter_params ...@@ -175,11 +168,10 @@ struct dmx_pes_filter_params
}; };
.. _dmx-event:
struct dmx_event struct dmx_event
================ ================
.. c:type:: dmx_event
.. code-block:: c .. code-block:: c
...@@ -194,11 +186,10 @@ struct dmx_event ...@@ -194,11 +186,10 @@ struct dmx_event
}; };
.. c:type:: dmx_stc
struct dmx_stc struct dmx_stc
============== ==============
.. c:type:: dmx_stc
.. code-block:: c .. code-block:: c
...@@ -209,11 +200,10 @@ struct dmx_stc ...@@ -209,11 +200,10 @@ struct dmx_stc
}; };
.. c:type:: dmx_caps
struct dmx_caps struct dmx_caps
=============== ===============
.. c:type:: dmx_caps
.. code-block:: c .. code-block:: c
...@@ -223,15 +213,14 @@ struct dmx_caps ...@@ -223,15 +213,14 @@ struct dmx_caps
} dmx_caps_t; } dmx_caps_t;
.. _dmx-source-t: enum dmx_source
===============
enum dmx_source_t
=================
.. c:type:: dmx_source
.. code-block:: c .. code-block:: c
typedef enum { typedef enum dmx_source {
DMX_SOURCE_FRONT0 = 0, DMX_SOURCE_FRONT0 = 0,
DMX_SOURCE_FRONT1, DMX_SOURCE_FRONT1,
DMX_SOURCE_FRONT2, DMX_SOURCE_FRONT2,
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _fe-bandwidth-t:
****************** ******************
Frontend bandwidth Frontend bandwidth
****************** ******************
.. c:type:: fe_bandwidth
.. _fe-bandwidth:
.. flat-table:: enum fe_bandwidth .. flat-table:: enum fe_bandwidth
:header-rows: 1 :header-rows: 1
......
...@@ -37,9 +37,6 @@ Receives reply from a DiSEqC 2.0 command. ...@@ -37,9 +37,6 @@ Receives reply from a DiSEqC 2.0 command.
.. c:type:: dvb_diseqc_slave_reply .. c:type:: dvb_diseqc_slave_reply
struct dvb_diseqc_slave_reply
-----------------------------
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
.. flat-table:: struct dvb_diseqc_slave_reply .. flat-table:: struct dvb_diseqc_slave_reply
......
...@@ -26,7 +26,7 @@ Arguments ...@@ -26,7 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :ref:`open() <frontend_f_open>`.
``tone`` ``tone``
pointer to enum :ref:`fe_sec_mini_cmd <fe-sec-mini-cmd>` pointer to enum :c:type:`fe_sec_mini_cmd`
Description Description
...@@ -39,12 +39,7 @@ read/write permissions. ...@@ -39,12 +39,7 @@ read/write permissions.
It provides support for what's specified at It provides support for what's specified at
`Digital Satellite Equipment Control (DiSEqC) - Simple "ToneBurst" Detection Circuit specification. <http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf>`__ `Digital Satellite Equipment Control (DiSEqC) - Simple "ToneBurst" Detection Circuit specification. <http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf>`__
.. _fe-sec-mini-cmd-t: .. c:type:: fe_sec_mini_cmd
enum fe_sec_mini_cmd
====================
.. _fe-sec-mini-cmd:
.. flat-table:: enum fe_sec_mini_cmd .. flat-table:: enum fe_sec_mini_cmd
:header-rows: 1 :header-rows: 1
......
...@@ -35,10 +35,8 @@ Description ...@@ -35,10 +35,8 @@ Description
Sends a DiSEqC command to the antenna subsystem. Sends a DiSEqC command to the antenna subsystem.
.. c:type:: dvb_diseqc_master_cmd
struct dvb_diseqc_master_cmd .. c:type:: dvb_diseqc_master_cmd
============================
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
......
...@@ -42,9 +42,6 @@ returns an error. ...@@ -42,9 +42,6 @@ returns an error.
.. c:type:: dvb_frontend_info .. c:type:: dvb_frontend_info
struct dvb_frontend_info
========================
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
.. flat-table:: struct dvb_frontend_info .. flat-table:: struct dvb_frontend_info
...@@ -137,7 +134,7 @@ struct dvb_frontend_info ...@@ -137,7 +134,7 @@ struct dvb_frontend_info
- .. row 11 - .. row 11
- enum :ref:`fe_caps <fe-caps>` - enum :c:type:`fe_caps`
- caps - caps
...@@ -150,17 +147,15 @@ struct dvb_frontend_info ...@@ -150,17 +147,15 @@ struct dvb_frontend_info
systems. They're specified in kHz for Satellite systems systems. They're specified in kHz for Satellite systems
.. _fe-caps-t:
frontend capabilities frontend capabilities
===================== =====================
Capabilities describe what a frontend can do. Some capabilities are Capabilities describe what a frontend can do. Some capabilities are
supported only on some specific frontend types. supported only on some specific frontend types.
.. tabularcolumns:: |p{6.5cm}|p{11.0cm}| .. c:type:: fe_caps
.. _fe-caps: .. tabularcolumns:: |p{6.5cm}|p{11.0cm}|
.. flat-table:: enum fe_caps .. flat-table:: enum fe_caps
:header-rows: 1 :header-rows: 1
......
...@@ -27,7 +27,7 @@ Arguments ...@@ -27,7 +27,7 @@ Arguments
``status`` ``status``
pointer to a bitmask integer filled with the values defined by enum pointer to a bitmask integer filled with the values defined by enum
:ref:`fe_status <fe-status>`. :c:type:`fe_status`.
Description Description
...@@ -45,14 +45,14 @@ written. ...@@ -45,14 +45,14 @@ written.
future. future.
.. _fe-status-t:
int fe_status int fe_status
============= =============
The fe_status parameter is used to indicate the current state and/or The fe_status parameter is used to indicate the current state and/or
state changes of the frontend hardware. It is produced using the enum state changes of the frontend hardware. It is produced using the enum
:ref:`fe_status <fe-status>` values on a bitmask :c:type:`fe_status` values on a bitmask
.. c:type:: fe_status
.. tabularcolumns:: |p{3.5cm}|p{14.0cm}| .. tabularcolumns:: |p{3.5cm}|p{14.0cm}|
......
...@@ -26,7 +26,7 @@ Arguments ...@@ -26,7 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :ref:`open() <frontend_f_open>`.
``tone`` ``tone``
pointer to enum :ref:`fe_sec_tone_mode <fe-sec-tone-mode>` pointer to enum :c:type:`fe_sec_tone_mode`
Description Description
...@@ -45,12 +45,7 @@ this is done using the DiSEqC ioctls. ...@@ -45,12 +45,7 @@ this is done using the DiSEqC ioctls.
capability of selecting the band. So, it is recommended that applications capability of selecting the band. So, it is recommended that applications
would change to SEC_TONE_OFF when the device is not used. would change to SEC_TONE_OFF when the device is not used.
.. _fe-sec-tone-mode-t: .. c:type:: fe_sec_tone_mode
enum fe_sec_tone_mode
=====================
.. _fe-sec-tone-mode:
.. flat-table:: enum fe_sec_tone_mode .. flat-table:: enum fe_sec_tone_mode
:header-rows: 1 :header-rows: 1
......
...@@ -26,10 +26,10 @@ Arguments ...@@ -26,10 +26,10 @@ Arguments
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :ref:`open() <frontend_f_open>`.
``voltage`` ``voltage``
pointer to enum :ref:`fe_sec_voltage <fe-sec-voltage>` pointer to enum :c:type:`fe_sec_voltage`
Valid values are described at enum Valid values are described at enum
:ref:`fe_sec_voltage <fe-sec-voltage>`. :c:type:`fe_sec_voltage`.
Description Description
......
.. -*- coding: utf-8; mode: rst -*- .. -*- coding: utf-8; mode: rst -*-
.. _fe-type-t:
************* *************
Frontend type Frontend type
************* *************
...@@ -11,7 +9,7 @@ modulation used in transmission. The fontend types are given by ...@@ -11,7 +9,7 @@ modulation used in transmission. The fontend types are given by
fe_type_t type, defined as: fe_type_t type, defined as:
.. _fe-type: .. c:type:: fe_type
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
......
...@@ -68,10 +68,10 @@ DTV_MODULATION ...@@ -68,10 +68,10 @@ DTV_MODULATION
Specifies the frontend modulation type for delivery systems that Specifies the frontend modulation type for delivery systems that
supports more than one modulation type. The modulation can be one of the supports more than one modulation type. The modulation can be one of the
types defined by enum :ref:`fe_modulation <fe-modulation>`. types defined by enum :c:type:`fe_modulation`.
.. _fe-modulation-t: .. c:type:: fe_modulation
Modulation property Modulation property
------------------- -------------------
...@@ -82,8 +82,6 @@ enum contains the values used by the Kernel. Please note that not all ...@@ -82,8 +82,6 @@ enum contains the values used by the Kernel. Please note that not all
modulations are supported by a given standard. modulations are supported by a given standard.
.. _fe-modulation:
.. flat-table:: enum fe_modulation .. flat-table:: enum fe_modulation
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
...@@ -251,8 +249,7 @@ DTV_INVERSION ...@@ -251,8 +249,7 @@ DTV_INVERSION
Specifies if the frontend should do spectral inversion or not. Specifies if the frontend should do spectral inversion or not.
.. c:type:: fe_spectral_inversion
.. _fe-spectral-inversion-t:
enum fe_modulation: Frontend spectral inversion enum fe_modulation: Frontend spectral inversion
----------------------------------------------- -----------------------------------------------
...@@ -264,8 +261,6 @@ support, the DVB core will try to lock at the carrier first with ...@@ -264,8 +261,6 @@ support, the DVB core will try to lock at the carrier first with
inversion off. If it fails, it will try to enable inversion. inversion off. If it fails, it will try to enable inversion.
.. _fe-spectral-inversion:
.. flat-table:: enum fe_modulation .. flat-table:: enum fe_modulation
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
...@@ -327,15 +322,11 @@ DTV_INNER_FEC ...@@ -327,15 +322,11 @@ DTV_INNER_FEC
Used cable/satellite transmissions. The acceptable values are: Used cable/satellite transmissions. The acceptable values are:
.. c:type:: fe_code_rate
.. _fe-code-rate-t:
enum fe_code_rate: type of the Forward Error Correction. enum fe_code_rate: type of the Forward Error Correction.
-------------------------------------------------------- --------------------------------------------------------
.. _fe-code-rate:
.. flat-table:: enum fe_code_rate .. flat-table:: enum fe_code_rate
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
...@@ -464,7 +455,7 @@ voltage has to be switched consistently to the DiSEqC commands as ...@@ -464,7 +455,7 @@ voltage has to be switched consistently to the DiSEqC commands as
described in the DiSEqC spec. described in the DiSEqC spec.
.. _fe-sec-voltage: .. c:type:: fe_sec_voltage
.. flat-table:: enum fe_sec_voltage .. flat-table:: enum fe_sec_voltage
:header-rows: 1 :header-rows: 1
...@@ -519,14 +510,12 @@ DTV_PILOT ...@@ -519,14 +510,12 @@ DTV_PILOT
Sets DVB-S2 pilot Sets DVB-S2 pilot
.. _fe-pilot-t: .. c:type:: fe_pilot
fe_pilot type fe_pilot type
------------- -------------
.. _fe-pilot:
.. flat-table:: enum fe_pilot .. flat-table:: enum fe_pilot
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
...@@ -572,14 +561,12 @@ DTV_ROLLOFF ...@@ -572,14 +561,12 @@ DTV_ROLLOFF
Sets DVB-S2 rolloff Sets DVB-S2 rolloff
.. _fe-rolloff-t: .. c:type:: fe_rolloff
fe_rolloff type fe_rolloff type
--------------- ---------------
.. _fe-rolloff:
.. flat-table:: enum fe_rolloff .. flat-table:: enum fe_rolloff
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
...@@ -657,7 +644,7 @@ DTV_DELIVERY_SYSTEM ...@@ -657,7 +644,7 @@ DTV_DELIVERY_SYSTEM
Specifies the type of Delivery system Specifies the type of Delivery system
.. _fe-delivery-system-t: .. c:type:: fe_delivery_system
fe_delivery_system type fe_delivery_system type
----------------------- -----------------------
...@@ -665,8 +652,6 @@ fe_delivery_system type ...@@ -665,8 +652,6 @@ fe_delivery_system type
Possible values: Possible values:
.. _fe-delivery-system:
.. flat-table:: enum fe_delivery_system .. flat-table:: enum fe_delivery_system
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
...@@ -1098,7 +1083,7 @@ The values here are referring to what can be found in the ...@@ -1098,7 +1083,7 @@ The values here are referring to what can be found in the
TMCC-structure, as shown in the table below. TMCC-structure, as shown in the table below.
.. _isdbt-layer-interleaving-table: .. c:type:: isdbt_layer_interleaving_table
.. flat-table:: ISDB-T time interleaving modes .. flat-table:: ISDB-T time interleaving modes
:header-rows: 0 :header-rows: 0
...@@ -1235,7 +1220,7 @@ Possible values are: ...@@ -1235,7 +1220,7 @@ Possible values are:
.. tabularcolumns:: |p{5.0cm}|p{12.5cm}| .. tabularcolumns:: |p{5.0cm}|p{12.5cm}|
.. _atscmh-rs-frame-mode: .. c:type:: atscmh_rs_frame_mode
.. flat-table:: enum atscmh_rs_frame_mode .. flat-table:: enum atscmh_rs_frame_mode
:header-rows: 1 :header-rows: 1
...@@ -1279,7 +1264,7 @@ Reed Solomon(RS) frame ensemble. ...@@ -1279,7 +1264,7 @@ Reed Solomon(RS) frame ensemble.
Possible values are: Possible values are:
.. _atscmh-rs-frame-ensemble: .. c:type:: atscmh_rs_frame_ensemble
.. flat-table:: enum atscmh_rs_frame_ensemble .. flat-table:: enum atscmh_rs_frame_ensemble
:header-rows: 1 :header-rows: 1
...@@ -1328,7 +1313,7 @@ Reed Solomon (RS) code mode (primary). ...@@ -1328,7 +1313,7 @@ Reed Solomon (RS) code mode (primary).
Possible values are: Possible values are:
.. _atscmh-rs-code-mode: .. c:type:: atscmh_rs_code_mode
.. flat-table:: enum atscmh_rs_code_mode .. flat-table:: enum atscmh_rs_code_mode
:header-rows: 1 :header-rows: 1
...@@ -1383,7 +1368,7 @@ DTV_ATSCMH_RS_CODE_MODE_SEC ...@@ -1383,7 +1368,7 @@ DTV_ATSCMH_RS_CODE_MODE_SEC
Reed Solomon (RS) code mode (secondary). Reed Solomon (RS) code mode (secondary).
Possible values are the same as documented on enum Possible values are the same as documented on enum
:ref:`atscmh_rs_code_mode <atscmh-rs-code-mode>`: :c:type:`atscmh_rs_code_mode`:
.. _DTV-ATSCMH-SCCC-BLOCK-MODE: .. _DTV-ATSCMH-SCCC-BLOCK-MODE:
...@@ -1397,7 +1382,7 @@ Possible values are: ...@@ -1397,7 +1382,7 @@ Possible values are:
.. tabularcolumns:: |p{4.5cm}|p{13.0cm}| .. tabularcolumns:: |p{4.5cm}|p{13.0cm}|
.. _atscmh-sccc-block-mode: .. c:type:: atscmh_sccc_block_mode
.. flat-table:: enum atscmh_scc_block_mode .. flat-table:: enum atscmh_scc_block_mode
:header-rows: 1 :header-rows: 1
...@@ -1448,7 +1433,7 @@ Series Concatenated Convolutional Code Rate. ...@@ -1448,7 +1433,7 @@ Series Concatenated Convolutional Code Rate.
Possible values are: Possible values are:
.. _atscmh-sccc-code-mode: .. c:type:: atscmh_sccc_code_mode
.. flat-table:: enum atscmh_sccc_code_mode .. flat-table:: enum atscmh_sccc_code_mode
:header-rows: 1 :header-rows: 1
...@@ -1495,7 +1480,7 @@ DTV_ATSCMH_SCCC_CODE_MODE_B ...@@ -1495,7 +1480,7 @@ DTV_ATSCMH_SCCC_CODE_MODE_B
Series Concatenated Convolutional Code Rate. Series Concatenated Convolutional Code Rate.
Possible values are the same as documented on enum Possible values are the same as documented on enum
:ref:`atscmh_sccc_code_mode <atscmh-sccc-code-mode>`. :c:type:`atscmh_sccc_code_mode`.
.. _DTV-ATSCMH-SCCC-CODE-MODE-C: .. _DTV-ATSCMH-SCCC-CODE-MODE-C:
...@@ -1506,7 +1491,7 @@ DTV_ATSCMH_SCCC_CODE_MODE_C ...@@ -1506,7 +1491,7 @@ DTV_ATSCMH_SCCC_CODE_MODE_C
Series Concatenated Convolutional Code Rate. Series Concatenated Convolutional Code Rate.
Possible values are the same as documented on enum Possible values are the same as documented on enum
:ref:`atscmh_sccc_code_mode <atscmh-sccc-code-mode>`. :c:type:`atscmh_sccc_code_mode`.
.. _DTV-ATSCMH-SCCC-CODE-MODE-D: .. _DTV-ATSCMH-SCCC-CODE-MODE-D:
...@@ -1517,7 +1502,7 @@ DTV_ATSCMH_SCCC_CODE_MODE_D ...@@ -1517,7 +1502,7 @@ DTV_ATSCMH_SCCC_CODE_MODE_D
Series Concatenated Convolutional Code Rate. Series Concatenated Convolutional Code Rate.
Possible values are the same as documented on enum Possible values are the same as documented on enum
:ref:`atscmh_sccc_code_mode <atscmh-sccc-code-mode>`. :c:type:`atscmh_sccc_code_mode`.
.. _DTV-API-VERSION: .. _DTV-API-VERSION:
...@@ -1534,7 +1519,7 @@ DTV_CODE_RATE_HP ...@@ -1534,7 +1519,7 @@ DTV_CODE_RATE_HP
================ ================
Used on terrestrial transmissions. The acceptable values are the ones Used on terrestrial transmissions. The acceptable values are the ones
described at :ref:`fe_transmit_mode_t <fe-transmit-mode-t>`. described at :c:type:`fe_transmit_mode`.
.. _DTV-CODE-RATE-LP: .. _DTV-CODE-RATE-LP:
...@@ -1543,7 +1528,7 @@ DTV_CODE_RATE_LP ...@@ -1543,7 +1528,7 @@ DTV_CODE_RATE_LP
================ ================
Used on terrestrial transmissions. The acceptable values are the ones Used on terrestrial transmissions. The acceptable values are the ones
described at :ref:`fe_transmit_mode_t <fe-transmit-mode-t>`. described at :c:type:`fe_transmit_mode`.
.. _DTV-GUARD-INTERVAL: .. _DTV-GUARD-INTERVAL:
...@@ -1554,14 +1539,12 @@ DTV_GUARD_INTERVAL ...@@ -1554,14 +1539,12 @@ DTV_GUARD_INTERVAL
Possible values are: Possible values are:
.. _fe-guard-interval-t: .. c:type:: fe_guard_interval
Modulation guard interval Modulation guard interval
------------------------- -------------------------
.. _fe-guard-interval:
.. flat-table:: enum fe_guard_interval .. flat-table:: enum fe_guard_interval
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
...@@ -1683,15 +1666,13 @@ Specifies the number of carriers used by the standard. This is used only ...@@ -1683,15 +1666,13 @@ Specifies the number of carriers used by the standard. This is used only
on OFTM-based standards, e. g. DVB-T/T2, ISDB-T, DTMB on OFTM-based standards, e. g. DVB-T/T2, ISDB-T, DTMB
.. _fe-transmit-mode-t: .. c:type:: fe_transmit_mode
enum fe_transmit_mode: Number of carriers per channel enum fe_transmit_mode: Number of carriers per channel
----------------------------------------------------- -----------------------------------------------------
.. tabularcolumns:: |p{5.0cm}|p{12.5cm}| .. tabularcolumns:: |p{5.0cm}|p{12.5cm}|
.. _fe-transmit-mode:
.. flat-table:: enum fe_transmit_mode .. flat-table:: enum fe_transmit_mode
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
...@@ -1801,14 +1782,12 @@ DTV_HIERARCHY ...@@ -1801,14 +1782,12 @@ DTV_HIERARCHY
Frontend hierarchy Frontend hierarchy
.. _fe-hierarchy-t: .. c:type:: fe_hierarchy
Frontend hierarchy Frontend hierarchy
------------------ ------------------
.. _fe-hierarchy:
.. flat-table:: enum fe_hierarchy .. flat-table:: enum fe_hierarchy
:header-rows: 1 :header-rows: 1
:stub-columns: 0 :stub-columns: 0
...@@ -1914,7 +1893,7 @@ DTV_INTERLEAVING ...@@ -1914,7 +1893,7 @@ DTV_INTERLEAVING
Time interleaving to be used. Currently, used only on DTMB. Time interleaving to be used. Currently, used only on DTMB.
.. _fe-interleaving: .. c:type:: fe_interleaving
.. flat-table:: enum fe_interleaving .. flat-table:: enum fe_interleaving
:header-rows: 1 :header-rows: 1
......
...@@ -41,12 +41,6 @@ created. ...@@ -41,12 +41,6 @@ created.
The struct :c:type:`dvb_net_if`::ifnum field will be The struct :c:type:`dvb_net_if`::ifnum field will be
filled with the number of the created interface. filled with the number of the created interface.
.. _dvb-net-if-t:
struct dvb_net_if description
=============================
.. c:type:: dvb_net_if .. c:type:: dvb_net_if
.. flat-table:: struct dvb_net_if .. flat-table:: struct dvb_net_if
......
...@@ -28,13 +28,13 @@ ignore define VIDEO_CAP_NAVI ...@@ -28,13 +28,13 @@ ignore define VIDEO_CAP_NAVI
ignore define VIDEO_CAP_CSS ignore define VIDEO_CAP_CSS
# some typedefs should point to struct/enums # some typedefs should point to struct/enums
replace typedef video_format_t video-format replace typedef video_format_t :c:type:`video_format`
replace typedef video_system_t video-system replace typedef video_system_t :c:type:`video_system`
replace typedef video_displayformat_t video-displayformat replace typedef video_displayformat_t :c:type:`video_displayformat`
replace typedef video_size_t video-size replace typedef video_size_t :c:type:`video_size`
replace typedef video_stream_source_t video-stream-source replace typedef video_stream_source_t :c:type:`video_stream_source`
replace typedef video_play_state_t video-play-state replace typedef video_play_state_t :c:type:`video_play_state`
replace typedef video_highlight_t video-highlight replace typedef video_highlight_t :c:type:`video_highlight`
replace typedef video_spu_t video-spu replace typedef video_spu_t :c:type:`video_spu`
replace typedef video_spu_palette_t video-spu-palette replace typedef video_spu_palette_t :c:type:`video_spu_palette`
replace typedef video_navi_pack_t video-navi-pack replace typedef video_navi_pack_t :c:type:`video_navi_pack`
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