diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-01 15:39:43 +0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-05 13:12:35 +0300 |
| commit | e0f891d8462d51bf42da16095fc9de57f7648043 (patch) | |
| tree | 9c9b53a25e95a5d7b5e44e2a430f43ad177c74c8 /Documentation | |
| parent | 5d153fb888bd9bae0802d0a8db8e1321caf4296e (diff) | |
| download | linux-e0f891d8462d51bf42da16095fc9de57f7648043.tar.xz | |
media: ca-get-descr-info.rst: document this ioctl
Instead of a generic boilerplate, fill it with relevant
information about this ioctl.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/media/uapi/dvb/ca-get-descr-info.rst | 29 |
1 files changed, 4 insertions, 25 deletions
diff --git a/Documentation/media/uapi/dvb/ca-get-descr-info.rst b/Documentation/media/uapi/dvb/ca-get-descr-info.rst index 7bf327a3d0e3..e564fbb8d524 100644 --- a/Documentation/media/uapi/dvb/ca-get-descr-info.rst +++ b/Documentation/media/uapi/dvb/ca-get-descr-info.rst @@ -27,37 +27,16 @@ Arguments ``desc`` Pointer to struct :c:type:`ca_descr_info`. -.. c:type:: struct ca_descr_info - -.. flat-table:: struct ca_descr_info - :header-rows: 1 - :stub-columns: 0 - - - - - type - - name - - description - - - - - unsigned int - - num - - number of available descramblers (keys) - - - - unsigned int - - type - - type of supported scrambling system. Valid values are: - ``CA_ECD``, ``CA_NDS`` and ``CA_DSS``. - - Description ----------- -.. note:: This ioctl is undocumented. Documentation is welcome. - +Returns information about all descrambler slots. Return Value ------------ -On success 0 is returned, on error -1 and the ``errno`` variable is set +On success 0 is returned, and :c:type:`ca_descr_info` is filled. + +On error -1 is returned, and the ``errno`` variable is set appropriately. The generic error codes are described at the :ref:`Generic Error Codes <gen-errors>` chapter. |