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
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.
67 Only specify either the
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 driver implements the power cycling option to
98 to implement power cycling of the system.
99 The motherboard's BMC must support the chassis device and the optional
100 power cycle subcomand of the chassis control command as described in section 28.3
101 of the IPMI standard.
102 The length of time the system is off will be at least one second, but
103 may be longer if the power cycle interval has been set (see section 28.9).
105 Sending and receiving messages through the
107 driver requires the use of
109 The ioctls are used due to the complexity of
110 data sent to and from the device.
113 command codes below are defined in
115 The third argument to
117 should be a pointer to the type indicated.
119 Currently the following ioctls are supported:
120 .Bl -tag -width indent
121 .It Dv IPMICTL_RECEIVE_MSG Pq Vt "struct ipmi_recv"
123 Possible error values:
126 No messages are in the process queue.
128 An address supplied was invalid.
130 The address could not fit in the message buffer and
131 will remain in the buffer.
133 .It Dv IPMICTL_RECEIVE_MSG_TRUNC Pq Vt "struct ipmi_recv"
135 .Dv IPMICTL_RECEIVE_MSG
136 but if the message cannot fit into the buffer, it
137 will truncate the contents instead of leaving the data
139 .It Dv IPMICTL_SEND_COMMAND Pq Vt "struct ipmi_req"
140 Send a message to the interface.
141 Possible error values:
144 An address supplied was invalid.
146 Buffers could not be allowed for the command, out of memory.
148 .It Dv IPMICTL_SET_MY_ADDRESS_CMD Pq Vt "unsigned int"
149 Set the slave address for source messages.
150 .It Dv IPMICTL_GET_MY_ADDRESS_CMD Pq Vt "unsigned int"
151 Get the slave address for source messages.
152 .It Dv IPMICTL_SET_MY_LUN_CMD Pq Vt "unsigned int"
153 Set the slave LUN for source messages.
154 .It Dv IPMICTL_GET_MY_LUN_CMD Pq Vt "unsigned int"
155 Get the slave LUN for source messages.
157 .Ss Unimplemented Ioctls
158 .Bl -tag -width indent
159 .It Dv IPMICTL_REGISTER_FOR_CMD Pq Vt "struct ipmi_cmdspec"
160 Register to receive a specific command.
161 Possible error values:
164 An supplied address was invalid.
166 The network function/command is already in use.
168 Could not allocate memory.
170 .It Dv IPMICTL_UNREGISTER_FOR_CMD Pq Vt "struct ipmi_cmdspec"
171 Unregister to receive a specific command.
172 Possible error values:
175 An address supplied was invalid.
177 The network function/command was not found.
181 .Bl -tag -width indent
182 .It Dv IPMICTL_SET_GETS_EVENTS_CMD Pq Vt int
183 Set whether this interface receives events.
184 Possible error values:
187 An address supplied was invalid.
201 driver first appeared in
207 driver was written by
208 .An Doug Ambrisko Aq Mt ambrisko@FreeBSD.org .
209 This manual page was written by
210 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org .
212 Not all features of the MontaVista driver are supported.
214 Currently, IPMB and BT modes are not implemented.