2 .\" Copyright (c) 2006 Tom Rhodes
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
26 .\" $FreeBSD: head/share/man/man4/ipmi.4 267938 2014-06-26 21:46:14Z bapt $
33 .Nd "OpenIPMI compatible IPMI interface driver"
37 .\"To 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"
44 .\"To 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"
53 .\".Bl -tag -offset indent -compact -width 0x0
66 .\"are not specified the interface type default will be used. Only specify
75 (Intelligent Platform Management Interface) is a standard for
76 monitoring system hardware by permitting generic code to detect
77 and monitor the sensors in a system.
80 standard offers watchdog support, an FRU database, and other
82 It is currently being adopted by the makers of many
83 single board and embedded system manufacturers.
89 is heavily adopted from the standard and
91 driver; however, not all features described in the
92 standard are supported.
96 variables are available:
97 .Bl -tag -width ".Va dev.ipmi.%d.watchdog_timeout"
98 .It Va dev.ipmi.%d.watchdog_enable
99 Enable watchdog functionality.
100 .It Va dev.ipmi.%d.watchdog_timeout
101 Set the watchdog timeout.
104 Sending and receiving messages through the
106 driver requires the use of
108 The ioctls are used due to the complexity of
109 data sent to and from the device.
112 command codes below are defined in
114 The third argument to
116 should be a pointer to the type indicated.
118 Currently the following ioctls are supported:
119 .Bl -tag -width indent
120 .It Dv IPMICTL_RECEIVE_MSG Pq Vt "struct ipmi_recv"
122 Possible error values:
125 No messages are in the process queue.
127 An address supplied was invalid.
129 The address could not fit in the message buffer and
130 will remain in the buffer.
132 .It Dv IPMICTL_RECEIVE_MSG_TRUNC Pq Vt "struct ipmi_recv"
134 .Dv IPMICTL_RECEIVE_MSG
135 but if the message cannot fit into the buffer, it
136 will truncate the contents instead of leaving the data
138 .It Dv IPMICTL_SEND_COMMAND Pq Vt "struct ipmi_req"
139 Send a message to the interface.
140 Possible error values:
143 An address supplied was invalid.
145 Buffers could not be allowed for the command, out of memory.
147 .It Dv IPMICTL_SET_MY_ADDRESS_CMD Pq Vt "unsigned int"
148 Set the slave address for source messages.
149 .It Dv IPMICTL_GET_MY_ADDRESS_CMD Pq Vt "unsigned int"
150 Get the slave address for source messages.
151 .It Dv IPMICTL_SET_MY_LUN_CMD Pq Vt "unsigned int"
152 Set the slave LUN for source messages.
153 .It Dv IPMICTL_GET_MY_LUN_CMD Pq Vt "unsigned int"
154 Get the slave LUN for source messages.
156 .Ss Unimplemented Ioctls
157 .Bl -tag -width indent
158 .It Dv IPMICTL_REGISTER_FOR_CMD Pq Vt "struct ipmi_cmdspec"
159 Register to receive a specific command.
160 Possible error values:
163 An supplied address was invalid.
165 The network function/command is already in use.
167 Could not allocate memory.
169 .It Dv IPMICTL_UNREGISTER_FOR_CMD Pq Vt "struct ipmi_cmdspec"
170 Unregister to receive a specific command.
171 Possible error values:
174 An address supplied was invalid.
176 The network function/command was not found.
180 .Bl -tag -width indent
181 .It Dv IPMICTL_SET_GETS_EVENTS_CMD Pq Vt int
182 Set whether this interface receives events.
183 Possible error values:
186 An address supplied was invalid.
198 driver first appeared in
206 driver was written by
207 .An Doug Ambrisko Aq Mt ambrisko@FreeBSD.org .
208 This manual page was written by
209 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org .
211 Not all features of the MontaVista driver are supported.
213 Currently, IPMB and BT modes are not implemented.