Commit 98f29073 authored by Dariusz Marcinkiewicz's avatar Dariusz Marcinkiewicz Committed by Mauro Carvalho Chehab
Browse files

media: cec: document CEC_ADAP_G_CONNECTOR_INFO and capability 



Document the new CEC_ADAP_G_CONNECTOR_INFO ioctl and the new
CEC_CAP_CONNECTOR_INFO capability.

Co-developed-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>

Signed-off-by: default avatarDariusz Marcinkiewicz <darekm@google.com>
Signed-off-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
[hverkuil-cisco@xs4all.nl: added CEC_CAP_CONNECTOR_INFO]
[hverkuil-cisco@xs4all.nl: added DQEVENT have_conn_info]
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
parent 9098c1c2

Documentation/media/uapi/cec/cec-funcs.rst

+1 −0
Original line number Diff line number Diff line
@@ -24,6 +24,7 @@ Function Reference 
    cec-ioc-adap-g-caps

    cec-ioc-adap-g-log-addrs

    cec-ioc-adap-g-phys-addr

    cec-ioc-adap-g-conn-info

    cec-ioc-dqevent

    cec-ioc-g-mode

    cec-ioc-receive

Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst

+5 −1
Original line number Diff line number Diff line
@@ -135,8 +135,12 @@ returns the information to the application. The ioctl never fails. 
      - The CEC hardware can monitor CEC pin changes from low to high voltage

        and vice versa. When in pin monitoring mode the application will

	receive ``CEC_EVENT_PIN_CEC_LOW`` and ``CEC_EVENT_PIN_CEC_HIGH`` events.

    * .. _`CEC-CAP-CONNECTOR-INFO`:





      - ``CEC_CAP_CONNECTOR_INFO``

      - 0x00000100

      - If this capability is set, then :ref:`CEC_ADAP_G_CONNECTOR_INFO` can

        be used.



Return Value

============

Documentation/media/uapi/cec/cec-ioc-adap-g-conn-info.rst

0 → 100644
+105 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0

..

.. Copyright 2019 Google LLC

..

.. _CEC_ADAP_G_CONNECTOR_INFO:



*******************************

ioctl CEC_ADAP_G_CONNECTOR_INFO

*******************************



Name

====



CEC_ADAP_G_CONNECTOR_INFO - Query HDMI connector information



Synopsis

========



.. c:function:: int ioctl( int fd, CEC_ADAP_G_CONNECTOR_INFO, struct cec_connector_info *argp )

    :name: CEC_ADAP_G_CONNECTOR_INFO



Arguments

=========



``fd``

    File descriptor returned by :c:func:`open() <cec-open>`.



``argp``





Description

===========



Using this ioctl an application can learn which HDMI connector this CEC

device corresponds to. While calling this ioctl the application should

provide a pointer to a cec_connector_info struct which will be populated

by the kernel with the info provided by the adapter's driver. This ioctl

is only available if the ``CEC_CAP_CONNECTOR_INFO`` capability is set.



.. tabularcolumns:: |p{1.0cm}|p{4.4cm}|p{2.5cm}|p{9.6cm}|



.. c:type:: cec_connector_info



.. flat-table:: struct cec_connector_info

    :header-rows:  0

    :stub-columns: 0

    :widths:       1 1 1 8



    * - __u32

      - ``type``

      - The type of connector this adapter is associated with.

    * - union

      - ``(anonymous)``

      -

    * -

      - ``struct cec_drm_connector_info``

      - drm

      - :ref:`cec-drm-connector-info`





.. tabularcolumns:: |p{4.4cm}|p{2.5cm}|p{10.6cm}|



.. _connector-type:



.. flat-table:: Connector types

    :header-rows:  0

    :stub-columns: 0

    :widths:       3 1 8



    * .. _`CEC-CONNECTOR-TYPE-NO-CONNECTOR`:



      - ``CEC_CONNECTOR_TYPE_NO_CONNECTOR``

      - 0

      - No connector is associated with the adapter/the information is not

        provided by the driver.

    * .. _`CEC-CONNECTOR-TYPE-DRM`:



      - ``CEC_CONNECTOR_TYPE_DRM``

      - 1

      - Indicates that a DRM connector is associated with this adapter.

        Information about the connector can be found in

	:ref:`cec-drm-connector-info`.



.. tabularcolumns:: |p{4.4cm}|p{2.5cm}|p{10.6cm}|



.. c:type:: cec_drm_connector_info



.. _cec-drm-connector-info:



.. flat-table:: struct cec_drm_connector_info

    :header-rows:  0

    :stub-columns: 0

    :widths:       3 1 8



    * .. _`CEC-DRM-CONNECTOR-TYPE-CARD-NO`:



      - __u32

      - ``card_no``

      - DRM card number: the number from a card's path, e.g. 0 in case of

        /dev/card0.

    * .. _`CEC-DRM-CONNECTOR-TYPE-CONNECTOR_ID`:



      - __u32

      - ``connector_id``

      - DRM connector ID.

Documentation/media/uapi/cec/cec-ioc-dqevent.rst

+8 −0
Original line number Diff line number Diff line
@@ -70,6 +70,14 @@ it is guaranteed that the state did change in between the two events. 
        addresses are claimed or if ``phys_addr`` is ``CEC_PHYS_ADDR_INVALID``.

	If bit 15 is set (``1 << CEC_LOG_ADDR_UNREGISTERED``) then this device

	has the unregistered logical address. In that case all other bits are 0.

    * - __u16

      - ``have_conn_info``

      - If non-zero, then HDMI connector information is available.

        This field is only valid if ``CEC_CAP_CONNECTOR_INFO`` is set. If that

        capability is set and ``have_conn_info`` is zero, then that indicates

        that the HDMI connector device is not instantiated, either because

        the HDMI driver is still configuring the device or because the HDMI

        device was unbound.





.. c:type:: cec_event_lost_msgs