Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-5.4 / 1a86fc754fc2bae3be5fe00c1b553b91ba20e089 / . / Documentation / media / uapi / dvb / fe-diseqc-send-burst.rst
blob: e962f6ec5aaf076115b34590248ec4be29b3620f [file] [log] [blame]
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]1.. -*- coding: utf-8; mode: rst -*-
2
3.. _FE_DISEQC_SEND_BURST:
4
5**************************
6ioctl FE_DISEQC_SEND_BURST
7**************************
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]9Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]10====
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]11
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]12FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]13
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]14
15Synopsis
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]16========
17
Mauro Carvalho Chehabaffd2502017-06-21 06:51:51 -0300[diff] [blame]18.. c:function:: int ioctl( int fd, FE_DISEQC_SEND_BURST, enum fe_sec_mini_cmd tone )
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -0300[diff] [blame]19 :name: FE_DISEQC_SEND_BURST
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]20
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]21
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]22Arguments
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]23=========
24
25``fd``
26 File descriptor returned by :ref:`open() <frontend_f_open>`.
27
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]28``tone``
Mauro Carvalho Chehabaffd2502017-06-21 06:51:51 -0300[diff] [blame]29 an integer enumered value described at :c:type:`fe_sec_mini_cmd`
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]30
31
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]32Description
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]33===========
34
35This ioctl is used to set the generation of a 22kHz tone burst for mini
36DiSEqC satellite selection for 2x1 switches. This call requires
37read/write permissions.
38
39It provides support for what's specified at
40`Digital Satellite Equipment Control (DiSEqC) - Simple "ToneBurst" Detection Circuit specification. <http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf>`__
41
Mauro Carvalho Chehab836cf1d2016-08-30 10:21:03 -0300[diff] [blame]42.. c:type:: fe_sec_mini_cmd
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]43
44.. flat-table:: enum fe_sec_mini_cmd
45 :header-rows: 1
46 :stub-columns: 0
47
48
49 - .. row 1
50
51 - ID
52
53 - Description
54
55 - .. row 2
56
Mauro Carvalho Chehab6aeb3f62016-07-07 15:53:44 -0300[diff] [blame]57 - .. _SEC-MINI-A:
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]58
Mauro Carvalho Chehab0579e6e2016-07-04 16:25:48 -0300[diff] [blame]59 ``SEC_MINI_A``
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]60
61 - Sends a mini-DiSEqC 22kHz '0' Tone Burst to select satellite-A
62
63 - .. row 3
64
Mauro Carvalho Chehab6aeb3f62016-07-07 15:53:44 -0300[diff] [blame]65 - .. _SEC-MINI-B:
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]66
Mauro Carvalho Chehab0579e6e2016-07-04 16:25:48 -0300[diff] [blame]67 ``SEC_MINI_B``
Markus Heiser5377d912016-06-30 15:18:56 +0200[diff] [blame]68
69 - Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B
Mauro Carvalho Chehabfc833982016-07-05 11:36:55 -0300[diff] [blame]70
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]71
72Return Value
Mauro Carvalho Chehabfc833982016-07-05 11:36:55 -0300[diff] [blame]73============
74
75On success 0 is returned, on error -1 and the ``errno`` variable is set
76appropriately. The generic error codes are described at the
77:ref:`Generic Error Codes <gen-errors>` chapter.