sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget;/translations/zh_CN/userspace-api/media/cec/cec-ioc-receivemodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/zh_TW/userspace-api/media/cec/cec-ioc-receivemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/it_IT/userspace-api/media/cec/cec-ioc-receivemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/ja_JP/userspace-api/media/cec/cec-ioc-receivemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/ko_KR/userspace-api/media/cec/cec-ioc-receivemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/pt_BR/userspace-api/media/cec/cec-ioc-receivemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/sp_SP/userspace-api/media/cec/cec-ioc-receivemodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h8SPDX-License-Identifier: GFDL-1.1-no-invariants-or-laterh]h8SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhU/var/lib/git/docbuild/linux/Documentation/userspace-api/media/cec/cec-ioc-receive.rsthKubhtarget)}(h.. _CEC_TRANSMIT:h]h}(h]h ]h"]h$]h&]refid cec-transmituh1hhKhhhhhhubh)}(h.. _CEC_RECEIVE:h]h}(h]h ]h"]h$]h&]hԌ cec-receiveuh1hhKhhhhhhnjexpect_referenced_by_name} cec_transmithsexpect_referenced_by_id}hhsubhsection)}(hhh](htitle)}(h#ioctls CEC_RECEIVE and CEC_TRANSMITh]h#ioctls CEC_RECEIVE and CEC_TRANSMIT}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hNameh]hName}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhK ubh paragraph)}(h=CEC_RECEIVE, CEC_TRANSMIT - Receive or transmit a CEC messageh]h=CEC_RECEIVE, CEC_TRANSMIT - Receive or transmit a CEC message}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhhhhubeh}(h]nameah ]h"]nameah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hSynopsish]hSynopsis}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$hhhhhKubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](singleCEC.CEC_RECEIVE (C macro)c.CEC.CEC_RECEIVEhNtauh1j5hj$hhhNhNubhdesc)}(hhh](hdesc_signature)}(h CEC_RECEIVEh]hdesc_signature_line)}(h CEC_RECEIVEh]h desc_name)}(h CEC_RECEIVEh]h desc_sig_name)}(hjOh]h CEC_RECEIVE}(hj_hhhNhNubah}(h]h ]nah"]h$]h&]uh1j]hjYubah}(h]h ](sig-namedescnameeh"]h$]h&]hhuh1jWhjShhhhhKubah}(h]h ]h"]h$]h&]hhƌ add_permalinkuh1jQsphinx_line_type declaratorhjMhhhhhKubah}(h]jDah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1jKhhhKhjHhhubh desc_content)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjHhhhhhKubeh}(h]h ](cmacroeh"]h$]h&]domainjobjtypejdesctypejnoindex noindexentrynocontentsentryuh1jFhhhj$hNhNubj )}(h8``int ioctl(int fd, CEC_RECEIVE, struct cec_msg *argp)``h]hliteral)}(hjh]h4int ioctl(int fd, CEC_RECEIVE, struct cec_msg *argp)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKhj$hhubj6)}(hhh]h}(h]h ]h"]h$]h&]entries](jBCEC.CEC_TRANSMIT (C macro)c.CEC.CEC_TRANSMIThNtauh1j5hj$hhhNhNubjG)}(hhh](jL)}(h CEC_TRANSMITh]jR)}(h CEC_TRANSMITh]jX)}(h CEC_TRANSMITh]j^)}(hjh]h CEC_TRANSMIT}(hjhhhNhNubah}(h]h ]jiah"]h$]h&]uh1j]hjubah}(h]h ](jpjqeh"]h$]h&]hhuh1jWhjhhhhhKubah}(h]h ]h"]h$]h&]hhj{uh1jQj|j}hjhhhhhKubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1jKhhhKhjhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjhhhhhKubeh}(h]h ](jmacroeh"]h$]h&]jjjjjjjjjuh1jFhhhj$hNhNubj )}(h9``int ioctl(int fd, CEC_TRANSMIT, struct cec_msg *argp)``h]j)}(hj h]h5int ioctl(int fd, CEC_TRANSMIT, struct cec_msg *argp)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKhj$hhubeh}(h]synopsisah ]h"]synopsisah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Argumentsh]h Arguments}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&hhhhhKubhdefinition_list)}(hhh](hdefinition_list_item)}(h5``fd`` File descriptor returned by :c:func:`open()`. h](hterm)}(h``fd``h]j)}(hjFh]hfd}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1jBhhhKhj>ubh definition)}(hhh]j )}(h-File descriptor returned by :c:func:`open()`.h](hFile descriptor returned by }(hj`hhhNhNubh)}(h:c:func:`open()`h]j)}(hjjh]hopen()}(hjlhhhNhNubah}(h]h ](xrefjc-funceh"]h$]h&]uh1jhjhubah}(h]h ]h"]h$]h&]refdoc'userspace-api/media/cec/cec-ioc-receive refdomainjreftypefunc refexplicitrefwarn c:parent_keysphinx.domains.c LookupKey)}data]j ASTIdentifier)} identifierCECsbNasb reftargetopenuh1hhhhKhj`ubh.}(hj`hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhj]ubah}(h]h ]h"]h$]h&]uh1j[hj>ubeh}(h]h ]h"]h$]h&]uh1j<hhhKhj9ubj=)}(h$``argp`` Pointer to struct cec_msg. h](jC)}(h``argp``h]j)}(hjh]hargp}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jBhhhK"hjubj\)}(hhh]j )}(hPointer to struct cec_msg.h]hPointer to struct cec_msg.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK"hjubah}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1j<hhhK"hj9hhubeh}(h]h ]h"]h$]h&]uh1j7hj&hhhhhNubeh}(h] argumentsah ]h"] argumentsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK%ubj )}(hXTo receive a CEC message the application has to fill in the ``timeout`` field of struct :c:type:`cec_msg` and pass it to :ref:`ioctl CEC_RECEIVE `. If the file descriptor is in non-blocking mode and there are no received messages pending, then it will return -1 and set errno to the ``EAGAIN`` error code. If the file descriptor is in blocking mode and ``timeout`` is non-zero and no message arrived within ``timeout`` milliseconds, then it will return -1 and set errno to the ``ETIMEDOUT`` error code.h](h`h]hinline)}(hjEh]hioctl CEC_RECEIVE}(hjIhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjCubah}(h]h ]h"]h$]h&]refdocj refdomainjSreftyperef refexplicitrefwarnj cec_receiveuh1hhhhK'hjubh. If the file descriptor is in non-blocking mode and there are no received messages pending, then it will return -1 and set errno to the }(hjhhhNhNubj)}(h ``EAGAIN``h]hEAGAIN}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh< error code. If the file descriptor is in blocking mode and }(hjhhhNhNubj)}(h ``timeout``h]htimeout}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh+ is non-zero and no message arrived within }(hjhhhNhNubj)}(h ``timeout``h]htimeout}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh; milliseconds, then it will return -1 and set errno to the }(hjhhhNhNubj)}(h ``ETIMEDOUT``h]h ETIMEDOUT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh error code.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhK'hjhhubj )}(hA received message can be:h]hA received message can be:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK0hjhhubhenumerated_list)}(hhh](h list_item)}(ha message received from another CEC device (the ``sequence`` field will be 0, ``tx_status`` will be 0 and ``rx_status`` will be non-zero).h]j )}(ha message received from another CEC device (the ``sequence`` field will be 0, ``tx_status`` will be 0 and ``rx_status`` will be non-zero).h](h0a message received from another CEC device (the }(hjhhhNhNubj)}(h ``sequence``h]hsequence}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh field will be 0, }(hjhhhNhNubj)}(h ``tx_status``h]h tx_status}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh will be 0 and }(hjhhhNhNubj)}(h ``rx_status``h]h rx_status}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh will be non-zero).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhK2hjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubj)}(hthe transmit result of an earlier non-blocking transmit (the ``sequence`` field will be non-zero, ``tx_status`` will be non-zero and ``rx_status`` will be 0).h]j )}(hthe transmit result of an earlier non-blocking transmit (the ``sequence`` field will be non-zero, ``tx_status`` will be non-zero and ``rx_status`` will be 0).h](h=the transmit result of an earlier non-blocking transmit (the }(hjhhhNhNubj)}(h ``sequence``h]hsequence}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh field will be non-zero, }(hjhhhNhNubj)}(h ``tx_status``h]h tx_status}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh will be non-zero and }(hjhhhNhNubj)}(h ``rx_status``h]h rx_status}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh will be 0).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhK4hjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubj)}(hthe reply to an earlier non-blocking transmit (the ``sequence`` field will be non-zero, ``tx_status`` will be 0 and ``rx_status`` will be non-zero). h]j )}(hthe reply to an earlier non-blocking transmit (the ``sequence`` field will be non-zero, ``tx_status`` will be 0 and ``rx_status`` will be non-zero).h](h3the reply to an earlier non-blocking transmit (the }(hjlhhhNhNubj)}(h ``sequence``h]hsequence}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubh field will be non-zero, }(hjlhhhNhNubj)}(h ``tx_status``h]h tx_status}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubh will be 0 and }(hjlhhhNhNubj)}(h ``rx_status``h]h rx_status}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubh will be non-zero).}(hjlhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhK7hjhubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1jhjhhhhhK2ubj )}(hX]To send a CEC message the application has to fill in the struct :c:type:`cec_msg` and pass it to :ref:`ioctl CEC_TRANSMIT `. The :ref:`ioctl CEC_TRANSMIT ` is only available if ``CEC_CAP_TRANSMIT`` is set. If there is no more room in the transmit queue, then it will return -1 and set errno to the ``EBUSY`` error code. The transmit queue has enough room for 18 messages (about 1 second worth of 2-byte messages). Note that the CEC kernel framework will also reply to core messages (see :ref:`cec-core-processing`), so it is not a good idea to fully fill up the transmit queue.h](h@To send a CEC message the application has to fill in the struct }(hjhhhNhNubh)}(h:c:type:`cec_msg`h]j)}(hjh]hcec_msg}(hjhhhNhNubah}(h]h ](jvjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjjcec_msguh1hhhhK:hjubh and pass it to }(hjhhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hjh]hioctl CEC_TRANSMIT}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_transmituh1hhhhK:hjubh. The }(hjhhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hjh]hioctl CEC_TRANSMIT}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_transmituh1hhhhK:hjubh is only available if }(hjhhhNhNubj)}(h``CEC_CAP_TRANSMIT``h]hCEC_CAP_TRANSMIT}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhe is set. If there is no more room in the transmit queue, then it will return -1 and set errno to the }(hjhhhNhNubj)}(h ``EBUSY``h]hEBUSY}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh error code. The transmit queue has enough room for 18 messages (about 1 second worth of 2-byte messages). Note that the CEC kernel framework will also reply to core messages (see }(hjhhhNhNubh)}(h:ref:`cec-core-processing`h]jH)}(hjZh]hcec-core-processing}(hj\hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjXubah}(h]h ]h"]h$]h&]refdocj refdomainjfreftyperef refexplicitrefwarnjcec-core-processinguh1hhhhK:hjubh@), so it is not a good idea to fully fill up the transmit queue.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhK:hjhhubj )}(hXIf the file descriptor is in non-blocking mode then the transmit will return 0 and the result of the transmit will be available via :ref:`ioctl CEC_RECEIVE ` once the transmit has finished. If a non-blocking transmit also specified waiting for a reply, then the reply will arrive in a later message. The ``sequence`` field can be used to associate both transmit results and replies with the original transmit.h](hIf the file descriptor is in non-blocking mode then the transmit will return 0 and the result of the transmit will be available via }(hjhhhNhNubh)}(h&:ref:`ioctl CEC_RECEIVE `h]jH)}(hjh]hioctl CEC_RECEIVE}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_receiveuh1hhhhKDhjubh once the transmit has finished. If a non-blocking transmit also specified waiting for a reply, then the reply will arrive in a later message. The }(hjhhhNhNubj)}(h ``sequence``h]hsequence}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh] field can be used to associate both transmit results and replies with the original transmit.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKDhjhhubj )}(hNormally calling :ref:`ioctl CEC_TRANSMIT ` when the physical address is invalid (due to e.g. a disconnect) will return ``ENONET``.h](hNormally calling }(hjhhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hjh]hioctl CEC_TRANSMIT}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_transmituh1hhhhKLhjubhM when the physical address is invalid (due to e.g. a disconnect) will return }(hjhhhNhNubj)}(h ``ENONET``h]hENONET}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKLhjhhubj )}(hHowever, the CEC specification allows sending messages from 'Unregistered' to 'TV' when the physical address is invalid since some TVs pull the hotplug detect pin of the HDMI connector low when they go into standby, or when switching to another input.h]hXHowever, the CEC specification allows sending messages from ‘Unregistered’ to ‘TV’ when the physical address is invalid since some TVs pull the hotplug detect pin of the HDMI connector low when they go into standby, or when switching to another input.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKOhjhhubj )}(hX.When the hotplug detect pin goes low the EDID disappears, and thus the physical address, but the cable is still connected and CEC still works. In order to detect/wake up the device it is allowed to send poll and 'Image/Text View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV').h]hX:When the hotplug detect pin goes low the EDID disappears, and thus the physical address, but the cable is still connected and CEC still works. In order to detect/wake up the device it is allowed to send poll and ‘Image/Text View On’ messages from initiator 0xf (‘Unregistered’) to destination 0 (‘TV’).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKThjhhubhtabular_col_spec)}(hhh]h}(h]h ]h"]h$]h&]spec|p{1.0cm}|p{3.5cm}|p{12.8cm}|uh1j&hhhKYhjhhubj6)}(hhh]h}(h]h ]h"]h$]h&]entries](jBCEC.cec_msg (C type) c.CEC.cec_msghNtauh1j5hjhhhNhNubjG)}(hhh](jL)}(hcec_msgh]jR)}(h type cec_msgh](hdesc_sig_keyword)}(htypeh]htype}(hjNhhhNhNubah}(h]h ]kah"]h$]h&]uh1jLhjHhhhhhK[ubhdesc_sig_space)}(h h]h }(hj_hhhNhNubah}(h]h ]wah"]h$]h&]uh1j]hjHhhhhhK[ubjX)}(hcec_msgh]j^)}(hjFh]hcec_msg}(hjrhhhNhNubah}(h]h ]jiah"]h$]h&]uh1j]hjnubah}(h]h ](jpjqeh"]h$]h&]hhuh1jWhjHhhhhhK[ubeh}(h]h ]h"]h$]h&]hhj{uh1jQj|j}hjDhhhhhK[ubah}(h]j?ah ](jjeh"]h$]h&]jj)jhuh1jKhhhK[hjAhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjAhhhhhK[ubeh}(h]h ](jtypeeh"]h$]h&]jjjjjjjjjuh1jFhhhjhNhNubhtable)}(hhh](h)}(hstruct cec_msgh]hstruct cec_msg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK_hjubhtgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubhtbody)}(hhh](hrow)}(hhh](hentry)}(hhh]j )}(h__u64h]h__u64}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKdhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(h ``tx_ts``h]j)}(hjh]htx_ts}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKehjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(hTimestamp in ns of when the last byte of the message was transmitted. The timestamp has been taken from the ``CLOCK_MONOTONIC`` clock. To access the same clock from userspace use :c:func:`clock_gettime`.h](hlTimestamp in ns of when the last byte of the message was transmitted. The timestamp has been taken from the }(hjhhhNhNubj)}(h``CLOCK_MONOTONIC``h]hCLOCK_MONOTONIC}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh4 clock. To access the same clock from userspace use }(hjhhhNhNubh)}(h:c:func:`clock_gettime`h]j)}(hj;h]hclock_gettime()}(hj=hhhNhNubah}(h]h ](jvjc-funceh"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjjj clock_gettimeuh1hhhhKfhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKfhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u64h]h__u64}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKihjqubah}(h]h ]h"]h$]h&]uh1jhjnubj)}(hhh]j )}(h ``rx_ts``h]j)}(hjh]hrx_ts}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKjhjubah}(h]h ]h"]h$]h&]uh1jhjnubj)}(hhh]j )}(hTimestamp in ns of when the last byte of the message was received. The timestamp has been taken from the ``CLOCK_MONOTONIC`` clock. To access the same clock from userspace use :c:func:`clock_gettime`.h](hiTimestamp in ns of when the last byte of the message was received. The timestamp has been taken from the }(hjhhhNhNubj)}(h``CLOCK_MONOTONIC``h]hCLOCK_MONOTONIC}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh4 clock. To access the same clock from userspace use }(hjhhhNhNubh)}(h:c:func:`clock_gettime`h]j)}(hjh]hclock_gettime()}(hjhhhNhNubah}(h]h ](jvjc-funceh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjjj clock_gettimeuh1hhhhKkhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKkhjubah}(h]h ]h"]h$]h&]uh1jhjnubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u32h]h__u32}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKnhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(h``len``h]j)}(hjh]hlen}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKohjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(hXAThe length of the message. For :ref:`ioctl CEC_TRANSMIT ` this is filled in by the application. The driver will fill this in for :ref:`ioctl CEC_RECEIVE `. For :ref:`ioctl CEC_TRANSMIT ` it will be filled in by the driver with the length of the reply message if ``reply`` was set.h](hThe length of the message. For }(hj7hhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hjAh]hioctl CEC_TRANSMIT}(hjChhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj?ubah}(h]h ]h"]h$]h&]refdocj refdomainjMreftyperef refexplicitrefwarnj cec_transmituh1hhhhKphj7ubhH this is filled in by the application. The driver will fill this in for }(hj7hhhNhNubh)}(h&:ref:`ioctl CEC_RECEIVE `h]jH)}(hjeh]hioctl CEC_RECEIVE}(hjghhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjcubah}(h]h ]h"]h$]h&]refdocj refdomainjqreftyperef refexplicitrefwarnj cec_receiveuh1hhhhKphj7ubh. For }(hj7hhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hjh]hioctl CEC_TRANSMIT}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_transmituh1hhhhKphj7ubhL it will be filled in by the driver with the length of the reply message if }(hj7hhhNhNubj)}(h ``reply``h]hreply}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubh was set.}(hj7hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKphj4ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u32h]h__u32}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKthjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(h ``timeout``h]j)}(hjh]htimeout}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKuhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(hXThe timeout in milliseconds. This is the time the device will wait for a message to be received before timing out. If it is set to 0, then it will wait indefinitely when it is called by :ref:`ioctl CEC_RECEIVE `. If it is 0 and it is called by :ref:`ioctl CEC_TRANSMIT `, then it will be replaced by 1000 if the ``reply`` is non-zero or ignored if ``reply`` is 0.h](hThe timeout in milliseconds. This is the time the device will wait for a message to be received before timing out. If it is set to 0, then it will wait indefinitely when it is called by }(hj hhhNhNubh)}(h&:ref:`ioctl CEC_RECEIVE `h]jH)}(hj h]hioctl CEC_RECEIVE}(hj hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj" reftyperef refexplicitrefwarnj cec_receiveuh1hhhhKvhj ubh!. If it is 0 and it is called by }(hj hhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hj: h]hioctl CEC_TRANSMIT}(hj< hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj8 ubah}(h]h ]h"]h$]h&]refdocj refdomainjF reftyperef refexplicitrefwarnj cec_transmituh1hhhhKvhj ubh*, then it will be replaced by 1000 if the }(hj hhhNhNubj)}(h ``reply``h]hreply}(hj\ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh is non-zero or ignored if }(hj hhhNhNubj)}(h ``reply``h]hreply}(hjn hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh is 0.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKvhj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u32h]h__u32}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK|hj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]j )}(h ``sequence``h]j)}(hj h]hsequence}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j hhhK}hj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh](j )}(hX!A non-zero sequence number is automatically assigned by the CEC framework for all transmitted messages. It is used by the CEC framework when it queues the transmit result for a non-blocking transmit. This allows the application to associate the received message with the original transmit.h]hX!A non-zero sequence number is automatically assigned by the CEC framework for all transmitted messages. It is used by the CEC framework when it queues the transmit result for a non-blocking transmit. This allows the application to associate the received message with the original transmit.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhK~hj ubj )}(hXIn addition, if a non-blocking transmit will wait for a reply (ii.e. ``timeout`` was not 0), then the ``sequence`` field of the reply will be set to the sequence value of the original transmit. This allows the application to associate the received message with the original transmit.h](hEIn addition, if a non-blocking transmit will wait for a reply (ii.e. }(hj hhhNhNubj)}(h ``timeout``h]htimeout}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh was not 0), then the }(hj hhhNhNubj)}(h ``sequence``h]hsequence}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh field of the reply will be set to the sequence value of the original transmit. This allows the application to associate the received message with the original transmit.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhj ubeh}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u32h]h__u32}(hj! hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]j )}(h ``flags``h]j)}(hj: h]hflags}(hj< hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8 ubah}(h]h ]h"]h$]h&]uh1j hhhKhj5 ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]j )}(h>Flags. See :ref:`cec-msg-flags` for a list of available flags.h](h Flags. See }(hjX hhhNhNubh)}(h:ref:`cec-msg-flags`h]jH)}(hjb h]h cec-msg-flags}(hjd hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj` ubah}(h]h ]h"]h$]h&]refdocj refdomainjn reftyperef refexplicitrefwarnj cec-msg-flagsuh1hhhhKhjX ubh for a list of available flags.}(hjX hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhjU ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u8h]h__u8}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]j )}(h ``msg[16]``h]j)}(hj h]hmsg[16]}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]j )}(hX>The message payload. For :ref:`ioctl CEC_TRANSMIT ` this is filled in by the application. The driver will fill this in for :ref:`ioctl CEC_RECEIVE `. For :ref:`ioctl CEC_TRANSMIT ` it will be filled in by the driver with the payload of the reply message if ``timeout`` was set.h](hThe message payload. For }(hj hhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hj h]hioctl CEC_TRANSMIT}(hj hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnj cec_transmituh1hhhhKhj ubhH this is filled in by the application. The driver will fill this in for }(hj hhhNhNubh)}(h&:ref:`ioctl CEC_RECEIVE `h]jH)}(hj h]hioctl CEC_RECEIVE}(hj hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnj cec_receiveuh1hhhhKhj ubh. For }(hj hhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hj% h]hioctl CEC_TRANSMIT}(hj' hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj# ubah}(h]h ]h"]h$]h&]refdocj refdomainj1 reftyperef refexplicitrefwarnj cec_transmituh1hhhhKhj ubhM it will be filled in by the driver with the payload of the reply message if }(hj hhhNhNubj)}(h ``timeout``h]htimeout}(hjG hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh was set.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u8h]h__u8}(hjq hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjn ubah}(h]h ]h"]h$]h&]uh1jhjk ubj)}(hhh]j )}(h ``reply``h]j)}(hj h]hreply}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhjk ubj)}(hhh](j )}(hXbWait until this message is replied. If ``reply`` is 0 and the ``timeout`` is 0, then don't wait for a reply but return after transmitting the message. Ignored by :ref:`ioctl CEC_RECEIVE `. The case where ``reply`` is 0 (this is the opcode for the Feature Abort message) and ``timeout`` is non-zero is specifically allowed to make it possible to send a message and wait up to ``timeout`` milliseconds for a Feature Abort reply. In this case ``rx_status`` will either be set to :ref:`CEC_RX_STATUS_TIMEOUT ` or :ref:`CEC_RX_STATUS_FEATURE_ABORT `.h](h'Wait until this message is replied. If }(hj hhhNhNubj)}(h ``reply``h]hreply}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh is 0 and the }(hj hhhNhNubj)}(h ``timeout``h]htimeout}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh[ is 0, then don’t wait for a reply but return after transmitting the message. Ignored by }(hj hhhNhNubh)}(h&:ref:`ioctl CEC_RECEIVE `h]jH)}(hj h]hioctl CEC_RECEIVE}(hj hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnj cec_receiveuh1hhhhKhj ubh. The case where }(hj hhhNhNubj)}(h ``reply``h]hreply}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh= is 0 (this is the opcode for the Feature Abort message) and }(hj hhhNhNubj)}(h ``timeout``h]htimeout}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubhZ is non-zero is specifically allowed to make it possible to send a message and wait up to }(hj hhhNhNubj)}(h ``timeout``h]htimeout}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh6 milliseconds for a Feature Abort reply. In this case }(hj hhhNhNubj)}(h ``rx_status``h]h rx_status}(hj. hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh will either be set to }(hj hhhNhNubh)}(h4:ref:`CEC_RX_STATUS_TIMEOUT `h]jH)}(hjB h]hCEC_RX_STATUS_TIMEOUT}(hjD hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj@ ubah}(h]h ]h"]h$]h&]refdocj refdomainjN reftyperef refexplicitrefwarnjcec-rx-status-timeoutuh1hhhhKhj ubh or }(hj hhhNhNubh)}(h@:ref:`CEC_RX_STATUS_FEATURE_ABORT `h]jH)}(hjf h]hCEC_RX_STATUS_FEATURE_ABORT}(hjh hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjd ubah}(h]h ]h"]h$]h&]refdocj refdomainjr reftyperef refexplicitrefwarnjcec-rx-status-feature-abortuh1hhhhKhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhj ubj )}(hXIf the transmitter message is ``CEC_MSG_INITIATE_ARC`` then the ``reply`` values ``CEC_MSG_REPORT_ARC_INITIATED`` and ``CEC_MSG_REPORT_ARC_TERMINATED`` are processed differently: either value will match both possible replies. The reason is that the ``CEC_MSG_INITIATE_ARC`` message is the only CEC message that has two possible replies other than Feature Abort. The ``reply`` field will be updated with the actual reply so that it is synchronized with the contents of the received message.h](hIf the transmitter message is }(hj hhhNhNubj)}(h``CEC_MSG_INITIATE_ARC``h]hCEC_MSG_INITIATE_ARC}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh then the }(hj hhhNhNubj)}(h ``reply``h]hreply}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh values }(hj hhhNhNubj)}(h ``CEC_MSG_REPORT_ARC_INITIATED``h]hCEC_MSG_REPORT_ARC_INITIATED}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh and }(hj hhhNhNubj)}(h!``CEC_MSG_REPORT_ARC_TERMINATED``h]hCEC_MSG_REPORT_ARC_TERMINATED}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubhb are processed differently: either value will match both possible replies. The reason is that the }(hj hhhNhNubj)}(h``CEC_MSG_INITIATE_ARC``h]hCEC_MSG_INITIATE_ARC}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh] message is the only CEC message that has two possible replies other than Feature Abort. The }(hj hhhNhNubj)}(h ``reply``h]hreply}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubhr field will be updated with the actual reply so that it is synchronized with the contents of the received message.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhj ubeh}(h]h ]h"]h$]h&]uh1jhjk ubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u8h]h__u8}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]j )}(h ``rx_status``h]j)}(hj3 h]h rx_status}(hj5 hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1 ubah}(h]h ]h"]h$]h&]uh1j hhhKhj. ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]j )}(haThe status bits of the received message. See :ref:`cec-rx-status` for the possible status values.h](h-The status bits of the received message. See }(hjQ hhhNhNubh)}(h:ref:`cec-rx-status`h]jH)}(hj[ h]h cec-rx-status}(hj] hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjY ubah}(h]h ]h"]h$]h&]refdocj refdomainjg reftyperef refexplicitrefwarnj cec-rx-statusuh1hhhhKhjQ ubh for the possible status values.}(hjQ hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhjN ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u8h]h__u8}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]j )}(h ``tx_status``h]j)}(hj h]h tx_status}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]j )}(hXThe status bits of the transmitted message. See :ref:`cec-tx-status` for the possible status values. When calling :ref:`ioctl CEC_TRANSMIT ` in non-blocking mode, this field will be 0 if the transmit started, or non-0 if the transmit result is known immediately. The latter would be the case when attempting to transmit a Poll message to yourself. That results in a :ref:`CEC_TX_STATUS_NACK ` without ever actually transmitting the Poll message.h](h0The status bits of the transmitted message. See }(hj hhhNhNubh)}(h:ref:`cec-tx-status`h]jH)}(hj h]h cec-tx-status}(hj hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnj cec-tx-statusuh1hhhhKhj ubh. for the possible status values. When calling }(hj hhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hj h]hioctl CEC_TRANSMIT}(hj hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_transmituh1hhhhKhj ubh in non-blocking mode, this field will be 0 if the transmit started, or non-0 if the transmit result is known immediately. The latter would be the case when attempting to transmit a Poll message to yourself. That results in a }(hj hhhNhNubh)}(h.:ref:`CEC_TX_STATUS_NACK `h]jH)}(hjh]hCEC_TX_STATUS_NACK}(hj hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainj*reftyperef refexplicitrefwarnjcec-tx-status-nackuh1hhhhKhj ubh5 without ever actually transmitting the Poll message.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u8h]h__u8}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjUubah}(h]h ]h"]h$]h&]uh1jhjRubj)}(hhh]j )}(h``tx_arb_lost_cnt``h]j)}(hjqh]htx_arb_lost_cnt}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjoubah}(h]h ]h"]h$]h&]uh1j hhhKhjlubah}(h]h ]h"]h$]h&]uh1jhjRubj)}(hhh]j )}(hXA counter of the number of transmit attempts that resulted in the Arbitration Lost error. This is only set if the hardware supports this, otherwise it is always 0. This counter is only valid if the :ref:`CEC_TX_STATUS_ARB_LOST ` status bit is set.h](hA counter of the number of transmit attempts that resulted in the Arbitration Lost error. This is only set if the hardware supports this, otherwise it is always 0. This counter is only valid if the }(hjhhhNhNubh)}(h6:ref:`CEC_TX_STATUS_ARB_LOST `h]jH)}(hjh]hCEC_TX_STATUS_ARB_LOST}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjcec-tx-status-arb-lostuh1hhhhKhjubh status bit is set.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhjubah}(h]h ]h"]h$]h&]uh1jhjRubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u8h]h__u8}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(h``tx_nack_cnt``h]j)}(hjh]h tx_nack_cnt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(hXA counter of the number of transmit attempts that resulted in the Not Acknowledged error. This is only set if the hardware supports this, otherwise it is always 0. This counter is only valid if the :ref:`CEC_TX_STATUS_NACK ` status bit is set.h](hA counter of the number of transmit attempts that resulted in the Not Acknowledged error. This is only set if the hardware supports this, otherwise it is always 0. This counter is only valid if the }(hj hhhNhNubh)}(h.:ref:`CEC_TX_STATUS_NACK `h]jH)}(hjh]hCEC_TX_STATUS_NACK}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnjcec-tx-status-nackuh1hhhhKhj ubh status bit is set.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u8h]h__u8}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjKubah}(h]h ]h"]h$]h&]uh1jhjHubj)}(hhh]j )}(h``tx_low_drive_cnt``h]j)}(hjgh]htx_low_drive_cnt}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1jhjeubah}(h]h ]h"]h$]h&]uh1j hhhKhjbubah}(h]h ]h"]h$]h&]uh1jhjHubj)}(hhh]j )}(hXA counter of the number of transmit attempts that resulted in the Arbitration Lost error. This is only set if the hardware supports this, otherwise it is always 0. This counter is only valid if the :ref:`CEC_TX_STATUS_LOW_DRIVE ` status bit is set.h](hA counter of the number of transmit attempts that resulted in the Arbitration Lost error. This is only set if the hardware supports this, otherwise it is always 0. This counter is only valid if the }(hjhhhNhNubh)}(h8:ref:`CEC_TX_STATUS_LOW_DRIVE `h]jH)}(hjh]hCEC_TX_STATUS_LOW_DRIVE}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjcec-tx-status-low-driveuh1hhhhKhjubh status bit is set.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhjubah}(h]h ]h"]h$]h&]uh1jhjHubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]j )}(h__u8h]h__u8}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(h``tx_error_cnt``h]j)}(hjh]h tx_error_cnt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]j )}(hX A counter of the number of transmit errors other than Arbitration Lost or Not Acknowledged. This is only set if the hardware supports this, otherwise it is always 0. This counter is only valid if the :ref:`CEC_TX_STATUS_ERROR ` status bit is set.h](hA counter of the number of transmit errors other than Arbitration Lost or Not Acknowledged. This is only set if the hardware supports this, otherwise it is always 0. This counter is only valid if the }(hjhhhNhNubh)}(h0:ref:`CEC_TX_STATUS_ERROR `h]jH)}(hj h]hCEC_TX_STATUS_ERROR}(hj hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjcec-tx-status-erroruh1hhhhKhjubh status bit is set.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubeh}(h]id1ah ] longtableah"]h$]h&]uh1jhjhhhNhNubj')}(hhh]h}(h]h ]h"]h$]h&]j1|p{6.2cm}|p{1.0cm}|p{10.1cm}|uh1j&hhhKhjhhubh)}(h.. _cec-msg-flags:h]h}(h]h ]h"]h$]h&]hԌ cec-msg-flagsuh1hhKhjhhhhubj)}(hhh](h)}(hFlags for struct cec_msgh]hFlags for struct cec_msg}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhubj)}(hhh](j)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjyubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjyubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjyubj)}(hhh](j)}(hhh](j)}(hhh](h)}(h$.. _`CEC-MSG-FL-REPLY-TO-FOLLOWERS`:h]h}(h]h ]h"]h$]h&]hԌcec-msg-fl-reply-to-followersuh1hhKhj)}(hhh](jj )}(hXIf a CEC transmit expects a reply, then by default that reply is only sent to the filehandle that called :ref:`ioctl CEC_TRANSMIT `. If this flag is set, then the reply is also sent to all followers, if any. If the filehandle that called :ref:`ioctl CEC_TRANSMIT ` is also a follower, then that filehandle will receive the reply twice: once as the result of the :ref:`ioctl CEC_TRANSMIT `, and once via :ref:`ioctl CEC_RECEIVE `.h](hiIf a CEC transmit expects a reply, then by default that reply is only sent to the filehandle that called }(hjhhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hjh]hioctl CEC_TRANSMIT}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_transmituh1hhhhKhjubhk. If this flag is set, then the reply is also sent to all followers, if any. If the filehandle that called }(hjhhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hjh]hioctl CEC_TRANSMIT}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_transmituh1hhhhKhjubhb is also a follower, then that filehandle will receive the reply twice: once as the result of the }(hjhhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hjh]hioctl CEC_TRANSMIT}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_transmituh1hhhhKhjubh, and once via }(hjhhhNhNubh)}(h&:ref:`ioctl CEC_RECEIVE `h]jH)}(hj'h]hioctl CEC_RECEIVE}(hj)hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj%ubah}(h]h ]h"]h$]h&]refdocj refdomainj3reftyperef refexplicitrefwarnj cec_receiveuh1hhhhKhjubh.}(hjhhhNhNubeh}(h]jah ]h"]cec-msg-fl-reply-to-followersah$]h&]uh1j hhhKhjh}jMjsh}jjsubeh}(h]h ]h"]h$]h&]uh1jhjububj )}(h!``CEC_MSG_FL_REPLY_TO_FOLLOWERS``h]j)}(hjZh]hCEC_MSG_FL_REPLY_TO_FOLLOWERS}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjXubah}(h]h ]h"]h$]h&]uh1j hhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](jj )}(h1h]h1}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjuubeh}(h]h ]h"]h$]h&]uh1jhjubjeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh](h)}(h.. _`CEC-MSG-FL-RAW`:h]h}(h]h ]h"]h$]h&]hԌcec-msg-fl-rawuh1hhKhj)}(hhh](jj )}(hXNormally CEC messages are validated before transmitting them. If this flag is set when :ref:`ioctl CEC_TRANSMIT ` is called, then no validation takes place and the message is transmitted as-is. This is useful when debugging CEC issues. This flag is only allowed if the process has the ``CAP_SYS_RAWIO`` capability. If that is not set, then the ``EPERM`` error code is returned.h](hWNormally CEC messages are validated before transmitting them. If this flag is set when }(hjhhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hjh]hioctl CEC_TRANSMIT}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_transmituh1hhhhKhjubh is called, then no validation takes place and the message is transmitted as-is. This is useful when debugging CEC issues. This flag is only allowed if the process has the }(hjhhhNhNubj)}(h``CAP_SYS_RAWIO``h]h CAP_SYS_RAWIO}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh* capability. If that is not set, then the }(hjhhhNhNubj)}(h ``EPERM``h]hEPERM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh error code is returned.}(hjhhhNhNubeh}(h]jah ]h"]cec-msg-fl-rawah$]h&]uh1j hhhKhjh}jjsh}jjsubeh}(h]h ]h"]h$]h&]uh1jhjububj )}(h``CEC_MSG_FL_RAW``h]j)}(hjh]hCEC_MSG_FL_RAW}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](jj )}(h2h]h2}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhj"ubeh}(h]h ]h"]h$]h&]uh1jhjubjeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh](h)}(h!.. _`CEC-MSG-FL-REPLY-VENDOR-ID`:h]h}(h]h ]h"]h$]h&]hԌcec-msg-fl-reply-vendor-iduh1hhKhj)}(hhh](jEj )}(hX*This flag is only available if the ``CEC_CAP_REPLY_VENDOR_ID`` capability is set. If this flag is set, then the reply is expected to consist of the ``CEC_MSG_VENDOR_COMMAND_WITH_ID`` opcode followed by the Vendor ID (in bytes 1-4 of the message), followed by the ``struct cec_msg`` ``reply`` field.h](h#This flag is only available if the }(hjShhhNhNubj)}(h``CEC_CAP_REPLY_VENDOR_ID``h]hCEC_CAP_REPLY_VENDOR_ID}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubhV capability is set. If this flag is set, then the reply is expected to consist of the }(hjShhhNhNubj)}(h"``CEC_MSG_VENDOR_COMMAND_WITH_ID``h]hCEC_MSG_VENDOR_COMMAND_WITH_ID}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubhQ opcode followed by the Vendor ID (in bytes 1-4 of the message), followed by the }(hjShhhNhNubj)}(h``struct cec_msg``h]hstruct cec_msg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubh }(hjShhhNhNubj)}(h ``reply``h]hreply}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubh field.}(hjShhhNhNubeh}(h]jOah ]h"]cec-msg-fl-reply-vendor-idah$]h&]uh1j hhhKhjPh}jjEsh}jOjEsubj )}(hUNote that this assumes that the byte after the Vendor ID is a vendor-specific opcode.h]hUNote that this assumes that the byte after the Vendor ID is a vendor-specific opcode.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjPubj )}(hAThis flag makes it easier to wait for replies to vendor commands.h]hAThis flag makes it easier to wait for replies to vendor commands.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjPubeh}(h]h ]h"]h$]h&]uh1jhj?ububj )}(h``CEC_MSG_FL_REPLY_VENDOR_ID``h]j)}(hjh]hCEC_MSG_FL_REPLY_VENDOR_ID}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhKhjBubeh}(h]h ]h"]h$]h&]uh1jhj?ubj)}(hhh](jEj )}(h4h]h4}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhKhjubeh}(h]h ]h"]h$]h&]uh1jhj?ubjPeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjyubeh}(h]h ]h"]h$]h&]colsKuh1jhjhubeh}(h](id2jgeh ]h"] cec-msg-flagsah$]h&]uh1jhjhhhNhNh}jj]sh}jgj]subj')}(hhh]h}(h]h ]h"]h$]h&]j1|p{5.6cm}|p{0.9cm}|p{10.8cm}|uh1j&hhhKhjhhubh)}(h.. _cec-tx-status:h]h}(h]h ]h"]h$]h&]hԌ cec-tx-statusuh1hhKhjhhhhubj)}(hhh](h)}(hCEC Transmit Statush]hCEC Transmit Status}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj4ubj)}(hhh](j)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjEubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjEubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjEubj)}(hhh](j)}(hhh](j)}(hhh](h)}(h.. _`CEC-TX-STATUS-OK`:h]h}(h]h ]h"]h$]h&]hԌcec-tx-status-okuh1hhMhj)}(hhh](joj )}(hThe message was transmitted successfully. This is mutually exclusive with :ref:`CEC_TX_STATUS_MAX_RETRIES `. Other bits can still be set if earlier attempts met with failure before the transmit was eventually successful.h](hJThe message was transmitted successfully. This is mutually exclusive with }(hj}hhhNhNubh)}(h<:ref:`CEC_TX_STATUS_MAX_RETRIES `h]jH)}(hjh]hCEC_TX_STATUS_MAX_RETRIES}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjcec-tx-status-max-retriesuh1hhhhMhj}ubhq. Other bits can still be set if earlier attempts met with failure before the transmit was eventually successful.}(hj}hhhNhNubeh}(h]jyah ]h"]cec-tx-status-okah$]h&]uh1j hhhMhjzh}jjosh}jyjosubeh}(h]h ]h"]h$]h&]uh1jhjiububj )}(h``CEC_TX_STATUS_OK``h]j)}(hjh]hCEC_TX_STATUS_OK}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhMhjlubeh}(h]h ]h"]h$]h&]uh1jhjiubj)}(hhh](joj )}(h0x01h]h0x01}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubeh}(h]h ]h"]h$]h&]uh1jhjiubjzeh}(h]h ]h"]h$]h&]uh1jhjfubj)}(hhh](j)}(hhh](h)}(h.. _`CEC-TX-STATUS-ARB-LOST`:h]h}(h]h ]h"]h$]h&]hԌcec-tx-status-arb-lostuh1hhM hj)}(hhh](jj )}(hCEC line arbitration was lost, i.e. another transmit started at the same time with a higher priority. Optional status, not all hardware can detect this error condition.h]hCEC line arbitration was lost, i.e. another transmit started at the same time with a higher priority. Optional status, not all hardware can detect this error condition.}(hjhhhNhNubah}(h]jah ]h"]cec-tx-status-arb-lostah$]h&]uh1j hhhMhjh}jjsh}jjsubeh}(h]h ]h"]h$]h&]uh1jhjububj )}(h``CEC_TX_STATUS_ARB_LOST``h]j)}(hjh]hCEC_TX_STATUS_ARB_LOST}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhM hjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](jj )}(h0x02h]h0x02}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhj:ubeh}(h]h ]h"]h$]h&]uh1jhjubjeh}(h]h ]h"]h$]h&]uh1jhjfubj)}(hhh](j)}(hhh](h)}(h.. _`CEC-TX-STATUS-NACK`:h]h}(h]h ]h"]h$]h&]hԌcec-tx-status-nackuh1hhMhj)}(hhh](j]j )}(hMessage was not acknowledged. Note that some hardware cannot tell apart a 'Not Acknowledged' status from other error conditions, i.e. the result of a transmit is just OK or FAIL. In that case this status will be returned when the transmit failed.h]hMessage was not acknowledged. Note that some hardware cannot tell apart a ‘Not Acknowledged’ status from other error conditions, i.e. the result of a transmit is just OK or FAIL. In that case this status will be returned when the transmit failed.}(hjkhhhNhNubah}(h]jgah ]h"]cec-tx-status-nackah$]h&]uh1j hhhMhjhh}jwj]sh}jgj]subeh}(h]h ]h"]h$]h&]uh1jhjWububj )}(h``CEC_TX_STATUS_NACK``h]j)}(hjh]hCEC_TX_STATUS_NACK}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhMhjZubeh}(h]h ]h"]h$]h&]uh1jhjWubj)}(hhh](j]j )}(h0x04h]h0x04}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubeh}(h]h ]h"]h$]h&]uh1jhjWubjheh}(h]h ]h"]h$]h&]uh1jhjfubj)}(hhh](j)}(hhh](h)}(h.. _`CEC-TX-STATUS-LOW-DRIVE`:h]h}(h]h ]h"]h$]h&]hԌcec-tx-status-low-driveuh1hhMhj)}(hhh](jj )}(hLow drive was detected on the CEC bus. This indicates that a follower detected an error on the bus and requests a retransmission. Optional status, not all hardware can detect this error condition.h]hLow drive was detected on the CEC bus. This indicates that a follower detected an error on the bus and requests a retransmission. Optional status, not all hardware can detect this error condition.}(hjhhhNhNubah}(h]jah ]h"]cec-tx-status-low-driveah$]h&]uh1j hhhMhjh}jjsh}jjsubeh}(h]h ]h"]h$]h&]uh1jhjububj )}(h``CEC_TX_STATUS_LOW_DRIVE``h]j)}(hjh]hCEC_TX_STATUS_LOW_DRIVE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhMhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](jj )}(h0x08h]h0x08}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMhjubeh}(h]h ]h"]h$]h&]uh1jhjubjeh}(h]h ]h"]h$]h&]uh1jhjfubj)}(hhh](j)}(hhh](h)}(h.. _`CEC-TX-STATUS-ERROR`:h]h}(h]h ]h"]h$]h&]hԌcec-tx-status-erroruh1hhM"hj)}(hhh](j'j )}(hXSome error occurred. This is used for any errors that do not fit ``CEC_TX_STATUS_ARB_LOST`` or ``CEC_TX_STATUS_LOW_DRIVE``, either because the hardware could not tell which error occurred, or because the hardware tested for other conditions besides those two. Optional status.h](hASome error occurred. This is used for any errors that do not fit }(hj5hhhNhNubj)}(h``CEC_TX_STATUS_ARB_LOST``h]hCEC_TX_STATUS_ARB_LOST}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubh or }(hj5hhhNhNubj)}(h``CEC_TX_STATUS_LOW_DRIVE``h]hCEC_TX_STATUS_LOW_DRIVE}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubh, either because the hardware could not tell which error occurred, or because the hardware tested for other conditions besides those two. Optional status.}(hj5hhhNhNubeh}(h]j1ah ]h"]cec-tx-status-errorah$]h&]uh1j hhhM&hj2h}jej'sh}j1j'subeh}(h]h ]h"]h$]h&]uh1jhj!ububj )}(h``CEC_TX_STATUS_ERROR``h]j)}(hjrh]hCEC_TX_STATUS_ERROR}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1j hhhM$hj$ubeh}(h]h ]h"]h$]h&]uh1jhj!ubj)}(hhh](j'j )}(h0x10h]h0x10}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM%hjubeh}(h]h ]h"]h$]h&]uh1jhj!ubj2eh}(h]h ]h"]h$]h&]uh1jhjfubj)}(hhh](j)}(hhh](h)}(h .. _`CEC-TX-STATUS-MAX-RETRIES`:h]h}(h]h ]h"]h$]h&]hԌcec-tx-status-max-retriesuh1hhM*hj)}(hhh](jj )}(hThe transmit failed after one or more retries. This status bit is mutually exclusive with :ref:`CEC_TX_STATUS_OK `. Other bits can still be set to explain which failures were seen.h](hZThe transmit failed after one or more retries. This status bit is mutually exclusive with }(hjhhhNhNubh)}(h*:ref:`CEC_TX_STATUS_OK `h]jH)}(hjh]hCEC_TX_STATUS_OK}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjcec-tx-status-okuh1hhhhM.hjubhB. Other bits can still be set to explain which failures were seen.}(hjhhhNhNubeh}(h]jah ]h"]cec-tx-status-max-retriesah$]h&]uh1j hhhM.hjh}jjsh}jjsubeh}(h]h ]h"]h$]h&]uh1jhjububj )}(h``CEC_TX_STATUS_MAX_RETRIES``h]j)}(hjh]hCEC_TX_STATUS_MAX_RETRIES}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhM,hjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](jj )}(h0x20h]h0x20}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM-hjubeh}(h]h ]h"]h$]h&]uh1jhjubjeh}(h]h ]h"]h$]h&]uh1jhjfubj)}(hhh](j)}(hhh](h)}(h.. _`CEC-TX-STATUS-ABORTED`:h]h}(h]h ]h"]h$]h&]hԌcec-tx-status-aborteduh1hhM1hj)}(hhh](j9j )}(hThe transmit was aborted due to an HDMI disconnect, or the adapter was unconfigured, or a transmit was interrupted, or the driver returned an error when attempting to start a transmit.h]hThe transmit was aborted due to an HDMI disconnect, or the adapter was unconfigured, or a transmit was interrupted, or the driver returned an error when attempting to start a transmit.}(hjGhhhNhNubah}(h]jCah ]h"]cec-tx-status-abortedah$]h&]uh1j hhhM5hjDh}jSj9sh}jCj9subeh}(h]h ]h"]h$]h&]uh1jhj3ububj )}(h``CEC_TX_STATUS_ABORTED``h]j)}(hj`h]hCEC_TX_STATUS_ABORTED}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&]uh1j hhhM3hj6ubeh}(h]h ]h"]h$]h&]uh1jhj3ubj)}(hhh](j9j )}(h0x40h]h0x40}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM4hj{ubeh}(h]h ]h"]h$]h&]uh1jhj3ubjDeh}(h]h ]h"]h$]h&]uh1jhjfubj)}(hhh](j)}(hhh](h)}(h.. _`CEC-TX-STATUS-TIMEOUT`:h]h}(h]h ]h"]h$]h&]hԌcec-tx-status-timeoutuh1hhM8hj)}(hhh](jj )}(h\The transmit timed out. This should not normally happen and this indicates a driver problem.h]h\The transmit timed out. This should not normally happen and this indicates a driver problem.}(hjhhhNhNubah}(h]jah ]h"]cec-tx-status-timeoutah$]h&]uh1j hhhM<hjh}jjsh}jjsubeh}(h]h ]h"]h$]h&]uh1jhjububj )}(h``CEC_TX_STATUS_TIMEOUT``h]j)}(hjh]hCEC_TX_STATUS_TIMEOUT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhM:hjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](jj )}(h0x80h]h0x80}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM;hjubeh}(h]h ]h"]h$]h&]uh1jhjubjeh}(h]h ]h"]h$]h&]uh1jhjfubeh}(h]h ]h"]h$]h&]uh1jhjEubeh}(h]h ]h"]h$]h&]colsKuh1jhj4ubeh}(h](id3j3eh ]h"] cec-tx-statusah$]h&]uh1jhjhhhNhNh}jj)sh}j3j)subj')}(hhh]h}(h]h ]h"]h$]h&]j1|p{5.6cm}|p{0.9cm}|p{10.8cm}|uh1j&hhhM?hjhhubh)}(h.. _cec-rx-status:h]h}(h]h ]h"]h$]h&]hԌ cec-rx-statusuh1hhMAhjhhhhubj)}(hhh](h)}(hCEC Receive Statush]hCEC Receive Status}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMChj)ubj)}(hhh](j)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhj:ubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhj:ubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhj:ubj)}(hhh](j)}(hhh](j)}(hhh](h)}(h.. _`CEC-RX-STATUS-OK`:h]h}(h]h ]h"]h$]h&]hԌcec-rx-status-okuh1hhMHhj)}(hhh](jdj )}(h&The message was received successfully.h]h&The message was received successfully.}(hjrhhhNhNubah}(h]jnah ]h"]cec-rx-status-okah$]h&]uh1j hhhMLhjoh}j~jdsh}jnjdsubeh}(h]h ]h"]h$]h&]uh1jhj^ububj )}(h``CEC_RX_STATUS_OK``h]j)}(hjh]hCEC_RX_STATUS_OK}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhMJhjaubeh}(h]h ]h"]h$]h&]uh1jhj^ubj)}(hhh](jdj )}(h0x01h]h0x01}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMKhjubeh}(h]h ]h"]h$]h&]uh1jhj^ubjoeh}(h]h ]h"]h$]h&]uh1jhj[ubj)}(hhh](j)}(hhh](h)}(h.. _`CEC-RX-STATUS-TIMEOUT`:h]h}(h]h ]h"]h$]h&]hԌcec-rx-status-timeoutuh1hhMMhj)}(hhh](jj )}(h6The reply to an earlier transmitted message timed out.h]h6The reply to an earlier transmitted message timed out.}(hjhhhNhNubah}(h]jah ]h"]cec-rx-status-timeoutah$]h&]uh1j hhhMQhjh}jjsh}jjsubeh}(h]h ]h"]h$]h&]uh1jhjububj )}(h``CEC_RX_STATUS_TIMEOUT``h]j)}(hjh]hCEC_RX_STATUS_TIMEOUT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhMOhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](jj )}(h0x02h]h0x02}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMPhj ubeh}(h]h ]h"]h$]h&]uh1jhjubjeh}(h]h ]h"]h$]h&]uh1jhj[ubj)}(hhh](j)}(hhh](h)}(h".. _`CEC-RX-STATUS-FEATURE-ABORT`:h]h}(h]h ]h"]h$]h&]hԌcec-rx-status-feature-abortuh1hhMRhj)}(hhh](j.j )}(hThe message was received successfully but the reply was ``CEC_MSG_FEATURE_ABORT``. This status is only set if this message was the reply to an earlier transmitted message.h](h8The message was received successfully but the reply was }(hj<hhhNhNubj)}(h``CEC_MSG_FEATURE_ABORT``h]hCEC_MSG_FEATURE_ABORT}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<ubhZ. This status is only set if this message was the reply to an earlier transmitted message.}(hj<hhhNhNubeh}(h]j8ah ]h"]cec-rx-status-feature-abortah$]h&]uh1j hhhMVhj9h}jZj.sh}j8j.subeh}(h]h ]h"]h$]h&]uh1jhj(ububj )}(h``CEC_RX_STATUS_FEATURE_ABORT``h]j)}(hjgh]hCEC_RX_STATUS_FEATURE_ABORT}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1jhjeubah}(h]h ]h"]h$]h&]uh1j hhhMThj+ubeh}(h]h ]h"]h$]h&]uh1jhj(ubj)}(hhh](j.j )}(h0x04h]h0x04}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMUhjubeh}(h]h ]h"]h$]h&]uh1jhj(ubj9eh}(h]h ]h"]h$]h&]uh1jhj[ubj)}(hhh](j)}(hhh](h)}(h.. _`CEC-RX-STATUS-ABORTED`:h]h}(h]h ]h"]h$]h&]hԌcec-rx-status-aborteduh1hhMYhj)}(hhh](jj )}(hThe wait for a reply to an earlier transmitted message was aborted because the HDMI cable was disconnected, the adapter was unconfigured or the :ref:`CEC_TRANSMIT ` that waited for a reply was interrupted.h](hThe wait for a reply to an earlier transmitted message was aborted because the HDMI cable was disconnected, the adapter was unconfigured or the }(hjhhhNhNubh)}(h!:ref:`CEC_TRANSMIT `h]jH)}(hjh]h CEC_TRANSMIT}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_receiveuh1hhhhM]hjubh) that waited for a reply was interrupted.}(hjhhhNhNubeh}(h]jah ]h"]cec-rx-status-abortedah$]h&]uh1j hhhM]hjh}jjsh}jjsubeh}(h]h ]h"]h$]h&]uh1jhjububj )}(h``CEC_RX_STATUS_ABORTED``h]j)}(hjh]hCEC_RX_STATUS_ABORTED}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hhhM[hjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](jj )}(h0x08h]h0x08}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhM\hj ubeh}(h]h ]h"]h$]h&]uh1jhjubjeh}(h]h ]h"]h$]h&]uh1jhj[ubeh}(h]h ]h"]h$]h&]uh1jhj:ubeh}(h]h ]h"]h$]h&]colsKuh1jhj)ubeh}(h](id4j(eh ]h"] cec-rx-statusah$]h&]uh1jhjhhhNhNh}j:jsh}j(jsubeh}(h] descriptionah ]h"] descriptionah$]h&]uh1hhhhhhhhK%ubh)}(hhh](h)}(h Return Valueh]h Return Value}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjGhhhhhMdubj )}(hOn success 0 is returned, on error -1 and the ``errno`` variable is set appropriately. The generic error codes are described at the :ref:`Generic Error Codes ` chapter.h](h.On success 0 is returned, on error -1 and the }(hjXhhhNhNubj)}(h ``errno``h]herrno}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjXubhM variable is set appropriately. The generic error codes are described at the }(hjXhhhNhNubh)}(h':ref:`Generic Error Codes `h]jH)}(hjth]hGeneric Error Codes}(hjvhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjrubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj gen-errorsuh1hhhhMfhjXubh chapter.}(hjXhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMfhjGhhubj )}(hPThe :ref:`ioctl CEC_RECEIVE ` can return the following error codes:h](hThe }(hjhhhNhNubh)}(h&:ref:`ioctl CEC_RECEIVE `h]jH)}(hjh]hioctl CEC_RECEIVE}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_receiveuh1hhhhMjhjubh& can return the following error codes:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMjhjGhhubj8)}(hhh](j=)}(hYEAGAIN No messages are in the receive queue, and the filehandle is in non-blocking mode. h](jC)}(hEAGAINh]hEAGAIN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jBhhhMnhjubj\)}(hhh]j )}(hQNo messages are in the receive queue, and the filehandle is in non-blocking mode.h]hQNo messages are in the receive queue, and the filehandle is in non-blocking mode.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMnhjubah}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1j<hhhMnhjubj=)}(hCETIMEDOUT The ``timeout`` was reached while waiting for a message. h](jC)}(h ETIMEDOUTh]h ETIMEDOUT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jBhhhMqhjubj\)}(hhh]j )}(h8The ``timeout`` was reached while waiting for a message.h](hThe }(hjhhhNhNubj)}(h ``timeout``h]htimeout}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh) was reached while waiting for a message.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMqhjubah}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1j<hhhMqhjhhubj=)}(hEERESTARTSYS The wait for a message was interrupted (e.g. by Ctrl-C). h](jC)}(h ERESTARTSYSh]h ERESTARTSYS}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jBhhhMthjAubj\)}(hhh]j )}(h8The wait for a message was interrupted (e.g. by Ctrl-C).h]h8The wait for a message was interrupted (e.g. by Ctrl-C).}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1j hhhMthjSubah}(h]h ]h"]h$]h&]uh1j[hjAubeh}(h]h ]h"]h$]h&]uh1j<hhhMthjhhubeh}(h]h ]h"]h$]h&]uh1j7hjGhhhhhNubj )}(hRThe :ref:`ioctl CEC_TRANSMIT ` can return the following error codes:h](hThe }(hjvhhhNhNubh)}(h(:ref:`ioctl CEC_TRANSMIT `h]jH)}(hjh]hioctl CEC_TRANSMIT}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj~ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj cec_transmituh1hhhhMvhjvubh& can return the following error codes:}(hjvhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMvhjGhhubj8)}(hhh](j=)}(hWENOTTY The ``CEC_CAP_TRANSMIT`` capability wasn't set, so this ioctl is not supported. h](jC)}(hENOTTYh]hENOTTY}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jBhhhMzhjubj\)}(hhh]j )}(hOThe ``CEC_CAP_TRANSMIT`` capability wasn't set, so this ioctl is not supported.h](hThe }(hjhhhNhNubj)}(h``CEC_CAP_TRANSMIT``h]hCEC_CAP_TRANSMIT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh9 capability wasn’t set, so this ioctl is not supported.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMzhjubah}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1j<hhhMzhjubj=)}(hEPERM The CEC adapter is not configured, i.e. :ref:`ioctl CEC_ADAP_S_LOG_ADDRS ` has never been called, or ``CEC_MSG_FL_RAW`` was used from a process that did not have the ``CAP_SYS_RAWIO`` capability. h](jC)}(hEPERMh]hEPERM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jBhhhMhjubj\)}(hhh]j )}(hThe CEC adapter is not configured, i.e. :ref:`ioctl CEC_ADAP_S_LOG_ADDRS ` has never been called, or ``CEC_MSG_FL_RAW`` was used from a process that did not have the ``CAP_SYS_RAWIO`` capability.h](h(The CEC adapter is not configured, i.e. }(hjhhhNhNubh)}(h8:ref:`ioctl CEC_ADAP_S_LOG_ADDRS `h]jH)}(hj h]hioctl CEC_ADAP_S_LOG_ADDRS}(hj hhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjcec_adap_s_log_addrsuh1hhhhM}hjubh has never been called, or }(hjhhhNhNubj)}(h``CEC_MSG_FL_RAW``h]hCEC_MSG_FL_RAW}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh/ was used from a process that did not have the }(hjhhhNhNubj)}(h``CAP_SYS_RAWIO``h]h CAP_SYS_RAWIO}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh capability.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhM}hjubah}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1j<hhhMhjhhubj=)}(hXYENONET The CEC adapter is not configured, i.e. :ref:`ioctl CEC_ADAP_S_LOG_ADDRS ` was called, but the physical address is invalid so no logical address was claimed. An exception is made in this case for transmits from initiator 0xf ('Unregistered') to destination 0 ('TV'). In that case the transmit will proceed as usual. h](jC)}(hENONETh]hENONET}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1jBhhhMhjcubj\)}(hhh]j )}(hXQThe CEC adapter is not configured, i.e. :ref:`ioctl CEC_ADAP_S_LOG_ADDRS ` was called, but the physical address is invalid so no logical address was claimed. An exception is made in this case for transmits from initiator 0xf ('Unregistered') to destination 0 ('TV'). In that case the transmit will proceed as usual.h](h(The CEC adapter is not configured, i.e. }(hjxhhhNhNubh)}(h8:ref:`ioctl CEC_ADAP_S_LOG_ADDRS `h]jH)}(hjh]hioctl CEC_ADAP_S_LOG_ADDRS}(hjhhhNhNubah}(h]h ](jvstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjcec_adap_s_log_addrsuh1hhhhMhjxubh was called, but the physical address is invalid so no logical address was claimed. An exception is made in this case for transmits from initiator 0xf (‘Unregistered’) to destination 0 (‘TV’). In that case the transmit will proceed as usual.}(hjxhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMhjuubah}(h]h ]h"]h$]h&]uh1j[hjcubeh}(h]h ]h"]h$]h&]uh1j<hhhMhjhhubj=)}(hEBUSY Another filehandle is in exclusive follower or initiator mode, or the filehandle is in mode ``CEC_MODE_NO_INITIATOR``. This is also returned if the transmit queue is full. h](jC)}(hEBUSYh]hEBUSY}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jBhhhMhjubj\)}(hhh]j )}(hAnother filehandle is in exclusive follower or initiator mode, or the filehandle is in mode ``CEC_MODE_NO_INITIATOR``. This is also returned if the transmit queue is full.h](h\Another filehandle is in exclusive follower or initiator mode, or the filehandle is in mode }(hjhhhNhNubj)}(h``CEC_MODE_NO_INITIATOR``h]hCEC_MODE_NO_INITIATOR}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh6. This is also returned if the transmit queue is full.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1j hhhMhjubah}(h]h ]h"]h$]h&]uh1j[hjubeh}(h]h ]h"]h$]h&]uh1j<hhhMhjhhubj=)}(h!ubah}(h]h ]h"]h$]h&]levelKtypejElineMHsourcehuh1j+ubj,)}(hhh]j )}(hhh]h;Hyperlink target "cec-rx-status-timeout" is not referenced.}hj[!sbah}(h]h ]h"]h$]h&]uh1j hjX!ubah}(h]h ]h"]h$]h&]levelKtypejElineMMsourcehuh1j+ubj,)}(hhh]j )}(hhh]h;Hyperlink target "cec-rx-status-timeout" is not referenced.}hju!sbah}(h]h ]h"]h$]h&]uh1j hjr!ubah}(h]h ]h"]h$]h&]levelKtypejElineMMsourcehuh1j+ubj,)}(hhh]j )}(hhh]h;Hyperlink target "cec-rx-status-timeout" is not referenced.}hj!sbah}(h]h ]h"]h$]h&]uh1j hj!ubah}(h]h ]h"]h$]h&]levelKtypejElineMMsourcehuh1j+ubj,)}(hhh]j )}(hhh]hAHyperlink target "cec-rx-status-feature-abort" is not referenced.}hj!sbah}(h]h ]h"]h$]h&]uh1j hj!ubah}(h]h ]h"]h$]h&]levelKtypejElineMRsourcehuh1j+ubj,)}(hhh]j )}(hhh]hAHyperlink target "cec-rx-status-feature-abort" is not referenced.}hj!sbah}(h]h ]h"]h$]h&]uh1j hj!ubah}(h]h ]h"]h$]h&]levelKtypejElineMRsourcehuh1j+ubj,)}(hhh]j )}(hhh]hAHyperlink target "cec-rx-status-feature-abort" is not referenced.}hj!sbah}(h]h ]h"]h$]h&]uh1j hj!ubah}(h]h ]h"]h$]h&]levelKtypejElineMRsourcehuh1j+ubj,)}(hhh]j )}(hhh]h;Hyperlink target "cec-rx-status-aborted" is not referenced.}hj!sbah}(h]h ]h"]h$]h&]uh1j hj!ubah}(h]h ]h"]h$]h&]levelKtypejElineMYsourcehuh1j+ubj,)}(hhh]j )}(hhh]h;Hyperlink target "cec-rx-status-aborted" is not referenced.}hj"sbah}(h]h ]h"]h$]h&]uh1j hj"ubah}(h]h ]h"]h$]h&]levelKtypejElineMYsourcehuh1j+ubj,)}(hhh]j )}(hhh]h;Hyperlink target "cec-rx-status-aborted" is not referenced.}hj+"sbah}(h]h ]h"]h$]h&]uh1j hj("ubah}(h]h ]h"]h$]h&]levelKtypejElineMYsourcehuh1j+ube transformerN include_log] decorationNhhub.