1.\" 2.\" Copyright (c) 2006 Tom Rhodes 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd October 25, 2017 29.Dt IPMI 4 30.Os 31.Sh NAME 32.Nm ipmi 33.Nd "OpenIPMI compatible IPMI interface driver" 34.Sh SYNOPSIS 35.Cd "device ipmi" 36.Pp 37To manually specify I/O attachment in 38.Pa /boot/device.hints : 39.Cd hint.ipmi.0.at="isa" 40.Cd hint.ipmi.0.port="0xCA2" 41.Cd hint.ipmi.0.spacing="8" 42.Cd hint.ipmi.0.mode="KCS" 43.Pp 44To manually specify memory attachment in 45.Pa /boot/device.hints : 46.Cd hint.ipmi.0.at="isa" 47.Cd hint.ipmi.0.maddr="0xf0000000" 48.Cd hint.ipmi.0.spacing="8" 49.Cd hint.ipmi.0.mode="SMIC" 50.Pp 51Meaning of 52.Ar spacing : 53.Bl -tag -offset indent -compact -width 0x0 54.It 8 558 bit alignment 56.It 16 5716 bit alignment 58.It 32 5932 bit alignment 60.El 61.Pp 62If the 63.Ar port 64and 65.Ar spacing 66are not specified the interface type default will be used. 67Only specify either the 68.Ar port 69for I/O access or 70.Ar maddr 71for memory access. 72.Sh DESCRIPTION 73The 74.Tn IPMI 75(Intelligent Platform Management Interface) is a standard for 76monitoring system hardware by permitting generic code to detect 77and monitor the sensors in a system. 78The 79.Tn IPMI 80standard offers watchdog support, an FRU database, and other 81support extensions. 82It is currently being adopted by the makers of many 83single board and embedded system manufacturers. 84.Pp 85The 86.Nm 87driver in 88.Fx 89is heavily adopted from the standard and 90.Tn Linux 91driver; however, not all features described in the 92standard are supported. 93.Pp 94The 95.Nm 96driver implements the power cycling option to 97.Xr shutdown 8 98to implement power cycling of the system. 99The motherboard's BMC must support the chassis device and the optional 100power cycle subcomand of the chassis control command as described in section 28.3 101of the IPMI standard. 102The length of time the system is off will be at least one second, but 103may be longer if the power cycle interval has been set (see section 28.9). 104.Sh IOCTLS 105Sending and receiving messages through the 106.Nm 107driver requires the use of 108.Xr ioctl 2 . 109The ioctls are used due to the complexity of 110data sent to and from the device. 111The 112.Xr ioctl 2 113command codes below are defined in 114.In sys/ipmi.h . 115The third argument to 116.Xr ioctl 2 117should be a pointer to the type indicated. 118.Pp 119Currently the following ioctls are supported: 120.Bl -tag -width indent 121.It Dv IPMICTL_RECEIVE_MSG Pq Vt "struct ipmi_recv" 122Receive a message. 123Possible error values: 124.Bl -tag -width Er 125.It Bq Er EAGAIN 126No messages are in the process queue. 127.It Bq Er EFAULT 128An address supplied was invalid. 129.It Bq Er EMSGSIZE 130The address could not fit in the message buffer and 131will remain in the buffer. 132.El 133.It Dv IPMICTL_RECEIVE_MSG_TRUNC Pq Vt "struct ipmi_recv" 134Like 135.Dv IPMICTL_RECEIVE_MSG 136but if the message cannot fit into the buffer, it 137will truncate the contents instead of leaving the data 138in the buffer. 139.It Dv IPMICTL_SEND_COMMAND Pq Vt "struct ipmi_req" 140Send a message to the interface. 141Possible error values: 142.Bl -tag -width Er 143.It Bq Er EFAULT 144An address supplied was invalid. 145.It Bq Er ENOMEM 146Buffers could not be allowed for the command, out of memory. 147.El 148.It Dv IPMICTL_SET_MY_ADDRESS_CMD Pq Vt "unsigned int" 149Set the slave address for source messages. 150.It Dv IPMICTL_GET_MY_ADDRESS_CMD Pq Vt "unsigned int" 151Get the slave address for source messages. 152.It Dv IPMICTL_SET_MY_LUN_CMD Pq Vt "unsigned int" 153Set the slave LUN for source messages. 154.It Dv IPMICTL_GET_MY_LUN_CMD Pq Vt "unsigned int" 155Get the slave LUN for source messages. 156.El 157.Ss Unimplemented Ioctls 158.Bl -tag -width indent 159.It Dv IPMICTL_REGISTER_FOR_CMD Pq Vt "struct ipmi_cmdspec" 160Register to receive a specific command. 161Possible error values: 162.Bl -tag -width Er 163.It Bq Er EFAULT 164An supplied address was invalid. 165.It Bq Er EBUSY 166The network function/command is already in use. 167.It Bq Er ENOMEM 168Could not allocate memory. 169.El 170.It Dv IPMICTL_UNREGISTER_FOR_CMD Pq Vt "struct ipmi_cmdspec" 171Unregister to receive a specific command. 172Possible error values: 173.Bl -tag -width Er 174.It Bq Er EFAULT 175An address supplied was invalid. 176.It Bq Er ENOENT 177The network function/command was not found. 178.El 179.El 180.Ss Stub Only Ioctl 181.Bl -tag -width indent 182.It Dv IPMICTL_SET_GETS_EVENTS_CMD Pq Vt int 183Set whether this interface receives events. 184Possible error values: 185.Bl -tag -width Er 186.It Bq Er EFAULT 187An address supplied was invalid. 188.El 189.El 190.Sh SEE ALSO 191.Xr ioctl 2 , 192.Xr watchdog 4 , 193.Xr reboot 8 , 194.Xr shutdown 8 , 195.Xr watchdog 8 , 196.Xr watchdogd 8 , 197.Xr watchdog 9 198.Sh HISTORY 199The 200.Nm 201driver first appeared in 202.Fx 6.2 . 203.Sh AUTHORS 204.An -nosplit 205The 206.Nm 207driver was written by 208.An Doug Ambrisko Aq Mt ambrisko@FreeBSD.org . 209This manual page was written by 210.An Tom Rhodes Aq Mt trhodes@FreeBSD.org . 211.Sh BUGS 212Not all features of the MontaVista driver are supported. 213.Pp 214Currently, IPMB and BT modes are not implemented. 215