Documentation/media/uapi/dvb/ca-set-descr.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _CA_SET_DESCR:
   4
   5 ============
   6 CA_SET_DESCR
   7 ============
   8
   9 Name
  10 ----
  11
  12 CA_SET_DESCR
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. c:function:: int ioctl(fd, CA_SET_DESCR, struct ca_descr *desc)
  19     :name: CA_SET_DESCR
  20
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26   File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
  27
  28 ``msg``
  29   Pointer to struct :c:type:`ca_descr`.
  30
  31 .. c:type:: ca_descr
  32
  33 .. code-block:: c
  34
  35     struct ca_descr {
  36         unsigned int index;
  37         unsigned int parity;
  38         unsigned char cw[8];
  39     };
  40
  41
  42 Description
  43 -----------
  44
  45 .. note:: This ioctl is undocumented. Documentation is welcome.
  46
  47
  48 Return Value
  49 ------------
  50
  51 On success 0 is returned, on error -1 and the ``errno`` variable is set
  52 appropriately. The generic error codes are described at the
  53 :ref:`Generic Error Codes <gen-errors>` chapter.