4 * Incoming and outgoing message routing for an 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 #include <linux/module.h>
35 #include <linux/errno.h>
36 #include <asm/system.h>
37 #include <linux/poll.h>
38 #include <linux/sched.h>
39 #include <linux/spinlock.h>
40 #include <linux/mutex.h>
41 #include <linux/slab.h>
42 #include <linux/ipmi.h>
43 #include <linux/ipmi_smi.h>
44 #include <linux/notifier.h>
45 #include <linux/init.h>
46 #include <linux/proc_fs.h>
47 #include <linux/rcupdate.h>
49 #define PFX "IPMI message handler: "
51 #define IPMI_DRIVER_VERSION "39.2"
53 static struct ipmi_recv_msg *ipmi_alloc_recv_msg(void);
54 static int ipmi_init_msghandler(void);
56 static int initialized;
59 static struct proc_dir_entry *proc_ipmi_root;
60 #endif /* CONFIG_PROC_FS */
62 /* Remain in auto-maintenance mode for this amount of time (in ms). */
63 #define IPMI_MAINTENANCE_MODE_TIMEOUT 30000
65 #define MAX_EVENTS_IN_QUEUE 25
68 * Don't let a message sit in a queue forever, always time it with at lest
69 * the max message timer. This is in milliseconds.
71 #define MAX_MSG_TIMEOUT 60000
74 * The main "user" data structure.
77 struct list_head link;
79 /* Set to "0" when the user is destroyed. */
84 /* The upper layer that handles receive messages. */
85 struct ipmi_user_hndl *handler;
88 /* The interface this user is bound to. */
91 /* Does this interface receive IPMI events? */
96 struct list_head link;
104 * This is used to form a linked lised during mass deletion.
105 * Since this is in an RCU list, we cannot use the link above
106 * or change any data until the RCU period completes. So we
107 * use this next variable during mass deletion so we can have
108 * a list and don't have to wait and restart the search on
109 * every individual deletion of a command.
111 struct cmd_rcvr *next;
115 unsigned int inuse : 1;
116 unsigned int broadcast : 1;
118 unsigned long timeout;
119 unsigned long orig_timeout;
120 unsigned int retries_left;
123 * To verify on an incoming send message response that this is
124 * the message that the response is for, we keep a sequence id
125 * and increment it every time we send a message.
130 * This is held so we can properly respond to the message on a
131 * timeout, and it is used to hold the temporary data for
132 * retransmission, too.
134 struct ipmi_recv_msg *recv_msg;
138 * Store the information in a msgid (long) to allow us to find a
139 * sequence table entry from the msgid.
141 #define STORE_SEQ_IN_MSGID(seq, seqid) (((seq&0xff)<<26) | (seqid&0x3ffffff))
143 #define GET_SEQ_FROM_MSGID(msgid, seq, seqid) \
145 seq = ((msgid >> 26) & 0x3f); \
146 seqid = (msgid & 0x3fffff); \
149 #define NEXT_SEQID(seqid) (((seqid) + 1) & 0x3fffff)
151 struct ipmi_channel {
152 unsigned char medium;
153 unsigned char protocol;
156 * My slave address. This is initialized to IPMI_BMC_SLAVE_ADDR,
157 * but may be changed by the user.
159 unsigned char address;
162 * My LUN. This should generally stay the SMS LUN, but just in
168 #ifdef CONFIG_PROC_FS
169 struct ipmi_proc_entry {
171 struct ipmi_proc_entry *next;
176 struct platform_device *dev;
177 struct ipmi_device_id id;
178 unsigned char guid[16];
181 struct kref refcount;
183 /* bmc device attributes */
184 struct device_attribute device_id_attr;
185 struct device_attribute provides_dev_sdrs_attr;
186 struct device_attribute revision_attr;
187 struct device_attribute firmware_rev_attr;
188 struct device_attribute version_attr;
189 struct device_attribute add_dev_support_attr;
190 struct device_attribute manufacturer_id_attr;
191 struct device_attribute product_id_attr;
192 struct device_attribute guid_attr;
193 struct device_attribute aux_firmware_rev_attr;
197 * Various statistics for IPMI, these index stats[] in the ipmi_smi
200 enum ipmi_stat_indexes {
201 /* Commands we got from the user that were invalid. */
202 IPMI_STAT_sent_invalid_commands = 0,
204 /* Commands we sent to the MC. */
205 IPMI_STAT_sent_local_commands,
207 /* Responses from the MC that were delivered to a user. */
208 IPMI_STAT_handled_local_responses,
210 /* Responses from the MC that were not delivered to a user. */
211 IPMI_STAT_unhandled_local_responses,
213 /* Commands we sent out to the IPMB bus. */
214 IPMI_STAT_sent_ipmb_commands,
216 /* Commands sent on the IPMB that had errors on the SEND CMD */
217 IPMI_STAT_sent_ipmb_command_errs,
219 /* Each retransmit increments this count. */
220 IPMI_STAT_retransmitted_ipmb_commands,
223 * When a message times out (runs out of retransmits) this is
226 IPMI_STAT_timed_out_ipmb_commands,
229 * This is like above, but for broadcasts. Broadcasts are
230 * *not* included in the above count (they are expected to
233 IPMI_STAT_timed_out_ipmb_broadcasts,
235 /* Responses I have sent to the IPMB bus. */
236 IPMI_STAT_sent_ipmb_responses,
238 /* The response was delivered to the user. */
239 IPMI_STAT_handled_ipmb_responses,
241 /* The response had invalid data in it. */
242 IPMI_STAT_invalid_ipmb_responses,
244 /* The response didn't have anyone waiting for it. */
245 IPMI_STAT_unhandled_ipmb_responses,
247 /* Commands we sent out to the IPMB bus. */
248 IPMI_STAT_sent_lan_commands,
250 /* Commands sent on the IPMB that had errors on the SEND CMD */
251 IPMI_STAT_sent_lan_command_errs,
253 /* Each retransmit increments this count. */
254 IPMI_STAT_retransmitted_lan_commands,
257 * When a message times out (runs out of retransmits) this is
260 IPMI_STAT_timed_out_lan_commands,
262 /* Responses I have sent to the IPMB bus. */
263 IPMI_STAT_sent_lan_responses,
265 /* The response was delivered to the user. */
266 IPMI_STAT_handled_lan_responses,
268 /* The response had invalid data in it. */
269 IPMI_STAT_invalid_lan_responses,
271 /* The response didn't have anyone waiting for it. */
272 IPMI_STAT_unhandled_lan_responses,
274 /* The command was delivered to the user. */
275 IPMI_STAT_handled_commands,
277 /* The command had invalid data in it. */
278 IPMI_STAT_invalid_commands,
280 /* The command didn't have anyone waiting for it. */
281 IPMI_STAT_unhandled_commands,
283 /* Invalid data in an event. */
284 IPMI_STAT_invalid_events,
286 /* Events that were received with the proper format. */
289 /* Retransmissions on IPMB that failed. */
290 IPMI_STAT_dropped_rexmit_ipmb_commands,
292 /* Retransmissions on LAN that failed. */
293 IPMI_STAT_dropped_rexmit_lan_commands,
295 /* This *must* remain last, add new values above this. */
300 #define IPMI_IPMB_NUM_SEQ 64
301 #define IPMI_MAX_CHANNELS 16
303 /* What interface number are we? */
306 struct kref refcount;
308 /* Used for a list of interfaces. */
309 struct list_head link;
312 * The list of upper layers that are using me. seq_lock
315 struct list_head users;
317 /* Information to supply to users. */
318 unsigned char ipmi_version_major;
319 unsigned char ipmi_version_minor;
321 /* Used for wake ups at startup. */
322 wait_queue_head_t waitq;
324 struct bmc_device *bmc;
329 * This is the lower-layer's sender routine. Note that you
330 * must either be holding the ipmi_interfaces_mutex or be in
331 * an umpreemptible region to use this. You must fetch the
332 * value into a local variable and make sure it is not NULL.
334 struct ipmi_smi_handlers *handlers;
337 #ifdef CONFIG_PROC_FS
338 /* A list of proc entries for this interface. */
339 struct mutex proc_entry_lock;
340 struct ipmi_proc_entry *proc_entries;
343 /* Driver-model device for the system interface. */
344 struct device *si_dev;
347 * A table of sequence numbers for this interface. We use the
348 * sequence numbers for IPMB messages that go out of the
349 * interface to match them up with their responses. A routine
350 * is called periodically to time the items in this list.
353 struct seq_table seq_table[IPMI_IPMB_NUM_SEQ];
357 * Messages that were delayed for some reason (out of memory,
358 * for instance), will go in here to be processed later in a
359 * periodic timer interrupt.
361 spinlock_t waiting_msgs_lock;
362 struct list_head waiting_msgs;
365 * The list of command receivers that are registered for commands
368 struct mutex cmd_rcvrs_mutex;
369 struct list_head cmd_rcvrs;
372 * Events that were queues because no one was there to receive
375 spinlock_t events_lock; /* For dealing with event stuff. */
376 struct list_head waiting_events;
377 unsigned int waiting_events_count; /* How many events in queue? */
378 char delivering_events;
379 char event_msg_printed;
382 * The event receiver for my BMC, only really used at panic
383 * shutdown as a place to store this.
385 unsigned char event_receiver;
386 unsigned char event_receiver_lun;
387 unsigned char local_sel_device;
388 unsigned char local_event_generator;
390 /* For handling of maintenance mode. */
391 int maintenance_mode;
392 int maintenance_mode_enable;
393 int auto_maintenance_timeout;
394 spinlock_t maintenance_mode_lock; /* Used in a timer... */
397 * A cheap hack, if this is non-null and a message to an
398 * interface comes in with a NULL user, call this routine with
399 * it. Note that the message will still be freed by the
400 * caller. This only works on the system interface.
402 void (*null_user_handler)(ipmi_smi_t intf, struct ipmi_recv_msg *msg);
405 * When we are scanning the channels for an SMI, this will
406 * tell which channel we are scanning.
410 /* Channel information */
411 struct ipmi_channel channels[IPMI_MAX_CHANNELS];
414 struct proc_dir_entry *proc_dir;
415 char proc_dir_name[10];
417 atomic_t stats[IPMI_NUM_STATS];
420 * run_to_completion duplicate of smb_info, smi_info
421 * and ipmi_serial_info structures. Used to decrease numbers of
422 * parameters passed by "low" level IPMI code.
424 int run_to_completion;
426 #define to_si_intf_from_dev(device) container_of(device, struct ipmi_smi, dev)
429 * The driver model view of the IPMI messaging driver.
431 static struct platform_driver ipmidriver = {
434 .bus = &platform_bus_type
437 static DEFINE_MUTEX(ipmidriver_mutex);
439 static LIST_HEAD(ipmi_interfaces);
440 static DEFINE_MUTEX(ipmi_interfaces_mutex);
443 * List of watchers that want to know when smi's are added and deleted.
445 static LIST_HEAD(smi_watchers);
446 static DEFINE_MUTEX(smi_watchers_mutex);
449 #define ipmi_inc_stat(intf, stat) \
450 atomic_inc(&(intf)->stats[IPMI_STAT_ ## stat])
451 #define ipmi_get_stat(intf, stat) \
452 ((unsigned int) atomic_read(&(intf)->stats[IPMI_STAT_ ## stat]))
454 static int is_lan_addr(struct ipmi_addr *addr)
456 return addr->addr_type == IPMI_LAN_ADDR_TYPE;
459 static int is_ipmb_addr(struct ipmi_addr *addr)
461 return addr->addr_type == IPMI_IPMB_ADDR_TYPE;
464 static int is_ipmb_bcast_addr(struct ipmi_addr *addr)
466 return addr->addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE;
469 static void free_recv_msg_list(struct list_head *q)
471 struct ipmi_recv_msg *msg, *msg2;
473 list_for_each_entry_safe(msg, msg2, q, link) {
474 list_del(&msg->link);
475 ipmi_free_recv_msg(msg);
479 static void free_smi_msg_list(struct list_head *q)
481 struct ipmi_smi_msg *msg, *msg2;
483 list_for_each_entry_safe(msg, msg2, q, link) {
484 list_del(&msg->link);
485 ipmi_free_smi_msg(msg);
489 static void clean_up_interface_data(ipmi_smi_t intf)
492 struct cmd_rcvr *rcvr, *rcvr2;
493 struct list_head list;
495 free_smi_msg_list(&intf->waiting_msgs);
496 free_recv_msg_list(&intf->waiting_events);
499 * Wholesale remove all the entries from the list in the
500 * interface and wait for RCU to know that none are in use.
502 mutex_lock(&intf->cmd_rcvrs_mutex);
503 INIT_LIST_HEAD(&list);
504 list_splice_init_rcu(&intf->cmd_rcvrs, &list, synchronize_rcu);
505 mutex_unlock(&intf->cmd_rcvrs_mutex);
507 list_for_each_entry_safe(rcvr, rcvr2, &list, link)
510 for (i = 0; i < IPMI_IPMB_NUM_SEQ; i++) {
511 if ((intf->seq_table[i].inuse)
512 && (intf->seq_table[i].recv_msg))
513 ipmi_free_recv_msg(intf->seq_table[i].recv_msg);
517 static void intf_free(struct kref *ref)
519 ipmi_smi_t intf = container_of(ref, struct ipmi_smi, refcount);
521 clean_up_interface_data(intf);
525 struct watcher_entry {
528 struct list_head link;
531 int ipmi_smi_watcher_register(struct ipmi_smi_watcher *watcher)
534 LIST_HEAD(to_deliver);
535 struct watcher_entry *e, *e2;
537 mutex_lock(&smi_watchers_mutex);
539 mutex_lock(&ipmi_interfaces_mutex);
541 /* Build a list of things to deliver. */
542 list_for_each_entry(intf, &ipmi_interfaces, link) {
543 if (intf->intf_num == -1)
545 e = kmalloc(sizeof(*e), GFP_KERNEL);
548 kref_get(&intf->refcount);
550 e->intf_num = intf->intf_num;
551 list_add_tail(&e->link, &to_deliver);
554 /* We will succeed, so add it to the list. */
555 list_add(&watcher->link, &smi_watchers);
557 mutex_unlock(&ipmi_interfaces_mutex);
559 list_for_each_entry_safe(e, e2, &to_deliver, link) {
561 watcher->new_smi(e->intf_num, e->intf->si_dev);
562 kref_put(&e->intf->refcount, intf_free);
566 mutex_unlock(&smi_watchers_mutex);
571 mutex_unlock(&ipmi_interfaces_mutex);
572 mutex_unlock(&smi_watchers_mutex);
573 list_for_each_entry_safe(e, e2, &to_deliver, link) {
575 kref_put(&e->intf->refcount, intf_free);
580 EXPORT_SYMBOL(ipmi_smi_watcher_register);
582 int ipmi_smi_watcher_unregister(struct ipmi_smi_watcher *watcher)
584 mutex_lock(&smi_watchers_mutex);
585 list_del(&(watcher->link));
586 mutex_unlock(&smi_watchers_mutex);
589 EXPORT_SYMBOL(ipmi_smi_watcher_unregister);
592 * Must be called with smi_watchers_mutex held.
595 call_smi_watchers(int i, struct device *dev)
597 struct ipmi_smi_watcher *w;
599 list_for_each_entry(w, &smi_watchers, link) {
600 if (try_module_get(w->owner)) {
602 module_put(w->owner);
608 ipmi_addr_equal(struct ipmi_addr *addr1, struct ipmi_addr *addr2)
610 if (addr1->addr_type != addr2->addr_type)
613 if (addr1->channel != addr2->channel)
616 if (addr1->addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE) {
617 struct ipmi_system_interface_addr *smi_addr1
618 = (struct ipmi_system_interface_addr *) addr1;
619 struct ipmi_system_interface_addr *smi_addr2
620 = (struct ipmi_system_interface_addr *) addr2;
621 return (smi_addr1->lun == smi_addr2->lun);
624 if (is_ipmb_addr(addr1) || is_ipmb_bcast_addr(addr1)) {
625 struct ipmi_ipmb_addr *ipmb_addr1
626 = (struct ipmi_ipmb_addr *) addr1;
627 struct ipmi_ipmb_addr *ipmb_addr2
628 = (struct ipmi_ipmb_addr *) addr2;
630 return ((ipmb_addr1->slave_addr == ipmb_addr2->slave_addr)
631 && (ipmb_addr1->lun == ipmb_addr2->lun));
634 if (is_lan_addr(addr1)) {
635 struct ipmi_lan_addr *lan_addr1
636 = (struct ipmi_lan_addr *) addr1;
637 struct ipmi_lan_addr *lan_addr2
638 = (struct ipmi_lan_addr *) addr2;
640 return ((lan_addr1->remote_SWID == lan_addr2->remote_SWID)
641 && (lan_addr1->local_SWID == lan_addr2->local_SWID)
642 && (lan_addr1->session_handle
643 == lan_addr2->session_handle)
644 && (lan_addr1->lun == lan_addr2->lun));
650 int ipmi_validate_addr(struct ipmi_addr *addr, int len)
652 if (len < sizeof(struct ipmi_system_interface_addr))
655 if (addr->addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE) {
656 if (addr->channel != IPMI_BMC_CHANNEL)
661 if ((addr->channel == IPMI_BMC_CHANNEL)
662 || (addr->channel >= IPMI_MAX_CHANNELS)
663 || (addr->channel < 0))
666 if (is_ipmb_addr(addr) || is_ipmb_bcast_addr(addr)) {
667 if (len < sizeof(struct ipmi_ipmb_addr))
672 if (is_lan_addr(addr)) {
673 if (len < sizeof(struct ipmi_lan_addr))
680 EXPORT_SYMBOL(ipmi_validate_addr);
682 unsigned int ipmi_addr_length(int addr_type)
684 if (addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
685 return sizeof(struct ipmi_system_interface_addr);
687 if ((addr_type == IPMI_IPMB_ADDR_TYPE)
688 || (addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE))
689 return sizeof(struct ipmi_ipmb_addr);
691 if (addr_type == IPMI_LAN_ADDR_TYPE)
692 return sizeof(struct ipmi_lan_addr);
696 EXPORT_SYMBOL(ipmi_addr_length);
698 static void deliver_response(struct ipmi_recv_msg *msg)
701 ipmi_smi_t intf = msg->user_msg_data;
703 /* Special handling for NULL users. */
704 if (intf->null_user_handler) {
705 intf->null_user_handler(intf, msg);
706 ipmi_inc_stat(intf, handled_local_responses);
708 /* No handler, so give up. */
709 ipmi_inc_stat(intf, unhandled_local_responses);
711 ipmi_free_recv_msg(msg);
713 ipmi_user_t user = msg->user;
714 user->handler->ipmi_recv_hndl(msg, user->handler_data);
719 deliver_err_response(struct ipmi_recv_msg *msg, int err)
721 msg->recv_type = IPMI_RESPONSE_RECV_TYPE;
722 msg->msg_data[0] = err;
723 msg->msg.netfn |= 1; /* Convert to a response. */
724 msg->msg.data_len = 1;
725 msg->msg.data = msg->msg_data;
726 deliver_response(msg);
730 * Find the next sequence number not being used and add the given
731 * message with the given timeout to the sequence table. This must be
732 * called with the interface's seq_lock held.
734 static int intf_next_seq(ipmi_smi_t intf,
735 struct ipmi_recv_msg *recv_msg,
736 unsigned long timeout,
745 for (i = intf->curr_seq; (i+1)%IPMI_IPMB_NUM_SEQ != intf->curr_seq;
746 i = (i+1)%IPMI_IPMB_NUM_SEQ) {
747 if (!intf->seq_table[i].inuse)
751 if (!intf->seq_table[i].inuse) {
752 intf->seq_table[i].recv_msg = recv_msg;
755 * Start with the maximum timeout, when the send response
756 * comes in we will start the real timer.
758 intf->seq_table[i].timeout = MAX_MSG_TIMEOUT;
759 intf->seq_table[i].orig_timeout = timeout;
760 intf->seq_table[i].retries_left = retries;
761 intf->seq_table[i].broadcast = broadcast;
762 intf->seq_table[i].inuse = 1;
763 intf->seq_table[i].seqid = NEXT_SEQID(intf->seq_table[i].seqid);
765 *seqid = intf->seq_table[i].seqid;
766 intf->curr_seq = (i+1)%IPMI_IPMB_NUM_SEQ;
775 * Return the receive message for the given sequence number and
776 * release the sequence number so it can be reused. Some other data
777 * is passed in to be sure the message matches up correctly (to help
778 * guard against message coming in after their timeout and the
779 * sequence number being reused).
781 static int intf_find_seq(ipmi_smi_t intf,
786 struct ipmi_addr *addr,
787 struct ipmi_recv_msg **recv_msg)
792 if (seq >= IPMI_IPMB_NUM_SEQ)
795 spin_lock_irqsave(&(intf->seq_lock), flags);
796 if (intf->seq_table[seq].inuse) {
797 struct ipmi_recv_msg *msg = intf->seq_table[seq].recv_msg;
799 if ((msg->addr.channel == channel) && (msg->msg.cmd == cmd)
800 && (msg->msg.netfn == netfn)
801 && (ipmi_addr_equal(addr, &(msg->addr)))) {
803 intf->seq_table[seq].inuse = 0;
807 spin_unlock_irqrestore(&(intf->seq_lock), flags);
813 /* Start the timer for a specific sequence table entry. */
814 static int intf_start_seq_timer(ipmi_smi_t intf,
823 GET_SEQ_FROM_MSGID(msgid, seq, seqid);
825 spin_lock_irqsave(&(intf->seq_lock), flags);
827 * We do this verification because the user can be deleted
828 * while a message is outstanding.
830 if ((intf->seq_table[seq].inuse)
831 && (intf->seq_table[seq].seqid == seqid)) {
832 struct seq_table *ent = &(intf->seq_table[seq]);
833 ent->timeout = ent->orig_timeout;
836 spin_unlock_irqrestore(&(intf->seq_lock), flags);
841 /* Got an error for the send message for a specific sequence number. */
842 static int intf_err_seq(ipmi_smi_t intf,
850 struct ipmi_recv_msg *msg = NULL;
853 GET_SEQ_FROM_MSGID(msgid, seq, seqid);
855 spin_lock_irqsave(&(intf->seq_lock), flags);
857 * We do this verification because the user can be deleted
858 * while a message is outstanding.
860 if ((intf->seq_table[seq].inuse)
861 && (intf->seq_table[seq].seqid == seqid)) {
862 struct seq_table *ent = &(intf->seq_table[seq]);
868 spin_unlock_irqrestore(&(intf->seq_lock), flags);
871 deliver_err_response(msg, err);
877 int ipmi_create_user(unsigned int if_num,
878 struct ipmi_user_hndl *handler,
883 ipmi_user_t new_user;
888 * There is no module usecount here, because it's not
889 * required. Since this can only be used by and called from
890 * other modules, they will implicitly use this module, and
891 * thus this can't be removed unless the other modules are
899 * Make sure the driver is actually initialized, this handles
900 * problems with initialization order.
903 rv = ipmi_init_msghandler();
908 * The init code doesn't return an error if it was turned
909 * off, but it won't initialize. Check that.
915 new_user = kmalloc(sizeof(*new_user), GFP_KERNEL);
919 mutex_lock(&ipmi_interfaces_mutex);
920 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
921 if (intf->intf_num == if_num)
924 /* Not found, return an error */
929 /* Note that each existing user holds a refcount to the interface. */
930 kref_get(&intf->refcount);
932 kref_init(&new_user->refcount);
933 new_user->handler = handler;
934 new_user->handler_data = handler_data;
935 new_user->intf = intf;
936 new_user->gets_events = 0;
938 if (!try_module_get(intf->handlers->owner)) {
943 if (intf->handlers->inc_usecount) {
944 rv = intf->handlers->inc_usecount(intf->send_info);
946 module_put(intf->handlers->owner);
952 * Hold the lock so intf->handlers is guaranteed to be good
955 mutex_unlock(&ipmi_interfaces_mutex);
958 spin_lock_irqsave(&intf->seq_lock, flags);
959 list_add_rcu(&new_user->link, &intf->users);
960 spin_unlock_irqrestore(&intf->seq_lock, flags);
965 kref_put(&intf->refcount, intf_free);
967 mutex_unlock(&ipmi_interfaces_mutex);
971 EXPORT_SYMBOL(ipmi_create_user);
973 static void free_user(struct kref *ref)
975 ipmi_user_t user = container_of(ref, struct ipmi_user, refcount);
979 int ipmi_destroy_user(ipmi_user_t user)
981 ipmi_smi_t intf = user->intf;
984 struct cmd_rcvr *rcvr;
985 struct cmd_rcvr *rcvrs = NULL;
989 /* Remove the user from the interface's sequence table. */
990 spin_lock_irqsave(&intf->seq_lock, flags);
991 list_del_rcu(&user->link);
993 for (i = 0; i < IPMI_IPMB_NUM_SEQ; i++) {
994 if (intf->seq_table[i].inuse
995 && (intf->seq_table[i].recv_msg->user == user)) {
996 intf->seq_table[i].inuse = 0;
997 ipmi_free_recv_msg(intf->seq_table[i].recv_msg);
1000 spin_unlock_irqrestore(&intf->seq_lock, flags);
1003 * Remove the user from the command receiver's table. First
1004 * we build a list of everything (not using the standard link,
1005 * since other things may be using it till we do
1006 * synchronize_rcu()) then free everything in that list.
1008 mutex_lock(&intf->cmd_rcvrs_mutex);
1009 list_for_each_entry_rcu(rcvr, &intf->cmd_rcvrs, link) {
1010 if (rcvr->user == user) {
1011 list_del_rcu(&rcvr->link);
1016 mutex_unlock(&intf->cmd_rcvrs_mutex);
1024 mutex_lock(&ipmi_interfaces_mutex);
1025 if (intf->handlers) {
1026 module_put(intf->handlers->owner);
1027 if (intf->handlers->dec_usecount)
1028 intf->handlers->dec_usecount(intf->send_info);
1030 mutex_unlock(&ipmi_interfaces_mutex);
1032 kref_put(&intf->refcount, intf_free);
1034 kref_put(&user->refcount, free_user);
1038 EXPORT_SYMBOL(ipmi_destroy_user);
1040 void ipmi_get_version(ipmi_user_t user,
1041 unsigned char *major,
1042 unsigned char *minor)
1044 *major = user->intf->ipmi_version_major;
1045 *minor = user->intf->ipmi_version_minor;
1047 EXPORT_SYMBOL(ipmi_get_version);
1049 int ipmi_set_my_address(ipmi_user_t user,
1050 unsigned int channel,
1051 unsigned char address)
1053 if (channel >= IPMI_MAX_CHANNELS)
1055 user->intf->channels[channel].address = address;
1058 EXPORT_SYMBOL(ipmi_set_my_address);
1060 int ipmi_get_my_address(ipmi_user_t user,
1061 unsigned int channel,
1062 unsigned char *address)
1064 if (channel >= IPMI_MAX_CHANNELS)
1066 *address = user->intf->channels[channel].address;
1069 EXPORT_SYMBOL(ipmi_get_my_address);
1071 int ipmi_set_my_LUN(ipmi_user_t user,
1072 unsigned int channel,
1075 if (channel >= IPMI_MAX_CHANNELS)
1077 user->intf->channels[channel].lun = LUN & 0x3;
1080 EXPORT_SYMBOL(ipmi_set_my_LUN);
1082 int ipmi_get_my_LUN(ipmi_user_t user,
1083 unsigned int channel,
1084 unsigned char *address)
1086 if (channel >= IPMI_MAX_CHANNELS)
1088 *address = user->intf->channels[channel].lun;
1091 EXPORT_SYMBOL(ipmi_get_my_LUN);
1093 int ipmi_get_maintenance_mode(ipmi_user_t user)
1096 unsigned long flags;
1098 spin_lock_irqsave(&user->intf->maintenance_mode_lock, flags);
1099 mode = user->intf->maintenance_mode;
1100 spin_unlock_irqrestore(&user->intf->maintenance_mode_lock, flags);
1104 EXPORT_SYMBOL(ipmi_get_maintenance_mode);
1106 static void maintenance_mode_update(ipmi_smi_t intf)
1108 if (intf->handlers->set_maintenance_mode)
1109 intf->handlers->set_maintenance_mode(
1110 intf->send_info, intf->maintenance_mode_enable);
1113 int ipmi_set_maintenance_mode(ipmi_user_t user, int mode)
1116 unsigned long flags;
1117 ipmi_smi_t intf = user->intf;
1119 spin_lock_irqsave(&intf->maintenance_mode_lock, flags);
1120 if (intf->maintenance_mode != mode) {
1122 case IPMI_MAINTENANCE_MODE_AUTO:
1123 intf->maintenance_mode = mode;
1124 intf->maintenance_mode_enable
1125 = (intf->auto_maintenance_timeout > 0);
1128 case IPMI_MAINTENANCE_MODE_OFF:
1129 intf->maintenance_mode = mode;
1130 intf->maintenance_mode_enable = 0;
1133 case IPMI_MAINTENANCE_MODE_ON:
1134 intf->maintenance_mode = mode;
1135 intf->maintenance_mode_enable = 1;
1143 maintenance_mode_update(intf);
1146 spin_unlock_irqrestore(&intf->maintenance_mode_lock, flags);
1150 EXPORT_SYMBOL(ipmi_set_maintenance_mode);
1152 int ipmi_set_gets_events(ipmi_user_t user, int val)
1154 unsigned long flags;
1155 ipmi_smi_t intf = user->intf;
1156 struct ipmi_recv_msg *msg, *msg2;
1157 struct list_head msgs;
1159 INIT_LIST_HEAD(&msgs);
1161 spin_lock_irqsave(&intf->events_lock, flags);
1162 user->gets_events = val;
1164 if (intf->delivering_events)
1166 * Another thread is delivering events for this, so
1167 * let it handle any new events.
1171 /* Deliver any queued events. */
1172 while (user->gets_events && !list_empty(&intf->waiting_events)) {
1173 list_for_each_entry_safe(msg, msg2, &intf->waiting_events, link)
1174 list_move_tail(&msg->link, &msgs);
1175 intf->waiting_events_count = 0;
1176 if (intf->event_msg_printed) {
1177 printk(KERN_WARNING PFX "Event queue no longer"
1179 intf->event_msg_printed = 0;
1182 intf->delivering_events = 1;
1183 spin_unlock_irqrestore(&intf->events_lock, flags);
1185 list_for_each_entry_safe(msg, msg2, &msgs, link) {
1187 kref_get(&user->refcount);
1188 deliver_response(msg);
1191 spin_lock_irqsave(&intf->events_lock, flags);
1192 intf->delivering_events = 0;
1196 spin_unlock_irqrestore(&intf->events_lock, flags);
1200 EXPORT_SYMBOL(ipmi_set_gets_events);
1202 static struct cmd_rcvr *find_cmd_rcvr(ipmi_smi_t intf,
1203 unsigned char netfn,
1207 struct cmd_rcvr *rcvr;
1209 list_for_each_entry_rcu(rcvr, &intf->cmd_rcvrs, link) {
1210 if ((rcvr->netfn == netfn) && (rcvr->cmd == cmd)
1211 && (rcvr->chans & (1 << chan)))
1217 static int is_cmd_rcvr_exclusive(ipmi_smi_t intf,
1218 unsigned char netfn,
1222 struct cmd_rcvr *rcvr;
1224 list_for_each_entry_rcu(rcvr, &intf->cmd_rcvrs, link) {
1225 if ((rcvr->netfn == netfn) && (rcvr->cmd == cmd)
1226 && (rcvr->chans & chans))
1232 int ipmi_register_for_cmd(ipmi_user_t user,
1233 unsigned char netfn,
1237 ipmi_smi_t intf = user->intf;
1238 struct cmd_rcvr *rcvr;
1242 rcvr = kmalloc(sizeof(*rcvr), GFP_KERNEL);
1246 rcvr->netfn = netfn;
1247 rcvr->chans = chans;
1250 mutex_lock(&intf->cmd_rcvrs_mutex);
1251 /* Make sure the command/netfn is not already registered. */
1252 if (!is_cmd_rcvr_exclusive(intf, netfn, cmd, chans)) {
1257 list_add_rcu(&rcvr->link, &intf->cmd_rcvrs);
1260 mutex_unlock(&intf->cmd_rcvrs_mutex);
1266 EXPORT_SYMBOL(ipmi_register_for_cmd);
1268 int ipmi_unregister_for_cmd(ipmi_user_t user,
1269 unsigned char netfn,
1273 ipmi_smi_t intf = user->intf;
1274 struct cmd_rcvr *rcvr;
1275 struct cmd_rcvr *rcvrs = NULL;
1276 int i, rv = -ENOENT;
1278 mutex_lock(&intf->cmd_rcvrs_mutex);
1279 for (i = 0; i < IPMI_NUM_CHANNELS; i++) {
1280 if (((1 << i) & chans) == 0)
1282 rcvr = find_cmd_rcvr(intf, netfn, cmd, i);
1285 if (rcvr->user == user) {
1287 rcvr->chans &= ~chans;
1288 if (rcvr->chans == 0) {
1289 list_del_rcu(&rcvr->link);
1295 mutex_unlock(&intf->cmd_rcvrs_mutex);
1304 EXPORT_SYMBOL(ipmi_unregister_for_cmd);
1306 static unsigned char
1307 ipmb_checksum(unsigned char *data, int size)
1309 unsigned char csum = 0;
1311 for (; size > 0; size--, data++)
1317 static inline void format_ipmb_msg(struct ipmi_smi_msg *smi_msg,
1318 struct kernel_ipmi_msg *msg,
1319 struct ipmi_ipmb_addr *ipmb_addr,
1321 unsigned char ipmb_seq,
1323 unsigned char source_address,
1324 unsigned char source_lun)
1328 /* Format the IPMB header data. */
1329 smi_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
1330 smi_msg->data[1] = IPMI_SEND_MSG_CMD;
1331 smi_msg->data[2] = ipmb_addr->channel;
1333 smi_msg->data[3] = 0;
1334 smi_msg->data[i+3] = ipmb_addr->slave_addr;
1335 smi_msg->data[i+4] = (msg->netfn << 2) | (ipmb_addr->lun & 0x3);
1336 smi_msg->data[i+5] = ipmb_checksum(&(smi_msg->data[i+3]), 2);
1337 smi_msg->data[i+6] = source_address;
1338 smi_msg->data[i+7] = (ipmb_seq << 2) | source_lun;
1339 smi_msg->data[i+8] = msg->cmd;
1341 /* Now tack on the data to the message. */
1342 if (msg->data_len > 0)
1343 memcpy(&(smi_msg->data[i+9]), msg->data,
1345 smi_msg->data_size = msg->data_len + 9;
1347 /* Now calculate the checksum and tack it on. */
1348 smi_msg->data[i+smi_msg->data_size]
1349 = ipmb_checksum(&(smi_msg->data[i+6]),
1350 smi_msg->data_size-6);
1353 * Add on the checksum size and the offset from the
1356 smi_msg->data_size += 1 + i;
1358 smi_msg->msgid = msgid;
1361 static inline void format_lan_msg(struct ipmi_smi_msg *smi_msg,
1362 struct kernel_ipmi_msg *msg,
1363 struct ipmi_lan_addr *lan_addr,
1365 unsigned char ipmb_seq,
1366 unsigned char source_lun)
1368 /* Format the IPMB header data. */
1369 smi_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
1370 smi_msg->data[1] = IPMI_SEND_MSG_CMD;
1371 smi_msg->data[2] = lan_addr->channel;
1372 smi_msg->data[3] = lan_addr->session_handle;
1373 smi_msg->data[4] = lan_addr->remote_SWID;
1374 smi_msg->data[5] = (msg->netfn << 2) | (lan_addr->lun & 0x3);
1375 smi_msg->data[6] = ipmb_checksum(&(smi_msg->data[4]), 2);
1376 smi_msg->data[7] = lan_addr->local_SWID;
1377 smi_msg->data[8] = (ipmb_seq << 2) | source_lun;
1378 smi_msg->data[9] = msg->cmd;
1380 /* Now tack on the data to the message. */
1381 if (msg->data_len > 0)
1382 memcpy(&(smi_msg->data[10]), msg->data,
1384 smi_msg->data_size = msg->data_len + 10;
1386 /* Now calculate the checksum and tack it on. */
1387 smi_msg->data[smi_msg->data_size]
1388 = ipmb_checksum(&(smi_msg->data[7]),
1389 smi_msg->data_size-7);
1392 * Add on the checksum size and the offset from the
1395 smi_msg->data_size += 1;
1397 smi_msg->msgid = msgid;
1401 * Separate from ipmi_request so that the user does not have to be
1402 * supplied in certain circumstances (mainly at panic time). If
1403 * messages are supplied, they will be freed, even if an error
1406 static int i_ipmi_request(ipmi_user_t user,
1408 struct ipmi_addr *addr,
1410 struct kernel_ipmi_msg *msg,
1411 void *user_msg_data,
1413 struct ipmi_recv_msg *supplied_recv,
1415 unsigned char source_address,
1416 unsigned char source_lun,
1418 unsigned int retry_time_ms)
1421 struct ipmi_smi_msg *smi_msg;
1422 struct ipmi_recv_msg *recv_msg;
1423 unsigned long flags;
1424 struct ipmi_smi_handlers *handlers;
1428 recv_msg = supplied_recv;
1430 recv_msg = ipmi_alloc_recv_msg();
1431 if (recv_msg == NULL)
1434 recv_msg->user_msg_data = user_msg_data;
1437 smi_msg = (struct ipmi_smi_msg *) supplied_smi;
1439 smi_msg = ipmi_alloc_smi_msg();
1440 if (smi_msg == NULL) {
1441 ipmi_free_recv_msg(recv_msg);
1447 handlers = intf->handlers;
1453 recv_msg->user = user;
1455 kref_get(&user->refcount);
1456 recv_msg->msgid = msgid;
1458 * Store the message to send in the receive message so timeout
1459 * responses can get the proper response data.
1461 recv_msg->msg = *msg;
1463 if (addr->addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE) {
1464 struct ipmi_system_interface_addr *smi_addr;
1466 if (msg->netfn & 1) {
1467 /* Responses are not allowed to the SMI. */
1472 smi_addr = (struct ipmi_system_interface_addr *) addr;
1473 if (smi_addr->lun > 3) {
1474 ipmi_inc_stat(intf, sent_invalid_commands);
1479 memcpy(&recv_msg->addr, smi_addr, sizeof(*smi_addr));
1481 if ((msg->netfn == IPMI_NETFN_APP_REQUEST)
1482 && ((msg->cmd == IPMI_SEND_MSG_CMD)
1483 || (msg->cmd == IPMI_GET_MSG_CMD)
1484 || (msg->cmd == IPMI_READ_EVENT_MSG_BUFFER_CMD))) {
1486 * We don't let the user do these, since we manage
1487 * the sequence numbers.
1489 ipmi_inc_stat(intf, sent_invalid_commands);
1494 if (((msg->netfn == IPMI_NETFN_APP_REQUEST)
1495 && ((msg->cmd == IPMI_COLD_RESET_CMD)
1496 || (msg->cmd == IPMI_WARM_RESET_CMD)))
1497 || (msg->netfn == IPMI_NETFN_FIRMWARE_REQUEST)) {
1498 spin_lock_irqsave(&intf->maintenance_mode_lock, flags);
1499 intf->auto_maintenance_timeout
1500 = IPMI_MAINTENANCE_MODE_TIMEOUT;
1501 if (!intf->maintenance_mode
1502 && !intf->maintenance_mode_enable) {
1503 intf->maintenance_mode_enable = 1;
1504 maintenance_mode_update(intf);
1506 spin_unlock_irqrestore(&intf->maintenance_mode_lock,
1510 if ((msg->data_len + 2) > IPMI_MAX_MSG_LENGTH) {
1511 ipmi_inc_stat(intf, sent_invalid_commands);
1516 smi_msg->data[0] = (msg->netfn << 2) | (smi_addr->lun & 0x3);
1517 smi_msg->data[1] = msg->cmd;
1518 smi_msg->msgid = msgid;
1519 smi_msg->user_data = recv_msg;
1520 if (msg->data_len > 0)
1521 memcpy(&(smi_msg->data[2]), msg->data, msg->data_len);
1522 smi_msg->data_size = msg->data_len + 2;
1523 ipmi_inc_stat(intf, sent_local_commands);
1524 } else if (is_ipmb_addr(addr) || is_ipmb_bcast_addr(addr)) {
1525 struct ipmi_ipmb_addr *ipmb_addr;
1526 unsigned char ipmb_seq;
1530 if (addr->channel >= IPMI_MAX_CHANNELS) {
1531 ipmi_inc_stat(intf, sent_invalid_commands);
1536 if (intf->channels[addr->channel].medium
1537 != IPMI_CHANNEL_MEDIUM_IPMB) {
1538 ipmi_inc_stat(intf, sent_invalid_commands);
1544 if (addr->addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE)
1545 retries = 0; /* Don't retry broadcasts. */
1549 if (addr->addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE) {
1551 * Broadcasts add a zero at the beginning of the
1552 * message, but otherwise is the same as an IPMB
1555 addr->addr_type = IPMI_IPMB_ADDR_TYPE;
1560 /* Default to 1 second retries. */
1561 if (retry_time_ms == 0)
1562 retry_time_ms = 1000;
1565 * 9 for the header and 1 for the checksum, plus
1566 * possibly one for the broadcast.
1568 if ((msg->data_len + 10 + broadcast) > IPMI_MAX_MSG_LENGTH) {
1569 ipmi_inc_stat(intf, sent_invalid_commands);
1574 ipmb_addr = (struct ipmi_ipmb_addr *) addr;
1575 if (ipmb_addr->lun > 3) {
1576 ipmi_inc_stat(intf, sent_invalid_commands);
1581 memcpy(&recv_msg->addr, ipmb_addr, sizeof(*ipmb_addr));
1583 if (recv_msg->msg.netfn & 0x1) {
1585 * It's a response, so use the user's sequence
1588 ipmi_inc_stat(intf, sent_ipmb_responses);
1589 format_ipmb_msg(smi_msg, msg, ipmb_addr, msgid,
1591 source_address, source_lun);
1594 * Save the receive message so we can use it
1595 * to deliver the response.
1597 smi_msg->user_data = recv_msg;
1599 /* It's a command, so get a sequence for it. */
1601 spin_lock_irqsave(&(intf->seq_lock), flags);
1604 * Create a sequence number with a 1 second
1605 * timeout and 4 retries.
1607 rv = intf_next_seq(intf,
1616 * We have used up all the sequence numbers,
1617 * probably, so abort.
1619 spin_unlock_irqrestore(&(intf->seq_lock),
1624 ipmi_inc_stat(intf, sent_ipmb_commands);
1627 * Store the sequence number in the message,
1628 * so that when the send message response
1629 * comes back we can start the timer.
1631 format_ipmb_msg(smi_msg, msg, ipmb_addr,
1632 STORE_SEQ_IN_MSGID(ipmb_seq, seqid),
1633 ipmb_seq, broadcast,
1634 source_address, source_lun);
1637 * Copy the message into the recv message data, so we
1638 * can retransmit it later if necessary.
1640 memcpy(recv_msg->msg_data, smi_msg->data,
1641 smi_msg->data_size);
1642 recv_msg->msg.data = recv_msg->msg_data;
1643 recv_msg->msg.data_len = smi_msg->data_size;
1646 * We don't unlock until here, because we need
1647 * to copy the completed message into the
1648 * recv_msg before we release the lock.
1649 * Otherwise, race conditions may bite us. I
1650 * know that's pretty paranoid, but I prefer
1653 spin_unlock_irqrestore(&(intf->seq_lock), flags);
1655 } else if (is_lan_addr(addr)) {
1656 struct ipmi_lan_addr *lan_addr;
1657 unsigned char ipmb_seq;
1660 if (addr->channel >= IPMI_MAX_CHANNELS) {
1661 ipmi_inc_stat(intf, sent_invalid_commands);
1666 if ((intf->channels[addr->channel].medium
1667 != IPMI_CHANNEL_MEDIUM_8023LAN)
1668 && (intf->channels[addr->channel].medium
1669 != IPMI_CHANNEL_MEDIUM_ASYNC)) {
1670 ipmi_inc_stat(intf, sent_invalid_commands);
1677 /* Default to 1 second retries. */
1678 if (retry_time_ms == 0)
1679 retry_time_ms = 1000;
1681 /* 11 for the header and 1 for the checksum. */
1682 if ((msg->data_len + 12) > IPMI_MAX_MSG_LENGTH) {
1683 ipmi_inc_stat(intf, sent_invalid_commands);
1688 lan_addr = (struct ipmi_lan_addr *) addr;
1689 if (lan_addr->lun > 3) {
1690 ipmi_inc_stat(intf, sent_invalid_commands);
1695 memcpy(&recv_msg->addr, lan_addr, sizeof(*lan_addr));
1697 if (recv_msg->msg.netfn & 0x1) {
1699 * It's a response, so use the user's sequence
1702 ipmi_inc_stat(intf, sent_lan_responses);
1703 format_lan_msg(smi_msg, msg, lan_addr, msgid,
1707 * Save the receive message so we can use it
1708 * to deliver the response.
1710 smi_msg->user_data = recv_msg;
1712 /* It's a command, so get a sequence for it. */
1714 spin_lock_irqsave(&(intf->seq_lock), flags);
1717 * Create a sequence number with a 1 second
1718 * timeout and 4 retries.
1720 rv = intf_next_seq(intf,
1729 * We have used up all the sequence numbers,
1730 * probably, so abort.
1732 spin_unlock_irqrestore(&(intf->seq_lock),
1737 ipmi_inc_stat(intf, sent_lan_commands);
1740 * Store the sequence number in the message,
1741 * so that when the send message response
1742 * comes back we can start the timer.
1744 format_lan_msg(smi_msg, msg, lan_addr,
1745 STORE_SEQ_IN_MSGID(ipmb_seq, seqid),
1746 ipmb_seq, source_lun);
1749 * Copy the message into the recv message data, so we
1750 * can retransmit it later if necessary.
1752 memcpy(recv_msg->msg_data, smi_msg->data,
1753 smi_msg->data_size);
1754 recv_msg->msg.data = recv_msg->msg_data;
1755 recv_msg->msg.data_len = smi_msg->data_size;
1758 * We don't unlock until here, because we need
1759 * to copy the completed message into the
1760 * recv_msg before we release the lock.
1761 * Otherwise, race conditions may bite us. I
1762 * know that's pretty paranoid, but I prefer
1765 spin_unlock_irqrestore(&(intf->seq_lock), flags);
1768 /* Unknown address type. */
1769 ipmi_inc_stat(intf, sent_invalid_commands);
1777 for (m = 0; m < smi_msg->data_size; m++)
1778 printk(" %2.2x", smi_msg->data[m]);
1783 handlers->sender(intf->send_info, smi_msg, priority);
1790 ipmi_free_smi_msg(smi_msg);
1791 ipmi_free_recv_msg(recv_msg);
1795 static int check_addr(ipmi_smi_t intf,
1796 struct ipmi_addr *addr,
1797 unsigned char *saddr,
1800 if (addr->channel >= IPMI_MAX_CHANNELS)
1802 *lun = intf->channels[addr->channel].lun;
1803 *saddr = intf->channels[addr->channel].address;
1807 int ipmi_request_settime(ipmi_user_t user,
1808 struct ipmi_addr *addr,
1810 struct kernel_ipmi_msg *msg,
1811 void *user_msg_data,
1814 unsigned int retry_time_ms)
1816 unsigned char saddr, lun;
1821 rv = check_addr(user->intf, addr, &saddr, &lun);
1824 return i_ipmi_request(user,
1837 EXPORT_SYMBOL(ipmi_request_settime);
1839 int ipmi_request_supply_msgs(ipmi_user_t user,
1840 struct ipmi_addr *addr,
1842 struct kernel_ipmi_msg *msg,
1843 void *user_msg_data,
1845 struct ipmi_recv_msg *supplied_recv,
1848 unsigned char saddr, lun;
1853 rv = check_addr(user->intf, addr, &saddr, &lun);
1856 return i_ipmi_request(user,
1869 EXPORT_SYMBOL(ipmi_request_supply_msgs);
1871 #ifdef CONFIG_PROC_FS
1872 static int ipmb_file_read_proc(char *page, char **start, off_t off,
1873 int count, int *eof, void *data)
1875 char *out = (char *) page;
1876 ipmi_smi_t intf = data;
1880 for (i = 0; i < IPMI_MAX_CHANNELS; i++)
1881 rv += sprintf(out+rv, "%x ", intf->channels[i].address);
1882 out[rv-1] = '\n'; /* Replace the final space with a newline */
1888 static int version_file_read_proc(char *page, char **start, off_t off,
1889 int count, int *eof, void *data)
1891 char *out = (char *) page;
1892 ipmi_smi_t intf = data;
1894 return sprintf(out, "%u.%u\n",
1895 ipmi_version_major(&intf->bmc->id),
1896 ipmi_version_minor(&intf->bmc->id));
1899 static int stat_file_read_proc(char *page, char **start, off_t off,
1900 int count, int *eof, void *data)
1902 char *out = (char *) page;
1903 ipmi_smi_t intf = data;
1905 out += sprintf(out, "sent_invalid_commands: %u\n",
1906 ipmi_get_stat(intf, sent_invalid_commands));
1907 out += sprintf(out, "sent_local_commands: %u\n",
1908 ipmi_get_stat(intf, sent_local_commands));
1909 out += sprintf(out, "handled_local_responses: %u\n",
1910 ipmi_get_stat(intf, handled_local_responses));
1911 out += sprintf(out, "unhandled_local_responses: %u\n",
1912 ipmi_get_stat(intf, unhandled_local_responses));
1913 out += sprintf(out, "sent_ipmb_commands: %u\n",
1914 ipmi_get_stat(intf, sent_ipmb_commands));
1915 out += sprintf(out, "sent_ipmb_command_errs: %u\n",
1916 ipmi_get_stat(intf, sent_ipmb_command_errs));
1917 out += sprintf(out, "retransmitted_ipmb_commands: %u\n",
1918 ipmi_get_stat(intf, retransmitted_ipmb_commands));
1919 out += sprintf(out, "timed_out_ipmb_commands: %u\n",
1920 ipmi_get_stat(intf, timed_out_ipmb_commands));
1921 out += sprintf(out, "timed_out_ipmb_broadcasts: %u\n",
1922 ipmi_get_stat(intf, timed_out_ipmb_broadcasts));
1923 out += sprintf(out, "sent_ipmb_responses: %u\n",
1924 ipmi_get_stat(intf, sent_ipmb_responses));
1925 out += sprintf(out, "handled_ipmb_responses: %u\n",
1926 ipmi_get_stat(intf, handled_ipmb_responses));
1927 out += sprintf(out, "invalid_ipmb_responses: %u\n",
1928 ipmi_get_stat(intf, invalid_ipmb_responses));
1929 out += sprintf(out, "unhandled_ipmb_responses: %u\n",
1930 ipmi_get_stat(intf, unhandled_ipmb_responses));
1931 out += sprintf(out, "sent_lan_commands: %u\n",
1932 ipmi_get_stat(intf, sent_lan_commands));
1933 out += sprintf(out, "sent_lan_command_errs: %u\n",
1934 ipmi_get_stat(intf, sent_lan_command_errs));
1935 out += sprintf(out, "retransmitted_lan_commands: %u\n",
1936 ipmi_get_stat(intf, retransmitted_lan_commands));
1937 out += sprintf(out, "timed_out_lan_commands: %u\n",
1938 ipmi_get_stat(intf, timed_out_lan_commands));
1939 out += sprintf(out, "sent_lan_responses: %u\n",
1940 ipmi_get_stat(intf, sent_lan_responses));
1941 out += sprintf(out, "handled_lan_responses: %u\n",
1942 ipmi_get_stat(intf, handled_lan_responses));
1943 out += sprintf(out, "invalid_lan_responses: %u\n",
1944 ipmi_get_stat(intf, invalid_lan_responses));
1945 out += sprintf(out, "unhandled_lan_responses: %u\n",
1946 ipmi_get_stat(intf, unhandled_lan_responses));
1947 out += sprintf(out, "handled_commands: %u\n",
1948 ipmi_get_stat(intf, handled_commands));
1949 out += sprintf(out, "invalid_commands: %u\n",
1950 ipmi_get_stat(intf, invalid_commands));
1951 out += sprintf(out, "unhandled_commands: %u\n",
1952 ipmi_get_stat(intf, unhandled_commands));
1953 out += sprintf(out, "invalid_events: %u\n",
1954 ipmi_get_stat(intf, invalid_events));
1955 out += sprintf(out, "events: %u\n",
1956 ipmi_get_stat(intf, events));
1957 out += sprintf(out, "failed rexmit LAN msgs: %u\n",
1958 ipmi_get_stat(intf, dropped_rexmit_lan_commands));
1959 out += sprintf(out, "failed rexmit IPMB msgs: %u\n",
1960 ipmi_get_stat(intf, dropped_rexmit_ipmb_commands));
1962 return (out - ((char *) page));
1964 #endif /* CONFIG_PROC_FS */
1966 int ipmi_smi_add_proc_entry(ipmi_smi_t smi, char *name,
1967 read_proc_t *read_proc,
1971 #ifdef CONFIG_PROC_FS
1972 struct proc_dir_entry *file;
1973 struct ipmi_proc_entry *entry;
1975 /* Create a list element. */
1976 entry = kmalloc(sizeof(*entry), GFP_KERNEL);
1979 entry->name = kmalloc(strlen(name)+1, GFP_KERNEL);
1984 strcpy(entry->name, name);
1986 file = create_proc_entry(name, 0, smi->proc_dir);
1993 file->read_proc = read_proc;
1995 mutex_lock(&smi->proc_entry_lock);
1996 /* Stick it on the list. */
1997 entry->next = smi->proc_entries;
1998 smi->proc_entries = entry;
1999 mutex_unlock(&smi->proc_entry_lock);
2001 #endif /* CONFIG_PROC_FS */
2005 EXPORT_SYMBOL(ipmi_smi_add_proc_entry);
2007 static int add_proc_entries(ipmi_smi_t smi, int num)
2011 #ifdef CONFIG_PROC_FS
2012 sprintf(smi->proc_dir_name, "%d", num);
2013 smi->proc_dir = proc_mkdir(smi->proc_dir_name, proc_ipmi_root);
2018 rv = ipmi_smi_add_proc_entry(smi, "stats",
2019 stat_file_read_proc,
2023 rv = ipmi_smi_add_proc_entry(smi, "ipmb",
2024 ipmb_file_read_proc,
2028 rv = ipmi_smi_add_proc_entry(smi, "version",
2029 version_file_read_proc,
2031 #endif /* CONFIG_PROC_FS */
2036 static void remove_proc_entries(ipmi_smi_t smi)
2038 #ifdef CONFIG_PROC_FS
2039 struct ipmi_proc_entry *entry;
2041 mutex_lock(&smi->proc_entry_lock);
2042 while (smi->proc_entries) {
2043 entry = smi->proc_entries;
2044 smi->proc_entries = entry->next;
2046 remove_proc_entry(entry->name, smi->proc_dir);
2050 mutex_unlock(&smi->proc_entry_lock);
2051 remove_proc_entry(smi->proc_dir_name, proc_ipmi_root);
2052 #endif /* CONFIG_PROC_FS */
2055 static int __find_bmc_guid(struct device *dev, void *data)
2057 unsigned char *id = data;
2058 struct bmc_device *bmc = dev_get_drvdata(dev);
2059 return memcmp(bmc->guid, id, 16) == 0;
2062 static struct bmc_device *ipmi_find_bmc_guid(struct device_driver *drv,
2063 unsigned char *guid)
2067 dev = driver_find_device(drv, NULL, guid, __find_bmc_guid);
2069 return dev_get_drvdata(dev);
2074 struct prod_dev_id {
2075 unsigned int product_id;
2076 unsigned char device_id;
2079 static int __find_bmc_prod_dev_id(struct device *dev, void *data)
2081 struct prod_dev_id *id = data;
2082 struct bmc_device *bmc = dev_get_drvdata(dev);
2084 return (bmc->id.product_id == id->product_id
2085 && bmc->id.device_id == id->device_id);
2088 static struct bmc_device *ipmi_find_bmc_prod_dev_id(
2089 struct device_driver *drv,
2090 unsigned int product_id, unsigned char device_id)
2092 struct prod_dev_id id = {
2093 .product_id = product_id,
2094 .device_id = device_id,
2098 dev = driver_find_device(drv, NULL, &id, __find_bmc_prod_dev_id);
2100 return dev_get_drvdata(dev);
2105 static ssize_t device_id_show(struct device *dev,
2106 struct device_attribute *attr,
2109 struct bmc_device *bmc = dev_get_drvdata(dev);
2111 return snprintf(buf, 10, "%u\n", bmc->id.device_id);
2114 static ssize_t provides_dev_sdrs_show(struct device *dev,
2115 struct device_attribute *attr,
2118 struct bmc_device *bmc = dev_get_drvdata(dev);
2120 return snprintf(buf, 10, "%u\n",
2121 (bmc->id.device_revision & 0x80) >> 7);
2124 static ssize_t revision_show(struct device *dev, struct device_attribute *attr,
2127 struct bmc_device *bmc = dev_get_drvdata(dev);
2129 return snprintf(buf, 20, "%u\n",
2130 bmc->id.device_revision & 0x0F);
2133 static ssize_t firmware_rev_show(struct device *dev,
2134 struct device_attribute *attr,
2137 struct bmc_device *bmc = dev_get_drvdata(dev);
2139 return snprintf(buf, 20, "%u.%x\n", bmc->id.firmware_revision_1,
2140 bmc->id.firmware_revision_2);
2143 static ssize_t ipmi_version_show(struct device *dev,
2144 struct device_attribute *attr,
2147 struct bmc_device *bmc = dev_get_drvdata(dev);
2149 return snprintf(buf, 20, "%u.%u\n",
2150 ipmi_version_major(&bmc->id),
2151 ipmi_version_minor(&bmc->id));
2154 static ssize_t add_dev_support_show(struct device *dev,
2155 struct device_attribute *attr,
2158 struct bmc_device *bmc = dev_get_drvdata(dev);
2160 return snprintf(buf, 10, "0x%02x\n",
2161 bmc->id.additional_device_support);
2164 static ssize_t manufacturer_id_show(struct device *dev,
2165 struct device_attribute *attr,
2168 struct bmc_device *bmc = dev_get_drvdata(dev);
2170 return snprintf(buf, 20, "0x%6.6x\n", bmc->id.manufacturer_id);
2173 static ssize_t product_id_show(struct device *dev,
2174 struct device_attribute *attr,
2177 struct bmc_device *bmc = dev_get_drvdata(dev);
2179 return snprintf(buf, 10, "0x%4.4x\n", bmc->id.product_id);
2182 static ssize_t aux_firmware_rev_show(struct device *dev,
2183 struct device_attribute *attr,
2186 struct bmc_device *bmc = dev_get_drvdata(dev);
2188 return snprintf(buf, 21, "0x%02x 0x%02x 0x%02x 0x%02x\n",
2189 bmc->id.aux_firmware_revision[3],
2190 bmc->id.aux_firmware_revision[2],
2191 bmc->id.aux_firmware_revision[1],
2192 bmc->id.aux_firmware_revision[0]);
2195 static ssize_t guid_show(struct device *dev, struct device_attribute *attr,
2198 struct bmc_device *bmc = dev_get_drvdata(dev);
2200 return snprintf(buf, 100, "%Lx%Lx\n",
2201 (long long) bmc->guid[0],
2202 (long long) bmc->guid[8]);
2205 static void remove_files(struct bmc_device *bmc)
2210 device_remove_file(&bmc->dev->dev,
2211 &bmc->device_id_attr);
2212 device_remove_file(&bmc->dev->dev,
2213 &bmc->provides_dev_sdrs_attr);
2214 device_remove_file(&bmc->dev->dev,
2215 &bmc->revision_attr);
2216 device_remove_file(&bmc->dev->dev,
2217 &bmc->firmware_rev_attr);
2218 device_remove_file(&bmc->dev->dev,
2219 &bmc->version_attr);
2220 device_remove_file(&bmc->dev->dev,
2221 &bmc->add_dev_support_attr);
2222 device_remove_file(&bmc->dev->dev,
2223 &bmc->manufacturer_id_attr);
2224 device_remove_file(&bmc->dev->dev,
2225 &bmc->product_id_attr);
2227 if (bmc->id.aux_firmware_revision_set)
2228 device_remove_file(&bmc->dev->dev,
2229 &bmc->aux_firmware_rev_attr);
2231 device_remove_file(&bmc->dev->dev,
2236 cleanup_bmc_device(struct kref *ref)
2238 struct bmc_device *bmc;
2240 bmc = container_of(ref, struct bmc_device, refcount);
2243 platform_device_unregister(bmc->dev);
2247 static void ipmi_bmc_unregister(ipmi_smi_t intf)
2249 struct bmc_device *bmc = intf->bmc;
2251 if (intf->sysfs_name) {
2252 sysfs_remove_link(&intf->si_dev->kobj, intf->sysfs_name);
2253 kfree(intf->sysfs_name);
2254 intf->sysfs_name = NULL;
2256 if (intf->my_dev_name) {
2257 sysfs_remove_link(&bmc->dev->dev.kobj, intf->my_dev_name);
2258 kfree(intf->my_dev_name);
2259 intf->my_dev_name = NULL;
2262 mutex_lock(&ipmidriver_mutex);
2263 kref_put(&bmc->refcount, cleanup_bmc_device);
2265 mutex_unlock(&ipmidriver_mutex);
2268 static int create_files(struct bmc_device *bmc)
2272 bmc->device_id_attr.attr.name = "device_id";
2273 bmc->device_id_attr.attr.mode = S_IRUGO;
2274 bmc->device_id_attr.show = device_id_show;
2275 sysfs_attr_init(&bmc->device_id_attr.attr);
2277 bmc->provides_dev_sdrs_attr.attr.name = "provides_device_sdrs";
2278 bmc->provides_dev_sdrs_attr.attr.mode = S_IRUGO;
2279 bmc->provides_dev_sdrs_attr.show = provides_dev_sdrs_show;
2280 sysfs_attr_init(&bmc->provides_dev_sdrs_attr.attr);
2282 bmc->revision_attr.attr.name = "revision";
2283 bmc->revision_attr.attr.mode = S_IRUGO;
2284 bmc->revision_attr.show = revision_show;
2285 sysfs_attr_init(&bmc->revision_attr.attr);
2287 bmc->firmware_rev_attr.attr.name = "firmware_revision";
2288 bmc->firmware_rev_attr.attr.mode = S_IRUGO;
2289 bmc->firmware_rev_attr.show = firmware_rev_show;
2290 sysfs_attr_init(&bmc->firmware_rev_attr.attr);
2292 bmc->version_attr.attr.name = "ipmi_version";
2293 bmc->version_attr.attr.mode = S_IRUGO;
2294 bmc->version_attr.show = ipmi_version_show;
2295 sysfs_attr_init(&bmc->version_attr.attr);
2297 bmc->add_dev_support_attr.attr.name = "additional_device_support";
2298 bmc->add_dev_support_attr.attr.mode = S_IRUGO;
2299 bmc->add_dev_support_attr.show = add_dev_support_show;
2300 sysfs_attr_init(&bmc->add_dev_support_attr.attr);
2302 bmc->manufacturer_id_attr.attr.name = "manufacturer_id";
2303 bmc->manufacturer_id_attr.attr.mode = S_IRUGO;
2304 bmc->manufacturer_id_attr.show = manufacturer_id_show;
2305 sysfs_attr_init(&bmc->manufacturer_id_attr.attr);
2307 bmc->product_id_attr.attr.name = "product_id";
2308 bmc->product_id_attr.attr.mode = S_IRUGO;
2309 bmc->product_id_attr.show = product_id_show;
2310 sysfs_attr_init(&bmc->product_id_attr.attr);
2312 bmc->guid_attr.attr.name = "guid";
2313 bmc->guid_attr.attr.mode = S_IRUGO;
2314 bmc->guid_attr.show = guid_show;
2315 sysfs_attr_init(&bmc->guid_attr.attr);
2317 bmc->aux_firmware_rev_attr.attr.name = "aux_firmware_revision";
2318 bmc->aux_firmware_rev_attr.attr.mode = S_IRUGO;
2319 bmc->aux_firmware_rev_attr.show = aux_firmware_rev_show;
2320 sysfs_attr_init(&bmc->aux_firmware_rev_attr.attr);
2322 err = device_create_file(&bmc->dev->dev,
2323 &bmc->device_id_attr);
2326 err = device_create_file(&bmc->dev->dev,
2327 &bmc->provides_dev_sdrs_attr);
2330 err = device_create_file(&bmc->dev->dev,
2331 &bmc->revision_attr);
2334 err = device_create_file(&bmc->dev->dev,
2335 &bmc->firmware_rev_attr);
2338 err = device_create_file(&bmc->dev->dev,
2339 &bmc->version_attr);
2342 err = device_create_file(&bmc->dev->dev,
2343 &bmc->add_dev_support_attr);
2346 err = device_create_file(&bmc->dev->dev,
2347 &bmc->manufacturer_id_attr);
2350 err = device_create_file(&bmc->dev->dev,
2351 &bmc->product_id_attr);
2354 if (bmc->id.aux_firmware_revision_set) {
2355 err = device_create_file(&bmc->dev->dev,
2356 &bmc->aux_firmware_rev_attr);
2360 if (bmc->guid_set) {
2361 err = device_create_file(&bmc->dev->dev,
2370 if (bmc->id.aux_firmware_revision_set)
2371 device_remove_file(&bmc->dev->dev,
2372 &bmc->aux_firmware_rev_attr);
2374 device_remove_file(&bmc->dev->dev,
2375 &bmc->product_id_attr);
2377 device_remove_file(&bmc->dev->dev,
2378 &bmc->manufacturer_id_attr);
2380 device_remove_file(&bmc->dev->dev,
2381 &bmc->add_dev_support_attr);
2383 device_remove_file(&bmc->dev->dev,
2384 &bmc->version_attr);
2386 device_remove_file(&bmc->dev->dev,
2387 &bmc->firmware_rev_attr);
2389 device_remove_file(&bmc->dev->dev,
2390 &bmc->revision_attr);
2392 device_remove_file(&bmc->dev->dev,
2393 &bmc->provides_dev_sdrs_attr);
2395 device_remove_file(&bmc->dev->dev,
2396 &bmc->device_id_attr);
2401 static int ipmi_bmc_register(ipmi_smi_t intf, int ifnum,
2402 const char *sysfs_name)
2405 struct bmc_device *bmc = intf->bmc;
2406 struct bmc_device *old_bmc;
2410 mutex_lock(&ipmidriver_mutex);
2413 * Try to find if there is an bmc_device struct
2414 * representing the interfaced BMC already
2417 old_bmc = ipmi_find_bmc_guid(&ipmidriver.driver, bmc->guid);
2419 old_bmc = ipmi_find_bmc_prod_dev_id(&ipmidriver.driver,
2424 * If there is already an bmc_device, free the new one,
2425 * otherwise register the new BMC device
2429 intf->bmc = old_bmc;
2432 kref_get(&bmc->refcount);
2433 mutex_unlock(&ipmidriver_mutex);
2436 "ipmi: interfacing existing BMC (man_id: 0x%6.6x,"
2437 " prod_id: 0x%4.4x, dev_id: 0x%2.2x)\n",
2438 bmc->id.manufacturer_id,
2443 unsigned char orig_dev_id = bmc->id.device_id;
2444 int warn_printed = 0;
2446 snprintf(name, sizeof(name),
2447 "ipmi_bmc.%4.4x", bmc->id.product_id);
2449 while (ipmi_find_bmc_prod_dev_id(&ipmidriver.driver,
2451 bmc->id.device_id)) {
2452 if (!warn_printed) {
2453 printk(KERN_WARNING PFX
2454 "This machine has two different BMCs"
2455 " with the same product id and device"
2456 " id. This is an error in the"
2457 " firmware, but incrementing the"
2458 " device id to work around the problem."
2459 " Prod ID = 0x%x, Dev ID = 0x%x\n",
2460 bmc->id.product_id, bmc->id.device_id);
2463 bmc->id.device_id++; /* Wraps at 255 */
2464 if (bmc->id.device_id == orig_dev_id) {
2466 "Out of device ids!\n");
2471 bmc->dev = platform_device_alloc(name, bmc->id.device_id);
2473 mutex_unlock(&ipmidriver_mutex);
2476 " Unable to allocate platform device\n");
2479 bmc->dev->dev.driver = &ipmidriver.driver;
2480 dev_set_drvdata(&bmc->dev->dev, bmc);
2481 kref_init(&bmc->refcount);
2483 rv = platform_device_add(bmc->dev);
2484 mutex_unlock(&ipmidriver_mutex);
2486 platform_device_put(bmc->dev);
2490 " Unable to register bmc device: %d\n",
2493 * Don't go to out_err, you can only do that if
2494 * the device is registered already.
2499 rv = create_files(bmc);
2501 mutex_lock(&ipmidriver_mutex);
2502 platform_device_unregister(bmc->dev);
2503 mutex_unlock(&ipmidriver_mutex);
2508 dev_info(intf->si_dev, "Found new BMC (man_id: 0x%6.6x, "
2509 "prod_id: 0x%4.4x, dev_id: 0x%2.2x)\n",
2510 bmc->id.manufacturer_id,
2516 * create symlink from system interface device to bmc device
2519 intf->sysfs_name = kstrdup(sysfs_name, GFP_KERNEL);
2520 if (!intf->sysfs_name) {
2523 "ipmi_msghandler: allocate link to BMC: %d\n",
2528 rv = sysfs_create_link(&intf->si_dev->kobj,
2529 &bmc->dev->dev.kobj, intf->sysfs_name);
2531 kfree(intf->sysfs_name);
2532 intf->sysfs_name = NULL;
2534 "ipmi_msghandler: Unable to create bmc symlink: %d\n",
2539 size = snprintf(dummy, 0, "ipmi%d", ifnum);
2540 intf->my_dev_name = kmalloc(size+1, GFP_KERNEL);
2541 if (!intf->my_dev_name) {
2542 kfree(intf->sysfs_name);
2543 intf->sysfs_name = NULL;
2546 "ipmi_msghandler: allocate link from BMC: %d\n",
2550 snprintf(intf->my_dev_name, size+1, "ipmi%d", ifnum);
2552 rv = sysfs_create_link(&bmc->dev->dev.kobj, &intf->si_dev->kobj,
2555 kfree(intf->sysfs_name);
2556 intf->sysfs_name = NULL;
2557 kfree(intf->my_dev_name);
2558 intf->my_dev_name = NULL;
2561 " Unable to create symlink to bmc: %d\n",
2569 ipmi_bmc_unregister(intf);
2574 send_guid_cmd(ipmi_smi_t intf, int chan)
2576 struct kernel_ipmi_msg msg;
2577 struct ipmi_system_interface_addr si;
2579 si.addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
2580 si.channel = IPMI_BMC_CHANNEL;
2583 msg.netfn = IPMI_NETFN_APP_REQUEST;
2584 msg.cmd = IPMI_GET_DEVICE_GUID_CMD;
2587 return i_ipmi_request(NULL,
2589 (struct ipmi_addr *) &si,
2596 intf->channels[0].address,
2597 intf->channels[0].lun,
2602 guid_handler(ipmi_smi_t intf, struct ipmi_recv_msg *msg)
2604 if ((msg->addr.addr_type != IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
2605 || (msg->msg.netfn != IPMI_NETFN_APP_RESPONSE)
2606 || (msg->msg.cmd != IPMI_GET_DEVICE_GUID_CMD))
2610 if (msg->msg.data[0] != 0) {
2611 /* Error from getting the GUID, the BMC doesn't have one. */
2612 intf->bmc->guid_set = 0;
2616 if (msg->msg.data_len < 17) {
2617 intf->bmc->guid_set = 0;
2618 printk(KERN_WARNING PFX
2619 "guid_handler: The GUID response from the BMC was too"
2620 " short, it was %d but should have been 17. Assuming"
2621 " GUID is not available.\n",
2626 memcpy(intf->bmc->guid, msg->msg.data, 16);
2627 intf->bmc->guid_set = 1;
2629 wake_up(&intf->waitq);
2633 get_guid(ipmi_smi_t intf)
2637 intf->bmc->guid_set = 0x2;
2638 intf->null_user_handler = guid_handler;
2639 rv = send_guid_cmd(intf, 0);
2641 /* Send failed, no GUID available. */
2642 intf->bmc->guid_set = 0;
2643 wait_event(intf->waitq, intf->bmc->guid_set != 2);
2644 intf->null_user_handler = NULL;
2648 send_channel_info_cmd(ipmi_smi_t intf, int chan)
2650 struct kernel_ipmi_msg msg;
2651 unsigned char data[1];
2652 struct ipmi_system_interface_addr si;
2654 si.addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
2655 si.channel = IPMI_BMC_CHANNEL;
2658 msg.netfn = IPMI_NETFN_APP_REQUEST;
2659 msg.cmd = IPMI_GET_CHANNEL_INFO_CMD;
2663 return i_ipmi_request(NULL,
2665 (struct ipmi_addr *) &si,
2672 intf->channels[0].address,
2673 intf->channels[0].lun,
2678 channel_handler(ipmi_smi_t intf, struct ipmi_recv_msg *msg)
2683 if ((msg->addr.addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
2684 && (msg->msg.netfn == IPMI_NETFN_APP_RESPONSE)
2685 && (msg->msg.cmd == IPMI_GET_CHANNEL_INFO_CMD)) {
2686 /* It's the one we want */
2687 if (msg->msg.data[0] != 0) {
2688 /* Got an error from the channel, just go on. */
2690 if (msg->msg.data[0] == IPMI_INVALID_COMMAND_ERR) {
2692 * If the MC does not support this
2693 * command, that is legal. We just
2694 * assume it has one IPMB at channel
2697 intf->channels[0].medium
2698 = IPMI_CHANNEL_MEDIUM_IPMB;
2699 intf->channels[0].protocol
2700 = IPMI_CHANNEL_PROTOCOL_IPMB;
2703 intf->curr_channel = IPMI_MAX_CHANNELS;
2704 wake_up(&intf->waitq);
2709 if (msg->msg.data_len < 4) {
2710 /* Message not big enough, just go on. */
2713 chan = intf->curr_channel;
2714 intf->channels[chan].medium = msg->msg.data[2] & 0x7f;
2715 intf->channels[chan].protocol = msg->msg.data[3] & 0x1f;
2718 intf->curr_channel++;
2719 if (intf->curr_channel >= IPMI_MAX_CHANNELS)
2720 wake_up(&intf->waitq);
2722 rv = send_channel_info_cmd(intf, intf->curr_channel);
2725 /* Got an error somehow, just give up. */
2726 intf->curr_channel = IPMI_MAX_CHANNELS;
2727 wake_up(&intf->waitq);
2729 printk(KERN_WARNING PFX
2730 "Error sending channel information: %d\n",
2738 void ipmi_poll_interface(ipmi_user_t user)
2740 ipmi_smi_t intf = user->intf;
2742 if (intf->handlers->poll)
2743 intf->handlers->poll(intf->send_info);
2745 EXPORT_SYMBOL(ipmi_poll_interface);
2747 int ipmi_register_smi(struct ipmi_smi_handlers *handlers,
2749 struct ipmi_device_id *device_id,
2750 struct device *si_dev,
2751 const char *sysfs_name,
2752 unsigned char slave_addr)
2758 struct list_head *link;
2761 * Make sure the driver is actually initialized, this handles
2762 * problems with initialization order.
2765 rv = ipmi_init_msghandler();
2769 * The init code doesn't return an error if it was turned
2770 * off, but it won't initialize. Check that.
2776 intf = kzalloc(sizeof(*intf), GFP_KERNEL);
2780 intf->ipmi_version_major = ipmi_version_major(device_id);
2781 intf->ipmi_version_minor = ipmi_version_minor(device_id);
2783 intf->bmc = kzalloc(sizeof(*intf->bmc), GFP_KERNEL);
2788 intf->intf_num = -1; /* Mark it invalid for now. */
2789 kref_init(&intf->refcount);
2790 intf->bmc->id = *device_id;
2791 intf->si_dev = si_dev;
2792 for (j = 0; j < IPMI_MAX_CHANNELS; j++) {
2793 intf->channels[j].address = IPMI_BMC_SLAVE_ADDR;
2794 intf->channels[j].lun = 2;
2796 if (slave_addr != 0)
2797 intf->channels[0].address = slave_addr;
2798 INIT_LIST_HEAD(&intf->users);
2799 intf->handlers = handlers;
2800 intf->send_info = send_info;
2801 spin_lock_init(&intf->seq_lock);
2802 for (j = 0; j < IPMI_IPMB_NUM_SEQ; j++) {
2803 intf->seq_table[j].inuse = 0;
2804 intf->seq_table[j].seqid = 0;
2807 #ifdef CONFIG_PROC_FS
2808 mutex_init(&intf->proc_entry_lock);
2810 spin_lock_init(&intf->waiting_msgs_lock);
2811 INIT_LIST_HEAD(&intf->waiting_msgs);
2812 spin_lock_init(&intf->events_lock);
2813 INIT_LIST_HEAD(&intf->waiting_events);
2814 intf->waiting_events_count = 0;
2815 mutex_init(&intf->cmd_rcvrs_mutex);
2816 spin_lock_init(&intf->maintenance_mode_lock);
2817 INIT_LIST_HEAD(&intf->cmd_rcvrs);
2818 init_waitqueue_head(&intf->waitq);
2819 for (i = 0; i < IPMI_NUM_STATS; i++)
2820 atomic_set(&intf->stats[i], 0);
2822 intf->proc_dir = NULL;
2824 mutex_lock(&smi_watchers_mutex);
2825 mutex_lock(&ipmi_interfaces_mutex);
2826 /* Look for a hole in the numbers. */
2828 link = &ipmi_interfaces;
2829 list_for_each_entry_rcu(tintf, &ipmi_interfaces, link) {
2830 if (tintf->intf_num != i) {
2831 link = &tintf->link;
2836 /* Add the new interface in numeric order. */
2838 list_add_rcu(&intf->link, &ipmi_interfaces);
2840 list_add_tail_rcu(&intf->link, link);
2842 rv = handlers->start_processing(send_info, intf);
2848 if ((intf->ipmi_version_major > 1)
2849 || ((intf->ipmi_version_major == 1)
2850 && (intf->ipmi_version_minor >= 5))) {
2852 * Start scanning the channels to see what is
2855 intf->null_user_handler = channel_handler;
2856 intf->curr_channel = 0;
2857 rv = send_channel_info_cmd(intf, 0);
2861 /* Wait for the channel info to be read. */
2862 wait_event(intf->waitq,
2863 intf->curr_channel >= IPMI_MAX_CHANNELS);
2864 intf->null_user_handler = NULL;
2866 /* Assume a single IPMB channel at zero. */
2867 intf->channels[0].medium = IPMI_CHANNEL_MEDIUM_IPMB;
2868 intf->channels[0].protocol = IPMI_CHANNEL_PROTOCOL_IPMB;
2869 intf->curr_channel = IPMI_MAX_CHANNELS;
2873 rv = add_proc_entries(intf, i);
2875 rv = ipmi_bmc_register(intf, i, sysfs_name);
2880 remove_proc_entries(intf);
2881 intf->handlers = NULL;
2882 list_del_rcu(&intf->link);
2883 mutex_unlock(&ipmi_interfaces_mutex);
2884 mutex_unlock(&smi_watchers_mutex);
2886 kref_put(&intf->refcount, intf_free);
2889 * Keep memory order straight for RCU readers. Make
2890 * sure everything else is committed to memory before
2891 * setting intf_num to mark the interface valid.
2895 mutex_unlock(&ipmi_interfaces_mutex);
2896 /* After this point the interface is legal to use. */
2897 call_smi_watchers(i, intf->si_dev);
2898 mutex_unlock(&smi_watchers_mutex);
2903 EXPORT_SYMBOL(ipmi_register_smi);
2905 static void cleanup_smi_msgs(ipmi_smi_t intf)
2908 struct seq_table *ent;
2910 /* No need for locks, the interface is down. */
2911 for (i = 0; i < IPMI_IPMB_NUM_SEQ; i++) {
2912 ent = &(intf->seq_table[i]);
2915 deliver_err_response(ent->recv_msg, IPMI_ERR_UNSPECIFIED);
2919 int ipmi_unregister_smi(ipmi_smi_t intf)
2921 struct ipmi_smi_watcher *w;
2922 int intf_num = intf->intf_num;
2924 ipmi_bmc_unregister(intf);
2926 mutex_lock(&smi_watchers_mutex);
2927 mutex_lock(&ipmi_interfaces_mutex);
2928 intf->intf_num = -1;
2929 intf->handlers = NULL;
2930 list_del_rcu(&intf->link);
2931 mutex_unlock(&ipmi_interfaces_mutex);
2934 cleanup_smi_msgs(intf);
2936 remove_proc_entries(intf);
2939 * Call all the watcher interfaces to tell them that
2940 * an interface is gone.
2942 list_for_each_entry(w, &smi_watchers, link)
2943 w->smi_gone(intf_num);
2944 mutex_unlock(&smi_watchers_mutex);
2946 kref_put(&intf->refcount, intf_free);
2949 EXPORT_SYMBOL(ipmi_unregister_smi);
2951 static int handle_ipmb_get_msg_rsp(ipmi_smi_t intf,
2952 struct ipmi_smi_msg *msg)
2954 struct ipmi_ipmb_addr ipmb_addr;
2955 struct ipmi_recv_msg *recv_msg;
2958 * This is 11, not 10, because the response must contain a
2961 if (msg->rsp_size < 11) {
2962 /* Message not big enough, just ignore it. */
2963 ipmi_inc_stat(intf, invalid_ipmb_responses);
2967 if (msg->rsp[2] != 0) {
2968 /* An error getting the response, just ignore it. */
2972 ipmb_addr.addr_type = IPMI_IPMB_ADDR_TYPE;
2973 ipmb_addr.slave_addr = msg->rsp[6];
2974 ipmb_addr.channel = msg->rsp[3] & 0x0f;
2975 ipmb_addr.lun = msg->rsp[7] & 3;
2978 * It's a response from a remote entity. Look up the sequence
2979 * number and handle the response.
2981 if (intf_find_seq(intf,
2985 (msg->rsp[4] >> 2) & (~1),
2986 (struct ipmi_addr *) &(ipmb_addr),
2989 * We were unable to find the sequence number,
2990 * so just nuke the message.
2992 ipmi_inc_stat(intf, unhandled_ipmb_responses);
2996 memcpy(recv_msg->msg_data,
3000 * The other fields matched, so no need to set them, except
3001 * for netfn, which needs to be the response that was
3002 * returned, not the request value.
3004 recv_msg->msg.netfn = msg->rsp[4] >> 2;
3005 recv_msg->msg.data = recv_msg->msg_data;
3006 recv_msg->msg.data_len = msg->rsp_size - 10;
3007 recv_msg->recv_type = IPMI_RESPONSE_RECV_TYPE;
3008 ipmi_inc_stat(intf, handled_ipmb_responses);
3009 deliver_response(recv_msg);
3014 static int handle_ipmb_get_msg_cmd(ipmi_smi_t intf,
3015 struct ipmi_smi_msg *msg)
3017 struct cmd_rcvr *rcvr;
3019 unsigned char netfn;
3022 ipmi_user_t user = NULL;
3023 struct ipmi_ipmb_addr *ipmb_addr;
3024 struct ipmi_recv_msg *recv_msg;
3025 struct ipmi_smi_handlers *handlers;
3027 if (msg->rsp_size < 10) {
3028 /* Message not big enough, just ignore it. */
3029 ipmi_inc_stat(intf, invalid_commands);
3033 if (msg->rsp[2] != 0) {
3034 /* An error getting the response, just ignore it. */
3038 netfn = msg->rsp[4] >> 2;
3040 chan = msg->rsp[3] & 0xf;
3043 rcvr = find_cmd_rcvr(intf, netfn, cmd, chan);
3046 kref_get(&user->refcount);
3052 /* We didn't find a user, deliver an error response. */
3053 ipmi_inc_stat(intf, unhandled_commands);
3055 msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
3056 msg->data[1] = IPMI_SEND_MSG_CMD;
3057 msg->data[2] = msg->rsp[3];
3058 msg->data[3] = msg->rsp[6];
3059 msg->data[4] = ((netfn + 1) << 2) | (msg->rsp[7] & 0x3);
3060 msg->data[5] = ipmb_checksum(&(msg->data[3]), 2);
3061 msg->data[6] = intf->channels[msg->rsp[3] & 0xf].address;
3063 msg->data[7] = (msg->rsp[7] & 0xfc) | (msg->rsp[4] & 0x3);
3064 msg->data[8] = msg->rsp[8]; /* cmd */
3065 msg->data[9] = IPMI_INVALID_CMD_COMPLETION_CODE;
3066 msg->data[10] = ipmb_checksum(&(msg->data[6]), 4);
3067 msg->data_size = 11;
3072 printk("Invalid command:");
3073 for (m = 0; m < msg->data_size; m++)
3074 printk(" %2.2x", msg->data[m]);
3079 handlers = intf->handlers;
3081 handlers->sender(intf->send_info, msg, 0);
3083 * We used the message, so return the value
3084 * that causes it to not be freed or
3091 /* Deliver the message to the user. */
3092 ipmi_inc_stat(intf, handled_commands);
3094 recv_msg = ipmi_alloc_recv_msg();
3097 * We couldn't allocate memory for the
3098 * message, so requeue it for handling
3102 kref_put(&user->refcount, free_user);
3104 /* Extract the source address from the data. */
3105 ipmb_addr = (struct ipmi_ipmb_addr *) &recv_msg->addr;
3106 ipmb_addr->addr_type = IPMI_IPMB_ADDR_TYPE;
3107 ipmb_addr->slave_addr = msg->rsp[6];
3108 ipmb_addr->lun = msg->rsp[7] & 3;
3109 ipmb_addr->channel = msg->rsp[3] & 0xf;
3112 * Extract the rest of the message information
3113 * from the IPMB header.
3115 recv_msg->user = user;
3116 recv_msg->recv_type = IPMI_CMD_RECV_TYPE;
3117 recv_msg->msgid = msg->rsp[7] >> 2;
3118 recv_msg->msg.netfn = msg->rsp[4] >> 2;
3119 recv_msg->msg.cmd = msg->rsp[8];
3120 recv_msg->msg.data = recv_msg->msg_data;
3123 * We chop off 10, not 9 bytes because the checksum
3124 * at the end also needs to be removed.
3126 recv_msg->msg.data_len = msg->rsp_size - 10;
3127 memcpy(recv_msg->msg_data,
3129 msg->rsp_size - 10);
3130 deliver_response(recv_msg);
3137 static int handle_lan_get_msg_rsp(ipmi_smi_t intf,
3138 struct ipmi_smi_msg *msg)
3140 struct ipmi_lan_addr lan_addr;
3141 struct ipmi_recv_msg *recv_msg;
3145 * This is 13, not 12, because the response must contain a
3148 if (msg->rsp_size < 13) {
3149 /* Message not big enough, just ignore it. */
3150 ipmi_inc_stat(intf, invalid_lan_responses);
3154 if (msg->rsp[2] != 0) {
3155 /* An error getting the response, just ignore it. */
3159 lan_addr.addr_type = IPMI_LAN_ADDR_TYPE;
3160 lan_addr.session_handle = msg->rsp[4];
3161 lan_addr.remote_SWID = msg->rsp[8];
3162 lan_addr.local_SWID = msg->rsp[5];
3163 lan_addr.channel = msg->rsp[3] & 0x0f;
3164 lan_addr.privilege = msg->rsp[3] >> 4;
3165 lan_addr.lun = msg->rsp[9] & 3;
3168 * It's a response from a remote entity. Look up the sequence
3169 * number and handle the response.
3171 if (intf_find_seq(intf,
3175 (msg->rsp[6] >> 2) & (~1),
3176 (struct ipmi_addr *) &(lan_addr),
3179 * We were unable to find the sequence number,
3180 * so just nuke the message.
3182 ipmi_inc_stat(intf, unhandled_lan_responses);
3186 memcpy(recv_msg->msg_data,
3188 msg->rsp_size - 11);
3190 * The other fields matched, so no need to set them, except
3191 * for netfn, which needs to be the response that was
3192 * returned, not the request value.
3194 recv_msg->msg.netfn = msg->rsp[6] >> 2;
3195 recv_msg->msg.data = recv_msg->msg_data;
3196 recv_msg->msg.data_len = msg->rsp_size - 12;
3197 recv_msg->recv_type = IPMI_RESPONSE_RECV_TYPE;
3198 ipmi_inc_stat(intf, handled_lan_responses);
3199 deliver_response(recv_msg);
3204 static int handle_lan_get_msg_cmd(ipmi_smi_t intf,
3205 struct ipmi_smi_msg *msg)
3207 struct cmd_rcvr *rcvr;
3209 unsigned char netfn;
3212 ipmi_user_t user = NULL;
3213 struct ipmi_lan_addr *lan_addr;
3214 struct ipmi_recv_msg *recv_msg;
3216 if (msg->rsp_size < 12) {
3217 /* Message not big enough, just ignore it. */
3218 ipmi_inc_stat(intf, invalid_commands);
3222 if (msg->rsp[2] != 0) {
3223 /* An error getting the response, just ignore it. */
3227 netfn = msg->rsp[6] >> 2;
3229 chan = msg->rsp[3] & 0xf;
3232 rcvr = find_cmd_rcvr(intf, netfn, cmd, chan);
3235 kref_get(&user->refcount);
3241 /* We didn't find a user, just give up. */
3242 ipmi_inc_stat(intf, unhandled_commands);
3245 * Don't do anything with these messages, just allow
3250 /* Deliver the message to the user. */
3251 ipmi_inc_stat(intf, handled_commands);
3253 recv_msg = ipmi_alloc_recv_msg();
3256 * We couldn't allocate memory for the
3257 * message, so requeue it for handling later.
3260 kref_put(&user->refcount, free_user);
3262 /* Extract the source address from the data. */
3263 lan_addr = (struct ipmi_lan_addr *) &recv_msg->addr;
3264 lan_addr->addr_type = IPMI_LAN_ADDR_TYPE;
3265 lan_addr->session_handle = msg->rsp[4];
3266 lan_addr->remote_SWID = msg->rsp[8];
3267 lan_addr->local_SWID = msg->rsp[5];
3268 lan_addr->lun = msg->rsp[9] & 3;
3269 lan_addr->channel = msg->rsp[3] & 0xf;
3270 lan_addr->privilege = msg->rsp[3] >> 4;
3273 * Extract the rest of the message information
3274 * from the IPMB header.
3276 recv_msg->user = user;
3277 recv_msg->recv_type = IPMI_CMD_RECV_TYPE;
3278 recv_msg->msgid = msg->rsp[9] >> 2;
3279 recv_msg->msg.netfn = msg->rsp[6] >> 2;
3280 recv_msg->msg.cmd = msg->rsp[10];
3281 recv_msg->msg.data = recv_msg->msg_data;
3284 * We chop off 12, not 11 bytes because the checksum
3285 * at the end also needs to be removed.
3287 recv_msg->msg.data_len = msg->rsp_size - 12;
3288 memcpy(recv_msg->msg_data,
3290 msg->rsp_size - 12);
3291 deliver_response(recv_msg);
3299 * This routine will handle "Get Message" command responses with
3300 * channels that use an OEM Medium. The message format belongs to
3301 * the OEM. See IPMI 2.0 specification, Chapter 6 and
3302 * Chapter 22, sections 22.6 and 22.24 for more details.
3304 static int handle_oem_get_msg_cmd(ipmi_smi_t intf,
3305 struct ipmi_smi_msg *msg)
3307 struct cmd_rcvr *rcvr;
3309 unsigned char netfn;
3312 ipmi_user_t user = NULL;
3313 struct ipmi_system_interface_addr *smi_addr;
3314 struct ipmi_recv_msg *recv_msg;
3317 * We expect the OEM SW to perform error checking
3318 * so we just do some basic sanity checks
3320 if (msg->rsp_size < 4) {
3321 /* Message not big enough, just ignore it. */
3322 ipmi_inc_stat(intf, invalid_commands);
3326 if (msg->rsp[2] != 0) {
3327 /* An error getting the response, just ignore it. */
3332 * This is an OEM Message so the OEM needs to know how
3333 * handle the message. We do no interpretation.
3335 netfn = msg->rsp[0] >> 2;
3337 chan = msg->rsp[3] & 0xf;
3340 rcvr = find_cmd_rcvr(intf, netfn, cmd, chan);
3343 kref_get(&user->refcount);
3349 /* We didn't find a user, just give up. */
3350 ipmi_inc_stat(intf, unhandled_commands);
3353 * Don't do anything with these messages, just allow
3359 /* Deliver the message to the user. */
3360 ipmi_inc_stat(intf, handled_commands);
3362 recv_msg = ipmi_alloc_recv_msg();
3365 * We couldn't allocate memory for the
3366 * message, so requeue it for handling
3370 kref_put(&user->refcount, free_user);
3373 * OEM Messages are expected to be delivered via
3374 * the system interface to SMS software. We might
3375 * need to visit this again depending on OEM
3378 smi_addr = ((struct ipmi_system_interface_addr *)
3380 smi_addr->addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
3381 smi_addr->channel = IPMI_BMC_CHANNEL;
3382 smi_addr->lun = msg->rsp[0] & 3;
3384 recv_msg->user = user;
3385 recv_msg->user_msg_data = NULL;
3386 recv_msg->recv_type = IPMI_OEM_RECV_TYPE;
3387 recv_msg->msg.netfn = msg->rsp[0] >> 2;
3388 recv_msg->msg.cmd = msg->rsp[1];
3389 recv_msg->msg.data = recv_msg->msg_data;
3392 * The message starts at byte 4 which follows the
3393 * the Channel Byte in the "GET MESSAGE" command
3395 recv_msg->msg.data_len = msg->rsp_size - 4;
3396 memcpy(recv_msg->msg_data,
3399 deliver_response(recv_msg);
3406 static void copy_event_into_recv_msg(struct ipmi_recv_msg *recv_msg,
3407 struct ipmi_smi_msg *msg)
3409 struct ipmi_system_interface_addr *smi_addr;
3411 recv_msg->msgid = 0;
3412 smi_addr = (struct ipmi_system_interface_addr *) &(recv_msg->addr);
3413 smi_addr->addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
3414 smi_addr->channel = IPMI_BMC_CHANNEL;
3415 smi_addr->lun = msg->rsp[0] & 3;
3416 recv_msg->recv_type = IPMI_ASYNC_EVENT_RECV_TYPE;
3417 recv_msg->msg.netfn = msg->rsp[0] >> 2;
3418 recv_msg->msg.cmd = msg->rsp[1];
3419 memcpy(recv_msg->msg_data, &(msg->rsp[3]), msg->rsp_size - 3);
3420 recv_msg->msg.data = recv_msg->msg_data;
3421 recv_msg->msg.data_len = msg->rsp_size - 3;
3424 static int handle_read_event_rsp(ipmi_smi_t intf,
3425 struct ipmi_smi_msg *msg)
3427 struct ipmi_recv_msg *recv_msg, *recv_msg2;
3428 struct list_head msgs;
3431 int deliver_count = 0;
3432 unsigned long flags;
3434 if (msg->rsp_size < 19) {
3435 /* Message is too small to be an IPMB event. */
3436 ipmi_inc_stat(intf, invalid_events);
3440 if (msg->rsp[2] != 0) {
3441 /* An error getting the event, just ignore it. */
3445 INIT_LIST_HEAD(&msgs);
3447 spin_lock_irqsave(&intf->events_lock, flags);
3449 ipmi_inc_stat(intf, events);
3452 * Allocate and fill in one message for every user that is
3456 list_for_each_entry_rcu(user, &intf->users, link) {
3457 if (!user->gets_events)
3460 recv_msg = ipmi_alloc_recv_msg();
3463 list_for_each_entry_safe(recv_msg, recv_msg2, &msgs,
3465 list_del(&recv_msg->link);
3466 ipmi_free_recv_msg(recv_msg);
3469 * We couldn't allocate memory for the
3470 * message, so requeue it for handling
3479 copy_event_into_recv_msg(recv_msg, msg);
3480 recv_msg->user = user;
3481 kref_get(&user->refcount);
3482 list_add_tail(&(recv_msg->link), &msgs);
3486 if (deliver_count) {
3487 /* Now deliver all the messages. */
3488 list_for_each_entry_safe(recv_msg, recv_msg2, &msgs, link) {
3489 list_del(&recv_msg->link);
3490 deliver_response(recv_msg);
3492 } else if (intf->waiting_events_count < MAX_EVENTS_IN_QUEUE) {
3494 * No one to receive the message, put it in queue if there's
3495 * not already too many things in the queue.
3497 recv_msg = ipmi_alloc_recv_msg();
3500 * We couldn't allocate memory for the
3501 * message, so requeue it for handling
3508 copy_event_into_recv_msg(recv_msg, msg);
3509 list_add_tail(&(recv_msg->link), &(intf->waiting_events));
3510 intf->waiting_events_count++;
3511 } else if (!intf->event_msg_printed) {
3513 * There's too many things in the queue, discard this
3516 printk(KERN_WARNING PFX "Event queue full, discarding"
3517 " incoming events\n");
3518 intf->event_msg_printed = 1;
3522 spin_unlock_irqrestore(&(intf->events_lock), flags);
3527 static int handle_bmc_rsp(ipmi_smi_t intf,
3528 struct ipmi_smi_msg *msg)
3530 struct ipmi_recv_msg *recv_msg;
3531 struct ipmi_user *user;
3533 recv_msg = (struct ipmi_recv_msg *) msg->user_data;
3534 if (recv_msg == NULL) {
3536 "IPMI message received with no owner. This\n"
3537 "could be because of a malformed message, or\n"
3538 "because of a hardware error. Contact your\n"
3539 "hardware vender for assistance\n");
3543 user = recv_msg->user;
3544 /* Make sure the user still exists. */
3545 if (user && !user->valid) {
3546 /* The user for the message went away, so give up. */
3547 ipmi_inc_stat(intf, unhandled_local_responses);
3548 ipmi_free_recv_msg(recv_msg);
3550 struct ipmi_system_interface_addr *smi_addr;
3552 ipmi_inc_stat(intf, handled_local_responses);
3553 recv_msg->recv_type = IPMI_RESPONSE_RECV_TYPE;
3554 recv_msg->msgid = msg->msgid;
3555 smi_addr = ((struct ipmi_system_interface_addr *)
3557 smi_addr->addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
3558 smi_addr->channel = IPMI_BMC_CHANNEL;
3559 smi_addr->lun = msg->rsp[0] & 3;
3560 recv_msg->msg.netfn = msg->rsp[0] >> 2;
3561 recv_msg->msg.cmd = msg->rsp[1];
3562 memcpy(recv_msg->msg_data,
3565 recv_msg->msg.data = recv_msg->msg_data;
3566 recv_msg->msg.data_len = msg->rsp_size - 2;
3567 deliver_response(recv_msg);
3574 * Handle a new message. Return 1 if the message should be requeued,
3575 * 0 if the message should be freed, or -1 if the message should not
3576 * be freed or requeued.
3578 static int handle_new_recv_msg(ipmi_smi_t intf,
3579 struct ipmi_smi_msg *msg)
3587 for (m = 0; m < msg->rsp_size; m++)
3588 printk(" %2.2x", msg->rsp[m]);
3591 if (msg->rsp_size < 2) {
3592 /* Message is too small to be correct. */
3593 printk(KERN_WARNING PFX "BMC returned to small a message"
3594 " for netfn %x cmd %x, got %d bytes\n",
3595 (msg->data[0] >> 2) | 1, msg->data[1], msg->rsp_size);
3597 /* Generate an error response for the message. */
3598 msg->rsp[0] = msg->data[0] | (1 << 2);
3599 msg->rsp[1] = msg->data[1];
3600 msg->rsp[2] = IPMI_ERR_UNSPECIFIED;
3602 } else if (((msg->rsp[0] >> 2) != ((msg->data[0] >> 2) | 1))
3603 || (msg->rsp[1] != msg->data[1])) {
3605 * The NetFN and Command in the response is not even
3606 * marginally correct.
3608 printk(KERN_WARNING PFX "BMC returned incorrect response,"
3609 " expected netfn %x cmd %x, got netfn %x cmd %x\n",
3610 (msg->data[0] >> 2) | 1, msg->data[1],
3611 msg->rsp[0] >> 2, msg->rsp[1]);
3613 /* Generate an error response for the message. */
3614 msg->rsp[0] = msg->data[0] | (1 << 2);
3615 msg->rsp[1] = msg->data[1];
3616 msg->rsp[2] = IPMI_ERR_UNSPECIFIED;
3620 if ((msg->rsp[0] == ((IPMI_NETFN_APP_REQUEST|1) << 2))
3621 && (msg->rsp[1] == IPMI_SEND_MSG_CMD)
3622 && (msg->user_data != NULL)) {
3624 * It's a response to a response we sent. For this we
3625 * deliver a send message response to the user.
3627 struct ipmi_recv_msg *recv_msg = msg->user_data;
3630 if (msg->rsp_size < 2)
3631 /* Message is too small to be correct. */
3634 chan = msg->data[2] & 0x0f;
3635 if (chan >= IPMI_MAX_CHANNELS)
3636 /* Invalid channel number */
3642 /* Make sure the user still exists. */
3643 if (!recv_msg->user || !recv_msg->user->valid)
3646 recv_msg->recv_type = IPMI_RESPONSE_RESPONSE_TYPE;
3647 recv_msg->msg.data = recv_msg->msg_data;
3648 recv_msg->msg.data_len = 1;
3649 recv_msg->msg_data[0] = msg->rsp[2];
3650 deliver_response(recv_msg);
3651 } else if ((msg->rsp[0] == ((IPMI_NETFN_APP_REQUEST|1) << 2))
3652 && (msg->rsp[1] == IPMI_GET_MSG_CMD)) {
3653 /* It's from the receive queue. */
3654 chan = msg->rsp[3] & 0xf;
3655 if (chan >= IPMI_MAX_CHANNELS) {
3656 /* Invalid channel number */
3662 * We need to make sure the channels have been initialized.
3663 * The channel_handler routine will set the "curr_channel"
3664 * equal to or greater than IPMI_MAX_CHANNELS when all the
3665 * channels for this interface have been initialized.
3667 if (intf->curr_channel < IPMI_MAX_CHANNELS) {
3668 requeue = 0; /* Throw the message away */
3672 switch (intf->channels[chan].medium) {
3673 case IPMI_CHANNEL_MEDIUM_IPMB:
3674 if (msg->rsp[4] & 0x04) {
3676 * It's a response, so find the
3677 * requesting message and send it up.
3679 requeue = handle_ipmb_get_msg_rsp(intf, msg);
3682 * It's a command to the SMS from some other
3683 * entity. Handle that.
3685 requeue = handle_ipmb_get_msg_cmd(intf, msg);
3689 case IPMI_CHANNEL_MEDIUM_8023LAN:
3690 case IPMI_CHANNEL_MEDIUM_ASYNC:
3691 if (msg->rsp[6] & 0x04) {
3693 * It's a response, so find the
3694 * requesting message and send it up.
3696 requeue = handle_lan_get_msg_rsp(intf, msg);
3699 * It's a command to the SMS from some other
3700 * entity. Handle that.
3702 requeue = handle_lan_get_msg_cmd(intf, msg);
3707 /* Check for OEM Channels. Clients had better
3708 register for these commands. */
3709 if ((intf->channels[chan].medium
3710 >= IPMI_CHANNEL_MEDIUM_OEM_MIN)
3711 && (intf->channels[chan].medium
3712 <= IPMI_CHANNEL_MEDIUM_OEM_MAX)) {
3713 requeue = handle_oem_get_msg_cmd(intf, msg);
3716 * We don't handle the channel type, so just
3723 } else if ((msg->rsp[0] == ((IPMI_NETFN_APP_REQUEST|1) << 2))
3724 && (msg->rsp[1] == IPMI_READ_EVENT_MSG_BUFFER_CMD)) {
3725 /* It's an asyncronous event. */
3726 requeue = handle_read_event_rsp(intf, msg);
3728 /* It's a response from the local BMC. */
3729 requeue = handle_bmc_rsp(intf, msg);
3736 /* Handle a new message from the lower layer. */
3737 void ipmi_smi_msg_received(ipmi_smi_t intf,
3738 struct ipmi_smi_msg *msg)
3740 unsigned long flags = 0; /* keep us warning-free. */
3742 int run_to_completion;
3745 if ((msg->data_size >= 2)
3746 && (msg->data[0] == (IPMI_NETFN_APP_REQUEST << 2))
3747 && (msg->data[1] == IPMI_SEND_MSG_CMD)
3748 && (msg->user_data == NULL)) {
3750 * This is the local response to a command send, start
3751 * the timer for these. The user_data will not be
3752 * NULL if this is a response send, and we will let
3753 * response sends just go through.
3757 * Check for errors, if we get certain errors (ones
3758 * that mean basically we can try again later), we
3759 * ignore them and start the timer. Otherwise we
3760 * report the error immediately.
3762 if ((msg->rsp_size >= 3) && (msg->rsp[2] != 0)
3763 && (msg->rsp[2] != IPMI_NODE_BUSY_ERR)
3764 && (msg->rsp[2] != IPMI_LOST_ARBITRATION_ERR)
3765 && (msg->rsp[2] != IPMI_BUS_ERR)
3766 && (msg->rsp[2] != IPMI_NAK_ON_WRITE_ERR)) {
3767 int chan = msg->rsp[3] & 0xf;
3769 /* Got an error sending the message, handle it. */
3770 if (chan >= IPMI_MAX_CHANNELS)
3771 ; /* This shouldn't happen */
3772 else if ((intf->channels[chan].medium
3773 == IPMI_CHANNEL_MEDIUM_8023LAN)
3774 || (intf->channels[chan].medium
3775 == IPMI_CHANNEL_MEDIUM_ASYNC))
3776 ipmi_inc_stat(intf, sent_lan_command_errs);
3778 ipmi_inc_stat(intf, sent_ipmb_command_errs);
3779 intf_err_seq(intf, msg->msgid, msg->rsp[2]);
3781 /* The message was sent, start the timer. */
3782 intf_start_seq_timer(intf, msg->msgid);
3784 ipmi_free_smi_msg(msg);
3789 * To preserve message order, if the list is not empty, we
3790 * tack this message onto the end of the list.
3792 run_to_completion = intf->run_to_completion;
3793 if (!run_to_completion)
3794 spin_lock_irqsave(&intf->waiting_msgs_lock, flags);
3795 if (!list_empty(&intf->waiting_msgs)) {
3796 list_add_tail(&msg->link, &intf->waiting_msgs);
3797 if (!run_to_completion)
3798 spin_unlock_irqrestore(&intf->waiting_msgs_lock, flags);
3801 if (!run_to_completion)
3802 spin_unlock_irqrestore(&intf->waiting_msgs_lock, flags);
3804 rv = handle_new_recv_msg(intf, msg);
3807 * Could not handle the message now, just add it to a
3808 * list to handle later.
3810 run_to_completion = intf->run_to_completion;
3811 if (!run_to_completion)
3812 spin_lock_irqsave(&intf->waiting_msgs_lock, flags);
3813 list_add_tail(&msg->link, &intf->waiting_msgs);
3814 if (!run_to_completion)
3815 spin_unlock_irqrestore(&intf->waiting_msgs_lock, flags);
3816 } else if (rv == 0) {
3817 ipmi_free_smi_msg(msg);
3823 EXPORT_SYMBOL(ipmi_smi_msg_received);
3825 void ipmi_smi_watchdog_pretimeout(ipmi_smi_t intf)
3830 list_for_each_entry_rcu(user, &intf->users, link) {
3831 if (!user->handler->ipmi_watchdog_pretimeout)
3834 user->handler->ipmi_watchdog_pretimeout(user->handler_data);
3838 EXPORT_SYMBOL(ipmi_smi_watchdog_pretimeout);
3840 static struct ipmi_smi_msg *
3841 smi_from_recv_msg(ipmi_smi_t intf, struct ipmi_recv_msg *recv_msg,
3842 unsigned char seq, long seqid)
3844 struct ipmi_smi_msg *smi_msg = ipmi_alloc_smi_msg();
3847 * If we can't allocate the message, then just return, we
3848 * get 4 retries, so this should be ok.
3852 memcpy(smi_msg->data, recv_msg->msg.data, recv_msg->msg.data_len);
3853 smi_msg->data_size = recv_msg->msg.data_len;
3854 smi_msg->msgid = STORE_SEQ_IN_MSGID(seq, seqid);
3860 for (m = 0; m < smi_msg->data_size; m++)
3861 printk(" %2.2x", smi_msg->data[m]);
3868 static void check_msg_timeout(ipmi_smi_t intf, struct seq_table *ent,
3869 struct list_head *timeouts, long timeout_period,
3870 int slot, unsigned long *flags)
3872 struct ipmi_recv_msg *msg;
3873 struct ipmi_smi_handlers *handlers;
3875 if (intf->intf_num == -1)
3881 ent->timeout -= timeout_period;
3882 if (ent->timeout > 0)
3885 if (ent->retries_left == 0) {
3886 /* The message has used all its retries. */
3888 msg = ent->recv_msg;
3889 list_add_tail(&msg->link, timeouts);
3891 ipmi_inc_stat(intf, timed_out_ipmb_broadcasts);
3892 else if (is_lan_addr(&ent->recv_msg->addr))
3893 ipmi_inc_stat(intf, timed_out_lan_commands);
3895 ipmi_inc_stat(intf, timed_out_ipmb_commands);
3897 struct ipmi_smi_msg *smi_msg;
3898 /* More retries, send again. */
3901 * Start with the max timer, set to normal timer after
3902 * the message is sent.
3904 ent->timeout = MAX_MSG_TIMEOUT;
3905 ent->retries_left--;
3906 smi_msg = smi_from_recv_msg(intf, ent->recv_msg, slot,
3909 if (is_lan_addr(&ent->recv_msg->addr))
3911 dropped_rexmit_lan_commands);
3914 dropped_rexmit_ipmb_commands);
3918 spin_unlock_irqrestore(&intf->seq_lock, *flags);
3921 * Send the new message. We send with a zero
3922 * priority. It timed out, I doubt time is that
3923 * critical now, and high priority messages are really
3924 * only for messages to the local MC, which don't get
3927 handlers = intf->handlers;
3929 if (is_lan_addr(&ent->recv_msg->addr))
3931 retransmitted_lan_commands);
3934 retransmitted_ipmb_commands);
3936 intf->handlers->sender(intf->send_info,
3939 ipmi_free_smi_msg(smi_msg);
3941 spin_lock_irqsave(&intf->seq_lock, *flags);
3945 static void ipmi_timeout_handler(long timeout_period)
3948 struct list_head timeouts;
3949 struct ipmi_recv_msg *msg, *msg2;
3950 struct ipmi_smi_msg *smi_msg, *smi_msg2;
3951 unsigned long flags;
3955 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
3956 /* See if any waiting messages need to be processed. */
3957 spin_lock_irqsave(&intf->waiting_msgs_lock, flags);
3958 list_for_each_entry_safe(smi_msg, smi_msg2,
3959 &intf->waiting_msgs, link) {
3960 if (!handle_new_recv_msg(intf, smi_msg)) {
3961 list_del(&smi_msg->link);
3962 ipmi_free_smi_msg(smi_msg);
3965 * To preserve message order, quit if we
3966 * can't handle a message.
3971 spin_unlock_irqrestore(&intf->waiting_msgs_lock, flags);
3974 * Go through the seq table and find any messages that
3975 * have timed out, putting them in the timeouts
3978 INIT_LIST_HEAD(&timeouts);
3979 spin_lock_irqsave(&intf->seq_lock, flags);
3980 for (i = 0; i < IPMI_IPMB_NUM_SEQ; i++)
3981 check_msg_timeout(intf, &(intf->seq_table[i]),
3982 &timeouts, timeout_period, i,
3984 spin_unlock_irqrestore(&intf->seq_lock, flags);
3986 list_for_each_entry_safe(msg, msg2, &timeouts, link)
3987 deliver_err_response(msg, IPMI_TIMEOUT_COMPLETION_CODE);
3990 * Maintenance mode handling. Check the timeout
3991 * optimistically before we claim the lock. It may
3992 * mean a timeout gets missed occasionally, but that
3993 * only means the timeout gets extended by one period
3994 * in that case. No big deal, and it avoids the lock
3997 if (intf->auto_maintenance_timeout > 0) {
3998 spin_lock_irqsave(&intf->maintenance_mode_lock, flags);
3999 if (intf->auto_maintenance_timeout > 0) {
4000 intf->auto_maintenance_timeout
4002 if (!intf->maintenance_mode
4003 && (intf->auto_maintenance_timeout <= 0)) {
4004 intf->maintenance_mode_enable = 0;
4005 maintenance_mode_update(intf);
4008 spin_unlock_irqrestore(&intf->maintenance_mode_lock,
4015 static void ipmi_request_event(void)
4018 struct ipmi_smi_handlers *handlers;
4022 * Called from the timer, no need to check if handlers is
4025 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
4026 /* No event requests when in maintenance mode. */
4027 if (intf->maintenance_mode_enable)
4030 handlers = intf->handlers;
4032 handlers->request_events(intf->send_info);
4037 static struct timer_list ipmi_timer;
4039 /* Call every ~1000 ms. */
4040 #define IPMI_TIMEOUT_TIME 1000
4042 /* How many jiffies does it take to get to the timeout time. */
4043 #define IPMI_TIMEOUT_JIFFIES ((IPMI_TIMEOUT_TIME * HZ) / 1000)
4046 * Request events from the queue every second (this is the number of
4047 * IPMI_TIMEOUT_TIMES between event requests). Hopefully, in the
4048 * future, IPMI will add a way to know immediately if an event is in
4049 * the queue and this silliness can go away.
4051 #define IPMI_REQUEST_EV_TIME (1000 / (IPMI_TIMEOUT_TIME))
4053 static atomic_t stop_operation;
4054 static unsigned int ticks_to_req_ev = IPMI_REQUEST_EV_TIME;
4056 static void ipmi_timeout(unsigned long data)
4058 if (atomic_read(&stop_operation))
4062 if (ticks_to_req_ev == 0) {
4063 ipmi_request_event();
4064 ticks_to_req_ev = IPMI_REQUEST_EV_TIME;
4067 ipmi_timeout_handler(IPMI_TIMEOUT_TIME);
4069 mod_timer(&ipmi_timer, jiffies + IPMI_TIMEOUT_JIFFIES);
4073 static atomic_t smi_msg_inuse_count = ATOMIC_INIT(0);
4074 static atomic_t recv_msg_inuse_count = ATOMIC_INIT(0);
4076 /* FIXME - convert these to slabs. */
4077 static void free_smi_msg(struct ipmi_smi_msg *msg)
4079 atomic_dec(&smi_msg_inuse_count);
4083 struct ipmi_smi_msg *ipmi_alloc_smi_msg(void)
4085 struct ipmi_smi_msg *rv;
4086 rv = kmalloc(sizeof(struct ipmi_smi_msg), GFP_ATOMIC);
4088 rv->done = free_smi_msg;
4089 rv->user_data = NULL;
4090 atomic_inc(&smi_msg_inuse_count);
4094 EXPORT_SYMBOL(ipmi_alloc_smi_msg);
4096 static void free_recv_msg(struct ipmi_recv_msg *msg)
4098 atomic_dec(&recv_msg_inuse_count);
4102 static struct ipmi_recv_msg *ipmi_alloc_recv_msg(void)
4104 struct ipmi_recv_msg *rv;
4106 rv = kmalloc(sizeof(struct ipmi_recv_msg), GFP_ATOMIC);
4109 rv->done = free_recv_msg;
4110 atomic_inc(&recv_msg_inuse_count);
4115 void ipmi_free_recv_msg(struct ipmi_recv_msg *msg)
4118 kref_put(&msg->user->refcount, free_user);
4121 EXPORT_SYMBOL(ipmi_free_recv_msg);
4123 #ifdef CONFIG_IPMI_PANIC_EVENT
4125 static void dummy_smi_done_handler(struct ipmi_smi_msg *msg)
4129 static void dummy_recv_done_handler(struct ipmi_recv_msg *msg)
4133 #ifdef CONFIG_IPMI_PANIC_STRING
4134 static void event_receiver_fetcher(ipmi_smi_t intf, struct ipmi_recv_msg *msg)
4136 if ((msg->addr.addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
4137 && (msg->msg.netfn == IPMI_NETFN_SENSOR_EVENT_RESPONSE)
4138 && (msg->msg.cmd == IPMI_GET_EVENT_RECEIVER_CMD)
4139 && (msg->msg.data[0] == IPMI_CC_NO_ERROR)) {
4140 /* A get event receiver command, save it. */
4141 intf->event_receiver = msg->msg.data[1];
4142 intf->event_receiver_lun = msg->msg.data[2] & 0x3;
4146 static void device_id_fetcher(ipmi_smi_t intf, struct ipmi_recv_msg *msg)
4148 if ((msg->addr.addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
4149 && (msg->msg.netfn == IPMI_NETFN_APP_RESPONSE)
4150 && (msg->msg.cmd == IPMI_GET_DEVICE_ID_CMD)
4151 && (msg->msg.data[0] == IPMI_CC_NO_ERROR)) {
4153 * A get device id command, save if we are an event
4154 * receiver or generator.
4156 intf->local_sel_device = (msg->msg.data[6] >> 2) & 1;
4157 intf->local_event_generator = (msg->msg.data[6] >> 5) & 1;
4162 static void send_panic_events(char *str)
4164 struct kernel_ipmi_msg msg;
4166 unsigned char data[16];
4167 struct ipmi_system_interface_addr *si;
4168 struct ipmi_addr addr;
4169 struct ipmi_smi_msg smi_msg;
4170 struct ipmi_recv_msg recv_msg;
4172 si = (struct ipmi_system_interface_addr *) &addr;
4173 si->addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
4174 si->channel = IPMI_BMC_CHANNEL;
4177 /* Fill in an event telling that we have failed. */
4178 msg.netfn = 0x04; /* Sensor or Event. */
4179 msg.cmd = 2; /* Platform event command. */
4182 data[0] = 0x41; /* Kernel generator ID, IPMI table 5-4 */
4183 data[1] = 0x03; /* This is for IPMI 1.0. */
4184 data[2] = 0x20; /* OS Critical Stop, IPMI table 36-3 */
4185 data[4] = 0x6f; /* Sensor specific, IPMI table 36-1 */
4186 data[5] = 0xa1; /* Runtime stop OEM bytes 2 & 3. */
4189 * Put a few breadcrumbs in. Hopefully later we can add more things
4190 * to make the panic events more useful.
4198 smi_msg.done = dummy_smi_done_handler;
4199 recv_msg.done = dummy_recv_done_handler;
4201 /* For every registered interface, send the event. */
4202 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
4203 if (!intf->handlers)
4204 /* Interface is not ready. */
4207 intf->run_to_completion = 1;
4208 /* Send the event announcing the panic. */
4209 intf->handlers->set_run_to_completion(intf->send_info, 1);
4210 i_ipmi_request(NULL,
4219 intf->channels[0].address,
4220 intf->channels[0].lun,
4221 0, 1); /* Don't retry, and don't wait. */
4224 #ifdef CONFIG_IPMI_PANIC_STRING
4226 * On every interface, dump a bunch of OEM event holding the
4232 /* For every registered interface, send the event. */
4233 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
4235 struct ipmi_ipmb_addr *ipmb;
4238 if (intf->intf_num == -1)
4239 /* Interface was not ready yet. */
4243 * intf_num is used as an marker to tell if the
4244 * interface is valid. Thus we need a read barrier to
4245 * make sure data fetched before checking intf_num
4251 * First job here is to figure out where to send the
4252 * OEM events. There's no way in IPMI to send OEM
4253 * events using an event send command, so we have to
4254 * find the SEL to put them in and stick them in
4258 /* Get capabilities from the get device id. */
4259 intf->local_sel_device = 0;
4260 intf->local_event_generator = 0;
4261 intf->event_receiver = 0;
4263 /* Request the device info from the local MC. */
4264 msg.netfn = IPMI_NETFN_APP_REQUEST;
4265 msg.cmd = IPMI_GET_DEVICE_ID_CMD;
4268 intf->null_user_handler = device_id_fetcher;
4269 i_ipmi_request(NULL,
4278 intf->channels[0].address,
4279 intf->channels[0].lun,
4280 0, 1); /* Don't retry, and don't wait. */
4282 if (intf->local_event_generator) {
4283 /* Request the event receiver from the local MC. */
4284 msg.netfn = IPMI_NETFN_SENSOR_EVENT_REQUEST;
4285 msg.cmd = IPMI_GET_EVENT_RECEIVER_CMD;
4288 intf->null_user_handler = event_receiver_fetcher;
4289 i_ipmi_request(NULL,
4298 intf->channels[0].address,
4299 intf->channels[0].lun,
4300 0, 1); /* no retry, and no wait. */
4302 intf->null_user_handler = NULL;
4305 * Validate the event receiver. The low bit must not
4306 * be 1 (it must be a valid IPMB address), it cannot
4307 * be zero, and it must not be my address.
4309 if (((intf->event_receiver & 1) == 0)
4310 && (intf->event_receiver != 0)
4311 && (intf->event_receiver != intf->channels[0].address)) {
4313 * The event receiver is valid, send an IPMB
4316 ipmb = (struct ipmi_ipmb_addr *) &addr;
4317 ipmb->addr_type = IPMI_IPMB_ADDR_TYPE;
4318 ipmb->channel = 0; /* FIXME - is this right? */
4319 ipmb->lun = intf->event_receiver_lun;
4320 ipmb->slave_addr = intf->event_receiver;
4321 } else if (intf->local_sel_device) {
4323 * The event receiver was not valid (or was
4324 * me), but I am an SEL device, just dump it
4327 si = (struct ipmi_system_interface_addr *) &addr;
4328 si->addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
4329 si->channel = IPMI_BMC_CHANNEL;
4332 continue; /* No where to send the event. */
4334 msg.netfn = IPMI_NETFN_STORAGE_REQUEST; /* Storage. */
4335 msg.cmd = IPMI_ADD_SEL_ENTRY_CMD;
4341 int size = strlen(p);
4347 data[2] = 0xf0; /* OEM event without timestamp. */
4348 data[3] = intf->channels[0].address;
4349 data[4] = j++; /* sequence # */
4351 * Always give 11 bytes, so strncpy will fill
4352 * it with zeroes for me.
4354 strncpy(data+5, p, 11);
4357 i_ipmi_request(NULL,
4366 intf->channels[0].address,
4367 intf->channels[0].lun,
4368 0, 1); /* no retry, and no wait. */
4371 #endif /* CONFIG_IPMI_PANIC_STRING */
4373 #endif /* CONFIG_IPMI_PANIC_EVENT */
4375 static int has_panicked;
4377 static int panic_event(struct notifier_block *this,
4378 unsigned long event,
4387 /* For every registered interface, set it to run to completion. */
4388 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
4389 if (!intf->handlers)
4390 /* Interface is not ready. */
4393 intf->run_to_completion = 1;
4394 intf->handlers->set_run_to_completion(intf->send_info, 1);
4397 #ifdef CONFIG_IPMI_PANIC_EVENT
4398 send_panic_events(ptr);
4404 static struct notifier_block panic_block = {
4405 .notifier_call = panic_event,
4407 .priority = 200 /* priority: INT_MAX >= x >= 0 */
4410 static int ipmi_init_msghandler(void)
4417 rv = driver_register(&ipmidriver.driver);
4419 printk(KERN_ERR PFX "Could not register IPMI driver\n");
4423 printk(KERN_INFO "ipmi message handler version "
4424 IPMI_DRIVER_VERSION "\n");
4426 #ifdef CONFIG_PROC_FS
4427 proc_ipmi_root = proc_mkdir("ipmi", NULL);
4428 if (!proc_ipmi_root) {
4429 printk(KERN_ERR PFX "Unable to create IPMI proc dir");
4433 #endif /* CONFIG_PROC_FS */
4435 setup_timer(&ipmi_timer, ipmi_timeout, 0);
4436 mod_timer(&ipmi_timer, jiffies + IPMI_TIMEOUT_JIFFIES);
4438 atomic_notifier_chain_register(&panic_notifier_list, &panic_block);
4445 static __init int ipmi_init_msghandler_mod(void)
4447 ipmi_init_msghandler();
4451 static __exit void cleanup_ipmi(void)
4458 atomic_notifier_chain_unregister(&panic_notifier_list, &panic_block);
4461 * This can't be called if any interfaces exist, so no worry
4462 * about shutting down the interfaces.
4466 * Tell the timer to stop, then wait for it to stop. This
4467 * avoids problems with race conditions removing the timer
4470 atomic_inc(&stop_operation);
4471 del_timer_sync(&ipmi_timer);
4473 #ifdef CONFIG_PROC_FS
4474 remove_proc_entry(proc_ipmi_root->name, NULL);
4475 #endif /* CONFIG_PROC_FS */
4477 driver_unregister(&ipmidriver.driver);
4481 /* Check for buffer leaks. */
4482 count = atomic_read(&smi_msg_inuse_count);
4484 printk(KERN_WARNING PFX "SMI message count %d at exit\n",
4486 count = atomic_read(&recv_msg_inuse_count);
4488 printk(KERN_WARNING PFX "recv message count %d at exit\n",
4491 module_exit(cleanup_ipmi);
4493 module_init(ipmi_init_msghandler_mod);
4494 MODULE_LICENSE("GPL");
4495 MODULE_AUTHOR("Corey Minyard <minyard@mvista.com>");
4496 MODULE_DESCRIPTION("Incoming and outgoing message routing for an IPMI"
4498 MODULE_VERSION(IPMI_DRIVER_VERSION);