Print this page
11622 clean up rarer mandoc lint warnings
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man7d/ipmi.7d
+++ new/usr/src/man/man7d/ipmi.7d
1 1 '\"
2 2 .\" CDDL HEADER START
3 3 .\"
4 4 .\" The contents of this file are subject to the terms of the
5 5 .\" Common Development and Distribution License (the "License").
6 6 .\" You may not use this file except in compliance with the License.
7 7 .\"
8 8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 9 .\" or http://www.opensolaris.org/os/licensing.
10 10 .\" See the License for the specific language governing permissions
11 11 .\" and limitations under the License.
12 12 .\"
13 13 .\" When distributing Covered Code, include this CDDL HEADER in each
14 14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 15 .\" If applicable, add the following below this CDDL HEADER, with the
16 16 .\" fields enclosed by brackets "[]" replaced with your own identifying
17 17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
|
↓ open down ↓ |
17 lines elided |
↑ open up ↑ |
18 18 .\"
19 19 .\" CDDL HEADER END
20 20 .\"
21 21 .\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved
22 22 .\" Copyright 2013 Nexenta Systems, Inc. All rights reserved.
23 23 .\"
24 24 .TH IPMI 7D "Oct 31, 2013"
25 25 .SH NAME
26 26 ipmi \- OpenIPMI compatible IPMI interface driver
27 27 .SH SYNOPSIS
28 -.LP
29 28 .nf
30 29 \fB/dev/ipmi0\fR
31 30 .fi
32 31
33 32 .SH DESCRIPTION
34 -.sp
35 -.LP
36 33 The \fBipmi\fR device is a character special file that provides access to the
37 34 Intelligent Platform Management Interface for the system. For more
38 35 information on \fBIPMI\fR and to obtain a copy of the \fBIPMI\fR
39 36 specification and implementation guidelines, refer to
40 37 http://www.intel.com/design/servers/ipmi/.
41 38 The driver is adapted from the FreeBSD driver which is in turn adapted from
42 39 the Linux driver, however, not all features described in the standard are
43 40 supported. The current implementation depends on the \fBsmbios\fR(7d) to
44 41 discover the existence of an IPMI device.
45 -.sp
46 -.LP
47 42
48 43 .SH IOCTLS
49 -.sp
50 -.LP
51 44 Sending and receiving messages through the IPMI drivers requires the use of
52 45 \fBioctl\fR(2).
53 46
54 47 The ioctl command codes below are defined in \fBsys/ipmi.h\fR.
55 48 The third argument to ioctl should be a pointer to the type indicated.
56 49 Currently the following ioctls are supported:
57 50 .RS +4
58 51 .TP
59 52 .ie t \(bu
60 53 .el o
61 54 IPMICTL_RECEIVE_MSG "struct ipmi_recv"
62 55 .br
63 56 Receive a message.
64 57 .br
65 58 Possible error values:
66 59 .RS +8
67 60 EAGAIN No messages are in the process queue.
68 61 .br
69 62 EFAULT An address supplied was invalid.
70 63 .br
71 64 EMSGSIZE The address could not fit in the message buffer and
72 65 will remain in the buffer.
73 66 .RE
74 67 .RE
75 68
76 69 .RS +4
77 70 .TP
78 71 .ie t \(bu
79 72 .el o
80 73 IPMICTL_RECEIVE_MSG_TRUNC "struct ipmi_recv"
81 74 .br
82 75 Like IPMICTL_RECEIVE_MSG but if the message cannot fit into the buffer, it
83 76 will truncate the contents instead of leaving the data in the buffer.
84 77 .RE
85 78
86 79 .RS +4
87 80 .TP
88 81 .ie t \(bu
89 82 .el o
90 83 IPMICTL_SEND_COMMAND "struct ipmi_req"
91 84 .br
92 85 Send a message to the interface.
93 86 .br
94 87 Possible error values:
95 88 .RS +8
96 89 EFAULT An address supplied was invalid
97 90 .br
98 91 ENOMEM Buffers could not be allowed for the command, out of memory.
99 92 .RE
100 93 .RE
101 94
102 95 .RS +4
103 96 .TP
104 97 .ie t \(bu
105 98 .el o
106 99 IPMICTL_SET_MY_ADDRESS_CMD "unsigned int"
107 100 .br
108 101 Set the slave address for source messages.
109 102 .RE
110 103
111 104 .RS +4
112 105 .TP
113 106 .ie t \(bu
114 107 .el o
115 108 IPMICTL_GET_MY_ADDRESS_CMD "unsigned int"
116 109 .br
117 110 Get the slave address for source messages.
118 111 .RE
119 112
120 113 .RS +4
121 114 .TP
122 115 .ie t \(bu
123 116 .el o
124 117 IPMICTL_SET_MY_LUN_CMD "unsigned int"
125 118 .br
126 119 Set the slave LUN for source messages.
127 120 .RE
128 121
129 122 .RS +4
130 123 .TP
131 124 .ie t \(bu
132 125 .el o
133 126 IPMICTL_GET_MY_LUN_CMD "unsigned int"
134 127 .br
135 128 Get the slave LUN for source messages.
136 129 .RE
137 130
138 131 Stub Only Ioctl
139 132
140 133 .RS +4
141 134 .TP
142 135 .ie t \(bu
143 136 .el o
144 137 IPMICTL_SET_GETS_EVENTS_CMD int
145 138 .br
146 139 Set whether this interface receives events.
147 140 .RE
148 141
149 142 Unimplemented Ioctls
150 143
151 144 .RS +4
152 145 .TP
153 146 .ie t \(bu
154 147 .el o
155 148 IPMICTL_REGISTER_FOR_CMD
156 149 .br
157 150 Register to receive a specific command
158 151 .RE
159 152
|
↓ open down ↓ |
99 lines elided |
↑ open up ↑ |
160 153 .RS +4
161 154 .TP
162 155 .ie t \(bu
163 156 .el o
164 157 IPMICTL_UNREGISTER_FOR_CMD
165 158 .br
166 159 Unregister to receive a specific command
167 160 .RE
168 161
169 162 .SH SEE ALSO
170 -.sp
171 -.LP
172 163 \fBipmitool\fR(1), \fBioctl\fR(2), \fBsmbios\fR(7d)
173 164 .sp
174 165 .LP
175 166 \fIIntelligent Platform Management Interface Specification Second
176 167 Generation\fR, v2.0 \(em
177 168 June 12, 2009 Markup
178 169 .SH NOTES
179 -.sp
180 -.LP
181 170 Not all systems include an \fBIPMI\fR.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX