Commit 3de530f8 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DVB: Point to the generic error chapter 



Just like the V4L, MC and LIRC API's, point to the generic error
chapter for ioctl's. This will allow moving generic error codes
to just one place inside all media API's.

A latter patch will remove the generic errors from each specific
ioctl.

Acked-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent 7464aa50

Documentation/DocBook/media/dvb/audio.xml

+21 −42
Original line number Diff line number Diff line
@@ -220,8 +220,7 @@ and right. 
<para>(blocking mode is the default)</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>ENODEV</para>
@@ -279,8 +278,7 @@ and right. 
<para>File descriptor returned by a previous call to open().</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -335,8 +333,7 @@ and right. 
<para>Size of buf.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EPERM</para>
@@ -394,8 +391,7 @@ role="subsection"><title>AUDIO_STOP</title> 
<para>Equals AUDIO_STOP for this command.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -446,8 +442,7 @@ role="subsection"><title>AUDIO_PLAY</title> 
<para>Equals AUDIO_PLAY for this command.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -506,8 +501,7 @@ role="subsection"><title>AUDIO_PAUSE</title> 
<para>Equals AUDIO_PAUSE for this command.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -563,8 +557,7 @@ with AUDIO_PAUSE command.</para> 
<para>Equals AUDIO_CONTINUE for this command.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -627,8 +620,7 @@ role="subsection"><title>AUDIO_SELECT_SOURCE</title> 
 stream.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -706,8 +698,7 @@ role="subsection"><title>AUDIO_SET_MUTE</title> 
<para>FALSE Audio Un-mute</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -785,8 +776,7 @@ role="subsection"><title>AUDIO_SET_AV_SYNC</title> 
<para>FALSE AV-sync OFF</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -868,8 +858,7 @@ role="subsection"><title>AUDIO_SET_BYPASS_MODE</title> 
<para>FALSE Bypass is enabled</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -937,8 +926,7 @@ role="subsection"><title>AUDIO_CHANNEL_SELECT</title> 
 stereo).</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1005,8 +993,7 @@ role="subsection"><title>AUDIO_GET_STATUS</title> 
<para>Returns the current state of Audio Device.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1073,8 +1060,7 @@ role="subsection"><title>AUDIO_GET_CAPABILITIES</title> 
<para>Returns a bit array of supported sound formats.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1132,8 +1118,7 @@ role="subsection"><title>AUDIO_CLEAR_BUFFER</title> 
<para>Equals AUDIO_CLEAR_BUFFER for this command.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1196,8 +1181,7 @@ role="subsection"><title>AUDIO_SET_ID</title> 
<para>audio sub-stream id</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1262,8 +1246,7 @@ role="subsection"><title>AUDIO_SET_MIXER</title> 
<para>mixer settings.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1330,8 +1313,7 @@ role="subsection"><title>AUDIO_SET_STREAMTYPE</title> 
<para>stream type</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1390,8 +1372,7 @@ role="subsection"><title>AUDIO_SET_EXT_ID</title> 
<para>audio sub_stream_id</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1451,8 +1432,7 @@ role="subsection"><title>AUDIO_SET_ATTRIBUTES</title> 
<para>audio attributes according to section ??</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1512,8 +1492,7 @@ role="subsection"><title>AUDIO_SET_KARAOKE</title> 
<para>karaoke settings according to section ??.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>

Documentation/DocBook/media/dvb/ca.xml

+2 −4
Original line number Diff line number Diff line
@@ -158,8 +158,7 @@ typedef struct ca_pid { 
<para>(blocking mode is the default)</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>ENODEV</para>
@@ -217,8 +216,7 @@ typedef struct ca_pid { 
<para>File descriptor returned by a previous call to open().</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>

Documentation/DocBook/media/dvb/demux.xml

+11 −22
Original line number Diff line number Diff line
@@ -239,8 +239,7 @@ typedef enum { 
<para>(blocking mode is the default)</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>ENODEV</para>
@@ -299,8 +298,7 @@ typedef enum { 
<para>File descriptor returned by a previous call to open().</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -381,8 +379,7 @@ typedef enum { 
<para>Size of buf.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EWOULDBLOCK</para>
@@ -485,8 +482,7 @@ typedef enum { 
<para>Size of buf.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EWOULDBLOCK</para>
@@ -553,8 +549,7 @@ typedef enum { 
<para>Equals DMX_START for this command.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -619,8 +614,7 @@ typedef enum { 
<para>Equals DMX_STOP for this command.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -682,8 +676,7 @@ typedef enum { 
<para>Pointer to structure containing filter parameters.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -755,8 +748,7 @@ typedef enum { 
<para>Pointer to structure containing filter parameters.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -827,8 +819,7 @@ typedef enum { 
<para>Size of circular buffer.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -900,8 +891,7 @@ typedef enum { 
<para>Pointer to the location where the event is to be stored.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -974,8 +964,7 @@ typedef enum { 
<para>Pointer to the location where the stc is to be stored.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>

Documentation/DocBook/media/dvb/dvbproperty.xml

+2 −3
Original line number Diff line number Diff line
@@ -80,7 +80,7 @@ struct dtv_properties { 
<para>Points to the location where the front-end property commands are stored.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row>

  <entry align="char"><para>EINVAL</para></entry>

  <entry align="char"><para>Invalid parameter(s) received or number of parameters out of the range.</para></entry>
@@ -137,8 +137,7 @@ struct dtv_properties { 
<para>Points to the location where the front-end property commands are stored.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row>

  <entry align="char"><para>EINVAL</para></entry>

  <entry align="char"><para>Invalid parameter(s) received or number of parameters out of the range.</para></entry>

Documentation/DocBook/media/dvb/frontend.xml

+20 −38
Original line number Diff line number Diff line
@@ -515,8 +515,7 @@ typedef enum fe_hierarchy { 
<para>(blocking mode is the default)</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>ENODEV</para>
@@ -576,8 +575,7 @@ typedef enum fe_hierarchy { 
<para>File descriptor returned by a previous call to open().</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -633,8 +631,7 @@ typedef enum fe_hierarchy { 
 to be stored.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

<para>RETURN VALUE</para>

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -695,8 +692,7 @@ typedef enum fe_hierarchy { 
<para>The bit error rate is stored into *ber.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -773,8 +769,7 @@ typedef enum fe_hierarchy { 
</entry>

 </row></tbody></tgroup></informaltable>



<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -851,8 +846,7 @@ typedef enum fe_hierarchy { 
<para>The signal strength value is stored into *strength.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -936,8 +930,7 @@ typedef enum fe_hierarchy { 
 so far.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1012,8 +1005,7 @@ typedef enum fe_hierarchy { 
<para>Points to parameters for tuning operation.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1085,8 +1077,7 @@ typedef enum fe_hierarchy { 
</entry>

 </row></tbody></tgroup></informaltable>



<para>ERRORS

</para>

&return-value-dvb;



<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">
@@ -1187,8 +1178,7 @@ typedef enum fe_hierarchy { 
</entry>

 </row></tbody></tgroup></informaltable>



<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1273,8 +1263,7 @@ typedef enum fe_hierarchy { 
 to be stored.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1332,8 +1321,7 @@ typedef enum fe_hierarchy { 
</entry>

 </row></tbody></tgroup></informaltable>



<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1405,8 +1393,7 @@ typedef enum fe_hierarchy { 
</entry>

 </row></tbody></tgroup></informaltable>



<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1493,8 +1480,7 @@ typedef enum fe_hierarchy { 
<para>Pointer to the command to be received.</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1579,8 +1565,7 @@ typedef enum fe_hierarchy { 
</entry>

 </row></tbody></tgroup></informaltable>



<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>EBADF</para>
@@ -1663,8 +1648,7 @@ typedef enum fe_hierarchy { 
<para>The requested tone generation mode (on/off).</para>

</entry>

 </row></tbody></tgroup></informaltable>

<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>ENODEV</para>
@@ -1748,8 +1732,7 @@ typedef enum fe_hierarchy { 
</entry>

 </row></tbody></tgroup></informaltable>



<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>ENODEV</para>
@@ -1834,8 +1817,7 @@ typedef enum fe_hierarchy { 
</entry>

 </row></tbody></tgroup></informaltable>



<para>ERRORS

</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row><entry

 align="char">

<para>ENODEV</para>
@@ -1903,7 +1885,7 @@ FE_TUNE_MODE_ONESHOT When set, this flag will disable any zigzagging or other "n 
</entry>

 </row></tbody></tgroup></informaltable>



<para>ERRORS</para>

&return-value-dvb;

<informaltable><tgroup cols="2"><tbody><row>

<entry align="char"><para>EINVAL</para></entry>

<entry align="char"><para>Invalid argument.</para></entry>
@@ -1941,7 +1923,7 @@ sends the specified raw cmd to the dish via DISEqC. 
</entry>

 </row></tbody></tgroup></informaltable>



<para>ERRORS</para>

&return-value-dvb;

<informaltable><tgroup cols="1"><tbody><row>

<entry align="char">

	<para>There are no errors in use for this call</para>