From 3de530f805c012d3b58ffdd10e43e3ec7790baa3 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 5 Jul 2011 12:36:01 -0300 Subject: [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: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/media/dvb/audio.xml | 63 +++++++------------- Documentation/DocBook/media/dvb/ca.xml | 6 +- Documentation/DocBook/media/dvb/demux.xml | 33 ++++------- Documentation/DocBook/media/dvb/dvbproperty.xml | 5 +- Documentation/DocBook/media/dvb/frontend.xml | 58 +++++++----------- Documentation/DocBook/media/dvb/video.xml | 78 +++++++++---------------- Documentation/DocBook/media_api.tmpl | 1 + 7 files changed, 83 insertions(+), 161 deletions(-) (limited to 'Documentation/DocBook') diff --git a/Documentation/DocBook/media/dvb/audio.xml b/Documentation/DocBook/media/dvb/audio.xml index c27fe73a4b66..90e9b7fede65 100644 --- a/Documentation/DocBook/media/dvb/audio.xml +++ b/Documentation/DocBook/media/dvb/audio.xml @@ -220,8 +220,7 @@ and right. (blocking mode is the default) -ERRORS - +RETURN VALUE ENODEV @@ -279,8 +278,7 @@ and right. File descriptor returned by a previous call to open(). -ERRORS - +RETURN VALUE EBADF @@ -335,8 +333,7 @@ and right. Size of buf. -ERRORS - +RETURN VALUE EPERM @@ -394,8 +391,7 @@ role="subsection">AUDIO_STOP Equals AUDIO_STOP for this command. -ERRORS - +&return-value-dvb; EBADF @@ -446,8 +442,7 @@ role="subsection">AUDIO_PLAY Equals AUDIO_PLAY for this command. -ERRORS - +&return-value-dvb; EBADF @@ -506,8 +501,7 @@ role="subsection">AUDIO_PAUSE Equals AUDIO_PAUSE for this command. -ERRORS - +&return-value-dvb; EBADF @@ -563,8 +557,7 @@ with AUDIO_PAUSE command. Equals AUDIO_CONTINUE for this command. -ERRORS - +&return-value-dvb; EBADF @@ -627,8 +620,7 @@ role="subsection">AUDIO_SELECT_SOURCE stream. -ERRORS - +&return-value-dvb; EBADF @@ -706,8 +698,7 @@ role="subsection">AUDIO_SET_MUTE FALSE Audio Un-mute -ERRORS - +&return-value-dvb; EBADF @@ -785,8 +776,7 @@ role="subsection">AUDIO_SET_AV_SYNC FALSE AV-sync OFF -ERRORS - +&return-value-dvb; EBADF @@ -868,8 +858,7 @@ role="subsection">AUDIO_SET_BYPASS_MODE FALSE Bypass is enabled -ERRORS - +&return-value-dvb; EBADF @@ -937,8 +926,7 @@ role="subsection">AUDIO_CHANNEL_SELECT stereo). -ERRORS - +&return-value-dvb; EBADF @@ -1005,8 +993,7 @@ role="subsection">AUDIO_GET_STATUS Returns the current state of Audio Device. -ERRORS - +&return-value-dvb; EBADF @@ -1073,8 +1060,7 @@ role="subsection">AUDIO_GET_CAPABILITIES Returns a bit array of supported sound formats. -ERRORS - +&return-value-dvb; EBADF @@ -1132,8 +1118,7 @@ role="subsection">AUDIO_CLEAR_BUFFER Equals AUDIO_CLEAR_BUFFER for this command. -ERRORS - +&return-value-dvb; EBADF @@ -1196,8 +1181,7 @@ role="subsection">AUDIO_SET_ID audio sub-stream id -ERRORS - +&return-value-dvb; EBADF @@ -1262,8 +1246,7 @@ role="subsection">AUDIO_SET_MIXER mixer settings. -ERRORS - +&return-value-dvb; EBADF @@ -1330,8 +1313,7 @@ role="subsection">AUDIO_SET_STREAMTYPE stream type -ERRORS - +&return-value-dvb; EBADF @@ -1390,8 +1372,7 @@ role="subsection">AUDIO_SET_EXT_ID audio sub_stream_id -ERRORS - +&return-value-dvb; EBADF @@ -1451,8 +1432,7 @@ role="subsection">AUDIO_SET_ATTRIBUTES audio attributes according to section ?? -ERRORS - +&return-value-dvb; EBADF @@ -1512,8 +1492,7 @@ role="subsection">AUDIO_SET_KARAOKE karaoke settings according to section ??. -ERRORS - +&return-value-dvb; EBADF diff --git a/Documentation/DocBook/media/dvb/ca.xml b/Documentation/DocBook/media/dvb/ca.xml index a6cb9522f289..5c4adb44b1c1 100644 --- a/Documentation/DocBook/media/dvb/ca.xml +++ b/Documentation/DocBook/media/dvb/ca.xml @@ -158,8 +158,7 @@ typedef struct ca_pid { (blocking mode is the default) -ERRORS - +RETURN VALUE ENODEV @@ -217,8 +216,7 @@ typedef struct ca_pid { File descriptor returned by a previous call to open(). -ERRORS - +RETURN VALUE EBADF diff --git a/Documentation/DocBook/media/dvb/demux.xml b/Documentation/DocBook/media/dvb/demux.xml index 6758739cd611..e5058d7d9213 100644 --- a/Documentation/DocBook/media/dvb/demux.xml +++ b/Documentation/DocBook/media/dvb/demux.xml @@ -239,8 +239,7 @@ typedef enum { (blocking mode is the default) -ERRORS - +RETURN VALUE ENODEV @@ -299,8 +298,7 @@ typedef enum { File descriptor returned by a previous call to open(). -ERRORS - +RETURN VALUE EBADF @@ -381,8 +379,7 @@ typedef enum { Size of buf. -ERRORS - +RETURN VALUE EWOULDBLOCK @@ -485,8 +482,7 @@ typedef enum { Size of buf. -ERRORS - +RETURN VALUE EWOULDBLOCK @@ -553,8 +549,7 @@ typedef enum { Equals DMX_START for this command. -ERRORS - +&return-value-dvb; EBADF @@ -619,8 +614,7 @@ typedef enum { Equals DMX_STOP for this command. -ERRORS - +&return-value-dvb; EBADF @@ -682,8 +676,7 @@ typedef enum { Pointer to structure containing filter parameters. -ERRORS - +&return-value-dvb; EBADF @@ -755,8 +748,7 @@ typedef enum { Pointer to structure containing filter parameters. -ERRORS - +&return-value-dvb; EBADF @@ -827,8 +819,7 @@ typedef enum { Size of circular buffer. -ERRORS - +&return-value-dvb; EBADF @@ -900,8 +891,7 @@ typedef enum { Pointer to the location where the event is to be stored. -ERRORS - +&return-value-dvb; EBADF @@ -974,8 +964,7 @@ typedef enum { Pointer to the location where the stc is to be stored. -ERRORS - +&return-value-dvb; EBADF diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml index caec58c60032..33274bcc8592 100644 --- a/Documentation/DocBook/media/dvb/dvbproperty.xml +++ b/Documentation/DocBook/media/dvb/dvbproperty.xml @@ -80,7 +80,7 @@ struct dtv_properties { Points to the location where the front-end property commands are stored. -ERRORS +&return-value-dvb; EINVAL Invalid parameter(s) received or number of parameters out of the range. @@ -137,8 +137,7 @@ struct dtv_properties { Points to the location where the front-end property commands are stored. -ERRORS - +&return-value-dvb; EINVAL Invalid parameter(s) received or number of parameters out of the range. diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml index 304d54ed3cbf..c5a5cb4051be 100644 --- a/Documentation/DocBook/media/dvb/frontend.xml +++ b/Documentation/DocBook/media/dvb/frontend.xml @@ -515,8 +515,7 @@ typedef enum fe_hierarchy { (blocking mode is the default) -ERRORS - +RETURN VALUE ENODEV @@ -576,8 +575,7 @@ typedef enum fe_hierarchy { File descriptor returned by a previous call to open(). -ERRORS - +&return-value-dvb; EBADF @@ -633,8 +631,7 @@ typedef enum fe_hierarchy { to be stored. -ERRORS - +RETURN VALUE EBADF @@ -695,8 +692,7 @@ typedef enum fe_hierarchy { The bit error rate is stored into *ber. -ERRORS - +&return-value-dvb; EBADF @@ -773,8 +769,7 @@ typedef enum fe_hierarchy { -ERRORS - +&return-value-dvb; EBADF @@ -851,8 +846,7 @@ typedef enum fe_hierarchy { The signal strength value is stored into *strength. -ERRORS - +&return-value-dvb; EBADF @@ -936,8 +930,7 @@ typedef enum fe_hierarchy { so far. -ERRORS - +&return-value-dvb; EBADF @@ -1012,8 +1005,7 @@ typedef enum fe_hierarchy { Points to parameters for tuning operation. -ERRORS - +&return-value-dvb; EBADF @@ -1085,8 +1077,7 @@ typedef enum fe_hierarchy { -ERRORS - +&return-value-dvb; @@ -1187,8 +1178,7 @@ typedef enum fe_hierarchy { -ERRORS - +&return-value-dvb; EBADF @@ -1273,8 +1263,7 @@ typedef enum fe_hierarchy { to be stored. -ERRORS - +&return-value-dvb; EBADF @@ -1332,8 +1321,7 @@ typedef enum fe_hierarchy { -ERRORS - +&return-value-dvb; EBADF @@ -1405,8 +1393,7 @@ typedef enum fe_hierarchy { -ERRORS - +&return-value-dvb; EBADF @@ -1493,8 +1480,7 @@ typedef enum fe_hierarchy { Pointer to the command to be received. -ERRORS - +&return-value-dvb; EBADF @@ -1579,8 +1565,7 @@ typedef enum fe_hierarchy { -ERRORS - +&return-value-dvb; EBADF @@ -1663,8 +1648,7 @@ typedef enum fe_hierarchy { The requested tone generation mode (on/off). -ERRORS - +&return-value-dvb; ENODEV @@ -1748,8 +1732,7 @@ typedef enum fe_hierarchy { -ERRORS - +&return-value-dvb; ENODEV @@ -1834,8 +1817,7 @@ typedef enum fe_hierarchy { -ERRORS - +&return-value-dvb; ENODEV @@ -1903,7 +1885,7 @@ FE_TUNE_MODE_ONESHOT When set, this flag will disable any zigzagging or other "n -ERRORS +&return-value-dvb; EINVAL Invalid argument. @@ -1941,7 +1923,7 @@ sends the specified raw cmd to the dish via DISEqC. -ERRORS +&return-value-dvb; There are no errors in use for this call diff --git a/Documentation/DocBook/media/dvb/video.xml b/Documentation/DocBook/media/dvb/video.xml index 539c79b027c3..0b1b662c345b 100644 --- a/Documentation/DocBook/media/dvb/video.xml +++ b/Documentation/DocBook/media/dvb/video.xml @@ -399,8 +399,7 @@ VIDEO_GET_NAVI: (blocking mode is the default) -ERRORS - +RETURN VALUE ENODEV @@ -458,8 +457,7 @@ VIDEO_GET_NAVI: File descriptor returned by a previous call to open(). -ERRORS - +RETURN VALUE EBADF @@ -514,8 +512,7 @@ VIDEO_GET_NAVI: Size of buf. -ERRORS - +RETURN VALUE EPERM @@ -595,8 +592,7 @@ role="subsection">VIDEO_STOP FALSE: Show last decoded frame. -ERRORS - +&return-value-dvb; EBADF @@ -648,8 +644,7 @@ role="subsection">VIDEO_PLAY Equals VIDEO_PLAY for this command. -ERRORS - +&return-value-dvb; EBADF @@ -705,8 +700,7 @@ role="subsection">VIDEO_FREEZE Equals VIDEO_FREEZE for this command. -ERRORS - +&return-value-dvb; EBADF @@ -758,8 +752,7 @@ role="subsection">VIDEO_CONTINUE Equals VIDEO_CONTINUE for this command. -ERRORS - +&return-value-dvb; EBADF @@ -821,8 +814,7 @@ role="subsection">VIDEO_SELECT_SOURCE Indicates which source shall be used for the Video stream. -ERRORS - +&return-value-dvb; EBADF @@ -887,8 +879,7 @@ role="subsection">VIDEO_SET_BLANK FALSE: Show last decoded frame. -ERRORS - +&return-value-dvb; EBADF @@ -955,8 +946,7 @@ role="subsection">VIDEO_GET_STATUS Returns the current status of the Video Device. -ERRORS - +&return-value-dvb; EBADF @@ -1032,8 +1022,7 @@ role="subsection">VIDEO_GET_EVENT stored. -ERRORS - +&return-value-dvb; EBADF @@ -1115,8 +1104,7 @@ role="subsection">VIDEO_SET_DISPLAY_FORMAT Selects the video format to be used. -ERRORS - +&return-value-dvb; EBADF @@ -1185,8 +1173,7 @@ role="subsection">VIDEO_STILLPICTURE Pointer to a location where an I-frame and size is stored. -ERRORS - +&return-value-dvb; EBADF @@ -1252,8 +1239,7 @@ role="subsection">VIDEO_FAST_FORWARD The number of frames to skip. -ERRORS - +&return-value-dvb; EBADF @@ -1326,8 +1312,7 @@ role="subsection">VIDEO_SLOWMOTION The number of times to repeat each frame. -ERRORS - +&return-value-dvb; EBADF @@ -1402,8 +1387,7 @@ role="subsection">VIDEO_GET_CAPABILITIES information. -ERRORS - +&return-value-dvb; EBADF @@ -1462,8 +1446,7 @@ role="subsection">VIDEO_SET_ID video sub-stream id -ERRORS - +&return-value-dvb; EBADF @@ -1520,8 +1503,7 @@ role="subsection">VIDEO_CLEAR_BUFFER Equals VIDEO_CLEAR_BUFFER for this command. -ERRORS - +&return-value-dvb; EBADF @@ -1574,8 +1556,7 @@ role="subsection">VIDEO_SET_STREAMTYPE stream type -ERRORS - +&return-value-dvb; EBADF @@ -1635,8 +1616,7 @@ role="subsection">VIDEO_SET_FORMAT video format of TV as defined in section ??. -ERRORS - +&return-value-dvb; EBADF @@ -1697,8 +1677,7 @@ role="subsection">VIDEO_SET_SYSTEM video system of TV output. -ERRORS - +&return-value-dvb; EBADF @@ -1757,8 +1736,7 @@ role="subsection">VIDEO_SET_HIGHLIGHT SPU Highlight information according to section ??. -ERRORS - +&return-value-dvb; EBADF @@ -1818,8 +1796,7 @@ role="subsection">VIDEO_SET_SPU to section ??. -ERRORS - +&return-value-dvb; EBADF @@ -1879,8 +1856,7 @@ role="subsection">VIDEO_SET_SPU_PALETTE SPU palette according to section ??. -ERRORS - +&return-value-dvb; EBADF @@ -1941,8 +1917,7 @@ role="subsection">VIDEO_GET_NAVI ??. -ERRORS - +&return-value-dvb; EBADF @@ -2003,8 +1978,7 @@ role="subsection">VIDEO_SET_ATTRIBUTES video attributes according to section ??. -ERRORS - +&return-value-dvb; EBADF diff --git a/Documentation/DocBook/media_api.tmpl b/Documentation/DocBook/media_api.tmpl index c273e3c54fc5..4e8e8985cc17 100644 --- a/Documentation/DocBook/media_api.tmpl +++ b/Documentation/DocBook/media_api.tmpl @@ -9,6 +9,7 @@ open()."> 2C"> Return ValueOn success 0 is returned, on error -1 and the errno variable is set appropriately. The generic error codes are described at the Generic Error Codes chapter."> +RETURN VALUEOn success 0 is returned, on error -1 and the errno variable is set appropriately. The generic error codes are described at the Generic Error Codes chapter."> 2"> -- cgit v1.2.3