Documentation/driver-api/ipmi.rst

12 standardized database for field-replaceable units (FRUs) and a watchdog
25 -------------
32 No matter what, you must pick 'IPMI top-level message handler' to use
35 The message handler does not provide any user-level interfaces.
47 this, choose 'IPMI SMBus handler', but be ready to try to do some
50 these enabled and let the drivers auto-detect what is present.
61 "The SMBus Driver" on how to hand-configure your system.
65 the kernel, then via a kernel command-line option you can have the
71 'Disable watchdog shutdown on close'.
74 'IPMI Poweroff' to do this.  The driver will auto-detect if the system
89 ------------
96 ipmi_msghandler - This is the central piece of software for the IPMI
103 ipmi_devintf - This provides a userland IOCTL interface for the IPMI
107 ipmi_si - A driver for various system interfaces.  This supports KCS,
108 SMIC, and BT interfaces.  Unless you have an SMBus interface or your
111 ipmi_ssif - A driver for accessing BMCs on the SMBus. It uses the
112 I2C kernel driver's SMBus interfaces to send and receive IPMI messages
113 over the SMBus.
115 ipmi_powernv - A driver for access BMCs on POWERNV systems.
117 ipmi_watchdog - IPMI requires systems to have a very capable watchdog
121 ipmi_poweroff - Some systems support the ability to be turned off via
124 bt-bmc - This is not part of the main driver, but instead a driver for
125 accessing a BMC-side interface of a BT interface.  It is used on BMCs
133 linux/ipmi.h - Contains the user interface and IOCTL interface for IPMI.
135 linux/ipmi_smi.h - Contains the interface for system management interfaces
138 linux/ipmi_msgdefs.h - General definitions for base IPMI messaging.
142 ----------
203 --------
221 offsets a little easier :-).
248 	/* Place-holder for the data, don't make any assumptions about
258 -------------------------------------------
297 To send a message from kernel-land, the ipmi_request_settime() call does
299 self-explanatory.  However, it takes a "msgid" parameter.  This is NOT
323 When you send a command (which is defined by the lowest-order bit of
326 command.  If the response is not receive in the IPMI-specified 5
354 "val" to non-zero.  Any events that have been received by the driver
376 -------------------------------
389 -------------
416 If you specify addrs as non-zero for an interface, the driver will
420 If you specify ports as non-zero for an interface, the driver will
423 If you specify irqs as non-zero for an interface, the driver will
426 The other try... items disable discovery by their corresponding
427 names.  These are all enabled by default, set them to zero to disable
432 locations and they may not be in 8-bit registers.  These parameters
442 data used by IPMI is 8-bits wide, but it may be inside a larger
455 (if set to 0) the kernel IPMI daemon.  Normally this is auto-detected
458 want the CPU hit) can disable it.
482 interface to help speed things up.  This is a low-priority kernel
495 tuned to your needs.  Maybe, someday, auto-tuning will be added, but
496 that's not a simple thing and even the auto-tuning would need to be
502 write-only parameter.  You write a string to this interface.  The string
525 The SMBus Driver (SSIF)
526 -----------------------
528 The SMBus driver allows up to 4 SMBus devices to be configured in the
543 name of the adapter, as shown in /sys/bus/i2c/devices/i2c-<n>/name.
544 It is *NOT* i2c-<n> itself.  Also, the comparison is done ignoring
552 The tryxxx parameters can be used to disable detecting interfaces
562 alerts_broken does not enable SMBus alert for SSIF. Otherwise SMBus
565 Discovering the IPMI compliant BMC on the SMBus can cause devices on
566 the I2C bus to fail. The SMBus driver writes a "Get Device ID" IPMI
569 recommended that the known I2C address be given to the SMBus driver in
585 The I2C driver does not support non-blocking access or polling, so
587 time, or other panic-related IPMI functions without special kernel
595 --------------------
617   echo ipmi-ipmb <addr> > /sys/class/i2c-dev/i2c-<n>/device/new_device
631 channels being 0-7 and try the IPMB channels.
634 ------------
637 --------------------------------------------------
664 --------
666 A watchdog timer is provided that implements the Linux-standard
670   modprobe ipmi_watchdog timeout=<t> pretimeout=<t> action=<action type>
675 The default is -1, which means to pick the first one registered.
677 The timeout is the number of seconds to the action, and the pretimeout
678 is the amount of seconds before the reset that the pre-timeout panic will
680 that the pretimeout is the time before the final timeout.  So if the
681 timeout is 50 seconds and the pretimeout is 10 seconds, then the pretimeout
682 will occur in 40 second (10 seconds before the timeout). The panic_wdt_timeout
683 is the value of timeout which is set on kernel panic, in order to let actions
715   ipmi_watchdog.timeout=<t> ipmi_watchdog.pretimeout=<t>
725 The watchdog will panic and start a 120 second reset timeout if it
726 gets a pre-action.  During a panic or a reboot, the watchdog will
742 --------------
744 The OpenIPMI driver supports the ability to put semi-custom and custom
758 * Event Dir | Event Type: 0x6f (Assertion, sensor-specific event info)
769 * Record ID (bytes 0-1): Set by the SEL.
770 * Record type (byte 2): 0xf0 (OEM non-timestamped)
789 --------
798 either be zero (do a power down) or non-zero (do a power cycle, power
806 code should use.  The default is -1, which means to pick the first one