blob: aa77a25a09400d91bbc45cf5f20152965c5b309a [file] [log] [blame]
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -03001=====================
2The Linux IPMI Driver
3=====================
Linus Torvalds1da177e2005-04-16 15:20:36 -07004
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -03005:Author: Corey Minyard <minyard@mvista.com> / <minyard@acm.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
7The Intelligent Platform Management Interface, or IPMI, is a
8standard for controlling intelligent devices that monitor a system.
9It provides for dynamic discovery of sensors in the system and the
10ability to monitor the sensors and be informed when the sensor's
11values change or go outside certain boundaries. It also has a
Matt LaPlantedc474c82006-06-30 01:56:06 -070012standardized database for field-replaceable units (FRUs) and a watchdog
Linus Torvalds1da177e2005-04-16 15:20:36 -070013timer.
14
15To use this, you need an interface to an IPMI controller in your
16system (called a Baseboard Management Controller, or BMC) and
17management software that can use the IPMI system.
18
19This document describes how to use the IPMI driver for Linux. If you
20are not familiar with IPMI itself, see the web site at
21http://www.intel.com/design/servers/ipmi/index.htm. IPMI is a big
22subject and I can't cover it all here!
23
24Configuration
25-------------
26
Corey Minyard845e78a2005-06-23 22:01:39 -070027The Linux IPMI driver is modular, which means you have to pick several
Linus Torvalds1da177e2005-04-16 15:20:36 -070028things to have it work right depending on your hardware. Most of
Corey Minyard845e78a2005-06-23 22:01:39 -070029these are available in the 'Character Devices' menu then the IPMI
30menu.
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32No matter what, you must pick 'IPMI top-level message handler' to use
33IPMI. What you do beyond that depends on your needs and hardware.
34
35The message handler does not provide any user-level interfaces.
36Kernel code (like the watchdog) can still use it. If you need access
37from userland, you need to select 'Device interface for IPMI' if you
Corey Minyard845e78a2005-06-23 22:01:39 -070038want access through a device driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Corey Minyard845e78a2005-06-23 22:01:39 -070040The driver interface depends on your hardware. If your system
41properly provides the SMBIOS info for IPMI, the driver will detect it
42and just work. If you have a board with a standard interface (These
43will generally be either "KCS", "SMIC", or "BT", consult your hardware
Corey Minyard25930702012-03-19 16:00:55 -050044manual), choose the 'IPMI SI handler' option. A driver also exists
45for direct I2C access to the IPMI management controller. Some boards
46support this, but it is unknown if it will work on every board. For
47this, choose 'IPMI SMBus handler', but be ready to try to do some
48figuring to see if it will work on your system if the SMBIOS/APCI
49information is wrong or not present. It is fairly safe to have both
50these enabled and let the drivers auto-detect what is present.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52You should generally enable ACPI on your system, as systems with IPMI
Corey Minyard845e78a2005-06-23 22:01:39 -070053can have ACPI tables describing them.
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55If you have a standard interface and the board manufacturer has done
56their job correctly, the IPMI controller should be automatically
Corey Minyard845e78a2005-06-23 22:01:39 -070057detected (via ACPI or SMBIOS tables) and should just work. Sadly,
58many boards do not have this information. The driver attempts
59standard defaults, but they may not work. If you fall into this
Corey Minyard25930702012-03-19 16:00:55 -050060situation, you need to read the section below named 'The SI Driver' or
61"The SMBus Driver" on how to hand-configure your system.
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63IPMI defines a standard watchdog timer. You can enable this with the
64'IPMI Watchdog Timer' config option. If you compile the driver into
65the kernel, then via a kernel command-line option you can have the
Matt LaPlantedc474c82006-06-30 01:56:06 -070066watchdog timer start as soon as it initializes. It also have a lot
Linus Torvalds1da177e2005-04-16 15:20:36 -070067of other options, see the 'Watchdog' section below for more details.
68Note that you can also have the watchdog continue to run if it is
69closed (by default it is disabled on close). Go into the 'Watchdog
70Cards' menu, enable 'Watchdog Timer Support', and enable the option
71'Disable watchdog shutdown on close'.
72
Corey Minyard845e78a2005-06-23 22:01:39 -070073IPMI systems can often be powered off using IPMI commands. Select
74'IPMI Poweroff' to do this. The driver will auto-detect if the system
75can be powered off by IPMI. It is safe to enable this even if your
76system doesn't support this option. This works on ATCA systems, the
77Radisys CPI1 card, and any IPMI system that supports standard chassis
78management commands.
79
80If you want the driver to put an event into the event log on a panic,
81enable the 'Generate a panic event to all BMCs on a panic' option. If
82you want the whole panic string put into the event log using OEM
83events, enable the 'Generate OEM events containing the panic string'
84option.
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86Basic Design
87------------
88
89The Linux IPMI driver is designed to be very modular and flexible, you
90only need to take the pieces you need and you can use it in many
91different ways. Because of that, it's broken into many chunks of
Corey Minyard845e78a2005-06-23 22:01:39 -070092code. These chunks (by module name) are:
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
94ipmi_msghandler - This is the central piece of software for the IPMI
95system. It handles all messages, message timing, and responses. The
96IPMI users tie into this, and the IPMI physical interfaces (called
97System Management Interfaces, or SMIs) also tie in here. This
98provides the kernelland interface for IPMI, but does not provide an
99interface for use by application processes.
100
101ipmi_devintf - This provides a userland IOCTL interface for the IPMI
102driver, each open file for this device ties in to the message handler
103as an IPMI user.
104
Corey Minyard845e78a2005-06-23 22:01:39 -0700105ipmi_si - A driver for various system interfaces. This supports KCS,
Corey Minyard25930702012-03-19 16:00:55 -0500106SMIC, and BT interfaces. Unless you have an SMBus interface or your
107own custom interface, you probably need to use this.
108
109ipmi_ssif - A driver for accessing BMCs on the SMBus. It uses the
110I2C kernel driver's SMBus interfaces to send and receive IPMI messages
111over the SMBus.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
Corey Minyardc11daf62016-10-25 20:31:53 -0500113ipmi_powernv - A driver for access BMCs on POWERNV systems.
114
Corey Minyard845e78a2005-06-23 22:01:39 -0700115ipmi_watchdog - IPMI requires systems to have a very capable watchdog
116timer. This driver implements the standard Linux watchdog timer
117interface on top of the IPMI message handler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Corey Minyard845e78a2005-06-23 22:01:39 -0700119ipmi_poweroff - Some systems support the ability to be turned off via
120IPMI commands.
121
Corey Minyardc11daf62016-10-25 20:31:53 -0500122bt-bmc - This is not part of the main driver, but instead a driver for
123accessing a BMC-side interface of a BT interface. It is used on BMCs
124running Linux to provide an interface to the host.
Corey Minyard845e78a2005-06-23 22:01:39 -0700125
Corey Minyardc11daf62016-10-25 20:31:53 -0500126These are all individually selectable via configuration options.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128Much documentation for the interface is in the include files. The
129IPMI include files are:
130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131linux/ipmi.h - Contains the user interface and IOCTL interface for IPMI.
132
133linux/ipmi_smi.h - Contains the interface for system management interfaces
134(things that interface to IPMI controllers) to use.
135
136linux/ipmi_msgdefs.h - General definitions for base IPMI messaging.
137
138
139Addressing
140----------
141
142The IPMI addressing works much like IP addresses, you have an overlay
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300143to handle the different address types. The overlay is::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145 struct ipmi_addr
146 {
147 int addr_type;
148 short channel;
149 char data[IPMI_MAX_ADDR_SIZE];
150 };
151
152The addr_type determines what the address really is. The driver
153currently understands two different types of addresses.
154
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300155"System Interface" addresses are defined as::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157 struct ipmi_system_interface_addr
158 {
159 int addr_type;
160 short channel;
161 };
162
163and the type is IPMI_SYSTEM_INTERFACE_ADDR_TYPE. This is used for talking
164straight to the BMC on the current card. The channel must be
165IPMI_BMC_CHANNEL.
166
167Messages that are destined to go out on the IPMB bus use the
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300168IPMI_IPMB_ADDR_TYPE address type. The format is::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170 struct ipmi_ipmb_addr
171 {
172 int addr_type;
173 short channel;
174 unsigned char slave_addr;
175 unsigned char lun;
176 };
177
178The "channel" here is generally zero, but some devices support more
179than one channel, it corresponds to the channel as defined in the IPMI
180spec.
181
182
183Messages
184--------
185
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300186Messages are defined as::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300188 struct ipmi_msg
189 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 unsigned char netfn;
191 unsigned char lun;
192 unsigned char cmd;
193 unsigned char *data;
194 int data_len;
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300195 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
197The driver takes care of adding/stripping the header information. The
198data portion is just the data to be send (do NOT put addressing info
199here) or the response. Note that the completion code of a response is
200the first item in "data", it is not stripped out because that is how
201all the messages are defined in the spec (and thus makes counting the
202offsets a little easier :-).
203
204When using the IOCTL interface from userland, you must provide a block
205of data for "data", fill it, and set data_len to the length of the
206block of data, even when receiving messages. Otherwise the driver
207will have no place to put the message.
208
209Messages coming up from the message handler in kernelland will come in
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300210as::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212 struct ipmi_recv_msg
213 {
214 struct list_head link;
215
216 /* The type of message as defined in the "Receive Types"
217 defines above. */
218 int recv_type;
219
220 ipmi_user_t *user;
221 struct ipmi_addr addr;
222 long msgid;
223 struct ipmi_msg msg;
224
225 /* Call this when done with the message. It will presumably free
226 the message and do any other necessary cleanup. */
227 void (*done)(struct ipmi_recv_msg *msg);
228
229 /* Place-holder for the data, don't make any assumptions about
230 the size or existence of this, since it may change. */
231 unsigned char msg_data[IPMI_MAX_MSG_LENGTH];
232 };
233
234You should look at the receive type and handle the message
235appropriately.
236
237
238The Upper Layer Interface (Message Handler)
239-------------------------------------------
240
241The upper layer of the interface provides the users with a consistent
242view of the IPMI interfaces. It allows multiple SMI interfaces to be
243addressed (because some boards actually have multiple BMCs on them)
244and the user should not have to care what type of SMI is below them.
245
246
Corey Minyardc11daf62016-10-25 20:31:53 -0500247Watching For Interfaces
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300248^^^^^^^^^^^^^^^^^^^^^^^
Corey Minyardc11daf62016-10-25 20:31:53 -0500249
250When your code comes up, the IPMI driver may or may not have detected
251if IPMI devices exist. So you might have to defer your setup until
252the device is detected, or you might be able to do it immediately.
253To handle this, and to allow for discovery, you register an SMI
254watcher with ipmi_smi_watcher_register() to iterate over interfaces
255and tell you when they come and go.
256
257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258Creating the User
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300259^^^^^^^^^^^^^^^^^
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
Rami Rosen08f6cd02016-12-18 21:11:54 +0200261To use the message handler, you must first create a user using
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262ipmi_create_user. The interface number specifies which SMI you want
263to connect to, and you must supply callback functions to be called
264when data comes in. The callback function can run at interrupt level,
265so be careful using the callbacks. This also allows to you pass in a
266piece of data, the handler_data, that will be passed back to you on
267all calls.
268
269Once you are done, call ipmi_destroy_user() to get rid of the user.
270
271From userland, opening the device automatically creates a user, and
272closing the device automatically destroys the user.
273
274
275Messaging
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300276^^^^^^^^^
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Corey Minyardc11daf62016-10-25 20:31:53 -0500278To send a message from kernel-land, the ipmi_request_settime() call does
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279pretty much all message handling. Most of the parameter are
280self-explanatory. However, it takes a "msgid" parameter. This is NOT
281the sequence number of messages. It is simply a long value that is
282passed back when the response for the message is returned. You may
283use it for anything you like.
284
285Responses come back in the function pointed to by the ipmi_recv_hndl
286field of the "handler" that you passed in to ipmi_create_user().
287Remember again, these may be running at interrupt level. Remember to
288look at the receive type, too.
289
290From userland, you fill out an ipmi_req_t structure and use the
291IPMICTL_SEND_COMMAND ioctl. For incoming stuff, you can use select()
292or poll() to wait for messages to come in. However, you cannot use
293read() to get them, you must call the IPMICTL_RECEIVE_MSG with the
294ipmi_recv_t structure to actually get the message. Remember that you
295must supply a pointer to a block of data in the msg.data field, and
296you must fill in the msg.data_len field with the size of the data.
297This gives the receiver a place to actually put the message.
298
299If the message cannot fit into the data you provide, you will get an
300EMSGSIZE error and the driver will leave the data in the receive
301queue. If you want to get it and have it truncate the message, us
302the IPMICTL_RECEIVE_MSG_TRUNC ioctl.
303
304When you send a command (which is defined by the lowest-order bit of
305the netfn per the IPMI spec) on the IPMB bus, the driver will
306automatically assign the sequence number to the command and save the
307command. If the response is not receive in the IPMI-specified 5
308seconds, it will generate a response automatically saying the command
309timed out. If an unsolicited response comes in (if it was after 5
310seconds, for instance), that response will be ignored.
311
312In kernelland, after you receive a message and are done with it, you
313MUST call ipmi_free_recv_msg() on it, or you will leak messages. Note
314that you should NEVER mess with the "done" field of a message, that is
315required to properly clean up the message.
316
317Note that when sending, there is an ipmi_request_supply_msgs() call
318that lets you supply the smi and receive message. This is useful for
319pieces of code that need to work even if the system is out of buffers
320(the watchdog timer uses this, for instance). You supply your own
321buffer and own free routines. This is not recommended for normal use,
322though, since it is tricky to manage your own buffers.
323
324
325Events and Incoming Commands
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300326^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328The driver takes care of polling for IPMI events and receiving
329commands (commands are messages that are not responses, they are
330commands that other things on the IPMB bus have sent you). To receive
331these, you must register for them, they will not automatically be sent
332to you.
333
334To receive events, you must call ipmi_set_gets_events() and set the
335"val" to non-zero. Any events that have been received by the driver
336since startup will immediately be delivered to the first user that
337registers for events. After that, if multiple users are registered
338for events, they will all receive all events that come in.
339
340For receiving commands, you have to individually register commands you
341want to receive. Call ipmi_register_for_cmd() and supply the netfn
Corey Minyardc69c3122006-09-30 23:27:56 -0700342and command name for each command you want to receive. You also
343specify a bitmask of the channels you want to receive the command from
344(or use IPMI_CHAN_ALL for all channels if you don't care). Only one
345user may be registered for each netfn/cmd/channel, but different users
346may register for different commands, or the same command if the
347channel bitmasks do not overlap.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349From userland, equivalent IOCTLs are provided to do these functions.
350
351
352The Lower Layer (SMI) Interface
353-------------------------------
354
355As mentioned before, multiple SMI interfaces may be registered to the
356message handler, each of these is assigned an interface number when
357they register with the message handler. They are generally assigned
358in the order they register, although if an SMI unregisters and then
359another one registers, all bets are off.
360
361The ipmi_smi.h defines the interface for management interfaces, see
362that for more details.
363
364
365The SI Driver
366-------------
367
Corey Minyardc11daf62016-10-25 20:31:53 -0500368The SI driver allows KCS, BT, and SMIC interfaces to be configured
369in the system. It discovers interfaces through a host of different
370methods, depending on the system.
371
372You can specify up to four interfaces on the module load line and
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300373control some module parameters::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375 modprobe ipmi_si.o type=<type1>,<type2>....
376 ports=<port1>,<port2>... addrs=<addr1>,<addr2>...
Corey Minyardf2afae42013-02-27 17:05:13 -0800377 irqs=<irq1>,<irq2>...
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 regspacings=<sp1>,<sp2>,... regsizes=<size1>,<size2>,...
379 regshifts=<shift1>,<shift2>,...
380 slave_addrs=<addr1>,<addr2>,...
Corey Minyarda51f4a82006-10-03 01:13:59 -0700381 force_kipmid=<enable1>,<enable2>,...
Martin Wilckae74e822010-03-10 15:23:06 -0800382 kipmid_max_busy_us=<ustime1>,<ustime2>,...
Corey Minyardb361e272006-12-06 20:41:07 -0800383 unload_when_empty=[0|1]
Corey Minyardc11daf62016-10-25 20:31:53 -0500384 trydmi=[0|1] tryacpi=[0|1]
Corey Minyardf2afae42013-02-27 17:05:13 -0800385 tryplatform=[0|1] trypci=[0|1]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Corey Minyardf2afae42013-02-27 17:05:13 -0800387Each of these except try... items is a list, the first item for the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388first interface, second item for the second interface, etc.
389
390The si_type may be either "kcs", "smic", or "bt". If you leave it blank, it
391defaults to "kcs".
392
Corey Minyardf2afae42013-02-27 17:05:13 -0800393If you specify addrs as non-zero for an interface, the driver will
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394use the memory address given as the address of the device. This
395overrides si_ports.
396
Corey Minyardf2afae42013-02-27 17:05:13 -0800397If you specify ports as non-zero for an interface, the driver will
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398use the I/O port given as the device address.
399
Corey Minyardf2afae42013-02-27 17:05:13 -0800400If you specify irqs as non-zero for an interface, the driver will
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401attempt to use the given interrupt for the device.
402
Corey Minyardf2afae42013-02-27 17:05:13 -0800403The other try... items disable discovery by their corresponding
404names. These are all enabled by default, set them to zero to disable
405them. The tryplatform disables openfirmware.
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407The next three parameters have to do with register layout. The
408registers used by the interfaces may not appear at successive
409locations and they may not be in 8-bit registers. These parameters
410allow the layout of the data in the registers to be more precisely
411specified.
412
413The regspacings parameter give the number of bytes between successive
414register start addresses. For instance, if the regspacing is set to 4
415and the start address is 0xca2, then the address for the second
416register would be 0xca6. This defaults to 1.
417
418The regsizes parameter gives the size of a register, in bytes. The
419data used by IPMI is 8-bits wide, but it may be inside a larger
420register. This parameter allows the read and write type to specified.
421It may be 1, 2, 4, or 8. The default is 1.
422
423Since the register size may be larger than 32 bits, the IPMI data may not
424be in the lower 8 bits. The regshifts parameter give the amount to shift
425the data to get to the actual IPMI data.
426
427The slave_addrs specifies the IPMI address of the local BMC. This is
428usually 0x20 and the driver defaults to that, but in case it's not, it
429can be specified when the driver starts up.
430
Corey Minyarda51f4a82006-10-03 01:13:59 -0700431The force_ipmid parameter forcefully enables (if set to 1) or disables
432(if set to 0) the kernel IPMI daemon. Normally this is auto-detected
433by the driver, but systems with broken interrupts might need an enable,
434or users that don't want the daemon (don't need the performance, don't
435want the CPU hit) can disable it.
436
Corey Minyardb361e272006-12-06 20:41:07 -0800437If unload_when_empty is set to 1, the driver will be unloaded if it
438doesn't find any interfaces or all the interfaces fail to work. The
439default is one. Setting to 0 is useful with the hotmod, but is
440obviously only useful for modules.
441
Corey Minyarda51f4a82006-10-03 01:13:59 -0700442When compiled into the kernel, the parameters can be specified on the
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300443kernel command line as::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
445 ipmi_si.type=<type1>,<type2>...
446 ipmi_si.ports=<port1>,<port2>... ipmi_si.addrs=<addr1>,<addr2>...
Corey Minyardc11daf62016-10-25 20:31:53 -0500447 ipmi_si.irqs=<irq1>,<irq2>...
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 ipmi_si.regspacings=<sp1>,<sp2>,...
449 ipmi_si.regsizes=<size1>,<size2>,...
450 ipmi_si.regshifts=<shift1>,<shift2>,...
451 ipmi_si.slave_addrs=<addr1>,<addr2>,...
Corey Minyarda51f4a82006-10-03 01:13:59 -0700452 ipmi_si.force_kipmid=<enable1>,<enable2>,...
Martin Wilckae74e822010-03-10 15:23:06 -0800453 ipmi_si.kipmid_max_busy_us=<ustime1>,<ustime2>,...
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
455It works the same as the module parameters of the same names.
456
Corey Minyard650dd0c2007-10-18 03:07:09 -0700457If your IPMI interface does not support interrupts and is a KCS or
458SMIC interface, the IPMI driver will start a kernel thread for the
459interface to help speed things up. This is a low-priority kernel
460thread that constantly polls the IPMI driver while an IPMI operation
461is in progress. The force_kipmid module parameter will all the user to
462force this thread on or off. If you force it off and don't have
463interrupts, the driver will run VERY slowly. Don't blame me,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464these interfaces suck.
465
Martin Wilckae74e822010-03-10 15:23:06 -0800466Unfortunately, this thread can use a lot of CPU depending on the
467interface's performance. This can waste a lot of CPU and cause
468various issues with detecting idle CPU and using extra power. To
469avoid this, the kipmid_max_busy_us sets the maximum amount of time, in
470microseconds, that kipmid will spin before sleeping for a tick. This
471value sets a balance between performance and CPU waste and needs to be
472tuned to your needs. Maybe, someday, auto-tuning will be added, but
473that's not a simple thing and even the auto-tuning would need to be
474tuned to the user's desired performance.
475
Corey Minyardb361e272006-12-06 20:41:07 -0800476The driver supports a hot add and remove of interfaces. This way,
477interfaces can be added or removed after the kernel is up and running.
Corey Minyard650dd0c2007-10-18 03:07:09 -0700478This is done using /sys/modules/ipmi_si/parameters/hotmod, which is a
479write-only parameter. You write a string to this interface. The string
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300480has the format::
481
Corey Minyardb361e272006-12-06 20:41:07 -0800482 <op1>[:op2[:op3...]]
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300483
484The "op"s are::
485
Corey Minyardb361e272006-12-06 20:41:07 -0800486 add|remove,kcs|bt|smic,mem|i/o,<address>[,<opt1>[,<opt2>[,...]]]
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300487
488You can specify more than one interface on the line. The "opt"s are::
489
Corey Minyardb361e272006-12-06 20:41:07 -0800490 rsp=<regspacing>
491 rsi=<regsize>
492 rsh=<regshift>
493 irq=<irq>
494 ipmb=<ipmb slave addr>
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300495
Corey Minyardb361e272006-12-06 20:41:07 -0800496and these have the same meanings as discussed above. Note that you
497can also use this on the kernel command line for a more compact format
498for specifying an interface. Note that when removing an interface,
499only the first three parameters (si type, address type, and address)
500are used for the comparison. Any options are ignored for removing.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
Corey Minyard25930702012-03-19 16:00:55 -0500502The SMBus Driver (SSIF)
503-----------------------
504
505The SMBus driver allows up to 4 SMBus devices to be configured in the
506system. By default, the driver will only register with something it
507finds in DMI or ACPI tables. You can change this
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300508at module load time (for a module) with::
Corey Minyard25930702012-03-19 16:00:55 -0500509
510 modprobe ipmi_ssif.o
511 addr=<i2caddr1>[,<i2caddr2>[,...]]
512 adapter=<adapter1>[,<adapter2>[...]]
513 dbg=<flags1>,<flags2>...
Corey Minyardc11daf62016-10-25 20:31:53 -0500514 slave_addrs=<addr1>,<addr2>,...
515 tryacpi=[0|1] trydmi=[0|1]
Corey Minyard25930702012-03-19 16:00:55 -0500516 [dbg_probe=1]
517
518The addresses are normal I2C addresses. The adapter is the string
519name of the adapter, as shown in /sys/class/i2c-adapter/i2c-<n>/name.
Corey Minyardb0e9aaa2015-03-31 12:48:53 -0500520It is *NOT* i2c-<n> itself. Also, the comparison is done ignoring
521spaces, so if the name is "This is an I2C chip" you can say
522adapter_name=ThisisanI2cchip. This is because it's hard to pass in
523spaces in kernel parameters.
Corey Minyard25930702012-03-19 16:00:55 -0500524
525The debug flags are bit flags for each BMC found, they are:
526IPMI messages: 1, driver state: 2, timing: 4, I2C probe: 8
527
Corey Minyardc11daf62016-10-25 20:31:53 -0500528The tryxxx parameters can be used to disable detecting interfaces
529from various sources.
530
Corey Minyard25930702012-03-19 16:00:55 -0500531Setting dbg_probe to 1 will enable debugging of the probing and
532detection process for BMCs on the SMBusses.
533
534The slave_addrs specifies the IPMI address of the local BMC. This is
535usually 0x20 and the driver defaults to that, but in case it's not, it
536can be specified when the driver starts up.
537
538Discovering the IPMI compliant BMC on the SMBus can cause devices on
539the I2C bus to fail. The SMBus driver writes a "Get Device ID" IPMI
540message as a block write to the I2C bus and waits for a response.
541This action can be detrimental to some I2C devices. It is highly
542recommended that the known I2C address be given to the SMBus driver in
543the smb_addr parameter unless you have DMI or ACPI data to tell the
544driver what to use.
545
546When compiled into the kernel, the addresses can be specified on the
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300547kernel command line as::
Corey Minyard25930702012-03-19 16:00:55 -0500548
549 ipmb_ssif.addr=<i2caddr1>[,<i2caddr2>[...]]
550 ipmi_ssif.adapter=<adapter1>[,<adapter2>[...]]
551 ipmi_ssif.dbg=<flags1>[,<flags2>[...]]
552 ipmi_ssif.dbg_probe=1
Corey Minyardc11daf62016-10-25 20:31:53 -0500553 ipmi_ssif.slave_addrs=<addr1>[,<addr2>[...]]
554 ipmi_ssif.tryacpi=[0|1] ipmi_ssif.trydmi=[0|1]
Corey Minyard25930702012-03-19 16:00:55 -0500555
556These are the same options as on the module command line.
557
558The I2C driver does not support non-blocking access or polling, so
559this driver cannod to IPMI panic events, extend the watchdog at panic
560time, or other panic-related IPMI functions without special kernel
561patches and driver modifications. You can get those at the openipmi
562web page.
563
564The driver supports a hot add and remove of interfaces through the I2C
565sysfs interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
567Other Pieces
568------------
569
Zhao Yakui37bf5012010-12-08 10:10:17 +0800570Get the detailed info related with the IPMI device
571--------------------------------------------------
572
573Some users need more detailed information about a device, like where
574the address came from or the raw base device for the IPMI interface.
575You can use the IPMI smi_watcher to catch the IPMI interfaces as they
576come or go, and to grab the information, you can use the function
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300577ipmi_get_smi_info(), which returns the following structure::
Zhao Yakui37bf5012010-12-08 10:10:17 +0800578
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300579 struct ipmi_smi_info {
Zhao Yakui37bf5012010-12-08 10:10:17 +0800580 enum ipmi_addr_src addr_src;
581 struct device *dev;
582 union {
583 struct {
584 void *acpi_handle;
585 } acpi_info;
586 } addr_info;
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300587 };
Zhao Yakui37bf5012010-12-08 10:10:17 +0800588
589Currently special info for only for SI_ACPI address sources is
590returned. Others may be added as necessary.
591
592Note that the dev pointer is included in the above structure, and
593assuming ipmi_smi_get_info returns success, you must call put_device
594on the dev pointer.
595
596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597Watchdog
598--------
599
600A watchdog timer is provided that implements the Linux-standard
601watchdog timer interface. It has three module parameters that can be
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300602used to control it::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
604 modprobe ipmi_watchdog timeout=<t> pretimeout=<t> action=<action type>
605 preaction=<preaction type> preop=<preop type> start_now=x
Jean-Yves Fayec7f42c62015-09-29 11:39:19 +0200606 nowayout=x ifnum_to_use=n panic_wdt_timeout=<t>
Corey Minyardb2c03942006-12-06 20:41:00 -0800607
608ifnum_to_use specifies which interface the watchdog timer should use.
609The default is -1, which means to pick the first one registered.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
611The timeout is the number of seconds to the action, and the pretimeout
612is the amount of seconds before the reset that the pre-timeout panic will
613occur (if pretimeout is zero, then pretimeout will not be enabled). Note
614that the pretimeout is the time before the final timeout. So if the
615timeout is 50 seconds and the pretimeout is 10 seconds, then the pretimeout
Jean-Yves Fayec7f42c62015-09-29 11:39:19 +0200616will occur in 40 second (10 seconds before the timeout). The panic_wdt_timeout
617is the value of timeout which is set on kernel panic, in order to let actions
618such as kdump to occur during panic.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620The action may be "reset", "power_cycle", or "power_off", and
621specifies what to do when the timer times out, and defaults to
622"reset".
623
624The preaction may be "pre_smi" for an indication through the SMI
625interface, "pre_int" for an indication through the SMI with an
626interrupts, and "pre_nmi" for a NMI on a preaction. This is how
627the driver is informed of the pretimeout.
628
629The preop may be set to "preop_none" for no operation on a pretimeout,
630"preop_panic" to set the preoperation to panic, or "preop_give_data"
631to provide data to read from the watchdog device when the pretimeout
632occurs. A "pre_nmi" setting CANNOT be used with "preop_give_data"
633because you can't do data operations from an NMI.
634
635When preop is set to "preop_give_data", one byte comes ready to read
636on the device when the pretimeout occurs. Select and fasync work on
637the device, as well.
638
639If start_now is set to 1, the watchdog timer will start running as
640soon as the driver is loaded.
641
642If nowayout is set to 1, the watchdog timer will not stop when the
643watchdog device is closed. The default value of nowayout is true
644if the CONFIG_WATCHDOG_NOWAYOUT option is enabled, or false if not.
645
646When compiled into the kernel, the kernel command line is available
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300647for configuring the watchdog::
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
649 ipmi_watchdog.timeout=<t> ipmi_watchdog.pretimeout=<t>
650 ipmi_watchdog.action=<action type>
651 ipmi_watchdog.preaction=<preaction type>
652 ipmi_watchdog.preop=<preop type>
653 ipmi_watchdog.start_now=x
654 ipmi_watchdog.nowayout=x
Jean-Yves Fayec7f42c62015-09-29 11:39:19 +0200655 ipmi_watchdog.panic_wdt_timeout=<t>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
657The options are the same as the module parameter options.
658
659The watchdog will panic and start a 120 second reset timeout if it
660gets a pre-action. During a panic or a reboot, the watchdog will
661start a 120 timer if it is running to make sure the reboot occurs.
662
Corey Minyard612b5a82007-10-18 03:07:10 -0700663Note that if you use the NMI preaction for the watchdog, you MUST NOT
664use the nmi watchdog. There is no reasonable way to tell if an NMI
665comes from the IPMI controller, so it must assume that if it gets an
666otherwise unhandled NMI, it must be from IPMI and it will panic
667immediately.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
669Once you open the watchdog timer, you must write a 'V' character to the
670device to close it, or the timer will not stop. This is a new semantic
671for the driver, but makes it consistent with the rest of the watchdog
672drivers in Linux.
Corey Minyard845e78a2005-06-23 22:01:39 -0700673
674
675Panic Timeouts
676--------------
677
678The OpenIPMI driver supports the ability to put semi-custom and custom
679events in the system event log if a panic occurs. if you enable the
680'Generate a panic event to all BMCs on a panic' option, you will get
681one event on a panic in a standard IPMI event format. If you enable
682the 'Generate OEM events containing the panic string' option, you will
683also get a bunch of OEM events holding the panic string.
684
685
686The field settings of the events are:
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300687
Corey Minyard845e78a2005-06-23 22:01:39 -0700688* Generator ID: 0x21 (kernel)
689* EvM Rev: 0x03 (this event is formatting in IPMI 1.0 format)
690* Sensor Type: 0x20 (OS critical stop sensor)
691* Sensor #: The first byte of the panic string (0 if no panic string)
692* Event Dir | Event Type: 0x6f (Assertion, sensor-specific event info)
693* Event Data 1: 0xa1 (Runtime stop in OEM bytes 2 and 3)
694* Event data 2: second byte of panic string
695* Event data 3: third byte of panic string
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300696
Corey Minyard845e78a2005-06-23 22:01:39 -0700697See the IPMI spec for the details of the event layout. This event is
698always sent to the local management controller. It will handle routing
699the message to the right place
700
701Other OEM events have the following format:
Mauro Carvalho Chehabf5981a52017-05-14 15:18:08 -0300702
703* Record ID (bytes 0-1): Set by the SEL.
704* Record type (byte 2): 0xf0 (OEM non-timestamped)
705* byte 3: The slave address of the card saving the panic
706* byte 4: A sequence number (starting at zero)
707 The rest of the bytes (11 bytes) are the panic string. If the panic string
708 is longer than 11 bytes, multiple messages will be sent with increasing
709 sequence numbers.
Corey Minyard845e78a2005-06-23 22:01:39 -0700710
711Because you cannot send OEM events using the standard interface, this
712function will attempt to find an SEL and add the events there. It
713will first query the capabilities of the local management controller.
714If it has an SEL, then they will be stored in the SEL of the local
715management controller. If not, and the local management controller is
716an event generator, the event receiver from the local management
717controller will be queried and the events sent to the SEL on that
718device. Otherwise, the events go nowhere since there is nowhere to
719send them.
Corey Minyard3b625942005-06-23 22:01:42 -0700720
721
722Poweroff
723--------
724
725If the poweroff capability is selected, the IPMI driver will install
726a shutdown function into the standard poweroff function pointer. This
727is in the ipmi_poweroff module. When the system requests a powerdown,
728it will send the proper IPMI commands to do this. This is supported on
729several platforms.
730
Corey Minyard8c702e12005-09-06 15:18:46 -0700731There is a module parameter named "poweroff_powercycle" that may
732either be zero (do a power down) or non-zero (do a power cycle, power
733the system off, then power it on in a few seconds). Setting
734ipmi_poweroff.poweroff_control=x will do the same thing on the kernel
735command line. The parameter is also available via the proc filesystem
736in /proc/sys/dev/ipmi/poweroff_powercycle. Note that if the system
737does not support power cycling, it will always do the power off.
Corey Minyard3b625942005-06-23 22:01:42 -0700738
Corey Minyardb2c03942006-12-06 20:41:00 -0800739The "ifnum_to_use" parameter specifies which interface the poweroff
740code should use. The default is -1, which means to pick the first one
741registered.
742
Corey Minyard3b625942005-06-23 22:01:42 -0700743Note that if you have ACPI enabled, the system will prefer using ACPI to
744power off.