€•_Œsphinx.addnodes”Œdocument”“”)”}”(Œ rawsource”Œ”Œchildren”]”(Œdocutils.nodes”Œsubstitution_definition”“”)”}”(hŒ&.. |AArch32| replace:: :term:`AArch32`”h]”hŒpending_xref”“”)”}”(hŒ:term:`AArch32`”h]”h Œinline”“”)”}”(hhh]”h ŒText”“”ŒAArch32”…””}”(hhŒparent”hubaŒ attributes”}”(Œids”]”Œclasses”]”(Œxref”Œstd”Œstd-term”eŒnames”]”Œdupnames”]”Œbackrefs”]”uŒtagname”hh!hubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”Œprocess/coding-guidelines”Œ refdomain”h)Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆŒ reftarget”ŒAArch32”uh1hŒsource”Œ”Œline”Kh!hubah"}”(h$]”h&]”h+]”ŒAArch32”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ&.. |AArch64| replace:: :term:`AArch64`”h]”h)”}”(hŒ:term:`AArch64`”h]”h)”}”(hhQh]”hŒAArch64”…””}”(hhh!hSubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!hOubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”h]Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒAArch64”uh1hhAhBhCKh!hKubah"}”(h$]”h&]”h+]”ŒAArch64”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |AMU| replace:: :term:`AMU`”h]”h)”}”(hŒ:term:`AMU`”h]”h)”}”(hh|h]”hŒAMU”…””}”(hhh!h~ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!hzubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”hˆŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒAMU”uh1hhAhBhCKh!hvubah"}”(h$]”h&]”h+]”ŒAMU”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ&.. |AMUs| replace:: :term:`AMUs `”h]”h)”}”(hŒ:term:`AMUs `”h]”h)”}”(hh§h]”hŒAMUs”…””}”(hhh!h©ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!h¥ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”h³Œreftype”Œterm”Œrefexplicit”ˆŒrefwarn”ˆh?ŒAMU”uh1hhAhBhCKh!h¡ubah"}”(h$]”h&]”h+]”ŒAMUs”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |API| replace:: :term:`API`”h]”h)”}”(hŒ:term:`API`”h]”h)”}”(hhÒh]”hŒAPI”…””}”(hhh!hÔubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!hÐubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”hÞŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒAPI”uh1hhAhBhCKh!hÌubah"}”(h$]”h&]”h+]”ŒAPI”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |BTI| replace:: :term:`BTI`”h]”h)”}”(hŒ:term:`BTI`”h]”h)”}”(hhýh]”hŒBTI”…””}”(hhh!hÿubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!hûubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒBTI”uh1hhAhBhCKh!h÷ubah"}”(h$]”h&]”h+]”ŒBTI”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |CoT| replace:: :term:`CoT`”h]”h)”}”(hŒ:term:`CoT`”h]”h)”}”(hj(h]”hŒCoT”…””}”(hhh!j*ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j&ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j4Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒCoT”uh1hhAhBhCKh!j"ubah"}”(h$]”h&]”h+]”ŒCoT”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |COT| replace:: :term:`COT`”h]”h)”}”(hŒ:term:`COT`”h]”h)”}”(hjSh]”hŒCOT”…””}”(hhh!jUubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jQubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j_Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒCOT”uh1hhAhBhCKh!jMubah"}”(h$]”h&]”h+]”ŒCOT”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |CSS| replace:: :term:`CSS`”h]”h)”}”(hŒ:term:`CSS`”h]”h)”}”(hj~h]”hŒCSS”…””}”(hhh!j€ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j|ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŠŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒCSS”uh1hhAhBhCK h!jxubah"}”(h$]”h&]”h+]”ŒCSS”ah-]”h/]”uh1h hAhBhCK h!hhhubh)”}”(hŒ.. |CVE| replace:: :term:`CVE`”h]”h)”}”(hŒ:term:`CVE`”h]”h)”}”(hj©h]”hŒCVE”…””}”(hhh!j«ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j§ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jµŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒCVE”uh1hhAhBhCK h!j£ubah"}”(h$]”h&]”h+]”ŒCVE”ah-]”h/]”uh1h hAhBhCK h!hhhubh)”}”(hŒ.. |DTB| replace:: :term:`DTB`”h]”h)”}”(hŒ:term:`DTB`”h]”h)”}”(hjÔh]”hŒDTB”…””}”(hhh!jÖubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jÒubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jàŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒDTB”uh1hhAhBhCKh!jÎubah"}”(h$]”h&]”h+]”ŒDTB”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ .. |DS-5| replace:: :term:`DS-5`”h]”h)”}”(hŒ:term:`DS-5`”h]”h)”}”(hjÿh]”hŒDS-5”…””}”(hhh!jubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jýubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒDS-5”uh1hhAhBhCKh!jùubah"}”(h$]”h&]”h+]”ŒDS-5”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |DSU| replace:: :term:`DSU`”h]”h)”}”(hŒ:term:`DSU`”h]”h)”}”(hj*h]”hŒDSU”…””}”(hhh!j,ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j(ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j6Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒDSU”uh1hhAhBhCK h!j$ubah"}”(h$]”h&]”h+]”ŒDSU”ah-]”h/]”uh1h hAhBhCK h!hhhubh)”}”(hŒ.. |DT| replace:: :term:`DT`”h]”h)”}”(hŒ :term:`DT`”h]”h)”}”(hjUh]”hŒDT”…””}”(hhh!jWubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jSubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jaŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒDT”uh1hhAhBhCKh!jOubah"}”(h$]”h&]”h+]”ŒDT”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |EL| replace:: :term:`EL`”h]”h)”}”(hŒ :term:`EL`”h]”h)”}”(hj€h]”hŒEL”…””}”(hhh!j‚ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j~ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŒŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒEL”uh1hhAhBhCKh!jzubah"}”(h$]”h&]”h+]”ŒEL”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |EHF| replace:: :term:`EHF`”h]”h)”}”(hŒ:term:`EHF`”h]”h)”}”(hj«h]”hŒEHF”…””}”(hhh!jubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j©ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j·Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒEHF”uh1hhAhBhCKh!j¥ubah"}”(h$]”h&]”h+]”ŒEHF”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ".. |FCONF| replace:: :term:`FCONF`”h]”h)”}”(hŒ :term:`FCONF`”h]”h)”}”(hjÖh]”hŒFCONF”…””}”(hhh!jØubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jÔubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jâŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒFCONF”uh1hhAhBhCKh!jÐubah"}”(h$]”h&]”h+]”ŒFCONF”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |FDT| replace:: :term:`FDT`”h]”h)”}”(hŒ:term:`FDT`”h]”h)”}”(hjh]”hŒFDT”…””}”(hhh!jubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jÿubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒFDT”uh1hhAhBhCKh!jûubah"}”(h$]”h&]”h+]”ŒFDT”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ .. |FF-A| replace:: :term:`FF-A`”h]”h)”}”(hŒ:term:`FF-A`”h]”h)”}”(hj,h]”hŒFF-A”…””}”(hhh!j.ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j*ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j8Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒFF-A”uh1hhAhBhCKh!j&ubah"}”(h$]”h&]”h+]”ŒFF-A”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |FIP| replace:: :term:`FIP`”h]”h)”}”(hŒ:term:`FIP`”h]”h)”}”(hjWh]”hŒFIP”…””}”(hhh!jYubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jUubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jcŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒFIP”uh1hhAhBhCKh!jQubah"}”(h$]”h&]”h+]”ŒFIP”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |FVP| replace:: :term:`FVP`”h]”h)”}”(hŒ:term:`FVP`”h]”h)”}”(hj‚h]”hŒFVP”…””}”(hhh!j„ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j€ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŽŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒFVP”uh1hhAhBhCKh!j|ubah"}”(h$]”h&]”h+]”ŒFVP”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |FWU| replace:: :term:`FWU`”h]”h)”}”(hŒ:term:`FWU`”h]”h)”}”(hjh]”hŒFWU”…””}”(hhh!j¯ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j«ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j¹Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒFWU”uh1hhAhBhCKh!j§ubah"}”(h$]”h&]”h+]”ŒFWU”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |GIC| replace:: :term:`GIC`”h]”h)”}”(hŒ:term:`GIC`”h]”h)”}”(hjØh]”hŒGIC”…””}”(hhh!jÚubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jÖubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jäŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒGIC”uh1hhAhBhCKh!jÒubah"}”(h$]”h&]”h+]”ŒGIC”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |ISA| replace:: :term:`ISA`”h]”h)”}”(hŒ:term:`ISA`”h]”h)”}”(hjh]”hŒISA”…””}”(hhh!jubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒISA”uh1hhAhBhCKh!jýubah"}”(h$]”h&]”h+]”ŒISA”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ$.. |Linaro| replace:: :term:`Linaro`”h]”h)”}”(hŒ:term:`Linaro`”h]”h)”}”(hj.h]”hŒLinaro”…””}”(hhh!j0ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j,ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j:Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒLinaro”uh1hhAhBhCKh!j(ubah"}”(h$]”h&]”h+]”ŒLinaro”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |MMU| replace:: :term:`MMU`”h]”h)”}”(hŒ:term:`MMU`”h]”h)”}”(hjYh]”hŒMMU”…””}”(hhh!j[ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jWubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jeŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒMMU”uh1hhAhBhCKh!jSubah"}”(h$]”h&]”h+]”ŒMMU”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ .. |MPAM| replace:: :term:`MPAM`”h]”h)”}”(hŒ:term:`MPAM`”h]”h)”}”(hj„h]”hŒMPAM”…””}”(hhh!j†ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j‚ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒMPAM”uh1hhAhBhCKh!j~ubah"}”(h$]”h&]”h+]”ŒMPAM”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ .. |MPMM| replace:: :term:`MPMM`”h]”h)”}”(hŒ:term:`MPMM`”h]”h)”}”(hj¯h]”hŒMPMM”…””}”(hhh!j±ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j»Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒMPMM”uh1hhAhBhCKh!j©ubah"}”(h$]”h&]”h+]”ŒMPMM”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ".. |MPIDR| replace:: :term:`MPIDR`”h]”h)”}”(hŒ :term:`MPIDR`”h]”h)”}”(hjÚh]”hŒMPIDR”…””}”(hhh!jÜubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jØubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jæŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒMPIDR”uh1hhAhBhCKh!jÔubah"}”(h$]”h&]”h+]”ŒMPIDR”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |MTE| replace:: :term:`MTE`”h]”h)”}”(hŒ:term:`MTE`”h]”h)”}”(hjh]”hŒMTE”…””}”(hhh!jubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒMTE”uh1hhAhBhCKh!jÿubah"}”(h$]”h&]”h+]”ŒMTE”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ.. |OEN| replace:: :term:`OEN`”h]”h)”}”(hŒ:term:`OEN`”h]”h)”}”(hj0h]”hŒOEN”…””}”(hhh!j2ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j.ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j<Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒOEN”uh1hhAhBhCKh!j*ubah"}”(h$]”h&]”h+]”ŒOEN”ah-]”h/]”uh1h hAhBhCKh!hhhubh)”}”(hŒ$.. |OP-TEE| replace:: :term:`OP-TEE`”h]”h)”}”(hŒ:term:`OP-TEE`”h]”h)”}”(hj[h]”hŒOP-TEE”…””}”(hhh!j]ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jYubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jgŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒOP-TEE”uh1hhAhBhCK h!jUubah"}”(h$]”h&]”h+]”ŒOP-TEE”ah-]”h/]”uh1h hAhBhCK h!hhhubh)”}”(hŒ.. |OTE| replace:: :term:`OTE`”h]”h)”}”(hŒ:term:`OTE`”h]”h)”}”(hj†h]”hŒOTE”…””}”(hhh!jˆubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j„ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j’Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒOTE”uh1hhAhBhCK!h!j€ubah"}”(h$]”h&]”h+]”ŒOTE”ah-]”h/]”uh1h hAhBhCK!h!hhhubh)”}”(hŒ.. |PDD| replace:: :term:`PDD`”h]”h)”}”(hŒ:term:`PDD`”h]”h)”}”(hj±h]”hŒPDD”…””}”(hhh!j³ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j¯ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j½Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒPDD”uh1hhAhBhCK"h!j«ubah"}”(h$]”h&]”h+]”ŒPDD”ah-]”h/]”uh1h hAhBhCK"h!hhhubh)”}”(hŒ".. |PAUTH| replace:: :term:`PAUTH`”h]”h)”}”(hŒ :term:`PAUTH`”h]”h)”}”(hjÜh]”hŒPAUTH”…””}”(hhh!jÞubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jÚubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jèŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒPAUTH”uh1hhAhBhCK#h!jÖubah"}”(h$]”h&]”h+]”ŒPAUTH”ah-]”h/]”uh1h hAhBhCK#h!hhhubh)”}”(hŒ.. |PMF| replace:: :term:`PMF`”h]”h)”}”(hŒ:term:`PMF`”h]”h)”}”(hjh]”hŒPMF”…””}”(hhh!j ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒPMF”uh1hhAhBhCK$h!jubah"}”(h$]”h&]”h+]”ŒPMF”ah-]”h/]”uh1h hAhBhCK$h!hhhubh)”}”(hŒ .. |PSCI| replace:: :term:`PSCI`”h]”h)”}”(hŒ:term:`PSCI`”h]”h)”}”(hj2h]”hŒPSCI”…””}”(hhh!j4ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j0ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j>Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒPSCI”uh1hhAhBhCK%h!j,ubah"}”(h$]”h&]”h+]”ŒPSCI”ah-]”h/]”uh1h hAhBhCK%h!hhhubh)”}”(hŒ.. |RAS| replace:: :term:`RAS`”h]”h)”}”(hŒ:term:`RAS`”h]”h)”}”(hj]h]”hŒRAS”…””}”(hhh!j_ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j[ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jiŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒRAS”uh1hhAhBhCK&h!jWubah"}”(h$]”h&]”h+]”ŒRAS”ah-]”h/]”uh1h hAhBhCK&h!hhhubh)”}”(hŒ.. |ROT| replace:: :term:`ROT`”h]”h)”}”(hŒ:term:`ROT`”h]”h)”}”(hjˆh]”hŒROT”…””}”(hhh!jŠubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j†ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j”Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒROT”uh1hhAhBhCK'h!j‚ubah"}”(h$]”h&]”h+]”ŒROT”ah-]”h/]”uh1h hAhBhCK'h!hhhubh)”}”(hŒ .. |SCMI| replace:: :term:`SCMI`”h]”h)”}”(hŒ:term:`SCMI`”h]”h)”}”(hj³h]”hŒSCMI”…””}”(hhh!jµubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j±ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j¿Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSCMI”uh1hhAhBhCK(h!jubah"}”(h$]”h&]”h+]”ŒSCMI”ah-]”h/]”uh1h hAhBhCK(h!hhhubh)”}”(hŒ.. |SCP| replace:: :term:`SCP`”h]”h)”}”(hŒ:term:`SCP`”h]”h)”}”(hjÞh]”hŒSCP”…””}”(hhh!jàubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jÜubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jêŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSCP”uh1hhAhBhCK)h!jØubah"}”(h$]”h&]”h+]”ŒSCP”ah-]”h/]”uh1h hAhBhCK)h!hhhubh)”}”(hŒ .. |SDEI| replace:: :term:`SDEI`”h]”h)”}”(hŒ:term:`SDEI`”h]”h)”}”(hj h]”hŒSDEI”…””}”(hhh!jubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSDEI”uh1hhAhBhCK*h!jubah"}”(h$]”h&]”h+]”ŒSDEI”ah-]”h/]”uh1h hAhBhCK*h!hhhubh)”}”(hŒ.. |SDS| replace:: :term:`SDS`”h]”h)”}”(hŒ:term:`SDS`”h]”h)”}”(hj4h]”hŒSDS”…””}”(hhh!j6ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j2ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j@Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSDS”uh1hhAhBhCK+h!j.ubah"}”(h$]”h&]”h+]”ŒSDS”ah-]”h/]”uh1h hAhBhCK+h!hhhubh)”}”(hŒ.. |SEA| replace:: :term:`SEA`”h]”h)”}”(hŒ:term:`SEA`”h]”h)”}”(hj_h]”hŒSEA”…””}”(hhh!jaubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j]ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jkŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSEA”uh1hhAhBhCK,h!jYubah"}”(h$]”h&]”h+]”ŒSEA”ah-]”h/]”uh1h hAhBhCK,h!hhhubh)”}”(hŒ.. |SiP| replace:: :term:`SiP`”h]”h)”}”(hŒ:term:`SiP`”h]”h)”}”(hjŠh]”hŒSiP”…””}”(hhh!jŒubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jˆubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j–Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSiP”uh1hhAhBhCK-h!j„ubah"}”(h$]”h&]”h+]”ŒSiP”ah-]”h/]”uh1h hAhBhCK-h!hhhubh)”}”(hŒ.. |SIP| replace:: :term:`SIP`”h]”h)”}”(hŒ:term:`SIP`”h]”h)”}”(hjµh]”hŒSIP”…””}”(hhh!j·ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j³ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jÁŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSIP”uh1hhAhBhCK.h!j¯ubah"}”(h$]”h&]”h+]”ŒSIP”ah-]”h/]”uh1h hAhBhCK.h!hhhubh)”}”(hŒ.. |SMC| replace:: :term:`SMC`”h]”h)”}”(hŒ:term:`SMC`”h]”h)”}”(hjàh]”hŒSMC”…””}”(hhh!jâubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jÞubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jìŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSMC”uh1hhAhBhCK/h!jÚubah"}”(h$]”h&]”h+]”ŒSMC”ah-]”h/]”uh1h hAhBhCK/h!hhhubh)”}”(hŒ".. |SMCCC| replace:: :term:`SMCCC`”h]”h)”}”(hŒ :term:`SMCCC`”h]”h)”}”(hjh]”hŒSMCCC”…””}”(hhh!j ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSMCCC”uh1hhAhBhCK0h!jubah"}”(h$]”h&]”h+]”ŒSMCCC”ah-]”h/]”uh1h hAhBhCK0h!hhhubh)”}”(hŒ.. |SoC| replace:: :term:`SoC`”h]”h)”}”(hŒ:term:`SoC`”h]”h)”}”(hj6h]”hŒSoC”…””}”(hhh!j8ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j4ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jBŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSoC”uh1hhAhBhCK1h!j0ubah"}”(h$]”h&]”h+]”ŒSoC”ah-]”h/]”uh1h hAhBhCK1h!hhhubh)”}”(hŒ.. |SP| replace:: :term:`SP`”h]”h)”}”(hŒ :term:`SP`”h]”h)”}”(hjah]”hŒSP”…””}”(hhh!jcubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j_ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jmŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSP”uh1hhAhBhCK2h!j[ubah"}”(h$]”h&]”h+]”ŒSP”ah-]”h/]”uh1h hAhBhCK2h!hhhubh)”}”(hŒ.. |SPD| replace:: :term:`SPD`”h]”h)”}”(hŒ:term:`SPD`”h]”h)”}”(hjŒh]”hŒSPD”…””}”(hhh!jŽubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jŠubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j˜Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSPD”uh1hhAhBhCK3h!j†ubah"}”(h$]”h&]”h+]”ŒSPD”ah-]”h/]”uh1h hAhBhCK3h!hhhubh)”}”(hŒ.. |SPM| replace:: :term:`SPM`”h]”h)”}”(hŒ:term:`SPM`”h]”h)”}”(hj·h]”hŒSPM”…””}”(hhh!j¹ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jµubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jÃŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSPM”uh1hhAhBhCK4h!j±ubah"}”(h$]”h&]”h+]”ŒSPM”ah-]”h/]”uh1h hAhBhCK4h!hhhubh)”}”(hŒ .. |SSBS| replace:: :term:`SSBS`”h]”h)”}”(hŒ:term:`SSBS`”h]”h)”}”(hjâh]”hŒSSBS”…””}”(hhh!jäubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jàubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jîŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSSBS”uh1hhAhBhCK5h!jÜubah"}”(h$]”h&]”h+]”ŒSSBS”ah-]”h/]”uh1h hAhBhCK5h!hhhubh)”}”(hŒ.. |SVE| replace:: :term:`SVE`”h]”h)”}”(hŒ:term:`SVE`”h]”h)”}”(hj h]”hŒSVE”…””}”(hhh!j ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒSVE”uh1hhAhBhCK6h!j ubah"}”(h$]”h&]”h+]”ŒSVE”ah-]”h/]”uh1h hAhBhCK6h!hhhubh)”}”(hŒ.. |TBB| replace:: :term:`TBB`”h]”h)”}”(hŒ:term:`TBB`”h]”h)”}”(hj8 h]”hŒTBB”…””}”(hhh!j: ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j6 ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jD Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒTBB”uh1hhAhBhCK7h!j2 ubah"}”(h$]”h&]”h+]”ŒTBB”ah-]”h/]”uh1h hAhBhCK7h!hhhubh)”}”(hŒ .. |TBBR| replace:: :term:`TBBR`”h]”h)”}”(hŒ:term:`TBBR`”h]”h)”}”(hjc h]”hŒTBBR”…””}”(hhh!je ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!ja ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jo Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒTBBR”uh1hhAhBhCK8h!j] ubah"}”(h$]”h&]”h+]”ŒTBBR”ah-]”h/]”uh1h hAhBhCK8h!hhhubh)”}”(hŒ.. |TEE| replace:: :term:`TEE`”h]”h)”}”(hŒ:term:`TEE`”h]”h)”}”(hjŽ h]”hŒTEE”…””}”(hhh!j ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jŒ ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jš Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒTEE”uh1hhAhBhCK9h!jˆ ubah"}”(h$]”h&]”h+]”ŒTEE”ah-]”h/]”uh1h hAhBhCK9h!hhhubh)”}”(hŒ .. |TF-A| replace:: :term:`TF-A`”h]”h)”}”(hŒ:term:`TF-A`”h]”h)”}”(hj¹ h]”hŒTF-A”…””}”(hhh!j» ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j· ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jÅ Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒTF-A”uh1hhAhBhCK:h!j³ ubah"}”(h$]”h&]”h+]”ŒTF-A”ah-]”h/]”uh1h hAhBhCK:h!hhhubh)”}”(hŒ .. |TF-M| replace:: :term:`TF-M`”h]”h)”}”(hŒ:term:`TF-M`”h]”h)”}”(hjä h]”hŒTF-M”…””}”(hhh!jæ ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jâ ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jð Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒTF-M”uh1hhAhBhCK;h!jÞ ubah"}”(h$]”h&]”h+]”ŒTF-M”ah-]”h/]”uh1h hAhBhCK;h!hhhubh)”}”(hŒ.. |TLB| replace:: :term:`TLB`”h]”h)”}”(hŒ:term:`TLB`”h]”h)”}”(hj h]”hŒTLB”…””}”(hhh!j ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”j Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒTLB”uh1hhAhBhCKh!j_ ubah"}”(h$]”h&]”h+]”ŒTRNG”ah-]”h/]”uh1h hAhBhCK>h!hhhubh)”}”(hŒ.. |TSP| replace:: :term:`TSP`”h]”h)”}”(hŒ:term:`TSP`”h]”h)”}”(hj h]”hŒTSP”…””}”(hhh!j’ ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jŽ ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jœ Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒTSP”uh1hhAhBhCK?h!jŠ ubah"}”(h$]”h&]”h+]”ŒTSP”ah-]”h/]”uh1h hAhBhCK?h!hhhubh)”}”(hŒ.. |TZC| replace:: :term:`TZC`”h]”h)”}”(hŒ:term:`TZC`”h]”h)”}”(hj» h]”hŒTZC”…””}”(hhh!j½ ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j¹ ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jÇ Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒTZC”uh1hhAhBhCK@h!jµ ubah"}”(h$]”h&]”h+]”ŒTZC”ah-]”h/]”uh1h hAhBhCK@h!hhhubh)”}”(hŒ".. |UBSAN| replace:: :term:`UBSAN`”h]”h)”}”(hŒ :term:`UBSAN`”h]”h)”}”(hjæ h]”hŒUBSAN”…””}”(hhh!jè ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jä ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jò Œreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒUBSAN”uh1hhAhBhCKAh!jà ubah"}”(h$]”h&]”h+]”ŒUBSAN”ah-]”h/]”uh1h hAhBhCKAh!hhhubh)”}”(hŒ .. |UEFI| replace:: :term:`UEFI`”h]”h)”}”(hŒ:term:`UEFI`”h]”h)”}”(hjh]”hŒUEFI”…””}”(hhh!jubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒUEFI”uh1hhAhBhCKBh!jubah"}”(h$]”h&]”h+]”ŒUEFI”ah-]”h/]”uh1h hAhBhCKBh!hhhubh)”}”(hŒ .. |WDOG| replace:: :term:`WDOG`”h]”h)”}”(hŒ:term:`WDOG`”h]”h)”}”(hj<h]”hŒWDOG”…””}”(hhh!j>ubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!j:ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jHŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒWDOG”uh1hhAhBhCKCh!j6ubah"}”(h$]”h&]”h+]”ŒWDOG”ah-]”h/]”uh1h hAhBhCKCh!hhhubh)”}”(hŒ!.. |XLAT| replace:: :term:`XLAT` ”h]”h)”}”(hŒ:term:`XLAT`”h]”h)”}”(hjgh]”hŒXLAT”…””}”(hhh!jiubah"}”(h$]”h&]”(h(Œstd”Œstd-term”eh+]”h-]”h/]”uh1hh!jeubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jsŒreftype”Œterm”Œrefexplicit”‰Œrefwarn”ˆh?ŒXLAT”uh1hhAhBhCKDh!jaubah"}”(h$]”h&]”h+]”ŒXLAT”ah-]”h/]”uh1h hAhBhCKDh!hhhubh Œsection”“”)”}”(hhh]”(h Œtitle”“”)”}”(hŒCoding Guidelines”h]”hŒCoding Guidelines”…””}”(hj•h!j“hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!jŽhhhAŒZ/home/test/workspace/code/optee_3.16/trusted-firmware-a/docs/process/coding-guidelines.rst”hCKubh Œ paragraph”“”)”}”(hŒºThis document provides some additional guidelines to consider when writing |TF-A| code. These are not intended to be strictly-enforced rules like the contents of the :ref:`Coding Style`.”h]”(hŒKThis document provides some additional guidelines to consider when writing ”…””}”(hŒKThis document provides some additional guidelines to consider when writing ”h!j¤hhhANhCNubh)”}”(hj¹ h]”h)”}”(hj¹ h]”hŒTF-A”…””}”(hhh!j°ubah"}”(h$]”h&]”(h(jÅ jÆ eh+]”h-]”h/]”uh1hhANhCNh!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jÅ Œreftype”jÓ Œrefexplicit”‰Œrefwarn”ˆŒ reftarget”jÖ uh1hhAhBhCK:h!j¤hhubhŒU code. These are not intended to be strictly-enforced rules like the contents of the ”…””}”(hŒU code. These are not intended to be strictly-enforced rules like the contents of the ”h!j¤hhhANhCNubh)”}”(hŒ:ref:`Coding Style`”h]”h)”}”(hjÐh]”hŒCoding Style”…””}”(hhh!jÒubah"}”(h$]”h&]”(h(Œstd”Œstd-ref”eh+]”h-]”h/]”uh1hh!jÎubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jÜŒreftype”Œref”Œrefexplicit”‰Œrefwarn”ˆh?Œcoding style”uh1hhAj¡hCKh!j¤ubhŒ.”…””}”(hŒ.”h!j¤hhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKh!jŽhhubj)”}”(hhh]”(j’)”}”(hŒAutomatic Editor Configuration”h]”hŒAutomatic Editor Configuration”…””}”(hjþh!jühhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!jùhhhAj¡hCK ubj£)”}”(hXUMany of the rules given below (such as indentation size, use of tabs, and newlines) can be set automatically using the `EditorConfig`_ configuration file in the root of the repository: ``.editorconfig``. With a supported editor, the rules set out in this file can be automatically applied when you are editing files in the |TF-A| repository.”h]”(hŒwMany of the rules given below (such as indentation size, use of tabs, and newlines) can be set automatically using the ”…””}”(hŒwMany of the rules given below (such as indentation size, use of tabs, and newlines) can be set automatically using the ”h!j hhhANhCNubh Œ reference”“”)”}”(hŒ`EditorConfig`_”h]”hŒEditorConfig”…””}”(hŒEditorConfig”h!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œname”jŒrefuri”Œhttp://editorconfig.org/”uh1jh!j Œresolved”KubhŒ3 configuration file in the root of the repository: ”…””}”(hŒ3 configuration file in the root of the repository: ”h!j hhhANhCNubh Œliteral”“”)”}”(hŒ``.editorconfig``”h]”hŒ .editorconfig”…””}”(hhh!j/ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j ubhŒy. With a supported editor, the rules set out in this file can be automatically applied when you are editing files in the ”…””}”(hŒy. With a supported editor, the rules set out in this file can be automatically applied when you are editing files in the ”h!j hhhANhCNubh)”}”(hj¹ h]”h)”}”(hj¹ h]”hŒTF-A”…””}”(hhh!jEubah"}”(h$]”h&]”(h(jÅ jÆ eh+]”h-]”h/]”uh1hhANhCNh!jBubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jÅ Œreftype”jÓ Œrefexplicit”‰Œrefwarn”ˆŒ reftarget”jÖ uh1hhAhBhCK:h!j hhubhŒ repository.”…””}”(hŒ repository.”h!j hhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKh!jùhhubj£)”}”(hŒ{Several editors include built-in support for EditorConfig files, and many others support its functionality through plugins.”h]”hŒ{Several editors include built-in support for EditorConfig files, and many others support its functionality through plugins.”…””}”(hjkh!jihhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKh!jùhhubj£)”}”(hŒ>Use of the EditorConfig file is suggested but is not required.”h]”hŒ>Use of the EditorConfig file is suggested but is not required.”…””}”(hjyh!jwhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKh!jùhhubh Œtarget”“”)”}”(hŒ".. _automatic-compliance-checking:”h]”h"}”(h$]”h&]”h+]”h-]”h/]”Œrefid”Œautomatic-compliance-checking”uh1j…hCK[h!jùhhhAj¡ubeh"}”(h$]”Œautomatic-editor-configuration”ah&]”h+]”Œautomatic editor configuration”ah-]”h/]”uh1jŒh!jŽhhhAj¡hCK ubj)”}”(hhh]”(j’)”}”(hŒAutomatic Compliance Checking”h]”hŒAutomatic Compliance Checking”…””}”(hj h!jžhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!j›hhhAj¡hCKubj£)”}”(hXTo assist with coding style compliance, the project Makefile contains two targets which both utilise the `checkpatch.pl` script that ships with the Linux source tree. The project also defines certain *checkpatch* options in the ``.checkpatch.conf`` file in the top-level directory.”h]”(hŒiTo assist with coding style compliance, the project Makefile contains two targets which both utilise the ”…””}”(hŒiTo assist with coding style compliance, the project Makefile contains two targets which both utilise the ”h!j¬hhhANhCNubh Œtitle_reference”“”)”}”(hŒ`checkpatch.pl`”h]”hŒ checkpatch.pl”…””}”(hhh!j·ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jµh!j¬ubhŒP script that ships with the Linux source tree. The project also defines certain ”…””}”(hŒP script that ships with the Linux source tree. The project also defines certain ”h!j¬hhhANhCNubh Œemphasis”“”)”}”(hŒ*checkpatch*”h]”hŒ checkpatch”…””}”(hhh!jÌubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!j¬ubhŒ options in the ”…””}”(hŒ options in the ”h!j¬hhhANhCNubj.)”}”(hŒ``.checkpatch.conf``”h]”hŒ.checkpatch.conf”…””}”(hhh!jßubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j¬ubhŒ! file in the top-level directory.”…””}”(hŒ! file in the top-level directory.”h!j¬hhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKh!j›hhubh Œnote”“”)”}”(hŒ–Checkpatch errors will gate upstream merging of pull requests. Checkpatch warnings will not gate merging but should be reviewed and fixed if possible.”h]”j£)”}”(hŒ–Checkpatch errors will gate upstream merging of pull requests. Checkpatch warnings will not gate merging but should be reviewed and fixed if possible.”h]”hŒ–Checkpatch errors will gate upstream merging of pull requests. Checkpatch warnings will not gate merging but should be reviewed and fixed if possible.”…””}”(hj h!jþubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK!h!júubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jøh!j›hhhAj¡hCNubj£)”}”(hXfTo check the entire source tree, you must first download copies of ``checkpatch.pl``, ``spelling.txt`` and ``const_structs.checkpatch`` available in the `Linux master tree`_ *scripts* directory, then set the ``CHECKPATCH`` environment variable to point to ``checkpatch.pl`` (with the other 2 files in the same directory) and build the `checkcodebase` target:”h]”(hŒCTo check the entire source tree, you must first download copies of ”…””}”(hŒCTo check the entire source tree, you must first download copies of ”h!j hhhANhCNubj.)”}”(hŒ``checkpatch.pl``”h]”hŒ checkpatch.pl”…””}”(hhh!j ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j ubhŒ, ”…””}”(hŒ, ”h!j hhhANhCNubj.)”}”(hŒ``spelling.txt``”h]”hŒspelling.txt”…””}”(hhh!j. ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j ubhŒ and ”…””}”(hŒ and ”h!j hhhANhCNubj.)”}”(hŒ``const_structs.checkpatch``”h]”hŒconst_structs.checkpatch”…””}”(hhh!jA ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j ubhŒ available in the ”…””}”(hŒ available in the ”h!j hhhANhCNubj)”}”(hŒ`Linux master tree`_”h]”hŒLinux master tree”…””}”(hŒLinux master tree”h!jT ubah"}”(h$]”h&]”h+]”h-]”h/]”Œname”ŒLinux master tree”j%ŒHhttps://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/”uh1jh!j j'KubhŒ ”…””}”(hŒ ”h!j hhhANhCNubjË)”}”(hŒ *scripts*”h]”hŒscripts”…””}”(hhh!jk ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!j ubhŒ directory, then set the ”…””}”(hŒ directory, then set the ”h!j hhhANhCNubj.)”}”(hŒ``CHECKPATCH``”h]”hŒ CHECKPATCH”…””}”(hhh!j~ ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j ubhŒ" environment variable to point to ”…””}”(hŒ" environment variable to point to ”h!j hhhANhCNubj.)”}”(hŒ``checkpatch.pl``”h]”hŒ checkpatch.pl”…””}”(hhh!j‘ ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j ubhŒ> (with the other 2 files in the same directory) and build the ”…””}”(hŒ> (with the other 2 files in the same directory) and build the ”h!j hhhANhCNubj¶)”}”(hŒ`checkcodebase`”h]”hŒ checkcodebase”…””}”(hhh!j¤ ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jµh!j ubhŒ target:”…””}”(hŒ target:”h!j hhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK%h!j›hhubh Œ literal_block”“”)”}”(hŒImake CHECKPATCH=/linux/scripts/checkpatch.pl checkcodebase”h]”hŒImake CHECKPATCH=/linux/scripts/checkpatch.pl checkcodebase”…””}”(hhh!j¿ ubah"}”(h$]”h&]”h+]”h-]”h/]”Œforce”‰Œhighlight_args”}”Œ xml:space”Œpreserve”Œlanguage”Œshell”uh1j½ hAj¡hCK+h!j›hhubj£)”}”(hŒfTo just check the style on the files that differ between your local branch and the remote master, use:”h]”hŒfTo just check the style on the files that differ between your local branch and the remote master, use:”…””}”(hjÖ h!jÔ hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK/h!j›hhubj¾ )”}”(hŒFmake CHECKPATCH=/linux/scripts/checkpatch.pl checkpatch”h]”hŒFmake CHECKPATCH=/linux/scripts/checkpatch.pl checkpatch”…””}”(hhh!jâ ubah"}”(h$]”h&]”h+]”h-]”h/]”Œforce”‰Œhighlight_args”}”jÐ jÑ jÒ Œshell”uh1j½ hAj¡hCK2h!j›hhubj£)”}”(hŒÁIf you wish to check your patch against something other than the remote master, set the ``BASE_COMMIT`` variable to your desired branch. By default, ``BASE_COMMIT`` is set to ``origin/master``.”h]”(hŒXIf you wish to check your patch against something other than the remote master, set the ”…””}”(hŒXIf you wish to check your patch against something other than the remote master, set the ”h!jô hhhANhCNubj.)”}”(hŒ``BASE_COMMIT``”h]”hŒBASE_COMMIT”…””}”(hhh!jý ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jô ubhŒ. variable to your desired branch. By default, ”…””}”(hŒ. variable to your desired branch. By default, ”h!jô hhhANhCNubj.)”}”(hŒ``BASE_COMMIT``”h]”hŒBASE_COMMIT”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jô ubhŒ is set to ”…””}”(hŒ is set to ”h!jô hhhANhCNubj.)”}”(hŒ``origin/master``”h]”hŒ origin/master”…””}”(hhh!j#ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jô ubhŒ.”…””}”(hjòh!jô hhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK6h!j›hhubj)”}”(hhh]”(j’)”}”(hŒIgnored Checkpatch Warnings”h]”hŒIgnored Checkpatch Warnings”…””}”(hj@h!j>hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!j;hhhAj¡hCK;ubj£)”}”(hŒTSome checkpatch warnings in the TF codebase are deliberately ignored. These include:”h]”hŒTSome checkpatch warnings in the TF codebase are deliberately ignored. These include:”…””}”(hjNh!jLhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK=h!j;hhubh Œbullet_list”“”)”}”(hhh]”(h Œ list_item”“”)”}”(hŒ``**WARNING: line over 80 characters**``: Although the codebase should generally conform to the 80 character limit this is overly restrictive in some cases. ”h]”j£)”}”(hŒœ``**WARNING: line over 80 characters**``: Although the codebase should generally conform to the 80 character limit this is overly restrictive in some cases.”h]”(j.)”}”(hŒ(``**WARNING: line over 80 characters**``”h]”hŒ$**WARNING: line over 80 characters**”…””}”(hhh!jiubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jeubhŒt: Although the codebase should generally conform to the 80 character limit this is overly restrictive in some cases.”…””}”(hŒt: Although the codebase should generally conform to the 80 character limit this is overly restrictive in some cases.”h!jeubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK@h!jaubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j\hhhAj¡hCNubj`)”}”(hŒý``**WARNING: Use of volatile is usually wrong``: see `Why the â€œvolatileâ€ type class should not be used`_ . Although this document contains some very useful information, there are several legimate uses of the volatile keyword within the TF codebase. ”h]”j£)”}”(hŒü``**WARNING: Use of volatile is usually wrong``: see `Why the â€œvolatileâ€ type class should not be used`_ . Although this document contains some very useful information, there are several legimate uses of the volatile keyword within the TF codebase.”h]”(j.)”}”(hŒ/``**WARNING: Use of volatile is usually wrong``”h]”hŒ+**WARNING: Use of volatile is usually wrong”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jŒubhŒ: see ”…””}”(hŒ: see ”h!jŒubj)”}”(hŒ7`Why the â€œvolatileâ€ type class should not be used`_”h]”hŒ4Why the â€œvolatileâ€ type class should not be used”…””}”(hŒ4Why the â€œvolatileâ€ type class should not be used”h!j£ubah"}”(h$]”h&]”h+]”h-]”h/]”Œname”Œ4Why the â€œvolatileâ€ type class should not be used”j%ŒOhttps://www.kernel.org/doc/html/latest/process/volatile-considered-harmful.html”uh1jh!jŒj'KubhŒ . Although this document contains some very useful information, there are several legimate uses of the volatile keyword within the TF codebase.”…””}”(hŒ . Although this document contains some very useful information, there are several legimate uses of the volatile keyword within the TF codebase.”h!jŒubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKDh!jˆubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j\hhhAj¡hCNubeh"}”(h$]”h&]”h+]”h-]”h/]”Œbullet”Œ-”uh1jZhAj¡hCK@h!j;hhubeh"}”(h$]”Œignored-checkpatch-warnings”ah&]”h+]”Œignored checkpatch warnings”ah-]”h/]”uh1jŒh!j›hhhAj¡hCK;ubeh"}”(h$]”(j’Œid1”eh&]”h+]”(Œautomatic compliance checking”Œautomatic-compliance-checking”eh-]”h/]”uh1jŒh!jŽhhhAj¡hCKŒexpect_referenced_by_name”}”jÜj‡sŒexpect_referenced_by_id”}”j’j‡subj)”}”(hhh]”(j’)”}”(hŒPerformance considerations”h]”hŒPerformance considerations”…””}”(hjèh!jæhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!jãhhhAj¡hCKJubj)”}”(hhh]”(j’)”}”(hŒ#Avoid printf and use logging macros”h]”hŒ#Avoid printf and use logging macros”…””}”(hjùh!j÷hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!jôhhhAj¡hCKMubj£)”}”(hX``debug.h`` provides logging macros (for example, ``WARN`` and ``ERROR``) which wrap ``tf_log`` and which allow the logging call to be compiled-out depending on the ``make`` command. Use these macros to avoid print statements being compiled unconditionally into the binary.”h]”(j.)”}”(hŒ``debug.h``”h]”hŒdebug.h”…””}”(hhh!j ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jubhŒ' provides logging macros (for example, ”…””}”(hŒ' provides logging macros (for example, ”h!jhhhANhCNubj.)”}”(hŒ``WARN``”h]”hŒWARN”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jubhŒ and ”…””}”(hŒ and ”h!jhhhANhCNubj.)”}”(hŒ ``ERROR``”h]”hŒERROR”…””}”(hhh!j/ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jubhŒ ) which wrap ”…””}”(hŒ ) which wrap ”h!jhhhANhCNubj.)”}”(hŒ ``tf_log``”h]”hŒtf_log”…””}”(hhh!jBubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jubhŒF and which allow the logging call to be compiled-out depending on the ”…””}”(hŒF and which allow the logging call to be compiled-out depending on the ”h!jhhhANhCNubj.)”}”(hŒ``make``”h]”hŒmake”…””}”(hhh!jUubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jubhŒd command. Use these macros to avoid print statements being compiled unconditionally into the binary.”…””}”(hŒd command. Use these macros to avoid print statements being compiled unconditionally into the binary.”h!jhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKOh!jôhhubj£)”}”(hŒ-Each logging macro has a numerical log level:”h]”hŒ-Each logging macro has a numerical log level:”…””}”(hjph!jnhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKTh!jôhhubj¾ )”}”(hŒ¬#define LOG_LEVEL_NONE 0 #define LOG_LEVEL_ERROR 10 #define LOG_LEVEL_NOTICE 20 #define LOG_LEVEL_WARNING 30 #define LOG_LEVEL_INFO 40 #define LOG_LEVEL_VERBOSE 50”h]”hŒ¬#define LOG_LEVEL_NONE 0 #define LOG_LEVEL_ERROR 10 #define LOG_LEVEL_NOTICE 20 #define LOG_LEVEL_WARNING 30 #define LOG_LEVEL_INFO 40 #define LOG_LEVEL_VERBOSE 50”…””}”(hhh!j|ubah"}”(h$]”h&]”h+]”h-]”h/]”Œforce”‰Œhighlight_args”}”jÐ jÑ jÒ Œc”uh1j½ hAj¡hCKVh!jôhhubj£)”}”(hXZBy default, all logging statements with a log level ``<= LOG_LEVEL_INFO`` will be compiled into debug builds and all statements with a log level ``<= LOG_LEVEL_NOTICE`` will be compiled into release builds. This can be overridden from the command line or by the platform makefile (although it may be necessary to clean the build directory first).”h]”(hŒ4By default, all logging statements with a log level ”…””}”(hŒ4By default, all logging statements with a log level ”h!jŽhhhANhCNubj.)”}”(hŒ``<= LOG_LEVEL_INFO``”h]”hŒ<= LOG_LEVEL_INFO”…””}”(hhh!j—ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jŽubhŒH will be compiled into debug builds and all statements with a log level ”…””}”(hŒH will be compiled into debug builds and all statements with a log level ”h!jŽhhhANhCNubj.)”}”(hŒ``<= LOG_LEVEL_NOTICE``”h]”hŒ<= LOG_LEVEL_NOTICE”…””}”(hhh!jªubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jŽubhŒ² will be compiled into release builds. This can be overridden from the command line or by the platform makefile (although it may be necessary to clean the build directory first).”…””}”(hŒ² will be compiled into release builds. This can be overridden from the command line or by the platform makefile (although it may be necessary to clean the build directory first).”h!jŽhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK_h!jôhhubj£)”}”(hŒ2For example, to enable ``VERBOSE`` logging on FVP:”h]”(hŒFor example, to enable ”…””}”(hŒFor example, to enable ”h!jÃhhhANhCNubj.)”}”(hŒ``VERBOSE``”h]”hŒVERBOSE”…””}”(hhh!jÌubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jÃubhŒ logging on FVP:”…””}”(hŒ logging on FVP:”h!jÃhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKeh!jôhhubj¾ )”}”(hŒmake PLAT=fvp LOG_LEVEL=50 all”h]”hŒmake PLAT=fvp LOG_LEVEL=50 all”…””}”(hhh!jåubah"}”(h$]”h&]”h+]”h-]”h/]”Œforce”‰Œhighlight_args”}”jÐ jÑ jÒ Œshell”uh1j½ hAj¡hCKgh!jôhhubeh"}”(h$]”Œ#avoid-printf-and-use-logging-macros”ah&]”h+]”Œ#avoid printf and use logging macros”ah-]”h/]”uh1jŒh!jãhhhAj¡hCKMubj)”}”(hhh]”(j’)”}”(hŒUse const data where possible”h]”hŒUse const data where possible”…””}”(hjh!jhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!jÿhhhAj¡hCKlubj£)”}”(hŒ For example, the following code:”h]”hŒ For example, the following code:”…””}”(hjh!jhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKnh!jÿhhubj¾ )”}”(hŒÇstruct my_struct { int arg1; int arg2; }; void init(struct my_struct *ptr); void main(void) { struct my_struct x; x.arg1 = 1; x.arg2 = 2; init(&x); }”h]”hŒÇstruct my_struct { int arg1; int arg2; }; void init(struct my_struct *ptr); void main(void) { struct my_struct x; x.arg1 = 1; x.arg2 = 2; init(&x); }”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œforce”‰Œhighlight_args”}”jÐ jÑ jÒ juh1j½ hAj¡hCKph!jÿhhubj£)”}”(hŒis better written as:”h]”hŒis better written as:”…””}”(hj1h!j/hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKh!jÿhhubj¾ )”}”(hŒ¶struct my_struct { int arg1; int arg2; }; void init(const struct my_struct *ptr); void main(void) { const struct my_struct x = { 1, 2 }; init(&x); }”h]”hŒ¶struct my_struct { int arg1; int arg2; }; void init(const struct my_struct *ptr); void main(void) { const struct my_struct x = { 1, 2 }; init(&x); }”…””}”(hhh!j=ubah"}”(h$]”h&]”h+]”h-]”h/]”Œforce”‰Œhighlight_args”}”jÐ jÑ jÒ juh1j½ hAj¡hCKƒh!jÿhhubj£)”}”(hX3This allows the linker to put the data in a read-only data section instead of a writeable data section, which may result in a smaller and faster binary. Note that this may require dependent functions (``init()`` in the above example) to have ``const`` arguments, assuming they don't need to modify the data.”h]”(hŒÉThis allows the linker to put the data in a read-only data section instead of a writeable data section, which may result in a smaller and faster binary. Note that this may require dependent functions (”…””}”(hŒÉThis allows the linker to put the data in a read-only data section instead of a writeable data section, which may result in a smaller and faster binary. Note that this may require dependent functions (”h!jNhhhANhCNubj.)”}”(hŒ ``init()``”h]”hŒinit()”…””}”(hhh!jWubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jNubhŒ in the above example) to have ”…””}”(hŒ in the above example) to have ”h!jNhhhANhCNubj.)”}”(hŒ ``const``”h]”hŒconst”…””}”(hhh!jjubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jNubhŒ: arguments, assuming they donâ€™t need to modify the data.”…””}”(hŒ8 arguments, assuming they don't need to modify the data.”h!jNhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK’h!jÿhhubeh"}”(h$]”Œuse-const-data-where-possible”ah&]”h+]”Œuse const data where possible”ah-]”h/]”uh1jŒh!jãhhhAj¡hCKlubeh"}”(h$]”Œperformance-considerations”ah&]”h+]”Œperformance considerations”ah-]”h/]”uh1jŒh!jŽhhhAj¡hCKJubj)”}”(hhh]”(j’)”}”(hŒ9Libc functions that are banned or to be used with caution”h]”hŒ9Libc functions that are banned or to be used with caution”…””}”(hj˜h!j–hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!j“hhhAj¡hCK˜ubj£)”}”(hŒŸBelow is a list of functions that present security risks and either must not be used (Banned) or are discouraged from use and must be used with care (Caution).”h]”hŒŸBelow is a list of functions that present security risks and either must not be used (Banned) or are discouraged from use and must be used with care (Caution).”…””}”(hj¦h!j¤hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKšh!j“hhubh Œtable”“”)”}”(hhh]”h Œtgroup”“”)”}”(hhh]”(h Œcolspec”“”)”}”(hhh]”h"}”(h$]”h&]”h+]”h-]”h/]”Œcolwidth”Kuh1j¼h!j¹ubj½)”}”(hhh]”h"}”(h$]”h&]”h+]”h-]”h/]”Œcolwidth”Kuh1j¼h!j¹ubj½)”}”(hhh]”h"}”(h$]”h&]”h+]”h-]”h/]”Œcolwidth”K&uh1j¼h!j¹ubh Œthead”“”)”}”(hhh]”h Œrow”“”)”}”(hhh]”(h Œentry”“”)”}”(hhh]”j£)”}”(hŒ libc function”h]”hŒ libc function”…””}”(hjíh!jëubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKžh!jèubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jãubjç)”}”(hhh]”j£)”}”(hŒStatus”h]”hŒStatus”…””}”(hjh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKžh!jÿubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jãubjç)”}”(hhh]”j£)”}”(hŒComments”h]”hŒComments”…””}”(hjh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKžh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jãubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1jáh!jÞubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÜh!j¹ubh Œtbody”“”)”}”(hhh]”(jâ)”}”(hhh]”(jç)”}”(hhh]”j£)”}”(hŒ``strcpy, wcscpy``, ``strncpy``”h]”(j.)”}”(hŒ``strcpy, wcscpy``”h]”hŒstrcpy, wcscpy”…””}”(hhh!jHubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jDubhŒ, ”…””}”(hŒ, ”h!jDubj.)”}”(hŒ``strncpy``”h]”hŒstrncpy”…””}”(hhh!j[ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jDubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK h!jAubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!j>ubjç)”}”(hhh]”j£)”}”(hŒBanned”h]”hŒBanned”…””}”(hjzh!jxubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK h!juubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!j>ubjç)”}”(hhh]”j£)”}”(hŒuse strlcpy instead”h]”hŒuse strlcpy instead”…””}”(hj‘h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK h!jŒubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!j>ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1jáh!j;ubjâ)”}”(hhh]”(jç)”}”(hhh]”j£)”}”(hŒ``strcat, wcscat``, ``strncat``”h]”(j.)”}”(hŒ``strcat, wcscat``”h]”hŒstrcat, wcscat”…””}”(hhh!j³ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j¯ubhŒ, ”…””}”(hŒ, ”h!j¯ubj.)”}”(hŒ``strncat``”h]”hŒstrncat”…””}”(hhh!jÆubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j¯ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK£h!j¬ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!j©ubjç)”}”(hhh]”j£)”}”(hŒBanned”h]”hŒBanned”…””}”(hjåh!jãubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK£h!jàubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!j©ubjç)”}”(hhh]”j£)”}”(hŒuse strlcat instead”h]”hŒuse strlcat instead”…””}”(hjüh!júubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK£h!j÷ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!j©ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1jáh!j;ubjâ)”}”(hhh]”(jç)”}”(hhh]”j£)”}”(hŒ``sprintf, vsprintf``”h]”j.)”}”(hjh]”hŒsprintf, vsprintf”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK¦h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jubjç)”}”(hhh]”j£)”}”(hŒBanned”h]”hŒBanned”…””}”(hj<h!j:ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK¦h!j7ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jubjç)”}”(hhh]”j£)”}”(hŒuse snprintf, vsnprintf instead”h]”hŒuse snprintf, vsnprintf instead”…””}”(hjSh!jQubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK¦h!jNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1jáh!j;ubjâ)”}”(hhh]”(jç)”}”(hhh]”j£)”}”(hŒ``snprintf``”h]”j.)”}”(hjsh]”hŒsnprintf”…””}”(hhh!juubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jqubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK©h!jnubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jkubjç)”}”(hhh]”j£)”}”(hŒCaution”h]”hŒCaution”…””}”(hj“h!j‘ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK©h!jŽubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jkubjç)”}”(hhh]”j£)”}”(hŒ?ensure result fits in buffer i.e : snprintf(buf,size...) < size”h]”hŒ?ensure result fits in buffer i.e : snprintf(buf,sizeâ€¦) < size”…””}”(hjªh!j¨ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK©h!j¥ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jkubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1jáh!j;ubjâ)”}”(hhh]”(jç)”}”(hhh]”j£)”}”(hŒ ``vsnprintf``”h]”j.)”}”(hjÊh]”hŒ vsnprintf”…””}”(hhh!jÌubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jÈubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK¬h!jÅubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jÂubjç)”}”(hhh]”j£)”}”(hŒCaution”h]”hŒCaution”…””}”(hjêh!jèubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK¬h!jåubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jÂubjç)”}”(hhh]”j£)”}”(hŒ6inspect va_list match types specified in format string”h]”hŒ6inspect va_list match types specified in format string”…””}”(hjh!jÿubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK¬h!jüubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jÂubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1jáh!j;ubjâ)”}”(hhh]”(jç)”}”(hhh]”j£)”}”(hŒ ``strtok``”h]”j.)”}”(hj!h]”hŒstrtok”…””}”(hhh!j#ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK¯h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jubjç)”}”(hhh]”j£)”}”(hŒBanned”h]”hŒBanned”…””}”(hjAh!j?ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK¯h!j<ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jubjç)”}”(hhh]”j£)”}”(hŒuse strtok_r or strsep instead”h]”hŒuse strtok_r or strsep instead”…””}”(hjXh!jVubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK¯h!jSubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1jáh!j;ubjâ)”}”(hhh]”(jç)”}”(hhh]”j£)”}”(hŒ``strtok_r, strsep``”h]”j.)”}”(hjxh]”hŒstrtok_r, strsep”…””}”(hhh!jzubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jvubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK±h!jsubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jpubjç)”}”(hhh]”j£)”}”(hŒCaution”h]”hŒCaution”…””}”(hj˜h!j–ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK±h!j“ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jpubjç)”}”(hhh]”j£)”}”(hŒ#inspect for terminated input buffer”h]”hŒ#inspect for terminated input buffer”…””}”(hj¯h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK±h!jªubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jpubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1jáh!j;ubjâ)”}”(hhh]”(jç)”}”(hhh]”j£)”}”(hŒ``ato*``”h]”j.)”}”(hjÏh]”hŒato*”…””}”(hhh!jÑubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jÍubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK³h!jÊubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jÇubjç)”}”(hhh]”j£)”}”(hŒBanned”h]”hŒBanned”…””}”(hjïh!jíubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK³h!jêubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jÇubjç)”}”(hhh]”j£)”}”(hŒuse equivalent strto* functions”h]”hŒuse equivalent strto* functions”…””}”(hjh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK³h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jÇubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1jáh!j;ubjâ)”}”(hhh]”(jç)”}”(hhh]”j£)”}”(hŒ``*toa``”h]”j.)”}”(hj&h]”hŒ*toa”…””}”(hhh!j(ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j$ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKµh!j!ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jubjç)”}”(hhh]”j£)”}”(hŒBanned”h]”hŒBanned”…””}”(hjFh!jDubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKµh!jAubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jubjç)”}”(hhh]”j£)”}”(hŒUse snprintf instead”h]”hŒUse snprintf instead”…””}”(hj]h!j[ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKµh!jXubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jæh!jubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1jáh!j;ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j9h!j¹ubeh"}”(h$]”h&]”h+]”h-]”h/]”Œcols”Kuh1j·h!j´ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j²h!j“hhhAj¡hCNubj£)”}”(hŒNThe `libc` component in the codebase will not add support for the banned APIs.”h]”(hŒThe ”…””}”(hŒThe ”h!jˆhhhANhCNubj¶)”}”(hŒ`libc`”h]”hŒlibc”…””}”(hhh!j‘ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jµh!jˆubhŒD component in the codebase will not add support for the banned APIs.”…””}”(hŒD component in the codebase will not add support for the banned APIs.”h!jˆhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCK¸h!j“hhubeh"}”(h$]”Œ9libc-functions-that-are-banned-or-to-be-used-with-caution”ah&]”h+]”Œ9libc functions that are banned or to be used with caution”ah-]”h/]”uh1jŒh!jŽhhhAj¡hCK˜ubj)”}”(hhh]”(j’)”}”(hŒError handling and robustness”h]”hŒError handling and robustness”…””}”(hj·h!jµhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!j²hhhAj¡hCK»ubj)”}”(hhh]”(j’)”}”(hŒ3Using CASSERT to check for compile time data errors”h]”hŒ3Using CASSERT to check for compile time data errors”…””}”(hjÈh!jÆhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!jÃhhhAj¡hCK¾ubj£)”}”(hŒ©Where possible, use the ``CASSERT`` macro to check the validity of data known at compile time instead of checking validity at runtime, to avoid unnecessary runtime code.”h]”(hŒWhere possible, use the ”…””}”(hŒWhere possible, use the ”h!jÔhhhANhCNubj.)”}”(hŒ``CASSERT``”h]”hŒCASSERT”…””}”(hhh!jÝubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jÔubhŒ† macro to check the validity of data known at compile time instead of checking validity at runtime, to avoid unnecessary runtime code.”…””}”(hŒ† macro to check the validity of data known at compile time instead of checking validity at runtime, to avoid unnecessary runtime code.”h!jÔhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKÀh!jÃhhubj£)”}”(hŒuFor example, this can be used to check that the assembler's and compiler's views of the size of an array is the same.”h]”hŒyFor example, this can be used to check that the assemblerâ€™s and compilerâ€™s views of the size of an array is the same.”…””}”(hjøh!jöhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKÄh!jÃhhubj¾ )”}”(hŒå#include define MY_STRUCT_SIZE 8 /* Used by assembler source files */ struct my_struct { uint32_t arg1; uint32_t arg2; }; CASSERT(MY_STRUCT_SIZE == sizeof(struct my_struct), assert_my_struct_size_mismatch);”h]”hŒå#include define MY_STRUCT_SIZE 8 /* Used by assembler source files */ struct my_struct { uint32_t arg1; uint32_t arg2; }; CASSERT(MY_STRUCT_SIZE == sizeof(struct my_struct), assert_my_struct_size_mismatch);”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œforce”‰Œhighlight_args”}”jÐ jÑ jÒ juh1j½ hAj¡hCKÇh!jÃhhubj£)”}”(hŒfIf ``MY_STRUCT_SIZE`` in the above example were wrong then the compiler would emit an error like this:”h]”(hŒIf ”…””}”(hŒIf ”h!jhhhANhCNubj.)”}”(hŒ``MY_STRUCT_SIZE``”h]”hŒMY_STRUCT_SIZE”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jubhŒQ in the above example were wrong then the compiler would emit an error like this:”…””}”(hŒQ in the above example were wrong then the compiler would emit an error like this:”h!jhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKÕh!jÃhhubj¾ )”}”(hŒWmy_struct.h:10:1: error: size of array â€˜assert_my_struct_size_mismatchâ€™ is negative”h]”hŒWmy_struct.h:10:1: error: size of array â€˜assert_my_struct_size_mismatchâ€™ is negative”…””}”(hhh!j7ubah"}”(h$]”h&]”h+]”h-]”h/]”jÐ jÑ uh1j½ hAj¡hCKÚh!jÃhhubeh"}”(h$]”Œ3using-cassert-to-check-for-compile-time-data-errors”ah&]”h+]”Œ3using cassert to check for compile time data errors”ah-]”h/]”uh1jŒh!j²hhhAj¡hCK¾ubj)”}”(hhh]”(j’)”}”(hŒ.Using assert() to check for programming errors”h]”hŒ.Using assert() to check for programming errors”…””}”(hjRh!jPhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!jMhhhAj¡hCKÞubj£)”}”(hX~In general, each secure world TF image (BL1, BL2, BL31 and BL32) should be treated as a tightly integrated package; the image builder should be aware of and responsible for all functionality within the image, even if code within that image is provided by multiple entities. This allows us to be more aggressive in interpreting invalid state or bad function arguments as programming errors using ``assert()``, including arguments passed across platform porting interfaces. This is in contrast to code in a Linux environment, which is less tightly integrated and may attempt to be more defensive by passing the error back up the call stack.”h]”(hX‹In general, each secure world TF image (BL1, BL2, BL31 and BL32) should be treated as a tightly integrated package; the image builder should be aware of and responsible for all functionality within the image, even if code within that image is provided by multiple entities. This allows us to be more aggressive in interpreting invalid state or bad function arguments as programming errors using ”…””}”(hX‹In general, each secure world TF image (BL1, BL2, BL31 and BL32) should be treated as a tightly integrated package; the image builder should be aware of and responsible for all functionality within the image, even if code within that image is provided by multiple entities. This allows us to be more aggressive in interpreting invalid state or bad function arguments as programming errors using ”h!j^hhhANhCNubj.)”}”(hŒ``assert()``”h]”hŒassert()”…””}”(hhh!jgubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j^ubhŒç, including arguments passed across platform porting interfaces. This is in contrast to code in a Linux environment, which is less tightly integrated and may attempt to be more defensive by passing the error back up the call stack.”…””}”(hŒç, including arguments passed across platform porting interfaces. This is in contrast to code in a Linux environment, which is less tightly integrated and may attempt to be more defensive by passing the error back up the call stack.”h!j^hhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKàh!jMhhubj£)”}”(hXWhere possible, badly written TF code should fail early using ``assert()``. This helps reduce the amount of untested conditional code. By default these statements are not compiled into release builds, although this can be overridden using the ``ENABLE_ASSERTIONS`` build flag.”h]”(hŒ>Where possible, badly written TF code should fail early using ”…””}”(hŒ>Where possible, badly written TF code should fail early using ”h!j€hhhANhCNubj.)”}”(hŒ``assert()``”h]”hŒassert()”…””}”(hhh!j‰ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j€ubhŒ©. This helps reduce the amount of untested conditional code. By default these statements are not compiled into release builds, although this can be overridden using the ”…””}”(hŒ©. This helps reduce the amount of untested conditional code. By default these statements are not compiled into release builds, although this can be overridden using the ”h!j€hhhANhCNubj.)”}”(hŒ``ENABLE_ASSERTIONS``”h]”hŒENABLE_ASSERTIONS”…””}”(hhh!jœubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j€ubhŒ build flag.”…””}”(hŒ build flag.”h!j€hhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKêh!jMhhubj£)”}”(hŒ Examples:”h]”hŒ Examples:”…””}”(hj·h!jµhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKïh!jMhhubj[)”}”(hhh]”(j`)”}”(hŒ)Bad argument supplied to library function”h]”j£)”}”(hjÈh]”hŒ)Bad argument supplied to library function”…””}”(hjÈh!jÊubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKñh!jÆubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jÃhhhAj¡hCNubj`)”}”(hŒ2Bad argument provided by platform porting function”h]”j£)”}”(hjßh]”hŒ2Bad argument provided by platform porting function”…””}”(hjßh!jáubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKòh!jÝubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jÃhhhAj¡hCNubj`)”}”(hŒ3Internal secure world image state is inconsistent ”h]”j£)”}”(hŒ1Internal secure world image state is inconsistent”h]”hŒ1Internal secure world image state is inconsistent”…””}”(hjúh!jøubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKóh!jôubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jÃhhhAj¡hCNubeh"}”(h$]”h&]”h+]”h-]”h/]”jÌjÍuh1jZhAj¡hCKñh!jMhhubeh"}”(h$]”Œ,using-assert-to-check-for-programming-errors”ah&]”h+]”Œ.using assert() to check for programming errors”ah-]”h/]”uh1jŒh!j²hhhAj¡hCKÞubj)”}”(hhh]”(j’)”}”(hŒHandling integration errors”h]”hŒHandling integration errors”…””}”(hjh!jhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!jhhhAj¡hCK÷ubj£)”}”(hŒÚEach secure world image may be provided by a different entity (for example, a Trusted Boot vendor may provide the BL2 image, a TEE vendor may provide the BL32 image and the OEM/SoC vendor may provide the other images).”h]”hŒÚEach secure world image may be provided by a different entity (for example, a Trusted Boot vendor may provide the BL2 image, a TEE vendor may provide the BL32 image and the OEM/SoC vendor may provide the other images).”…””}”(hj-h!j+hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKùh!jhhubj£)”}”(hX½An image may contain bugs that are only visible when the images are integrated. The system integrator may not even have access to the debug variants of all the images in order to check if asserts are firing. For example, the release variant of BL1 may have already been burnt into the SoC. Therefore, TF code that detects an integration error should _not_ consider this a programming error, and should always take action, even in release builds.”•Åâh]”hX½An image may contain bugs that are only visible when the images are integrated. The system integrator may not even have access to the debug variants of all the images in order to check if asserts are firing. For example, the release variant of BL1 may have already been burnt into the SoC. Therefore, TF code that detects an integration error should _not_ consider this a programming error, and should always take action, even in release builds.”…””}”(hj;h!j9hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCKýh!jhhubj£)”}”(hŒ¾If an integration error is considered non-critical it should be treated as a recoverable error. If the error is considered critical it should be treated as an unexpected unrecoverable error.”h]”hŒ¾If an integration error is considered non-critical it should be treated as a recoverable error. If the error is considered critical it should be treated as an unexpected unrecoverable error.”…””}”(hjIh!jGhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!jhhubeh"}”(h$]”Œhandling-integration-errors”ah&]”h+]”Œhandling integration errors”ah-]”h/]”uh1jŒh!j²hhhAj¡hCK÷ubj)”}”(hhh]”(j’)”}”(hŒHandling recoverable errors”h]”hŒHandling recoverable errors”…””}”(hjbh!j`hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!j]hhhAj¡hCM ubj£)”}”(hX•The secure world **must not** crash when supplied with bad data from an external source. For example, data from the normal world or a hardware device. Similarly, the secure world **must not** crash if it detects a non-critical problem within itself or the system. It must make every effort to recover from the problem by emitting a ``WARN`` message, performing any necessary error handling and continuing.”h]”(hŒThe secure world ”…””}”(hŒThe secure world ”h!jnhhhANhCNubh Œstrong”“”)”}”(hŒ**must not**”h]”hŒmust not”…””}”(hhh!jyubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jwh!jnubhŒ– crash when supplied with bad data from an external source. For example, data from the normal world or a hardware device. Similarly, the secure world ”…””}”(hŒ– crash when supplied with bad data from an external source. For example, data from the normal world or a hardware device. Similarly, the secure world ”h!jnhhhANhCNubjx)”}”(hŒ**must not**”h]”hŒmust not”…””}”(hhh!jŒubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jwh!jnubhŒ crash if it detects a non-critical problem within itself or the system. It must make every effort to recover from the problem by emitting a ”…””}”(hŒ crash if it detects a non-critical problem within itself or the system. It must make every effort to recover from the problem by emitting a ”h!jnhhhANhCNubj.)”}”(hŒ``WARN``”h]”hŒWARN”…””}”(hhh!jŸubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jnubhŒA message, performing any necessary error handling and continuing.”…””}”(hŒA message, performing any necessary error handling and continuing.”h!jnhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!j]hhubj£)”}”(hŒ Examples:”h]”hŒ Examples:”…””}”(hjºh!j¸hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!j]hhubj[)”}”(hhh]”(j`)”}”(hŒ?Secure world receives SMC from normal world with bad arguments.”h]”j£)”}”(hjËh]”hŒ?Secure world receives SMC from normal world with bad arguments.”…””}”(hjËh!jÍubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!jÉubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jÆhhhAj¡hCNubj`)”}”(hŒBSecure world receives SMC from normal world at an unexpected time.”h]”j£)”}”(hjâh]”hŒBSecure world receives SMC from normal world at an unexpected time.”…””}”(hjâh!jäubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!jàubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jÆhhhAj¡hCNubj`)”}”(hŒ/BL31 receives SMC from BL32 with bad arguments.”h]”j£)”}”(hjùh]”hŒ/BL31 receives SMC from BL32 with bad arguments.”…””}”(hjùh!jûubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!j÷ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jÆhhhAj¡hCNubj`)”}”(hŒ/BL31 receives SMC from BL32 at unexpected time.”h]”j£)”}”(hjh]”hŒ/BL31 receives SMC from BL32 at unexpected time.”…””}”(hjh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jÆhhhAj¡hCNubj`)”}”(hŒcSecure world receives recoverable error from hardware device. Retrying the operation may help here.”h]”j£)”}”(hŒcSecure world receives recoverable error from hardware device. Retrying the operation may help here.”h]”hŒcSecure world receives recoverable error from hardware device. Retrying the operation may help here.”…””}”(hj+h!j)ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!j%ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jÆhhhAj¡hCNubj`)”}”(hŒ?Non-critical secure world service is not functioning correctly.”h]”j£)”}”(hj?h]”hŒ?Non-critical secure world service is not functioning correctly.”…””}”(hj?h!jAubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!j=ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jÆhhhAj¡hCNubj`)”}”(hŒFBL31 SPD discovers minor configuration problem with corresponding SP. ”h]”j£)”}”(hŒEBL31 SPD discovers minor configuration problem with corresponding SP.”h]”hŒEBL31 SPD discovers minor configuration problem with corresponding SP.”…””}”(hjZh!jXubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!jTubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jÆhhhAj¡hCNubeh"}”(h$]”h&]”h+]”h-]”h/]”jÌjÍuh1jZhAj¡hCMh!j]hhubeh"}”(h$]”Œhandling-recoverable-errors”ah&]”h+]”Œhandling recoverable errors”ah-]”h/]”uh1jŒh!j²hhhAj¡hCM ubj)”}”(hhh]”(j’)”}”(hŒHandling unrecoverable errors”h]”hŒHandling unrecoverable errors”…””}”(hjh!j}hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!jzhhhAj¡hCMubj£)”}”(hŒ’In some cases it may not be possible for the secure world to recover from an error. This situation should be handled in one of the following ways:”h]”hŒ’In some cases it may not be possible for the secure world to recover from an error. This situation should be handled in one of the following ways:”…””}”(hjh!j‹hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM h!jzhhubh Œenumerated_list”“”)”}”(hhh]”(j`)”}”(hŒ¯If the unrecoverable error is unexpected then emit an ``ERROR`` message and call ``panic()``. This will end up calling the platform-specific function ``plat_panic_handler()``.”h]”j£)”}”(hŒ¯If the unrecoverable error is unexpected then emit an ``ERROR`` message and call ``panic()``. This will end up calling the platform-specific function ``plat_panic_handler()``.”h]”(hŒ6If the unrecoverable error is unexpected then emit an ”…””}”(hŒ6If the unrecoverable error is unexpected then emit an ”h!j¢ubj.)”}”(hŒ ``ERROR``”h]”hŒERROR”…””}”(hhh!j«ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j¢ubhŒ message and call ”…””}”(hŒ message and call ”h!j¢ubj.)”}”(hŒ``panic()``”h]”hŒpanic()”…””}”(hhh!j¾ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j¢ubhŒ:. This will end up calling the platform-specific function ”…””}”(hŒ:. This will end up calling the platform-specific function ”h!j¢ubj.)”}”(hŒ``plat_panic_handler()``”h]”hŒplat_panic_handler()”…””}”(hhh!jÑubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j¢ubhŒ.”…””}”(hjòh!j¢ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM#h!jžubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j›hhhAj¡hCNubj`)”}”(hŒ«If the unrecoverable error is expected to occur in certain circumstances, then emit an ``ERROR`` message and call the platform-specific function ``plat_error_handler()``. ”h]”j£)”}”(hŒªIf the unrecoverable error is expected to occur in certain circumstances, then emit an ``ERROR`` message and call the platform-specific function ``plat_error_handler()``.”h]”(hŒWIf the unrecoverable error is expected to occur in certain circumstances, then emit an ”…””}”(hŒWIf the unrecoverable error is expected to occur in certain circumstances, then emit an ”h!jóubj.)”}”(hŒ ``ERROR``”h]”hŒERROR”…””}”(hhh!jüubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jóubhŒ1 message and call the platform-specific function ”…””}”(hŒ1 message and call the platform-specific function ”h!jóubj.)”}”(hŒ``plat_error_handler()``”h]”hŒplat_error_handler()”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jóubhŒ.”…””}”(hjòh!jóubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM&h!jïubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j›hhhAj¡hCNubeh"}”(h$]”h&]”h+]”h-]”h/]”Œenumtype”Œarabic”Œprefix”hŒsuffix”jòuh1j™h!jzhhhAj¡hCM#ubj£)”}”(hX%Cases 1 and 2 are subtly different. A platform may implement ``plat_panic_handler`` and ``plat_error_handler`` in the same way (for example, by waiting for a secure watchdog to time-out or by invoking an interface on the platform's power controller to reset the platform). However, ``plat_error_handler`` may take additional action for some errors (for example, it may set a flag so the platform resets into a different mode). Also, ``plat_panic_handler()`` may implement additional debug functionality (for example, invoking a hardware breakpoint).”h]”(hŒ=Cases 1 and 2 are subtly different. A platform may implement ”…””}”(hŒ=Cases 1 and 2 are subtly different. A platform may implement ”h!j7hhhANhCNubj.)”}”(hŒ``plat_panic_handler``”h]”hŒplat_panic_handler”…””}”(hhh!j@ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j7ubhŒ and ”…””}”(hŒ and ”h!j7hhhANhCNubj.)”}”(hŒ``plat_error_handler``”h]”hŒplat_error_handler”…””}”(hhh!jSubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j7ubhŒ® in the same way (for example, by waiting for a secure watchdog to time-out or by invoking an interface on the platformâ€™s power controller to reset the platform). However, ”…””}”(hŒ¬ in the same way (for example, by waiting for a secure watchdog to time-out or by invoking an interface on the platform's power controller to reset the platform). However, ”h!j7hhhANhCNubj.)”}”(hŒ``plat_error_handler``”h]”hŒplat_error_handler”…””}”(hhh!jfubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j7ubhŒ may take additional action for some errors (for example, it may set a flag so the platform resets into a different mode). Also, ”…””}”(hŒ may take additional action for some errors (for example, it may set a flag so the platform resets into a different mode). Also, ”h!j7hhhANhCNubj.)”}”(hŒ``plat_panic_handler()``”h]”hŒplat_panic_handler()”…””}”(hhh!jyubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j7ubhŒ\ may implement additional debug functionality (for example, invoking a hardware breakpoint).”…””}”(hŒ\ may implement additional debug functionality (for example, invoking a hardware breakpoint).”h!j7hhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM*h!jzhhubj£)”}”(hŒ,Examples of unexpected unrecoverable errors:”h]”hŒ,Examples of unexpected unrecoverable errors:”…””}”(hj”h!j’hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM3h!jzhhubj[)”}”(hhh]”(j`)”}”(hŒUBL32 receives an unexpected SMC response from BL31 that it is unable to recover from.”h]”j£)”}”(hŒUBL32 receives an unexpected SMC response from BL31 that it is unable to recover from.”h]”hŒUBL32 receives an unexpected SMC response from BL31 that it is unable to recover from.”…””}”(hj©h!j§ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM5h!j£ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j hhhAj¡hCNubj`)”}”(hŒ‚BL31 Trusted OS SPD code discovers that BL2 has not loaded the corresponding Trusted OS, which is critical for platform operation.”h]”j£)”}”(hŒ‚BL31 Trusted OS SPD code discovers that BL2 has not loaded the corresponding Trusted OS, which is critical for platform operation.”h]”hŒ‚BL31 Trusted OS SPD code discovers that BL2 has not loaded the corresponding Trusted OS, which is critical for platform operation.”…””}”(hjÁh!j¿ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM7h!j»ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j hhhAj¡hCNubj`)”}”(hŒ`Secure world discovers that a critical hardware device is an unexpected and unrecoverable state.”h]”j£)”}”(hŒ`Secure world discovers that a critical hardware device is an unexpected and unrecoverable state.”h]”hŒ`Secure world discovers that a critical hardware device is an unexpected and unrecoverable state.”…””}”(hjÙh!j×ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM9h!jÓubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j hhhAj¡hCNubj`)”}”(hŒ\Secure world receives an unexpected and unrecoverable error from a critical hardware device.”h]”j£)”}”(hŒ\Secure world receives an unexpected and unrecoverable error from a critical hardware device.”h]”hŒ\Secure world receives an unexpected and unrecoverable error from a critical hardware device.”…””}”(hjñh!jïubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM;h!jëubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j hhhAj¡hCNubj`)”}”(hŒCSecure world discovers that it is running on unsupported hardware. ”h]”j£)”}”(hŒBSecure world discovers that it is running on unsupported hardware.”h]”hŒBSecure world discovers that it is running on unsupported hardware.”…””}”(hj h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM=h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j hhhAj¡hCNubeh"}”(h$]”h&]”h+]”h-]”h/]”jÌjÍuh1jZhAj¡hCM5h!jzhhubj£)”}”(hŒ*Examples of expected unrecoverable errors:”h]”hŒ*Examples of expected unrecoverable errors:”…””}”(hj#h!j!hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM?h!jzhhubj[)”}”(hhh]”(j`)”}”(hŒMBL1/BL2 fails to load the next image due to missing/corrupt firmware on disk.”h]”j£)”}”(hj4h]”hŒMBL1/BL2 fails to load the next image due to missing/corrupt firmware on disk.”…””}”(hj4h!j6ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMAh!j2ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j/hhhAj¡hCNubj`)”}”(hŒKBL1/BL2 fails to authenticate the next image due to an invalid certificate.”h]”j£)”}”(hjKh]”hŒKBL1/BL2 fails to authenticate the next image due to an invalid certificate.”…””}”(hjKh!jMubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMBh!jIubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j/hhhAj¡hCNubj`)”}”(hŒ€Secure world continuously receives recoverable errors from a hardware device but is unable to proceed without a valid response. ”h]”j£)”}”(hŒSecure world continuously receives recoverable errors from a hardware device but is unable to proceed without a valid response.”h]”hŒSecure world continuously receives recoverable errors from a hardware device but is unable to proceed without a valid response.”…””}”(hjfh!jdubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMCh!j`ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j/hhhAj¡hCNubeh"}”(h$]”h&]”h+]”h-]”h/]”jÌjÍuh1jZhAj¡hCMAh!jzhhubeh"}”(h$]”Œhandling-unrecoverable-errors”ah&]”h+]”Œhandling unrecoverable errors”ah-]”h/]”uh1jŒh!j²hhhAj¡hCMubj)”}”(hhh]”(j’)”}”(hŒ"Handling critical unresponsiveness”h]”hŒ"Handling critical unresponsiveness”…””}”(hj‹h!j‰hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!j†hhhAj¡hCMGubj£)”}”(hXoIf the secure world is waiting for a response from an external source (for example, the normal world or a hardware device) which is critical for continued operation, it must not wait indefinitely. It must have a mechanism (for example, a secure watchdog) for resetting itself and/or the external source to prevent the system from executing in this state indefinitely.”h]”hXoIf the secure world is waiting for a response from an external source (for example, the normal world or a hardware device) which is critical for continued operation, it must not wait indefinitely. It must have a mechanism (for example, a secure watchdog) for resetting itself and/or the external source to prevent the system from executing in this state indefinitely.”…””}”(hj™h!j—hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMIh!j†hhubj£)”}”(hŒ Examples:”h]”hŒ Examples:”…””}”(hj§h!j¥hhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMOh!j†hhubj[)”}”(hhh]”(j`)”}”(hŒwBL1 is waiting for the normal world to raise an SMC to proceed to the next stage of the secure firmware update process.”h]”j£)”}”(hŒwBL1 is waiting for the normal world to raise an SMC to proceed to the next stage of the secure firmware update process.”h]”hŒwBL1 is waiting for the normal world to raise an SMC to proceed to the next stage of the secure firmware update process.”…””}”(hj¼h!jºubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMQh!j¶ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j³hhhAj¡hCNubj`)”}”(hŒqA Trusted OS is waiting for a response from a proxy in the normal world that is critical for continued operation.”h]”j£)”}”(hŒqA Trusted OS is waiting for a response from a proxy in the normal world that is critical for continued operation.”h]”hŒqA Trusted OS is waiting for a response from a proxy in the normal world that is critical for continued operation.”…””}”(hjÔh!jÒubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMSh!jÎubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j³hhhAj¡hCNubj`)”}”(hŒZSecure world is waiting for a hardware response that is critical for continued operation. ”h]”j£)”}”(hŒYSecure world is waiting for a hardware response that is critical for continued operation.”h]”hŒYSecure world is waiting for a hardware response that is critical for continued operation.”…””}”(hjìh!jêubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMUh!jæubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j³hhhAj¡hCNubeh"}”(h$]”h&]”h+]”h-]”h/]”jÌjÍuh1jZhAj¡hCMQh!j†hhubeh"}”(h$]”Œ"handling-critical-unresponsiveness”ah&]”h+]”Œ"handling critical unresponsiveness”ah-]”h/]”uh1jŒh!j²hhhAj¡hCMGubeh"}”(h$]”Œerror-handling-and-robustness”ah&]”h+]”Œerror handling and robustness”ah-]”h/]”uh1jŒh!jŽhhhAj¡hCK»ubj)”}”(hhh]”(j’)”}”(hŒ)Use of built-in *C* and *libc* data types”h]”(hŒUse of built-in ”…””}”(hŒUse of built-in ”h!jhhhANhCNubjË)”}”(hŒ*C*”h]”hŒC”…””}”(hhh!j ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!jubhŒ and ”…””}”(hŒ and ”h!jhhhANhCNubjË)”}”(hŒ*libc*”h]”hŒlibc”…””}”(hhh!j3ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!jubhŒ data types”…””}”(hŒ data types”h!jhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!jhhhAj¡hCMYubj£)”}”(hŒÌThe |TF-A| codebase should be kept as portable as possible, especially since both 64-bit and 32-bit platforms are supported. To help with this, the following data type usage guidelines should be followed:”h]”(hŒThe ”…””}”(hŒThe ”h!jLhhhANhCNubh)”}”(hj¹ h]”h)”}”(hj¹ h]”hŒTF-A”…””}”(hhh!jXubah"}”(h$]”h&]”(h(jÅ jÆ eh+]”h-]”h/]”uh1hhANhCNh!jUubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”jÅ Œreftype”jÓ Œrefexplicit”‰Œrefwarn”ˆŒ reftarget”jÖ uh1hhAhBhCK:h!jLhhubhŒÂ codebase should be kept as portable as possible, especially since both 64-bit and 32-bit platforms are supported. To help with this, the following data type usage guidelines should be followed:”…””}”(hŒÂ codebase should be kept as portable as possible, especially since both 64-bit and 32-bit platforms are supported. To help with this, the following data type usage guidelines should be followed:”h!jLhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM[h!jhhubj[)”}”(hhh]”(j`)”}”(hXWhere possible, use the built-in *C* data types for variable storage (for example, ``char``, ``int``, ``long long``, etc) instead of the standard *C99* types. Most code is typically only concerned with the minimum size of the data stored, which the built-in *C* types guarantee. ”h]”j£)”}”(hXWhere possible, use the built-in *C* data types for variable storage (for example, ``char``, ``int``, ``long long``, etc) instead of the standard *C99* types. Most code is typically only concerned with the minimum size of the data stored, which the built-in *C* types guarantee.”h]”(hŒ!Where possible, use the built-in ”…””}”(hŒ!Where possible, use the built-in ”h!jƒubjË)”}”(hŒ*C*”h]”hŒC”…””}”(hhh!jŒubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!jƒubhŒ/ data types for variable storage (for example, ”…””}”(hŒ/ data types for variable storage (for example, ”h!jƒubj.)”}”(hŒ``char``”h]”hŒchar”…””}”(hhh!jŸubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jƒubhŒ, ”…””}”(hŒ, ”h!jƒubj.)”}”(hŒ``int``”h]”hŒint”…””}”(hhh!j²ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jƒubhŒ, ”…””}”(hj±h!jƒubj.)”}”(hŒ ``long long``”h]”hŒ long long”…””}”(hhh!jÄubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jƒubhŒ, etc) instead of the standard ”…””}”(hŒ, etc) instead of the standard ”h!jƒubjË)”}”(hŒ*C99*”h]”hŒC99”…””}”(hhh!j×ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!jƒubhŒk types. Most code is typically only concerned with the minimum size of the data stored, which the built-in ”…””}”(hŒk types. Most code is typically only concerned with the minimum size of the data stored, which the built-in ”h!jƒubjË)”}”(hŒ*C*”h]”hŒC”…””}”(hhh!jêubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!jƒubhŒ types guarantee.”…””}”(hŒ types guarantee.”h!jƒubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM_h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhAj¡hCNubj`)”}”(hXéAvoid using the exact-size standard *C99* types in general (for example, ``uint16_t``, ``uint32_t``, ``uint64_t``, etc) since they can prevent the compiler from making optimizations. There are legitimate uses for them, for example to represent data of a known structure. When using them in struct definitions, consider how padding in the struct will work across architectures. For example, extra padding may be introduced in |AArch32| systems if a struct member crosses a 32-bit boundary. ”h]”j£)”}”(hXèAvoid using the exact-size standard *C99* types in general (for example, ``uint16_t``, ``uint32_t``, ``uint64_t``, etc) since they can prevent the compiler from making optimizations. There are legitimate uses for them, for example to represent data of a known structure. When using them in struct definitions, consider how padding in the struct will work across architectures. For example, extra padding may be introduced in |AArch32| systems if a struct member crosses a 32-bit boundary.”h]”(hŒ$Avoid using the exact-size standard ”…””}”(hŒ$Avoid using the exact-size standard ”h!j ubjË)”}”(hŒ*C99*”h]”hŒC99”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!j ubhŒ types in general (for example, ”…””}”(hŒ types in general (for example, ”h!j ubj.)”}”(hŒ``uint16_t``”h]”hŒuint16_t”…””}”(hhh!j)ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j ubhŒ, ”…””}”(hŒ, ”h!j ubj.)”}”(hŒ``uint32_t``”h]”hŒuint32_t”…””}”(hhh!j<ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j ubhŒ, ”…””}”(hj;h!j ubj.)”}”(hŒ``uint64_t``”h]”hŒuint64_t”…””}”(hhh!jNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j ubhX8, etc) since they can prevent the compiler from making optimizations. There are legitimate uses for them, for example to represent data of a known structure. When using them in struct definitions, consider how padding in the struct will work across architectures. For example, extra padding may be introduced in ”…””}”(hX8, etc) since they can prevent the compiler from making optimizations. There are legitimate uses for them, for example to represent data of a known structure. When using them in struct definitions, consider how padding in the struct will work across architectures. For example, extra padding may be introduced in ”h!j ubh)”}”(hhh]”h)”}”(hhh]”hŒAArch32”…””}”(hhh!jdubah"}”(h$]”h&]”(h(h)h*eh+]”h-]”h/]”uh1hhANhCNh!jaubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”h)Œreftype”h<Œrefexplicit”‰Œrefwarn”ˆŒ reftarget”h@uh1hhAhBhCKh!j ubhŒ6 systems if a struct member crosses a 32-bit boundary.”…””}”(hŒ6 systems if a struct member crosses a 32-bit boundary.”h!j ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMdh!j ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhAj¡hCNubj`)”}”(hXUse ``int`` as the default integer type - it's likely to be the fastest on all systems. Also this can be assumed to be 32-bit as a consequence of the `Procedure Call Standard for the Arm Architecture`_ and the `Procedure Call Standard for the Arm 64-bit Architecture`_ . ”h]”j£)”}”(hXUse ``int`` as the default integer type - it's likely to be the fastest on all systems. Also this can be assumed to be 32-bit as a consequence of the `Procedure Call Standard for the Arm Architecture`_ and the `Procedure Call Standard for the Arm 64-bit Architecture`_ .”h]”(hŒUse ”…””}”(hŒUse ”h!j’ubj.)”}”(hŒ``int``”h]”hŒint”…””}”(hhh!j›ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j’ubhŒ as the default integer type - itâ€™s likely to be the fastest on all systems. Also this can be assumed to be 32-bit as a consequence of the ”…””}”(hŒ‹ as the default integer type - it's likely to be the fastest on all systems. Also this can be assumed to be 32-bit as a consequence of the ”h!j’ubj)”}”(hŒ3`Procedure Call Standard for the Arm Architecture`_”h]”hŒ0Procedure Call Standard for the Arm Architecture”…””}”(hŒ0Procedure Call Standard for the Arm Architecture”h!j®ubah"}”(h$]”h&]”h+]”h-]”h/]”Œname”Œ0Procedure Call Standard for the Arm Architecture”j%Œ.https://developer.arm.com/docs/ihi0042/latest/”uh1jh!j’j'KubhŒ and the ”…””}”(hŒ and the ”h!j’ubj)”}”(hŒ:`Procedure Call Standard for the Arm 64-bit Architecture`_”h]”hŒ7Procedure Call Standard for the Arm 64-bit Architecture”…””}”(hŒ7Procedure Call Standard for the Arm 64-bit Architecture”h!jÅubah"}”(h$]”h&]”h+]”h-]”h/]”Œname”Œ7Procedure Call Standard for the Arm 64-bit Architecture”j%Œ.https://developer.arm.com/docs/ihi0055/latest/”uh1jh!j’j'KubhŒ .”…””}”(hŒ .”h!j’ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMlh!jŽubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhAj¡hCNubj`)”}”(hŒœAvoid use of ``short`` as this may end up being slower than ``int`` in some systems. If a variable must be exactly 16-bit, use ``int16_t`` or ``uint16_t``. ”h]”j£)”}”(hŒ›Avoid use of ``short`` as this may end up being slower than ``int`` in some systems. If a variable must be exactly 16-bit, use ``int16_t`` or ``uint16_t``.”h]”(hŒ Avoid use of ”…””}”(hŒ Avoid use of ”h!jìubj.)”}”(hŒ ``short``”h]”hŒshort”…””}”(hhh!jõubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jìubhŒ& as this may end up being slower than ”…””}”(hŒ& as this may end up being slower than ”h!jìubj.)”}”(hŒ``int``”h]”hŒint”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jìubhŒ< in some systems. If a variable must be exactly 16-bit, use ”…””}”(hŒ< in some systems. If a variable must be exactly 16-bit, use ”h!jìubj.)”}”(hŒ``int16_t``”h]”hŒint16_t”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jìubhŒ or ”…””}”(hŒ or ”h!jìubj.)”}”(hŒ``uint16_t``”h]”hŒuint16_t”…””}”(hhh!j.ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jìubhŒ.”…””}”(hjòh!jìubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMqh!jèubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhAj¡hCNubj`)”}”(hŒ¾Avoid use of ``long``. This is guaranteed to be at least 32-bit but, given that `int` is 32-bit on Arm platforms, there is no use for it. For integers of at least 64-bit, use ``long long``. ”h]”j£)”}”(hŒ½Avoid use of ``long``. This is guaranteed to be at least 32-bit but, given that `int` is 32-bit on Arm platforms, there is no use for it. For integers of at least 64-bit, use ``long long``.”h]”(hŒ Avoid use of ”…””}”(hŒ Avoid use of ”h!jPubj.)”}”(hŒ``long``”h]”hŒlong”…””}”(hhh!jYubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jPubhŒ;. This is guaranteed to be at least 32-bit but, given that ”…””}”(hŒ;. This is guaranteed to be at least 32-bit but, given that ”h!jPubj¶)”}”(hŒ`int`”h]”hŒint”…””}”(hhh!jlubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jµh!jPubhŒZ is 32-bit on Arm platforms, there is no use for it. For integers of at least 64-bit, use ”…””}”(hŒZ is 32-bit on Arm platforms, there is no use for it. For integers of at least 64-bit, use ”h!jPubj.)”}”(hŒ ``long long``”h]”hŒ long long”…””}”(hhh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jPubhŒ.”…””}”(hjòh!jPubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMuh!jLubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhAj¡hCNubj`)”}”(hŒMUse ``char`` for storing text. Use ``uint8_t`` for storing other 8-bit data. ”h]”j£)”}”(hŒLUse ``char`` for storing text. Use ``uint8_t`` for storing other 8-bit data.”h]”(hŒUse ”…””}”(hŒUse ”h!j¡ubj.)”}”(hŒ``char``”h]”hŒchar”…””}”(hhh!jªubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j¡ubhŒ for storing text. Use ”…””}”(hŒ for storing text. Use ”h!j¡ubj.)”}”(hŒ``uint8_t``”h]”hŒuint8_t”…””}”(hhh!j½ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j¡ubhŒ for storing other 8-bit data.”…””}”(hŒ for storing other 8-bit data.”h!j¡ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMyh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhAj¡hCNubj`)”}”(hX…Use ``unsigned`` for integers that can never be negative (counts, indices, sizes, etc). TF intends to comply with MISRA "essential type" coding rules (10.X), where signed and unsigned types are considered different essential types. Choosing the correct type will aid this. MISRA static analysers will pick up any implicit signed/unsigned conversions that may lead to unexpected behaviour. ”h]”j£)”}”(hX„Use ``unsigned`` for integers that can never be negative (counts, indices, sizes, etc). TF intends to comply with MISRA "essential type" coding rules (10.X), where signed and unsigned types are considered different essential types. Choosing the correct type will aid this. MISRA static analysers will pick up any implicit signed/unsigned conversions that may lead to unexpected behaviour.”h]”(hŒUse ”…””}”(hŒUse ”h!jàubj.)”}”(hŒ``unsigned``”h]”hŒunsigned”…””}”(hhh!jéubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jàubhXx for integers that can never be negative (counts, indices, sizes, etc). TF intends to comply with MISRA â€œessential typeâ€ coding rules (10.X), where signed and unsigned types are considered different essential types. Choosing the correct type will aid this. MISRA static analysers will pick up any implicit signed/unsigned conversions that may lead to unexpected behaviour.”…””}”(hXt for integers that can never be negative (counts, indices, sizes, etc). TF intends to comply with MISRA "essential type" coding rules (10.X), where signed and unsigned types are considered different essential types. Choosing the correct type will aid this. MISRA static analysers will pick up any implicit signed/unsigned conversions that may lead to unexpected behaviour.”h!jàubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM{h!jÜubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhAj¡hCNubj`)”}”(hXŽFor pointer types: - If an argument in a function declaration is pointing to a known type then simply use a pointer to that type (for example: ``struct my_struct *``). - If a variable (including an argument in a function declaration) is pointing to a general, memory-mapped address, an array of pointers or another structure that is likely to require pointer arithmetic then use ``uintptr_t``. This will reduce the amount of casting required in the code. Avoid using ``unsigned long`` or ``unsigned long long`` for this purpose; it may work but is less portable. - For other pointer arguments in a function declaration, use ``void *``. This includes pointers to types that are abstracted away from the known API and pointers to arbitrary data. This allows the calling function to pass a pointer argument to the function without any explicit casting (the cast to ``void *`` is implicit). The function implementation can then do the appropriate casting to a specific type. - Avoid pointer arithmetic generally (as this violates MISRA C 2012 rule 18.4) and especially on void pointers (as this is only supported via language extensions and is considered non-standard). In TF-A, setting the ``W`` build flag to ``W=3`` enables the *-Wpointer-arith* compiler flag and this will emit warnings where pointer arithmetic is used. - Use ``ptrdiff_t`` to compare the difference between 2 pointers. ”h]”(j£)”}”(hŒFor pointer types:”h]”hŒFor pointer types:”…””}”(hjh!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM‚h!jubj[)”}”(hhh]”(j`)”}”(hŒ“If an argument in a function declaration is pointing to a known type then simply use a pointer to that type (for example: ``struct my_struct *``). ”h]”j£)”}”(hŒ’If an argument in a function declaration is pointing to a known type then simply use a pointer to that type (for example: ``struct my_struct *``).”h]”(hŒzIf an argument in a function declaration is pointing to a known type then simply use a pointer to that type (for example: ”…””}”(hŒzIf an argument in a function declaration is pointing to a known type then simply use a pointer to that type (for example: ”h!j!ubj.)”}”(hŒ``struct my_struct *``”h]”hŒstruct my_struct *”…””}”(hhh!j*ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j!ubhŒ).”…””}”(hŒ).”h!j!ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM„h!jubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jubj`)”}”(hX‰If a variable (including an argument in a function declaration) is pointing to a general, memory-mapped address, an array of pointers or another structure that is likely to require pointer arithmetic then use ``uintptr_t``. This will reduce the amount of casting required in the code. Avoid using ``unsigned long`` or ``unsigned long long`` for this purpose; it may work but is less portable. ”h]”j£)”}”(hXˆIf a variable (including an argument in a function declaration) is pointing to a general, memory-mapped address, an array of pointers or another structure that is likely to require pointer arithmetic then use ``uintptr_t``. This will reduce the amount of casting required in the code. Avoid using ``unsigned long`` or ``unsigned long long`` for this purpose; it may work but is less portable.”h]”(hŒÑIf a variable (including an argument in a function declaration) is pointing to a general, memory-mapped address, an array of pointers or another structure that is likely to require pointer arithmetic then use ”…””}”(hŒÑIf a variable (including an argument in a function declaration) is pointing to a general, memory-mapped address, an array of pointers or another structure that is likely to require pointer arithmetic then use ”h!jMubj.)”}”(hŒ ``uintptr_t``”h]”hŒ uintptr_t”…””}”(hhh!jVubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jMubhŒK. This will reduce the amount of casting required in the code. Avoid using ”…””}”(hŒK. This will reduce the amount of casting required in the code. Avoid using ”h!jMubj.)”}”(hŒ``unsigned long``”h]”hŒ unsigned long”…””}”(hhh!jiubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jMubhŒ or ”…””}”(hŒ or ”h!jMubj.)”}”(hŒ``unsigned long long``”h]”hŒunsigned long long”…””}”(hhh!j|ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jMubhŒ4 for this purpose; it may work but is less portable.”…””}”(hŒ4 for this purpose; it may work but is less portable.”h!jMubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM‡h!jIubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jubj`)”}”(hX–For other pointer arguments in a function declaration, use ``void *``. This includes pointers to types that are abstracted away from the known API and pointers to arbitrary data. This allows the calling function to pass a pointer argument to the function without any explicit casting (the cast to ``void *`` is implicit). The function implementation can then do the appropriate casting to a specific type. ”h]”j£)”}”(hX•For other pointer arguments in a function declaration, use ``void *``. This includes pointers to types that are abstracted away from the known API and pointers to arbitrary data. This allows the calling function to pass a pointer argument to the function without any explicit casting (the cast to ``void *`` is implicit). The function implementation can then do the appropriate casting to a specific type.”h]”(hŒ;For other pointer arguments in a function declaration, use ”…””}”(hŒ;For other pointer arguments in a function declaration, use ”h!jŸubj.)”}”(hŒ ``void *``”h]”hŒvoid *”…””}”(hhh!j¨ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jŸubhŒä. This includes pointers to types that are abstracted away from the known API and pointers to arbitrary data. This allows the calling function to pass a pointer argument to the function without any explicit casting (the cast to ”…””}”(hŒä. This includes pointers to types that are abstracted away from the known API and pointers to arbitrary data. This allows the calling function to pass a pointer argument to the function without any explicit casting (the cast to ”h!jŸubj.)”}”(hŒ ``void *``”h]”hŒvoid *”…””}”(hhh!j»ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jŸubhŒb is implicit). The function implementation can then do the appropriate casting to a specific type.”…””}”(hŒb is implicit). The function implementation can then do the appropriate casting to a specific type.”h!jŸubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMŽh!j›ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jubj`)”}”(hX\Avoid pointer arithmetic generally (as this violates MISRA C 2012 rule 18.4) and especially on void pointers (as this is only supported via language extensions and is considered non-standard). In TF-A, setting the ``W`` build flag to ``W=3`` enables the *-Wpointer-arith* compiler flag and this will emit warnings where pointer arithmetic is used. ”h]”j£)”}”(hX[Avoid pointer arithmetic generally (as this violates MISRA C 2012 rule 18.4) and especially on void pointers (as this is only supported via language extensions and is considered non-standard). In TF-A, setting the ``W`` build flag to ``W=3`` enables the *-Wpointer-arith* compiler flag and this will emit warnings where pointer arithmetic is used.”h]”(hŒÖAvoid pointer arithmetic generally (as this violates MISRA C 2012 rule 18.4) and especially on void pointers (as this is only supported via language extensions and is considered non-standard). In TF-A, setting the ”…””}”(hŒÖAvoid pointer arithmetic generally (as this violates MISRA C 2012 rule 18.4) and especially on void pointers (as this is only supported via language extensions and is considered non-standard). In TF-A, setting the ”h!jÞubj.)”}”(hŒ``W``”h]”hŒW”…””}”(hhh!jçubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jÞubhŒ build flag to ”…””}”(hŒ build flag to ”h!jÞubj.)”}”(hŒ``W=3``”h]”hŒW=3”…””}”(hhh!júubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jÞubhŒ enables the ”…””}”(hŒ enables the ”h!jÞubjË)”}”(hŒ*-Wpointer-arith*”h]”hŒ-Wpointer-arith”…””}”(hhh!j ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!jÞubhŒL compiler flag and this will emit warnings where pointer arithmetic is used.”…””}”(hŒL compiler flag and this will emit warnings where pointer arithmetic is used.”h!jÞubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM•h!jÚubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jubj`)”}”(hŒ@Use ``ptrdiff_t`` to compare the difference between 2 pointers. ”h]”j£)”}”(hŒ?Use ``ptrdiff_t`` to compare the difference between 2 pointers.”h]”(hŒUse ”…””}”(hŒUse ”h!j0ubj.)”}”(hŒ ``ptrdiff_t``”h]”hŒ ptrdiff_t”…””}”(hhh!j9ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j0ubhŒ. to compare the difference between 2 pointers.”…””}”(hŒ. to compare the difference between 2 pointers.”h!j0ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM›h!j,ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!jubeh"}”(h$]”h&]”h+]”h-]”h/]”jÌjÍuh1jZhAj¡hCM„h!jubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhANhCNubj`)”}”(hŒ8Use ``size_t`` when storing the ``sizeof()`` something. ”h]”j£)”}”(hŒ7Use ``size_t`` when storing the ``sizeof()`` something.”h]”(hŒUse ”…””}”(hŒUse ”h!jhubj.)”}”(hŒ ``size_t``”h]”hŒsize_t”…””}”(hhh!jqubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jhubhŒ when storing the ”…””}”(hŒ when storing the ”h!jhubj.)”}”(hŒ``sizeof()``”h]”hŒsizeof()”…””}”(hhh!j„ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jhubhŒ something.”…””}”(hŒ something.”h!jhubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMh!jdubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhAj¡hCNubj`)”}”(hŒÚUse ``ssize_t`` when returning the ``sizeof()`` something from a function that can also return an error code; the signed type allows for a negative return code in case of error. This practice should be used sparingly. ”h]”j£)”}”(hŒÙUse ``ssize_t`` when returning the ``sizeof()`` something from a function that can also return an error code; the signed type allows for a negative return code in case of error. This practice should be used sparingly.”h]”(hŒUse ”…””}”(hŒUse ”h!j§ubj.)”}”(hŒ``ssize_t``”h]”hŒssize_t”…””}”(hhh!j°ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j§ubhŒ when returning the ”…””}”(hŒ when returning the ”h!j§ubj.)”}”(hŒ``sizeof()``”h]”hŒsizeof()”…””}”(hhh!jÃubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!j§ubhŒª something from a function that can also return an error code; the signed type allows for a negative return code in case of error. This practice should be used sparingly.”…””}”(hŒª something from a function that can also return an error code; the signed type allows for a negative return code in case of error. This practice should be used sparingly.”h!j§ubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMŸh!j£ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhAj¡hCNubj`)”}”(hXüUse ``u_register_t`` when it's important to store the contents of a register in its native size (32-bit in |AArch32| and 64-bit in |AArch64|). This is not a standard *C99* type but is widely available in libc implementations, including the FreeBSD version included with the TF codebase. Where possible, cast the variable to a more appropriate type before interpreting the data. For example, the following struct in ``ep_info.h`` could use this type to minimize the storage required for the set of registers: ”h]”j£)”}”(hXûUse ``u_register_t`` when it's important to store the contents of a register in its native size (32-bit in |AArch32| and 64-bit in |AArch64|). This is not a standard *C99* type but is widely available in libc implementations, including the FreeBSD version included with the TF codebase. Where possible, cast the variable to a more appropriate type before interpreting the data. For example, the following struct in ``ep_info.h`` could use this type to minimize the storage required for the set of registers:”h]”(hŒUse ”…””}”(hŒUse ”h!jæubj.)”}”(hŒ``u_register_t``”h]”hŒu_register_t”…””}”(hhh!jïubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jæubhŒY when itâ€™s important to store the contents of a register in its native size (32-bit in ”…””}”(hŒW when it's important to store the contents of a register in its native size (32-bit in ”h!jæubh)”}”(hhh]”h)”}”(hhh]”hŒAArch32”…””}”(hhh!jubah"}”(h$]”h&]”(h(h)h*eh+]”h-]”h/]”uh1hhANhCNh!jubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”h)Œreftype”h<Œrefexplicit”‰Œrefwarn”ˆŒ reftarget”h@uh1hhAhBhCKh!jæubhŒ and 64-bit in ”…””}”(hŒ and 64-bit in ”h!jæubh)”}”(hhQh]”h)”}”(hhQh]”hŒAArch64”…””}”(hhh!j&ubah"}”(h$]”h&]”(h(h]h^eh+]”h-]”h/]”uh1hhANhCNh!j#ubah"}”(h$]”h&]”h+]”h-]”h/]”Œrefdoc”h9Œ refdomain”h]Œreftype”hkŒrefexplicit”‰Œrefwarn”ˆŒ reftarget”hnuh1hhAhBhCKh!jæubhŒ). This is not a standard ”…””}”(hŒ). This is not a standard ”h!jæubjË)”}”(hŒ*C99*”h]”hŒC99”…””}”(hhh!jDubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!jæubhŒô type but is widely available in libc implementations, including the FreeBSD version included with the TF codebase. Where possible, cast the variable to a more appropriate type before interpreting the data. For example, the following struct in ”…””}”(hŒô type but is widely available in libc implementations, including the FreeBSD version included with the TF codebase. Where possible, cast the variable to a more appropriate type before interpreting the data. For example, the following struct in ”h!jæubj.)”}”(hŒ ``ep_info.h``”h]”hŒ ep_info.h”…””}”(hhh!jWubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jæubhŒO could use this type to minimize the storage required for the set of registers:”…””}”(hŒO could use this type to minimize the storage required for the set of registers:”h!jæubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM£h!jâubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j|hhhAj¡hCNubeh"}”(h$]”h&]”h+]”h-]”h/]”jÌjÍuh1jZhAj¡hCM_h!jhhubj¾ )”}”(hXtypedef struct aapcs64_params { u_register_t arg0; u_register_t arg1; u_register_t arg2; u_register_t arg3; u_register_t arg4; u_register_t arg5; u_register_t arg6; u_register_t arg7; } aapcs64_params_t;”h]”hXtypedef struct aapcs64_params { u_register_t arg0; u_register_t arg1; u_register_t arg2; u_register_t arg3; u_register_t arg4; u_register_t arg5; u_register_t arg6; u_register_t arg7; } aapcs64_params_t;”…””}”(hhh!j|ubah"}”(h$]”h&]”h+]”h-]”h/]”Œforce”‰Œhighlight_args”}”jÐ jÑ jÒ juh1j½ hAj¡hCM«h!jhhubj£)”}”(hŒIf some code wants to operate on ``arg0`` and knows that it represents a 32-bit unsigned integer on all systems, cast it to ``unsigned int``.”h]”(hŒ!If some code wants to operate on ”…””}”(hŒ!If some code wants to operate on ”h!jhhhANhCNubj.)”}”(hŒ``arg0``”h]”hŒarg0”…””}”(hhh!j–ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jubhŒS and knows that it represents a 32-bit unsigned integer on all systems, cast it to ”…””}”(hŒS and knows that it represents a 32-bit unsigned integer on all systems, cast it to ”h!jhhhANhCNubj.)”}”(hŒ``unsigned int``”h]”hŒunsigned int”…””}”(hhh!j©ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j-h!jubhŒ.”…””}”(hjòh!jhhhANhCNubeh"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM¸h!jhhubj£)”}”(hŒBThese guidelines should be updated if additional types are needed.”h]”hŒBThese guidelines should be updated if additional types are needed.”…””}”(hjÃh!jÁhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCM»h!jhhubeh"}”(h$]”Œ%use-of-built-in-c-and-libc-data-types”ah&]”h+]”Œ%use of built-in c and libc data types”ah-]”h/]”uh1jŒh!jŽhhhAj¡hCMYubj)”}”(hhh]”(j’)”}”(hŒ'Favor C language over assembly language”h]”hŒ'Favor C language over assembly language”…””}”(hjÜh!jÚhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j‘h!j×hhhAj¡hCM¾ubj£)”}”(hŒÍGenerally, prefer code written in C over assembly. Assembly code is less portable, harder to understand, maintain and audit security wise. Also, static analysis tools generally don't analyze assembly code.”h]”hŒÏGenerally, prefer code written in C over assembly. Assembly code is less portable, harder to understand, maintain and audit security wise. Also, static analysis tools generally donâ€™t analyze assembly code.”…””}”(hjêh!jèhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMÀh!j×hhubj£)”}”(hŒHThere are, however, legitimate uses of assembly language. These include:”h]”hŒHThere are, however, legitimate uses of assembly language. These include:”…””}”(hjøh!jöhhhANhCNubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMÄh!j×hhubh Œblock_quote”“”)”}”(hhh]”j[)”}”(hhh]”(j`)”}”(hŒDEarly boot code executed before the C runtime environment is setup. ”h]”j£)”}”(hŒCEarly boot code executed before the C runtime environment is setup.”h]”hŒCEarly boot code executed before the C runtime environment is setup.”…””}”(hj h!j ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMÆh!j ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j ubj`)”}”(hŒException handling code. ”h]”j£)”}”(hŒException handling code.”h]”hŒException handling code.”…””}”(hj* h!j( ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMÈh!j$ ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j ubj`)”}”(hŒrLow-level code where the exact sequence of instructions executed on the CPU matters, such as CPU reset sequences. ”h]”j£)”}”(hŒqLow-level code where the exact sequence of instructions executed on the CPU matters, such as CPU reset sequences.”h]”hŒqLow-level code where the exact sequence of instructions executed on the CPU matters, such as CPU reset sequences.”…””}”(hjB h!j@ ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMÊh!j< ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j ubj`)”}”(hŒlLow-level code where specific system-level instructions must be used, such as cache maintenance operations. ”h]”j£)”}”(hŒkLow-level code where specific system-level instructions must be used, such as cache maintenance operations.”h]”hŒkLow-level code where specific system-level instructions must be used, such as cache maintenance operations.”…””}”(hjZ h!jX ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMÍh!jT ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j_h!j ubeh"}”(h$]”h&]”h+]”h-]”h/]”jÌjÍuh1jZhAj¡hCMÆh!j ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j h!j×hhhANhCNubh Œ transition”“”)”}”(hŒ--------------”h]”h"}”(h$]”h&]”h+]”h-]”h/]”uh1jx hAj¡hCMÐh!j×hhubj£)”}”(hŒH*Copyright (c) 2020, Arm Limited and Contributors. All rights reserved.*”h]”jË)”}”(hj† h]”hŒFCopyright (c) 2020, Arm Limited and Contributors. All rights reserved.”…””}”(hhh!jˆ ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1jÊh!j„ ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢hAj¡hCMÒh!j×hhubj†)”}”(hŒa.. _`Linux master tree`: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/”h]”h"}”(h$]”Œlinux-master-tree”ah&]”h+]”Œlinux master tree”ah-]”h/]”j%je uh1j…hCMh!j×hhhAj¡Œ referenced”Kubj†)”}”(hŒf.. _`Procedure Call Standard for the Arm Architecture`: https://developer.arm.com/docs/ihi0042/latest/”h]”h"}”(h$]”Œ0procedure-call-standard-for-the-arm-architecture”ah&]”h+]”Œ0procedure call standard for the arm architecture”ah-]”h/]”j%j¿uh1j…hCMh!j×hhhAj¡j§ Kubj†)”}”(hŒm.. _`Procedure Call Standard for the Arm 64-bit Architecture`: https://developer.arm.com/docs/ihi0055/latest/”h]”h"}”(h$]”Œ7procedure-call-standard-for-the-arm-64-bit-architecture”ah&]”h+]”Œ7procedure call standard for the arm 64-bit architecture”ah-]”h/]”j%jÖuh1j…hCMh!j×hhhAj¡j§ Kubj†)”}”(hŒ,.. _`EditorConfig`: http://editorconfig.org/”h]”h"}”(h$]”Œeditorconfig”ah&]”h+]”Œeditorconfig”ah-]”h/]”j%j&uh1j…hCMh!j×hhhAj¡j§ Kubj†)”}”(hŒ‹.. _`Why the â€œvolatileâ€ type class should not be used`: https://www.kernel.org/doc/html/latest/process/volatile-considered-harmful.html”h]”h"}”(h$]”Œ.why-the-volatile-type-class-should-not-be-used”ah&]”h+]”Œ4why the â€œvolatileâ€ type class should not be used”ah-]”h/]”j%j´uh1j…hCMh!j×hhhAj¡j§ Kubj†)”}”(hŒ`.. _`MISRA C:2012 Guidelines`: https://www.misra.org.uk/Activities/MISRAC/tabid/160/Default.aspx”h]”h"}”(h$]”Œmisra-c-2012-guidelines”ah&]”h+]”Œmisra c:2012 guidelines”ah-]”h/]”j%ŒAhttps://www.misra.org.uk/Activities/MISRAC/tabid/160/Default.aspx”uh1j…hCMh!j×hhhAj¡ubj†)”}”(hŒ›.. _`a spreadsheet`: https://developer.trustedfirmware.org/file/download/lamajxif3w7c4mpjeoo5/PHID-FILE-fp7c7acszn6vliqomyhn/MISRA-and-TF-Analysis-v1.3.ods”h]”h"}”(h$]”Œ a-spreadsheet”ah&]”h+]”Œ a spreadsheet”ah-]”h/]”j%Œ†https://developer.trustedfirmware.org/file/download/lamajxif3w7c4mpjeoo5/PHID-FILE-fp7c7acszn6vliqomyhn/MISRA-and-TF-Analysis-v1.3.ods”uh1j…hCMh!j×hhhAj¡ubeh"}”(h$]”Œ'favor-c-language-over-assembly-language”ah&]”h+]”Œ'favor c language over assembly language”ah-]”h/]”uh1jŒh!jŽhhhAj¡hCM¾ubeh"}”(h$]”Œcoding-guidelines”ah&]”h+]”Œcoding guidelines”ah-]”h/]”uh1jŒh!hhhhAj¡hCKubeh"}”(h$]”h&]”h+]”h-]”h/]”Œsource”j¡uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(j‘NŒ generator”NŒ datestamp”NŒsource_link”NŒ source_url”NŒ toc_backlinks”jæŒ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”j¡Œ_destination”NŒ _config_files”]”Œpep_references”NŒpep_base_url”Œ https://www.python.org/dev/peps/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œhttps://tools.ietf.org/html/”Œ tab_width”KŒtrim_footnote_reference_space”‰Œfile_insertion_enabled”ˆŒraw_enabled”KŒsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œ docinfo_xform”KŒsectsubtitle_xform”‰Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”(hHhhshKhžhvhÉh¡hôhÌjh÷jJj"jujMj jxjËj£jöjÎj!jùjLj$jwjOj¢jzjÍj¥jøjÐj#jûjNj&jyjQj¤j|jÏj§jújÒj%jýjPj(j{jSj¦j~jÑj©jüjÔj'jÿjRj*j}jUj¨j€jÓj«jþjÖj)jjTj,jjWjªj‚jÕjjjØj+jjVj.jjYj¬j„j×j¯jjÚj-jjXj0jƒj[j®j†jÙj±j jÜj/ j jZ j2 j… j] j° jˆ jÛ j³ j jÞ j1 j j\ j4 j‡ j_ j² jŠ jÝ jµ jjà j3jj^j6j‰jauŒsubstitution_names”}”(Œaarch32”hHŒaarch64”hsŒamu”hžŒamus”hÉŒapi”hôŒbti”jŒcot”juŒcss”j Œcve”jËŒdtb”jöŒds-5”j!Œdsu”jLŒdt”jwŒel”j¢Œehf”jÍŒfconf”jøŒfdt”j#Œff-a”jNŒfip”jyŒfvp”j¤Œfwu”jÏŒgic”júŒisa”j%Œlinaro”jPŒmmu”j{Œmpam”j¦Œmpmm”jÑŒmpidr”jüŒmte”j'Œoen”jRŒop-tee”j}Œote”j¨Œpdd”jÓŒpauth”jþŒpmf”j)Œpsci”jTŒras”jŒrot”jªŒscmi”jÕŒscp”jŒsdei”j+Œsds”jVŒsea”jŒsip”j×Œsmc”jŒsmccc”j-Œsoc”jXŒsp”jƒŒspd”j®Œspm”jÙŒssbs”j Œsve”j/ Œtbb”jZ Œtbbr”j… Œtee”j° Œtf-a”jÛ Œtf-m”j Œtlb”j1 Œtlk”j\ Œtrng”j‡ Œtsp”j² Œtzc”jÝ Œubsan”jŒuefi”j3Œwdog”j^Œxlat”j‰uŒrefnames”}”(Œeditorconfig”]”jaŒlinux master tree”]”jT aŒ4why the â€œvolatileâ€ type class should not be used”]”j£aŒ0procedure call standard for the arm architecture”]”j®aŒ7procedure call standard for the arm 64-bit architecture”]”jÅauŒrefids”}”j’]”j‡asŒnameids”}”(jÿ jü j˜j•jÜj’jÛjØjÓjÐjjjüjùjˆj…j¯j¬jjjJjGjjjZjWjwjtjƒj€j jjÔjÑj÷ jô j¤ j¡ j± j® j½ jº jÉ jÆ jÕ jÒ já jÞ jî jë uŒ nametypes”}”(jÿ Nj˜NjÜˆjÛNjÓNjNjüNjˆNj¯NjNjJNjNjZNjwNjƒNj NjÔNj÷ Nj¤ ˆj± ˆj½ ˆjÉ ˆjÕ ˆjá ˆjî ˆuh$}”(jü jŽj•jùj’j›jØj›jÐj;jjãjùjôj…jÿj¬j“jj²jGjÃjjMjWjjtj]j€jzjj†jÑjjô j×j¡ j› j® j¨ jº j´ jÆ jÀ jÒ jÌ jÞ jØ jë jå uŒ 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”“”}”j2!Ks…”R”Œparse_messages”]”Œtransform_messages”]”(h Œsystem_message”“”)”}”(hhh]”j£)”}”(hhh]”hŒCHyperlink target "automatic-compliance-checking" is not referenced.”…””}”(hhh!jÕ!ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢h!jÒ!ubah"}”(h$]”h&]”h+]”h-]”h/]”Œlevel”KŒtype”ŒINFO”Œsource”j¡Œline”K[uh1jÐ!ubjÑ!)”}”(hhh]”j£)”}”(hhh]”hŒ=Hyperlink target "misra c:2012 guidelines" is not referenced.”…””}”(hhh!jð!ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢h!jí!ubah"}”(h$]”h&]”h+]”h-]”h/]”Œlevel”KŒtype”jê!Œsource”j¡Œline”Muh1jÐ!ubjÑ!)”}”(hhh]”j£)”}”(hhh]”hŒ3Hyperlink target "a spreadsheet" is not referenced.”…””}”(hhh!j "ubah"}”(h$]”h&]”h+]”h-]”h/]”uh1j¢h!j"ubah"}”(h$]”h&]”h+]”h-]”h/]”Œlevel”KŒtype”jê!Œsource”j¡Œline”Muh1jÐ!ubeŒtransformer”NŒ decoration”Nhhub.