summaryrefslogtreecommitdiffstats
path: root/Documentation/userspace-api/media/dvb/ca-set-descr.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/userspace-api/media/dvb/ca-set-descr.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/Documentation/userspace-api/media/dvb/ca-set-descr.rst b/Documentation/userspace-api/media/dvb/ca-set-descr.rst
new file mode 100644
index 0000000000..a740af34c8
--- /dev/null
+++ b/Documentation/userspace-api/media/dvb/ca-set-descr.rst
@@ -0,0 +1,46 @@
+.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+.. c:namespace:: DTV.ca
+
+.. _CA_SET_DESCR:
+
+============
+CA_SET_DESCR
+============
+
+Name
+----
+
+CA_SET_DESCR
+
+Synopsis
+--------
+
+.. c:macro:: CA_SET_DESCR
+
+``int ioctl(fd, CA_SET_DESCR, struct ca_descr *desc)``
+
+Arguments
+---------
+
+``fd``
+ File descriptor returned by a previous call to :c:func:`open()`.
+
+``msg``
+ Pointer to struct :c:type:`ca_descr`.
+
+Description
+-----------
+
+CA_SET_DESCR is used for feeding descrambler CA slots with descrambling
+keys (referred as control words).
+
+Return Value
+------------
+
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.