
                          The Linux IPMI Driver
			  ---------------------
			      Corey Minyard
			  <minyard@mvista.com>
			    <minyard@acm.org>

The 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-replacable units (FRUs) and a watchdog
timer.

Intelligent Platform Management Interface (IPMI) ϥƥƻ뤹
٤ʥǥХΰ٤ɸǤϥƥΥ󥵡ưŪ
ȥ󥵡Υ˥󥰵ǽ󶡤󥵡ͤѲ䤢붭
ͤۤΤޤޤIPMI ϸִǽ˥å(FRU) 
åɥåޤ˴ؤɸಽ줿ǡ١ޤ

(åɥåޡĥƥΥϥ󥰥åפΤ٤Υǥ
)

To 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.

IPMI Ѥ٤ˤϡƥ IPMI ȥ (Baseboard
Management Controller ޤ BMC ȸޤ) ؤΥ󥿡եȡ
IPMI ƥѤǤեȥɬפǤ

This document describes how to use the IPMI driver for Linux.  If you
are not familiar with IPMI itself, see the web site at
http://www.intel.com/design/servers/ipmi/index.htm.  IPMI is a big
subject and I can't cover it all here.

ΥɥȤ Linux  IPMI ɥ饤ФѤˡޤ
⤷ʤ IPMI Τ褯Τʤϡ
http://www.intel.com/design/servers/ipmi/index.htm  Web Ȥ򻲾
ƤIPMI 礭ʥơޤǤꡢƤ򥫥СϽ
ޤ


Configuration

-------------

The LinuxIPMI 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.

LinuxIPMI ɥ饤Фϥ⥸塼벽(ʬ)ƤޤϡIPMI ɥ
Фǽ٤ˡϡɥ˹碌ƴĤΥ⥸塼
ФʤȤʤ̣ޤʪϤۤȤɡ'Character
Devices' ˥塼ǽǤ

No matter what, you must pick 'IPMI top-level message handler' to use
IPMI.  What you do beyond that depends on your needs and hardware.

ȤꤢIPMI Ѥ뤿 'IPMI top-level message handler' 
򤷤ʤФʤޤ󡣤θ򤹤ΤϤʤΥˡȥϡ
˰¸ޤ

The 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.  Another interface is also
available, you may select 'IPMI sockets' in the 'Networking Support'
main menu.  This provides a socket interface to IPMI.  You may select
both of these at the same time, they will both work together.

åϥɥϥ桼٥Υ󥿡ե󶡤ޤ
Ǥ⡢åɥåΤ褦ʥͥ⥳ɤϤѤǤޤ
桼ɤΥɬפʾ硢ǥХɥ饤зͳǥ
ΤǤС'Device interface for IPMI' 򤹤ɬפޤ
¾Υ󥿡եѤǤޤ'IPMI sockets' in the 'Networking
Support' ᥤ˥塼򤷤Ʋ IPMI Ф륽å
󥿡ե󶡤ޤξƱ򤹤ޤƱ
ξȤⵡǽޤ

(桼ɡᥫͥˤäݸ줿ץ¹Ԥ
ؤޤ˥ͥɤꡢͥ뼫Τ¹Ԥ
ؤޤƱˤ줾졢桼ڡ桼⡼ɡ
ͥ륹ڡ䥫ͥ⡼ɤޤ)

The driver interface depends on your hardware.  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.

ɥ饤Х󥿡եϥϡɥ˰¸ޤɸ।󥿡ե
 (ϰ̤ˡKCS, SMIC, BT Τ줫ǤϡɥΥޥ˥
򻲾ȤƲ) դΥܡɤϡ'IPMI SI handler' 
򤷤ƲIPMI ȥؤ I2C ľܥΰ
Υɥ饤Ф¸ߤޤĤΥܡɤϤ򥵥ݡȤޤƤ
ܡɤǤΥɥ饤Фǽ뤫ɤʬޤ󡣤ˤϡ'
IPMISMBus handler' 򤷤ޤΥɥ饤ФưɤĴ
٤٤ˤϡȻƤߤи򤷤Ʋ

There is also a KCS-only driver interface supplied, but it is
depracated in favor of the SI interface.

KCS ΤߤΥɥ饤Х󥿡ե󶡤ƤޤSI 󥿡ե
뤿侩ޤ

You should generally enable ACPI on your system, as systems with IPMI
should have ACPI tables describing them.

̤ˡIPMI եƥ IPMI 򵭽Ҥ ACPI ơ֥äƤȦ
ʤΤǡƥ ACPI ͭˤ٤Ǥ

If you have a standard interface and the board manufacturer has done
their job correctly, the IPMI controller should be automatically
detect (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' on how to
hand-configure your system.

ɸ।󥿡եꡢܡ¤ԤȤŻ򤷤ΤǤ
СACPI ޤ SMBIOS ơ֥𤷤 IPMI ȥϼưŪ
Τ졢ȵǽϤǤᤷȤˡ¿Υܡɤξ
äƤޤ󡣤Υɥ饤Фɸͤߤޤưʤ⤷
ޤ󡣤ξ֤˴٤ä硢ƥưꤹˡˤĤơ
ΡSI ɥ饤СפξϤɤɬפޤ

IPMI 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 intitializes.  It also have 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'.

IPMI ɸ०åɥåޤޤ'IPMI åɥå
' ꥪץǤεǽͭˤǤޤΥɥ饤Ф򥫡ͥ
Ȥ߹硢ͥ륳ޥɥ饤󥪥ץͳǡɥ饤Ф
켡襦åɥåޤͭˤǤޤ¾ˤ¿Υ
ץ󤬤ޤܺ٤ϲΡ֥åɥåפξϤ򻲾ȤƲ
åɥåޤ close 줿ͭˤǤդ
Ƥ (ǥեȤǤ close 줿̵ޤ)'Watchdog
Cards' ˥塼˹Ԥ'Watchdog Timer Support' ͭˤơ'Disable
watchdog shutdown on close' ץ򤷤Ʋ

Basic Design
ܥǥ
------------

The 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 are:

Linux IPMI ɥ饤ФϹ٤˥⥸塼벽𲽤褦ǥ󤵤
Ƥޤɬפʬ٤ɤǤĤΰۤʤˡǻѤ
ǤޤΤᡢIPMI ɥ饤Ф¿Υ⥸塼ʬ䤵Ƥ
ޤϲ̤Ǥ

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.

ipmi_msghandler - 줬 IPMI ƥѥեȥ˥⥸塼
ƤΥååߥ󥰡򰷤ޤIPMI 
桼ϤΥɥ饤Ф˷ӤĤ졢IPMI ʪ󥿡ե (System
Management Interface ޤ SMI ȸƤФƤޤ) ⤳Υ⥸塼˷
ӤĤޤΥ⥸塼 IPMI ѤΥͥɥ󥿡ե
󶡤ޤץꥱץˤäƻѤ륤󥿡
ե󶡤ޤ

ipmi_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.

ipmi_devintf - IPMI ɥ饤ФФ桼ɤ IOCTL 󥿡
ե󶡤ޤΥɥ饤Фؤ open 줿եϤ줾졢
IPMI 桼Ȥƥåϥɥ˷ӤĤޤ

ipmi_si - A driver for various system interfaces.  This supports
KCS, SMIC, and may support BT in the future.  Unless you have your own
custom interface, you probably need to use this.

ipmi_si - ͡ʥƥ।󥿡եΰ٤Υɥ饤Ф󶡤ޤ
 KCS  SMIC 򥵥ݡȤƤꡢ BT 򥵥ݡȤ뤫⤷
ȼѥ󥿡եѰդΤǤʤ¤ꡢ¿ʬΥɥ饤
ФɬפˤʤǤ礦

ipmi_smb - 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.

ipmi_smb - SMBus  BMC ˥٤Υɥ饤ФǤΥɥ饤
ϡSMbus  IPMI å٤ˡI2C ͥɥ饤Ф 
SMBus 󥿡եѤޤ

af_ipmi - A network socket interface to IPMI.  This doesn't take up
a character device in your system.

af_ipmi - IPMI ؤΥͥåȥåȥ󥿡եǤΥɥ
ФϥƥΥ饯ǥХѤޤ

Note that the KCS-only interface ahs been removed.

KCS ΤߤΥ󥿡եϺ줿դƲ

Much documentation for the interface is in the include files.  The
IPMI include files are:

Υ󥿡եΤۤȤɤΥɥȤ include եˤ
ޤIPMI include եϡ

net/af_ipmi.h - Contains the socket interface.

net/af_ipmi.h - åȥ󥿡եޤߤޤ

linux/ipmi.h - Contains the user interface and IOCTL interface for IPMI.

linux/ipmi.h - IPMI ѥ桼󥿡ե IOCTL 󥿡ե
ޤߤޤ

linux/ipmi_smi.h - Contains the interface for system management interfaces
(things that interface to IPMI controllers) to use.

linux/ipmi_smi.h - SMI (IPMI ȥؤΥ󥿡ե) 
٤Υ󥿡եޤߤޤ

linux/ipmi_msgdefs.h - General definitions for base IPMI messaging.

linux/ipmi_msgdefs.h -  IPMI åΰ٤ΰŪ


Addressing
ɥå
----------

The IPMI addressing works much like IP addresses, you have an overlay
to handle the different address types.  The overlay is:

IPMI ɥå󥰤 IP ɥ쥹Τ褦ưۤʤ륢ɥ쥹
򰷤٤ΥХ쥤ޤХ쥤ϲ̤Ǥ

  struct ipmi_addr
  {
	int   addr_type;
	short channel;
	char  data[IPMI_MAX_ADDR_SIZE];
  };

The addr_type determines what the address really is.  The driver
currently understands two different types of addresses.

addr_type ϥɥ쥹ºݲǤΤꤷޤߡɥ饤Ф2
ΰۤʤ륢ɥå󥰤򤷤ޤ

"System Interface" addresses are defined as:

"System Interface" ɥå󥰤ϼΤ褦ޤ

  struct ipmi_system_interface_addr
  {
	int   addr_type;
	short channel;
  };

and 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.

Υפ IPMI_SYSTEM_INTERFACE_ADDR_TYPE ǤΥפϸߤ
ɾ BMC ľܲä٤˻ѤޤΥͥ 
IPMI_BMC_CHANNEL ǤʤФʤޤ

Messages that are destined to go out on the IPMB bus use the
IPMI_IPMB_ADDR_TYPE address type.  The format is

IPMB Хǳ˽ФƤ褦ꤵ줿å 
IPMI_IPMB_ADDR_TYPE ɥå󥰥פѤޤΥեޥå
ϰʲ̤Ǥ

  struct ipmi_ipmb_addr
  {
	int           addr_type;
	short         channel;
	unsigned char slave_addr;
	unsigned char lun;
  };

The "channel" here is generally zero, but some devices support more
than one channel, it corresponds to the channel as defined in the IPMI
spec.

Ǥ "channel" Ȥϰ̤0ǤĤΥǥХ1İʾΥ
ͥ򥵥ݡȤޤ IPMI ͤˤ줿ͥŬ
Ƥޤ

Messages
å
--------

Messages are defined as:

struct ipmi_msg
{
	unsigned char netfn;
	unsigned char lun;
	unsigned char cmd;
	unsigned char *data;
	int           data_len;
};

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 :-).

Υɥ饤Фϥإåɲ/ݤߤޤdata /
ǡΤΤǤ (˥ɥå󥰾֤ʤǤ)
δλɤ "data" κǽΥƥǤꡢ;塢å
Τ褦ƤΤǡΥɤʬ䤵ʤդƲ
 (ƤϡեåȤΥȤäȤڤˤޤ :-)

When 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.

桼ɤ IOCTL 󥿡եѤݡåμ
ǤäƤ⡢"data" ѤΥǡ֥å󶡤ǡơ
data_len ˥ǡ֥åĹ򥻥åȤʤФʤޤ󡣤ʤ
СΥɥ饤Фϥå֤꤬ʤˤʤޤ

Messages coming up from the message handler in kernelland will come in
as:

ͥǥåϥɥ餫åϲΤ褦
ˤʤޤ

  struct ipmi_recv_msg
  {
	struct list_head link;

	/* The type of message as defined in the "Receive Types"
           defines above. */
	/* åΥפϲ "Receive Types" 
	   */
	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];
  };

You should look at the receive type and handle the message
appropriately.

פ򸫤ơåŬڤ˽٤Ǥ礦


The Upper Layer Interface (Message Handler)
̥쥤䥤󥿡ե (åϥɥ)
-------------------------------------------

The 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.

󥿡եξ̥쥤ϡIPMI 󥿡եΰΤӥ塼
桼󶡤ޤޤʣ SMI 󥿡եɥ
󥰤Ĥޤ (¸ĤΥܡɤʣ BMC 
)Υ󥿡եѤ桼ϡ SMI פβ
ˤ뤫ռ٤ǤϤޤ

Creating the User

桼κ

To user 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.  The callback function can run at interrupt level,
so be careful using the callbacks.  This also allows to you pass in a
piece of data, the handler_data, that will be passed back to you on
all calls.

åϥɥΥ桼Ѥˡޤ ipmi_create_user Ѥƥ桼
ʤФʤޤ󡣥󥿡եֹϤʤ³ SMI 
ɤ줫ꤷޤǡäƤݤ˸ƤФ륳Хåؿ
󶡤ʤФʤޤ󡣥Хåؿϳߥ٥Ǽ¹Բǽ
ΤǡХåλѤˤդ٤ǤϤޤƤΥ
֤ǡ (handler_data) ϤĤޤ

Once you are done, call ipmi_destroy_user() to get rid of the user.

öλСipmi_destroy_user() ǥ桼Ǥޤ

>From userland, opening the device automatically creates a user, and
closing the device automatically destroys the user.

桼ɤϡǥХ򳫤ǼưŪ˥桼졢ǥХ
ǼưŪ˥桼ޤ

Messaging
å

To send a message from kernel-land, the ipmi_request() 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.

ͥɤå硢ipmi_request() 뤬
åϥɥ󥰤ԤޤۤȤɤΥѥ᡼ϼǤ
ʤ顢msgid ѥ᡼ˤɬפǤ礦ϥå
ֹǤϤޤ󡣤ñˡåᤵƤ
ݤ֤ long ͤǤͤϹ˻ȤäƤäƹޤ

Responses 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 again, these may be running at interrupt level.  Remember to
look at the receive type, too.

ipmi_create_user() Ϥ줿 handler  ipmi_recv_hndl եɤǻ
ꤵ줿ؿ˱äƤޤ֤ޤδؿϳ
٥ưǽդƤפ򸫤
˺ʤǤ

>From 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.

桼ɤϡipmi_req_t ¤Τ IPMICTL_SEND_COMMAND
ioctl ѤƲäƤΤΰ٤ˤϡselect() ޤ poll() 
ѤƥåϤԤĤȤޤʤ顢Υ
٤ read() ȤϽޤ󡣼ºݤ˥å
ˤ ipmi_recv_t ¤դ IPMICTL_RECEIVE_MSG 򥳡뤷ʤФ
ޤmsg.data եǥǡ֥åؤΥݥ󥿤󶡤
Фʤʤȡmsg.data_len եɤ˥ǡΥƤ
ʤȤʤФƤƤϥ쥷СФƼº
˥å֤Ϳޤ

If 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, us
the IPMICTL_RECEIVE_MSG_TRUNC ioctl.

󶡤줿ǡ˥åޤʤä硢EMSGSIZE 顼
졢ɥ饤Фϼ塼˥ǡĤǤ礦⤷顼
ơ顼ˤäƥåڤͤ᤿ΤǤС
IPMICTL_RECEIVE_MSG_TRUNC ioctl ѤƲ

When 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 receive 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.

(IPMI  netfn κǲ̥ӥåȤ줿) ޥɤäݡ
Υɥ饤Фϥޥɤ˥ֹưŪ˳ơޥɤ
¸ޤ IPMI ͤ줿5ä᤮Ƥʤä
硢ޥɤॢȤ̣ưŪޤ
ޤʤ֤줿 (㤨5ðʾξ)α̵뤵


In 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.

ͥɤǤϡåƤǴλƤޤä塢
 ipmi_free_recv_msg() 򥳡뤷ʤФʤޤ󡣤ʤС
ꤳܤˤʤޤå "done" եɤ褷
ˤƤϤʤʤդƲϥåŬڤ˥
꡼󥢥åפ٤ɬפǤ

Note 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.

ݡsmi 󶡤å 
ipmi_request_supply_msg() 뤬դƲϥ
बХåե­ˤʤäǤưɬפ륳ɤξȤ
 (㤨ХåɥåޤϤѤƤޤ)ȼΥХåե
伫ͳʥ롼󶡤ޤäȤ⡢ȼΥХåե
ΤϺٹɬפʤΤǡδؿ̾λѤǤϿ侩ޤ


Events and Incoming Commands
٥Ȥϥޥ

The 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.

Υɥ饤ФIPMI ٥ȤΥݡ󥰤ȥޥɤμݤߤޤ
(ޥɤϱΤʤåǡIPMB Х¾ΥǥХ桼
ФΤǤ)ޥɤ뤿ˤϥޥɤϿ
Фʤޤ󡣥ޥɤϼưŪˤޤ

To 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.

٥Ȥ뤿ˤϡipmi_set_gets_events() ȯԤ 
"val" 0ʳ˥åȤʤФʤޤ󡣥ɥ饤Фνʹߡɥ
ФˤäƼ줿ƤΥ٥Ȥϥ٥ȤϿǽΥ桼
¨ۿޤθ塢ʣΥ桼٥ȤϿƤϡ
桼Ϥ줿ƤΥ٥Ȥˤʤޤ

For 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.  Only one user
may be registered for each netfn/cmd, but different users may register
for different commands.

ޥɤ뤿ˤϡޥɤ̤Ͽɬפ
ޤipmi_register_for_cmd() 򥳡뤷ơޥɤ줾
Ф netfn ȥޥ̾󶡤Ƥ netfn/cmd Ф
ͣΥ桼ϿǽǤ̤Υ桼̤ΥޥɤϿϤ
ޤ

>From userland, equivalent IOCTLs are provided to do these functions.

桼ɤϡεǽ¹Ԥ뤿Ʊ IOCTL 󶡤
Ƥޤ


The Lower Layer (SMI) Interface
̥쥤䡼 (SMI) 󥿡ե
-------------------------------

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.

Ҥ̤ꡢåϥɥˤʣ SMI 󥿡եϿ
ޤϤ줾졢åϥɥϿݤ˥
󥿡եֹ椬Ƥޤֹϰ̤Ͽ˳Ƥ
ޤSMI Ͽä¾ΤΤϿ줿Ϥθ¤ǤϤ
ޤ

The ipmi_smi.h defines the interface for management interfaces, see
that for more details.

ipmi_smi.h ϴ󥿡եΰ٤Υ󥿡եޤ
ܺ٤ϤΥե򻲾ȤƲ

The SI Driver
SI ɥ饤
-------------

The SI driver allows up to 4 KCS or SMIC interfaces to be configured
in the system.  By default, scan the ACPI tables for interfaces, and
if it doesn't find any the driver will attempt to register one KCS
interface at the spec-specified I/O port 0xca2 without interrupts.
You can change this at module load time (for a module) with:

SI ɥ饤ФǤ KCS ޤ SMIC 󥿡ե4Ĥޤǥƥ
ǽǤǥեȤǤϡΥ󥿡եõ٤ 
ACPI ơ֥򥹥󤷡⸫ĤʤäСɥ饤Ф 
IPMI ͤǵꤵ줿 I/O ݡ0xca2 ˤ1Ĥ KCS 󥿡ե
ߤʤϿ褦Ȥޤ

You can change this at module load time (for a module) with:

(⥸塼ξ) ⥸塼ΥɻˤΥ󥿡եѹ
Ǥޤ

  modprobe ipmi_si.o type=<type1>,<type2>....
       ports=<port1>,<port2>... addrs=<addr1>,<addr2>...
       irqs=<irq1>,<irq2>... trydefaults=[0|1]
       regspacings=<sp1>,<sp2>,... regsizes=<size1>,<size2>,...
       regshifts=<shift1>,<shift2>,...

Each of these except si_trydefaults is a list, the first item for the
first interface, second item for the second interface, etc.

si_trydefaults ѥ᡼Ϥ줾ꥹȤǤꡢǽΥ
󥿡եˤϺǽιܡ2ĤΥ󥿡եˤ2Ĥιܡ
Ȥʤޤ

The si_type may be either "kcs", "smic", or "bt".  If you leave it blank, it
defaults to "kcs".

si_type  "kcs", "smic", "bt" Τ줫Ǥξϡǥե
Ȥ "kcs" ˤʤޤ

If you specify si_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.

󥿡ե si_addrs 0ʳǻꤷϡɥ饤ФϥǥХ
Υɥ쥹ȤͿ줿ꥢɥ쥹Ѥޤ 
si_ports 񤭤ޤ

If you specify si_ports as non-zero for an interface, the driver will
use the I/O port given as the device address.

󥿡ե si_ports 0ʳǻꤷϡɥ饤ФϥǥХ
ɥ쥹ȤͿ줿I/O ݡȤѤޤ

If you specify si_irqs as non-zero for an interface, the driver will
attempt to use the given interrupt for the device.

󥿡ե si_irqs 0ʳǻꤷϡɥ饤ФϤΥ
ХѤͿ줿ߤѤ褦Ȥޤ

si_trydefaults sets whether the standard IPMI interface at 0xca2 and
any interfaces specified by ACPE are tried.  By default, the driver
tries it, set this value to zero to turn this off.

si_trydefaults  0xca2 ˤɸ IPMI 󥿡ե ACPE ǻ
줿󥿡եɤꤷޤǥեȤǤϥɥ饤
ФϤΥ󥿡եߤޤͤ0ˤȻԤʤ
ʤޤ

The 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.

3ĤΥѥ᡼ϥ쥸֤˹碌ɬפޤ󥿡
եˤäƻѤ쥸Ϣ³˸Ȥϸ¤餺
8ӥåȥ쥸ǤʤΤޤ󡣤Υѥ᡼ϡ쥸
ΥǡΥ쥤ȤΤ˻ꤹ٤˵Ƥޤ

The 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.

regspacings ѥ᡼Ϣ³쥸γϥɥ쥹ΥХȿͿ
ޤ㤨Сregspacings 4ϥɥ쥹 0xca2 ξ硢2
Υ쥸Υɥ쥹 0xca6 ˤʤޤǥեȤ1Ǥ

The 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 specified.
It may be 1, 2, 4, or 8.  The default is 1.

regsies ѥ᡼ϥ쥸ΥХñ̤ǻꤷޤIPMI 
Ѥǡ8ӥåǤ礭Υ쥸ˤ뤫
ޤ󡣤Υѥ᡼ read/write פǽˤޤ
ͤ 1,2,4,8 Τɤ줫ǤǥեȤ1Ǥ

Since 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.

쥸 32bit 礭ΤʤΤǡIPMI ǡ 
8bit ǤȤϸ¤ޤregshifts ѥ᡼ϼºݤ IPMI ǡ
٤ΥǡΥե̤ꤷޤ

When compiled into the kernel, the addresses can be specified on the
kernel command line as:

ɥ饤Ф򥫡ͥȤ߹硢ɥ쥹ϥͥ륳ޥɥ饤
᡼ǲΤ褦˻ꤹǤޤ

  ipmi_si.type=<type1>,<type2>...
       ipmi_si.ports=<port1>,<port2>... ipmi_si.addrs=<addr1>,<addr2>...
       ipmi_si.irqs=<irq1>,<irq2>... ipmi_si.trydefaults=[0|1]
       ipmi_si.regspacings=<sp1>,<sp2>,...
       ipmi_si.regsizes=<size1>,<size2>,...
       ipmi_si.regshifts=<shift1>,<shift2>,...

It works the same as the module parameters of the same names.

Ʊ̾ΤΥ⥸塼ѥ᡼Ʊͤ˵ǽޤ

By default, the driver will attempt to detect any device specified by
ACPI, and if none of those then a KCS device at the spec-specified
0xca2.  If you want to turn this off, set the "trydefaults" option to
false.

ǥեȤǤϡɥ饤Ф ACPI ǻꤵ줿ǥХΤ褦Ȥ
Ĥʤäϻͤ 0xca2 ˵ꤵ줿 KCS ǥХθΤ
ߤޤμưΤ off ˤϡ"trydefaults" ץ
0ꤷƤ

If you have high-res timers compiled into the kernel, the driver will
use them to provide much better performance.  Note that if you do not
have high-res timers enabled in the kernel and you don't have
interrupts enabled, the driver will run VERY slowly.  Don't blame me,
these interfaces suck.

٥ޡ򥫡ͥȤ߹ϡäɤѥեޥ󥹤
󶡤٤˥ɥ饤ФϤΥޡѤޤͥǹ٥
ޡͭˤޤߤͭˤʤä硢ɥ饤Ф
®ưդƤդʤǤΥ
󥿡եäƤ뤻Ǥ

The SMBus Driver
SMBus ɥ饤
----------------

The SMBus driver allows up to 4 SMBus devices to be configured in the
system.  By default, the driver will register any SMBus interfaces it finds
in the I2C address range of 0x20 to 0x4f on any adapter.  You can change this
at module load time (for a module) with:

SMBus ɥ饤Ф SMBus ǥХ1ƥǺ4ĤޤǽǤ
ǥեȤǤϡΥɥ饤Фϳƥץ I2C ɥ쥹ϰ 0x20
0x4f ǸФ줿 SMBus 󥿡եϿޤ(⥸塼
) ⥸塼ɻˤѹǤޤ

  modprobe ipmi_smb.o
	addr=<adapter1>,<i2caddr1>[,<adapter2>,<i2caddr2>[,...]]
	dbg=<flags1>,<flags2>...
	[defaultprobe=0] [dbg_probe=1]

The addresses are specified in pairs, the first is the adapter ID and the
second is the I2C address on that adapter.

Υɥ쥹ϥڥǻꤵޤǽΤΤϥץ ID ǡ2Ĥ
ΤϤΥץ I2C ɥ쥹Ǥ

The debug flags are bit flags for each BMC found, they are:
IPMI messages: 1, driver state: 2, timing: 4, I2C probe: 8

ǥХåե饰ϳ BMC ǸФΤΥӥåȥե饰Ǥ
IPMI å1ɥ饤о֡2ߥ󥰡4I2C ץ֡
8Ǥ

Setting smb_defaultprobe to zero disabled the default probing of SMBus
interfaces at address range 0x20 to 0x4f.  This means that only the
BMCs specified on the smb_addr line will be detected.

smb_defaultprobe 0ꤹȡɸưǤ륢ɥ쥹ϰ 0x20
0x4f  SMBus 󥿡եθФ̵ޤ smb_addr 
ǻꤵ줿 BMC Τ߸Τ̣ޤ

Setting smb_dbg_probe to 1 will enable debugging of the probing and
detection process for BMCs on the SMBusses.

smb_dbg_probe 1ꤹȡSMBus  BMC Υץ֤ȸβ
ǥХåͭˤޤ

Discovering the IPMI compilant 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. The default adrress range will not be used when a smb_addr
parameter is provided.

SMbus  IPMI  BMC ФϡI2C ХΥǥХưǽˤ
븶ˤʤ꤫ͤޤSMBus ɥ饤ФϡI2C ХФƥ֥å
ߤȤ "Get Device ID" IPMI å񤭹ߡԤޤ
ưϴĤ I2C ǥХˤȤäͭˤʤޤΤ I2C 
ɥ쥹 smb_addr ѥ᡼ SMBus ɥ饤ФͿ򶯤侩
ޤsmb_addr ѥ᡼Ϳ줿硢ǥեȥɥ쥹ϰϤϻ
Ѥޤ

When compiled into the kernel, the addresses can be specified on the
kernel command line as:

ɥ饤ФͥȤ߹ޤ줿硢ɥ쥹ϥͥ륳ޥɥ饤
ǻꤹޤ

  ipmb_smb.addr=<adapter1>,<i2caddr1>[,<adapter2>,<i2caddr2>[,...]]
	ipmi_smb.dbg=<flags1>,<flags2>...
	ipmi_smb.defaultprobe=0 ipmi_smb.dbg_probe=1

These are the same options as on the module command line.

⥸塼륳ޥɥ饤Ʊץ󤬤ޤ

Note that you might need some I2C changes if CONFIG_IPMI_PANIC_EVENT
is enabled along with this, so the I2C driver knows to run to
completion during sending a panic event.

Υ⥸塼Ȱ CONFIG_IPMI_PANIC_EVENT ͭˤ硢
 I2C ѹɬפˤʤ뤫⤷ʤդƤ
 I2C ɥ饤Фϥѥ˥å٥ȤƤ֤ưλ
İޤ

Other Pieces
¾ʬ
------------

Watchdog
åɥå
--------

A watchdog timer is provided that implements the Linux-standard
watchdog timer interface.  It has three module parameters that can be
used to control it:

åɥåޤ Linux ɸΥåɥåޥ󥿡ե
Τ󶡤ƤޤˤѤ˻Ѥ3ĤΥ
塼ѥ᡼ޤ

  modprobe ipmi_watchdog timeout=<t> pretimeout=<t> action=<action type>
      preaction=<preaction type> preop=<preop type> start_now=x
      nowayout=x

The timeout is the number of seconds to the action, and the pretimeout
is the amount of seconds before the reset that the pre-timeout panic will
occur (if pretimeout is zero, then pretimeout will not be enabled).  Note
that the pretimeout is the time before the final timeout.  So if the
timeout is 50 seconds and the pretimeout is 10 seconds, then the pretimeout
will occur in 40 second (10 seconds before the timeout).

timeout ưޤǤÿǤꡢpretimeout pre-timeout ѥ˥å
ȯꥻåȤޤǤÿǤ (pretimeout 0ξ硢pretimeout 
ͭˤʤޤ)pretimeout ϺǽŪʥॢȤޤǤλ֤Ǥ
դƲĤޤꡢtimeout  50ä pretimeout  10äξ硢
pretimeout  40äȯޤ (timeout ޤ 10)

The action may be "reset", "power_cycle", or "power_off", and
specifies what to do when the timer times out, and defaults to
"reset".

ư reset, power_cycle, power_off Τ줫ǤꡢॢȤ
ȯݤưꤷޤǥեȤ reset Ǥ

The preaction may be "pre_smi" for an indication through the SMI
interface, "pre_int" for an indication through the SMI with an
interrupts, and "pre_nmi" for a NMI on a preaction.  This is how
the driver is informed of the pretimeout.

preaction ˤ SMI 󥿡եؤΤ򼨤 pre_smiSMI ؤγ
դΤ򼨤 pre_intNMI 򼨤 pre_nmi Ǥޤ
ϡɥ饤Ф pretimeout Τˡ򼨤ޤ

The preop may be set to "preop_none" for no operation on a pretimeout,
"preop_panic" to set the preoperation to panic, or "preop_give_data"
to provide data to read from the watchdog device when the pretimeout
occurs.  A "pre_nmi" setting CANNOT be used with "preop_give_data"
because you can't do data operations from an NMI.

preop ˤ pretimeout ˲⤷ʤ preop_noneư panic 򥻥
Ȥ preop_panicpretimeout ˥åɥåޤɤ߽Фǡ
󶡤 preop_give_data ǤޤNMI ϥǡ
ʤΤǡpre_nmi  "preop_give_data" ȰˤϻѤǤޤ

When preop is set to "preop_give_data", one byte comes ready to read
on the device when the pretimeout occurs.  Select and fasync work on
the device, as well.

preop_give_data  preop ˥åȤ줿硢pretimeout ȯݤ
ǥХ1ХȤɤ߽Фǽˤʤޤselect  fasync Ʊ
˥ǥХǵǽޤ

If start_now is set to 1, the watchdog timer will start running as
soon as the driver is loaded.

start_now 1˥åȤ줿硢åɥåޤϥɥ饤Ф
ɤƱ˼¹Ԥޤ

If nowayout is set to 1, the watchdog timer will not stop when the
watchdog device is closed.  The default value of nowayout is true
if the CONFIG_WATCHDOG_NOWAYOUT option is enabled, or false if not.

nowayout 1˥åȤ줿硢åɥåޤϥåɥå
ǥХ close 줿ǤߤޤCONFIG_WATCHDOG_NOWAYOUT 
ץͭξ硢nowayout ΥǥեͤϿǤꡢ̵ξ
ˤʤޤ

When compiled into the kernel, the kernel command line is available
for configuring the watchdog:

ͥȤ߹ޤ줿硢åɥå˥ͥ륳ޥɥ饤
ѤǤޤ

  ipmi_watchdog.timeout=<t> ipmi_watchdog.pretimeout=<t>
	ipmi_watchdog.action=<action type>
	ipmi_watchdog.preaction=<preaction type>
	ipmi_watchdog.preop=<preop type>
	ipmi_watchdog.start_now=x
	ipmi_watchdog.nowayout=x

The options are the same as the module parameter options.

Υץϥ⥸塼ѥ᡼ƱͤǤ

The watchdog will panic and start a 120 second reset timeout if it
gets a pre-action.  During a panic or a reboot, the watchdog will
start a 120 timer if it is running to make sure the reboot occurs.

åɥå pre-action ȥѥ˥åȯ120 äΥꥻ
ȥॢȤ򳫻Ϥޤѥ˥åޤϺƵưδ֡åɥå
ưǤгμ¤˺ƵưϤ褦 120åޡ򳫻Ϥޤ

Note that if you use the NMI preaction for the watchdog, you MUST
NOT use nmi watchdog mode 1.  If you use the NMI watchdog, you
must use mode 2.

åɥå NMI preaction Ѥ硢NMI åɥå⡼
1ѤƤϤʤդƲNMI åɥåѤ
硢⡼2ѤʤФʤޤ

Once you open the watchdog timer, you must write a 'V' character to the
device to close it, or the timer will not stop.  This is a new semantic
for the driver, but makes it consistent with the rest of the watchdog
drivers in Linux.

öåɥåޤ򳫤硢ǥХ򥯥뤿ˤϥ
Х 'V' 饯񤭹ޤʤФʤޤ󡣤Ǥʤȥޡ
ߤޤ󡣤ϤΥɥ饤ФοޥƥåǤLinux 
¾Υåɥåɥ饤ФȤΰ󶡤ޤ
