From 66b30b5d510f46c47beb330932afdcb7943d1d78 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Wed, 6 Jul 2011 13:42:08 -0300 Subject: [PATCH] [media] DocBook/dvb: Use generic descriptions for the frontend API Move generic stuff into gen-errors.xml, and remove them from DVB API. While here, removes two bogus error codes that aren't supported or used on Linux: EINTERNAL and ENOSIGNAL. Acked-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/media/dvb/dvbproperty.xml | 18 - Documentation/DocBook/media/dvb/frontend.xml | 431 +----------------------- Documentation/DocBook/media/v4l/gen-errors.xml | 24 +- 3 files changed, 24 insertions(+), 449 deletions(-) diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml index 33274bc..207e1a5 100644 --- a/Documentation/DocBook/media/dvb/dvbproperty.xml +++ b/Documentation/DocBook/media/dvb/dvbproperty.xml @@ -82,15 +82,6 @@ struct dtv_properties { &return-value-dvb; - EINVAL - Invalid parameter(s) received or number of parameters out of the range. - - ENOMEM - Out of memory. - - EFAULT - Failure while copying data from/to userspace. - EOPNOTSUPP Property type not supported. @@ -139,15 +130,6 @@ struct dtv_properties { &return-value-dvb; - EINVAL - Invalid parameter(s) received or number of parameters out of the range. - - ENOMEM - Out of memory. - - EFAULT - Failure while copying data from/to userspace. - EOPNOTSUPP Property type not supported. diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml index c5a5cb4..61407ea 100644 --- a/Documentation/DocBook/media/dvb/frontend.xml +++ b/Documentation/DocBook/media/dvb/frontend.xml @@ -575,7 +575,7 @@ typedef enum fe_hierarchy { File descriptor returned by a previous call to open(). -&return-value-dvb; +RETURN VALUE EBADF @@ -692,37 +692,8 @@ typedef enum fe_hierarchy { The bit error rate is stored into *ber. + &return-value-dvb; - -EBADF - -fd is not a valid open file descriptor. - - -EFAULT - -ber points to invalid address. - - -ENOSIGNAL - -There is no signal, thus no meaningful bit error rate. Also - returned if the front-end is not turned on. - - -ENOSYS - -Function not available for this device. - -
@@ -770,36 +741,6 @@ typedef enum fe_hierarchy { &return-value-dvb; - -EBADF - -fd is not a valid open file descriptor. - - -EFAULT - -snr points to invalid address. - - -ENOSIGNAL - -There is no signal, thus no meaningful signal strength - value. Also returned if front-end is not turned on. - - -ENOSYS - -Function not available for this device. - -
@@ -846,37 +787,8 @@ typedef enum fe_hierarchy { The signal strength value is stored into *strength. + &return-value-dvb; - -EBADF - -fd is not a valid open file descriptor. - - -EFAULT - -status points to invalid address. - - -ENOSIGNAL - -There is no signal, thus no meaningful signal strength - value. Also returned if front-end is not turned on. - - -ENOSYS - -Function not available for this device. - -
@@ -930,29 +842,8 @@ typedef enum fe_hierarchy { so far. + &return-value-dvb; - -EBADF - -fd is not a valid open file descriptor. - - -EFAULT - -ublocks points to invalid address. - - -ENOSYS - -Function not available for this device. - -
@@ -1005,23 +896,10 @@ typedef enum fe_hierarchy { Points to parameters for tuning operation. + &return-value-dvb; -EBADF - -fd is not a valid open file descriptor. - - -EFAULT - -p points to invalid address. - - EINVAL @@ -1078,23 +956,8 @@ typedef enum fe_hierarchy { &return-value-dvb; - -EBADF - -fd is not a valid open file descriptor. - - -EFAULT - -p points to invalid address. - - EINVAL @@ -1181,20 +1044,6 @@ typedef enum fe_hierarchy { &return-value-dvb; -EBADF - -fd is not a valid open file descriptor. - - -EFAULT - -ev points to invalid address. - - EWOULDBLOCK @@ -1206,11 +1055,6 @@ typedef enum fe_hierarchy { EOVERFLOW - - - Overflow in event queue - one or more events were lost. @@ -1264,21 +1108,6 @@ typedef enum fe_hierarchy { &return-value-dvb; - -EBADF - -fd is not a valid open file descriptor. - - -EFAULT - -info points to invalid address. - -
@@ -1322,28 +1151,6 @@ typedef enum fe_hierarchy { &return-value-dvb; - -EBADF - -fd is not a valid file descriptor. - - -EPERM - -Permission denied (needs read/write access). - - -EINTERNAL - -Internal error in the device driver. - -
@@ -1394,43 +1201,6 @@ typedef enum fe_hierarchy { &return-value-dvb; - -EBADF - -fd is not a valid file descriptor. - - -EFAULT - -Seq points to an invalid address. - - -EINVAL - -The data structure referred to by seq is invalid in some - way. - - -EPERM - -Permission denied (needs read/write access). - - -EINTERNAL - -Internal error in the device driver. - -
@@ -1481,43 +1251,6 @@ typedef enum fe_hierarchy { &return-value-dvb; - -EBADF - -fd is not a valid file descriptor. - - -EFAULT - -Seq points to an invalid address. - - -EINVAL - -The data structure referred to by seq is invalid in some - way. - - -EPERM - -Permission denied (needs read/write access). - - -EINTERNAL - -Internal error in the device driver. - -
@@ -1566,43 +1299,6 @@ typedef enum fe_hierarchy { &return-value-dvb; - -EBADF - -fd is not a valid file descriptor. - - -EFAULT - -Seq points to an invalid address. - - -EINVAL - -The data structure referred to by seq is invalid in some - way. - - -EPERM - -Permission denied (needs read/write access). - - -EINTERNAL - -Internal error in the device driver. - -
@@ -1649,42 +1345,6 @@ typedef enum fe_hierarchy { &return-value-dvb; - -ENODEV - -Device driver not loaded/available. - - -EBUSY - -Device or resource busy. - - -EINVAL - -Invalid argument. - - -EPERM - -File not opened with read permissions. - - -EINTERNAL - -Internal error in the device driver. - -
@@ -1733,42 +1393,6 @@ typedef enum fe_hierarchy { &return-value-dvb; - -ENODEV - -Device driver not loaded/available. - - -EBUSY - -Device or resource busy. - - -EINVAL - -Invalid argument. - - -EPERM - -File not opened with read permissions. - - -EINTERNAL - -Internal error in the device driver. - -
@@ -1818,42 +1442,6 @@ typedef enum fe_hierarchy { &return-value-dvb; - -ENODEV - -Device driver not loaded/available. - - -EBUSY - -Device or resource busy. - - -EINVAL - -Invalid argument. - - -EPERM - -File not opened with read permissions. - - -EINTERNAL - -Internal error in the device driver. - -
@@ -1886,10 +1474,6 @@ FE_TUNE_MODE_ONESHOT When set, this flag will disable any zigzagging or other "n &return-value-dvb; - -EINVAL -Invalid argument. -
@@ -1924,11 +1508,6 @@ sends the specified raw cmd to the dish via DISEqC. &return-value-dvb; - - - There are no errors in use for this call - -
diff --git a/Documentation/DocBook/media/v4l/gen-errors.xml b/Documentation/DocBook/media/v4l/gen-errors.xml index c981879..7c1980e 100644 --- a/Documentation/DocBook/media/v4l/gen-errors.xml +++ b/Documentation/DocBook/media/v4l/gen-errors.xml @@ -8,7 +8,7 @@ EBADF - fd is not a valid open file descriptor. + The file descriptor is not a valid. EBUSY @@ -21,18 +21,21 @@ EFAULT - fd is not a valid open file descriptor. + There was a failure while copying data from/to userspace, + probably caused by an invalid pointer reference. EINVAL - One or more of the ioctl parameters are invalid. This is a widely - used error code. See the individual ioctl requests for actual causes. + One or more of the ioctl parameters are invalid or out of the + allowed range. This is a widely used error code. See the individual + ioctl requests for specific causes. EINVAL or ENOTTY The ioctl is not supported by the driver, actually meaning that the required functionality is not available, or the file - descriptor is not for a media device. + descriptor is not for a media device. The usage of EINVAL is + deprecated and will be fixed on a latter patch. ENODEV @@ -49,6 +52,17 @@ for periodic transfers (up to 80% of the USB bandwidth). + ENOSYS or EOPNOTSUPP + Function not available for this device (dvb API only. Will likely + be replaced anytime soon by ENOTTY). + + + EPERM + Permission denied. Can be returned if the device needs write + permission, or some special capabilities is needed + (e. g. root) + + EWOULDBLOCK Operation would block. Used when the ioctl would need to wait for an event, but the device was opened in non-blocking mode. -- 2.7.4