1 /* 2 * ipmi.h 3 * 4 * MontaVista IPMI interface 5 * 6 * Author: MontaVista Software, Inc. 7 * Corey Minyard <minyard@mvista.com> 8 * source@mvista.com 9 * 10 * Copyright 2002 MontaVista Software Inc. 11 * 12 * This program is free software; you can redistribute it and/or modify it 13 * under the terms of the GNU General Public License as published by the 14 * Free Software Foundation; either version 2 of the License, or (at your 15 * option) any later version. 16 * 17 * 18 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED 19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 23 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 24 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 26 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 27 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 * 29 * You should have received a copy of the GNU General Public License along 30 * with this program; if not, write to the Free Software Foundation, Inc., 31 * 675 Mass Ave, Cambridge, MA 02139, USA. 32 */ 33 34 #ifndef _UAPI__LINUX_IPMI_H 35 #define _UAPI__LINUX_IPMI_H 36 37 #include <linux/ipmi_msgdefs.h> 38 #include <linux/compiler.h> 39 40 /* 41 * This file describes an interface to an IPMI driver. You have to 42 * have a fairly good understanding of IPMI to use this, so go read 43 * the specs first before actually trying to do anything. 44 * 45 * With that said, this driver provides a multi-user interface to the 46 * IPMI driver, and it allows multiple IPMI physical interfaces below 47 * the driver. The physical interfaces bind as a lower layer on the 48 * driver. They appear as interfaces to the application using this 49 * interface. 50 * 51 * Multi-user means that multiple applications may use the driver, 52 * send commands, receive responses, etc. The driver keeps track of 53 * commands the user sends and tracks the responses. The responses 54 * will go back to the application that send the command. If the 55 * response doesn't come back in time, the driver will return a 56 * timeout error response to the application. Asynchronous events 57 * from the BMC event queue will go to all users bound to the driver. 58 * The incoming event queue in the BMC will automatically be flushed 59 * if it becomes full and it is queried once a second to see if 60 * anything is in it. Incoming commands to the driver will get 61 * delivered as commands. 62 */ 63 64 /* 65 * This is an overlay for all the address types, so it's easy to 66 * determine the actual address type. This is kind of like addresses 67 * work for sockets. 68 */ 69 #define IPMI_MAX_ADDR_SIZE 32 70 struct ipmi_addr { 71 /* Try to take these from the "Channel Medium Type" table 72 in section 6.5 of the IPMI 1.5 manual. */ 73 int addr_type; 74 short channel; 75 char data[IPMI_MAX_ADDR_SIZE]; 76 }; 77 78 /* 79 * When the address is not used, the type will be set to this value. 80 * The channel is the BMC's channel number for the channel (usually 81 * 0), or IPMC_BMC_CHANNEL if communicating directly with the BMC. 82 */ 83 #define IPMI_SYSTEM_INTERFACE_ADDR_TYPE 0x0c 84 struct ipmi_system_interface_addr { 85 int addr_type; 86 short channel; 87 unsigned char lun; 88 }; 89 90 /* An IPMB Address. */ 91 #define IPMI_IPMB_ADDR_TYPE 0x01 92 /* Used for broadcast get device id as described in section 17.9 of the 93 IPMI 1.5 manual. */ 94 #define IPMI_IPMB_BROADCAST_ADDR_TYPE 0x41 95 struct ipmi_ipmb_addr { 96 int addr_type; 97 short channel; 98 unsigned char slave_addr; 99 unsigned char lun; 100 }; 101 102 /* 103 * A LAN Address. This is an address to/from a LAN interface bridged 104 * by the BMC, not an address actually out on the LAN. 105 * 106 * A conscious decision was made here to deviate slightly from the IPMI 107 * spec. We do not use rqSWID and rsSWID like it shows in the 108 * message. Instead, we use remote_SWID and local_SWID. This means 109 * that any message (a request or response) from another device will 110 * always have exactly the same address. If you didn't do this, 111 * requests and responses from the same device would have different 112 * addresses, and that's not too cool. 113 * 114 * In this address, the remote_SWID is always the SWID the remote 115 * message came from, or the SWID we are sending the message to. 116 * local_SWID is always our SWID. Note that having our SWID in the 117 * message is a little weird, but this is required. 118 */ 119 #define IPMI_LAN_ADDR_TYPE 0x04 120 struct ipmi_lan_addr { 121 int addr_type; 122 short channel; 123 unsigned char privilege; 124 unsigned char session_handle; 125 unsigned char remote_SWID; 126 unsigned char local_SWID; 127 unsigned char lun; 128 }; 129 130 131 /* 132 * Channel for talking directly with the BMC. When using this 133 * channel, This is for the system interface address type only. FIXME 134 * - is this right, or should we use -1? 135 */ 136 #define IPMI_BMC_CHANNEL 0xf 137 #define IPMI_NUM_CHANNELS 0x10 138 139 /* 140 * Used to signify an "all channel" bitmask. This is more than the 141 * actual number of channels because this is used in userland and 142 * will cover us if the number of channels is extended. 143 */ 144 #define IPMI_CHAN_ALL (~0) 145 146 147 /* 148 * A raw IPMI message without any addressing. This covers both 149 * commands and responses. The completion code is always the first 150 * byte of data in the response (as the spec shows the messages laid 151 * out). 152 */ 153 struct ipmi_msg { 154 unsigned char netfn; 155 unsigned char cmd; 156 unsigned short data_len; 157 unsigned char __user *data; 158 }; 159 160 struct kernel_ipmi_msg { 161 unsigned char netfn; 162 unsigned char cmd; 163 unsigned short data_len; 164 unsigned char *data; 165 }; 166 167 /* 168 * Various defines that are useful for IPMI applications. 169 */ 170 #define IPMI_INVALID_CMD_COMPLETION_CODE 0xC1 171 #define IPMI_TIMEOUT_COMPLETION_CODE 0xC3 172 #define IPMI_UNKNOWN_ERR_COMPLETION_CODE 0xff 173 174 175 /* 176 * Receive types for messages coming from the receive interface. This 177 * is used for the receive in-kernel interface and in the receive 178 * IOCTL. 179 * 180 * The "IPMI_RESPONSE_RESPNOSE_TYPE" is a little strange sounding, but 181 * it allows you to get the message results when you send a response 182 * message. 183 */ 184 #define IPMI_RESPONSE_RECV_TYPE 1 /* A response to a command */ 185 #define IPMI_ASYNC_EVENT_RECV_TYPE 2 /* Something from the event queue */ 186 #define IPMI_CMD_RECV_TYPE 3 /* A command from somewhere else */ 187 #define IPMI_RESPONSE_RESPONSE_TYPE 4 /* The response for 188 a sent response, giving any 189 error status for sending the 190 response. When you send a 191 response message, this will 192 be returned. */ 193 #define IPMI_OEM_RECV_TYPE 5 /* The response for OEM Channels */ 194 195 /* Note that async events and received commands do not have a completion 196 code as the first byte of the incoming data, unlike a response. */ 197 198 199 /* 200 * Modes for ipmi_set_maint_mode() and the userland IOCTL. The AUTO 201 * setting is the default and means it will be set on certain 202 * commands. Hard setting it on and off will override automatic 203 * operation. 204 */ 205 #define IPMI_MAINTENANCE_MODE_AUTO 0 206 #define IPMI_MAINTENANCE_MODE_OFF 1 207 #define IPMI_MAINTENANCE_MODE_ON 2 208 209 210 211 /* 212 * The userland interface 213 */ 214 215 /* 216 * The userland interface for the IPMI driver is a standard character 217 * device, with each instance of an interface registered as a minor 218 * number under the major character device. 219 * 220 * The read and write calls do not work, to get messages in and out 221 * requires ioctl calls because of the complexity of the data. select 222 * and poll do work, so you can wait for input using the file 223 * descriptor, you just can use read to get it. 224 * 225 * In general, you send a command down to the interface and receive 226 * responses back. You can use the msgid value to correlate commands 227 * and responses, the driver will take care of figuring out which 228 * incoming messages are for which command and find the proper msgid 229 * value to report. You will only receive reponses for commands you 230 * send. Asynchronous events, however, go to all open users, so you 231 * must be ready to handle these (or ignore them if you don't care). 232 * 233 * The address type depends upon the channel type. When talking 234 * directly to the BMC (IPMC_BMC_CHANNEL), the address is ignored 235 * (IPMI_UNUSED_ADDR_TYPE). When talking to an IPMB channel, you must 236 * supply a valid IPMB address with the addr_type set properly. 237 * 238 * When talking to normal channels, the driver takes care of the 239 * details of formatting and sending messages on that channel. You do 240 * not, for instance, have to format a send command, you just send 241 * whatever command you want to the channel, the driver will create 242 * the send command, automatically issue receive command and get even 243 * commands, and pass those up to the proper user. 244 */ 245 246 247 /* The magic IOCTL value for this interface. */ 248 #define IPMI_IOC_MAGIC 'i' 249 250 251 /* Messages sent to the interface are this format. */ 252 struct ipmi_req { 253 unsigned char __user *addr; /* Address to send the message to. */ 254 unsigned int addr_len; 255 256 long msgid; /* The sequence number for the message. This 257 exact value will be reported back in the 258 response to this request if it is a command. 259 If it is a response, this will be used as 260 the sequence value for the response. */ 261 262 struct ipmi_msg msg; 263 }; 264 /* 265 * Send a message to the interfaces. error values are: 266 * - EFAULT - an address supplied was invalid. 267 * - EINVAL - The address supplied was not valid, or the command 268 * was not allowed. 269 * - EMSGSIZE - The message to was too large. 270 * - ENOMEM - Buffers could not be allocated for the command. 271 */ 272 #define IPMICTL_SEND_COMMAND _IOR(IPMI_IOC_MAGIC, 13, \ 273 struct ipmi_req) 274 275 /* Messages sent to the interface with timing parameters are this 276 format. */ 277 struct ipmi_req_settime { 278 struct ipmi_req req; 279 280 /* See ipmi_request_settime() above for details on these 281 values. */ 282 int retries; 283 unsigned int retry_time_ms; 284 }; 285 /* 286 * Send a message to the interfaces with timing parameters. error values 287 * are: 288 * - EFAULT - an address supplied was invalid. 289 * - EINVAL - The address supplied was not valid, or the command 290 * was not allowed. 291 * - EMSGSIZE - The message to was too large. 292 * - ENOMEM - Buffers could not be allocated for the command. 293 */ 294 #define IPMICTL_SEND_COMMAND_SETTIME _IOR(IPMI_IOC_MAGIC, 21, \ 295 struct ipmi_req_settime) 296 297 /* Messages received from the interface are this format. */ 298 struct ipmi_recv { 299 int recv_type; /* Is this a command, response or an 300 asyncronous event. */ 301 302 unsigned char __user *addr; /* Address the message was from is put 303 here. The caller must supply the 304 memory. */ 305 unsigned int addr_len; /* The size of the address buffer. 306 The caller supplies the full buffer 307 length, this value is updated to 308 the actual message length when the 309 message is received. */ 310 311 long msgid; /* The sequence number specified in the request 312 if this is a response. If this is a command, 313 this will be the sequence number from the 314 command. */ 315 316 struct ipmi_msg msg; /* The data field must point to a buffer. 317 The data_size field must be set to the 318 size of the message buffer. The 319 caller supplies the full buffer 320 length, this value is updated to the 321 actual message length when the message 322 is received. */ 323 }; 324 325 /* 326 * Receive a message. error values: 327 * - EAGAIN - no messages in the queue. 328 * - EFAULT - an address supplied was invalid. 329 * - EINVAL - The address supplied was not valid. 330 * - EMSGSIZE - The message to was too large to fit into the message buffer, 331 * the message will be left in the buffer. */ 332 #define IPMICTL_RECEIVE_MSG _IOWR(IPMI_IOC_MAGIC, 12, \ 333 struct ipmi_recv) 334 335 /* 336 * Like RECEIVE_MSG, but if the message won't fit in the buffer, it 337 * will truncate the contents instead of leaving the data in the 338 * buffer. 339 */ 340 #define IPMICTL_RECEIVE_MSG_TRUNC _IOWR(IPMI_IOC_MAGIC, 11, \ 341 struct ipmi_recv) 342 343 /* Register to get commands from other entities on this interface. */ 344 struct ipmi_cmdspec { 345 unsigned char netfn; 346 unsigned char cmd; 347 }; 348 349 /* 350 * Register to receive a specific command. error values: 351 * - EFAULT - an address supplied was invalid. 352 * - EBUSY - The netfn/cmd supplied was already in use. 353 * - ENOMEM - could not allocate memory for the entry. 354 */ 355 #define IPMICTL_REGISTER_FOR_CMD _IOR(IPMI_IOC_MAGIC, 14, \ 356 struct ipmi_cmdspec) 357 /* 358 * Unregister a regsitered command. error values: 359 * - EFAULT - an address supplied was invalid. 360 * - ENOENT - The netfn/cmd was not found registered for this user. 361 */ 362 #define IPMICTL_UNREGISTER_FOR_CMD _IOR(IPMI_IOC_MAGIC, 15, \ 363 struct ipmi_cmdspec) 364 365 /* 366 * Register to get commands from other entities on specific channels. 367 * This way, you can only listen on specific channels, or have messages 368 * from some channels go to one place and other channels to someplace 369 * else. The chans field is a bitmask, (1 << channel) for each channel. 370 * It may be IPMI_CHAN_ALL for all channels. 371 */ 372 struct ipmi_cmdspec_chans { 373 unsigned int netfn; 374 unsigned int cmd; 375 unsigned int chans; 376 }; 377 378 /* 379 * Register to receive a specific command on specific channels. error values: 380 * - EFAULT - an address supplied was invalid. 381 * - EBUSY - One of the netfn/cmd/chans supplied was already in use. 382 * - ENOMEM - could not allocate memory for the entry. 383 */ 384 #define IPMICTL_REGISTER_FOR_CMD_CHANS _IOR(IPMI_IOC_MAGIC, 28, \ 385 struct ipmi_cmdspec_chans) 386 /* 387 * Unregister some netfn/cmd/chans. error values: 388 * - EFAULT - an address supplied was invalid. 389 * - ENOENT - None of the netfn/cmd/chans were found registered for this user. 390 */ 391 #define IPMICTL_UNREGISTER_FOR_CMD_CHANS _IOR(IPMI_IOC_MAGIC, 29, \ 392 struct ipmi_cmdspec_chans) 393 394 /* 395 * Set whether this interface receives events. Note that the first 396 * user registered for events will get all pending events for the 397 * interface. error values: 398 * - EFAULT - an address supplied was invalid. 399 */ 400 #define IPMICTL_SET_GETS_EVENTS_CMD _IOR(IPMI_IOC_MAGIC, 16, int) 401 402 /* 403 * Set and get the slave address and LUN that we will use for our 404 * source messages. Note that this affects the interface, not just 405 * this user, so it will affect all users of this interface. This is 406 * so some initialization code can come in and do the OEM-specific 407 * things it takes to determine your address (if not the BMC) and set 408 * it for everyone else. You should probably leave the LUN alone. 409 */ 410 struct ipmi_channel_lun_address_set { 411 unsigned short channel; 412 unsigned char value; 413 }; 414 #define IPMICTL_SET_MY_CHANNEL_ADDRESS_CMD \ 415 _IOR(IPMI_IOC_MAGIC, 24, struct ipmi_channel_lun_address_set) 416 #define IPMICTL_GET_MY_CHANNEL_ADDRESS_CMD \ 417 _IOR(IPMI_IOC_MAGIC, 25, struct ipmi_channel_lun_address_set) 418 #define IPMICTL_SET_MY_CHANNEL_LUN_CMD \ 419 _IOR(IPMI_IOC_MAGIC, 26, struct ipmi_channel_lun_address_set) 420 #define IPMICTL_GET_MY_CHANNEL_LUN_CMD \ 421 _IOR(IPMI_IOC_MAGIC, 27, struct ipmi_channel_lun_address_set) 422 /* Legacy interfaces, these only set IPMB 0. */ 423 #define IPMICTL_SET_MY_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 17, unsigned int) 424 #define IPMICTL_GET_MY_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 18, unsigned int) 425 #define IPMICTL_SET_MY_LUN_CMD _IOR(IPMI_IOC_MAGIC, 19, unsigned int) 426 #define IPMICTL_GET_MY_LUN_CMD _IOR(IPMI_IOC_MAGIC, 20, unsigned int) 427 428 /* 429 * Get/set the default timing values for an interface. You shouldn't 430 * generally mess with these. 431 */ 432 struct ipmi_timing_parms { 433 int retries; 434 unsigned int retry_time_ms; 435 }; 436 #define IPMICTL_SET_TIMING_PARMS_CMD _IOR(IPMI_IOC_MAGIC, 22, \ 437 struct ipmi_timing_parms) 438 #define IPMICTL_GET_TIMING_PARMS_CMD _IOR(IPMI_IOC_MAGIC, 23, \ 439 struct ipmi_timing_parms) 440 441 /* 442 * Set the maintenance mode. See ipmi_set_maintenance_mode() above 443 * for a description of what this does. 444 */ 445 #define IPMICTL_GET_MAINTENANCE_MODE_CMD _IOR(IPMI_IOC_MAGIC, 30, int) 446 #define IPMICTL_SET_MAINTENANCE_MODE_CMD _IOW(IPMI_IOC_MAGIC, 31, int) 447 448 #endif /* _UAPI__LINUX_IPMI_H */ 449