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