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
28 .Dd September 30, 2006
33 .Nd "OpenIPMI compatible IPMI interface driver"
39 (Intelligent Platform Management Interface) is a standard for
40 monitoring system hardware by permitting generic code to detect
41 and monitor the sensors in a system.
44 standard offers watchdog support, an FRU database, and other
46 It is currently being adopted by the makers of many
47 single board and embedded system manufacturers.
53 is heavily adopted from the standard and
55 driver; however, not all features described in the
56 standard are supported.
58 Sending and receiving messages through the
60 driver requires the use of
62 The ioctls are used due to the complexity of
63 data sent to and from the device.
66 command codes below are defined in
70 should be a pointer to the type indicated.
72 Currently the following ioctls are supported:
73 .Bl -tag -width indent
74 .It Dv IPMICTL_RECEIVE_MSG Pq Vt "struct ipmi_recv"
76 Possible error values:
79 No messages are in the process queue.
81 An address supplied was invalid.
83 The address could not fit in the message buffer and
84 will remain in the buffer.
86 .It Dv IPMICTL_RECEIVE_MSG_TRUNC Pq Vt "struct ipmi_recv"
88 .Dv IPMICTL_RECEIVE_MSG
89 but if the message cannot fit into the buffer, it
90 will truncate the contents instead of leaving the data
92 .It Dv IPMICTL_SEND_COMMAND Pq Vt "struct ipmi_req"
93 Send a message to the interface.
94 Possible error values:
97 An address supplied was invalid
99 Buffers could not be allowed for the command, out of memory.
101 .It Dv IPMICTL_SET_MY_ADDRESS_CMD Pq Vt "unsigned int"
102 Set the slave address for source messages.
103 .It Dv IPMICTL_GET_MY_ADDRESS_CMD Pq Vt "unsigned int"
104 Get the slave address for source messages.
105 .It Dv IPMICTL_SET_MY_LUN_CMD Pq Vt "unsigned int"
106 Set the slave LUN for source messages.
107 .It Dv IPMICTL_GET_MY_LUN_CMD Pq Vt "unsigned int"
108 Get the slave LUN for source messages.
110 .Ss Unimplemented Ioctls
111 .Bl -tag -width indent
112 .It Dv IPMICTL_REGISTER_FOR_CMD Pq Vt "struct ipmi_cmdspec"
113 Register to receive a specific command
114 Possible error values:
117 An supplied address was invalid.
119 The network function/command is already in use.
121 Could not allocate memory.
123 .It Dv IPMICTL_UNREGISTER_FOR_CMD Pq Vt "struct ipmi_cmdspec"
124 Unregister to receive a specific command
125 Possible error values:
128 An address supplied was invalid.
130 The network function/command was not found.
134 .Bl -tag -width indent
135 .It Dv IPMICTL_SET_GETS_EVENTS_CMD Pq Vt int
136 Set whether this interface receives events.
137 Possible error values:
140 An address supplied was invalid.
152 driver first appeared in
158 driver was written by
159 .An Doug Ambrisko Aq ambrisko@FreeBSD.org .
160 This manual page was written by
161 .An Tom Rhodes Aq trhodes@FreeBSD.org .
163 Not all features of the MontaVista driver are supported.
165 Currently, IPMB and BT modes are not implemented.