'sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget#/translations/zh_CN/driver-api/ipmimodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/zh_TW/driver-api/ipmimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/it_IT/driver-api/ipmimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/ja_JP/driver-api/ipmimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/ko_KR/driver-api/ipmimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/pt_BR/driver-api/ipmimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/sp_SP/driver-api/ipmimodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(hThe Linux IPMI Driverh]hThe Linux IPMI Driver}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhh=/var/lib/git/docbuild/linux/Documentation/driver-api/ipmi.rsthKubh field_list)}(hhh]hfield)}(hhh](h field_name)}(hAuthorh]hAuthor}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhKubh field_body)}(h7Corey Minyard / h]h paragraph)}(h6Corey Minyard / h](hCorey Minyard <}(hhhhhNhNubh reference)}(hminyard@mvista.comh]hminyard@mvista.com}(hhhhhNhNubah}(h]h ]h"]h$]h&]refurimailto:minyard@mvista.comuh1hhhubh> / <}(hhhhhNhNubh)}(hminyard@acm.orgh]hminyard@acm.org}(hj hhhNhNubah}(h]h ]h"]h$]h&]refurimailto:minyard@acm.orguh1hhhubh>}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhubah}(h]h ]h"]h$]h&]uh1hhhubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hXThe Intelligent Platform Management Interface, or IPMI, is a standard for controlling intelligent devices that monitor a system. It provides for dynamic discovery of sensors in the system and the ability to monitor the sensors and be informed when the sensor's values change or go outside certain boundaries. It also has a standardized database for field-replaceable units (FRUs) and a watchdog timer.h]hXThe Intelligent Platform Management Interface, or IPMI, is a standard for controlling intelligent devices that monitor a system. It provides for dynamic discovery of sensors in the system and the ability to monitor the sensors and be informed when the sensor’s values change or go outside certain boundaries. It also has a standardized database for field-replaceable units (FRUs) and a watchdog timer.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hTo use this, you need an interface to an IPMI controller in your system (called a Baseboard Management Controller, or BMC) and management software that can use the IPMI system.h]hTo use this, you need an interface to an IPMI controller in your system (called a Baseboard Management Controller, or BMC) and management software that can use the IPMI system.}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hThis document describes how to use the IPMI driver for Linux. If you are not familiar with IPMI itself, see the web site at https://www.intel.com/design/servers/ipmi/index.htm. IPMI is a big subject and I can't cover it all here!h](h}This document describes how to use the IPMI driver for Linux. If you are not familiar with IPMI itself, see the web site at }(hjShhhNhNubh)}(h3https://www.intel.com/design/servers/ipmi/index.htmh]h3https://www.intel.com/design/servers/ipmi/index.htm}(hj[hhhNhNubah}(h]h ]h"]h$]h&]refurij]uh1hhjSubh9. IPMI is a big subject and I can’t cover it all here!}(hjShhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(h Configurationh]h Configuration}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjthhhhhKubh)}(hThe Linux IPMI driver is modular, which means you have to pick several things to have it work right depending on your hardware. Most of these are available in the 'Character Devices' menu then the IPMI menu.h]hThe Linux IPMI driver is modular, which means you have to pick several things to have it work right depending on your hardware. Most of these are available in the ‘Character Devices’ menu then the IPMI menu.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjthhubh)}(hNo matter what, you must pick 'IPMI top-level message handler' to use IPMI. What you do beyond that depends on your needs and hardware.h]hNo matter what, you must pick ‘IPMI top-level message handler’ to use IPMI. What you do beyond that depends on your needs and hardware.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hjthhubh)}(hThe message handler does not provide any user-level interfaces. Kernel code (like the watchdog) can still use it. If you need access from userland, you need to select 'Device interface for IPMI' if you want access through a device driver.h]hThe message handler does not provide any user-level interfaces. Kernel code (like the watchdog) can still use it. If you need access from userland, you need to select ‘Device interface for IPMI’ if you want access through a device driver.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK#hjthhubh)}(hXThe driver interface depends on your hardware. If your system properly provides the SMBIOS info for IPMI, the driver will detect it and just work. If you have a board with a standard interface (These will generally be either "KCS", "SMIC", or "BT", consult your hardware manual), choose the 'IPMI SI handler' option. A driver also exists for direct I2C access to the IPMI management controller. Some boards support this, but it is unknown if it will work on every board. For this, choose 'IPMI SMBus handler', but be ready to try to do some figuring to see if it will work on your system if the SMBIOS/ACPI information is wrong or not present. It is fairly safe to have both these enabled and let the drivers auto-detect what is present.h]hXThe driver interface depends on your hardware. If your system properly provides the SMBIOS info for IPMI, the driver will detect it and just work. If you have a board with a standard interface (These will generally be either “KCS”, “SMIC”, or “BT”, consult your hardware manual), choose the ‘IPMI SI handler’ option. A driver also exists for direct I2C access to the IPMI management controller. Some boards support this, but it is unknown if it will work on every board. For this, choose ‘IPMI SMBus handler’, but be ready to try to do some figuring to see if it will work on your system if the SMBIOS/ACPI information is wrong or not present. It is fairly safe to have both these enabled and let the drivers auto-detect what is present.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK(hjthhubh)}(hkYou should generally enable ACPI on your system, as systems with IPMI can have ACPI tables describing them.h]hkYou should generally enable ACPI on your system, as systems with IPMI can have ACPI tables describing them.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK4hjthhubh)}(hXIf you have a standard interface and the board manufacturer has done their job correctly, the IPMI controller should be automatically detected (via ACPI or SMBIOS tables) and should just work. Sadly, many boards do not have this information. The driver attempts standard defaults, but they may not work. If you fall into this situation, you need to read the section below named 'The SI Driver' or "The SMBus Driver" on how to hand-configure your system.h]hXIf you have a standard interface and the board manufacturer has done their job correctly, the IPMI controller should be automatically detected (via ACPI or SMBIOS tables) and should just work. Sadly, many boards do not have this information. The driver attempts standard defaults, but they may not work. If you fall into this situation, you need to read the section below named ‘The SI Driver’ or “The SMBus Driver” on how to hand-configure your system.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK7hjthhubh)}(hXEIPMI defines a standard watchdog timer. You can enable this with the 'IPMI Watchdog Timer' config option. If you compile the driver into the kernel, then via a kernel command-line option you can have the watchdog timer start as soon as it initializes. It also has a lot of other options, see the 'Watchdog' section below for more details. Note that you can also have the watchdog continue to run if it is closed (by default it is disabled on close). Go into the 'Watchdog Cards' menu, enable 'Watchdog Timer Support', and enable the option 'Disable watchdog shutdown on close'.h]hXYIPMI defines a standard watchdog timer. You can enable this with the ‘IPMI Watchdog Timer’ config option. If you compile the driver into the kernel, then via a kernel command-line option you can have the watchdog timer start as soon as it initializes. It also has a lot of other options, see the ‘Watchdog’ section below for more details. Note that you can also have the watchdog continue to run if it is closed (by default it is disabled on close). Go into the ‘Watchdog Cards’ menu, enable ‘Watchdog Timer Support’, and enable the option ‘Disable watchdog shutdown on close’.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK?hjthhubh)}(hXmIPMI systems can often be powered off using IPMI commands. Select 'IPMI Poweroff' to do this. The driver will auto-detect if the system can be powered off by IPMI. It is safe to enable this even if your system doesn't support this option. This works on ATCA systems, the Radisys CPI1 card, and any IPMI system that supports standard chassis management commands.h]hXsIPMI systems can often be powered off using IPMI commands. Select ‘IPMI Poweroff’ to do this. The driver will auto-detect if the system can be powered off by IPMI. It is safe to enable this even if your system doesn’t support this option. This works on ATCA systems, the Radisys CPI1 card, and any IPMI system that supports standard chassis management commands.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKIhjthhubh)}(hXIf you want the driver to put an event into the event log on a panic, enable the 'Generate a panic event to all BMCs on a panic' option. If you want the whole panic string put into the event log using OEM events, enable the 'Generate OEM events containing the panic string' option. You can also enable these dynamically by setting the module parameter named "panic_op" in the ipmi_msghandler module to "event" or "string". Setting that parameter to "none" disables this function.h]hXIf you want the driver to put an event into the event log on a panic, enable the ‘Generate a panic event to all BMCs on a panic’ option. If you want the whole panic string put into the event log using OEM events, enable the ‘Generate OEM events containing the panic string’ option. You can also enable these dynamically by setting the module parameter named “panic_op” in the ipmi_msghandler module to “event” or “string”. Setting that parameter to “none” disables this function.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKPhjthhubeh}(h] configurationah ]h"] configurationah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Basic Designh]h Basic Design}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhKYubh)}(hThe Linux IPMI driver is designed to be very modular and flexible, you only need to take the pieces you need and you can use it in many different ways. Because of that, it's broken into many chunks of code. These chunks (by module name) are:h]hThe Linux IPMI driver is designed to be very modular and flexible, you only need to take the pieces you need and you can use it in many different ways. Because of that, it’s broken into many chunks of code. These chunks (by module name) are:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK[hj hhubh)}(hX|ipmi_msghandler - This is the central piece of software for the IPMI system. It handles all messages, message timing, and responses. The IPMI users tie into this, and the IPMI physical interfaces (called System Management Interfaces, or SMIs) also tie in here. This provides the kernelland interface for IPMI, but does not provide an interface for use by application processes.h]hX|ipmi_msghandler - This is the central piece of software for the IPMI system. It handles all messages, message timing, and responses. The IPMI users tie into this, and the IPMI physical interfaces (called System Management Interfaces, or SMIs) also tie in here. This provides the kernelland interface for IPMI, but does not provide an interface for use by application processes.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK`hj hhubh)}(hipmi_devintf - This provides a userland IOCTL interface for the IPMI driver, each open file for this device ties in to the message handler as an IPMI user.h]hipmi_devintf - This provides a userland IOCTL interface for the IPMI driver, each open file for this device ties in to the message handler as an IPMI user.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKghj hhubh)}(hipmi_si - A driver for various system interfaces. This supports KCS, SMIC, and BT interfaces. Unless you have an SMBus interface or your own custom interface, you probably need to use this.h]hipmi_si - A driver for various system interfaces. This supports KCS, SMIC, and BT interfaces. Unless you have an SMBus interface or your own custom interface, you probably need to use this.}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKkhj hhubh)}(hipmi_ssif - A driver for accessing BMCs on the SMBus. It uses the I2C kernel driver's SMBus interfaces to send and receive IPMI messages over the SMBus.h]hipmi_ssif - A driver for accessing BMCs on the SMBus. It uses the I2C kernel driver’s SMBus interfaces to send and receive IPMI messages over the SMBus.}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKohj hhubh)}(h;ipmi_powernv - A driver for access BMCs on POWERNV systems.h]h;ipmi_powernv - A driver for access BMCs on POWERNV systems.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKshj hhubh)}(hipmi_watchdog - IPMI requires systems to have a very capable watchdog timer. This driver implements the standard Linux watchdog timer interface on top of the IPMI message handler.h]hipmi_watchdog - IPMI requires systems to have a very capable watchdog timer. This driver implements the standard Linux watchdog timer interface on top of the IPMI message handler.}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKuhj hhubh)}(hTipmi_poweroff - Some systems support the ability to be turned off via IPMI commands.h]hTipmi_poweroff - Some systems support the ability to be turned off via IPMI commands.}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKyhj hhubh)}(hbt-bmc - This is not part of the main driver, but instead a driver for accessing a BMC-side interface of a BT interface. It is used on BMCs running Linux to provide an interface to the host.h]hbt-bmc - This is not part of the main driver, but instead a driver for accessing a BMC-side interface of a BT interface. It is used on BMCs running Linux to provide an interface to the host.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK|hj hhubh)}(h@These are all individually selectable via configuration options.h]h@These are all individually selectable via configuration options.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hZMuch documentation for the interface is in the include files. The IPMI include files are:h]hZMuch documentation for the interface is in the include files. The IPMI include files are:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hHlinux/ipmi.h - Contains the user interface and IOCTL interface for IPMI.h]hHlinux/ipmi.h - Contains the user interface and IOCTL interface for IPMI.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(h~linux/ipmi_smi.h - Contains the interface for system management interfaces (things that interface to IPMI controllers) to use.h]h~linux/ipmi_smi.h - Contains the interface for system management interfaces (things that interface to IPMI controllers) to use.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hClinux/ipmi_msgdefs.h - General definitions for base IPMI messaging.h]hClinux/ipmi_msgdefs.h - General definitions for base IPMI messaging.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj hhubeh}(h] basic-designah ]h"] basic designah$]h&]uh1hhhhhhhhKYubh)}(hhh](h)}(h Addressingh]h Addressing}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(h~The IPMI addressing works much like IP addresses, you have an overlay to handle the different address types. The overlay is::h]h}The IPMI addressing works much like IP addresses, you have an overlay to handle the different address types. The overlay is:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh literal_block)}(hgstruct ipmi_addr { int addr_type; short channel; char data[IPMI_MAX_ADDR_SIZE]; };h]hgstruct ipmi_addr { int addr_type; short channel; char data[IPMI_MAX_ADDR_SIZE]; };}hj sbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1jhhhKhjhhubh)}(hxThe addr_type determines what the address really is. The driver currently understands two different types of addresses.h]hxThe addr_type determines what the address really is. The driver currently understands two different types of addresses.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(h-"System Interface" addresses are defined as::h]h0“System Interface” addresses are defined as:}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hRstruct ipmi_system_interface_addr { int addr_type; short channel; };h]hRstruct ipmi_system_interface_addr { int addr_type; short channel; };}hj5sbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjhhubh)}(hand the type is IPMI_SYSTEM_INTERFACE_ADDR_TYPE. This is used for talking straight to the BMC on the current card. The channel must be IPMI_BMC_CHANNEL.h]hand the type is IPMI_SYSTEM_INTERFACE_ADDR_TYPE. This is used for talking straight to the BMC on the current card. The channel must be IPMI_BMC_CHANNEL.}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hMessages that are destined to go out on the IPMB bus going through the BMC use the IPMI_IPMB_ADDR_TYPE address type. The format is::h]hMessages that are destined to go out on the IPMB bus going through the BMC use the IPMI_IPMB_ADDR_TYPE address type. The format is:}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hstruct ipmi_ipmb_addr { int addr_type; short channel; unsigned char slave_addr; unsigned char lun; };h]hstruct ipmi_ipmb_addr { int addr_type; short channel; unsigned char slave_addr; unsigned char lun; };}hj_sbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjhhubh)}(hThe "channel" here is generally zero, but some devices support more than one channel, it corresponds to the channel as defined in the IPMI spec.h]hThe “channel” here is generally zero, but some devices support more than one channel, it corresponds to the channel as defined in the IPMI spec.}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hXThere is also an IPMB direct address for a situation where the sender is directly on an IPMB bus and doesn't have to go through the BMC. You can send messages to a specific management controller (MC) on the IPMB using the IPMI_IPMB_DIRECT_ADDR_TYPE with the following format::h]hXThere is also an IPMB direct address for a situation where the sender is directly on an IPMB bus and doesn’t have to go through the BMC. You can send messages to a specific management controller (MC) on the IPMB using the IPMI_IPMB_DIRECT_ADDR_TYPE with the following format:}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hstruct ipmi_ipmb_direct_addr { int addr_type; short channel; unsigned char slave_addr; unsigned char rq_lun; unsigned char rs_lun; };h]hstruct ipmi_ipmb_direct_addr { int addr_type; short channel; unsigned char slave_addr; unsigned char rq_lun; unsigned char rs_lun; };}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjhhubh)}(hThe channel is always zero. You can also receive commands from other MCs that you have registered to handle and respond to them, so you can use this to implement a management controller on a bus..h]hThe channel is always zero. You can also receive commands from other MCs that you have registered to handle and respond to them, so you can use this to implement a management controller on a bus..}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h] addressingah ]h"] addressingah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hMessagesh]hMessages}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hMessages are defined as::h]hMessages are defined as:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hstruct ipmi_msg { unsigned char netfn; unsigned char lun; unsigned char cmd; unsigned char *data; int data_len; };h]hstruct ipmi_msg { unsigned char netfn; unsigned char lun; unsigned char cmd; unsigned char *data; int data_len; };}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjhhubh)}(hXzThe driver takes care of adding/stripping the header information. The data portion is just the data to be send (do NOT put addressing info here) or the response. Note that the completion code of a response is the first item in "data", it is not stripped out because that is how all the messages are defined in the spec (and thus makes counting the offsets a little easier :-).h]hX~The driver takes care of adding/stripping the header information. The data portion is just the data to be send (do NOT put addressing info here) or the response. Note that the completion code of a response is the first item in “data”, it is not stripped out because that is how all the messages are defined in the spec (and thus makes counting the offsets a little easier :-).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hWhen using the IOCTL interface from userland, you must provide a block of data for "data", fill it, and set data_len to the length of the block of data, even when receiving messages. Otherwise the driver will have no place to put the message.h]hWhen using the IOCTL interface from userland, you must provide a block of data for “data”, fill it, and set data_len to the length of the block of data, even when receiving messages. Otherwise the driver will have no place to put the message.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hKMessages coming up from the message handler in kernelland will come in as::h]hJMessages coming up from the message handler in kernelland will come in as:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hXstruct ipmi_recv_msg { struct list_head link; /* The type of message as defined in the "Receive Types" defines above. */ int recv_type; ipmi_user_t *user; struct ipmi_addr addr; long msgid; struct ipmi_msg msg; /* Call this when done with the message. It will presumably free the message and do any other necessary cleanup. */ void (*done)(struct ipmi_recv_msg *msg); /* Place-holder for the data, don't make any assumptions about the size or existence of this, since it may change. */ unsigned char msg_data[IPMI_MAX_MSG_LENGTH]; };h]hXstruct ipmi_recv_msg { struct list_head link; /* The type of message as defined in the "Receive Types" defines above. */ int recv_type; ipmi_user_t *user; struct ipmi_addr addr; long msgid; struct ipmi_msg msg; /* Call this when done with the message. It will presumably free the message and do any other necessary cleanup. */ void (*done)(struct ipmi_recv_msg *msg); /* Place-holder for the data, don't make any assumptions about the size or existence of this, since it may change. */ unsigned char msg_data[IPMI_MAX_MSG_LENGTH]; };}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjhhubh)}(hIYou should look at the receive type and handle the message appropriately.h]hIYou should look at the receive type and handle the message appropriately.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]messagesah ]h"]messagesah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h+The Upper Layer Interface (Message Handler)h]h+The Upper Layer Interface (Message Handler)}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubh)}(hXThe upper layer of the interface provides the users with a consistent view of the IPMI interfaces. It allows multiple SMI interfaces to be addressed (because some boards actually have multiple BMCs on them) and the user should not have to care what type of SMI is below them.h]hXThe upper layer of the interface provides the users with a consistent view of the IPMI interfaces. It allows multiple SMI interfaces to be addressed (because some boards actually have multiple BMCs on them) and the user should not have to care what type of SMI is below them.}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj(hhubh)}(hhh](h)}(hWatching For Interfacesh]hWatching For Interfaces}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjGhhhhhM ubh)}(hXtWhen your code comes up, the IPMI driver may or may not have detected if IPMI devices exist. So you might have to defer your setup until the device is detected, or you might be able to do it immediately. To handle this, and to allow for discovery, you register an SMI watcher with ipmi_smi_watcher_register() to iterate over interfaces and tell you when they come and go.h]hXtWhen your code comes up, the IPMI driver may or may not have detected if IPMI devices exist. So you might have to defer your setup until the device is detected, or you might be able to do it immediately. To handle this, and to allow for discovery, you register an SMI watcher with ipmi_smi_watcher_register() to iterate over interfaces and tell you when they come and go.}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjGhhubeh}(h]watching-for-interfacesah ]h"]watching for interfacesah$]h&]uh1hhj(hhhhhM ubh)}(hhh](h)}(hCreating the Userh]hCreating the User}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjnhhhhhMubh)}(hXLTo use the message handler, you must first create a user using ipmi_create_user. The interface number specifies which SMI you want to connect to, and you must supply callback functions to be called when data comes in. This also allows you to pass in a piece of data, the handler_data, that will be passed back to you on all calls.h]hXLTo use the message handler, you must first create a user using ipmi_create_user. The interface number specifies which SMI you want to connect to, and you must supply callback functions to be called when data comes in. This also allows you to pass in a piece of data, the handler_data, that will be passed back to you on all calls.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjnhhubh)}(hCOnce you are done, call ipmi_destroy_user() to get rid of the user.h]hCOnce you are done, call ipmi_destroy_user() to get rid of the user.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjnhhubh)}(hwFrom userland, opening the device automatically creates a user, and closing the device automatically destroys the user.h]hwFrom userland, opening the device automatically creates a user, and closing the device automatically destroys the user.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjnhhubeh}(h]creating-the-userah ]h"]creating the userah$]h&]uh1hhj(hhhhhMubh)}(hhh](h)}(h Messagingh]h Messaging}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM%ubh)}(hXrTo send a message from kernel-land, the ipmi_request_settime() call does pretty much all message handling. Most of the parameter are self-explanatory. However, it takes a "msgid" parameter. This is NOT the sequence number of messages. It is simply a long value that is passed back when the response for the message is returned. You may use it for anything you like.h]hXvTo send a message from kernel-land, the ipmi_request_settime() call does pretty much all message handling. Most of the parameter are self-explanatory. However, it takes a “msgid” parameter. This is NOT the sequence number of messages. It is simply a long value that is passed back when the response for the message is returned. You may use it for anything you like.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM'hjhhubh)}(hResponses come back in the function pointed to by the ipmi_recv_hndl field of the "handler" that you passed in to ipmi_create_user(). Remember to look at the receive type, too.h]hResponses come back in the function pointed to by the ipmi_recv_hndl field of the “handler” that you passed in to ipmi_create_user(). Remember to look at the receive type, too.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM.hjhhubh)}(hXFrom userland, you fill out an ipmi_req_t structure and use the IPMICTL_SEND_COMMAND ioctl. For incoming stuff, you can use select() or poll() to wait for messages to come in. However, you cannot use read() to get them, you must call the IPMICTL_RECEIVE_MSG with the ipmi_recv_t structure to actually get the message. Remember that you must supply a pointer to a block of data in the msg.data field, and you must fill in the msg.data_len field with the size of the data. This gives the receiver a place to actually put the message.h]hXFrom userland, you fill out an ipmi_req_t structure and use the IPMICTL_SEND_COMMAND ioctl. For incoming stuff, you can use select() or poll() to wait for messages to come in. However, you cannot use read() to get them, you must call the IPMICTL_RECEIVE_MSG with the ipmi_recv_t structure to actually get the message. Remember that you must supply a pointer to a block of data in the msg.data field, and you must fill in the msg.data_len field with the size of the data. This gives the receiver a place to actually put the message.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM2hjhhubh)}(hIf the message cannot fit into the data you provide, you will get an EMSGSIZE error and the driver will leave the data in the receive queue. If you want to get it and have it truncate the message, use the IPMICTL_RECEIVE_MSG_TRUNC ioctl.h]hIf the message cannot fit into the data you provide, you will get an EMSGSIZE error and the driver will leave the data in the receive queue. If you want to get it and have it truncate the message, use the IPMICTL_RECEIVE_MSG_TRUNC ioctl.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM;hjhhubh)}(hXWhen you send a command (which is defined by the lowest-order bit of the netfn per the IPMI spec) on the IPMB bus, the driver will automatically assign the sequence number to the command and save the command. If the response is not received in the IPMI-specified 5 seconds, it will generate a response automatically saying the command timed out. If an unsolicited response comes in (if it was after 5 seconds, for instance), that response will be ignored.h]hXWhen you send a command (which is defined by the lowest-order bit of the netfn per the IPMI spec) on the IPMB bus, the driver will automatically assign the sequence number to the command and save the command. If the response is not received in the IPMI-specified 5 seconds, it will generate a response automatically saying the command timed out. If an unsolicited response comes in (if it was after 5 seconds, for instance), that response will be ignored.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM@hjhhubh)}(hIn kernelland, after you receive a message and are done with it, you MUST call ipmi_free_recv_msg() on it, or you will leak messages. Note that you should NEVER mess with the "done" field of a message, that is required to properly clean up the message.h]hXIn kernelland, after you receive a message and are done with it, you MUST call ipmi_free_recv_msg() on it, or you will leak messages. Note that you should NEVER mess with the “done” field of a message, that is required to properly clean up the message.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMHhjhhubh)}(hXNote that when sending, there is an ipmi_request_supply_msgs() call that lets you supply the smi and receive message. This is useful for pieces of code that need to work even if the system is out of buffers (the watchdog timer uses this, for instance). You supply your own buffer and own free routines. This is not recommended for normal use, though, since it is tricky to manage your own buffers.h]hXNote that when sending, there is an ipmi_request_supply_msgs() call that lets you supply the smi and receive message. This is useful for pieces of code that need to work even if the system is out of buffers (the watchdog timer uses this, for instance). You supply your own buffer and own free routines. This is not recommended for normal use, though, since it is tricky to manage your own buffers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMMhjhhubeh}(h] messagingah ]h"] messagingah$]h&]uh1hhj(hhhhhM%ubh)}(hhh](h)}(hEvents and Incoming Commandsh]hEvents and Incoming Commands}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hhhhhMVubh)}(hXThe driver takes care of polling for IPMI events and receiving commands (commands are messages that are not responses, they are commands that other things on the IPMB bus have sent you). To receive these, you must register for them, they will not automatically be sent to you.h]hXThe driver takes care of polling for IPMI events and receiving commands (commands are messages that are not responses, they are commands that other things on the IPMB bus have sent you). To receive these, you must register for them, they will not automatically be sent to you.}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMXhj,hhubh)}(hXJTo receive events, you must call ipmi_set_gets_events() and set the "val" to non-zero. Any events that have been received by the driver since startup will immediately be delivered to the first user that registers for events. After that, if multiple users are registered for events, they will all receive all events that come in.h]hXNTo receive events, you must call ipmi_set_gets_events() and set the “val” to non-zero. Any events that have been received by the driver since startup will immediately be delivered to the first user that registers for events. After that, if multiple users are registered for events, they will all receive all events that come in.}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM^hj,hhubh)}(hXFor receiving commands, you have to individually register commands you want to receive. Call ipmi_register_for_cmd() and supply the netfn and command name for each command you want to receive. You also specify a bitmask of the channels you want to receive the command from (or use IPMI_CHAN_ALL for all channels if you don't care). Only one user may be registered for each netfn/cmd/channel, but different users may register for different commands, or the same command if the channel bitmasks do not overlap.h]hXFor receiving commands, you have to individually register commands you want to receive. Call ipmi_register_for_cmd() and supply the netfn and command name for each command you want to receive. You also specify a bitmask of the channels you want to receive the command from (or use IPMI_CHAN_ALL for all channels if you don’t care). Only one user may be registered for each netfn/cmd/channel, but different users may register for different commands, or the same command if the channel bitmasks do not overlap.}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMdhj,hhubh)}(hTo respond to a received command, set the response bit in the returned netfn, use the address from the received message, and use the same msgid that you got in the received message.h]hTo respond to a received command, set the response bit in the returned netfn, use the address from the received message, and use the same msgid that you got in the received message.}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMmhj,hhubh)}(hDFrom userland, equivalent IOCTLs are provided to do these functions.h]hDFrom userland, equivalent IOCTLs are provided to do these functions.}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMqhj,hhubeh}(h]events-and-incoming-commandsah ]h"]events and incoming commandsah$]h&]uh1hhj(hhhhhMVubeh}(h])the-upper-layer-interface-message-handlerah ]h"]+the upper layer interface (message handler)ah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hThe Lower Layer (SMI) Interfaceh]hThe Lower Layer (SMI) Interface}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMuubh)}(hX;As mentioned before, multiple SMI interfaces may be registered to the message handler, each of these is assigned an interface number when they register with the message handler. They are generally assigned in the order they register, although if an SMI unregisters and then another one registers, all bets are off.h]hX;As mentioned before, multiple SMI interfaces may be registered to the message handler, each of these is assigned an interface number when they register with the message handler. They are generally assigned in the order they register, although if an SMI unregisters and then another one registers, all bets are off.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMwhjhhubh)}(hZThe ipmi_smi.h defines the interface for management interfaces, see that for more details.h]hZThe ipmi_smi.h defines the interface for management interfaces, see that for more details.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM}hjhhubeh}(h]the-lower-layer-smi-interfaceah ]h"]the lower layer (smi) interfaceah$]h&]uh1hhhhhhhhMuubh)}(hhh](h)}(h The SI Driverh]h The SI Driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hThe SI driver allows KCS, BT, and SMIC interfaces to be configured in the system. It discovers interfaces through a host of different methods, depending on the system.h]hThe SI driver allows KCS, BT, and SMIC interfaces to be configured in the system. It discovers interfaces through a host of different methods, depending on the system.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hbYou can specify up to four interfaces on the module load line and control some module parameters::h]haYou can specify up to four interfaces on the module load line and control some module parameters:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(hXmodprobe ipmi_si.o type=,.... ports=,... addrs=,... irqs=,... regspacings=,,... regsizes=,,... regshifts=,,... slave_addrs=,,... force_kipmid=,,... kipmid_max_busy_us=,,... unload_when_empty=[0|1] trydmi=[0|1] tryacpi=[0|1] tryplatform=[0|1] trypci=[0|1]h]hXmodprobe ipmi_si.o type=,.... ports=,... addrs=,... irqs=,... regspacings=,,... regsizes=,,... regshifts=,,... slave_addrs=,,... force_kipmid=,,... kipmid_max_busy_us=,,... unload_when_empty=[0|1] trydmi=[0|1] tryacpi=[0|1] tryplatform=[0|1] trypci=[0|1]}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjhhubh)}(hEach of these except try... items is a list, the first item for the first interface, second item for the second interface, etc.h]hEach of these except try... items is a list, the first item for the first interface, second item for the second interface, etc.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(h_The si_type may be either "kcs", "smic", or "bt". If you leave it blank, it defaults to "kcs".h]hoThe si_type may be either “kcs”, “smic”, or “bt”. If you leave it blank, it defaults to “kcs”.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hIf you specify addrs as non-zero for an interface, the driver will use the memory address given as the address of the device. This overrides si_ports.h]hIf you specify addrs as non-zero for an interface, the driver will use the memory address given as the address of the device. This overrides si_ports.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hpIf you specify ports as non-zero for an interface, the driver will use the I/O port given as the device address.h]hpIf you specify ports as non-zero for an interface, the driver will use the I/O port given as the device address.}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(htIf you specify irqs as non-zero for an interface, the driver will attempt to use the given interrupt for the device.h]htIf you specify irqs as non-zero for an interface, the driver will attempt to use the given interrupt for the device.}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hThe other try... items disable discovery by their corresponding names. These are all enabled by default, set them to zero to disable them. The tryplatform disables openfirmware.h]hThe other try... items disable discovery by their corresponding names. These are all enabled by default, set them to zero to disable them. The tryplatform disables openfirmware.}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXThe next three parameters have to do with register layout. The registers used by the interfaces may not appear at successive locations and they may not be in 8-bit registers. These parameters allow the layout of the data in the registers to be more precisely specified.h]hXThe next three parameters have to do with register layout. The registers used by the interfaces may not appear at successive locations and they may not be in 8-bit registers. These parameters allow the layout of the data in the registers to be more precisely specified.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hThe regspacings parameter give the number of bytes between successive register start addresses. For instance, if the regspacing is set to 4 and the start address is 0xca2, then the address for the second register would be 0xca6. This defaults to 1.h]hThe regspacings parameter give the number of bytes between successive register start addresses. For instance, if the regspacing is set to 4 and the start address is 0xca2, then the address for the second register would be 0xca6. This defaults to 1.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hThe regsizes parameter gives the size of a register, in bytes. The data used by IPMI is 8-bits wide, but it may be inside a larger register. This parameter allows the read and write type to be specified. It may be 1, 2, 4, or 8. The default is 1.h]hThe regsizes parameter gives the size of a register, in bytes. The data used by IPMI is 8-bits wide, but it may be inside a larger register. This parameter allows the read and write type to be specified. It may be 1, 2, 4, or 8. The default is 1.}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hSince the register size may be larger than 32 bits, the IPMI data may not be in the lower 8 bits. The regshifts parameter give the amount to shift the data to get to the actual IPMI data.h]hSince the register size may be larger than 32 bits, the IPMI data may not be in the lower 8 bits. The regshifts parameter give the amount to shift the data to get to the actual IPMI data.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hThe slave_addrs specifies the IPMI address of the local BMC. This is usually 0x20 and the driver defaults to that, but in case it's not, it can be specified when the driver starts up.h]hThe slave_addrs specifies the IPMI address of the local BMC. This is usually 0x20 and the driver defaults to that, but in case it’s not, it can be specified when the driver starts up.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hX=The force_ipmid parameter forcefully enables (if set to 1) or disables (if set to 0) the kernel IPMI daemon. Normally this is auto-detected by the driver, but systems with broken interrupts might need an enable, or users that don't want the daemon (don't need the performance, don't want the CPU hit) can disable it.h]hXCThe force_ipmid parameter forcefully enables (if set to 1) or disables (if set to 0) the kernel IPMI daemon. Normally this is auto-detected by the driver, but systems with broken interrupts might need an enable, or users that don’t want the daemon (don’t need the performance, don’t want the CPU hit) can disable it.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hIf unload_when_empty is set to 1, the driver will be unloaded if it doesn't find any interfaces or all the interfaces fail to work. The default is one. Setting to 0 is useful with the hotmod, but is obviously only useful for modules.h]hIf unload_when_empty is set to 1, the driver will be unloaded if it doesn’t find any interfaces or all the interfaces fail to work. The default is one. Setting to 0 is useful with the hotmod, but is obviously only useful for modules.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(h^When compiled into the kernel, the parameters can be specified on the kernel command line as::h]h]When compiled into the kernel, the parameters can be specified on the kernel command line as:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(hXipmi_si.type=,... ipmi_si.ports=,... ipmi_si.addrs=,... ipmi_si.irqs=,... ipmi_si.regspacings=,,... ipmi_si.regsizes=,,... ipmi_si.regshifts=,,... ipmi_si.slave_addrs=,,... ipmi_si.force_kipmid=,,... ipmi_si.kipmid_max_busy_us=,,...h]hXipmi_si.type=,... ipmi_si.ports=,... ipmi_si.addrs=,... ipmi_si.irqs=,... ipmi_si.regspacings=,,... ipmi_si.regsizes=,,... ipmi_si.regshifts=,,... ipmi_si.slave_addrs=,,... ipmi_si.force_kipmid=,,... ipmi_si.kipmid_max_busy_us=,,...}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjhhubh)}(h=It works the same as the module parameters of the same names.h]h=It works the same as the module parameters of the same names.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXIf your IPMI interface does not support interrupts and is a KCS or SMIC interface, the IPMI driver will start a kernel thread for the interface to help speed things up. This is a low-priority kernel thread that constantly polls the IPMI driver while an IPMI operation is in progress. The force_kipmid module parameter will allow the user to force this thread on or off. If you force it off and don't have interrupts, the driver will run VERY slowly. Don't blame me, these interfaces suck.h]hXIf your IPMI interface does not support interrupts and is a KCS or SMIC interface, the IPMI driver will start a kernel thread for the interface to help speed things up. This is a low-priority kernel thread that constantly polls the IPMI driver while an IPMI operation is in progress. The force_kipmid module parameter will allow the user to force this thread on or off. If you force it off and don’t have interrupts, the driver will run VERY slowly. Don’t blame me, these interfaces suck.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXHUnfortunately, this thread can use a lot of CPU depending on the interface's performance. This can waste a lot of CPU and cause various issues with detecting idle CPU and using extra power. To avoid this, the kipmid_max_busy_us sets the maximum amount of time, in microseconds, that kipmid will spin before sleeping for a tick. This value sets a balance between performance and CPU waste and needs to be tuned to your needs. Maybe, someday, auto-tuning will be added, but that's not a simple thing and even the auto-tuning would need to be tuned to the user's desired performance.h]hXNUnfortunately, this thread can use a lot of CPU depending on the interface’s performance. This can waste a lot of CPU and cause various issues with detecting idle CPU and using extra power. To avoid this, the kipmid_max_busy_us sets the maximum amount of time, in microseconds, that kipmid will spin before sleeping for a tick. This value sets a balance between performance and CPU waste and needs to be tuned to your needs. Maybe, someday, auto-tuning will be added, but that’s not a simple thing and even the auto-tuning would need to be tuned to the user’s desired performance.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hX(The driver supports a hot add and remove of interfaces. This way, interfaces can be added or removed after the kernel is up and running. This is done using /sys/module/ipmi_si/parameters/hotmod, which is a write-only parameter. You write a string to this interface. The string has the format::h]hX'The driver supports a hot add and remove of interfaces. This way, interfaces can be added or removed after the kernel is up and running. This is done using /sys/module/ipmi_si/parameters/hotmod, which is a write-only parameter. You write a string to this interface. The string has the format:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(h[:op2[:op3...]]h]h[:op2[:op3...]]}hj sbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjhhubh)}(hThe "op"s are::h]hThe “op”s are:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(h@add|remove,kcs|bt|smic,mem|i/o,
[,[,[,...]]]h]h@add|remove,kcs|bt|smic,mem|i/o,
[,[,[,...]]]}hj)sbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjhhubh)}(hFYou can specify more than one interface on the line. The "opt"s are::h]hIYou can specify more than one interface on the line. The “opt”s are:}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(hNrsp= rsi= rsh= irq= ipmb=h]hNrsp= rsi= rsh= irq= ipmb=}hjEsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjhhubh)}(hXWand these have the same meanings as discussed above. Note that you can also use this on the kernel command line for a more compact format for specifying an interface. Note that when removing an interface, only the first three parameters (si type, address type, and address) are used for the comparison. Any options are ignored for removing.h]hXWand these have the same meanings as discussed above. Note that you can also use this on the kernel command line for a more compact format for specifying an interface. Note that when removing an interface, only the first three parameters (si type, address type, and address) are used for the comparison. Any options are ignored for removing.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h] the-si-driverah ]h"] the si driverah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hThe SMBus Driver (SSIF)h]hThe SMBus Driver (SSIF)}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjihhhhhM ubh)}(hThe SMBus driver allows up to 4 SMBus devices to be configured in the system. By default, the driver will only register with something it finds in DMI or ACPI tables. You can change this at module load time (for a module) with::h]hThe SMBus driver allows up to 4 SMBus devices to be configured in the system. By default, the driver will only register with something it finds in DMI or ACPI tables. You can change this at module load time (for a module) with:}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjihhubj)}(hmodprobe ipmi_ssif.o addr=[,[,...]] adapter=[,[...]] dbg=,... slave_addrs=,,... tryacpi=[0|1] trydmi=[0|1] [dbg_probe=1] alerts_brokenh]hmodprobe ipmi_ssif.o addr=[,[,...]] adapter=[,[...]] dbg=,... slave_addrs=,,... tryacpi=[0|1] trydmi=[0|1] [dbg_probe=1] alerts_broken}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjihhubh)}(hXfThe addresses are normal I2C addresses. The adapter is the string name of the adapter, as shown in /sys/bus/i2c/devices/i2c-/name. It is *NOT* i2c- itself. Also, the comparison is done ignoring spaces, so if the name is "This is an I2C chip" you can say adapter_name=ThisisanI2cchip. This is because it's hard to pass in spaces in kernel parameters.h](hThe addresses are normal I2C addresses. The adapter is the string name of the adapter, as shown in /sys/bus/i2c/devices/i2c-/name. It is }(hjhhhNhNubhemphasis)}(h*NOT*h]hNOT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh i2c- itself. Also, the comparison is done ignoring spaces, so if the name is “This is an I2C chip” you can say adapter_name=ThisisanI2cchip. This is because it’s hard to pass in spaces in kernel parameters.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjihhubh)}(hvThe debug flags are bit flags for each BMC found, they are: IPMI messages: 1, driver state: 2, timing: 4, I2C probe: 8h]hvThe debug flags are bit flags for each BMC found, they are: IPMI messages: 1, driver state: 2, timing: 4, I2C probe: 8}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM"hjihhubh)}(hWThe tryxxx parameters can be used to disable detecting interfaces from various sources.h]hWThe tryxxx parameters can be used to disable detecting interfaces from various sources.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM%hjihhubh)}(hkSetting dbg_probe to 1 will enable debugging of the probing and detection process for BMCs on the SMBusses.h]hkSetting dbg_probe to 1 will enable debugging of the probing and detection process for BMCs on the SMBusses.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM(hjihhubh)}(hThe slave_addrs specifies the IPMI address of the local BMC. This is usually 0x20 and the driver defaults to that, but in case it's not, it can be specified when the driver starts up.h]hThe slave_addrs specifies the IPMI address of the local BMC. This is usually 0x20 and the driver defaults to that, but in case it’s not, it can be specified when the driver starts up.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM+hjihhubh)}(hpalerts_broken does not enable SMBus alert for SSIF. Otherwise SMBus alert will be enabled on supported hardware.h]hpalerts_broken does not enable SMBus alert for SSIF. Otherwise SMBus alert will be enabled on supported hardware.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM/hjihhubh)}(hXDiscovering the IPMI compliant BMC on the SMBus can cause devices on the I2C bus to fail. The SMBus driver writes a "Get Device ID" IPMI message as a block write to the I2C bus and waits for a response. This action can be detrimental to some I2C devices. It is highly recommended that the known I2C address be given to the SMBus driver in the smb_addr parameter unless you have DMI or ACPI data to tell the driver what to use.h]hXDiscovering the IPMI compliant BMC on the SMBus can cause devices on the I2C bus to fail. The SMBus driver writes a “Get Device ID” IPMI message as a block write to the I2C bus and waits for a response. This action can be detrimental to some I2C devices. It is highly recommended that the known I2C address be given to the SMBus driver in the smb_addr parameter unless you have DMI or ACPI data to tell the driver what to use.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM2hjihhubh)}(h]When compiled into the kernel, the addresses can be specified on the kernel command line as::h]h\When compiled into the kernel, the addresses can be specified on the kernel command line as:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM:hjihhubj)}(hXipmb_ssif.addr=[,[...]] ipmi_ssif.adapter=[,[...]] ipmi_ssif.dbg=[,[...]] ipmi_ssif.dbg_probe=1 ipmi_ssif.slave_addrs=[,[...]] ipmi_ssif.tryacpi=[0|1] ipmi_ssif.trydmi=[0|1]h]hXipmb_ssif.addr=[,[...]] ipmi_ssif.adapter=[,[...]] ipmi_ssif.dbg=[,[...]] ipmi_ssif.dbg_probe=1 ipmi_ssif.slave_addrs=[,[...]] ipmi_ssif.tryacpi=[0|1] ipmi_ssif.trydmi=[0|1]}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhM=hjihhubh)}(h9These are the same options as on the module command line.h]h9These are the same options as on the module command line.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMDhjihhubh)}(hXThe I2C driver does not support non-blocking access or polling, so this driver cannot do IPMI panic events, extend the watchdog at panic time, or other panic-related IPMI functions without special kernel patches and driver modifications. You can get those at the openipmi web page.h]hXThe I2C driver does not support non-blocking access or polling, so this driver cannot do IPMI panic events, extend the watchdog at panic time, or other panic-related IPMI functions without special kernel patches and driver modifications. You can get those at the openipmi web page.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMFhjihhubh)}(hWThe driver supports a hot add and remove of interfaces through the I2C sysfs interface.h]hWThe driver supports a hot add and remove of interfaces through the I2C sysfs interface.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMLhjihhubeh}(h]the-smbus-driver-ssifah ]h"]the smbus driver (ssif)ah$]h&]uh1hhhhhhhhM ubh)}(hhh](h)}(hThe IPMI IPMB Driverh]hThe IPMI IPMB Driver}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjZhhhhhMPubh)}(hXThis driver is for supporting a system that sits on an IPMB bus; it allows the interface to look like a normal IPMI interface. Sending system interface addressed messages to it will cause the message to go to the registered BMC on the system (default at IPMI address 0x20).h]hXThis driver is for supporting a system that sits on an IPMB bus; it allows the interface to look like a normal IPMI interface. Sending system interface addressed messages to it will cause the message to go to the registered BMC on the system (default at IPMI address 0x20).}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMRhjZhhubh)}(hIt also allows you to directly address other MCs on the bus using the ipmb direct addressing. You can receive commands from other MCs on the bus and they will be handled through the normal received command mechanism described above.h]hIt also allows you to directly address other MCs on the bus using the ipmb direct addressing. You can receive commands from other MCs on the bus and they will be handled through the normal received command mechanism described above.}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMWhjZhhubh)}(hParameters are::h]hParameters are:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM\hjZhhubj)}(hipmi_ipmb.bmcaddr=
ipmi_ipmb.retry_time_ms=