€•®3Œsphinx.addnodes”Œdocument”“”)”}”(Œ rawsource”Œ”Œchildren”]”(Œ translations”Œ LanguagesNode”“”)”}”(hhh]”(hŒ pending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ refdomain”Œstd”Œreftype”Œdoc”Œ reftarget”Œ-/translations/zh_CN/dev-tools/testing-devices”Œmodname”NŒ classname”NŒ refexplicit”ˆuŒtagname”hhh ubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/zh_TW/dev-tools/testing-devices”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/it_IT/dev-tools/testing-devices”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/ja_JP/dev-tools/testing-devices”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/ko_KR/dev-tools/testing-devices”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/pt_BR/dev-tools/testing-devices”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/sp_SP/dev-tools/testing-devices”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h hhŒ _document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…””}”hh·sbah}”(h]”h ]”h"]”h$]”h&]”Œ xml:space”Œpreserve”uh1hµhhh²hh³ŒG/var/lib/git/docbuild/linux/Documentation/dev-tools/testing-devices.rst”h´Kubh¶)”}”(hŒ Copyright (c) 2024 Collabora Ltd”h]”hŒ Copyright (c) 2024 Collabora Ltd”…””}”hhÈsbah}”(h]”h ]”h"]”h$]”h&]”hÅhÆuh1hµhhh²hh³hÇh´KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒDevice testing with kselftest”h]”hŒDevice testing with kselftest”…””}”(hhÝh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛhhØh²hh³hÇh´KubhŒ paragraph”“”)”}”(hŒ½There are a few different kselftests available for testing devices generically, with some overlap in coverage and different requirements. This document aims to give an overview of each one.”h]”hŒ½There are a few different kselftests available for testing devices generically, with some overlap in coverage and different requirements. This document aims to give an overview of each one.”…””}”(hhíh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´K hhØh²hubhì)”}”(hŒ`Note: Paths in this document are relative to the kselftest folder (``tools/testing/selftests``).”h]”(hŒCNote: Paths in this document are relative to the kselftest folder (”…””}”(hhûh²hh³Nh´NubhŒliteral”“”)”}”(hŒ``tools/testing/selftests``”h]”hŒtools/testing/selftests”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jhhûubhŒ).”…””}”(hhûh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´K hhØh²hubhì)”}”(hŒDevice oriented kselftests:”h]”hŒDevice oriented kselftests:”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´KhhØh²hubhŒ bullet_list”“”)”}”(hhh]”(hŒ list_item”“”)”}”(hŒoDevicetree (``dt``) * **Coverage**: Probe status for devices described in Devicetree * **Requirements**: None ”h]”(hì)”}”(hŒDevicetree (``dt``)”h]”(hŒ Devicetree (”…””}”(hj6h²hh³Nh´Nubj)”}”(hŒ``dt``”h]”hŒdt”…””}”(hj>h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj6ubhŒ)”…””}”(hj6h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´Khj2ubj,)”}”(hhh]”(j1)”}”(hŒ>**Coverage**: Probe status for devices described in Devicetree”h]”hì)”}”(hj[h]”(hŒstrong”“”)”}”(hŒ **Coverage**”h]”hŒCoverage”…””}”(hjbh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j`hj]ubhŒ2: Probe status for devices described in Devicetree”…””}”(hj]h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´KhjYubah}”(h]”h ]”h"]”h$]”h&]”uh1j0hjVubj1)”}”(hŒ**Requirements**: None ”h]”hì)”}”(hŒ**Requirements**: None”h]”(ja)”}”(hŒ**Requirements**”h]”hŒ Requirements”…””}”(hjˆh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j`hj„ubhŒ: None”…””}”(hj„h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´Khj€ubah}”(h]”h ]”h"]”h$]”h&]”uh1j0hjVubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ*”uh1j+h³hÇh´Khj2ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j0hj-h²hh³Nh´Nubj1)”}”(hŒ–Error logs (``devices/error_logs``) * **Coverage**: Error (or more critical) log messages presence coming from any device * **Requirements**: None ”h]”(hì)”}”(hŒ#Error logs (``devices/error_logs``)”h]”(hŒ Error logs (”…””}”(hj¸h²hh³Nh´Nubj)”}”(hŒ``devices/error_logs``”h]”hŒdevices/error_logs”…””}”(hjÀh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj¸ubhŒ)”…””}”(hj¸h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´Khj´ubj,)”}”(hhh]”(j1)”}”(hŒS**Coverage**: Error (or more critical) log messages presence coming from any device”h]”hì)”}”(hŒS**Coverage**: Error (or more critical) log messages presence coming from any device”h]”(ja)”}”(hŒ **Coverage**”h]”hŒCoverage”…””}”(hjãh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j`hjßubhŒG: Error (or more critical) log messages presence coming from any device”…””}”(hjßh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´KhjÛubah}”(h]”h ]”h"]”h$]”h&]”uh1j0hjØubj1)”}”(hŒ**Requirements**: None ”h]”hì)”}”(hŒ**Requirements**: None”h]”(ja)”}”(hŒ**Requirements**”h]”hŒ Requirements”…””}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j`hjubhŒ: None”…””}”(hjh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´Khjubah}”(h]”h ]”h"]”h$]”h&]”uh1j0hjØubeh}”(h]”h ]”h"]”h$]”h&]”j¬j­uh1j+h³hÇh´Khj´ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j0hj-h²hh³Nh´Nubj1)”}”(hX?Discoverable bus (``devices/probe``) * **Coverage**: Presence and probe status of USB or PCI devices that have been described in the reference file * **Requirements**: Manually describe the devices that should be tested in a YAML reference file (see ``devices/probe/boards/google,spherion.yaml`` for an example) ”h]”(hì)”}”(hŒ$Discoverable bus (``devices/probe``)”h]”(hŒDiscoverable bus (”…””}”(hj7h²hh³Nh´Nubj)”}”(hŒ``devices/probe``”h]”hŒ devices/probe”…””}”(hj?h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj7ubhŒ)”…””}”(hj7h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´Khj3ubj,)”}”(hhh]”(j1)”}”(hŒl**Coverage**: Presence and probe status of USB or PCI devices that have been described in the reference file”h]”hì)”}”(hŒl**Coverage**: Presence and probe status of USB or PCI devices that have been described in the reference file”h]”(ja)”}”(hŒ **Coverage**”h]”hŒCoverage”…””}”(hjbh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j`hj^ubhŒ`: Presence and probe status of USB or PCI devices that have been described in the reference file”…””}”(hj^h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´KhjZubah}”(h]”h ]”h"]”h$]”h&]”uh1j0hjWubj1)”}”(hŒ¢**Requirements**: Manually describe the devices that should be tested in a YAML reference file (see ``devices/probe/boards/google,spherion.yaml`` for an example) ”h]”hì)”}”(hŒ¡**Requirements**: Manually describe the devices that should be tested in a YAML reference file (see ``devices/probe/boards/google,spherion.yaml`` for an example)”h]”(ja)”}”(hŒ**Requirements**”h]”hŒ Requirements”…””}”(hjˆh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j`hj„ubhŒT: Manually describe the devices that should be tested in a YAML reference file (see ”…””}”(hj„h²hh³Nh´Nubj)”}”(hŒ-``devices/probe/boards/google,spherion.yaml``”h]”hŒ)devices/probe/boards/google,spherion.yaml”…””}”(hjšh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jhj„ubhŒ for an example)”…””}”(hj„h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´K!hj€ubah}”(h]”h ]”h"]”h$]”h&]”uh1j0hjWubeh}”(h]”h ]”h"]”h$]”h&]”j¬j­uh1j+h³hÇh´Khj3ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j0hj-h²hh³Nh´Nubj1)”}”(hŒ¶Exist (``devices/exist``) * **Coverage**: Presence of all devices * **Requirements**: Generate the reference (see ``devices/exist/README.rst`` for details) on a known-good kernel ”h]”(hì)”}”(hŒExist (``devices/exist``)”h]”(hŒExist (”…””}”(hjÈh²hh³Nh´Nubj)”}”(hŒ``devices/exist``”h]”hŒ devices/exist”…””}”(hjÐh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjÈubhŒ)”…””}”(hjÈh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´K%hjÄubj,)”}”(hhh]”(j1)”}”(hŒ%**Coverage**: Presence of all devices”h]”hì)”}”(hjíh]”(ja)”}”(hŒ **Coverage**”h]”hŒCoverage”…””}”(hjòh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j`hjïubhŒ: Presence of all devices”…””}”(hjïh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´K'hjëubah}”(h]”h ]”h"]”h$]”h&]”uh1j0hjèubj1)”}”(hŒo**Requirements**: Generate the reference (see ``devices/exist/README.rst`` for details) on a known-good kernel ”h]”hì)”}”(hŒn**Requirements**: Generate the reference (see ``devices/exist/README.rst`` for details) on a known-good kernel”h]”(ja)”}”(hŒ**Requirements**”h]”hŒ Requirements”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j`hjubhŒ: Generate the reference (see ”…””}”(hjh²hh³Nh´Nubj)”}”(hŒ``devices/exist/README.rst``”h]”hŒdevices/exist/README.rst”…””}”(hj*h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubhŒ$ for details) on a known-good kernel”…””}”(hjh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´K(hjubah}”(h]”h ]”h"]”h$]”h&]”uh1j0hjèubeh}”(h]”h ]”h"]”h$]”h&]”j¬j­uh1j+h³hÇh´K'hjÄubeh}”(h]”h ]”h"]”h$]”h&]”uh1j0hj-h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”j¬j­uh1j+h³hÇh´KhhØh²hubhì)”}”(hX‚Therefore, the suggestion is to enable the error log and devicetree tests on all (DT-based) platforms, since they don't have any requirements. Then to greatly improve coverage, generate the reference for each platform and enable the exist test. The discoverable bus test can be used to verify the probe status of specific USB or PCI devices, but is probably not worth it for most cases.”h]”hX„Therefore, the suggestion is to enable the error log and devicetree tests on all (DT-based) platforms, since they don’t have any requirements. Then to greatly improve coverage, generate the reference for each platform and enable the exist test. The discoverable bus test can be used to verify the probe status of specific USB or PCI devices, but is probably not worth it for most cases.”…””}”(hjZh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hëh³hÇh´K+hhØh²hubeh}”(h]”Œdevice-testing-with-kselftest”ah ]”h"]”Œdevice testing with kselftest”ah$]”h&]”uh1hÖhhh²hh³hÇh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÇuh1hŒcurrent_source”NŒ current_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hÛNŒ generator”NŒ datestamp”NŒ source_link”NŒ source_url”NŒ toc_backlinks”Œentry”Œfootnote_backlinks”KŒ sectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒ strip_classes”NŒ report_level”KŒ halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ traceback”ˆŒinput_encoding”Œ utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j“Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œ language_code”Œen”Œrecord_dependencies”NŒconfig”NŒ id_prefix”hŒauto_id_prefix”Œid”Œ dump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÇŒ _destination”NŒ _config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒ raw_enabled”KŒline_length_limit”M'Œpep_references”NŒ pep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒ rfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œ smart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œ docinfo_xform”KŒsectsubtitle_xform”‰Œ image_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”jmjjsŒ nametypes”}”jm‰sh}”jjhØsŒ footnote_refs”}”Œ citation_refs”}”Œ autofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ footnotes”]”Œ citations”]”Œautofootnote_start”KŒsymbol_footnote_start”KŒ id_counter”Œ collections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œ transformer”NŒ include_log”]”Œ decoration”Nh²hub.