media/cec/cec-ioc-dqevent.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
13 CEC_DQEVENT - Dequeue a CEC event
35 non-blocking mode and no event is pending, then it will return -1 and
38 The internal event queues are per-filehandle and per-event type. If
39 there is no more room in a queue then the last event is overwritten with
43 two :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>` events with
51 .. flat-table:: struct cec_event_state_change
52     :header-rows:  0
53     :stub-columns: 0
54     :widths:       1 1 8
56     * - __u16
57       - ``phys_addr``
58       - The current physical address. This is ``CEC_PHYS_ADDR_INVALID`` if no
60     * - __u16
61       - ``log_addr_mask``
62       - The current set of claimed logical addresses. This is 0 if no logical
64 	If bit 15 is set (``1 << CEC_LOG_ADDR_UNREGISTERED``) then this device
66     * - __u16
67       - ``have_conn_info``
68       - If non-zero, then HDMI connector information is available.
79 .. flat-table:: struct cec_event_lost_msgs
80     :header-rows:  0
81     :stub-columns: 0
82     :widths:       1 1 16
84     * - __u32
85       - ``lost_msgs``
86       - Set to the number of lost messages since the filehandle was opened
89 	new message arrives and there is no more room, then the oldest
100 .. flat-table:: struct cec_event
101     :header-rows:  0
102     :stub-columns: 0
103     :widths:       1 1 8
105     * - __u64
106       - ``ts``
107       - Timestamp of the event in ns.
112     * - __u32
113       - ``event``
114       - The CEC event type, see :ref:`cec-events`.
115     * - __u32
116       - ``flags``
117       - Event flags, see :ref:`cec-event-flags`.
118     * - union {
119       - (anonymous)
120     * - struct cec_event_state_change
121       - ``state_change``
122       - The new adapter state as sent by the :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>`
124     * - struct cec_event_lost_msgs
125       - ``lost_msgs``
126       - The number of lost messages as sent by the :ref:`CEC_EVENT_LOST_MSGS <CEC-EVENT-LOST-MSGS>`
128     * - }
129       -
133 .. _cec-events:
135 .. flat-table:: CEC Events Types
136     :header-rows:  0
137     :stub-columns: 0
138     :widths:       3 1 16
140     * .. _`CEC-EVENT-STATE-CHANGE`:
142       - ``CEC_EVENT_STATE_CHANGE``
143       - 1
144       - Generated when the CEC Adapter's state changes. When open() is
147     * .. _`CEC-EVENT-LOST-MSGS`:
149       - ``CEC_EVENT_LOST_MSGS``
150       - 2
151       - Generated if one or more CEC messages were lost because the
153     * .. _`CEC-EVENT-PIN-CEC-LOW`:
155       - ``CEC_EVENT_PIN_CEC_LOW``
156       - 3
157       - Generated if the CEC pin goes from a high voltage to a low voltage.
160     * .. _`CEC-EVENT-PIN-CEC-HIGH`:
162       - ``CEC_EVENT_PIN_CEC_HIGH``
163       - 4
164       - Generated if the CEC pin goes from a low voltage to a high voltage.
167     * .. _`CEC-EVENT-PIN-HPD-LOW`:
169       - ``CEC_EVENT_PIN_HPD_LOW``
170       - 5
171       - Generated if the HPD pin goes from a high voltage to a low voltage.
176     * .. _`CEC-EVENT-PIN-HPD-HIGH`:
178       - ``CEC_EVENT_PIN_HPD_HIGH``
179       - 6
180       - Generated if the HPD pin goes from a low voltage to a high voltage.
185     * .. _`CEC-EVENT-PIN-5V-LOW`:
187       - ``CEC_EVENT_PIN_5V_LOW``
188       - 6
189       - Generated if the 5V pin goes from a high voltage to a low voltage.
191 	capability set. When open() is called, the 5V pin can be read and
192 	if the 5V is low, then an initial event will be generated for that
194     * .. _`CEC-EVENT-PIN-5V-HIGH`:
196       - ``CEC_EVENT_PIN_5V_HIGH``
197       - 7
198       - Generated if the 5V pin goes from a low voltage to a high voltage.
200 	capability set. When open() is called, the 5V pin can be read and
201 	if the 5V is high, then an initial event will be generated for that
206 .. _cec-event-flags:
208 .. flat-table:: CEC Event Flags
209     :header-rows:  0
210     :stub-columns: 0
211     :widths:       3 1 8
213     * .. _`CEC-EVENT-FL-INITIAL-STATE`:
215       - ``CEC_EVENT_FL_INITIAL_STATE``
216       - 1
217       - Set for the initial events that are generated when the device is
221     * .. _`CEC-EVENT-FL-DROPPED-EVENTS`:
223       - ``CEC_EVENT_FL_DROPPED_EVENTS``
224       - 2
225       - Set if one or more events of the given event type have been dropped.
232 On success 0 is returned, on error -1 and the ``errno`` variable is set
234 :ref:`Generic Error Codes <gen-errors>` chapter.
240     This is returned when the filehandle is in non-blocking mode and there
241     are no pending events.
244     An interrupt (e.g. Ctrl-C) arrived while in blocking mode waiting for