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.
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
73 IPMI systems can often be powered off using IPMI commands.  Select
74 'IPMI Poweroff' to do this.  The driver will auto-detect if the system
75 can be powered off by IPMI.  It is safe to enable this even if your
89 ------------
96 ipmi_msghandler - This is the central piece of software for the IPMI
98 IPMI users tie into this, and the IPMI physical interfaces (called
99 System Management Interfaces, or SMIs) also tie in here.  This
103 ipmi_devintf - This provides a userland IOCTL interface for the IPMI
107 ipmi_si - A driver for various system interfaces.  This supports KCS,
111 ipmi_ssif - A driver for accessing BMCs on the SMBus. It uses the
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 -------------------------------
382 another one registers, all bets are off.
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
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
482 interface to help speed things up.  This is a low-priority kernel
485 force this thread on or off.  If you force it off and don't have
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
526 -----------------------
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
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
675 The default is -1, which means to pick the first one registered.
678 is the amount of seconds before the reset that the pre-timeout panic will
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
799 the system off, then power it on in a few seconds).  Setting
803 does not support power cycling, it will always do the power off.
806 code should use.  The default is -1, which means to pick the first one
810 power off.