lkml.org 
[lkml]   [2017]   [Sep]   [1]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v2 22/27] media: ca-get-cap.rst: document this ioctl
    Date
    Instead of a generic boilerplate, fill it with relevant
    information about this ioctl.

    Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
    ---
    Documentation/media/uapi/dvb/ca-get-cap.rst | 36 ++++-------------------------
    1 file changed, 5 insertions(+), 31 deletions(-)

    diff --git a/Documentation/media/uapi/dvb/ca-get-cap.rst b/Documentation/media/uapi/dvb/ca-get-cap.rst
    index fbf7e359cb8a..02d64acfb087 100644
    --- a/Documentation/media/uapi/dvb/ca-get-cap.rst
    +++ b/Documentation/media/uapi/dvb/ca-get-cap.rst
    @@ -28,43 +28,17 @@ Arguments
    ``caps``
    Pointer to struct :c:type:`ca_caps`.

    -.. c:type:: struct ca_caps
    -
    -.. flat-table:: struct ca_caps
    - :header-rows: 1
    - :stub-columns: 0
    -
    - -
    - - type
    - - name
    - - description
    - -
    - - unsigned int
    - - slot_num
    - - total number of CA card and module slots
    - -
    - - unsigned int
    - - slot_type
    - - bitmask with all supported slot types
    - -
    - - unsigned int
    - - descr_num
    - - total number of descrambler slots (keys)
    - -
    - - unsigned int
    - - descr_type
    - - bit mask with all supported descr types
    -
    -
    Description
    -----------

    -.. note:: This ioctl is undocumented. Documentation is welcome.
    -
    +Queries the Kernel for information about the available CA and descrambler
    +slots, and their types.

    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_caps` 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.
    --
    2.13.5
    \
     
     \ /
      Last update: 2017-09-01 15:28    [W:2.783 / U:0.100 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site