man/man4d/ipmi.4d

 CDDL HEADER START

 The contents of this file are subject to the terms of the
 Common Development and Distribution License (the "License").
 You may not use this file except in compliance with the License.

 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 or http://www.opensolaris.org/os/licensing.
 See the License for the specific language governing permissions
 and limitations under the License.

 When distributing Covered Code, include this CDDL HEADER in each
 file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 If applicable, add the following below this CDDL HEADER, with the
 fields enclosed by brackets "[]" replaced with your own identifying
 information: Portions Copyright [yyyy] [name of copyright owner]

 CDDL HEADER END

 Copyright (c) 2012, Joyent, Inc. All Rights Reserved
 Copyright 2013 Nexenta Systems, Inc. All rights reserved.

 IPMI 4D "Oct 31, 2013"
 NAME
ipmi - OpenIPMI compatible IPMI interface driver
 SYNOPSIS
/dev/ipmi0


 DESCRIPTION
The ipmi device is a character special file that provides access to the
Intelligent Platform Management Interface for the system. For more
information on IPMI and to obtain a copy of the IPMI
specification and implementation guidelines, refer to
http://www.intel.com/design/servers/ipmi/.
The driver is adapted from the FreeBSD driver which is in turn adapted from
the Linux driver, however, not all features described in the standard are
supported. The current implementation depends on the smbios(4D) to
discover the existence of an IPMI device.

 IOCTLS
Sending and receiving messages through the IPMI drivers requires the use of
ioctl(2).

The ioctl command codes below are defined in sys/ipmi.h.
The third argument to ioctl should be a pointer to the type indicated.
Currently the following ioctls are supported:


IPMICTL_RECEIVE_MSG "struct ipmi_recv"

Receive a message.

Possible error values:

EAGAIN No messages are in the process queue.

EFAULT An address supplied was invalid.

EMSGSIZE The address could not fit in the message buffer and
will remain in the buffer.


IPMICTL_RECEIVE_MSG_TRUNC "struct ipmi_recv"

Like IPMICTL_RECEIVE_MSG but if the message cannot fit into the buffer, it
will truncate the contents instead of leaving the data in the buffer.


IPMICTL_SEND_COMMAND "struct ipmi_req"

Send a message to the interface.

Possible error values:

EFAULT An address supplied was invalid

ENOMEM Buffers could not be allowed for the command, out of memory.


IPMICTL_SET_MY_ADDRESS_CMD "unsigned int"

Set the slave address for source messages.


IPMICTL_GET_MY_ADDRESS_CMD "unsigned int"

Get the slave address for source messages.


IPMICTL_SET_MY_LUN_CMD "unsigned int"

Set the slave LUN for source messages.


IPMICTL_GET_MY_LUN_CMD "unsigned int"

Get the slave LUN for source messages.


Stub Only Ioctl


IPMICTL_SET_GETS_EVENTS_CMD int

Set whether this interface receives events.


Unimplemented Ioctls


IPMICTL_REGISTER_FOR_CMD

Register to receive a specific command


IPMICTL_UNREGISTER_FOR_CMD

Unregister to receive a specific command


 SEE ALSO
 ipmitool (1),  ioctl (2),  smbios (4D)
Intelligent Platform Management Interface Specification Second
Generation, v2.0 \(em
June 12, 2009 Markup
 NOTES
Not all systems include an IPMI.