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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _CEC_DQEVENT:
   4
   5 *****************
   6 ioctl CEC_DQEVENT
   7 *****************
   8
   9 Name
  10 ====
  11
  12 CEC_DQEVENT - Dequeue a CEC event
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, CEC_DQEVENT, struct cec_event *argp )
  19     :name: CEC_DQEVENT
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <cec-func-open>`.
  26
  27 ``argp``
  28
  29
  30 Description
  31 ===========
  32
  33 .. note::
  34
  35    This documents the proposed CEC API. This API is not yet finalized
  36    and is currently only available as a staging kernel module.
  37
  38 CEC devices can send asynchronous events. These can be retrieved by
  39 calling :c:func:`CEC_DQEVENT`. If the file descriptor is in
  40 non-blocking mode and no event is pending, then it will return -1 and
  41 set errno to the ``EAGAIN`` error code.
  42
  43 The internal event queues are per-filehandle and per-event type. If
  44 there is no more room in a queue then the last event is overwritten with
  45 the new one. This means that intermediate results can be thrown away but
  46 that the latest event is always available. This also means that is it
  47 possible to read two successive events that have the same value (e.g.
  48 two :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>` events with
  49 the same state). In that case the intermediate state changes were lost but
  50 it is guaranteed that the state did change in between the two events.
  51
  52 .. tabularcolumns:: |p{1.2cm}|p{2.9cm}|p{13.4cm}|
  53
  54 .. c:type:: cec_event_state_change
  55
  56 .. flat-table:: struct cec_event_state_change
  57     :header-rows:  0
  58     :stub-columns: 0
  59     :widths:       1 1 8
  60
  61     * - __u16
  62       - ``phys_addr``
  63       - The current physical address. This is ``CEC_PHYS_ADDR_INVALID`` if no
  64           valid physical address is set.
  65     * - __u16
  66       - ``log_addr_mask``
  67       - The current set of claimed logical addresses. This is 0 if no logical
  68         addresses are claimed or if ``phys_addr`` is ``CEC_PHYS_ADDR_INVALID``.
  69         If bit 15 is set (``1 << CEC_LOG_ADDR_UNREGISTERED``) then this device
  70         has the unregistered logical address. In that case all other bits are 0.
  71
  72
  73 .. c:type:: cec_event_lost_msgs
  74
  75 .. tabularcolumns:: |p{1.0cm}|p{2.0cm}|p{14.5cm}|
  76
  77 .. flat-table:: struct cec_event_lost_msgs
  78     :header-rows:  0
  79     :stub-columns: 0
  80     :widths:       1 1 16
  81
  82     * - __u32
  83       - ``lost_msgs``
  84       - Set to the number of lost messages since the filehandle was opened
  85         or since the last time this event was dequeued for this
  86         filehandle. The messages lost are the oldest messages. So when a
  87         new message arrives and there is no more room, then the oldest
  88         message is discarded to make room for the new one. The internal
  89         size of the message queue guarantees that all messages received in
  90         the last two seconds will be stored. Since messages should be
  91         replied to within a second according to the CEC specification,
  92         this is more than enough.
  93
  94
  95 .. tabularcolumns:: |p{1.0cm}|p{4.2cm}|p{2.5cm}|p{8.8cm}|
  96
  97 .. c:type:: cec_event
  98
  99 .. flat-table:: struct cec_event
 100     :header-rows:  0
 101     :stub-columns: 0
 102     :widths:       1 1 1 8
 103
 104     * - __u64
 105       - ``ts``
 106       - :cspan:`1` Timestamp of the event in ns.
 107
 108         The timestamp has been taken from the ``CLOCK_MONOTONIC`` clock. To access
 109         the same clock from userspace use :c:func:`clock_gettime`.
 110     * - __u32
 111       - ``event``
 112       - :cspan:`1` The CEC event type, see :ref:`cec-events`.
 113     * - __u32
 114       - ``flags``
 115       - :cspan:`1` Event flags, see :ref:`cec-event-flags`.
 116     * - union
 117       - (anonymous)
 118       -
 119       -
 120     * -
 121       - struct cec_event_state_change
 122       - ``state_change``
 123       - The new adapter state as sent by the :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>`
 124         event.
 125     * -
 126       - struct cec_event_lost_msgs
 127       - ``lost_msgs``
 128       - The number of lost messages as sent by the :ref:`CEC_EVENT_LOST_MSGS <CEC-EVENT-LOST-MSGS>`
 129         event.
 130
 131
 132 .. tabularcolumns:: |p{5.6cm}|p{0.9cm}|p{11.0cm}|
 133
 134 .. _cec-events:
 135
 136 .. flat-table:: CEC Events Types
 137     :header-rows:  0
 138     :stub-columns: 0
 139     :widths:       3 1 16
 140
 141     * .. _`CEC-EVENT-STATE-CHANGE`:
 142
 143       - ``CEC_EVENT_STATE_CHANGE``
 144       - 1
 145       - Generated when the CEC Adapter's state changes. When open() is
 146         called an initial event will be generated for that filehandle with
 147         the CEC Adapter's state at that time.
 148     * .. _`CEC-EVENT-LOST-MSGS`:
 149
 150       - ``CEC_EVENT_LOST_MSGS``
 151       - 2
 152       - Generated if one or more CEC messages were lost because the
 153         application didn't dequeue CEC messages fast enough.
 154
 155
 156 .. tabularcolumns:: |p{6.0cm}|p{0.6cm}|p{10.9cm}|
 157
 158 .. _cec-event-flags:
 159
 160 .. flat-table:: CEC Event Flags
 161     :header-rows:  0
 162     :stub-columns: 0
 163     :widths:       3 1 8
 164
 165     * .. _`CEC-EVENT-FL-INITIAL-VALUE`:
 166
 167       - ``CEC_EVENT_FL_INITIAL_VALUE``
 168       - 1
 169       - Set for the initial events that are generated when the device is
 170         opened. See the table above for which events do this. This allows
 171         applications to learn the initial state of the CEC adapter at
 172         open() time.
 173
 174
 175
 176 Return Value
 177 ============
 178
 179 On success 0 is returned, on error -1 and the ``errno`` variable is set
 180 appropriately. The generic error codes are described at the
 181 :ref:`Generic Error Codes <gen-errors>` chapter.