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 .. _cec-event-state-change_s:
  55
  56 .. flat-table:: struct cec_event_state_change
  57     :header-rows:  0
  58     :stub-columns: 0
  59     :widths:       1 1 8
  60
  61
  62     -  .. row 1
  63
  64        -  __u16
  65
  66        -  ``phys_addr``
  67
  68        -  The current physical address.
  69
  70     -  .. row 2
  71
  72        -  __u16
  73
  74        -  ``log_addr_mask``
  75
  76        -  The current set of claimed logical addresses.
  77
  78
  79 .. tabularcolumns:: |p{1.0cm}|p{2.0cm}|p{14.5cm}|
  80
  81 .. _cec-event-lost-msgs_s:
  82
  83 .. flat-table:: struct cec_event_lost_msgs
  84     :header-rows:  0
  85     :stub-columns: 0
  86     :widths:       1 1 16
  87
  88
  89     -  .. row 1
  90
  91        -  __u32
  92
  93        -  ``lost_msgs``
  94
  95        -  Set to the number of lost messages since the filehandle was opened
  96           or since the last time this event was dequeued for this
  97           filehandle. The messages lost are the oldest messages. So when a
  98           new message arrives and there is no more room, then the oldest
  99           message is discarded to make room for the new one. The internal
 100           size of the message queue guarantees that all messages received in
 101           the last two seconds will be stored. Since messages should be
 102           replied to within a second according to the CEC specification,
 103           this is more than enough.
 104
 105
 106 .. tabularcolumns:: |p{1.0cm}|p{4.2cm}|p{2.5cm}|p{8.8cm}|
 107
 108 .. _cec-event:
 109
 110 .. flat-table:: struct cec_event
 111     :header-rows:  0
 112     :stub-columns: 0
 113     :widths:       1 1 1 8
 114
 115
 116     -  .. row 1
 117
 118        -  __u64
 119
 120        -  ``ts``
 121
 122        -  :cspan:`1` Timestamp of the event in ns.
 123
 124           The timestamp has been taken from the ``CLOCK_MONOTONIC`` clock. To access
 125           the same clock from userspace use :c:func:`clock_gettime(2)`.
 126
 127     -  .. row 2
 128
 129        -  __u32
 130
 131        -  ``event``
 132
 133        -  :cspan:`1` The CEC event type, see :ref:`cec-events`.
 134
 135     -  .. row 3
 136
 137        -  __u32
 138
 139        -  ``flags``
 140
 141        -  :cspan:`1` Event flags, see :ref:`cec-event-flags`.
 142
 143     -  .. row 4
 144
 145        -  union
 146
 147        -  (anonymous)
 148
 149        -
 150        -
 151
 152     -  .. row 5
 153
 154        -
 155        -  struct cec_event_state_change
 156
 157        -  ``state_change``
 158
 159        -  The new adapter state as sent by the :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>`
 160           event.
 161
 162     -  .. row 6
 163
 164        -
 165        -  struct cec_event_lost_msgs
 166
 167        -  ``lost_msgs``
 168
 169        -  The number of lost messages as sent by the :ref:`CEC_EVENT_LOST_MSGS <CEC-EVENT-LOST-MSGS>`
 170           event.
 171
 172
 173 .. tabularcolumns:: |p{5.6cm}|p{0.9cm}|p{11.0cm}|
 174
 175 .. _cec-events:
 176
 177 .. flat-table:: CEC Events Types
 178     :header-rows:  0
 179     :stub-columns: 0
 180     :widths:       3 1 16
 181
 182
 183     -  .. _`CEC-EVENT-STATE-CHANGE`:
 184
 185        -  ``CEC_EVENT_STATE_CHANGE``
 186
 187        -  1
 188
 189        -  Generated when the CEC Adapter's state changes. When open() is
 190           called an initial event will be generated for that filehandle with
 191           the CEC Adapter's state at that time.
 192
 193     -  .. _`CEC-EVENT-LOST-MSGS`:
 194
 195        -  ``CEC_EVENT_LOST_MSGS``
 196
 197        -  2
 198
 199        -  Generated if one or more CEC messages were lost because the
 200           application didn't dequeue CEC messages fast enough.
 201
 202
 203 .. tabularcolumns:: |p{6.0cm}|p{0.6cm}|p{10.9cm}|
 204
 205 .. _cec-event-flags:
 206
 207 .. flat-table:: CEC Event Flags
 208     :header-rows:  0
 209     :stub-columns: 0
 210     :widths:       3 1 8
 211
 212
 213     -  .. _`CEC-EVENT-FL-INITIAL-VALUE`:
 214
 215        -  ``CEC_EVENT_FL_INITIAL_VALUE``
 216
 217        -  1
 218
 219        -  Set for the initial events that are generated when the device is
 220           opened. See the table above for which events do this. This allows
 221           applications to learn the initial state of the CEC adapter at
 222           open() time.
 223
 224
 225
 226 Return Value
 227 ============
 228
 229 On success 0 is returned, on error -1 and the ``errno`` variable is set
 230 appropriately. The generic error codes are described at the
 231 :ref:`Generic Error Codes <gen-errors>` chapter.