8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9 .\" or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions
  11 .\" and limitations under the License.
  12 .\"
  13 .\" When distributing Covered Code, include this CDDL HEADER in each
  14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15 .\" If applicable, add the following below this CDDL HEADER, with the
  16 .\" fields enclosed by brackets "[]" replaced with your own identifying
  17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  18 .\"
  19 .\" CDDL HEADER END
  20 .\"
  21 .\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved
  22 .\" Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
  23 .\"
  24 .TH IPMI 7D "Oct 31, 2013"
  25 .SH NAME
  26 ipmi \- OpenIPMI compatible IPMI interface driver
  27 .SH SYNOPSIS
  28 .LP
  29 .nf
  30 \fB/dev/ipmi0\fR
  31 .fi
  32 
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBipmi\fR device is a character special file that provides access to the
  37 Intelligent Platform Management Interface for the system.  For more
  38 information on \fBIPMI\fR and to obtain a copy of the \fBIPMI\fR
  39 specification and implementation guidelines, refer to
  40 http://www.intel.com/design/servers/ipmi/.
  41 The driver is adapted from the FreeBSD driver which is in turn adapted from
  42 the Linux driver, however, not all features described in the standard are
  43 supported. The current implementation depends on the \fBsmbios\fR(7d) to
  44 discover the existence of an IPMI device.
  45 .sp
  46 .LP
  47 
  48 .SH IOCTLS
  49 .sp
  50 .LP
  51 Sending and receiving messages through the IPMI drivers requires the use of
  52 \fBioctl\fR(2).
  53 
  54 The ioctl command codes below are defined in \fBsys/ipmi.h\fR.
  55 The third argument to ioctl should be a pointer to the type indicated.
  56 Currently the following ioctls are supported:
  57 .RS +4
  58 .TP
  59 .ie t \(bu
  60 .el o
  61 IPMICTL_RECEIVE_MSG "struct ipmi_recv"
  62 .br
  63 Receive a message.
  64 .br
  65 Possible error values:
  66 .RS +8
  67 EAGAIN No messages are in the process queue.
  68 .br
  69 EFAULT An address supplied was invalid.
  70 .br

 150 
 151 .RS +4
 152 .TP
 153 .ie t \(bu
 154 .el o
 155 IPMICTL_REGISTER_FOR_CMD
 156 .br
 157 Register to receive a specific command
 158 .RE
 159 
 160 .RS +4
 161 .TP
 162 .ie t \(bu
 163 .el o
 164 IPMICTL_UNREGISTER_FOR_CMD
 165 .br
 166 Unregister to receive a specific command
 167 .RE
 168 
 169 .SH SEE ALSO
 170 .sp
 171 .LP
 172 \fBipmitool\fR(1), \fBioctl\fR(2), \fBsmbios\fR(7d)
 173 .sp
 174 .LP
 175 \fIIntelligent Platform Management Interface Specification Second
 176 Generation\fR, v2.0 \(em
 177 June 12, 2009 Markup
 178 .SH NOTES
 179 .sp
 180 .LP
 181 Not all systems include an \fBIPMI\fR.

   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9 .\" or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions
  11 .\" and limitations under the License.
  12 .\"
  13 .\" When distributing Covered Code, include this CDDL HEADER in each
  14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15 .\" If applicable, add the following below this CDDL HEADER, with the
  16 .\" fields enclosed by brackets "[]" replaced with your own identifying
  17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  18 .\"
  19 .\" CDDL HEADER END
  20 .\"
  21 .\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved
  22 .\" Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
  23 .\"
  24 .TH IPMI 7D "Oct 31, 2013"
  25 .SH NAME
  26 ipmi \- OpenIPMI compatible IPMI interface driver
  27 .SH SYNOPSIS

  28 .nf
  29 \fB/dev/ipmi0\fR
  30 .fi
  31 
  32 .SH DESCRIPTION


  33 The \fBipmi\fR device is a character special file that provides access to the
  34 Intelligent Platform Management Interface for the system.  For more
  35 information on \fBIPMI\fR and to obtain a copy of the \fBIPMI\fR
  36 specification and implementation guidelines, refer to
  37 http://www.intel.com/design/servers/ipmi/.
  38 The driver is adapted from the FreeBSD driver which is in turn adapted from
  39 the Linux driver, however, not all features described in the standard are
  40 supported. The current implementation depends on the \fBsmbios\fR(7d) to
  41 discover the existence of an IPMI device.


  42 
  43 .SH IOCTLS


  44 Sending and receiving messages through the IPMI drivers requires the use of
  45 \fBioctl\fR(2).
  46 
  47 The ioctl command codes below are defined in \fBsys/ipmi.h\fR.
  48 The third argument to ioctl should be a pointer to the type indicated.
  49 Currently the following ioctls are supported:
  50 .RS +4
  51 .TP
  52 .ie t \(bu
  53 .el o
  54 IPMICTL_RECEIVE_MSG "struct ipmi_recv"
  55 .br
  56 Receive a message.
  57 .br
  58 Possible error values:
  59 .RS +8
  60 EAGAIN No messages are in the process queue.
  61 .br
  62 EFAULT An address supplied was invalid.
  63 .br

 143 
 144 .RS +4
 145 .TP
 146 .ie t \(bu
 147 .el o
 148 IPMICTL_REGISTER_FOR_CMD
 149 .br
 150 Register to receive a specific command
 151 .RE
 152 
 153 .RS +4
 154 .TP
 155 .ie t \(bu
 156 .el o
 157 IPMICTL_UNREGISTER_FOR_CMD
 158 .br
 159 Unregister to receive a specific command
 160 .RE
 161 
 162 .SH SEE ALSO


 163 \fBipmitool\fR(1), \fBioctl\fR(2), \fBsmbios\fR(7d)
 164 .sp
 165 .LP
 166 \fIIntelligent Platform Management Interface Specification Second
 167 Generation\fR, v2.0 \(em
 168 June 12, 2009 Markup
 169 .SH NOTES


 170 Not all systems include an \fBIPMI\fR.