ssphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftargetH/translations/zh_CN/userspace-api/media/mediactl/media-ioc-enum-entitiesmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetH/translations/zh_TW/userspace-api/media/mediactl/media-ioc-enum-entitiesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetH/translations/it_IT/userspace-api/media/mediactl/media-ioc-enum-entitiesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetH/translations/ja_JP/userspace-api/media/mediactl/media-ioc-enum-entitiesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetH/translations/ko_KR/userspace-api/media/mediactl/media-ioc-enum-entitiesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetH/translations/pt_BR/userspace-api/media/mediactl/media-ioc-enum-entitiesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetH/translations/sp_SP/userspace-api/media/mediactl/media-ioc-enum-entitiesmodnameN 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:spacepreserveuh1hhhhhhb/var/lib/git/docbuild/linux/Documentation/userspace-api/media/mediactl/media-ioc-enum-entities.rsthKubhtarget)}(h.. _media_ioc_enum_entities:h]h}(h]h ]h"]h$]h&]refidmedia-ioc-enum-entitiesuh1hhKhhhhhhubhsection)}(hhh](htitle)}(hioctl MEDIA_IOC_ENUM_ENTITIESh]hioctl MEDIA_IOC_ENUM_ENTITIES}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hNameh]hName}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhK ubh paragraph)}(hAMEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their propertiesh]hAMEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their properties}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubeh}(h]nameah ]h"]nameah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hSynopsish]hSynopsis}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](single$MC.MEDIA_IOC_ENUM_ENTITIES (C macro)c.MC.MEDIA_IOC_ENUM_ENTITIEShNtauh1j%hjhhhNhNubhdesc)}(hhh](hdesc_signature)}(hMEDIA_IOC_ENUM_ENTITIESh]hdesc_signature_line)}(hMEDIA_IOC_ENUM_ENTITIESh]h desc_name)}(hMEDIA_IOC_ENUM_ENTITIESh]h desc_sig_name)}(hj?h]hMEDIA_IOC_ENUM_ENTITIES}(hjOhhhNhNubah}(h]h ]nah"]h$]h&]uh1jMhjIubah}(h]h ](sig-namedescnameeh"]h$]h&]hhuh1jGhjChhhhhKubah}(h]h ]h"]h$]h&]hhƌ add_permalinkuh1jAsphinx_line_type declaratorhj=hhhhhKubah}(h]j4ah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1j;hhhKhj8hhubh desc_content)}(hhh]h}(h]h ]h"]h$]h&]uh1jyhj8hhhhhKubeh}(h]h ](cmacroeh"]h$]h&]domainjobjtypejdesctypejnoindex noindexentrynocontentsentryuh1j6hhhjhNhNubh)}(hN``int ioctl(int fd, MEDIA_IOC_ENUM_ENTITIES, struct media_entity_desc *argp)``h]hliteral)}(hjh]hJint ioctl(int fd, MEDIA_IOC_ENUM_ENTITIES, struct media_entity_desc *argp)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]synopsisah ]h"]synopsisah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Argumentsh]h Arguments}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubhdefinition_list)}(hhh](hdefinition_list_item)}(h5``fd`` File descriptor returned by :c:func:`open()`. h](hterm)}(h``fd``h]j)}(hjh]hfd}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubh definition)}(hhh]h)}(h-File descriptor returned by :c:func:`open()`.h](hFile descriptor returned by }(hjhhhNhNubh)}(h:c:func:`open()`h]j)}(hjh]hopen()}(hjhhhNhNubah}(h]h ](xrefjc-funceh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdoc4userspace-api/media/mediactl/media-ioc-enum-entities refdomainjreftypefunc refexplicitrefwarn c:parent_keysphinx.domains.c LookupKey)}data]j ASTIdentifier)} identifierMCsbNasb reftargetopenuh1hhhhKhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h8``argp`` Pointer to struct :c:type:`media_entity_desc`. h](j)}(h``argp``h]j)}(hjBh]hargp}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]uh1jhhhKhj<ubj)}(hhh]h)}(h.Pointer to struct :c:type:`media_entity_desc`.h](hPointer to struct }(hjZhhhNhNubh)}(h:c:type:`media_entity_desc`h]j)}(hjdh]hmedia_entity_desc}(hjfhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjj$media_entity_descuh1hhhhKhjZubh.}(hjZhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjWubah}(h]h ]h"]h$]h&]uh1jhj<ubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubeh}(h]h ]h"]h$]h&]uh1jhjhhhhhNubeh}(h] argumentsah ]h"] argumentsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK ubh)}(hX%To query the attributes of an entity, applications set the id field of a struct :c:type:`media_entity_desc` structure and call the MEDIA_IOC_ENUM_ENTITIES ioctl with a pointer to this structure. The driver fills the rest of the structure or returns an EINVAL error code when the id is invalid.h](hPTo query the attributes of an entity, applications set the id field of a struct }(hjhhhNhNubh)}(h:c:type:`media_entity_desc`h]j)}(hjh]hmedia_entity_desc}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjj$media_entity_descuh1hhhhK"hjubh structure and call the MEDIA_IOC_ENUM_ENTITIES ioctl with a pointer to this structure. The driver fills the rest of the structure or returns an EINVAL error code when the id is invalid.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK"hjhhubh)}(h.. _media-ent-id-flag-next:h]h}(h]h ]h"]h$]h&]hԌmedia-ent-id-flag-nextuh1hhK(hjhhhhubh)}(hXEntities can be enumerated by or'ing the id with the ``MEDIA_ENT_ID_FLAG_NEXT`` flag. The driver will return information about the entity with the smallest id strictly larger than the requested one ('next entity'), or the ``EINVAL`` error code if there is none.h](h7Entities can be enumerated by or’ing the id with the }(hjhhhNhNubj)}(h``MEDIA_ENT_ID_FLAG_NEXT``h]hMEDIA_ENT_ID_FLAG_NEXT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh flag. The driver will return information about the entity with the smallest id strictly larger than the requested one (‘next entity’), or the }(hjhhhNhNubj)}(h ``EINVAL``h]hEINVAL}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh error code if there is none.}(hjhhhNhNubeh}(h]jah ]h"]media-ent-id-flag-nextah$]h&]uh1hhhhK*hjhhexpect_referenced_by_name}j"jsexpect_referenced_by_id}jjsubh)}(hEntity IDs can be non-contiguous. Applications must *not* try to enumerate entities by calling MEDIA_IOC_ENUM_ENTITIES with increasing id's until they get an error.h](h4Entity IDs can be non-contiguous. Applications must }(hj)hhhNhNubhemphasis)}(h*not*h]hnot}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j1hj)ubhm try to enumerate entities by calling MEDIA_IOC_ENUM_ENTITIES with increasing id’s until they get an error.}(hj)hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK/hjhhubj&)}(hhh]h}(h]h ]h"]h$]h&]entries](j2MC.media_entity_desc (C type)c.MC.media_entity_deschNtauh1j%hjhhhNhNubj7)}(hhh](j<)}(hmedia_entity_desch]jB)}(htype media_entity_desch](hdesc_sig_keyword)}(htypeh]htype}(hjfhhhNhNubah}(h]h ]kah"]h$]h&]uh1jdhj`hhhhhK3ubhdesc_sig_space)}(h h]h }(hjwhhhNhNubah}(h]h ]wah"]h$]h&]uh1juhj`hhhhhK3ubjH)}(hmedia_entity_desch]jN)}(hj^h]hmedia_entity_desc}(hjhhhNhNubah}(h]h ]jYah"]h$]h&]uh1jMhjubah}(h]h ](j`jaeh"]h$]h&]hhuh1jGhj`hhhhhK3ubeh}(h]h ]h"]h$]h&]hhjkuh1jAjljmhj\hhhhhK3ubah}(h]jWah ](jqjreh"]h$]h&]jvjw)jxhuh1j;hhhK3hjYhhubjz)}(hhh]h}(h]h ]h"]h$]h&]uh1jyhjYhhhhhK3ubeh}(h]h ](jtypeeh"]h$]h&]jjjjjjjjjuh1j6hhhjhNhNubhtabular_col_spec)}(hhh]h}(h]h ]h"]h$]h&]spec/|p{1.5cm}|p{1.7cm}|p{1.6cm}|p{1.5cm}|p{10.6cm}|uh1jhhhK5hjhhubhtable)}(hhh](h)}(hstruct media_entity_desch]hstruct media_entity_desc}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK7hjubhtgroup)}(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&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubhtbody)}(hhh](hrow)}(hhh](hentry)}(hhh]h)}(h__u32h]h__u32}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK` chapter.h](h.On success 0 is returned, on error -1 and the }(hj hhhNhNubj)}(h ``errno``h]herrno}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubhM variable is set appropriately. The generic error codes are described at the }(hj hhhNhNubh)}(h':ref:`Generic Error Codes `h]j;)}(hj h]hGeneric Error Codes}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j:hj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnj$ gen-errorsuh1hhhhKhj ubh chapter.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj hhubj)}(hhh]j)}(hVEINVAL The struct :c:type:`media_entity_desc` ``id`` references a non-existing entity.h](j)}(hEINVALh]hEINVAL}(hj# hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj ubj)}(hhh]h)}(hOThe struct :c:type:`media_entity_desc` ``id`` references a non-existing entity.h](h The struct }(hj4 hhhNhNubh)}(h:c:type:`media_entity_desc`h]j)}(hj> h]hmedia_entity_desc}(hj@ hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj< ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjj$media_entity_descuh1hhhhKhj4 ubh }(hj4 hhhNhNubj)}(h``id``h]hid}(hj_ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4 ubh" references a non-existing entity.}(hj4 hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj1 ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj hhhhhNubeh}(h] return-valueah ]h"] return valueah$]h&]uh1hhhhhhhhKubeh}(h](ioctl-media-ioc-enum-entitiesheh ]h"](ioctl media_ioc_enum_entitiesmedia_ioc_enum_entitieseh$]h&]uh1hhhhhhhhKj%}j hsj'}hhsubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksjfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehnj _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}(h]haj]jaunameids}(j hj j jjjjjjj j j"jj j u nametypes}(j j jjjj j"j uh}(hhj hjhjjj4j=jjj jjjjWj\j j j ju footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}j KsRparse_messages]hsystem_message)}(hhh]h)}(heUnexpected possible title overline or transition. Treating it as ordinary text because it's so short.h]hgUnexpected possible title overline or transition. Treating it as ordinary text because it’s so short.}(hj' hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$ ubah}(h]h ]h"]h$]h&]levelKtypeINFOlineKsourcehuh1j" hj ubatransform_messages](j# )}(hhh]h)}(hhh]h=Hyperlink target "media-ioc-enum-entities" is not referenced.}hjE sbah}(h]h ]h"]h$]h&]uh1hhjB ubah}(h]h ]h"]h$]h&]levelKtypej= sourcehnjlineKuh1j" ubj# )}(hhh]h)}(hhh]h