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