4 * MontaVista IPMI interface
6 * Author: MontaVista Software, Inc.
7 * Corey Minyard <minyard@mvista.com>
10 * Copyright 2002 MontaVista Software Inc.
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.
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.
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.
34 #ifndef __LINUX_IPMI_H
35 #define __LINUX_IPMI_H
37 #include <linux/ipmi_msgdefs.h>
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.
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
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.
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. */
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
76 #define IPMI_MAX_ADDR_SIZE 32
79 /* Try to take these from the "Channel Medium Type" table
80 in section 6.5 of the IPMI 1.5 manual. */
83 char data[IPMI_MAX_ADDR_SIZE];
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.
91 #define IPMI_SYSTEM_INTERFACE_ADDR_TYPE 0x0c
92 struct ipmi_system_interface_addr
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
103 #define IPMI_IPMB_BROADCAST_ADDR_TYPE 0x41
104 struct ipmi_ipmb_addr
108 unsigned char slave_addr;
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.
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.
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 wierd, but this is required.
129 #define IPMI_LAN_ADDR_TYPE 0x04
134 unsigned char privilege;
135 unsigned char session_handle;
136 unsigned char remote_SWID;
137 unsigned char local_SWID;
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?
147 #define IPMI_BMC_CHANNEL 0xf
148 #define IPMI_NUM_CHANNELS 0x10
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
161 unsigned short data_len;
166 * Various defines that are useful for IPMI applications.
168 #define IPMI_INVALID_CMD_COMPLETION_CODE 0xC1
169 #define IPMI_TIMEOUT_COMPLETION_CODE 0xC3
170 #define IPMI_UNKNOWN_ERR_COMPLETION_CODE 0xff
174 * Receive types for messages coming from the receive interface. This
175 * is used for the receive in-kernel interface and in the receive
178 * The "IPMI_RESPONSE_RESPNOSE_TYPE" is a little strange sounding, but
179 * it allows you to get the message results when you send a response
182 #define IPMI_RESPONSE_RECV_TYPE 1 /* A response to a command */
183 #define IPMI_ASYNC_EVENT_RECV_TYPE 2 /* Something from the event queue */
184 #define IPMI_CMD_RECV_TYPE 3 /* A command from somewhere else */
185 #define IPMI_RESPONSE_RESPONSE_TYPE 4 /* The response for
186 a sent response, giving any
187 error status for sending the
188 response. When you send a
189 response message, this will
191 /* Note that async events and received commands do not have a completion
192 code as the first byte of the incoming data, unlike a response. */
199 * The in-kernel interface.
201 #include <linux/list.h>
202 #include <linux/module.h>
204 /* Opaque type for a IPMI message user. One of these is needed to
205 send and receive messages. */
206 typedef struct ipmi_user *ipmi_user_t;
209 * Stuff coming from the receive interface comes as one of these.
210 * They are allocated, the receiver must free them with
211 * ipmi_free_recv_msg() when done with the message. The link is not
212 * used after the message is delivered, so the upper layer may use the
213 * link to build a linked list, if it likes.
217 struct list_head link;
219 /* The type of message as defined in the "Receive Types"
224 struct ipmi_addr addr;
228 /* The user_msg_data is the data supplied when a message was
229 sent, if this is a response to a sent message. If this is
230 not a response to a sent message, then user_msg_data will
234 /* Call this when done with the message. It will presumably free
235 the message and do any other necessary cleanup. */
236 void (*done)(struct ipmi_recv_msg *msg);
238 /* Place-holder for the data, don't make any assumptions about
239 the size or existance of this, since it may change. */
240 unsigned char msg_data[IPMI_MAX_MSG_LENGTH];
243 /* Allocate and free the receive message. */
244 static inline void ipmi_free_recv_msg(struct ipmi_recv_msg *msg)
248 struct ipmi_recv_msg *ipmi_alloc_recv_msg(void);
250 struct ipmi_user_hndl
252 /* Routine type to call when a message needs to be routed to
253 the upper layer. This will be called with some locks held,
254 the only IPMI routines that can be called are ipmi_request
255 and the alloc/free operations. The handler_data is the
256 variable supplied when the receive handler was registered. */
257 void (*ipmi_recv_hndl)(struct ipmi_recv_msg *msg,
258 void *user_msg_data);
260 /* Called when the interface detects a watchdog pre-timeout. If
261 this is NULL, it will be ignored for the user. */
262 void (*ipmi_watchdog_pretimeout)(void *handler_data);
265 /* Create a new user of the IPMI layer on the given interface number. */
266 int ipmi_create_user(unsigned int if_num,
267 struct ipmi_user_hndl *handler,
271 /* Destroy the given user of the IPMI layer. Note that after this
272 function returns, the system is guaranteed to not call any
273 callbacks for the user. Thus as long as you destroy all the users
274 before you unload a module, you will be safe. And if you destroy
275 the users before you destroy the callback structures, it should be
277 int ipmi_destroy_user(ipmi_user_t user);
279 /* Get the IPMI version of the BMC we are talking to. */
280 void ipmi_get_version(ipmi_user_t user,
281 unsigned char *major,
282 unsigned char *minor);
284 /* Set and get the slave address and LUN that we will use for our
285 source messages. Note that this affects the interface, not just
286 this user, so it will affect all users of this interface. This is
287 so some initialization code can come in and do the OEM-specific
288 things it takes to determine your address (if not the BMC) and set
289 it for everyone else. */
290 void ipmi_set_my_address(ipmi_user_t user,
291 unsigned char address);
292 unsigned char ipmi_get_my_address(ipmi_user_t user);
293 void ipmi_set_my_LUN(ipmi_user_t user,
295 unsigned char ipmi_get_my_LUN(ipmi_user_t user);
298 * Send a command request from the given user. The address is the
299 * proper address for the channel type. If this is a command, then
300 * the message response comes back, the receive handler for this user
301 * will be called with the given msgid value in the recv msg. If this
302 * is a response to a command, then the msgid will be used as the
303 * sequence number for the response (truncated if necessary), so when
304 * sending a response you should use the sequence number you received
305 * in the msgid field of the received command. If the priority is >
306 * 0, the message will go into a high-priority queue and be sent
307 * first. Otherwise, it goes into a normal-priority queue.
308 * The user_msg_data field will be returned in any response to this
311 * Note that if you send a response (with the netfn lower bit set),
312 * you *will* get back a SEND_MSG response telling you what happened
313 * when the response was sent. You will not get back a response to
314 * the message itself.
316 int ipmi_request(ipmi_user_t user,
317 struct ipmi_addr *addr,
319 struct ipmi_msg *msg,
324 * Like ipmi_request, but lets you specify the number of retries and
325 * the retry time. The retries is the number of times the message
326 * will be resent if no reply is received. If set to -1, the default
327 * value will be used. The retry time is the time in milliseconds
328 * between retries. If set to zero, the default value will be
331 * Don't use this unless you *really* have to. It's primarily for the
332 * IPMI over LAN converter; since the LAN stuff does its own retries,
333 * it makes no sense to do it here. However, this can be used if you
334 * have unusual requirements.
336 int ipmi_request_settime(ipmi_user_t user,
337 struct ipmi_addr *addr,
339 struct ipmi_msg *msg,
343 unsigned int retry_time_ms);
346 * Like ipmi_request, but lets you specify the slave return address.
348 int ipmi_request_with_source(ipmi_user_t user,
349 struct ipmi_addr *addr,
351 struct ipmi_msg *msg,
354 unsigned char source_address,
355 unsigned char source_lun);
358 * Like ipmi_request, but with messages supplied. This will not
359 * allocate any memory, and the messages may be statically allocated
360 * (just make sure to do the "done" handling on them). Note that this
361 * is primarily for the watchdog timer, since it should be able to
362 * send messages even if no memory is available. This is subject to
363 * change as the system changes, so don't use it unless you REALLY
366 int ipmi_request_supply_msgs(ipmi_user_t user,
367 struct ipmi_addr *addr,
369 struct ipmi_msg *msg,
372 struct ipmi_recv_msg *supplied_recv,
376 * Do polling on the IPMI interface the user is attached to. This
377 * causes the IPMI code to do an immediate check for information from
378 * the driver and handle anything that is immediately pending. This
379 * will not block in anyway. This is useful if you need to implement
380 * polling from the user like you need to send periodic watchdog pings
381 * from a crash dump, or something like that.
383 void ipmi_poll_interface(ipmi_user_t user);
386 * When commands come in to the SMS, the user can register to receive
387 * them. Only one user can be listening on a specific netfn/cmd pair
388 * at a time, you will get an EBUSY error if the command is already
389 * registered. If a command is received that does not have a user
390 * registered, the driver will automatically return the proper
393 int ipmi_register_for_cmd(ipmi_user_t user,
396 int ipmi_unregister_for_cmd(ipmi_user_t user,
401 * When the user is created, it will not receive IPMI events by
402 * default. The user must set this to TRUE to get incoming events.
403 * The first user that sets this to TRUE will receive all events that
404 * have been queued while no one was waiting for events.
406 int ipmi_set_gets_events(ipmi_user_t user, int val);
409 * Register the given user to handle all received IPMI commands. This
410 * will fail if anyone is registered as a command receiver or if
411 * another is already registered to receive all commands. NOTE THAT
412 * THIS IS FOR EMULATION USERS ONLY, DO NOT USER THIS FOR NORMAL
415 int ipmi_register_all_cmd_rcvr(ipmi_user_t user);
416 int ipmi_unregister_all_cmd_rcvr(ipmi_user_t user);
420 * Called when a new SMI is registered. This will also be called on
421 * every existing interface when a new watcher is registered with
422 * ipmi_smi_watcher_register().
424 struct ipmi_smi_watcher
426 struct list_head link;
428 /* You must set the owner to the current module, if you are in
429 a module (generally just set it to "THIS_MODULE"). */
430 struct module *owner;
432 /* These two are called with read locks held for the interface
433 the watcher list. So you can add and remove users from the
434 IPMI interface, send messages, etc., but you cannot add
435 or remove SMI watchers or SMI interfaces. */
436 void (*new_smi)(int if_num);
437 void (*smi_gone)(int if_num);
440 int ipmi_smi_watcher_register(struct ipmi_smi_watcher *watcher);
441 int ipmi_smi_watcher_unregister(struct ipmi_smi_watcher *watcher);
443 /* The following are various helper functions for dealing with IPMI
446 /* Return the maximum length of an IPMI address given it's type. */
447 unsigned int ipmi_addr_length(int addr_type);
449 /* Validate that the given IPMI address is valid. */
450 int ipmi_validate_addr(struct ipmi_addr *addr, int len);
452 /* Return 1 if the given addresses are equal, 0 if not. */
453 int ipmi_addr_equal(struct ipmi_addr *addr1, struct ipmi_addr *addr2);
455 #endif /* __KERNEL__ */
459 * The userland interface
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.
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.
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).
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.
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.
494 /* The magic IOCTL value for this interface. */
495 #define IPMI_IOC_MAGIC 'i'
498 /* Messages sent to the interface are this format. */
501 unsigned char __user *addr; /* Address to send the message to. */
502 unsigned int addr_len;
504 long msgid; /* The sequence number for the message. This
505 exact value will be reported back in the
506 response to this request if it is a command.
507 If it is a response, this will be used as
508 the sequence value for the response. */
513 * Send a message to the interfaces. error values are:
514 * - EFAULT - an address supplied was invalid.
515 * - EINVAL - The address supplied was not valid, or the command
517 * - EMSGSIZE - The message to was too large.
518 * - ENOMEM - Buffers could not be allocated for the command.
520 #define IPMICTL_SEND_COMMAND _IOR(IPMI_IOC_MAGIC, 13, \
523 /* Messages sent to the interface with timing parameters are this
525 struct ipmi_req_settime
529 /* See ipmi_request_settime() above for details on these
532 unsigned int retry_time_ms;
535 * Send a message to the interfaces with timing parameters. error values
537 * - EFAULT - an address supplied was invalid.
538 * - EINVAL - The address supplied was not valid, or the command
540 * - EMSGSIZE - The message to was too large.
541 * - ENOMEM - Buffers could not be allocated for the command.
543 #define IPMICTL_SEND_COMMAND_SETTIME _IOR(IPMI_IOC_MAGIC, 21, \
544 struct ipmi_req_settime)
546 /* Messages received from the interface are this format. */
549 int recv_type; /* Is this a command, response or an
550 asyncronous event. */
552 unsigned char __user *addr; /* Address the message was from is put
553 here. The caller must supply the
555 unsigned int addr_len; /* The size of the address buffer.
556 The caller supplies the full buffer
557 length, this value is updated to
558 the actual message length when the
559 message is received. */
561 long msgid; /* The sequence number specified in the request
562 if this is a response. If this is a command,
563 this will be the sequence number from the
566 struct ipmi_msg msg; /* The data field must point to a buffer.
567 The data_size field must be set to the
568 size of the message buffer. The
569 caller supplies the full buffer
570 length, this value is updated to the
571 actual message length when the message
576 * Receive a message. error values:
577 * - EAGAIN - no messages in the queue.
578 * - EFAULT - an address supplied was invalid.
579 * - EINVAL - The address supplied was not valid.
580 * - EMSGSIZE - The message to was too large to fit into the message buffer,
581 * the message will be left in the buffer. */
582 #define IPMICTL_RECEIVE_MSG _IOWR(IPMI_IOC_MAGIC, 12, \
586 * Like RECEIVE_MSG, but if the message won't fit in the buffer, it
587 * will truncate the contents instead of leaving the data in the
590 #define IPMICTL_RECEIVE_MSG_TRUNC _IOWR(IPMI_IOC_MAGIC, 11, \
593 /* Register to get commands from other entities on this interface. */
601 * Register to receive a specific command. error values:
602 * - EFAULT - an address supplied was invalid.
603 * - EBUSY - The netfn/cmd supplied was already in use.
604 * - ENOMEM - could not allocate memory for the entry.
606 #define IPMICTL_REGISTER_FOR_CMD _IOR(IPMI_IOC_MAGIC, 14, \
609 * Unregister a regsitered command. error values:
610 * - EFAULT - an address supplied was invalid.
611 * - ENOENT - The netfn/cmd was not found registered for this user.
613 #define IPMICTL_UNREGISTER_FOR_CMD _IOR(IPMI_IOC_MAGIC, 15, \
617 * Set whether this interface receives events. Note that the first
618 * user registered for events will get all pending events for the
619 * interface. error values:
620 * - EFAULT - an address supplied was invalid.
622 #define IPMICTL_SET_GETS_EVENTS_CMD _IOR(IPMI_IOC_MAGIC, 16, int)
625 * Set and get the slave address and LUN that we will use for our
626 * source messages. Note that this affects the interface, not just
627 * this user, so it will affect all users of this interface. This is
628 * so some initialization code can come in and do the OEM-specific
629 * things it takes to determine your address (if not the BMC) and set
630 * it for everyone else. You should probably leave the LUN alone.
632 #define IPMICTL_SET_MY_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 17, unsigned int)
633 #define IPMICTL_GET_MY_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 18, unsigned int)
634 #define IPMICTL_SET_MY_LUN_CMD _IOR(IPMI_IOC_MAGIC, 19, unsigned int)
635 #define IPMICTL_GET_MY_LUN_CMD _IOR(IPMI_IOC_MAGIC, 20, unsigned int)
638 * Get/set the default timing values for an interface. You shouldn't
639 * generally mess with these.
641 struct ipmi_timing_parms
644 unsigned int retry_time_ms;
646 #define IPMICTL_SET_TIMING_PARMS_CMD _IOR(IPMI_IOC_MAGIC, 22, \
647 struct ipmi_timing_parms)
648 #define IPMICTL_GET_TIMING_PARMS_CMD _IOR(IPMI_IOC_MAGIC, 23, \
649 struct ipmi_timing_parms)
651 #endif /* __LINUX_IPMI_H */