Documentation/media/uapi/rc/lirc-set-send-carrier.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _lirc_set_send_carrier:
  11
  12 ***************************
  13 ioctl LIRC_SET_SEND_CARRIER
  14 ***************************
  15
  16 Name
  17 ====
  18
  19 LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.
  20
  21
  22 Synopsis
  23 ========
  24
  25 .. c:function:: int ioctl( int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency )
  26     :name: LIRC_SET_SEND_CARRIER
  27
  28 Arguments
  29 =========
  30
  31 ``fd``
  32     File descriptor returned by open().
  33
  34 ``frequency``
  35     Frequency of the carrier to be modulated, in Hz.
  36
  37 Description
  38 ===========
  39
  40 Set send carrier used to modulate IR PWM pulses and spaces.
  41
  42
  43 Return Value
  44 ============
  45
  46 On success 0 is returned, on error -1 and the ``errno`` variable is set
  47 appropriately. The generic error codes are described at the
  48 :ref:`Generic Error Codes <gen-errors>` chapter.