From 5b233e1a91f31ec45feffb1ea6a33aae433259e9 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 26 May 2015 08:17:53 -0300 Subject: [PATCH] [media] DocBook: improve documentation for FE_READ_STATUS Move the ioctl and enum fe_status to a separate xml file and put it into a better format. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/media/dvb/frontend.xml | 119 ++---------------- .../media/dvb/frontend_read_status.xml | 103 +++++++++++++++ 2 files changed, 113 insertions(+), 109 deletions(-) create mode 100644 Documentation/DocBook/media/dvb/frontend_read_status.xml diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml index 86346189e8fb..28acf5a1e9ff 100644 --- a/Documentation/DocBook/media/dvb/frontend.xml +++ b/Documentation/DocBook/media/dvb/frontend.xml @@ -33,12 +33,21 @@ specification is available at
Querying frontend information -Information about the frontend ca be queried with +Information about the frontend can be queried with FE_GET_INFO.
&sub-frontend_get_info; +
+Querying frontend status + +Information about the frontend tuner locking status can be queried with + FE_READ_STATUS. +
+ +&sub-frontend_read_status; +
diseqc master command @@ -109,51 +118,6 @@ spec.
-
-frontend status -Several functions of the frontend device use the fe_status data type defined -by - -typedef enum fe_status { - FE_HAS_SIGNAL = 0x01, - FE_HAS_CARRIER = 0x02, - FE_HAS_VITERBI = 0x04, - FE_HAS_SYNC = 0x08, - FE_HAS_LOCK = 0x10, - FE_TIMEDOUT = 0x20, - FE_REINIT = 0x40, -} fe_status_t; - -to indicate the current state and/or state changes of the frontend hardware: - - - - -FE_HAS_SIGNAL -The frontend has found something above the noise level - -FE_HAS_CARRIER -The frontend has found a DVB signal - -FE_HAS_VITERBI -The frontend FEC inner coding (Viterbi, LDPC or other inner code) is stable - -FE_HAS_SYNC -Synchronization bytes was found - -FE_HAS_LOCK -The DVB were locked and everything is working - -FE_TIMEDOUT -no lock within the last about 2 seconds - -FE_REINIT -The frontend was reinitialized, application is -recommended to reset DiSEqC, tone and parameters - - -
-
frontend spectral inversion The Inversion field can take one of these values: @@ -437,69 +401,6 @@ typedef enum fe_hierarchy {
-
-FE_READ_STATUS -DESCRIPTION - - -This ioctl call returns status information about the front-end. This call only - requires read-only access to the device. - - -SYNOPSIS - - -int ioctl(int fd, int request = FE_READ_STATUS, - fe_status_t ⋆status); - - -PARAMETERS - - - -int fd - -File descriptor returned by a previous call to open(). - - -int request - -Equals FE_READ_STATUS for this command. - - -struct fe_status_t - *status - -Points to the location where the front-end status word is - to be stored. - - -RETURN VALUE - -EBADF - -fd is not a valid open file descriptor. - - -EFAULT - -status points to invalid address. - - -
-
FE_DISEQC_RESET_OVERLOAD diff --git a/Documentation/DocBook/media/dvb/frontend_read_status.xml b/Documentation/DocBook/media/dvb/frontend_read_status.xml new file mode 100644 index 000000000000..f2d08b6e2422 --- /dev/null +++ b/Documentation/DocBook/media/dvb/frontend_read_status.xml @@ -0,0 +1,103 @@ + + + ioctl FE_READ_STATUS + &manvol; + + + + FE_READ_STATUS + Returns status information about the front-end. This call only + requires read-only access to the device + + + + + + int ioctl + int fd + int request + &fe-status; *argp + + + + + + Arguments + + + fd + + &fd; + + + + request + + FE_READ_STATUS + + + + argp + + pointer to &fe-status; + + + + + + + Description + + All DVB frontend devices support the +FE_READ_STATUS ioctl. It is used to check about the +locking status of the frontend after being tuned. The ioctl takes a +pointer to a 16-bits number where the status will be written. +&return-value-dvb;. + + + +
+enum fe_status + +The enum fe_status is used to indicate the current state + and/or state changes of the frontend hardware. + + + enum fe_status + + &cs-def; + + + ID + Description + + + + + FE_HAS_SIGNAL + The frontend has found something above the noise level + + FE_HAS_CARRIER + The frontend has found a DVB signal + + FE_HAS_VITERBI + The frontend FEC inner coding (Viterbi, LDPC or other inner code) is stable + + FE_HAS_SYNC + Synchronization bytes was found + + FE_HAS_LOCK + The DVB were locked and everything is working + + FE_TIMEDOUT + no lock within the last about 2 seconds + + FE_REINIT + The frontend was reinitialized, application is + recommended to reset DiSEqC, tone and parameters + + + +
+
+ -- 2.20.1