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
74 'IPMI Poweroff' to do this.  The driver will auto-detect if the system
82 you want the whole panic string put into the event log using OEM
83 events, enable the 'Generate OEM events containing the panic string'
86 or "string".  Setting that parameter to "none" disables this function.
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,
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 ----------
186 --------
204 offsets a little easier :-).
231 	/* Place-holder for the data, don't make any assumptions about
241 -------------------------------------------
280 To send a message from kernel-land, the ipmi_request_settime() call does
282 self-explanatory.  However, it takes a "msgid" parameter.  This is NOT
306 When you send a command (which is defined by the lowest-order bit of
309 command.  If the response is not receive in the IPMI-specified 5
337 "val" to non-zero.  Any events that have been received by the driver
355 -------------------------------
368 -------------
395 If you specify addrs as non-zero for an interface, the driver will
399 If you specify ports as non-zero for an interface, the driver will
402 If you specify irqs as non-zero for an interface, the driver will
411 locations and they may not be in 8-bit registers.  These parameters
421 data used by IPMI is 8-bits wide, but it may be inside a larger
434 (if set to 0) the kernel IPMI daemon.  Normally this is auto-detected
461 interface to help speed things up.  This is a low-priority kernel
474 tuned to your needs.  Maybe, someday, auto-tuning will be added, but
475 that's not a simple thing and even the auto-tuning would need to be
481 write-only parameter.  You write a string to this interface.  The string
505 -----------------------
521 The addresses are normal I2C addresses.  The adapter is the string
522 name of the adapter, as shown in /sys/class/i2c-adapter/i2c-<n>/name.
523 It is *NOT* i2c-<n> itself.  Also, the comparison is done ignoring
535 detection process for BMCs on the SMBusses.
564 The I2C driver does not support non-blocking access or polling, so
566 time, or other panic-related IPMI functions without special kernel
574 ------------
577 --------------------------------------------------
604 --------
606 A watchdog timer is provided that implements the Linux-standard
615 The default is -1, which means to pick the first one registered.
618 is the amount of seconds before the reset that the pre-timeout panic will
666 gets a pre-action.  During a panic or a reboot, the watchdog will
682 --------------
684 The OpenIPMI driver supports the ability to put semi-custom and custom
688 the 'Generate OEM events containing the panic string' option, you will
689 also get a bunch of OEM events holding the panic string.
697 * Sensor #: The first byte of the panic string (0 if no panic string)
698 * Event Dir | Event Type: 0x6f (Assertion, sensor-specific event info)
700 * Event data 2: second byte of panic string
701 * Event data 3: third byte of panic string
709 * Record ID (bytes 0-1): Set by the SEL.
710 * Record type (byte 2): 0xf0 (OEM non-timestamped)
713   The rest of the bytes (11 bytes) are the panic string.  If the panic string
729 --------
738 either be zero (do a power down) or non-zero (do a power cycle, power
746 code should use.  The default is -1, which means to pick the first one