include/linux/ipmi.h

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