i686-linux-gnu-4.7/usr/include/linux/ipmi.h

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