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