€•«2Œ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Œ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”…””}”(hhñhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hïhhç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:”…””}”(hj hž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 (”…””}”(hj"hžhhŸNh Nubhð)”}”(hŒ``dt``”h]”hŒdt”…””}”(hj*hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hïhj"ubhŒ)”…””}”(hj"hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h×hŸh³h Khjubj)”}”(hhh]”(j)”}”(hŒ>**Coverage**: Probe status for devices described in Devicetree”h]”hØ)”}”(hjGh]”(hŒstrong”“”)”}”(hŒ **Coverage**”h]”hŒCoverage”…””}”(hjNhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jLhjIubhŒ2: Probe status for devices described in Devicetree”…””}”(hjIhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h×hŸh³h KhjEubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjBubj)”}”(hŒ**Requirements**: None ”h]”hØ)”}”(hŒ**Requirements**: None”h]”(jM)”}”(hŒ**Requirements**”h]”hŒ Requirements”…””}”(hjthžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jLhjpubhŒ: None”…””}”(hjphžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h×hŸh³h Khjlubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjBubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ*”uh1jhŸh³h Khjubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjhžhhŸNh Nubj)”}”(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 Nubhð)”}”(hŒ``devices/error_logs``”h]”hŒdevices/error_logs”…””}”(hj¬hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hïhj¤ubhŒ)”…””}”(hj¤hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h×hŸh³h Khj ubj)”}”(hhh]”(j)”}”(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]”(jM)”}”(hŒ **Coverage**”h]”hŒCoverage”…””}”(hjÏhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jLhjË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&]”uh1jhjÄubj)”}”(hŒ**Requirements**: None ”h]”hØ)”}”(hŒ**Requirements**: None”h]”(jM)”}”(hŒ**Requirements**”h]”hŒ Requirements”…””}”(hjõhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jLhjñubhŒ: None”…””}”(hjñhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h×hŸh³h Khjíubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjÄubeh}”(h]”h ]”h"]”h$]”h&]”j˜j™uh1jhŸh³h Khj ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjhžhhŸNh Nubj)”}”(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 (”…””}”(hj#hžhhŸNh Nubhð)”}”(hŒ``devices/probe``”h]”hŒ devices/probe”…””}”(hj+hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hïhj#ubhŒ)”…””}”(hj#hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h×hŸh³h Khjubj)”}”(hhh]”(j)”}”(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]”(jM)”}”(hŒ **Coverage**”h]”hŒCoverage”…””}”(hjNhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jLhjJubhŒ`: Presence and probe status of USB or PCI devices that have been described in the reference file”…””}”(hjJhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h×hŸh³h KhjFubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjCubj)”}”(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]”(jM)”}”(hŒ**Requirements**”h]”hŒ Requirements”…””}”(hjthžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jLhjpubhŒT: Manually describe the devices that should be tested in a YAML reference file (see ”…””}”(hjphžhhŸNh Nubhð)”}”(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&]”uh1hïhjpubhŒ for an example)”…””}”(hjphžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h×hŸh³h K!hjlubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjCubeh}”(h]”h ]”h"]”h$]”h&]”j˜j™uh1jhŸh³h Khjubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjhžhhŸNh Nubj)”}”(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 Nubhð)”}”(hŒ``devices/exist``”h]”hŒ devices/exist”…””}”(hj¼hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hïhj´ubhŒ)”…””}”(hj´hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h×hŸh³h K%hj°ubj)”}”(hhh]”(j)”}”(hŒ%**Coverage**: Presence of all devices”h]”hØ)”}”(hjÙh]”(jM)”}”(hŒ **Coverage**”h]”hŒCoverage”…””}”(hjÞhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jLhjÛ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&]”uh1jhjÔubj)”}”(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]”(jM)”}”(hŒ**Requirements**”h]”hŒ Requirements”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jLhjubhŒ: Generate the reference (see ”…””}”(hjhžhhŸNh Nubhð)”}”(hŒ``devices/exist/README.rst``”h]”hŒdevices/exist/README.rst”…””}”(hjhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hïhjubhŒ$ for details) on a known-good kernel”…””}”(hjhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h×hŸh³h K(hjüubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjÔubeh}”(h]”h ]”h"]”h$]”h&]”j˜j™uh1jhŸh³h K'hj°ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”j˜j™uh1jhŸ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.”…””}”(hjFhž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”}”jYjVsŒ nametypes”}”jY‰sh}”jVhÄ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.