1 /* 2 * ipmi.h 3 * 4 * MontaVista IPMI interface 5 * 6 * Author: MontaVista Software, Inc. 7 * Corey Minyard <[email protected]> 8 * [email protected] 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 #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 * This driver provides two main interfaces: one for in-kernel 64 * applications and another for userland applications. The 65 * capabilities are basically the same for both interface, although 66 * the interfaces are somewhat different. The stuff in the 67 * #ifdef KERNEL below is the in-kernel interface. The userland 68 * interface is defined later in the file. */ 69 70 71 72 /* 73 * This is an overlay for all the address types, so it's easy to 74 * determine the actual address type. This is kind of like addresses 75 * work for sockets. 76 */ 77 #define IPMI_MAX_ADDR_SIZE 32 78 struct ipmi_addr 79 { 80 /* Try to take these from the "Channel Medium Type" table 81 in section 6.5 of the IPMI 1.5 manual. */ 82 int addr_type; 83 short channel; 84 char data[IPMI_MAX_ADDR_SIZE]; 85 }; 86 87 /* 88 * When the address is not used, the type will be set to this value. 89 * The channel is the BMC's channel number for the channel (usually 90 * 0), or IPMC_BMC_CHANNEL if communicating directly with the BMC. 91 */ 92 #define IPMI_SYSTEM_INTERFACE_ADDR_TYPE 0x0c 93 struct ipmi_system_interface_addr 94 { 95 int addr_type; 96 short channel; 97 unsigned char lun; 98 }; 99 100 /* An IPMB Address. */ 101 #define IPMI_IPMB_ADDR_TYPE 0x01 102 /* Used for broadcast get device id as described in section 17.9 of the 103 IPMI 1.5 manual. */ 104 #define IPMI_IPMB_BROADCAST_ADDR_TYPE 0x41 105 struct ipmi_ipmb_addr 106 { 107 int addr_type; 108 short channel; 109 unsigned char slave_addr; 110 unsigned char lun; 111 }; 112 113 /* 114 * A LAN Address. This is an address to/from a LAN interface bridged 115 * by the BMC, not an address actually out on the LAN. 116 * 117 * A concious decision was made here to deviate slightly from the IPMI 118 * spec. We do not use rqSWID and rsSWID like it shows in the 119 * message. Instead, we use remote_SWID and local_SWID. This means 120 * that any message (a request or response) from another device will 121 * always have exactly the same address. If you didn't do this, 122 * requests and responses from the same device would have different 123 * addresses, and that's not too cool. 124 * 125 * In this address, the remote_SWID is always the SWID the remote 126 * message came from, or the SWID we are sending the message to. 127 * local_SWID is always our SWID. Note that having our SWID in the 128 * message is a little weird, but this is required. 129 */ 130 #define IPMI_LAN_ADDR_TYPE 0x04 131 struct ipmi_lan_addr 132 { 133 int addr_type; 134 short channel; 135 unsigned char privilege; 136 unsigned char session_handle; 137 unsigned char remote_SWID; 138 unsigned char local_SWID; 139 unsigned char lun; 140 }; 141 142 143 /* 144 * Channel for talking directly with the BMC. When using this 145 * channel, This is for the system interface address type only. FIXME 146 * - is this right, or should we use -1? 147 */ 148 #define IPMI_BMC_CHANNEL 0xf 149 #define IPMI_NUM_CHANNELS 0x10 150 151 152 /* 153 * A raw IPMI message without any addressing. This covers both 154 * commands and responses. The completion code is always the first 155 * byte of data in the response (as the spec shows the messages laid 156 * out). 157 */ 158 struct ipmi_msg 159 { 160 unsigned char netfn; 161 unsigned char cmd; 162 unsigned short data_len; 163 unsigned char __user *data; 164 }; 165 166 struct kernel_ipmi_msg 167 { 168 unsigned char netfn; 169 unsigned char cmd; 170 unsigned short data_len; 171 unsigned char *data; 172 }; 173 174 /* 175 * Various defines that are useful for IPMI applications. 176 */ 177 #define IPMI_INVALID_CMD_COMPLETION_CODE 0xC1 178 #define IPMI_TIMEOUT_COMPLETION_CODE 0xC3 179 #define IPMI_UNKNOWN_ERR_COMPLETION_CODE 0xff 180 181 182 /* 183 * Receive types for messages coming from the receive interface. This 184 * is used for the receive in-kernel interface and in the receive 185 * IOCTL. 186 * 187 * The "IPMI_RESPONSE_RESPNOSE_TYPE" is a little strange sounding, but 188 * it allows you to get the message results when you send a response 189 * message. 190 */ 191 #define IPMI_RESPONSE_RECV_TYPE 1 /* A response to a command */ 192 #define IPMI_ASYNC_EVENT_RECV_TYPE 2 /* Something from the event queue */ 193 #define IPMI_CMD_RECV_TYPE 3 /* A command from somewhere else */ 194 #define IPMI_RESPONSE_RESPONSE_TYPE 4 /* The response for 195 a sent response, giving any 196 error status for sending the 197 response. When you send a 198 response message, this will 199 be returned. */ 200 /* Note that async events and received commands do not have a completion 201 code as the first byte of the incoming data, unlike a response. */ 202 203 204 205 #ifdef __KERNEL__ 206 207 /* 208 * The in-kernel interface. 209 */ 210 #include <linux/list.h> 211 #include <linux/module.h> 212 213 #ifdef CONFIG_PROC_FS 214 #include <linux/proc_fs.h> 215 extern struct proc_dir_entry *proc_ipmi_root; 216 #endif /* CONFIG_PROC_FS */ 217 218 /* Opaque type for a IPMI message user. One of these is needed to 219 send and receive messages. */ 220 typedef struct ipmi_user *ipmi_user_t; 221 222 /* 223 * Stuff coming from the receive interface comes as one of these. 224 * They are allocated, the receiver must free them with 225 * ipmi_free_recv_msg() when done with the message. The link is not 226 * used after the message is delivered, so the upper layer may use the 227 * link to build a linked list, if it likes. 228 */ 229 struct ipmi_recv_msg 230 { 231 struct list_head link; 232 233 /* The type of message as defined in the "Receive Types" 234 defines above. */ 235 int recv_type; 236 237 ipmi_user_t user; 238 struct ipmi_addr addr; 239 long msgid; 240 struct kernel_ipmi_msg msg; 241 242 /* The user_msg_data is the data supplied when a message was 243 sent, if this is a response to a sent message. If this is 244 not a response to a sent message, then user_msg_data will 245 be NULL. If the user above is NULL, then this will be the 246 intf. */ 247 void *user_msg_data; 248 249 /* Call this when done with the message. It will presumably free 250 the message and do any other necessary cleanup. */ 251 void (*done)(struct ipmi_recv_msg *msg); 252 253 /* Place-holder for the data, don't make any assumptions about 254 the size or existance of this, since it may change. */ 255 unsigned char msg_data[IPMI_MAX_MSG_LENGTH]; 256 }; 257 258 /* Allocate and free the receive message. */ 259 void ipmi_free_recv_msg(struct ipmi_recv_msg *msg); 260 261 struct ipmi_user_hndl 262 { 263 /* Routine type to call when a message needs to be routed to 264 the upper layer. This will be called with some locks held, 265 the only IPMI routines that can be called are ipmi_request 266 and the alloc/free operations. The handler_data is the 267 variable supplied when the receive handler was registered. */ 268 void (*ipmi_recv_hndl)(struct ipmi_recv_msg *msg, 269 void *user_msg_data); 270 271 /* Called when the interface detects a watchdog pre-timeout. If 272 this is NULL, it will be ignored for the user. */ 273 void (*ipmi_watchdog_pretimeout)(void *handler_data); 274 }; 275 276 /* Create a new user of the IPMI layer on the given interface number. */ 277 int ipmi_create_user(unsigned int if_num, 278 struct ipmi_user_hndl *handler, 279 void *handler_data, 280 ipmi_user_t *user); 281 282 /* Destroy the given user of the IPMI layer. Note that after this 283 function returns, the system is guaranteed to not call any 284 callbacks for the user. Thus as long as you destroy all the users 285 before you unload a module, you will be safe. And if you destroy 286 the users before you destroy the callback structures, it should be 287 safe, too. */ 288 int ipmi_destroy_user(ipmi_user_t user); 289 290 /* Get the IPMI version of the BMC we are talking to. */ 291 void ipmi_get_version(ipmi_user_t user, 292 unsigned char *major, 293 unsigned char *minor); 294 295 /* Set and get the slave address and LUN that we will use for our 296 source messages. Note that this affects the interface, not just 297 this user, so it will affect all users of this interface. This is 298 so some initialization code can come in and do the OEM-specific 299 things it takes to determine your address (if not the BMC) and set 300 it for everyone else. Note that each channel can have its own address. */ 301 int ipmi_set_my_address(ipmi_user_t user, 302 unsigned int channel, 303 unsigned char address); 304 int ipmi_get_my_address(ipmi_user_t user, 305 unsigned int channel, 306 unsigned char *address); 307 int ipmi_set_my_LUN(ipmi_user_t user, 308 unsigned int channel, 309 unsigned char LUN); 310 int ipmi_get_my_LUN(ipmi_user_t user, 311 unsigned int channel, 312 unsigned char *LUN); 313 314 /* 315 * Like ipmi_request, but lets you specify the number of retries and 316 * the retry time. The retries is the number of times the message 317 * will be resent if no reply is received. If set to -1, the default 318 * value will be used. The retry time is the time in milliseconds 319 * between retries. If set to zero, the default value will be 320 * used. 321 * 322 * Don't use this unless you *really* have to. It's primarily for the 323 * IPMI over LAN converter; since the LAN stuff does its own retries, 324 * it makes no sense to do it here. However, this can be used if you 325 * have unusual requirements. 326 */ 327 int ipmi_request_settime(ipmi_user_t user, 328 struct ipmi_addr *addr, 329 long msgid, 330 struct kernel_ipmi_msg *msg, 331 void *user_msg_data, 332 int priority, 333 int max_retries, 334 unsigned int retry_time_ms); 335 336 /* 337 * Like ipmi_request, but with messages supplied. This will not 338 * allocate any memory, and the messages may be statically allocated 339 * (just make sure to do the "done" handling on them). Note that this 340 * is primarily for the watchdog timer, since it should be able to 341 * send messages even if no memory is available. This is subject to 342 * change as the system changes, so don't use it unless you REALLY 343 * have to. 344 */ 345 int ipmi_request_supply_msgs(ipmi_user_t user, 346 struct ipmi_addr *addr, 347 long msgid, 348 struct kernel_ipmi_msg *msg, 349 void *user_msg_data, 350 void *supplied_smi, 351 struct ipmi_recv_msg *supplied_recv, 352 int priority); 353 354 /* 355 * When commands come in to the SMS, the user can register to receive 356 * them. Only one user can be listening on a specific netfn/cmd pair 357 * at a time, you will get an EBUSY error if the command is already 358 * registered. If a command is received that does not have a user 359 * registered, the driver will automatically return the proper 360 * error. 361 */ 362 int ipmi_register_for_cmd(ipmi_user_t user, 363 unsigned char netfn, 364 unsigned char cmd); 365 int ipmi_unregister_for_cmd(ipmi_user_t user, 366 unsigned char netfn, 367 unsigned char cmd); 368 369 /* 370 * Allow run-to-completion mode to be set for the interface of 371 * a specific user. 372 */ 373 void ipmi_user_set_run_to_completion(ipmi_user_t user, int val); 374 375 /* 376 * When the user is created, it will not receive IPMI events by 377 * default. The user must set this to TRUE to get incoming events. 378 * The first user that sets this to TRUE will receive all events that 379 * have been queued while no one was waiting for events. 380 */ 381 int ipmi_set_gets_events(ipmi_user_t user, int val); 382 383 /* 384 * Called when a new SMI is registered. This will also be called on 385 * every existing interface when a new watcher is registered with 386 * ipmi_smi_watcher_register(). 387 */ 388 struct ipmi_smi_watcher 389 { 390 struct list_head link; 391 392 /* You must set the owner to the current module, if you are in 393 a module (generally just set it to "THIS_MODULE"). */ 394 struct module *owner; 395 396 /* These two are called with read locks held for the interface 397 the watcher list. So you can add and remove users from the 398 IPMI interface, send messages, etc., but you cannot add 399 or remove SMI watchers or SMI interfaces. */ 400 void (*new_smi)(int if_num); 401 void (*smi_gone)(int if_num); 402 }; 403 404 int ipmi_smi_watcher_register(struct ipmi_smi_watcher *watcher); 405 int ipmi_smi_watcher_unregister(struct ipmi_smi_watcher *watcher); 406 407 /* The following are various helper functions for dealing with IPMI 408 addresses. */ 409 410 /* Return the maximum length of an IPMI address given it's type. */ 411 unsigned int ipmi_addr_length(int addr_type); 412 413 /* Validate that the given IPMI address is valid. */ 414 int ipmi_validate_addr(struct ipmi_addr *addr, int len); 415 416 #endif /* __KERNEL__ */ 417 418 419 /* 420 * The userland interface 421 */ 422 423 /* 424 * The userland interface for the IPMI driver is a standard character 425 * device, with each instance of an interface registered as a minor 426 * number under the major character device. 427 * 428 * The read and write calls do not work, to get messages in and out 429 * requires ioctl calls because of the complexity of the data. select 430 * and poll do work, so you can wait for input using the file 431 * descriptor, you just can use read to get it. 432 * 433 * In general, you send a command down to the interface and receive 434 * responses back. You can use the msgid value to correlate commands 435 * and responses, the driver will take care of figuring out which 436 * incoming messages are for which command and find the proper msgid 437 * value to report. You will only receive reponses for commands you 438 * send. Asynchronous events, however, go to all open users, so you 439 * must be ready to handle these (or ignore them if you don't care). 440 * 441 * The address type depends upon the channel type. When talking 442 * directly to the BMC (IPMC_BMC_CHANNEL), the address is ignored 443 * (IPMI_UNUSED_ADDR_TYPE). When talking to an IPMB channel, you must 444 * supply a valid IPMB address with the addr_type set properly. 445 * 446 * When talking to normal channels, the driver takes care of the 447 * details of formatting and sending messages on that channel. You do 448 * not, for instance, have to format a send command, you just send 449 * whatever command you want to the channel, the driver will create 450 * the send command, automatically issue receive command and get even 451 * commands, and pass those up to the proper user. 452 */ 453 454 455 /* The magic IOCTL value for this interface. */ 456 #define IPMI_IOC_MAGIC 'i' 457 458 459 /* Messages sent to the interface are this format. */ 460 struct ipmi_req 461 { 462 unsigned char __user *addr; /* Address to send the message to. */ 463 unsigned int addr_len; 464 465 long msgid; /* The sequence number for the message. This 466 exact value will be reported back in the 467 response to this request if it is a command. 468 If it is a response, this will be used as 469 the sequence value for the response. */ 470 471 struct ipmi_msg msg; 472 }; 473 /* 474 * Send a message to the interfaces. error values are: 475 * - EFAULT - an address supplied was invalid. 476 * - EINVAL - The address supplied was not valid, or the command 477 * was not allowed. 478 * - EMSGSIZE - The message to was too large. 479 * - ENOMEM - Buffers could not be allocated for the command. 480 */ 481 #define IPMICTL_SEND_COMMAND _IOR(IPMI_IOC_MAGIC, 13, \ 482 struct ipmi_req) 483 484 /* Messages sent to the interface with timing parameters are this 485 format. */ 486 struct ipmi_req_settime 487 { 488 struct ipmi_req req; 489 490 /* See ipmi_request_settime() above for details on these 491 values. */ 492 int retries; 493 unsigned int retry_time_ms; 494 }; 495 /* 496 * Send a message to the interfaces with timing parameters. error values 497 * are: 498 * - EFAULT - an address supplied was invalid. 499 * - EINVAL - The address supplied was not valid, or the command 500 * was not allowed. 501 * - EMSGSIZE - The message to was too large. 502 * - ENOMEM - Buffers could not be allocated for the command. 503 */ 504 #define IPMICTL_SEND_COMMAND_SETTIME _IOR(IPMI_IOC_MAGIC, 21, \ 505 struct ipmi_req_settime) 506 507 /* Messages received from the interface are this format. */ 508 struct ipmi_recv 509 { 510 int recv_type; /* Is this a command, response or an 511 asyncronous event. */ 512 513 unsigned char __user *addr; /* Address the message was from is put 514 here. The caller must supply the 515 memory. */ 516 unsigned int addr_len; /* The size of the address buffer. 517 The caller supplies the full buffer 518 length, this value is updated to 519 the actual message length when the 520 message is received. */ 521 522 long msgid; /* The sequence number specified in the request 523 if this is a response. If this is a command, 524 this will be the sequence number from the 525 command. */ 526 527 struct ipmi_msg msg; /* The data field must point to a buffer. 528 The data_size field must be set to the 529 size of the message buffer. The 530 caller supplies the full buffer 531 length, this value is updated to the 532 actual message length when the message 533 is received. */ 534 }; 535 536 /* 537 * Receive a message. error values: 538 * - EAGAIN - no messages in the queue. 539 * - EFAULT - an address supplied was invalid. 540 * - EINVAL - The address supplied was not valid. 541 * - EMSGSIZE - The message to was too large to fit into the message buffer, 542 * the message will be left in the buffer. */ 543 #define IPMICTL_RECEIVE_MSG _IOWR(IPMI_IOC_MAGIC, 12, \ 544 struct ipmi_recv) 545 546 /* 547 * Like RECEIVE_MSG, but if the message won't fit in the buffer, it 548 * will truncate the contents instead of leaving the data in the 549 * buffer. 550 */ 551 #define IPMICTL_RECEIVE_MSG_TRUNC _IOWR(IPMI_IOC_MAGIC, 11, \ 552 struct ipmi_recv) 553 554 /* Register to get commands from other entities on this interface. */ 555 struct ipmi_cmdspec 556 { 557 unsigned char netfn; 558 unsigned char cmd; 559 }; 560 561 /* 562 * Register to receive a specific command. error values: 563 * - EFAULT - an address supplied was invalid. 564 * - EBUSY - The netfn/cmd supplied was already in use. 565 * - ENOMEM - could not allocate memory for the entry. 566 */ 567 #define IPMICTL_REGISTER_FOR_CMD _IOR(IPMI_IOC_MAGIC, 14, \ 568 struct ipmi_cmdspec) 569 /* 570 * Unregister a regsitered command. error values: 571 * - EFAULT - an address supplied was invalid. 572 * - ENOENT - The netfn/cmd was not found registered for this user. 573 */ 574 #define IPMICTL_UNREGISTER_FOR_CMD _IOR(IPMI_IOC_MAGIC, 15, \ 575 struct ipmi_cmdspec) 576 577 /* 578 * Set whether this interface receives events. Note that the first 579 * user registered for events will get all pending events for the 580 * interface. error values: 581 * - EFAULT - an address supplied was invalid. 582 */ 583 #define IPMICTL_SET_GETS_EVENTS_CMD _IOR(IPMI_IOC_MAGIC, 16, int) 584 585 /* 586 * Set and get the slave address and LUN that we will use for our 587 * source messages. Note that this affects the interface, not just 588 * this user, so it will affect all users of this interface. This is 589 * so some initialization code can come in and do the OEM-specific 590 * things it takes to determine your address (if not the BMC) and set 591 * it for everyone else. You should probably leave the LUN alone. 592 */ 593 struct ipmi_channel_lun_address_set 594 { 595 unsigned short channel; 596 unsigned char value; 597 }; 598 #define IPMICTL_SET_MY_CHANNEL_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 24, struct ipmi_channel_lun_address_set) 599 #define IPMICTL_GET_MY_CHANNEL_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 25, struct ipmi_channel_lun_address_set) 600 #define IPMICTL_SET_MY_CHANNEL_LUN_CMD _IOR(IPMI_IOC_MAGIC, 26, struct ipmi_channel_lun_address_set) 601 #define IPMICTL_GET_MY_CHANNEL_LUN_CMD _IOR(IPMI_IOC_MAGIC, 27, struct ipmi_channel_lun_address_set) 602 /* Legacy interfaces, these only set IPMB 0. */ 603 #define IPMICTL_SET_MY_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 17, unsigned int) 604 #define IPMICTL_GET_MY_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 18, unsigned int) 605 #define IPMICTL_SET_MY_LUN_CMD _IOR(IPMI_IOC_MAGIC, 19, unsigned int) 606 #define IPMICTL_GET_MY_LUN_CMD _IOR(IPMI_IOC_MAGIC, 20, unsigned int) 607 608 /* 609 * Get/set the default timing values for an interface. You shouldn't 610 * generally mess with these. 611 */ 612 struct ipmi_timing_parms 613 { 614 int retries; 615 unsigned int retry_time_ms; 616 }; 617 #define IPMICTL_SET_TIMING_PARMS_CMD _IOR(IPMI_IOC_MAGIC, 22, \ 618 struct ipmi_timing_parms) 619 #define IPMICTL_GET_TIMING_PARMS_CMD _IOR(IPMI_IOC_MAGIC, 23, \ 620 struct ipmi_timing_parms) 621 622 #endif /* __LINUX_IPMI_H */ 623