€•˜0      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ2/translations/zh_CN/userspace-api/fwctl/bnxt_fwctl”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ2/translations/zh_TW/userspace-api/fwctl/bnxt_fwctl”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ2/translations/it_IT/userspace-api/fwctl/bnxt_fwctl”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ2/translations/ja_JP/userspace-api/fwctl/bnxt_fwctl”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ2/translations/ko_KR/userspace-api/fwctl/bnxt_fwctl”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ2/translations/pt_BR/userspace-api/fwctl/bnxt_fwctl”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ2/translations/sp_SP/userspace-api/fwctl/bnxt_fwctl”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…””}”hh·sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1hµhhh²hh³ŒL/var/lib/git/docbuild/linux/Documentation/userspace-api/fwctl/bnxt_fwctl.rst”h´KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒfwctl bnxt driver”h]”hŒfwctl bnxt driver”…””}”(hhÏh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhhÊh²hh³hÇh´KubhŒ
field_list”“”)”}”(hhh]”hŒfield”“”)”}”(hhh]”(hŒ
field_name”“”)”}”(hŒAuthor”h]”hŒAuthor”…””}”(hhéh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hçhhäh³hÇh´K ubhŒ
field_body”“”)”}”(hŒPavan Chebbi
”h]”hŒ	paragraph”“”)”}”(hŒPavan Chebbi”h]”hŒPavan Chebbi”…””}”(hhÿh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´Khhùubah}”(h]”h ]”h"]”h$]”h&]”uh1h÷hhäubeh}”(h]”h ]”h"]”h$]”h&]”uh1hâh³hÇh´Khhßh²hubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝhhÊh²hh³hÇh´KubhÉ)”}”(hhh]”(hÎ)”}”(hŒOverview”h]”hŒOverview”…””}”(hj"  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj  h²hh³hÇh´K
ubhþ)”}”(hŒ¢BNXT driver makes a fwctl service available through an auxiliary_device.
The bnxt_fwctl driver binds to this device and registers itself with the
fwctl subsystem.”h]”hŒ¢BNXT driver makes a fwctl service available through an auxiliary_device.
The bnxt_fwctl driver binds to this device and registers itself with the
fwctl subsystem.”…””}”(hj0  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´Khj  h²hubhþ)”}”(hŒÂThe bnxt_fwctl driver is agnostic to the device firmware internals. It
uses the Upper Layer Protocol (ULP) conduit provided by bnxt to send
HardWare Resource Manager (HWRM) commands to firmware.”h]”hŒÂThe bnxt_fwctl driver is agnostic to the device firmware internals. It
uses the Upper Layer Protocol (ULP) conduit provided by bnxt to send
HardWare Resource Manager (HWRM) commands to firmware.”…””}”(hj>  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´Khj  h²hubhþ)”}”(hŒ€These commands can query or change firmware driven device configurations
and read/write registers that are useful for debugging.”h]”hŒ€These commands can query or change firmware driven device configurations
and read/write registers that are useful for debugging.”…””}”(hjL  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´Khj  h²hubeh}”(h]”Œoverview”ah ]”h"]”Œoverview”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´K
ubhÉ)”}”(hhh]”(hÎ)”}”(hŒbnxt_fwctl User API”h]”hŒbnxt_fwctl User API”…””}”(hje  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjb  h²hh³hÇh´Kubhþ)”}”(hŒvEach RPC request contains the HWRM input structure in the fwctl_rpc
'in' buffer while 'out' will contain the response.”h]”hŒ~Each RPC request contains the HWRM input structure in the fwctl_rpc
â€˜inâ€™ buffer while â€˜outâ€™ will contain the response.”…””}”(hjs  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´Khjb  h²hubhþ)”}”(hŒ€A typical user application can send a FWCTL_INFO command using ioctl()
to discover bnxt_fwctl's RPC capabilities as shown below:”h]”hŒ‚A typical user application can send a FWCTL_INFO command using ioctl()
to discover bnxt_fwctlâ€™s RPC capabilities as shown below:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´Khjb  h²hubhŒblock_quote”“”)”}”(hŒ(ioctl(fd, FWCTL_INFO, &fwctl_info_msg);
”h]”hþ)”}”(hŒ'ioctl(fd, FWCTL_INFO, &fwctl_info_msg);”h]”hŒ'ioctl(fd, FWCTL_INFO, &fwctl_info_msg);”…””}”(hj•  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´K hj‘  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÇh´K hjb  h²hubhþ)”}”(hŒwhere fwctl_info_msg (of type struct fwctl_info) describes bnxt_info_msg
(of type struct fwctl_info_bnxt). fwctl_info_msg is set up as follows:”h]”hŒwhere fwctl_info_msg (of type struct fwctl_info) describes bnxt_info_msg
(of type struct fwctl_info_bnxt). fwctl_info_msg is set up as follows:”…””}”(hj©  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´K"hjb  h²hubj  )”}”(hŒ‡size = sizeof(struct fwctl_info);
flags = 0;
device_data_len = sizeof(bnxt_info_msg);
out_device_data = (__aligned_u64)&bnxt_info_msg;
”h]”hþ)”}”(hŒ†size = sizeof(struct fwctl_info);
flags = 0;
device_data_len = sizeof(bnxt_info_msg);
out_device_data = (__aligned_u64)&bnxt_info_msg;”h]”hŒ†size = sizeof(struct fwctl_info);
flags = 0;
device_data_len = sizeof(bnxt_info_msg);
out_device_data = (__aligned_u64)&bnxt_info_msg;”…””}”(hj»  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´K%hj·  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÇh´K%hjb  h²hubhþ)”}”(hŒ{The uctx_caps of bnxt_info_msg represents the capabilities as described
in fwctl_bnxt_commands of include/uapi/fwctl/bnxt.h”h]”hŒ{The uctx_caps of bnxt_info_msg represents the capabilities as described
in fwctl_bnxt_commands of include/uapi/fwctl/bnxt.h”…””}”(hjÏ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´K*hjb  h²hubhþ)”}”(hŒ:The FW RPC itself, FWCTL_RPC can be sent using ioctl() as:”h]”hŒ:The FW RPC itself, FWCTL_RPC can be sent using ioctl() as:”…””}”(hjÝ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´K-hjb  h²hubj  )”}”(hŒ&ioctl(fd, FWCTL_RPC, &fwctl_rpc_msg);
”h]”hþ)”}”(hŒ%ioctl(fd, FWCTL_RPC, &fwctl_rpc_msg);”h]”hŒ%ioctl(fd, FWCTL_RPC, &fwctl_rpc_msg);”…””}”(hjï  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´K/hjë  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÇh´K/hjb  h²hubhþ)”}”(hŒÌwhere fwctl_rpc_msg (of type struct fwctl_rpc) carries the HWRM command
in its 'in' buffer. The HWRM input structures are described in
include/linux/bnxt/hsi.h. An example for HWRM_VER_GET is shown below:”h]”hŒÐwhere fwctl_rpc_msg (of type struct fwctl_rpc) carries the HWRM command
in its â€˜inâ€™ buffer. The HWRM input structures are described in
include/linux/bnxt/hsi.h. An example for HWRM_VER_GET is shown below:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´K1hjb  h²hubj  )”}”(hX  struct hwrm_ver_get_output resp;
struct fwctl_rpc fwctl_rpc_msg;
struct hwrm_ver_get_input req;

req.req_type = HWRM_VER_GET;
req.hwrm_intf_maj = HWRM_VERSION_MAJOR;
req.hwrm_intf_min = HWRM_VERSION_MINOR;
req.hwrm_intf_upd = HWRM_VERSION_UPDATE;
req.cmpl_ring = -1;
req.target_id = -1;

fwctl_rpc_msg.size = sizeof(struct fwctl_rpc);
fwctl_rpc_msg.scope = FWCTL_RPC_DEBUG_READ_ONLY;
fwctl_rpc_msg.in_len = sizeof(req);
fwctl_rpc_msg.out_len = sizeof(resp);
fwctl_rpc_msg.in = (__aligned_u64)&req;
fwctl_rpc_msg.out = (__aligned_u64)&resp;
”h]”(hþ)”}”(hŒ_struct hwrm_ver_get_output resp;
struct fwctl_rpc fwctl_rpc_msg;
struct hwrm_ver_get_input req;”h]”hŒ_struct hwrm_ver_get_output resp;
struct fwctl_rpc fwctl_rpc_msg;
struct hwrm_ver_get_input req;”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´K5hj  ubhþ)”}”(hŒ½req.req_type = HWRM_VER_GET;
req.hwrm_intf_maj = HWRM_VERSION_MAJOR;
req.hwrm_intf_min = HWRM_VERSION_MINOR;
req.hwrm_intf_upd = HWRM_VERSION_UPDATE;
req.cmpl_ring = -1;
req.target_id = -1;”h]”hŒ½req.req_type = HWRM_VER_GET;
req.hwrm_intf_maj = HWRM_VERSION_MAJOR;
req.hwrm_intf_min = HWRM_VERSION_MINOR;
req.hwrm_intf_upd = HWRM_VERSION_UPDATE;
req.cmpl_ring = -1;
req.target_id = -1;”…””}”(hj#  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´K9hj  ubhþ)”}”(hŒûfwctl_rpc_msg.size = sizeof(struct fwctl_rpc);
fwctl_rpc_msg.scope = FWCTL_RPC_DEBUG_READ_ONLY;
fwctl_rpc_msg.in_len = sizeof(req);
fwctl_rpc_msg.out_len = sizeof(resp);
fwctl_rpc_msg.in = (__aligned_u64)&req;
fwctl_rpc_msg.out = (__aligned_u64)&resp;”h]”hŒûfwctl_rpc_msg.size = sizeof(struct fwctl_rpc);
fwctl_rpc_msg.scope = FWCTL_RPC_DEBUG_READ_ONLY;
fwctl_rpc_msg.in_len = sizeof(req);
fwctl_rpc_msg.out_len = sizeof(resp);
fwctl_rpc_msg.in = (__aligned_u64)&req;
fwctl_rpc_msg.out = (__aligned_u64)&resp;”…””}”(hj1  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´K@hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÇh´K5hjb  h²hubhþ)”}”(hŒiAn example python3 program that can exercise this interface can be found in
the following git repository:”h]”hŒiAn example python3 program that can exercise this interface can be found in
the following git repository:”…””}”(hjE  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´KGhjb  h²hubhþ)”}”(hŒ'https://github.com/Broadcom/fwctl-tools”h]”hŒ	reference”“”)”}”(hjU  h]”hŒ'https://github.com/Broadcom/fwctl-tools”…””}”(hjY  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”jU  uh1jW  hjS  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hýh³hÇh´KJhjb  h²hubeh}”(h]”Œbnxt-fwctl-user-api”ah ]”h"]”Œbnxt_fwctl user api”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´Kubeh}”(h]”Œfwctl-bnxt-driver”ah ]”h"]”Œfwctl bnxt driver”ah$]”h&]”uh1hÈhhh²hh³hÇh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÇuh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hÍNŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j   Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÇŒ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jz  jw  j_  j\  jr  jo  uŒ	nametypes”}”(jz  ‰j_  ‰jr  ‰uh}”(jw  hÊj\  j  jo  jb  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”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nh²hub.