media: docs-next: update the fe_status documentation for FE_NONE
authorColin Ian King <colin.king@canonical.com>
Fri, 21 Jul 2017 16:12:38 +0000 (12:12 -0400)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 27 Aug 2017 21:58:05 +0000 (17:58 -0400)
Recently added FE_NONE to the enum fe_status, so update the
documentation accordingly.

[mchehab@s-opensource.com: change description to actually
 reflect what FE_NONE means: no lock of any kind]
Signed-off-by: Colin Ian King <colin.king@canonical.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/uapi/dvb/fe-read-status.rst

index 812f086c20f51a78352c38c5722d6dec0bc0ad98..76b93e3865529f049cd9c4d30c06932bc5915b89 100644 (file)
@@ -71,13 +71,21 @@ state changes of the frontend hardware. It is produced using the enum
 
     -  .. row 2
 
+       -  .. _FE-NONE:
+
+         ``FE_NONE``
+
+       -  The frontend doesn't have any kind of lock. That's the initial frontend status
+
+    -  .. row 3
+
        -  .. _FE-HAS-SIGNAL:
 
          ``FE_HAS_SIGNAL``
 
        -  The frontend has found something above the noise level
 
-    -  .. row 3
+    -  .. row 4
 
        -  .. _FE-HAS-CARRIER:
 
@@ -85,7 +93,7 @@ state changes of the frontend hardware. It is produced using the enum
 
        -  The frontend has found a DVB signal
 
-    -  .. row 4
+    -  .. row 5
 
        -  .. _FE-HAS-VITERBI:
 
@@ -94,7 +102,7 @@ state changes of the frontend hardware. It is produced using the enum
        -  The frontend FEC inner coding (Viterbi, LDPC or other inner code)
          is stable
 
-    -  .. row 5
+    -  .. row 6
 
        -  .. _FE-HAS-SYNC:
 
@@ -102,7 +110,7 @@ state changes of the frontend hardware. It is produced using the enum
 
        -  Synchronization bytes was found
 
-    -  .. row 6
+    -  .. row 7
 
        -  .. _FE-HAS-LOCK:
 
@@ -110,7 +118,7 @@ state changes of the frontend hardware. It is produced using the enum
 
        -  The DVB were locked and everything is working
 
-    -  .. row 7
+    -  .. row 8
 
        -  .. _FE-TIMEDOUT:
 
@@ -118,7 +126,7 @@ state changes of the frontend hardware. It is produced using the enum
 
        -  no lock within the last about 2 seconds
 
-    -  .. row 8
+    -  .. row 9
 
        -  .. _FE-REINIT: