€•O=Œsphinx.addnodes”Œdocument”“”)”}”(Œ rawsource”Œ”Œchildren”]”(Œ translations”Œ LanguagesNode”“”)”}”(hhh]”(hŒ pending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ refdomain”Œstd”Œreftype”Œdoc”Œ reftarget”Œ#/translations/zh_CN/driver-api/ipmb”Œmodname”NŒ classname”NŒ refexplicit”ˆuŒtagname”hhh ubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/zh_TW/driver-api/ipmb”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/it_IT/driver-api/ipmb”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/ja_JP/driver-api/ipmb”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/ko_KR/driver-api/ipmb”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/pt_BR/driver-api/ipmb”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ#/translations/sp_SP/driver-api/ipmb”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h hhŒ _document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒIPMB Driver for a Satellite MC”h]”hŒIPMB Driver for a Satellite MC”…””}”(hh¼h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhh·h²hh³Œ=/var/lib/git/docbuild/linux/Documentation/driver-api/ipmb.rst”h´KubhŒ paragraph”“”)”}”(hX8The Intelligent Platform Management Bus or IPMB, is an I2C bus that provides a standardized interconnection between different boards within a chassis. This interconnection is between the baseboard management (BMC) and chassis electronics. IPMB is also associated with the messaging protocol through the IPMB bus.”h]”hX8The Intelligent Platform Management Bus or IPMB, is an I2C bus that provides a standardized interconnection between different boards within a chassis. This interconnection is between the baseboard management (BMC) and chassis electronics. IPMB is also associated with the messaging protocol through the IPMB bus.”…””}”(hhÍh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhÌ)”}”(hŒÞThe devices using the IPMB are usually management controllers that perform management functions such as servicing the front panel interface, monitoring the baseboard, hot-swapping disk drivers in the system chassis, etc...”h]”hŒÞThe devices using the IPMB are usually management controllers that perform management functions such as servicing the front panel interface, monitoring the baseboard, hot-swapping disk drivers in the system chassis, etc...”…””}”(hhÛh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K hh·h²hubhÌ)”}”(hXWhen an IPMB is implemented in the system, the BMC serves as a controller to give system software access to the IPMB. The BMC sends IPMI requests to a device (usually a Satellite Management Controller or Satellite MC) via IPMB and the device sends a response back to the BMC.”h]”hXWhen an IPMB is implemented in the system, the BMC serves as a controller to give system software access to the IPMB. The BMC sends IPMI requests to a device (usually a Satellite Management Controller or Satellite MC) via IPMB and the device sends a response back to the BMC.”…””}”(hhéh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhÌ)”}”(hŒjFor more information on IPMB and the format of an IPMB message, refer to the IPMB and IPMI specifications.”h]”hŒjFor more information on IPMB and the format of an IPMB message, refer to the IPMB and IPMI specifications.”…””}”(hh÷h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubh¶)”}”(hhh]”(h»)”}”(hŒIPMB driver for Satellite MC”h]”hŒIPMB driver for Satellite MC”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjh²hh³hÊh´KubhÌ)”}”(hŒÈipmb-dev-int - This is the driver needed on a Satellite MC to receive IPMB messages from a BMC and send a response back. This driver works with the I2C driver and a userspace program such as OpenIPMI:”h]”hŒÈipmb-dev-int - This is the driver needed on a Satellite MC to receive IPMB messages from a BMC and send a response back. This driver works with the I2C driver and a userspace program such as OpenIPMI:”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khjh²hubhŒenumerated_list”“”)”}”(hhh]”(hŒ list_item”“”)”}”(hŒªIt is an I2C slave backend driver. So, it defines a callback function to set the Satellite MC as an I2C slave. This callback function handles the received IPMI requests. ”h]”hÌ)”}”(hŒ©It is an I2C slave backend driver. So, it defines a callback function to set the Satellite MC as an I2C slave. This callback function handles the received IPMI requests.”h]”hŒ©It is an I2C slave backend driver. So, it defines a callback function to set the Satellite MC as an I2C slave. This callback function handles the received IPMI requests.”…””}”(hj/h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K"hj+ubah}”(h]”h ]”h"]”h$]”h&]”uh1j)hj&h²hh³hÊh´Nubj*)”}”(hŒ{It defines the read and write functions to enable a user space program (such as OpenIPMI) to communicate with the kernel. ”h]”hÌ)”}”(hŒyIt defines the read and write functions to enable a user space program (such as OpenIPMI) to communicate with the kernel.”h]”hŒyIt defines the read and write functions to enable a user space program (such as OpenIPMI) to communicate with the kernel.”…””}”(hjGh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K&hjCubah}”(h]”h ]”h"]”h$]”h&]”uh1j)hj&h²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ)”uh1j$hjh²hh³hÊh´K"ubeh}”(h]”Œipmb-driver-for-satellite-mc”ah ]”h"]”Œipmb driver for satellite mc”ah$]”h&]”uh1hµhh·h²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒLoad the IPMB driver”h]”hŒLoad the IPMB driver”…””}”(hjqh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjnh²hh³hÊh´K+ubhÌ)”}”(hŒ™The driver needs to be loaded at boot time or manually first. First, make sure you have the following in your config file: CONFIG_IPMB_DEVICE_INTERFACE=y”h]”hŒ™The driver needs to be loaded at boot time or manually first. First, make sure you have the following in your config file: CONFIG_IPMB_DEVICE_INTERFACE=y”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K-hjnh²hubj%)”}”(hhh]”j*)”}”(hŒ2If you want the driver to be loaded at boot time: ”h]”hÌ)”}”(hŒ1If you want the driver to be loaded at boot time:”h]”hŒ1If you want the driver to be loaded at boot time:”…””}”(hj”h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K1hjubah}”(h]”h ]”h"]”h$]”h&]”uh1j)hjh²hh³hÊh´Nubah}”(h]”h ]”h"]”h$]”h&]”jajbjchjdjeuh1j$hjnh²hh³hÊh´K1ubj%)”}”(hhh]”(j*)”}”(hXƒAdd this entry to your ACPI table, under the appropriate SMBus:: Device (SMB0) // Example SMBus host controller { Name (_HID, "") // Vendor-Specific HID Name (_UID, 0) // Unique ID of particular host controller : : Device (IPMB) { Name (_HID, "IPMB0001") // IPMB device interface Name (_UID, 0) // Unique device identifier } } ”h]”(hÌ)”}”(hŒ@Add this entry to your ACPI table, under the appropriate SMBus::”h]”hŒ?Add this entry to your ACPI table, under the appropriate SMBus:”…””}”(hjµh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K3hj±ubhŒ literal_block”“”)”}”(hX(Device (SMB0) // Example SMBus host controller { Name (_HID, "") // Vendor-Specific HID Name (_UID, 0) // Unique ID of particular host controller : : Device (IPMB) { Name (_HID, "IPMB0001") // IPMB device interface Name (_UID, 0) // Unique device identifier } }”h]”hX(Device (SMB0) // Example SMBus host controller { Name (_HID, "") // Vendor-Specific HID Name (_UID, 0) // Unique ID of particular host controller : : Device (IPMB) { Name (_HID, "IPMB0001") // IPMB device interface Name (_UID, 0) // Unique device identifier } }”…””}”hjÅsbah}”(h]”h ]”h"]”h$]”h&]”Œ xml:space”Œpreserve”uh1jÃh³hÊh´K5hj±ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j)hj®h²hh³hÊh´Nubj*)”}”(hŒÌExample for device tree:: &i2c2 { status = "okay"; ipmb@10 { compatible = "ipmb-dev"; reg = <0x10>; i2c-protocol; }; }; ”h]”(hÌ)”}”(hŒExample for device tree::”h]”hŒExample for device tree:”…””}”(hjßh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KBhjÛubjÄ)”}”(hŒ &i2c2 { status = "okay"; ipmb@10 { compatible = "ipmb-dev"; reg = <0x10>; i2c-protocol; }; };”h]”hŒ &i2c2 { status = "okay"; ipmb@10 { compatible = "ipmb-dev"; reg = <0x10>; i2c-protocol; }; };”…””}”hjísbah}”(h]”h ]”h"]”h$]”h&]”jÓjÔuh1jÃh³hÊh´KDhjÛubeh}”(h]”h ]”h"]”h$]”h&]”uh1j)hj®h²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”jaŒ loweralpha”jchjdjeuh1j$hjnh²hh³hÊh´K3ubhÌ)”}”(hŒiIf xmit of data to be done using raw i2c block vs smbus then "i2c-protocol" needs to be defined as above.”h]”hŒmIf xmit of data to be done using raw i2c block vs smbus then “i2c-protocol†needs to be defined as above.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KNhjnh²hubj%)”}”(hhh]”j*)”}”(hŒ0Manually from Linux:: modprobe ipmb-dev-int ”h]”(hÌ)”}”(hŒManually from Linux::”h]”hŒManually from Linux:”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KQhjubjÄ)”}”(hŒmodprobe ipmb-dev-int”h]”hŒmodprobe ipmb-dev-int”…””}”hj+sbah}”(h]”h ]”h"]”h$]”h&]”jÓjÔuh1jÃh³hÊh´KShjubeh}”(h]”h ]”h"]”h$]”h&]”uh1j)hjh²hh³hÊh´Nubah}”(h]”h ]”h"]”h$]”h&]”jajbjchjdjeŒstart”Kuh1j$hjnh²hh³hÊh´KQubeh}”(h]”Œload-the-ipmb-driver”ah ]”h"]”Œload the ipmb driver”ah$]”h&]”uh1hµhh·h²hh³hÊh´K+ubh¶)”}”(hhh]”(h»)”}”(hŒInstantiate the device”h]”hŒInstantiate the device”…””}”(hjQh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjNh²hh³hÊh´KWubhÌ)”}”(hXAfter loading the driver, you can instantiate the device as described in 'Documentation/i2c/instantiating-devices.rst'. If you have multiple BMCs, each connected to your Satellite MC via a different I2C bus, you can instantiate a device for each of those BMCs.”h]”hXAfter loading the driver, you can instantiate the device as described in ‘Documentation/i2c/instantiating-devices.rst’. If you have multiple BMCs, each connected to your Satellite MC via a different I2C bus, you can instantiate a device for each of those BMCs.”…””}”(hj_h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KYhjNh²hubhÌ)”}”(hŒ_The name of the instantiated device contains the I2C bus number associated with it as follows::”h]”hŒ^The name of the instantiated device contains the I2C bus number associated with it as follows:”…””}”(hjmh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K_hjNh²hubjÄ)”}”(hŒ’BMC1 ------ IPMB/I2C bus 1 ---------| /dev/ipmb-1 Satellite MC BMC1 ------ IPMB/I2C bus 2 ---------| /dev/ipmb-2”h]”hŒ’BMC1 ------ IPMB/I2C bus 1 ---------| /dev/ipmb-1 Satellite MC BMC1 ------ IPMB/I2C bus 2 ---------| /dev/ipmb-2”…””}”hj{sbah}”(h]”h ]”h"]”h$]”h&]”jÓjÔuh1jÃh³hÊh´KbhjNh²hubhÌ)”}”(hŒnFor instance, you can instantiate the ipmb-dev-int device from user space at the 7 bit address 0x10 on bus 2::”h]”hŒmFor instance, you can instantiate the ipmb-dev-int device from user space at the 7 bit address 0x10 on bus 2:”…””}”(hj‰h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KfhjNh²hubjÄ)”}”(hŒ># echo ipmb-dev 0x1010 > /sys/bus/i2c/devices/i2c-2/new_device”h]”hŒ># echo ipmb-dev 0x1010 > /sys/bus/i2c/devices/i2c-2/new_device”…””}”hj—sbah}”(h]”h ]”h"]”h$]”h&]”jÓjÔuh1jÃh³hÊh´KihjNh²hubhÌ)”}”(hŒ©This will create the device file /dev/ipmb-2, which can be accessed by the user space program. The device needs to be instantiated before running the user space program.”h]”hŒ©This will create the device file /dev/ipmb-2, which can be accessed by the user space program. The device needs to be instantiated before running the user space program.”…””}”(hj¥h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KkhjNh²hubeh}”(h]”Œinstantiate-the-device”ah ]”h"]”Œinstantiate the device”ah$]”h&]”uh1hµhh·h²hh³hÊh´KWubeh}”(h]”Œipmb-driver-for-a-satellite-mc”ah ]”h"]”Œipmb driver for a satellite mc”ah$]”h&]”uh1hµhhh²hh³hÊh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÊuh1hŒcurrent_source”NŒ current_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hºNŒ generator”NŒ datestamp”NŒ source_link”NŒ source_url”NŒ toc_backlinks”Œentry”Œfootnote_backlinks”KŒ sectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒ strip_classes”NŒ report_level”KŒ halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ traceback”ˆŒinput_encoding”Œ utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jæŒerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œ language_code”Œen”Œrecord_dependencies”NŒconfig”NŒ id_prefix”hŒauto_id_prefix”Œid”Œ dump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÊŒ _destination”NŒ _config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒ raw_enabled”KŒline_length_limit”M'Œpep_references”NŒ pep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒ rfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œ smart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œ docinfo_xform”KŒsectsubtitle_xform”‰Œ image_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jÀj½jkjhjKjHj¸jµuŒ nametypes”}”(jÀ‰jk‰jK‰j¸‰uh}”(j½h·jhjjHjnjµjNuŒ 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”]”hŒsystem_message”“”)”}”(hhh]”hÌ)”}”(hŒ:Enumerated list start value not ordinal-1: "2" (ordinal 2)”h]”hŒ>Enumerated list start value not ordinal-1: “2†(ordinal 2)”…””}”(hjMh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËhjJubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”ŒINFO”Œsource”hÊŒline”Kuh1jHhjnh²hh³hÊh´KQubaŒtransform_messages”]”Œ transformer”NŒ include_log”]”Œ decoration”Nh²hub.