Commit | Line | Data |
---|---|---|
5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _FE_READ_STATUS: | |
4 | ||
5 | ******************** | |
6 | ioctl FE_READ_STATUS | |
7 | ******************** | |
8 | ||
15e7d615 | 9 | Name |
586027ce | 10 | ==== |
5377d91f | 11 | |
586027ce | 12 | FE_READ_STATUS - Returns status information about the front-end. This call only requires - read-only access to the device |
5377d91f | 13 | |
15e7d615 MCC |
14 | |
15 | Synopsis | |
5377d91f MH |
16 | ======== |
17 | ||
cf8076c3 MCC |
18 | .. c:function:: int ioctl( int fd, FE_READ_STATUS, unsigned int *status ) |
19 | :name: FE_READ_STATUS | |
5377d91f | 20 | |
586027ce | 21 | |
15e7d615 | 22 | Arguments |
5377d91f MH |
23 | ========= |
24 | ||
25 | ``fd`` | |
26 | File descriptor returned by :ref:`open() <frontend_f_open>`. | |
27 | ||
5377d91f MH |
28 | ``status`` |
29 | pointer to a bitmask integer filled with the values defined by enum | |
836cf1db | 30 | :c:type:`fe_status`. |
5377d91f MH |
31 | |
32 | ||
15e7d615 | 33 | Description |
5377d91f MH |
34 | =========== |
35 | ||
36 | All DVB frontend devices support the ``FE_READ_STATUS`` ioctl. It is | |
37 | used to check about the locking status of the frontend after being | |
38 | tuned. The ioctl takes a pointer to an integer where the status will be | |
39 | written. | |
40 | ||
b6b6e678 MCC |
41 | .. note:: |
42 | ||
43 | The size of status is actually sizeof(enum fe_status), with | |
706f8a99 MCC |
44 | varies according with the architecture. This needs to be fixed in the |
45 | future. | |
5377d91f | 46 | |
586027ce | 47 | |
5377d91f MH |
48 | int fe_status |
49 | ============= | |
50 | ||
51 | The fe_status parameter is used to indicate the current state and/or | |
52 | state changes of the frontend hardware. It is produced using the enum | |
836cf1db MCC |
53 | :c:type:`fe_status` values on a bitmask |
54 | ||
55 | .. c:type:: fe_status | |
5377d91f | 56 | |
16dac354 | 57 | .. tabularcolumns:: |p{3.5cm}|p{14.0cm}| |
5377d91f MH |
58 | |
59 | .. _fe-status: | |
60 | ||
61 | .. flat-table:: enum fe_status | |
62 | :header-rows: 1 | |
63 | :stub-columns: 0 | |
64 | ||
65 | ||
66 | - .. row 1 | |
67 | ||
68 | - ID | |
69 | ||
70 | - Description | |
71 | ||
72 | - .. row 2 | |
73 | ||
6aeb3f67 | 74 | - .. _FE-HAS-SIGNAL: |
5377d91f | 75 | |
0579e6e3 | 76 | ``FE_HAS_SIGNAL`` |
5377d91f MH |
77 | |
78 | - The frontend has found something above the noise level | |
79 | ||
80 | - .. row 3 | |
81 | ||
6aeb3f67 | 82 | - .. _FE-HAS-CARRIER: |
5377d91f | 83 | |
0579e6e3 | 84 | ``FE_HAS_CARRIER`` |
5377d91f MH |
85 | |
86 | - The frontend has found a DVB signal | |
87 | ||
88 | - .. row 4 | |
89 | ||
6aeb3f67 | 90 | - .. _FE-HAS-VITERBI: |
5377d91f | 91 | |
0579e6e3 | 92 | ``FE_HAS_VITERBI`` |
5377d91f MH |
93 | |
94 | - The frontend FEC inner coding (Viterbi, LDPC or other inner code) | |
0579e6e3 | 95 | is stable |
5377d91f MH |
96 | |
97 | - .. row 5 | |
98 | ||
6aeb3f67 | 99 | - .. _FE-HAS-SYNC: |
5377d91f | 100 | |
0579e6e3 | 101 | ``FE_HAS_SYNC`` |
5377d91f MH |
102 | |
103 | - Synchronization bytes was found | |
104 | ||
105 | - .. row 6 | |
106 | ||
6aeb3f67 | 107 | - .. _FE-HAS-LOCK: |
5377d91f | 108 | |
0579e6e3 | 109 | ``FE_HAS_LOCK`` |
5377d91f MH |
110 | |
111 | - The DVB were locked and everything is working | |
112 | ||
113 | - .. row 7 | |
114 | ||
6aeb3f67 | 115 | - .. _FE-TIMEDOUT: |
5377d91f | 116 | |
0579e6e3 | 117 | ``FE_TIMEDOUT`` |
5377d91f MH |
118 | |
119 | - no lock within the last about 2 seconds | |
120 | ||
121 | - .. row 8 | |
122 | ||
6aeb3f67 | 123 | - .. _FE-REINIT: |
5377d91f | 124 | |
0579e6e3 | 125 | ``FE_REINIT`` |
5377d91f MH |
126 | |
127 | - The frontend was reinitialized, application is recommended to | |
0579e6e3 | 128 | reset DiSEqC, tone and parameters |
fc833980 | 129 | |
15e7d615 MCC |
130 | |
131 | Return Value | |
fc833980 MCC |
132 | ============ |
133 | ||
134 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
135 | appropriately. The generic error codes are described at the | |
136 | :ref:`Generic Error Codes <gen-errors>` chapter. |