frontend.xml 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954
  1. <title>DVB Frontend API</title>
  2. <para>The DVB frontend device controls the tuner and DVB demodulator
  3. hardware. It can be accessed through <emphasis
  4. role="tt">/dev/dvb/adapter0/frontend0</emphasis>. Data types and and
  5. ioctl definitions can be accessed by including <emphasis
  6. role="tt">linux/dvb/frontend.h</emphasis> in your application.</para>
  7. <para>DVB frontends come in three varieties: DVB-S (satellite), DVB-C
  8. (cable) and DVB-T (terrestrial). Transmission via the internet (DVB-IP)
  9. is not yet handled by this API but a future extension is possible. For
  10. DVB-S the frontend device also supports satellite equipment control
  11. (SEC) via DiSEqC and V-SEC protocols. The DiSEqC (digital SEC)
  12. specification is available from
  13. <ulink url="http://www.eutelsat.com/satellites/4_5_5.html">Eutelsat</ulink>.</para>
  14. <para>Note that the DVB API may also be used for MPEG decoder-only PCI
  15. cards, in which case there exists no frontend device.</para>
  16. <section id="frontend_types">
  17. <title>Frontend Data Types</title>
  18. <section id="fe-type-t">
  19. <title>Frontend type</title>
  20. <para>For historical reasons, frontend types are named by the type of modulation used in
  21. transmission. The fontend types are given by fe_type_t type, defined as:</para>
  22. <table pgwide="1" frame="none" id="fe-type">
  23. <title>Frontend types</title>
  24. <tgroup cols="3">
  25. &cs-def;
  26. <thead>
  27. <row>
  28. <entry>fe_type</entry>
  29. <entry>Description</entry>
  30. <entry><link linkend="DTV-DELIVERY-SYSTEM">DTV_DELIVERY_SYSTEM</link> equivalent type</entry>
  31. </row>
  32. </thead>
  33. <tbody valign="top">
  34. <row>
  35. <entry id="FE_QPSK"><constant>FE_QPSK</constant></entry>
  36. <entry>For DVB-S standard</entry>
  37. <entry><constant>SYS_DVBS</constant></entry>
  38. </row>
  39. <row>
  40. <entry id="FE_QAM"><constant>FE_QAM</constant></entry>
  41. <entry>For DVB-C annex A/C standard</entry>
  42. <entry><constant>SYS_DVBC_ANNEX_AC</constant></entry>
  43. </row>
  44. <row>
  45. <entry id="FE_OFDM"><constant>FE_OFDM</constant></entry>
  46. <entry>For DVB-T standard</entry>
  47. <entry><constant>SYS_DVBT</constant></entry>
  48. </row>
  49. <row>
  50. <entry id="FE_ATSC"><constant>FE_ATSC</constant></entry>
  51. <entry>For ATSC standard (terrestrial) or for DVB-C Annex B (cable) used in US.</entry>
  52. <entry><constant>SYS_ATSC</constant> (terrestrial) or <constant>SYS_DVBC_ANNEX_B</constant> (cable)</entry>
  53. </row>
  54. </tbody></tgroup></table>
  55. <para>Newer formats like DVB-S2, ISDB-T, ISDB-S and DVB-T2 are not described at the above, as they're
  56. supported via the new <link linkend="FE_GET_SET_PROPERTY">FE_GET_PROPERTY/FE_GET_SET_PROPERTY</link> ioctl's, using the <link linkend="DTV-DELIVERY-SYSTEM">DTV_DELIVERY_SYSTEM</link> parameter.
  57. </para>
  58. </section>
  59. <section id="fe-caps-t">
  60. <title>frontend capabilities</title>
  61. <para>Capabilities describe what a frontend can do. Some capabilities can only be supported for
  62. a specific frontend type.</para>
  63. <programlisting>
  64. typedef enum fe_caps {
  65. FE_IS_STUPID = 0,
  66. FE_CAN_INVERSION_AUTO = 0x1,
  67. FE_CAN_FEC_1_2 = 0x2,
  68. FE_CAN_FEC_2_3 = 0x4,
  69. FE_CAN_FEC_3_4 = 0x8,
  70. FE_CAN_FEC_4_5 = 0x10,
  71. FE_CAN_FEC_5_6 = 0x20,
  72. FE_CAN_FEC_6_7 = 0x40,
  73. FE_CAN_FEC_7_8 = 0x80,
  74. FE_CAN_FEC_8_9 = 0x100,
  75. FE_CAN_FEC_AUTO = 0x200,
  76. FE_CAN_QPSK = 0x400,
  77. FE_CAN_QAM_16 = 0x800,
  78. FE_CAN_QAM_32 = 0x1000,
  79. FE_CAN_QAM_64 = 0x2000,
  80. FE_CAN_QAM_128 = 0x4000,
  81. FE_CAN_QAM_256 = 0x8000,
  82. FE_CAN_QAM_AUTO = 0x10000,
  83. FE_CAN_TRANSMISSION_MODE_AUTO = 0x20000,
  84. FE_CAN_BANDWIDTH_AUTO = 0x40000,
  85. FE_CAN_GUARD_INTERVAL_AUTO = 0x80000,
  86. FE_CAN_HIERARCHY_AUTO = 0x100000,
  87. FE_CAN_8VSB = 0x200000,
  88. FE_CAN_16VSB = 0x400000,
  89. FE_HAS_EXTENDED_CAPS = 0x800000,
  90. FE_CAN_TURBO_FEC = 0x8000000,
  91. FE_CAN_2G_MODULATION = 0x10000000,
  92. FE_NEEDS_BENDING = 0x20000000,
  93. FE_CAN_RECOVER = 0x40000000,
  94. FE_CAN_MUTE_TS = 0x80000000
  95. } fe_caps_t;
  96. </programlisting>
  97. </section>
  98. <section id="dvb-frontend-info">
  99. <title>frontend information</title>
  100. <para>Information about the frontend ca be queried with
  101. <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
  102. <programlisting>
  103. struct dvb_frontend_info {
  104. char name[128];
  105. fe_type_t type;
  106. uint32_t frequency_min;
  107. uint32_t frequency_max;
  108. uint32_t frequency_stepsize;
  109. uint32_t frequency_tolerance;
  110. uint32_t symbol_rate_min;
  111. uint32_t symbol_rate_max;
  112. uint32_t symbol_rate_tolerance; /&#x22C6; ppm &#x22C6;/
  113. uint32_t notifier_delay; /&#x22C6; ms &#x22C6;/
  114. fe_caps_t caps;
  115. };
  116. </programlisting>
  117. </section>
  118. <section id="dvb-diseqc-master-cmd">
  119. <title>diseqc master command</title>
  120. <para>A message sent from the frontend to DiSEqC capable equipment.</para>
  121. <programlisting>
  122. struct dvb_diseqc_master_cmd {
  123. uint8_t msg [6]; /&#x22C6; { framing, address, command, data[3] } &#x22C6;/
  124. uint8_t msg_len; /&#x22C6; valid values are 3...6 &#x22C6;/
  125. };
  126. </programlisting>
  127. </section>
  128. <section role="subsection" id="dvb-diseqc-slave-reply">
  129. <title>diseqc slave reply</title>
  130. <para>A reply to the frontend from DiSEqC 2.0 capable equipment.</para>
  131. <programlisting>
  132. struct dvb_diseqc_slave_reply {
  133. uint8_t msg [4]; /&#x22C6; { framing, data [3] } &#x22C6;/
  134. uint8_t msg_len; /&#x22C6; valid values are 0...4, 0 means no msg &#x22C6;/
  135. int timeout; /&#x22C6; return from ioctl after timeout ms with &#x22C6;/
  136. }; /&#x22C6; errorcode when no message was received &#x22C6;/
  137. </programlisting>
  138. </section>
  139. <section id="fe-sec-voltage-t">
  140. <title>diseqc slave reply</title>
  141. <para>The voltage is usually used with non-DiSEqC capable LNBs to switch the polarzation
  142. (horizontal/vertical). When using DiSEqC epuipment this voltage has to be switched
  143. consistently to the DiSEqC commands as described in the DiSEqC spec.</para>
  144. <programlisting>
  145. typedef enum fe_sec_voltage {
  146. SEC_VOLTAGE_13,
  147. SEC_VOLTAGE_18
  148. } fe_sec_voltage_t;
  149. </programlisting>
  150. </section>
  151. <section id="fe-sec-tone-mode-t">
  152. <title>SEC continuous tone</title>
  153. <para>The continuous 22KHz tone is usually used with non-DiSEqC capable LNBs to switch the
  154. high/low band of a dual-band LNB. When using DiSEqC epuipment this voltage has to
  155. be switched consistently to the DiSEqC commands as described in the DiSEqC
  156. spec.</para>
  157. <programlisting>
  158. typedef enum fe_sec_tone_mode {
  159. SEC_TONE_ON,
  160. SEC_TONE_OFF
  161. } fe_sec_tone_mode_t;
  162. </programlisting>
  163. </section>
  164. <section id="fe-sec-mini-cmd-t">
  165. <title>SEC tone burst</title>
  166. <para>The 22KHz tone burst is usually used with non-DiSEqC capable switches to select
  167. between two connected LNBs/satellites. When using DiSEqC epuipment this voltage has to
  168. be switched consistently to the DiSEqC commands as described in the DiSEqC
  169. spec.</para>
  170. <programlisting>
  171. typedef enum fe_sec_mini_cmd {
  172. SEC_MINI_A,
  173. SEC_MINI_B
  174. } fe_sec_mini_cmd_t;
  175. </programlisting>
  176. <para></para>
  177. </section>
  178. <section id="fe-status-t">
  179. <title>frontend status</title>
  180. <para>Several functions of the frontend device use the fe_status data type defined
  181. by</para>
  182. <programlisting>
  183. typedef enum fe_status {
  184. FE_HAS_SIGNAL = 0x01, /&#x22C6; found something above the noise level &#x22C6;/
  185. FE_HAS_CARRIER = 0x02, /&#x22C6; found a DVB signal &#x22C6;/
  186. FE_HAS_VITERBI = 0x04, /&#x22C6; FEC is stable &#x22C6;/
  187. FE_HAS_SYNC = 0x08, /&#x22C6; found sync bytes &#x22C6;/
  188. FE_HAS_LOCK = 0x10, /&#x22C6; everything's working... &#x22C6;/
  189. FE_TIMEDOUT = 0x20, /&#x22C6; no lock within the last ~2 seconds &#x22C6;/
  190. FE_REINIT = 0x40 /&#x22C6; frontend was reinitialized, &#x22C6;/
  191. } fe_status_t; /&#x22C6; application is recommned to reset &#x22C6;/
  192. </programlisting>
  193. <para>to indicate the current state and/or state changes of the frontend hardware.
  194. </para>
  195. </section>
  196. <section id="dvb-frontend-parameters">
  197. <title>frontend parameters</title>
  198. <para>The kind of parameters passed to the frontend device for tuning depend on
  199. the kind of hardware you are using.</para>
  200. <para>The struct <constant>dvb_frontend_parameters</constant> uses an
  201. union with specific per-system parameters. However, as newer delivery systems
  202. required more data, the structure size weren't enough to fit, and just
  203. extending its size would break the existing applications. So, those parameters
  204. were replaced by the usage of <link linkend="FE_GET_SET_PROPERTY">
  205. <constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></link> ioctl's. The
  206. new API is flexible enough to add new parameters to existing delivery systems,
  207. and to add newer delivery systems.</para>
  208. <para>So, newer applications should use <link linkend="FE_GET_SET_PROPERTY">
  209. <constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></link> instead, in
  210. order to be able to support the newer System Delivery like DVB-S2, DVB-T2,
  211. DVB-C2, ISDB, etc.</para>
  212. <para>All kinds of parameters are combined as an union in the FrontendParameters structure:</para>
  213. <programlisting>
  214. struct dvb_frontend_parameters {
  215. uint32_t frequency; /&#x22C6; (absolute) frequency in Hz for QAM/OFDM &#x22C6;/
  216. /&#x22C6; intermediate frequency in kHz for QPSK &#x22C6;/
  217. fe_spectral_inversion_t inversion;
  218. union {
  219. struct dvb_qpsk_parameters qpsk;
  220. struct dvb_qam_parameters qam;
  221. struct dvb_ofdm_parameters ofdm;
  222. struct dvb_vsb_parameters vsb;
  223. } u;
  224. };
  225. </programlisting>
  226. <para>In the case of QPSK frontends the <constant>frequency</constant> field specifies the intermediate
  227. frequency, i.e. the offset which is effectively added to the local oscillator frequency (LOF) of
  228. the LNB. The intermediate frequency has to be specified in units of kHz. For QAM and
  229. OFDM frontends the <constant>frequency</constant> specifies the absolute frequency and is given in Hz.
  230. </para>
  231. <section id="dvb-qpsk-parameters">
  232. <title>QPSK parameters</title>
  233. <para>For satellite QPSK frontends you have to use the <constant>dvb_qpsk_parameters</constant> structure:</para>
  234. <programlisting>
  235. struct dvb_qpsk_parameters {
  236. uint32_t symbol_rate; /&#x22C6; symbol rate in Symbols per second &#x22C6;/
  237. fe_code_rate_t fec_inner; /&#x22C6; forward error correction (see above) &#x22C6;/
  238. };
  239. </programlisting>
  240. </section>
  241. <section id="dvb-qam-parameters">
  242. <title>QAM parameters</title>
  243. <para>for cable QAM frontend you use the <constant>dvb_qam_parameters</constant> structure:</para>
  244. <programlisting>
  245. struct dvb_qam_parameters {
  246. uint32_t symbol_rate; /&#x22C6; symbol rate in Symbols per second &#x22C6;/
  247. fe_code_rate_t fec_inner; /&#x22C6; forward error correction (see above) &#x22C6;/
  248. fe_modulation_t modulation; /&#x22C6; modulation type (see above) &#x22C6;/
  249. };
  250. </programlisting>
  251. </section>
  252. <section id="dvb-vsb-parameters">
  253. <title>VSB parameters</title>
  254. <para>ATSC frontends are supported by the <constant>dvb_vsb_parameters</constant> structure:</para>
  255. <programlisting>
  256. struct dvb_vsb_parameters {
  257. fe_modulation_t modulation; /&#x22C6; modulation type (see above) &#x22C6;/
  258. };
  259. </programlisting>
  260. </section>
  261. <section id="dvb-ofdm-parameters">
  262. <title>OFDM parameters</title>
  263. <para>DVB-T frontends are supported by the <constant>dvb_ofdm_parameters</constant> structure:</para>
  264. <programlisting>
  265. struct dvb_ofdm_parameters {
  266. fe_bandwidth_t bandwidth;
  267. fe_code_rate_t code_rate_HP; /&#x22C6; high priority stream code rate &#x22C6;/
  268. fe_code_rate_t code_rate_LP; /&#x22C6; low priority stream code rate &#x22C6;/
  269. fe_modulation_t constellation; /&#x22C6; modulation type (see above) &#x22C6;/
  270. fe_transmit_mode_t transmission_mode;
  271. fe_guard_interval_t guard_interval;
  272. fe_hierarchy_t hierarchy_information;
  273. };
  274. </programlisting>
  275. </section>
  276. <section id="fe-spectral-inversion-t">
  277. <title>frontend spectral inversion</title>
  278. <para>The Inversion field can take one of these values:
  279. </para>
  280. <programlisting>
  281. typedef enum fe_spectral_inversion {
  282. INVERSION_OFF,
  283. INVERSION_ON,
  284. INVERSION_AUTO
  285. } fe_spectral_inversion_t;
  286. </programlisting>
  287. <para>It indicates if spectral inversion should be presumed or not. In the automatic setting
  288. (<constant>INVERSION_AUTO</constant>) the hardware will try to figure out the correct setting by
  289. itself.
  290. </para>
  291. </section>
  292. <section id="fe-code-rate-t">
  293. <title>frontend code rate</title>
  294. <para>The possible values for the <constant>fec_inner</constant> field used on
  295. <link refend="dvb-qpsk-parameters"><constant>struct dvb_qpsk_parameters</constant></link> and
  296. <link refend="dvb-qam-parameters"><constant>struct dvb_qam_parameters</constant></link> are:
  297. </para>
  298. <programlisting>
  299. typedef enum fe_code_rate {
  300. FEC_NONE = 0,
  301. FEC_1_2,
  302. FEC_2_3,
  303. FEC_3_4,
  304. FEC_4_5,
  305. FEC_5_6,
  306. FEC_6_7,
  307. FEC_7_8,
  308. FEC_8_9,
  309. FEC_AUTO,
  310. FEC_3_5,
  311. FEC_9_10,
  312. } fe_code_rate_t;
  313. </programlisting>
  314. <para>which correspond to error correction rates of 1/2, 2/3, etc., no error correction or auto
  315. detection.
  316. </para>
  317. </section>
  318. <section id="fe-modulation-t">
  319. <title>frontend modulation type for QAM, OFDM and VSB</title>
  320. <para>For cable and terrestrial frontends, e. g. for
  321. <link refend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>,
  322. <link refend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and
  323. <link refend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>,
  324. it needs to specify the quadrature modulation mode which can be one of the following:
  325. </para>
  326. <programlisting>
  327. typedef enum fe_modulation {
  328. QPSK,
  329. QAM_16,
  330. QAM_32,
  331. QAM_64,
  332. QAM_128,
  333. QAM_256,
  334. QAM_AUTO,
  335. VSB_8,
  336. VSB_16,
  337. PSK_8,
  338. APSK_16,
  339. APSK_32,
  340. DQPSK,
  341. } fe_modulation_t;
  342. </programlisting>
  343. </section>
  344. <para>Finally, there are several more parameters for OFDM:
  345. </para>
  346. <section id="fe-transmit-mode-t">
  347. <title>Number of carriers per channel</title>
  348. <programlisting>
  349. typedef enum fe_transmit_mode {
  350. TRANSMISSION_MODE_2K,
  351. TRANSMISSION_MODE_8K,
  352. TRANSMISSION_MODE_AUTO,
  353. TRANSMISSION_MODE_4K,
  354. TRANSMISSION_MODE_1K,
  355. TRANSMISSION_MODE_16K,
  356. TRANSMISSION_MODE_32K,
  357. } fe_transmit_mode_t;
  358. </programlisting>
  359. </section>
  360. <section id="fe-bandwidth-t">
  361. <title>frontend bandwidth</title>
  362. <programlisting>
  363. typedef enum fe_bandwidth {
  364. BANDWIDTH_8_MHZ,
  365. BANDWIDTH_7_MHZ,
  366. BANDWIDTH_6_MHZ,
  367. BANDWIDTH_AUTO,
  368. BANDWIDTH_5_MHZ,
  369. BANDWIDTH_10_MHZ,
  370. BANDWIDTH_1_712_MHZ,
  371. } fe_bandwidth_t;
  372. </programlisting>
  373. </section>
  374. <section id="fe-guard-interval-t">
  375. <title>frontend guard inverval</title>
  376. <programlisting>
  377. typedef enum fe_guard_interval {
  378. GUARD_INTERVAL_1_32,
  379. GUARD_INTERVAL_1_16,
  380. GUARD_INTERVAL_1_8,
  381. GUARD_INTERVAL_1_4,
  382. GUARD_INTERVAL_AUTO,
  383. GUARD_INTERVAL_1_128,
  384. GUARD_INTERVAL_19_128,
  385. GUARD_INTERVAL_19_256,
  386. } fe_guard_interval_t;
  387. </programlisting>
  388. </section>
  389. <section id="fe-hierarchy-t">
  390. <title>frontend hierarchy</title>
  391. <programlisting>
  392. typedef enum fe_hierarchy {
  393. HIERARCHY_NONE,
  394. HIERARCHY_1,
  395. HIERARCHY_2,
  396. HIERARCHY_4,
  397. HIERARCHY_AUTO
  398. } fe_hierarchy_t;
  399. </programlisting>
  400. </section>
  401. </section>
  402. <section id="dvb-frontend-event">
  403. <title>frontend events</title>
  404. <programlisting>
  405. struct dvb_frontend_event {
  406. fe_status_t status;
  407. struct dvb_frontend_parameters parameters;
  408. };
  409. </programlisting>
  410. </section>
  411. </section>
  412. <section id="frontend_fcalls">
  413. <title>Frontend Function Calls</title>
  414. <section id="frontend_f_open">
  415. <title>open()</title>
  416. <para>DESCRIPTION</para>
  417. <informaltable><tgroup cols="1"><tbody><row>
  418. <entry align="char">
  419. <para>This system call opens a named frontend device (/dev/dvb/adapter0/frontend0)
  420. for subsequent use. Usually the first thing to do after a successful open is to
  421. find out the frontend type with <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
  422. <para>The device can be opened in read-only mode, which only allows monitoring of
  423. device status and statistics, or read/write mode, which allows any kind of use
  424. (e.g. performing tuning operations.)
  425. </para>
  426. <para>In a system with multiple front-ends, it is usually the case that multiple devices
  427. cannot be open in read/write mode simultaneously. As long as a front-end
  428. device is opened in read/write mode, other open() calls in read/write mode will
  429. either fail or block, depending on whether non-blocking or blocking mode was
  430. specified. A front-end device opened in blocking mode can later be put into
  431. non-blocking mode (and vice versa) using the F_SETFL command of the fcntl
  432. system call. This is a standard system call, documented in the Linux manual
  433. page for fcntl. When an open() call has succeeded, the device will be ready
  434. for use in the specified mode. This implies that the corresponding hardware is
  435. powered up, and that other front-ends may have been powered down to make
  436. that possible.</para>
  437. </entry>
  438. </row></tbody></tgroup></informaltable>
  439. <para>SYNOPSIS</para>
  440. <informaltable><tgroup cols="1"><tbody><row><entry
  441. align="char">
  442. <para>int open(const char &#x22C6;deviceName, int flags);</para>
  443. </entry>
  444. </row></tbody></tgroup></informaltable>
  445. <para>PARAMETERS
  446. </para>
  447. <informaltable><tgroup cols="2"><tbody><row><entry
  448. align="char">
  449. <para>const char
  450. *deviceName</para>
  451. </entry><entry
  452. align="char">
  453. <para>Name of specific video device.</para>
  454. </entry>
  455. </row><row><entry
  456. align="char">
  457. <para>int flags</para>
  458. </entry><entry
  459. align="char">
  460. <para>A bit-wise OR of the following flags:</para>
  461. </entry>
  462. </row><row><entry
  463. align="char">
  464. </entry><entry
  465. align="char">
  466. <para>O_RDONLY read-only access</para>
  467. </entry>
  468. </row><row><entry
  469. align="char">
  470. </entry><entry
  471. align="char">
  472. <para>O_RDWR read/write access</para>
  473. </entry>
  474. </row><row><entry
  475. align="char">
  476. </entry><entry
  477. align="char">
  478. <para>O_NONBLOCK open in non-blocking mode</para>
  479. </entry>
  480. </row><row><entry
  481. align="char">
  482. </entry><entry
  483. align="char">
  484. <para>(blocking mode is the default)</para>
  485. </entry>
  486. </row></tbody></tgroup></informaltable>
  487. <para>ERRORS
  488. </para>
  489. <informaltable><tgroup cols="2"><tbody><row><entry
  490. align="char">
  491. <para>ENODEV</para>
  492. </entry><entry
  493. align="char">
  494. <para>Device driver not loaded/available.</para>
  495. </entry>
  496. </row><row><entry
  497. align="char">
  498. <para>EINTERNAL</para>
  499. </entry><entry
  500. align="char">
  501. <para>Internal error.</para>
  502. </entry>
  503. </row><row><entry
  504. align="char">
  505. <para>EBUSY</para>
  506. </entry><entry
  507. align="char">
  508. <para>Device or resource busy.</para>
  509. </entry>
  510. </row><row><entry
  511. align="char">
  512. <para>EINVAL</para>
  513. </entry><entry
  514. align="char">
  515. <para>Invalid argument.</para>
  516. </entry>
  517. </row></tbody></tgroup></informaltable>
  518. </section>
  519. <section id="frontend_f_close">
  520. <title>close()</title>
  521. <para>DESCRIPTION
  522. </para>
  523. <informaltable><tgroup cols="1"><tbody><row><entry
  524. align="char">
  525. <para>This system call closes a previously opened front-end device. After closing
  526. a front-end device, its corresponding hardware might be powered down
  527. automatically.</para>
  528. </entry>
  529. </row></tbody></tgroup></informaltable>
  530. <para>SYNOPSIS
  531. </para>
  532. <informaltable><tgroup cols="1"><tbody><row><entry
  533. align="char">
  534. <para>int close(int fd);</para>
  535. </entry>
  536. </row></tbody></tgroup></informaltable>
  537. <para>PARAMETERS
  538. </para>
  539. <informaltable><tgroup cols="2"><tbody><row><entry
  540. align="char">
  541. <para>int fd</para>
  542. </entry><entry
  543. align="char">
  544. <para>File descriptor returned by a previous call to open().</para>
  545. </entry>
  546. </row></tbody></tgroup></informaltable>
  547. <para>ERRORS
  548. </para>
  549. <informaltable><tgroup cols="2"><tbody><row><entry
  550. align="char">
  551. <para>EBADF</para>
  552. </entry><entry
  553. align="char">
  554. <para>fd is not a valid open file descriptor.</para>
  555. </entry>
  556. </row></tbody></tgroup></informaltable>
  557. </section>
  558. <section id="FE_READ_STATUS">
  559. <title>FE_READ_STATUS</title>
  560. <para>DESCRIPTION
  561. </para>
  562. <informaltable><tgroup cols="1"><tbody><row><entry
  563. align="char">
  564. <para>This ioctl call returns status information about the front-end. This call only
  565. requires read-only access to the device.</para>
  566. </entry>
  567. </row></tbody></tgroup></informaltable>
  568. <para>SYNOPSIS
  569. </para>
  570. <informaltable><tgroup cols="1"><tbody><row><entry
  571. align="char">
  572. <para>int ioctl(int fd, int request = <link linkend="FE_READ_STATUS">FE_READ_STATUS</link>,
  573. fe_status_t &#x22C6;status);</para>
  574. </entry>
  575. </row></tbody></tgroup></informaltable>
  576. <para>PARAMETERS
  577. </para>
  578. <informaltable><tgroup cols="2"><tbody><row><entry
  579. align="char">
  580. <para>int fd</para>
  581. </entry><entry
  582. align="char">
  583. <para>File descriptor returned by a previous call to open().</para>
  584. </entry>
  585. </row><row><entry
  586. align="char">
  587. <para>int request</para>
  588. </entry><entry
  589. align="char">
  590. <para>Equals <link linkend="FE_READ_STATUS">FE_READ_STATUS</link> for this command.</para>
  591. </entry>
  592. </row><row><entry
  593. align="char">
  594. <para>struct fe_status_t
  595. *status</para>
  596. </entry><entry
  597. align="char">
  598. <para>Points to the location where the front-end status word is
  599. to be stored.</para>
  600. </entry>
  601. </row></tbody></tgroup></informaltable>
  602. <para>ERRORS
  603. </para>
  604. <informaltable><tgroup cols="2"><tbody><row><entry
  605. align="char">
  606. <para>EBADF</para>
  607. </entry><entry
  608. align="char">
  609. <para>fd is not a valid open file descriptor.</para>
  610. </entry>
  611. </row><row><entry
  612. align="char">
  613. <para>EFAULT</para>
  614. </entry><entry
  615. align="char">
  616. <para>status points to invalid address.</para>
  617. </entry>
  618. </row></tbody></tgroup></informaltable>
  619. </section>
  620. <section id="FE_READ_BER">
  621. <title>FE_READ_BER</title>
  622. <para>DESCRIPTION
  623. </para>
  624. <informaltable><tgroup cols="1"><tbody><row><entry
  625. align="char">
  626. <para>This ioctl call returns the bit error rate for the signal currently
  627. received/demodulated by the front-end. For this command, read-only access to
  628. the device is sufficient.</para>
  629. </entry>
  630. </row></tbody></tgroup></informaltable>
  631. <para>SYNOPSIS
  632. </para>
  633. <informaltable><tgroup cols="1"><tbody><row><entry
  634. align="char">
  635. <para>int ioctl(int fd, int request = <link linkend="FE_READ_BER">FE_READ_BER</link>,
  636. uint32_t &#x22C6;ber);</para>
  637. </entry>
  638. </row></tbody></tgroup></informaltable>
  639. <para>PARAMETERS
  640. </para>
  641. <informaltable><tgroup cols="2"><tbody><row><entry
  642. align="char">
  643. <para>int fd</para>
  644. </entry><entry
  645. align="char">
  646. <para>File descriptor returned by a previous call to open().</para>
  647. </entry>
  648. </row><row><entry
  649. align="char">
  650. <para>int request</para>
  651. </entry><entry
  652. align="char">
  653. <para>Equals <link linkend="FE_READ_BER">FE_READ_BER</link> for this command.</para>
  654. </entry>
  655. </row><row><entry
  656. align="char">
  657. <para>uint32_t *ber</para>
  658. </entry><entry
  659. align="char">
  660. <para>The bit error rate is stored into *ber.</para>
  661. </entry>
  662. </row></tbody></tgroup></informaltable>
  663. <para>ERRORS
  664. </para>
  665. <informaltable><tgroup cols="2"><tbody><row><entry
  666. align="char">
  667. <para>EBADF</para>
  668. </entry><entry
  669. align="char">
  670. <para>fd is not a valid open file descriptor.</para>
  671. </entry>
  672. </row><row><entry
  673. align="char">
  674. <para>EFAULT</para>
  675. </entry><entry
  676. align="char">
  677. <para>ber points to invalid address.</para>
  678. </entry>
  679. </row><row><entry
  680. align="char">
  681. <para>ENOSIGNAL</para>
  682. </entry><entry
  683. align="char">
  684. <para>There is no signal, thus no meaningful bit error rate. Also
  685. returned if the front-end is not turned on.</para>
  686. </entry>
  687. </row><row><entry
  688. align="char">
  689. <para>ENOSYS</para>
  690. </entry><entry
  691. align="char">
  692. <para>Function not available for this device.</para>
  693. </entry>
  694. </row></tbody></tgroup></informaltable>
  695. </section>
  696. <section id="FE_READ_SNR">
  697. <title>FE_READ_SNR</title>
  698. <para>DESCRIPTION
  699. </para>
  700. <informaltable><tgroup cols="1"><tbody><row><entry
  701. align="char">
  702. <para>This ioctl call returns the signal-to-noise ratio for the signal currently received
  703. by the front-end. For this command, read-only access to the device is sufficient.</para>
  704. </entry>
  705. </row></tbody></tgroup></informaltable>
  706. <para>SYNOPSIS
  707. </para>
  708. <informaltable><tgroup cols="1"><tbody><row><entry
  709. align="char">
  710. <para>int ioctl(int fd, int request = <link linkend="FE_READ_SNR">FE_READ_SNR</link>, int16_t
  711. &#x22C6;snr);</para>
  712. </entry>
  713. </row></tbody></tgroup></informaltable>
  714. <para>PARAMETERS
  715. </para>
  716. <informaltable><tgroup cols="2"><tbody><row><entry
  717. align="char">
  718. <para>int fd</para>
  719. </entry><entry
  720. align="char">
  721. <para>File descriptor returned by a previous call to open().</para>
  722. </entry>
  723. </row><row><entry
  724. align="char">
  725. <para>int request</para>
  726. </entry><entry
  727. align="char">
  728. <para>Equals <link linkend="FE_READ_SNR">FE_READ_SNR</link> for this command.</para>
  729. </entry>
  730. </row><row><entry
  731. align="char">
  732. <para>int16_t *snr</para>
  733. </entry><entry
  734. align="char">
  735. <para>The signal-to-noise ratio is stored into *snr.</para>
  736. </entry>
  737. </row></tbody></tgroup></informaltable>
  738. <para>ERRORS
  739. </para>
  740. <informaltable><tgroup cols="2"><tbody><row><entry
  741. align="char">
  742. <para>EBADF</para>
  743. </entry><entry
  744. align="char">
  745. <para>fd is not a valid open file descriptor.</para>
  746. </entry>
  747. </row><row><entry
  748. align="char">
  749. <para>EFAULT</para>
  750. </entry><entry
  751. align="char">
  752. <para>snr points to invalid address.</para>
  753. </entry>
  754. </row><row><entry
  755. align="char">
  756. <para>ENOSIGNAL</para>
  757. </entry><entry
  758. align="char">
  759. <para>There is no signal, thus no meaningful signal strength
  760. value. Also returned if front-end is not turned on.</para>
  761. </entry>
  762. </row><row><entry
  763. align="char">
  764. <para>ENOSYS</para>
  765. </entry><entry
  766. align="char">
  767. <para>Function not available for this device.</para>
  768. </entry>
  769. </row></tbody></tgroup></informaltable>
  770. </section>
  771. <section id="FE_READ_SIGNAL_STRENGTH">
  772. <title>FE_READ_SIGNAL_STRENGTH</title>
  773. <para>DESCRIPTION
  774. </para>
  775. <informaltable><tgroup cols="1"><tbody><row><entry
  776. align="char">
  777. <para>This ioctl call returns the signal strength value for the signal currently received
  778. by the front-end. For this command, read-only access to the device is sufficient.</para>
  779. </entry>
  780. </row></tbody></tgroup></informaltable>
  781. <para>SYNOPSIS
  782. </para>
  783. <informaltable><tgroup cols="1"><tbody><row><entry
  784. align="char">
  785. <para>int ioctl( int fd, int request =
  786. <link linkend="FE_READ_SIGNAL_STRENGTH">FE_READ_SIGNAL_STRENGTH</link>, int16_t &#x22C6;strength);</para>
  787. </entry>
  788. </row></tbody></tgroup></informaltable>
  789. <para>PARAMETERS
  790. </para>
  791. <informaltable><tgroup cols="2"><tbody><row><entry
  792. align="char">
  793. <para>int fd</para>
  794. </entry><entry
  795. align="char">
  796. <para>File descriptor returned by a previous call to open().</para>
  797. </entry>
  798. </row><row><entry
  799. align="char">
  800. <para>int request</para>
  801. </entry><entry
  802. align="char">
  803. <para>Equals <link linkend="FE_READ_SIGNAL_STRENGTH">FE_READ_SIGNAL_STRENGTH</link> for this
  804. command.</para>
  805. </entry>
  806. </row><row><entry
  807. align="char">
  808. <para>int16_t *strength</para>
  809. </entry><entry
  810. align="char">
  811. <para>The signal strength value is stored into *strength.</para>
  812. </entry>
  813. </row></tbody></tgroup></informaltable>
  814. <para>ERRORS
  815. </para>
  816. <informaltable><tgroup cols="2"><tbody><row><entry
  817. align="char">
  818. <para>EBADF</para>
  819. </entry><entry
  820. align="char">
  821. <para>fd is not a valid open file descriptor.</para>
  822. </entry>
  823. </row><row><entry
  824. align="char">
  825. <para>EFAULT</para>
  826. </entry><entry
  827. align="char">
  828. <para>status points to invalid address.</para>
  829. </entry>
  830. </row><row><entry
  831. align="char">
  832. <para>ENOSIGNAL</para>
  833. </entry><entry
  834. align="char">
  835. <para>There is no signal, thus no meaningful signal strength
  836. value. Also returned if front-end is not turned on.</para>
  837. </entry>
  838. </row><row><entry
  839. align="char">
  840. <para>ENOSYS</para>
  841. </entry><entry
  842. align="char">
  843. <para>Function not available for this device.</para>
  844. </entry>
  845. </row></tbody></tgroup></informaltable>
  846. </section>
  847. <section id="FE_READ_UNCORRECTED_BLOCKS">
  848. <title>FE_READ_UNCORRECTED_BLOCKS</title>
  849. <para>DESCRIPTION
  850. </para>
  851. <informaltable><tgroup cols="1"><tbody><row><entry
  852. align="char">
  853. <para>This ioctl call returns the number of uncorrected blocks detected by the device
  854. driver during its lifetime. For meaningful measurements, the increment in block
  855. count during a specific time interval should be calculated. For this command,
  856. read-only access to the device is sufficient.</para>
  857. </entry>
  858. </row><row><entry
  859. align="char">
  860. <para>Note that the counter will wrap to zero after its maximum count has been
  861. reached.</para>
  862. </entry>
  863. </row></tbody></tgroup></informaltable>
  864. <para>SYNOPSIS
  865. </para>
  866. <informaltable><tgroup cols="1"><tbody><row><entry
  867. align="char">
  868. <para>int ioctl( int fd, int request =
  869. <link linkend="FE_READ_UNCORRECTED_BLOCKS">FE_READ_UNCORRECTED_BLOCKS</link>, uint32_t &#x22C6;ublocks);</para>
  870. </entry>
  871. </row></tbody></tgroup></informaltable>
  872. <para>PARAMETERS
  873. </para>
  874. <informaltable><tgroup cols="2"><tbody><row><entry
  875. align="char">
  876. <para>int fd</para>
  877. </entry><entry
  878. align="char">
  879. <para>File descriptor returned by a previous call to open().</para>
  880. </entry>
  881. </row><row><entry
  882. align="char">
  883. <para>int request</para>
  884. </entry><entry
  885. align="char">
  886. <para>Equals <link linkend="FE_READ_UNCORRECTED_BLOCKS">FE_READ_UNCORRECTED_BLOCKS</link> for this
  887. command.</para>
  888. </entry>
  889. </row><row><entry
  890. align="char">
  891. <para>uint32_t *ublocks</para>
  892. </entry><entry
  893. align="char">
  894. <para>The total number of uncorrected blocks seen by the driver
  895. so far.</para>
  896. </entry>
  897. </row></tbody></tgroup></informaltable>
  898. <para>ERRORS
  899. </para>
  900. <informaltable><tgroup cols="2"><tbody><row><entry
  901. align="char">
  902. <para>EBADF</para>
  903. </entry><entry
  904. align="char">
  905. <para>fd is not a valid open file descriptor.</para>
  906. </entry>
  907. </row><row><entry
  908. align="char">
  909. <para>EFAULT</para>
  910. </entry><entry
  911. align="char">
  912. <para>ublocks points to invalid address.</para>
  913. </entry>
  914. </row><row><entry
  915. align="char">
  916. <para>ENOSYS</para>
  917. </entry><entry
  918. align="char">
  919. <para>Function not available for this device.</para>
  920. </entry>
  921. </row></tbody></tgroup></informaltable>
  922. </section>
  923. <section id="FE_SET_FRONTEND">
  924. <title>FE_SET_FRONTEND</title>
  925. <para>DESCRIPTION
  926. </para>
  927. <informaltable><tgroup cols="1"><tbody><row><entry
  928. align="char">
  929. <para>This ioctl call starts a tuning operation using specified parameters. The result
  930. of this call will be successful if the parameters were valid and the tuning could
  931. be initiated. The result of the tuning operation in itself, however, will arrive
  932. asynchronously as an event (see documentation for <link linkend="FE_GET_EVENT">FE_GET_EVENT</link> and
  933. FrontendEvent.) If a new <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> operation is initiated before
  934. the previous one was completed, the previous operation will be aborted in favor
  935. of the new one. This command requires read/write access to the device.</para>
  936. </entry>
  937. </row></tbody></tgroup></informaltable>
  938. <para>SYNOPSIS
  939. </para>
  940. <informaltable><tgroup cols="1"><tbody><row><entry
  941. align="char">
  942. <para>int ioctl(int fd, int request = <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link>,
  943. struct dvb_frontend_parameters &#x22C6;p);</para>
  944. </entry>
  945. </row></tbody></tgroup></informaltable>
  946. <para>PARAMETERS
  947. </para>
  948. <informaltable><tgroup cols="2"><tbody><row><entry
  949. align="char">
  950. <para>int fd</para>
  951. </entry><entry
  952. align="char">
  953. <para>File descriptor returned by a previous call to open().</para>
  954. </entry>
  955. </row><row><entry
  956. align="char">
  957. <para>int request</para>
  958. </entry><entry
  959. align="char">
  960. <para>Equals <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> for this command.</para>
  961. </entry>
  962. </row><row><entry
  963. align="char">
  964. <para>struct
  965. dvb_frontend_parameters
  966. *p</para>
  967. </entry><entry
  968. align="char">
  969. <para>Points to parameters for tuning operation.</para>
  970. </entry>
  971. </row></tbody></tgroup></informaltable>
  972. <para>ERRORS
  973. </para>
  974. <informaltable><tgroup cols="2"><tbody><row><entry
  975. align="char">
  976. <para>EBADF</para>
  977. </entry><entry
  978. align="char">
  979. <para>fd is not a valid open file descriptor.</para>
  980. </entry>
  981. </row><row><entry
  982. align="char">
  983. <para>EFAULT</para>
  984. </entry><entry
  985. align="char">
  986. <para>p points to invalid address.</para>
  987. </entry>
  988. </row><row><entry
  989. align="char">
  990. <para>EINVAL</para>
  991. </entry><entry
  992. align="char">
  993. <para>Maximum supported symbol rate reached.</para>
  994. </entry>
  995. </row></tbody></tgroup></informaltable>
  996. </section>
  997. <section id="FE_GET_FRONTEND">
  998. <title>FE_GET_FRONTEND</title>
  999. <para>DESCRIPTION
  1000. </para>
  1001. <informaltable><tgroup cols="1"><tbody><row><entry
  1002. align="char">
  1003. <para>This ioctl call queries the currently effective frontend parameters. For this
  1004. command, read-only access to the device is sufficient.</para>
  1005. </entry>
  1006. </row></tbody></tgroup></informaltable>
  1007. <para>SYNOPSIS
  1008. </para>
  1009. <informaltable><tgroup cols="1"><tbody><row><entry
  1010. align="char">
  1011. <para>int ioctl(int fd, int request = <link linkend="FE_GET_FRONTEND">FE_GET_FRONTEND</link>,
  1012. struct dvb_frontend_parameters &#x22C6;p);</para>
  1013. </entry>
  1014. </row></tbody></tgroup></informaltable>
  1015. <para>PARAMETERS
  1016. </para>
  1017. <informaltable><tgroup cols="2"><tbody><row><entry
  1018. align="char">
  1019. <para>int fd</para>
  1020. </entry><entry
  1021. align="char">
  1022. <para>File descriptor returned by a previous call to open().</para>
  1023. </entry>
  1024. </row><row><entry
  1025. align="char">
  1026. <para>int request</para>
  1027. </entry><entry
  1028. align="char">
  1029. <para>Equals <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> for this command.</para>
  1030. </entry>
  1031. </row><row><entry
  1032. align="char">
  1033. <para>struct
  1034. dvb_frontend_parameters
  1035. *p</para>
  1036. </entry><entry
  1037. align="char">
  1038. <para>Points to parameters for tuning operation.</para>
  1039. </entry>
  1040. </row></tbody></tgroup></informaltable>
  1041. <para>ERRORS
  1042. </para>
  1043. <informaltable><tgroup cols="2"><tbody><row><entry
  1044. align="char">
  1045. <para>EBADF</para>
  1046. </entry><entry
  1047. align="char">
  1048. <para>fd is not a valid open file descriptor.</para>
  1049. </entry>
  1050. </row><row><entry
  1051. align="char">
  1052. <para>EFAULT</para>
  1053. </entry><entry
  1054. align="char">
  1055. <para>p points to invalid address.</para>
  1056. </entry>
  1057. </row><row><entry
  1058. align="char">
  1059. <para>EINVAL</para>
  1060. </entry><entry
  1061. align="char">
  1062. <para>Maximum supported symbol rate reached.</para>
  1063. </entry>
  1064. </row></tbody></tgroup></informaltable>
  1065. </section>
  1066. <section id="FE_GET_EVENT">
  1067. <title>FE_GET_EVENT</title>
  1068. <para>DESCRIPTION
  1069. </para>
  1070. <informaltable><tgroup cols="1"><tbody><row><entry
  1071. align="char">
  1072. <para>This ioctl call returns a frontend event if available. If an event is not
  1073. available, the behavior depends on whether the device is in blocking or
  1074. non-blocking mode. In the latter case, the call fails immediately with errno
  1075. set to EWOULDBLOCK. In the former case, the call blocks until an event
  1076. becomes available.</para>
  1077. </entry>
  1078. </row><row><entry
  1079. align="char">
  1080. <para>The standard Linux poll() and/or select() system calls can be used with the
  1081. device file descriptor to watch for new events. For select(), the file descriptor
  1082. should be included in the exceptfds argument, and for poll(), POLLPRI should
  1083. be specified as the wake-up condition. Since the event queue allocated is
  1084. rather small (room for 8 events), the queue must be serviced regularly to avoid
  1085. overflow. If an overflow happens, the oldest event is discarded from the queue,
  1086. and an error (EOVERFLOW) occurs the next time the queue is read. After
  1087. reporting the error condition in this fashion, subsequent
  1088. <link linkend="FE_GET_EVENT">FE_GET_EVENT</link>
  1089. calls will return events from the queue as usual.</para>
  1090. </entry>
  1091. </row><row><entry
  1092. align="char">
  1093. <para>For the sake of implementation simplicity, this command requires read/write
  1094. access to the device.</para>
  1095. </entry>
  1096. </row></tbody></tgroup></informaltable>
  1097. <para>SYNOPSIS
  1098. </para>
  1099. <informaltable><tgroup cols="1"><tbody><row><entry
  1100. align="char">
  1101. <para>int ioctl(int fd, int request = QPSK_GET_EVENT,
  1102. struct dvb_frontend_event &#x22C6;ev);</para>
  1103. </entry>
  1104. </row></tbody></tgroup></informaltable>
  1105. <para>PARAMETERS
  1106. </para>
  1107. <informaltable><tgroup cols="2"><tbody><row><entry
  1108. align="char">
  1109. <para>int fd</para>
  1110. </entry><entry
  1111. align="char">
  1112. <para>File descriptor returned by a previous call to open().</para>
  1113. </entry>
  1114. </row><row><entry
  1115. align="char">
  1116. <para>int request</para>
  1117. </entry><entry
  1118. align="char">
  1119. <para>Equals <link linkend="FE_GET_EVENT">FE_GET_EVENT</link> for this command.</para>
  1120. </entry>
  1121. </row><row><entry
  1122. align="char">
  1123. <para>struct
  1124. dvb_frontend_event
  1125. *ev</para>
  1126. </entry><entry
  1127. align="char">
  1128. <para>Points to the location where the event,</para>
  1129. </entry>
  1130. </row><row><entry
  1131. align="char">
  1132. </entry><entry
  1133. align="char">
  1134. <para>if any, is to be stored.</para>
  1135. </entry>
  1136. </row></tbody></tgroup></informaltable>
  1137. <para>ERRORS
  1138. </para>
  1139. <informaltable><tgroup cols="2"><tbody><row><entry
  1140. align="char">
  1141. <para>EBADF</para>
  1142. </entry><entry
  1143. align="char">
  1144. <para>fd is not a valid open file descriptor.</para>
  1145. </entry>
  1146. </row><row><entry
  1147. align="char">
  1148. <para>EFAULT</para>
  1149. </entry><entry
  1150. align="char">
  1151. <para>ev points to invalid address.</para>
  1152. </entry>
  1153. </row><row><entry
  1154. align="char">
  1155. <para>EWOULDBLOCK</para>
  1156. </entry><entry
  1157. align="char">
  1158. <para>There is no event pending, and the device is in
  1159. non-blocking mode.</para>
  1160. </entry>
  1161. </row><row><entry
  1162. align="char">
  1163. <para>EOVERFLOW</para>
  1164. </entry><entry
  1165. align="char">
  1166. </entry>
  1167. </row><row><entry
  1168. align="char">
  1169. </entry><entry
  1170. align="char">
  1171. <para>Overflow in event queue - one or more events were lost.</para>
  1172. </entry>
  1173. </row></tbody></tgroup></informaltable>
  1174. </section>
  1175. <section id="FE_GET_INFO">
  1176. <title>FE_GET_INFO</title>
  1177. <para>DESCRIPTION
  1178. </para>
  1179. <informaltable><tgroup cols="1"><tbody><row><entry
  1180. align="char">
  1181. <para>This ioctl call returns information about the front-end. This call only requires
  1182. read-only access to the device.</para>
  1183. </entry>
  1184. </row></tbody></tgroup></informaltable>
  1185. <para>SYNOPSIS
  1186. </para>
  1187. <informaltable><tgroup cols="1"><tbody><row><entry
  1188. align="char">
  1189. <para> int ioctl(int fd, int request = <link linkend="FE_GET_INFO">FE_GET_INFO</link>, struct
  1190. dvb_frontend_info &#x22C6;info);</para>
  1191. </entry>
  1192. </row></tbody></tgroup></informaltable>
  1193. <para>PARAMETERS
  1194. </para>
  1195. <informaltable><tgroup cols="2"><tbody><row><entry
  1196. align="char">
  1197. <para>int fd</para>
  1198. </entry><entry
  1199. align="char">
  1200. <para>File descriptor returned by a previous call to open().</para>
  1201. </entry>
  1202. </row><row><entry
  1203. align="char">
  1204. <para>int request</para>
  1205. </entry><entry
  1206. align="char">
  1207. <para>Equals <link linkend="FE_GET_INFO">FE_GET_INFO</link> for this command.</para>
  1208. </entry>
  1209. </row><row><entry
  1210. align="char">
  1211. <para>struct
  1212. dvb_frontend_info
  1213. *info</para>
  1214. </entry><entry
  1215. align="char">
  1216. <para>Points to the location where the front-end information is
  1217. to be stored.</para>
  1218. </entry>
  1219. </row></tbody></tgroup></informaltable>
  1220. <para>ERRORS
  1221. </para>
  1222. <informaltable><tgroup cols="2"><tbody><row><entry
  1223. align="char">
  1224. <para>EBADF</para>
  1225. </entry><entry
  1226. align="char">
  1227. <para>fd is not a valid open file descriptor.</para>
  1228. </entry>
  1229. </row><row><entry
  1230. align="char">
  1231. <para>EFAULT</para>
  1232. </entry><entry
  1233. align="char">
  1234. <para>info points to invalid address.</para>
  1235. </entry>
  1236. </row></tbody></tgroup></informaltable>
  1237. </section>
  1238. <section id="FE_DISEQC_RESET_OVERLOAD">
  1239. <title>FE_DISEQC_RESET_OVERLOAD</title>
  1240. <para>DESCRIPTION
  1241. </para>
  1242. <informaltable><tgroup cols="1"><tbody><row><entry
  1243. align="char">
  1244. <para>If the bus has been automatically powered off due to power overload, this ioctl
  1245. call restores the power to the bus. The call requires read/write access to the
  1246. device. This call has no effect if the device is manually powered off. Not all
  1247. DVB adapters support this ioctl.</para>
  1248. </entry>
  1249. </row></tbody></tgroup></informaltable>
  1250. <para>SYNOPSIS
  1251. </para>
  1252. <informaltable><tgroup cols="1"><tbody><row><entry
  1253. align="char">
  1254. <para>int ioctl(int fd, int request =
  1255. <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link>);</para>
  1256. </entry>
  1257. </row></tbody></tgroup></informaltable>
  1258. <para>PARAMETERS
  1259. </para>
  1260. <informaltable><tgroup cols="2"><tbody><row><entry
  1261. align="char">
  1262. <para>int fd</para>
  1263. </entry><entry
  1264. align="char">
  1265. <para>File descriptor returned by a previous call to open().</para>
  1266. </entry>
  1267. </row><row><entry
  1268. align="char">
  1269. <para>int request</para>
  1270. </entry><entry
  1271. align="char">
  1272. <para>Equals <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link> for this
  1273. command.</para>
  1274. </entry>
  1275. </row></tbody></tgroup></informaltable>
  1276. <para>ERRORS
  1277. </para>
  1278. <informaltable><tgroup cols="2"><tbody><row><entry
  1279. align="char">
  1280. <para>EBADF</para>
  1281. </entry><entry
  1282. align="char">
  1283. <para>fd is not a valid file descriptor.</para>
  1284. </entry>
  1285. </row><row><entry
  1286. align="char">
  1287. <para>EPERM</para>
  1288. </entry><entry
  1289. align="char">
  1290. <para>Permission denied (needs read/write access).</para>
  1291. </entry>
  1292. </row><row><entry
  1293. align="char">
  1294. <para>EINTERNAL</para>
  1295. </entry><entry
  1296. align="char">
  1297. <para>Internal error in the device driver.</para>
  1298. </entry>
  1299. </row></tbody></tgroup></informaltable>
  1300. </section>
  1301. <section id="FE_DISEQC_SEND_MASTER_CMD">
  1302. <title>FE_DISEQC_SEND_MASTER_CMD</title>
  1303. <para>DESCRIPTION
  1304. </para>
  1305. <informaltable><tgroup cols="1"><tbody><row><entry
  1306. align="char">
  1307. <para>This ioctl call is used to send a a DiSEqC command.</para>
  1308. </entry>
  1309. </row></tbody></tgroup></informaltable>
  1310. <para>SYNOPSIS
  1311. </para>
  1312. <informaltable><tgroup cols="1"><tbody><row><entry
  1313. align="char">
  1314. <para>int ioctl(int fd, int request =
  1315. <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link>, struct
  1316. dvb_diseqc_master_cmd &#x22C6;cmd);</para>
  1317. </entry>
  1318. </row></tbody></tgroup></informaltable>
  1319. <para>PARAMETERS
  1320. </para>
  1321. <informaltable><tgroup cols="2"><tbody><row><entry
  1322. align="char">
  1323. <para>int fd</para>
  1324. </entry><entry
  1325. align="char">
  1326. <para>File descriptor returned by a previous call to open().</para>
  1327. </entry>
  1328. </row><row><entry
  1329. align="char">
  1330. <para>int request</para>
  1331. </entry><entry
  1332. align="char">
  1333. <para>Equals <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link> for this
  1334. command.</para>
  1335. </entry>
  1336. </row><row><entry
  1337. align="char">
  1338. <para>struct
  1339. dvb_diseqc_master_cmd
  1340. *cmd</para>
  1341. </entry><entry
  1342. align="char">
  1343. <para>Pointer to the command to be transmitted.</para>
  1344. </entry>
  1345. </row></tbody></tgroup></informaltable>
  1346. <para>ERRORS
  1347. </para>
  1348. <informaltable><tgroup cols="2"><tbody><row><entry
  1349. align="char">
  1350. <para>EBADF</para>
  1351. </entry><entry
  1352. align="char">
  1353. <para>fd is not a valid file descriptor.</para>
  1354. </entry>
  1355. </row><row><entry
  1356. align="char">
  1357. <para>EFAULT</para>
  1358. </entry><entry
  1359. align="char">
  1360. <para>Seq points to an invalid address.</para>
  1361. </entry>
  1362. </row><row><entry
  1363. align="char">
  1364. <para>EINVAL</para>
  1365. </entry><entry
  1366. align="char">
  1367. <para>The data structure referred to by seq is invalid in some
  1368. way.</para>
  1369. </entry>
  1370. </row><row><entry
  1371. align="char">
  1372. <para>EPERM</para>
  1373. </entry><entry
  1374. align="char">
  1375. <para>Permission denied (needs read/write access).</para>
  1376. </entry>
  1377. </row><row><entry
  1378. align="char">
  1379. <para>EINTERNAL</para>
  1380. </entry><entry
  1381. align="char">
  1382. <para>Internal error in the device driver.</para>
  1383. </entry>
  1384. </row></tbody></tgroup></informaltable>
  1385. </section>
  1386. <section id="FE_DISEQC_RECV_SLAVE_REPLY">
  1387. <title>FE_DISEQC_RECV_SLAVE_REPLY</title>
  1388. <para>DESCRIPTION
  1389. </para>
  1390. <informaltable><tgroup cols="1"><tbody><row><entry
  1391. align="char">
  1392. <para>This ioctl call is used to receive reply to a DiSEqC 2.0 command.</para>
  1393. </entry>
  1394. </row></tbody></tgroup></informaltable>
  1395. <para>SYNOPSIS
  1396. </para>
  1397. <informaltable><tgroup cols="1"><tbody><row><entry
  1398. align="char">
  1399. <para>int ioctl(int fd, int request =
  1400. <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link>, struct
  1401. dvb_diseqc_slave_reply &#x22C6;reply);</para>
  1402. </entry>
  1403. </row></tbody></tgroup></informaltable>
  1404. <para>PARAMETERS
  1405. </para>
  1406. <informaltable><tgroup cols="2"><tbody><row><entry
  1407. align="char">
  1408. <para>int fd</para>
  1409. </entry><entry
  1410. align="char">
  1411. <para>File descriptor returned by a previous call to open().</para>
  1412. </entry>
  1413. </row><row><entry
  1414. align="char">
  1415. <para>int request</para>
  1416. </entry><entry
  1417. align="char">
  1418. <para>Equals <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link> for this
  1419. command.</para>
  1420. </entry>
  1421. </row><row><entry
  1422. align="char">
  1423. <para>struct
  1424. dvb_diseqc_slave_reply
  1425. *reply</para>
  1426. </entry><entry
  1427. align="char">
  1428. <para>Pointer to the command to be received.</para>
  1429. </entry>
  1430. </row></tbody></tgroup></informaltable>
  1431. <para>ERRORS
  1432. </para>
  1433. <informaltable><tgroup cols="2"><tbody><row><entry
  1434. align="char">
  1435. <para>EBADF</para>
  1436. </entry><entry
  1437. align="char">
  1438. <para>fd is not a valid file descriptor.</para>
  1439. </entry>
  1440. </row><row><entry
  1441. align="char">
  1442. <para>EFAULT</para>
  1443. </entry><entry
  1444. align="char">
  1445. <para>Seq points to an invalid address.</para>
  1446. </entry>
  1447. </row><row><entry
  1448. align="char">
  1449. <para>EINVAL</para>
  1450. </entry><entry
  1451. align="char">
  1452. <para>The data structure referred to by seq is invalid in some
  1453. way.</para>
  1454. </entry>
  1455. </row><row><entry
  1456. align="char">
  1457. <para>EPERM</para>
  1458. </entry><entry
  1459. align="char">
  1460. <para>Permission denied (needs read/write access).</para>
  1461. </entry>
  1462. </row><row><entry
  1463. align="char">
  1464. <para>EINTERNAL</para>
  1465. </entry><entry
  1466. align="char">
  1467. <para>Internal error in the device driver.</para>
  1468. </entry>
  1469. </row></tbody></tgroup></informaltable>
  1470. </section>
  1471. <section id="FE_DISEQC_SEND_BURST">
  1472. <title>FE_DISEQC_SEND_BURST</title>
  1473. <para>DESCRIPTION
  1474. </para>
  1475. <informaltable><tgroup cols="1"><tbody><row><entry
  1476. align="char">
  1477. <para>This ioctl call is used to send a 22KHz tone burst.</para>
  1478. </entry>
  1479. </row></tbody></tgroup></informaltable>
  1480. <para>SYNOPSIS
  1481. </para>
  1482. <informaltable><tgroup cols="1"><tbody><row><entry
  1483. align="char">
  1484. <para>int ioctl(int fd, int request =
  1485. <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link>, fe_sec_mini_cmd_t burst);</para>
  1486. </entry>
  1487. </row></tbody></tgroup></informaltable>
  1488. <para>PARAMETERS
  1489. </para>
  1490. <informaltable><tgroup cols="2"><tbody><row><entry
  1491. align="char">
  1492. <para>int fd</para>
  1493. </entry><entry
  1494. align="char">
  1495. <para>File descriptor returned by a previous call to open().</para>
  1496. </entry>
  1497. </row><row><entry
  1498. align="char">
  1499. <para>int request</para>
  1500. </entry><entry
  1501. align="char">
  1502. <para>Equals <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link> for this command.</para>
  1503. </entry>
  1504. </row><row><entry
  1505. align="char">
  1506. <para>fe_sec_mini_cmd_t
  1507. burst</para>
  1508. </entry><entry
  1509. align="char">
  1510. <para>burst A or B.</para>
  1511. </entry>
  1512. </row></tbody></tgroup></informaltable>
  1513. <para>ERRORS
  1514. </para>
  1515. <informaltable><tgroup cols="2"><tbody><row><entry
  1516. align="char">
  1517. <para>EBADF</para>
  1518. </entry><entry
  1519. align="char">
  1520. <para>fd is not a valid file descriptor.</para>
  1521. </entry>
  1522. </row><row><entry
  1523. align="char">
  1524. <para>EFAULT</para>
  1525. </entry><entry
  1526. align="char">
  1527. <para>Seq points to an invalid address.</para>
  1528. </entry>
  1529. </row><row><entry
  1530. align="char">
  1531. <para>EINVAL</para>
  1532. </entry><entry
  1533. align="char">
  1534. <para>The data structure referred to by seq is invalid in some
  1535. way.</para>
  1536. </entry>
  1537. </row><row><entry
  1538. align="char">
  1539. <para>EPERM</para>
  1540. </entry><entry
  1541. align="char">
  1542. <para>Permission denied (needs read/write access).</para>
  1543. </entry>
  1544. </row><row><entry
  1545. align="char">
  1546. <para>EINTERNAL</para>
  1547. </entry><entry
  1548. align="char">
  1549. <para>Internal error in the device driver.</para>
  1550. </entry>
  1551. </row></tbody></tgroup></informaltable>
  1552. </section>
  1553. <section id="FE_SET_TONE">
  1554. <title>FE_SET_TONE</title>
  1555. <para>DESCRIPTION
  1556. </para>
  1557. <informaltable><tgroup cols="1"><tbody><row><entry
  1558. align="char">
  1559. <para>This call is used to set the generation of the continuous 22kHz tone. This call
  1560. requires read/write permissions.</para>
  1561. </entry>
  1562. </row></tbody></tgroup></informaltable>
  1563. <para>SYNOPSIS
  1564. </para>
  1565. <informaltable><tgroup cols="1"><tbody><row><entry
  1566. align="char">
  1567. <para>int ioctl(int fd, int request = <link linkend="FE_SET_TONE">FE_SET_TONE</link>,
  1568. fe_sec_tone_mode_t tone);</para>
  1569. </entry>
  1570. </row></tbody></tgroup></informaltable>
  1571. <para>PARAMETERS
  1572. </para>
  1573. <informaltable><tgroup cols="2"><tbody><row><entry
  1574. align="char">
  1575. <para>int fd</para>
  1576. </entry><entry
  1577. align="char">
  1578. <para>File descriptor returned by a previous call to open().</para>
  1579. </entry>
  1580. </row><row><entry
  1581. align="char">
  1582. <para>int request</para>
  1583. </entry><entry
  1584. align="char">
  1585. <para>Equals <link linkend="FE_SET_TONE">FE_SET_TONE</link> for this command.</para>
  1586. </entry>
  1587. </row><row><entry
  1588. align="char">
  1589. <para>fe_sec_tone_mode_t
  1590. tone</para>
  1591. </entry><entry
  1592. align="char">
  1593. <para>The requested tone generation mode (on/off).</para>
  1594. </entry>
  1595. </row></tbody></tgroup></informaltable>
  1596. <para>ERRORS
  1597. </para>
  1598. <informaltable><tgroup cols="2"><tbody><row><entry
  1599. align="char">
  1600. <para>ENODEV</para>
  1601. </entry><entry
  1602. align="char">
  1603. <para>Device driver not loaded/available.</para>
  1604. </entry>
  1605. </row><row><entry
  1606. align="char">
  1607. <para>EBUSY</para>
  1608. </entry><entry
  1609. align="char">
  1610. <para>Device or resource busy.</para>
  1611. </entry>
  1612. </row><row><entry
  1613. align="char">
  1614. <para>EINVAL</para>
  1615. </entry><entry
  1616. align="char">
  1617. <para>Invalid argument.</para>
  1618. </entry>
  1619. </row><row><entry
  1620. align="char">
  1621. <para>EPERM</para>
  1622. </entry><entry
  1623. align="char">
  1624. <para>File not opened with read permissions.</para>
  1625. </entry>
  1626. </row><row><entry
  1627. align="char">
  1628. <para>EINTERNAL</para>
  1629. </entry><entry
  1630. align="char">
  1631. <para>Internal error in the device driver.</para>
  1632. </entry>
  1633. </row></tbody></tgroup></informaltable>
  1634. </section>
  1635. <section id="FE_SET_VOLTAGE">
  1636. <title>FE_SET_VOLTAGE</title>
  1637. <para>DESCRIPTION
  1638. </para>
  1639. <informaltable><tgroup cols="1"><tbody><row><entry
  1640. align="char">
  1641. <para>This call is used to set the bus voltage. This call requires read/write
  1642. permissions.</para>
  1643. </entry>
  1644. </row></tbody></tgroup></informaltable>
  1645. <para>SYNOPSIS
  1646. </para>
  1647. <informaltable><tgroup cols="1"><tbody><row><entry
  1648. align="char">
  1649. <para>int ioctl(int fd, int request = <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link>,
  1650. fe_sec_voltage_t voltage);</para>
  1651. </entry>
  1652. </row></tbody></tgroup></informaltable>
  1653. <para>PARAMETERS
  1654. </para>
  1655. <informaltable><tgroup cols="2"><tbody><row><entry
  1656. align="char">
  1657. <para>int fd</para>
  1658. </entry><entry
  1659. align="char">
  1660. <para>File descriptor returned by a previous call to open().</para>
  1661. </entry>
  1662. </row><row><entry
  1663. align="char">
  1664. <para>int request</para>
  1665. </entry><entry
  1666. align="char">
  1667. <para>Equals <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> for this command.</para>
  1668. </entry>
  1669. </row><row><entry
  1670. align="char">
  1671. <para>fe_sec_voltage_t
  1672. voltage</para>
  1673. </entry><entry
  1674. align="char">
  1675. <para>The requested bus voltage.</para>
  1676. </entry>
  1677. </row></tbody></tgroup></informaltable>
  1678. <para>ERRORS
  1679. </para>
  1680. <informaltable><tgroup cols="2"><tbody><row><entry
  1681. align="char">
  1682. <para>ENODEV</para>
  1683. </entry><entry
  1684. align="char">
  1685. <para>Device driver not loaded/available.</para>
  1686. </entry>
  1687. </row><row><entry
  1688. align="char">
  1689. <para>EBUSY</para>
  1690. </entry><entry
  1691. align="char">
  1692. <para>Device or resource busy.</para>
  1693. </entry>
  1694. </row><row><entry
  1695. align="char">
  1696. <para>EINVAL</para>
  1697. </entry><entry
  1698. align="char">
  1699. <para>Invalid argument.</para>
  1700. </entry>
  1701. </row><row><entry
  1702. align="char">
  1703. <para>EPERM</para>
  1704. </entry><entry
  1705. align="char">
  1706. <para>File not opened with read permissions.</para>
  1707. </entry>
  1708. </row><row><entry
  1709. align="char">
  1710. <para>EINTERNAL</para>
  1711. </entry><entry
  1712. align="char">
  1713. <para>Internal error in the device driver.</para>
  1714. </entry>
  1715. </row></tbody></tgroup></informaltable>
  1716. </section>
  1717. <section id="FE_ENABLE_HIGH_LNB_VOLTAGE">
  1718. <title>FE_ENABLE_HIGH_LNB_VOLTAGE</title>
  1719. <para>DESCRIPTION
  1720. </para>
  1721. <informaltable><tgroup cols="1"><tbody><row><entry
  1722. align="char">
  1723. <para>If high != 0 enables slightly higher voltages instead of 13/18V (to compensate
  1724. for long cables). This call requires read/write permissions. Not all DVB
  1725. adapters support this ioctl.</para>
  1726. </entry>
  1727. </row></tbody></tgroup></informaltable>
  1728. <para>SYNOPSIS
  1729. </para>
  1730. <informaltable><tgroup cols="1"><tbody><row><entry
  1731. align="char">
  1732. <para>int ioctl(int fd, int request =
  1733. <link linkend="FE_ENABLE_HIGH_LNB_VOLTAGE">FE_ENABLE_HIGH_LNB_VOLTAGE</link>, int high);</para>
  1734. </entry>
  1735. </row></tbody></tgroup></informaltable>
  1736. <para>PARAMETERS
  1737. </para>
  1738. <informaltable><tgroup cols="2"><tbody><row><entry
  1739. align="char">
  1740. <para>int fd</para>
  1741. </entry><entry
  1742. align="char">
  1743. <para>File descriptor returned by a previous call to open().</para>
  1744. </entry>
  1745. </row><row><entry
  1746. align="char">
  1747. <para>int request</para>
  1748. </entry><entry
  1749. align="char">
  1750. <para>Equals <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> for this command.</para>
  1751. </entry>
  1752. </row><row><entry
  1753. align="char">
  1754. <para>int high</para>
  1755. </entry><entry
  1756. align="char">
  1757. <para>The requested bus voltage.</para>
  1758. </entry>
  1759. </row></tbody></tgroup></informaltable>
  1760. <para>ERRORS
  1761. </para>
  1762. <informaltable><tgroup cols="2"><tbody><row><entry
  1763. align="char">
  1764. <para>ENODEV</para>
  1765. </entry><entry
  1766. align="char">
  1767. <para>Device driver not loaded/available.</para>
  1768. </entry>
  1769. </row><row><entry
  1770. align="char">
  1771. <para>EBUSY</para>
  1772. </entry><entry
  1773. align="char">
  1774. <para>Device or resource busy.</para>
  1775. </entry>
  1776. </row><row><entry
  1777. align="char">
  1778. <para>EINVAL</para>
  1779. </entry><entry
  1780. align="char">
  1781. <para>Invalid argument.</para>
  1782. </entry>
  1783. </row><row><entry
  1784. align="char">
  1785. <para>EPERM</para>
  1786. </entry><entry
  1787. align="char">
  1788. <para>File not opened with read permissions.</para>
  1789. </entry>
  1790. </row><row><entry
  1791. align="char">
  1792. <para>EINTERNAL</para>
  1793. </entry><entry
  1794. align="char">
  1795. <para>Internal error in the device driver.</para>
  1796. </entry>
  1797. </row></tbody></tgroup></informaltable>
  1798. </section>
  1799. <section id="FE_SET_FRONTEND_TUNE_MODE">
  1800. <title>FE_SET_FRONTEND_TUNE_MODE</title>
  1801. <para>DESCRIPTION</para>
  1802. <informaltable><tgroup cols="1"><tbody><row>
  1803. <entry align="char">
  1804. <para>Allow setting tuner mode flags to the frontend.</para>
  1805. </entry>
  1806. </row></tbody></tgroup></informaltable>
  1807. <para>SYNOPSIS</para>
  1808. <informaltable><tgroup cols="1"><tbody><row>
  1809. <entry align="char">
  1810. <para>int ioctl(int fd, int request =
  1811. <link linkend="FE_SET_FRONTEND_TUNE_MODE">FE_SET_FRONTEND_TUNE_MODE</link>, unsigned int flags);</para>
  1812. </entry>
  1813. </row></tbody></tgroup></informaltable>
  1814. <para>PARAMETERS</para>
  1815. <informaltable><tgroup cols="2"><tbody><row>
  1816. <entry align="char">
  1817. <para>unsigned int flags</para>
  1818. </entry>
  1819. <entry align="char">
  1820. <para>
  1821. FE_TUNE_MODE_ONESHOT When set, this flag will disable any zigzagging or other "normal" tuning behaviour. Additionally, there will be no automatic monitoring of the lock status, and hence no frontend events will be generated. If a frontend device is closed, this flag will be automatically turned off when the device is reopened read-write.
  1822. </para>
  1823. </entry>
  1824. </row></tbody></tgroup></informaltable>
  1825. <para>ERRORS</para>
  1826. <informaltable><tgroup cols="2"><tbody><row>
  1827. <entry align="char"><para>EINVAL</para></entry>
  1828. <entry align="char"><para>Invalid argument.</para></entry>
  1829. </row></tbody></tgroup></informaltable>
  1830. </section>
  1831. <section id="FE_DISHNETWORK_SEND_LEGACY_CMD">
  1832. <title>FE_DISHNETWORK_SEND_LEGACY_CMD</title>
  1833. <para>DESCRIPTION</para>
  1834. <informaltable><tgroup cols="1"><tbody><row>
  1835. <entry align="char">
  1836. <para>WARNING: This is a very obscure legacy command, used only at stv0299 driver. Should not be used on newer drivers.</para>
  1837. <para>It provides a non-standard method for selecting Diseqc voltage on the frontend, for Dish Network legacy switches.</para>
  1838. <para>As support for this ioctl were added in 2004, this means that such dishes were already legacy in 2004.</para>
  1839. </entry>
  1840. </row></tbody></tgroup></informaltable>
  1841. <para>SYNOPSIS</para>
  1842. <informaltable><tgroup cols="1"><tbody><row>
  1843. <entry align="char">
  1844. <para>int ioctl(int fd, int request =
  1845. <link linkend="FE_DISHNETWORK_SEND_LEGACY_CMD">FE_DISHNETWORK_SEND_LEGACY_CMD</link>, unsigned long cmd);</para>
  1846. </entry>
  1847. </row></tbody></tgroup></informaltable>
  1848. <para>PARAMETERS</para>
  1849. <informaltable><tgroup cols="2"><tbody><row>
  1850. <entry align="char">
  1851. <para>unsigned long cmd</para>
  1852. </entry>
  1853. <entry align="char">
  1854. <para>
  1855. sends the specified raw cmd to the dish via DISEqC.
  1856. </para>
  1857. </entry>
  1858. </row></tbody></tgroup></informaltable>
  1859. <para>ERRORS</para>
  1860. <informaltable><tgroup cols="1"><tbody><row>
  1861. <entry align="char">
  1862. <para>There are no errors in use for this call</para>
  1863. </entry>
  1864. </row></tbody></tgroup></informaltable>
  1865. </section>
  1866. </section>
  1867. &sub-dvbproperty;