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 <linux/poll.h>
37 #include <linux/sched.h>
38 #include <linux/seq_file.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>
48 #include <linux/interrupt.h>
50 #define PFX "IPMI message handler: "
52 #define IPMI_DRIVER_VERSION "39.2"
54 static struct ipmi_recv_msg *ipmi_alloc_recv_msg(void);
55 static int ipmi_init_msghandler(void);
56 static void smi_recv_tasklet(unsigned long);
57 static void handle_new_recv_msgs(ipmi_smi_t intf);
58 static void need_waiter(ipmi_smi_t intf);
59 static int handle_one_recv_msg(ipmi_smi_t intf,
60 struct ipmi_smi_msg *msg);
62 static int initialized;
65 static struct proc_dir_entry *proc_ipmi_root;
66 #endif /* CONFIG_PROC_FS */
68 /* Remain in auto-maintenance mode for this amount of time (in ms). */
69 #define IPMI_MAINTENANCE_MODE_TIMEOUT 30000
71 #define MAX_EVENTS_IN_QUEUE 25
74 * Don't let a message sit in a queue forever, always time it with at lest
75 * the max message timer. This is in milliseconds.
77 #define MAX_MSG_TIMEOUT 60000
79 /* Call every ~1000 ms. */
80 #define IPMI_TIMEOUT_TIME 1000
82 /* How many jiffies does it take to get to the timeout time. */
83 #define IPMI_TIMEOUT_JIFFIES ((IPMI_TIMEOUT_TIME * HZ) / 1000)
86 * Request events from the queue every second (this is the number of
87 * IPMI_TIMEOUT_TIMES between event requests). Hopefully, in the
88 * future, IPMI will add a way to know immediately if an event is in
89 * the queue and this silliness can go away.
91 #define IPMI_REQUEST_EV_TIME (1000 / (IPMI_TIMEOUT_TIME))
94 * The main "user" data structure.
97 struct list_head link;
99 /* Set to false when the user is destroyed. */
102 struct kref refcount;
104 /* The upper layer that handles receive messages. */
105 struct ipmi_user_hndl *handler;
108 /* The interface this user is bound to. */
111 /* Does this interface receive IPMI events? */
116 struct list_head link;
124 * This is used to form a linked lised during mass deletion.
125 * Since this is in an RCU list, we cannot use the link above
126 * or change any data until the RCU period completes. So we
127 * use this next variable during mass deletion so we can have
128 * a list and don't have to wait and restart the search on
129 * every individual deletion of a command.
131 struct cmd_rcvr *next;
135 unsigned int inuse : 1;
136 unsigned int broadcast : 1;
138 unsigned long timeout;
139 unsigned long orig_timeout;
140 unsigned int retries_left;
143 * To verify on an incoming send message response that this is
144 * the message that the response is for, we keep a sequence id
145 * and increment it every time we send a message.
150 * This is held so we can properly respond to the message on a
151 * timeout, and it is used to hold the temporary data for
152 * retransmission, too.
154 struct ipmi_recv_msg *recv_msg;
158 * Store the information in a msgid (long) to allow us to find a
159 * sequence table entry from the msgid.
161 #define STORE_SEQ_IN_MSGID(seq, seqid) (((seq&0xff)<<26) | (seqid&0x3ffffff))
163 #define GET_SEQ_FROM_MSGID(msgid, seq, seqid) \
165 seq = ((msgid >> 26) & 0x3f); \
166 seqid = (msgid & 0x3fffff); \
169 #define NEXT_SEQID(seqid) (((seqid) + 1) & 0x3fffff)
171 struct ipmi_channel {
172 unsigned char medium;
173 unsigned char protocol;
176 * My slave address. This is initialized to IPMI_BMC_SLAVE_ADDR,
177 * but may be changed by the user.
179 unsigned char address;
182 * My LUN. This should generally stay the SMS LUN, but just in
188 #ifdef CONFIG_PROC_FS
189 struct ipmi_proc_entry {
191 struct ipmi_proc_entry *next;
196 struct platform_device pdev;
197 struct ipmi_device_id id;
198 unsigned char guid[16];
201 struct kref usecount;
203 #define to_bmc_device(x) container_of((x), struct bmc_device, pdev.dev)
206 * Various statistics for IPMI, these index stats[] in the ipmi_smi
209 enum ipmi_stat_indexes {
210 /* Commands we got from the user that were invalid. */
211 IPMI_STAT_sent_invalid_commands = 0,
213 /* Commands we sent to the MC. */
214 IPMI_STAT_sent_local_commands,
216 /* Responses from the MC that were delivered to a user. */
217 IPMI_STAT_handled_local_responses,
219 /* Responses from the MC that were not delivered to a user. */
220 IPMI_STAT_unhandled_local_responses,
222 /* Commands we sent out to the IPMB bus. */
223 IPMI_STAT_sent_ipmb_commands,
225 /* Commands sent on the IPMB that had errors on the SEND CMD */
226 IPMI_STAT_sent_ipmb_command_errs,
228 /* Each retransmit increments this count. */
229 IPMI_STAT_retransmitted_ipmb_commands,
232 * When a message times out (runs out of retransmits) this is
235 IPMI_STAT_timed_out_ipmb_commands,
238 * This is like above, but for broadcasts. Broadcasts are
239 * *not* included in the above count (they are expected to
242 IPMI_STAT_timed_out_ipmb_broadcasts,
244 /* Responses I have sent to the IPMB bus. */
245 IPMI_STAT_sent_ipmb_responses,
247 /* The response was delivered to the user. */
248 IPMI_STAT_handled_ipmb_responses,
250 /* The response had invalid data in it. */
251 IPMI_STAT_invalid_ipmb_responses,
253 /* The response didn't have anyone waiting for it. */
254 IPMI_STAT_unhandled_ipmb_responses,
256 /* Commands we sent out to the IPMB bus. */
257 IPMI_STAT_sent_lan_commands,
259 /* Commands sent on the IPMB that had errors on the SEND CMD */
260 IPMI_STAT_sent_lan_command_errs,
262 /* Each retransmit increments this count. */
263 IPMI_STAT_retransmitted_lan_commands,
266 * When a message times out (runs out of retransmits) this is
269 IPMI_STAT_timed_out_lan_commands,
271 /* Responses I have sent to the IPMB bus. */
272 IPMI_STAT_sent_lan_responses,
274 /* The response was delivered to the user. */
275 IPMI_STAT_handled_lan_responses,
277 /* The response had invalid data in it. */
278 IPMI_STAT_invalid_lan_responses,
280 /* The response didn't have anyone waiting for it. */
281 IPMI_STAT_unhandled_lan_responses,
283 /* The command was delivered to the user. */
284 IPMI_STAT_handled_commands,
286 /* The command had invalid data in it. */
287 IPMI_STAT_invalid_commands,
289 /* The command didn't have anyone waiting for it. */
290 IPMI_STAT_unhandled_commands,
292 /* Invalid data in an event. */
293 IPMI_STAT_invalid_events,
295 /* Events that were received with the proper format. */
298 /* Retransmissions on IPMB that failed. */
299 IPMI_STAT_dropped_rexmit_ipmb_commands,
301 /* Retransmissions on LAN that failed. */
302 IPMI_STAT_dropped_rexmit_lan_commands,
304 /* This *must* remain last, add new values above this. */
309 #define IPMI_IPMB_NUM_SEQ 64
310 #define IPMI_MAX_CHANNELS 16
312 /* What interface number are we? */
315 struct kref refcount;
317 /* Set when the interface is being unregistered. */
320 /* Used for a list of interfaces. */
321 struct list_head link;
324 * The list of upper layers that are using me. seq_lock
327 struct list_head users;
329 /* Information to supply to users. */
330 unsigned char ipmi_version_major;
331 unsigned char ipmi_version_minor;
333 /* Used for wake ups at startup. */
334 wait_queue_head_t waitq;
336 struct bmc_device *bmc;
340 * This is the lower-layer's sender routine. Note that you
341 * must either be holding the ipmi_interfaces_mutex or be in
342 * an umpreemptible region to use this. You must fetch the
343 * value into a local variable and make sure it is not NULL.
345 struct ipmi_smi_handlers *handlers;
348 #ifdef CONFIG_PROC_FS
349 /* A list of proc entries for this interface. */
350 struct mutex proc_entry_lock;
351 struct ipmi_proc_entry *proc_entries;
354 /* Driver-model device for the system interface. */
355 struct device *si_dev;
358 * A table of sequence numbers for this interface. We use the
359 * sequence numbers for IPMB messages that go out of the
360 * interface to match them up with their responses. A routine
361 * is called periodically to time the items in this list.
364 struct seq_table seq_table[IPMI_IPMB_NUM_SEQ];
368 * Messages queued for delivery. If delivery fails (out of memory
369 * for instance), They will stay in here to be processed later in a
370 * periodic timer interrupt. The tasklet is for handling received
371 * messages directly from the handler.
373 spinlock_t waiting_rcv_msgs_lock;
374 struct list_head waiting_rcv_msgs;
375 atomic_t watchdog_pretimeouts_to_deliver;
376 struct tasklet_struct recv_tasklet;
378 spinlock_t xmit_msgs_lock;
379 struct list_head xmit_msgs;
380 struct ipmi_smi_msg *curr_msg;
381 struct list_head hp_xmit_msgs;
384 * The list of command receivers that are registered for commands
387 struct mutex cmd_rcvrs_mutex;
388 struct list_head cmd_rcvrs;
391 * Events that were queues because no one was there to receive
394 spinlock_t events_lock; /* For dealing with event stuff. */
395 struct list_head waiting_events;
396 unsigned int waiting_events_count; /* How many events in queue? */
397 char delivering_events;
398 char event_msg_printed;
399 atomic_t event_waiters;
400 unsigned int ticks_to_req_ev;
401 int last_needs_timer;
404 * The event receiver for my BMC, only really used at panic
405 * shutdown as a place to store this.
407 unsigned char event_receiver;
408 unsigned char event_receiver_lun;
409 unsigned char local_sel_device;
410 unsigned char local_event_generator;
412 /* For handling of maintenance mode. */
413 int maintenance_mode;
414 bool maintenance_mode_enable;
415 int auto_maintenance_timeout;
416 spinlock_t maintenance_mode_lock; /* Used in a timer... */
419 * A cheap hack, if this is non-null and a message to an
420 * interface comes in with a NULL user, call this routine with
421 * it. Note that the message will still be freed by the
422 * caller. This only works on the system interface.
424 void (*null_user_handler)(ipmi_smi_t intf, struct ipmi_recv_msg *msg);
427 * When we are scanning the channels for an SMI, this will
428 * tell which channel we are scanning.
432 /* Channel information */
433 struct ipmi_channel channels[IPMI_MAX_CHANNELS];
436 struct proc_dir_entry *proc_dir;
437 char proc_dir_name[10];
439 atomic_t stats[IPMI_NUM_STATS];
442 * run_to_completion duplicate of smb_info, smi_info
443 * and ipmi_serial_info structures. Used to decrease numbers of
444 * parameters passed by "low" level IPMI code.
446 int run_to_completion;
448 #define to_si_intf_from_dev(device) container_of(device, struct ipmi_smi, dev)
451 * The driver model view of the IPMI messaging driver.
453 static struct platform_driver ipmidriver = {
456 .bus = &platform_bus_type
459 static DEFINE_MUTEX(ipmidriver_mutex);
461 static LIST_HEAD(ipmi_interfaces);
462 static DEFINE_MUTEX(ipmi_interfaces_mutex);
465 * List of watchers that want to know when smi's are added and deleted.
467 static LIST_HEAD(smi_watchers);
468 static DEFINE_MUTEX(smi_watchers_mutex);
470 #define ipmi_inc_stat(intf, stat) \
471 atomic_inc(&(intf)->stats[IPMI_STAT_ ## stat])
472 #define ipmi_get_stat(intf, stat) \
473 ((unsigned int) atomic_read(&(intf)->stats[IPMI_STAT_ ## stat]))
475 static char *addr_src_to_str[] = { "invalid", "hotmod", "hardcoded", "SPMI",
476 "ACPI", "SMBIOS", "PCI",
477 "device-tree", "default" };
479 const char *ipmi_addr_src_to_str(enum ipmi_addr_src src)
481 if (src > SI_DEFAULT)
482 src = 0; /* Invalid */
483 return addr_src_to_str[src];
485 EXPORT_SYMBOL(ipmi_addr_src_to_str);
487 static int is_lan_addr(struct ipmi_addr *addr)
489 return addr->addr_type == IPMI_LAN_ADDR_TYPE;
492 static int is_ipmb_addr(struct ipmi_addr *addr)
494 return addr->addr_type == IPMI_IPMB_ADDR_TYPE;
497 static int is_ipmb_bcast_addr(struct ipmi_addr *addr)
499 return addr->addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE;
502 static void free_recv_msg_list(struct list_head *q)
504 struct ipmi_recv_msg *msg, *msg2;
506 list_for_each_entry_safe(msg, msg2, q, link) {
507 list_del(&msg->link);
508 ipmi_free_recv_msg(msg);
512 static void free_smi_msg_list(struct list_head *q)
514 struct ipmi_smi_msg *msg, *msg2;
516 list_for_each_entry_safe(msg, msg2, q, link) {
517 list_del(&msg->link);
518 ipmi_free_smi_msg(msg);
522 static void clean_up_interface_data(ipmi_smi_t intf)
525 struct cmd_rcvr *rcvr, *rcvr2;
526 struct list_head list;
528 tasklet_kill(&intf->recv_tasklet);
530 free_smi_msg_list(&intf->waiting_rcv_msgs);
531 free_recv_msg_list(&intf->waiting_events);
534 * Wholesale remove all the entries from the list in the
535 * interface and wait for RCU to know that none are in use.
537 mutex_lock(&intf->cmd_rcvrs_mutex);
538 INIT_LIST_HEAD(&list);
539 list_splice_init_rcu(&intf->cmd_rcvrs, &list, synchronize_rcu);
540 mutex_unlock(&intf->cmd_rcvrs_mutex);
542 list_for_each_entry_safe(rcvr, rcvr2, &list, link)
545 for (i = 0; i < IPMI_IPMB_NUM_SEQ; i++) {
546 if ((intf->seq_table[i].inuse)
547 && (intf->seq_table[i].recv_msg))
548 ipmi_free_recv_msg(intf->seq_table[i].recv_msg);
552 static void intf_free(struct kref *ref)
554 ipmi_smi_t intf = container_of(ref, struct ipmi_smi, refcount);
556 clean_up_interface_data(intf);
560 struct watcher_entry {
563 struct list_head link;
566 int ipmi_smi_watcher_register(struct ipmi_smi_watcher *watcher)
569 LIST_HEAD(to_deliver);
570 struct watcher_entry *e, *e2;
572 mutex_lock(&smi_watchers_mutex);
574 mutex_lock(&ipmi_interfaces_mutex);
576 /* Build a list of things to deliver. */
577 list_for_each_entry(intf, &ipmi_interfaces, link) {
578 if (intf->intf_num == -1)
580 e = kmalloc(sizeof(*e), GFP_KERNEL);
583 kref_get(&intf->refcount);
585 e->intf_num = intf->intf_num;
586 list_add_tail(&e->link, &to_deliver);
589 /* We will succeed, so add it to the list. */
590 list_add(&watcher->link, &smi_watchers);
592 mutex_unlock(&ipmi_interfaces_mutex);
594 list_for_each_entry_safe(e, e2, &to_deliver, link) {
596 watcher->new_smi(e->intf_num, e->intf->si_dev);
597 kref_put(&e->intf->refcount, intf_free);
601 mutex_unlock(&smi_watchers_mutex);
606 mutex_unlock(&ipmi_interfaces_mutex);
607 mutex_unlock(&smi_watchers_mutex);
608 list_for_each_entry_safe(e, e2, &to_deliver, link) {
610 kref_put(&e->intf->refcount, intf_free);
615 EXPORT_SYMBOL(ipmi_smi_watcher_register);
617 int ipmi_smi_watcher_unregister(struct ipmi_smi_watcher *watcher)
619 mutex_lock(&smi_watchers_mutex);
620 list_del(&(watcher->link));
621 mutex_unlock(&smi_watchers_mutex);
624 EXPORT_SYMBOL(ipmi_smi_watcher_unregister);
627 * Must be called with smi_watchers_mutex held.
630 call_smi_watchers(int i, struct device *dev)
632 struct ipmi_smi_watcher *w;
634 list_for_each_entry(w, &smi_watchers, link) {
635 if (try_module_get(w->owner)) {
637 module_put(w->owner);
643 ipmi_addr_equal(struct ipmi_addr *addr1, struct ipmi_addr *addr2)
645 if (addr1->addr_type != addr2->addr_type)
648 if (addr1->channel != addr2->channel)
651 if (addr1->addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE) {
652 struct ipmi_system_interface_addr *smi_addr1
653 = (struct ipmi_system_interface_addr *) addr1;
654 struct ipmi_system_interface_addr *smi_addr2
655 = (struct ipmi_system_interface_addr *) addr2;
656 return (smi_addr1->lun == smi_addr2->lun);
659 if (is_ipmb_addr(addr1) || is_ipmb_bcast_addr(addr1)) {
660 struct ipmi_ipmb_addr *ipmb_addr1
661 = (struct ipmi_ipmb_addr *) addr1;
662 struct ipmi_ipmb_addr *ipmb_addr2
663 = (struct ipmi_ipmb_addr *) addr2;
665 return ((ipmb_addr1->slave_addr == ipmb_addr2->slave_addr)
666 && (ipmb_addr1->lun == ipmb_addr2->lun));
669 if (is_lan_addr(addr1)) {
670 struct ipmi_lan_addr *lan_addr1
671 = (struct ipmi_lan_addr *) addr1;
672 struct ipmi_lan_addr *lan_addr2
673 = (struct ipmi_lan_addr *) addr2;
675 return ((lan_addr1->remote_SWID == lan_addr2->remote_SWID)
676 && (lan_addr1->local_SWID == lan_addr2->local_SWID)
677 && (lan_addr1->session_handle
678 == lan_addr2->session_handle)
679 && (lan_addr1->lun == lan_addr2->lun));
685 int ipmi_validate_addr(struct ipmi_addr *addr, int len)
687 if (len < sizeof(struct ipmi_system_interface_addr))
690 if (addr->addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE) {
691 if (addr->channel != IPMI_BMC_CHANNEL)
696 if ((addr->channel == IPMI_BMC_CHANNEL)
697 || (addr->channel >= IPMI_MAX_CHANNELS)
698 || (addr->channel < 0))
701 if (is_ipmb_addr(addr) || is_ipmb_bcast_addr(addr)) {
702 if (len < sizeof(struct ipmi_ipmb_addr))
707 if (is_lan_addr(addr)) {
708 if (len < sizeof(struct ipmi_lan_addr))
715 EXPORT_SYMBOL(ipmi_validate_addr);
717 unsigned int ipmi_addr_length(int addr_type)
719 if (addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
720 return sizeof(struct ipmi_system_interface_addr);
722 if ((addr_type == IPMI_IPMB_ADDR_TYPE)
723 || (addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE))
724 return sizeof(struct ipmi_ipmb_addr);
726 if (addr_type == IPMI_LAN_ADDR_TYPE)
727 return sizeof(struct ipmi_lan_addr);
731 EXPORT_SYMBOL(ipmi_addr_length);
733 static void deliver_response(struct ipmi_recv_msg *msg)
736 ipmi_smi_t intf = msg->user_msg_data;
738 /* Special handling for NULL users. */
739 if (intf->null_user_handler) {
740 intf->null_user_handler(intf, msg);
741 ipmi_inc_stat(intf, handled_local_responses);
743 /* No handler, so give up. */
744 ipmi_inc_stat(intf, unhandled_local_responses);
746 ipmi_free_recv_msg(msg);
748 ipmi_user_t user = msg->user;
749 user->handler->ipmi_recv_hndl(msg, user->handler_data);
754 deliver_err_response(struct ipmi_recv_msg *msg, int err)
756 msg->recv_type = IPMI_RESPONSE_RECV_TYPE;
757 msg->msg_data[0] = err;
758 msg->msg.netfn |= 1; /* Convert to a response. */
759 msg->msg.data_len = 1;
760 msg->msg.data = msg->msg_data;
761 deliver_response(msg);
765 * Find the next sequence number not being used and add the given
766 * message with the given timeout to the sequence table. This must be
767 * called with the interface's seq_lock held.
769 static int intf_next_seq(ipmi_smi_t intf,
770 struct ipmi_recv_msg *recv_msg,
771 unsigned long timeout,
780 for (i = intf->curr_seq; (i+1)%IPMI_IPMB_NUM_SEQ != intf->curr_seq;
781 i = (i+1)%IPMI_IPMB_NUM_SEQ) {
782 if (!intf->seq_table[i].inuse)
786 if (!intf->seq_table[i].inuse) {
787 intf->seq_table[i].recv_msg = recv_msg;
790 * Start with the maximum timeout, when the send response
791 * comes in we will start the real timer.
793 intf->seq_table[i].timeout = MAX_MSG_TIMEOUT;
794 intf->seq_table[i].orig_timeout = timeout;
795 intf->seq_table[i].retries_left = retries;
796 intf->seq_table[i].broadcast = broadcast;
797 intf->seq_table[i].inuse = 1;
798 intf->seq_table[i].seqid = NEXT_SEQID(intf->seq_table[i].seqid);
800 *seqid = intf->seq_table[i].seqid;
801 intf->curr_seq = (i+1)%IPMI_IPMB_NUM_SEQ;
811 * Return the receive message for the given sequence number and
812 * release the sequence number so it can be reused. Some other data
813 * is passed in to be sure the message matches up correctly (to help
814 * guard against message coming in after their timeout and the
815 * sequence number being reused).
817 static int intf_find_seq(ipmi_smi_t intf,
822 struct ipmi_addr *addr,
823 struct ipmi_recv_msg **recv_msg)
828 if (seq >= IPMI_IPMB_NUM_SEQ)
831 spin_lock_irqsave(&(intf->seq_lock), flags);
832 if (intf->seq_table[seq].inuse) {
833 struct ipmi_recv_msg *msg = intf->seq_table[seq].recv_msg;
835 if ((msg->addr.channel == channel) && (msg->msg.cmd == cmd)
836 && (msg->msg.netfn == netfn)
837 && (ipmi_addr_equal(addr, &(msg->addr)))) {
839 intf->seq_table[seq].inuse = 0;
843 spin_unlock_irqrestore(&(intf->seq_lock), flags);
849 /* Start the timer for a specific sequence table entry. */
850 static int intf_start_seq_timer(ipmi_smi_t intf,
859 GET_SEQ_FROM_MSGID(msgid, seq, seqid);
861 spin_lock_irqsave(&(intf->seq_lock), flags);
863 * We do this verification because the user can be deleted
864 * while a message is outstanding.
866 if ((intf->seq_table[seq].inuse)
867 && (intf->seq_table[seq].seqid == seqid)) {
868 struct seq_table *ent = &(intf->seq_table[seq]);
869 ent->timeout = ent->orig_timeout;
872 spin_unlock_irqrestore(&(intf->seq_lock), flags);
877 /* Got an error for the send message for a specific sequence number. */
878 static int intf_err_seq(ipmi_smi_t intf,
886 struct ipmi_recv_msg *msg = NULL;
889 GET_SEQ_FROM_MSGID(msgid, seq, seqid);
891 spin_lock_irqsave(&(intf->seq_lock), flags);
893 * We do this verification because the user can be deleted
894 * while a message is outstanding.
896 if ((intf->seq_table[seq].inuse)
897 && (intf->seq_table[seq].seqid == seqid)) {
898 struct seq_table *ent = &(intf->seq_table[seq]);
904 spin_unlock_irqrestore(&(intf->seq_lock), flags);
907 deliver_err_response(msg, err);
913 int ipmi_create_user(unsigned int if_num,
914 struct ipmi_user_hndl *handler,
919 ipmi_user_t new_user;
924 * There is no module usecount here, because it's not
925 * required. Since this can only be used by and called from
926 * other modules, they will implicitly use this module, and
927 * thus this can't be removed unless the other modules are
935 * Make sure the driver is actually initialized, this handles
936 * problems with initialization order.
939 rv = ipmi_init_msghandler();
944 * The init code doesn't return an error if it was turned
945 * off, but it won't initialize. Check that.
951 new_user = kmalloc(sizeof(*new_user), GFP_KERNEL);
955 mutex_lock(&ipmi_interfaces_mutex);
956 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
957 if (intf->intf_num == if_num)
960 /* Not found, return an error */
965 /* Note that each existing user holds a refcount to the interface. */
966 kref_get(&intf->refcount);
968 kref_init(&new_user->refcount);
969 new_user->handler = handler;
970 new_user->handler_data = handler_data;
971 new_user->intf = intf;
972 new_user->gets_events = false;
974 if (!try_module_get(intf->handlers->owner)) {
979 if (intf->handlers->inc_usecount) {
980 rv = intf->handlers->inc_usecount(intf->send_info);
982 module_put(intf->handlers->owner);
988 * Hold the lock so intf->handlers is guaranteed to be good
991 mutex_unlock(&ipmi_interfaces_mutex);
993 new_user->valid = true;
994 spin_lock_irqsave(&intf->seq_lock, flags);
995 list_add_rcu(&new_user->link, &intf->users);
996 spin_unlock_irqrestore(&intf->seq_lock, flags);
997 if (handler->ipmi_watchdog_pretimeout) {
998 /* User wants pretimeouts, so make sure to watch for them. */
999 if (atomic_inc_return(&intf->event_waiters) == 1)
1006 kref_put(&intf->refcount, intf_free);
1008 mutex_unlock(&ipmi_interfaces_mutex);
1012 EXPORT_SYMBOL(ipmi_create_user);
1014 int ipmi_get_smi_info(int if_num, struct ipmi_smi_info *data)
1018 struct ipmi_smi_handlers *handlers;
1020 mutex_lock(&ipmi_interfaces_mutex);
1021 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
1022 if (intf->intf_num == if_num)
1025 /* Not found, return an error */
1027 mutex_unlock(&ipmi_interfaces_mutex);
1031 handlers = intf->handlers;
1033 if (handlers->get_smi_info)
1034 rv = handlers->get_smi_info(intf->send_info, data);
1035 mutex_unlock(&ipmi_interfaces_mutex);
1039 EXPORT_SYMBOL(ipmi_get_smi_info);
1041 static void free_user(struct kref *ref)
1043 ipmi_user_t user = container_of(ref, struct ipmi_user, refcount);
1047 int ipmi_destroy_user(ipmi_user_t user)
1049 ipmi_smi_t intf = user->intf;
1051 unsigned long flags;
1052 struct cmd_rcvr *rcvr;
1053 struct cmd_rcvr *rcvrs = NULL;
1055 user->valid = false;
1057 if (user->handler->ipmi_watchdog_pretimeout)
1058 atomic_dec(&intf->event_waiters);
1060 if (user->gets_events)
1061 atomic_dec(&intf->event_waiters);
1063 /* Remove the user from the interface's sequence table. */
1064 spin_lock_irqsave(&intf->seq_lock, flags);
1065 list_del_rcu(&user->link);
1067 for (i = 0; i < IPMI_IPMB_NUM_SEQ; i++) {
1068 if (intf->seq_table[i].inuse
1069 && (intf->seq_table[i].recv_msg->user == user)) {
1070 intf->seq_table[i].inuse = 0;
1071 ipmi_free_recv_msg(intf->seq_table[i].recv_msg);
1074 spin_unlock_irqrestore(&intf->seq_lock, flags);
1077 * Remove the user from the command receiver's table. First
1078 * we build a list of everything (not using the standard link,
1079 * since other things may be using it till we do
1080 * synchronize_rcu()) then free everything in that list.
1082 mutex_lock(&intf->cmd_rcvrs_mutex);
1083 list_for_each_entry_rcu(rcvr, &intf->cmd_rcvrs, link) {
1084 if (rcvr->user == user) {
1085 list_del_rcu(&rcvr->link);
1090 mutex_unlock(&intf->cmd_rcvrs_mutex);
1098 mutex_lock(&ipmi_interfaces_mutex);
1099 if (intf->handlers) {
1100 module_put(intf->handlers->owner);
1101 if (intf->handlers->dec_usecount)
1102 intf->handlers->dec_usecount(intf->send_info);
1104 mutex_unlock(&ipmi_interfaces_mutex);
1106 kref_put(&intf->refcount, intf_free);
1108 kref_put(&user->refcount, free_user);
1112 EXPORT_SYMBOL(ipmi_destroy_user);
1114 void ipmi_get_version(ipmi_user_t user,
1115 unsigned char *major,
1116 unsigned char *minor)
1118 *major = user->intf->ipmi_version_major;
1119 *minor = user->intf->ipmi_version_minor;
1121 EXPORT_SYMBOL(ipmi_get_version);
1123 int ipmi_set_my_address(ipmi_user_t user,
1124 unsigned int channel,
1125 unsigned char address)
1127 if (channel >= IPMI_MAX_CHANNELS)
1129 user->intf->channels[channel].address = address;
1132 EXPORT_SYMBOL(ipmi_set_my_address);
1134 int ipmi_get_my_address(ipmi_user_t user,
1135 unsigned int channel,
1136 unsigned char *address)
1138 if (channel >= IPMI_MAX_CHANNELS)
1140 *address = user->intf->channels[channel].address;
1143 EXPORT_SYMBOL(ipmi_get_my_address);
1145 int ipmi_set_my_LUN(ipmi_user_t user,
1146 unsigned int channel,
1149 if (channel >= IPMI_MAX_CHANNELS)
1151 user->intf->channels[channel].lun = LUN & 0x3;
1154 EXPORT_SYMBOL(ipmi_set_my_LUN);
1156 int ipmi_get_my_LUN(ipmi_user_t user,
1157 unsigned int channel,
1158 unsigned char *address)
1160 if (channel >= IPMI_MAX_CHANNELS)
1162 *address = user->intf->channels[channel].lun;
1165 EXPORT_SYMBOL(ipmi_get_my_LUN);
1167 int ipmi_get_maintenance_mode(ipmi_user_t user)
1170 unsigned long flags;
1172 spin_lock_irqsave(&user->intf->maintenance_mode_lock, flags);
1173 mode = user->intf->maintenance_mode;
1174 spin_unlock_irqrestore(&user->intf->maintenance_mode_lock, flags);
1178 EXPORT_SYMBOL(ipmi_get_maintenance_mode);
1180 static void maintenance_mode_update(ipmi_smi_t intf)
1182 if (intf->handlers->set_maintenance_mode)
1183 intf->handlers->set_maintenance_mode(
1184 intf->send_info, intf->maintenance_mode_enable);
1187 int ipmi_set_maintenance_mode(ipmi_user_t user, int mode)
1190 unsigned long flags;
1191 ipmi_smi_t intf = user->intf;
1193 spin_lock_irqsave(&intf->maintenance_mode_lock, flags);
1194 if (intf->maintenance_mode != mode) {
1196 case IPMI_MAINTENANCE_MODE_AUTO:
1197 intf->maintenance_mode_enable
1198 = (intf->auto_maintenance_timeout > 0);
1201 case IPMI_MAINTENANCE_MODE_OFF:
1202 intf->maintenance_mode_enable = false;
1205 case IPMI_MAINTENANCE_MODE_ON:
1206 intf->maintenance_mode_enable = true;
1213 intf->maintenance_mode = mode;
1215 maintenance_mode_update(intf);
1218 spin_unlock_irqrestore(&intf->maintenance_mode_lock, flags);
1222 EXPORT_SYMBOL(ipmi_set_maintenance_mode);
1224 int ipmi_set_gets_events(ipmi_user_t user, bool val)
1226 unsigned long flags;
1227 ipmi_smi_t intf = user->intf;
1228 struct ipmi_recv_msg *msg, *msg2;
1229 struct list_head msgs;
1231 INIT_LIST_HEAD(&msgs);
1233 spin_lock_irqsave(&intf->events_lock, flags);
1234 if (user->gets_events == val)
1237 user->gets_events = val;
1240 if (atomic_inc_return(&intf->event_waiters) == 1)
1243 atomic_dec(&intf->event_waiters);
1246 if (intf->delivering_events)
1248 * Another thread is delivering events for this, so
1249 * let it handle any new events.
1253 /* Deliver any queued events. */
1254 while (user->gets_events && !list_empty(&intf->waiting_events)) {
1255 list_for_each_entry_safe(msg, msg2, &intf->waiting_events, link)
1256 list_move_tail(&msg->link, &msgs);
1257 intf->waiting_events_count = 0;
1258 if (intf->event_msg_printed) {
1259 printk(KERN_WARNING PFX "Event queue no longer"
1261 intf->event_msg_printed = 0;
1264 intf->delivering_events = 1;
1265 spin_unlock_irqrestore(&intf->events_lock, flags);
1267 list_for_each_entry_safe(msg, msg2, &msgs, link) {
1269 kref_get(&user->refcount);
1270 deliver_response(msg);
1273 spin_lock_irqsave(&intf->events_lock, flags);
1274 intf->delivering_events = 0;
1278 spin_unlock_irqrestore(&intf->events_lock, flags);
1282 EXPORT_SYMBOL(ipmi_set_gets_events);
1284 static struct cmd_rcvr *find_cmd_rcvr(ipmi_smi_t intf,
1285 unsigned char netfn,
1289 struct cmd_rcvr *rcvr;
1291 list_for_each_entry_rcu(rcvr, &intf->cmd_rcvrs, link) {
1292 if ((rcvr->netfn == netfn) && (rcvr->cmd == cmd)
1293 && (rcvr->chans & (1 << chan)))
1299 static int is_cmd_rcvr_exclusive(ipmi_smi_t intf,
1300 unsigned char netfn,
1304 struct cmd_rcvr *rcvr;
1306 list_for_each_entry_rcu(rcvr, &intf->cmd_rcvrs, link) {
1307 if ((rcvr->netfn == netfn) && (rcvr->cmd == cmd)
1308 && (rcvr->chans & chans))
1314 int ipmi_register_for_cmd(ipmi_user_t user,
1315 unsigned char netfn,
1319 ipmi_smi_t intf = user->intf;
1320 struct cmd_rcvr *rcvr;
1324 rcvr = kmalloc(sizeof(*rcvr), GFP_KERNEL);
1328 rcvr->netfn = netfn;
1329 rcvr->chans = chans;
1332 mutex_lock(&intf->cmd_rcvrs_mutex);
1333 /* Make sure the command/netfn is not already registered. */
1334 if (!is_cmd_rcvr_exclusive(intf, netfn, cmd, chans)) {
1339 if (atomic_inc_return(&intf->event_waiters) == 1)
1342 list_add_rcu(&rcvr->link, &intf->cmd_rcvrs);
1345 mutex_unlock(&intf->cmd_rcvrs_mutex);
1351 EXPORT_SYMBOL(ipmi_register_for_cmd);
1353 int ipmi_unregister_for_cmd(ipmi_user_t user,
1354 unsigned char netfn,
1358 ipmi_smi_t intf = user->intf;
1359 struct cmd_rcvr *rcvr;
1360 struct cmd_rcvr *rcvrs = NULL;
1361 int i, rv = -ENOENT;
1363 mutex_lock(&intf->cmd_rcvrs_mutex);
1364 for (i = 0; i < IPMI_NUM_CHANNELS; i++) {
1365 if (((1 << i) & chans) == 0)
1367 rcvr = find_cmd_rcvr(intf, netfn, cmd, i);
1370 if (rcvr->user == user) {
1372 rcvr->chans &= ~chans;
1373 if (rcvr->chans == 0) {
1374 list_del_rcu(&rcvr->link);
1380 mutex_unlock(&intf->cmd_rcvrs_mutex);
1383 atomic_dec(&intf->event_waiters);
1390 EXPORT_SYMBOL(ipmi_unregister_for_cmd);
1392 static unsigned char
1393 ipmb_checksum(unsigned char *data, int size)
1395 unsigned char csum = 0;
1397 for (; size > 0; size--, data++)
1403 static inline void format_ipmb_msg(struct ipmi_smi_msg *smi_msg,
1404 struct kernel_ipmi_msg *msg,
1405 struct ipmi_ipmb_addr *ipmb_addr,
1407 unsigned char ipmb_seq,
1409 unsigned char source_address,
1410 unsigned char source_lun)
1414 /* Format the IPMB header data. */
1415 smi_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
1416 smi_msg->data[1] = IPMI_SEND_MSG_CMD;
1417 smi_msg->data[2] = ipmb_addr->channel;
1419 smi_msg->data[3] = 0;
1420 smi_msg->data[i+3] = ipmb_addr->slave_addr;
1421 smi_msg->data[i+4] = (msg->netfn << 2) | (ipmb_addr->lun & 0x3);
1422 smi_msg->data[i+5] = ipmb_checksum(&(smi_msg->data[i+3]), 2);
1423 smi_msg->data[i+6] = source_address;
1424 smi_msg->data[i+7] = (ipmb_seq << 2) | source_lun;
1425 smi_msg->data[i+8] = msg->cmd;
1427 /* Now tack on the data to the message. */
1428 if (msg->data_len > 0)
1429 memcpy(&(smi_msg->data[i+9]), msg->data,
1431 smi_msg->data_size = msg->data_len + 9;
1433 /* Now calculate the checksum and tack it on. */
1434 smi_msg->data[i+smi_msg->data_size]
1435 = ipmb_checksum(&(smi_msg->data[i+6]),
1436 smi_msg->data_size-6);
1439 * Add on the checksum size and the offset from the
1442 smi_msg->data_size += 1 + i;
1444 smi_msg->msgid = msgid;
1447 static inline void format_lan_msg(struct ipmi_smi_msg *smi_msg,
1448 struct kernel_ipmi_msg *msg,
1449 struct ipmi_lan_addr *lan_addr,
1451 unsigned char ipmb_seq,
1452 unsigned char source_lun)
1454 /* Format the IPMB header data. */
1455 smi_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
1456 smi_msg->data[1] = IPMI_SEND_MSG_CMD;
1457 smi_msg->data[2] = lan_addr->channel;
1458 smi_msg->data[3] = lan_addr->session_handle;
1459 smi_msg->data[4] = lan_addr->remote_SWID;
1460 smi_msg->data[5] = (msg->netfn << 2) | (lan_addr->lun & 0x3);
1461 smi_msg->data[6] = ipmb_checksum(&(smi_msg->data[4]), 2);
1462 smi_msg->data[7] = lan_addr->local_SWID;
1463 smi_msg->data[8] = (ipmb_seq << 2) | source_lun;
1464 smi_msg->data[9] = msg->cmd;
1466 /* Now tack on the data to the message. */
1467 if (msg->data_len > 0)
1468 memcpy(&(smi_msg->data[10]), msg->data,
1470 smi_msg->data_size = msg->data_len + 10;
1472 /* Now calculate the checksum and tack it on. */
1473 smi_msg->data[smi_msg->data_size]
1474 = ipmb_checksum(&(smi_msg->data[7]),
1475 smi_msg->data_size-7);
1478 * Add on the checksum size and the offset from the
1481 smi_msg->data_size += 1;
1483 smi_msg->msgid = msgid;
1486 static void smi_send(ipmi_smi_t intf, struct ipmi_smi_handlers *handlers,
1487 struct ipmi_smi_msg *smi_msg, int priority)
1489 int run_to_completion = intf->run_to_completion;
1490 unsigned long flags;
1492 if (!run_to_completion)
1493 spin_lock_irqsave(&intf->xmit_msgs_lock, flags);
1494 if (intf->curr_msg) {
1496 list_add_tail(&smi_msg->link, &intf->hp_xmit_msgs);
1498 list_add_tail(&smi_msg->link, &intf->xmit_msgs);
1501 intf->curr_msg = smi_msg;
1503 if (!run_to_completion)
1504 spin_unlock_irqrestore(&intf->xmit_msgs_lock, flags);
1507 handlers->sender(intf->send_info, smi_msg);
1511 * Separate from ipmi_request so that the user does not have to be
1512 * supplied in certain circumstances (mainly at panic time). If
1513 * messages are supplied, they will be freed, even if an error
1516 static int i_ipmi_request(ipmi_user_t user,
1518 struct ipmi_addr *addr,
1520 struct kernel_ipmi_msg *msg,
1521 void *user_msg_data,
1523 struct ipmi_recv_msg *supplied_recv,
1525 unsigned char source_address,
1526 unsigned char source_lun,
1528 unsigned int retry_time_ms)
1531 struct ipmi_smi_msg *smi_msg;
1532 struct ipmi_recv_msg *recv_msg;
1533 unsigned long flags;
1537 recv_msg = supplied_recv;
1539 recv_msg = ipmi_alloc_recv_msg();
1540 if (recv_msg == NULL)
1543 recv_msg->user_msg_data = user_msg_data;
1546 smi_msg = (struct ipmi_smi_msg *) supplied_smi;
1548 smi_msg = ipmi_alloc_smi_msg();
1549 if (smi_msg == NULL) {
1550 ipmi_free_recv_msg(recv_msg);
1556 if (intf->in_shutdown) {
1561 recv_msg->user = user;
1563 kref_get(&user->refcount);
1564 recv_msg->msgid = msgid;
1566 * Store the message to send in the receive message so timeout
1567 * responses can get the proper response data.
1569 recv_msg->msg = *msg;
1571 if (addr->addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE) {
1572 struct ipmi_system_interface_addr *smi_addr;
1574 if (msg->netfn & 1) {
1575 /* Responses are not allowed to the SMI. */
1580 smi_addr = (struct ipmi_system_interface_addr *) addr;
1581 if (smi_addr->lun > 3) {
1582 ipmi_inc_stat(intf, sent_invalid_commands);
1587 memcpy(&recv_msg->addr, smi_addr, sizeof(*smi_addr));
1589 if ((msg->netfn == IPMI_NETFN_APP_REQUEST)
1590 && ((msg->cmd == IPMI_SEND_MSG_CMD)
1591 || (msg->cmd == IPMI_GET_MSG_CMD)
1592 || (msg->cmd == IPMI_READ_EVENT_MSG_BUFFER_CMD))) {
1594 * We don't let the user do these, since we manage
1595 * the sequence numbers.
1597 ipmi_inc_stat(intf, sent_invalid_commands);
1602 if (((msg->netfn == IPMI_NETFN_APP_REQUEST)
1603 && ((msg->cmd == IPMI_COLD_RESET_CMD)
1604 || (msg->cmd == IPMI_WARM_RESET_CMD)))
1605 || (msg->netfn == IPMI_NETFN_FIRMWARE_REQUEST)) {
1606 spin_lock_irqsave(&intf->maintenance_mode_lock, flags);
1607 intf->auto_maintenance_timeout
1608 = IPMI_MAINTENANCE_MODE_TIMEOUT;
1609 if (!intf->maintenance_mode
1610 && !intf->maintenance_mode_enable) {
1611 intf->maintenance_mode_enable = true;
1612 maintenance_mode_update(intf);
1614 spin_unlock_irqrestore(&intf->maintenance_mode_lock,
1618 if ((msg->data_len + 2) > IPMI_MAX_MSG_LENGTH) {
1619 ipmi_inc_stat(intf, sent_invalid_commands);
1624 smi_msg->data[0] = (msg->netfn << 2) | (smi_addr->lun & 0x3);
1625 smi_msg->data[1] = msg->cmd;
1626 smi_msg->msgid = msgid;
1627 smi_msg->user_data = recv_msg;
1628 if (msg->data_len > 0)
1629 memcpy(&(smi_msg->data[2]), msg->data, msg->data_len);
1630 smi_msg->data_size = msg->data_len + 2;
1631 ipmi_inc_stat(intf, sent_local_commands);
1632 } else if (is_ipmb_addr(addr) || is_ipmb_bcast_addr(addr)) {
1633 struct ipmi_ipmb_addr *ipmb_addr;
1634 unsigned char ipmb_seq;
1638 if (addr->channel >= IPMI_MAX_CHANNELS) {
1639 ipmi_inc_stat(intf, sent_invalid_commands);
1644 if (intf->channels[addr->channel].medium
1645 != IPMI_CHANNEL_MEDIUM_IPMB) {
1646 ipmi_inc_stat(intf, sent_invalid_commands);
1652 if (addr->addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE)
1653 retries = 0; /* Don't retry broadcasts. */
1657 if (addr->addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE) {
1659 * Broadcasts add a zero at the beginning of the
1660 * message, but otherwise is the same as an IPMB
1663 addr->addr_type = IPMI_IPMB_ADDR_TYPE;
1668 /* Default to 1 second retries. */
1669 if (retry_time_ms == 0)
1670 retry_time_ms = 1000;
1673 * 9 for the header and 1 for the checksum, plus
1674 * possibly one for the broadcast.
1676 if ((msg->data_len + 10 + broadcast) > IPMI_MAX_MSG_LENGTH) {
1677 ipmi_inc_stat(intf, sent_invalid_commands);
1682 ipmb_addr = (struct ipmi_ipmb_addr *) addr;
1683 if (ipmb_addr->lun > 3) {
1684 ipmi_inc_stat(intf, sent_invalid_commands);
1689 memcpy(&recv_msg->addr, ipmb_addr, sizeof(*ipmb_addr));
1691 if (recv_msg->msg.netfn & 0x1) {
1693 * It's a response, so use the user's sequence
1696 ipmi_inc_stat(intf, sent_ipmb_responses);
1697 format_ipmb_msg(smi_msg, msg, ipmb_addr, msgid,
1699 source_address, source_lun);
1702 * Save the receive message so we can use it
1703 * to deliver the response.
1705 smi_msg->user_data = recv_msg;
1707 /* It's a command, so get a sequence for it. */
1709 spin_lock_irqsave(&(intf->seq_lock), flags);
1712 * Create a sequence number with a 1 second
1713 * timeout and 4 retries.
1715 rv = intf_next_seq(intf,
1724 * We have used up all the sequence numbers,
1725 * probably, so abort.
1727 spin_unlock_irqrestore(&(intf->seq_lock),
1732 ipmi_inc_stat(intf, sent_ipmb_commands);
1735 * Store the sequence number in the message,
1736 * so that when the send message response
1737 * comes back we can start the timer.
1739 format_ipmb_msg(smi_msg, msg, ipmb_addr,
1740 STORE_SEQ_IN_MSGID(ipmb_seq, seqid),
1741 ipmb_seq, broadcast,
1742 source_address, source_lun);
1745 * Copy the message into the recv message data, so we
1746 * can retransmit it later if necessary.
1748 memcpy(recv_msg->msg_data, smi_msg->data,
1749 smi_msg->data_size);
1750 recv_msg->msg.data = recv_msg->msg_data;
1751 recv_msg->msg.data_len = smi_msg->data_size;
1754 * We don't unlock until here, because we need
1755 * to copy the completed message into the
1756 * recv_msg before we release the lock.
1757 * Otherwise, race conditions may bite us. I
1758 * know that's pretty paranoid, but I prefer
1761 spin_unlock_irqrestore(&(intf->seq_lock), flags);
1763 } else if (is_lan_addr(addr)) {
1764 struct ipmi_lan_addr *lan_addr;
1765 unsigned char ipmb_seq;
1768 if (addr->channel >= IPMI_MAX_CHANNELS) {
1769 ipmi_inc_stat(intf, sent_invalid_commands);
1774 if ((intf->channels[addr->channel].medium
1775 != IPMI_CHANNEL_MEDIUM_8023LAN)
1776 && (intf->channels[addr->channel].medium
1777 != IPMI_CHANNEL_MEDIUM_ASYNC)) {
1778 ipmi_inc_stat(intf, sent_invalid_commands);
1785 /* Default to 1 second retries. */
1786 if (retry_time_ms == 0)
1787 retry_time_ms = 1000;
1789 /* 11 for the header and 1 for the checksum. */
1790 if ((msg->data_len + 12) > IPMI_MAX_MSG_LENGTH) {
1791 ipmi_inc_stat(intf, sent_invalid_commands);
1796 lan_addr = (struct ipmi_lan_addr *) addr;
1797 if (lan_addr->lun > 3) {
1798 ipmi_inc_stat(intf, sent_invalid_commands);
1803 memcpy(&recv_msg->addr, lan_addr, sizeof(*lan_addr));
1805 if (recv_msg->msg.netfn & 0x1) {
1807 * It's a response, so use the user's sequence
1810 ipmi_inc_stat(intf, sent_lan_responses);
1811 format_lan_msg(smi_msg, msg, lan_addr, msgid,
1815 * Save the receive message so we can use it
1816 * to deliver the response.
1818 smi_msg->user_data = recv_msg;
1820 /* It's a command, so get a sequence for it. */
1822 spin_lock_irqsave(&(intf->seq_lock), flags);
1825 * Create a sequence number with a 1 second
1826 * timeout and 4 retries.
1828 rv = intf_next_seq(intf,
1837 * We have used up all the sequence numbers,
1838 * probably, so abort.
1840 spin_unlock_irqrestore(&(intf->seq_lock),
1845 ipmi_inc_stat(intf, sent_lan_commands);
1848 * Store the sequence number in the message,
1849 * so that when the send message response
1850 * comes back we can start the timer.
1852 format_lan_msg(smi_msg, msg, lan_addr,
1853 STORE_SEQ_IN_MSGID(ipmb_seq, seqid),
1854 ipmb_seq, source_lun);
1857 * Copy the message into the recv message data, so we
1858 * can retransmit it later if necessary.
1860 memcpy(recv_msg->msg_data, smi_msg->data,
1861 smi_msg->data_size);
1862 recv_msg->msg.data = recv_msg->msg_data;
1863 recv_msg->msg.data_len = smi_msg->data_size;
1866 * We don't unlock until here, because we need
1867 * to copy the completed message into the
1868 * recv_msg before we release the lock.
1869 * Otherwise, race conditions may bite us. I
1870 * know that's pretty paranoid, but I prefer
1873 spin_unlock_irqrestore(&(intf->seq_lock), flags);
1876 /* Unknown address type. */
1877 ipmi_inc_stat(intf, sent_invalid_commands);
1885 for (m = 0; m < smi_msg->data_size; m++)
1886 printk(" %2.2x", smi_msg->data[m]);
1891 smi_send(intf, intf->handlers, smi_msg, priority);
1898 ipmi_free_smi_msg(smi_msg);
1899 ipmi_free_recv_msg(recv_msg);
1903 static int check_addr(ipmi_smi_t intf,
1904 struct ipmi_addr *addr,
1905 unsigned char *saddr,
1908 if (addr->channel >= IPMI_MAX_CHANNELS)
1910 *lun = intf->channels[addr->channel].lun;
1911 *saddr = intf->channels[addr->channel].address;
1915 int ipmi_request_settime(ipmi_user_t user,
1916 struct ipmi_addr *addr,
1918 struct kernel_ipmi_msg *msg,
1919 void *user_msg_data,
1922 unsigned int retry_time_ms)
1924 unsigned char saddr = 0, lun = 0;
1929 rv = check_addr(user->intf, addr, &saddr, &lun);
1932 return i_ipmi_request(user,
1945 EXPORT_SYMBOL(ipmi_request_settime);
1947 int ipmi_request_supply_msgs(ipmi_user_t user,
1948 struct ipmi_addr *addr,
1950 struct kernel_ipmi_msg *msg,
1951 void *user_msg_data,
1953 struct ipmi_recv_msg *supplied_recv,
1956 unsigned char saddr = 0, lun = 0;
1961 rv = check_addr(user->intf, addr, &saddr, &lun);
1964 return i_ipmi_request(user,
1977 EXPORT_SYMBOL(ipmi_request_supply_msgs);
1979 #ifdef CONFIG_PROC_FS
1980 static int smi_ipmb_proc_show(struct seq_file *m, void *v)
1982 ipmi_smi_t intf = m->private;
1985 seq_printf(m, "%x", intf->channels[0].address);
1986 for (i = 1; i < IPMI_MAX_CHANNELS; i++)
1987 seq_printf(m, " %x", intf->channels[i].address);
1988 return seq_putc(m, '\n');
1991 static int smi_ipmb_proc_open(struct inode *inode, struct file *file)
1993 return single_open(file, smi_ipmb_proc_show, PDE_DATA(inode));
1996 static const struct file_operations smi_ipmb_proc_ops = {
1997 .open = smi_ipmb_proc_open,
1999 .llseek = seq_lseek,
2000 .release = single_release,
2003 static int smi_version_proc_show(struct seq_file *m, void *v)
2005 ipmi_smi_t intf = m->private;
2007 return seq_printf(m, "%u.%u\n",
2008 ipmi_version_major(&intf->bmc->id),
2009 ipmi_version_minor(&intf->bmc->id));
2012 static int smi_version_proc_open(struct inode *inode, struct file *file)
2014 return single_open(file, smi_version_proc_show, PDE_DATA(inode));
2017 static const struct file_operations smi_version_proc_ops = {
2018 .open = smi_version_proc_open,
2020 .llseek = seq_lseek,
2021 .release = single_release,
2024 static int smi_stats_proc_show(struct seq_file *m, void *v)
2026 ipmi_smi_t intf = m->private;
2028 seq_printf(m, "sent_invalid_commands: %u\n",
2029 ipmi_get_stat(intf, sent_invalid_commands));
2030 seq_printf(m, "sent_local_commands: %u\n",
2031 ipmi_get_stat(intf, sent_local_commands));
2032 seq_printf(m, "handled_local_responses: %u\n",
2033 ipmi_get_stat(intf, handled_local_responses));
2034 seq_printf(m, "unhandled_local_responses: %u\n",
2035 ipmi_get_stat(intf, unhandled_local_responses));
2036 seq_printf(m, "sent_ipmb_commands: %u\n",
2037 ipmi_get_stat(intf, sent_ipmb_commands));
2038 seq_printf(m, "sent_ipmb_command_errs: %u\n",
2039 ipmi_get_stat(intf, sent_ipmb_command_errs));
2040 seq_printf(m, "retransmitted_ipmb_commands: %u\n",
2041 ipmi_get_stat(intf, retransmitted_ipmb_commands));
2042 seq_printf(m, "timed_out_ipmb_commands: %u\n",
2043 ipmi_get_stat(intf, timed_out_ipmb_commands));
2044 seq_printf(m, "timed_out_ipmb_broadcasts: %u\n",
2045 ipmi_get_stat(intf, timed_out_ipmb_broadcasts));
2046 seq_printf(m, "sent_ipmb_responses: %u\n",
2047 ipmi_get_stat(intf, sent_ipmb_responses));
2048 seq_printf(m, "handled_ipmb_responses: %u\n",
2049 ipmi_get_stat(intf, handled_ipmb_responses));
2050 seq_printf(m, "invalid_ipmb_responses: %u\n",
2051 ipmi_get_stat(intf, invalid_ipmb_responses));
2052 seq_printf(m, "unhandled_ipmb_responses: %u\n",
2053 ipmi_get_stat(intf, unhandled_ipmb_responses));
2054 seq_printf(m, "sent_lan_commands: %u\n",
2055 ipmi_get_stat(intf, sent_lan_commands));
2056 seq_printf(m, "sent_lan_command_errs: %u\n",
2057 ipmi_get_stat(intf, sent_lan_command_errs));
2058 seq_printf(m, "retransmitted_lan_commands: %u\n",
2059 ipmi_get_stat(intf, retransmitted_lan_commands));
2060 seq_printf(m, "timed_out_lan_commands: %u\n",
2061 ipmi_get_stat(intf, timed_out_lan_commands));
2062 seq_printf(m, "sent_lan_responses: %u\n",
2063 ipmi_get_stat(intf, sent_lan_responses));
2064 seq_printf(m, "handled_lan_responses: %u\n",
2065 ipmi_get_stat(intf, handled_lan_responses));
2066 seq_printf(m, "invalid_lan_responses: %u\n",
2067 ipmi_get_stat(intf, invalid_lan_responses));
2068 seq_printf(m, "unhandled_lan_responses: %u\n",
2069 ipmi_get_stat(intf, unhandled_lan_responses));
2070 seq_printf(m, "handled_commands: %u\n",
2071 ipmi_get_stat(intf, handled_commands));
2072 seq_printf(m, "invalid_commands: %u\n",
2073 ipmi_get_stat(intf, invalid_commands));
2074 seq_printf(m, "unhandled_commands: %u\n",
2075 ipmi_get_stat(intf, unhandled_commands));
2076 seq_printf(m, "invalid_events: %u\n",
2077 ipmi_get_stat(intf, invalid_events));
2078 seq_printf(m, "events: %u\n",
2079 ipmi_get_stat(intf, events));
2080 seq_printf(m, "failed rexmit LAN msgs: %u\n",
2081 ipmi_get_stat(intf, dropped_rexmit_lan_commands));
2082 seq_printf(m, "failed rexmit IPMB msgs: %u\n",
2083 ipmi_get_stat(intf, dropped_rexmit_ipmb_commands));
2087 static int smi_stats_proc_open(struct inode *inode, struct file *file)
2089 return single_open(file, smi_stats_proc_show, PDE_DATA(inode));
2092 static const struct file_operations smi_stats_proc_ops = {
2093 .open = smi_stats_proc_open,
2095 .llseek = seq_lseek,
2096 .release = single_release,
2098 #endif /* CONFIG_PROC_FS */
2100 int ipmi_smi_add_proc_entry(ipmi_smi_t smi, char *name,
2101 const struct file_operations *proc_ops,
2105 #ifdef CONFIG_PROC_FS
2106 struct proc_dir_entry *file;
2107 struct ipmi_proc_entry *entry;
2109 /* Create a list element. */
2110 entry = kmalloc(sizeof(*entry), GFP_KERNEL);
2113 entry->name = kstrdup(name, GFP_KERNEL);
2119 file = proc_create_data(name, 0, smi->proc_dir, proc_ops, data);
2125 mutex_lock(&smi->proc_entry_lock);
2126 /* Stick it on the list. */
2127 entry->next = smi->proc_entries;
2128 smi->proc_entries = entry;
2129 mutex_unlock(&smi->proc_entry_lock);
2131 #endif /* CONFIG_PROC_FS */
2135 EXPORT_SYMBOL(ipmi_smi_add_proc_entry);
2137 static int add_proc_entries(ipmi_smi_t smi, int num)
2141 #ifdef CONFIG_PROC_FS
2142 sprintf(smi->proc_dir_name, "%d", num);
2143 smi->proc_dir = proc_mkdir(smi->proc_dir_name, proc_ipmi_root);
2148 rv = ipmi_smi_add_proc_entry(smi, "stats",
2149 &smi_stats_proc_ops,
2153 rv = ipmi_smi_add_proc_entry(smi, "ipmb",
2158 rv = ipmi_smi_add_proc_entry(smi, "version",
2159 &smi_version_proc_ops,
2161 #endif /* CONFIG_PROC_FS */
2166 static void remove_proc_entries(ipmi_smi_t smi)
2168 #ifdef CONFIG_PROC_FS
2169 struct ipmi_proc_entry *entry;
2171 mutex_lock(&smi->proc_entry_lock);
2172 while (smi->proc_entries) {
2173 entry = smi->proc_entries;
2174 smi->proc_entries = entry->next;
2176 remove_proc_entry(entry->name, smi->proc_dir);
2180 mutex_unlock(&smi->proc_entry_lock);
2181 remove_proc_entry(smi->proc_dir_name, proc_ipmi_root);
2182 #endif /* CONFIG_PROC_FS */
2185 static int __find_bmc_guid(struct device *dev, void *data)
2187 unsigned char *id = data;
2188 struct bmc_device *bmc = to_bmc_device(dev);
2189 return memcmp(bmc->guid, id, 16) == 0;
2192 static struct bmc_device *ipmi_find_bmc_guid(struct device_driver *drv,
2193 unsigned char *guid)
2197 dev = driver_find_device(drv, NULL, guid, __find_bmc_guid);
2199 return to_bmc_device(dev);
2204 struct prod_dev_id {
2205 unsigned int product_id;
2206 unsigned char device_id;
2209 static int __find_bmc_prod_dev_id(struct device *dev, void *data)
2211 struct prod_dev_id *id = data;
2212 struct bmc_device *bmc = to_bmc_device(dev);
2214 return (bmc->id.product_id == id->product_id
2215 && bmc->id.device_id == id->device_id);
2218 static struct bmc_device *ipmi_find_bmc_prod_dev_id(
2219 struct device_driver *drv,
2220 unsigned int product_id, unsigned char device_id)
2222 struct prod_dev_id id = {
2223 .product_id = product_id,
2224 .device_id = device_id,
2228 dev = driver_find_device(drv, NULL, &id, __find_bmc_prod_dev_id);
2230 return to_bmc_device(dev);
2235 static ssize_t device_id_show(struct device *dev,
2236 struct device_attribute *attr,
2239 struct bmc_device *bmc = to_bmc_device(dev);
2241 return snprintf(buf, 10, "%u\n", bmc->id.device_id);
2243 static DEVICE_ATTR(device_id, S_IRUGO, device_id_show, NULL);
2245 static ssize_t provides_device_sdrs_show(struct device *dev,
2246 struct device_attribute *attr,
2249 struct bmc_device *bmc = to_bmc_device(dev);
2251 return snprintf(buf, 10, "%u\n",
2252 (bmc->id.device_revision & 0x80) >> 7);
2254 static DEVICE_ATTR(provides_device_sdrs, S_IRUGO, provides_device_sdrs_show,
2257 static ssize_t revision_show(struct device *dev, struct device_attribute *attr,
2260 struct bmc_device *bmc = to_bmc_device(dev);
2262 return snprintf(buf, 20, "%u\n",
2263 bmc->id.device_revision & 0x0F);
2265 static DEVICE_ATTR(revision, S_IRUGO, revision_show, NULL);
2267 static ssize_t firmware_revision_show(struct device *dev,
2268 struct device_attribute *attr,
2271 struct bmc_device *bmc = to_bmc_device(dev);
2273 return snprintf(buf, 20, "%u.%x\n", bmc->id.firmware_revision_1,
2274 bmc->id.firmware_revision_2);
2276 static DEVICE_ATTR(firmware_revision, S_IRUGO, firmware_revision_show, NULL);
2278 static ssize_t ipmi_version_show(struct device *dev,
2279 struct device_attribute *attr,
2282 struct bmc_device *bmc = to_bmc_device(dev);
2284 return snprintf(buf, 20, "%u.%u\n",
2285 ipmi_version_major(&bmc->id),
2286 ipmi_version_minor(&bmc->id));
2288 static DEVICE_ATTR(ipmi_version, S_IRUGO, ipmi_version_show, NULL);
2290 static ssize_t add_dev_support_show(struct device *dev,
2291 struct device_attribute *attr,
2294 struct bmc_device *bmc = to_bmc_device(dev);
2296 return snprintf(buf, 10, "0x%02x\n",
2297 bmc->id.additional_device_support);
2299 static DEVICE_ATTR(additional_device_support, S_IRUGO, add_dev_support_show,
2302 static ssize_t manufacturer_id_show(struct device *dev,
2303 struct device_attribute *attr,
2306 struct bmc_device *bmc = to_bmc_device(dev);
2308 return snprintf(buf, 20, "0x%6.6x\n", bmc->id.manufacturer_id);
2310 static DEVICE_ATTR(manufacturer_id, S_IRUGO, manufacturer_id_show, NULL);
2312 static ssize_t product_id_show(struct device *dev,
2313 struct device_attribute *attr,
2316 struct bmc_device *bmc = to_bmc_device(dev);
2318 return snprintf(buf, 10, "0x%4.4x\n", bmc->id.product_id);
2320 static DEVICE_ATTR(product_id, S_IRUGO, product_id_show, NULL);
2322 static ssize_t aux_firmware_rev_show(struct device *dev,
2323 struct device_attribute *attr,
2326 struct bmc_device *bmc = to_bmc_device(dev);
2328 return snprintf(buf, 21, "0x%02x 0x%02x 0x%02x 0x%02x\n",
2329 bmc->id.aux_firmware_revision[3],
2330 bmc->id.aux_firmware_revision[2],
2331 bmc->id.aux_firmware_revision[1],
2332 bmc->id.aux_firmware_revision[0]);
2334 static DEVICE_ATTR(aux_firmware_revision, S_IRUGO, aux_firmware_rev_show, NULL);
2336 static ssize_t guid_show(struct device *dev, struct device_attribute *attr,
2339 struct bmc_device *bmc = to_bmc_device(dev);
2341 return snprintf(buf, 100, "%Lx%Lx\n",
2342 (long long) bmc->guid[0],
2343 (long long) bmc->guid[8]);
2345 static DEVICE_ATTR(guid, S_IRUGO, guid_show, NULL);
2347 static struct attribute *bmc_dev_attrs[] = {
2348 &dev_attr_device_id.attr,
2349 &dev_attr_provides_device_sdrs.attr,
2350 &dev_attr_revision.attr,
2351 &dev_attr_firmware_revision.attr,
2352 &dev_attr_ipmi_version.attr,
2353 &dev_attr_additional_device_support.attr,
2354 &dev_attr_manufacturer_id.attr,
2355 &dev_attr_product_id.attr,
2359 static struct attribute_group bmc_dev_attr_group = {
2360 .attrs = bmc_dev_attrs,
2363 static const struct attribute_group *bmc_dev_attr_groups[] = {
2364 &bmc_dev_attr_group,
2368 static struct device_type bmc_device_type = {
2369 .groups = bmc_dev_attr_groups,
2373 release_bmc_device(struct device *dev)
2375 kfree(to_bmc_device(dev));
2379 cleanup_bmc_device(struct kref *ref)
2381 struct bmc_device *bmc = container_of(ref, struct bmc_device, usecount);
2383 if (bmc->id.aux_firmware_revision_set)
2384 device_remove_file(&bmc->pdev.dev,
2385 &dev_attr_aux_firmware_revision);
2387 device_remove_file(&bmc->pdev.dev,
2390 platform_device_unregister(&bmc->pdev);
2393 static void ipmi_bmc_unregister(ipmi_smi_t intf)
2395 struct bmc_device *bmc = intf->bmc;
2397 sysfs_remove_link(&intf->si_dev->kobj, "bmc");
2398 if (intf->my_dev_name) {
2399 sysfs_remove_link(&bmc->pdev.dev.kobj, intf->my_dev_name);
2400 kfree(intf->my_dev_name);
2401 intf->my_dev_name = NULL;
2404 mutex_lock(&ipmidriver_mutex);
2405 kref_put(&bmc->usecount, cleanup_bmc_device);
2407 mutex_unlock(&ipmidriver_mutex);
2410 static int create_bmc_files(struct bmc_device *bmc)
2414 if (bmc->id.aux_firmware_revision_set) {
2415 err = device_create_file(&bmc->pdev.dev,
2416 &dev_attr_aux_firmware_revision);
2420 if (bmc->guid_set) {
2421 err = device_create_file(&bmc->pdev.dev,
2430 if (bmc->id.aux_firmware_revision_set)
2431 device_remove_file(&bmc->pdev.dev,
2432 &dev_attr_aux_firmware_revision);
2437 static int ipmi_bmc_register(ipmi_smi_t intf, int ifnum)
2440 struct bmc_device *bmc = intf->bmc;
2441 struct bmc_device *old_bmc;
2443 mutex_lock(&ipmidriver_mutex);
2446 * Try to find if there is an bmc_device struct
2447 * representing the interfaced BMC already
2450 old_bmc = ipmi_find_bmc_guid(&ipmidriver.driver, bmc->guid);
2452 old_bmc = ipmi_find_bmc_prod_dev_id(&ipmidriver.driver,
2457 * If there is already an bmc_device, free the new one,
2458 * otherwise register the new BMC device
2462 intf->bmc = old_bmc;
2465 kref_get(&bmc->usecount);
2466 mutex_unlock(&ipmidriver_mutex);
2469 "ipmi: interfacing existing BMC (man_id: 0x%6.6x,"
2470 " prod_id: 0x%4.4x, dev_id: 0x%2.2x)\n",
2471 bmc->id.manufacturer_id,
2475 unsigned char orig_dev_id = bmc->id.device_id;
2476 int warn_printed = 0;
2478 snprintf(bmc->name, sizeof(bmc->name),
2479 "ipmi_bmc.%4.4x", bmc->id.product_id);
2480 bmc->pdev.name = bmc->name;
2482 while (ipmi_find_bmc_prod_dev_id(&ipmidriver.driver,
2484 bmc->id.device_id)) {
2485 if (!warn_printed) {
2486 printk(KERN_WARNING PFX
2487 "This machine has two different BMCs"
2488 " with the same product id and device"
2489 " id. This is an error in the"
2490 " firmware, but incrementing the"
2491 " device id to work around the problem."
2492 " Prod ID = 0x%x, Dev ID = 0x%x\n",
2493 bmc->id.product_id, bmc->id.device_id);
2496 bmc->id.device_id++; /* Wraps at 255 */
2497 if (bmc->id.device_id == orig_dev_id) {
2499 "Out of device ids!\n");
2504 bmc->pdev.dev.driver = &ipmidriver.driver;
2505 bmc->pdev.id = bmc->id.device_id;
2506 bmc->pdev.dev.release = release_bmc_device;
2507 bmc->pdev.dev.type = &bmc_device_type;
2508 kref_init(&bmc->usecount);
2510 rv = platform_device_register(&bmc->pdev);
2511 mutex_unlock(&ipmidriver_mutex);
2513 put_device(&bmc->pdev.dev);
2516 " Unable to register bmc device: %d\n",
2519 * Don't go to out_err, you can only do that if
2520 * the device is registered already.
2525 rv = create_bmc_files(bmc);
2527 mutex_lock(&ipmidriver_mutex);
2528 platform_device_unregister(&bmc->pdev);
2529 mutex_unlock(&ipmidriver_mutex);
2534 dev_info(intf->si_dev, "Found new BMC (man_id: 0x%6.6x, "
2535 "prod_id: 0x%4.4x, dev_id: 0x%2.2x)\n",
2536 bmc->id.manufacturer_id,
2542 * create symlink from system interface device to bmc device
2545 rv = sysfs_create_link(&intf->si_dev->kobj, &bmc->pdev.dev.kobj, "bmc");
2548 "ipmi_msghandler: Unable to create bmc symlink: %d\n",
2553 intf->my_dev_name = kasprintf(GFP_KERNEL, "ipmi%d", ifnum);
2554 if (!intf->my_dev_name) {
2557 "ipmi_msghandler: allocate link from BMC: %d\n",
2562 rv = sysfs_create_link(&bmc->pdev.dev.kobj, &intf->si_dev->kobj,
2565 kfree(intf->my_dev_name);
2566 intf->my_dev_name = NULL;
2569 " Unable to create symlink to bmc: %d\n",
2577 ipmi_bmc_unregister(intf);
2582 send_guid_cmd(ipmi_smi_t intf, int chan)
2584 struct kernel_ipmi_msg msg;
2585 struct ipmi_system_interface_addr si;
2587 si.addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
2588 si.channel = IPMI_BMC_CHANNEL;
2591 msg.netfn = IPMI_NETFN_APP_REQUEST;
2592 msg.cmd = IPMI_GET_DEVICE_GUID_CMD;
2595 return i_ipmi_request(NULL,
2597 (struct ipmi_addr *) &si,
2604 intf->channels[0].address,
2605 intf->channels[0].lun,
2610 guid_handler(ipmi_smi_t intf, struct ipmi_recv_msg *msg)
2612 if ((msg->addr.addr_type != IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
2613 || (msg->msg.netfn != IPMI_NETFN_APP_RESPONSE)
2614 || (msg->msg.cmd != IPMI_GET_DEVICE_GUID_CMD))
2618 if (msg->msg.data[0] != 0) {
2619 /* Error from getting the GUID, the BMC doesn't have one. */
2620 intf->bmc->guid_set = 0;
2624 if (msg->msg.data_len < 17) {
2625 intf->bmc->guid_set = 0;
2626 printk(KERN_WARNING PFX
2627 "guid_handler: The GUID response from the BMC was too"
2628 " short, it was %d but should have been 17. Assuming"
2629 " GUID is not available.\n",
2634 memcpy(intf->bmc->guid, msg->msg.data, 16);
2635 intf->bmc->guid_set = 1;
2637 wake_up(&intf->waitq);
2641 get_guid(ipmi_smi_t intf)
2645 intf->bmc->guid_set = 0x2;
2646 intf->null_user_handler = guid_handler;
2647 rv = send_guid_cmd(intf, 0);
2649 /* Send failed, no GUID available. */
2650 intf->bmc->guid_set = 0;
2651 wait_event(intf->waitq, intf->bmc->guid_set != 2);
2652 intf->null_user_handler = NULL;
2656 send_channel_info_cmd(ipmi_smi_t intf, int chan)
2658 struct kernel_ipmi_msg msg;
2659 unsigned char data[1];
2660 struct ipmi_system_interface_addr si;
2662 si.addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
2663 si.channel = IPMI_BMC_CHANNEL;
2666 msg.netfn = IPMI_NETFN_APP_REQUEST;
2667 msg.cmd = IPMI_GET_CHANNEL_INFO_CMD;
2671 return i_ipmi_request(NULL,
2673 (struct ipmi_addr *) &si,
2680 intf->channels[0].address,
2681 intf->channels[0].lun,
2686 channel_handler(ipmi_smi_t intf, struct ipmi_recv_msg *msg)
2691 if ((msg->addr.addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
2692 && (msg->msg.netfn == IPMI_NETFN_APP_RESPONSE)
2693 && (msg->msg.cmd == IPMI_GET_CHANNEL_INFO_CMD)) {
2694 /* It's the one we want */
2695 if (msg->msg.data[0] != 0) {
2696 /* Got an error from the channel, just go on. */
2698 if (msg->msg.data[0] == IPMI_INVALID_COMMAND_ERR) {
2700 * If the MC does not support this
2701 * command, that is legal. We just
2702 * assume it has one IPMB at channel
2705 intf->channels[0].medium
2706 = IPMI_CHANNEL_MEDIUM_IPMB;
2707 intf->channels[0].protocol
2708 = IPMI_CHANNEL_PROTOCOL_IPMB;
2710 intf->curr_channel = IPMI_MAX_CHANNELS;
2711 wake_up(&intf->waitq);
2716 if (msg->msg.data_len < 4) {
2717 /* Message not big enough, just go on. */
2720 chan = intf->curr_channel;
2721 intf->channels[chan].medium = msg->msg.data[2] & 0x7f;
2722 intf->channels[chan].protocol = msg->msg.data[3] & 0x1f;
2725 intf->curr_channel++;
2726 if (intf->curr_channel >= IPMI_MAX_CHANNELS)
2727 wake_up(&intf->waitq);
2729 rv = send_channel_info_cmd(intf, intf->curr_channel);
2732 /* Got an error somehow, just give up. */
2733 printk(KERN_WARNING PFX
2734 "Error sending channel information for channel"
2735 " %d: %d\n", intf->curr_channel, rv);
2737 intf->curr_channel = IPMI_MAX_CHANNELS;
2738 wake_up(&intf->waitq);
2745 static void ipmi_poll(ipmi_smi_t intf)
2747 if (intf->handlers->poll)
2748 intf->handlers->poll(intf->send_info);
2749 /* In case something came in */
2750 handle_new_recv_msgs(intf);
2753 void ipmi_poll_interface(ipmi_user_t user)
2755 ipmi_poll(user->intf);
2757 EXPORT_SYMBOL(ipmi_poll_interface);
2759 int ipmi_register_smi(struct ipmi_smi_handlers *handlers,
2761 struct ipmi_device_id *device_id,
2762 struct device *si_dev,
2763 unsigned char slave_addr)
2769 struct list_head *link;
2772 * Make sure the driver is actually initialized, this handles
2773 * problems with initialization order.
2776 rv = ipmi_init_msghandler();
2780 * The init code doesn't return an error if it was turned
2781 * off, but it won't initialize. Check that.
2787 intf = kzalloc(sizeof(*intf), GFP_KERNEL);
2791 intf->ipmi_version_major = ipmi_version_major(device_id);
2792 intf->ipmi_version_minor = ipmi_version_minor(device_id);
2794 intf->bmc = kzalloc(sizeof(*intf->bmc), GFP_KERNEL);
2799 intf->intf_num = -1; /* Mark it invalid for now. */
2800 kref_init(&intf->refcount);
2801 intf->bmc->id = *device_id;
2802 intf->si_dev = si_dev;
2803 for (j = 0; j < IPMI_MAX_CHANNELS; j++) {
2804 intf->channels[j].address = IPMI_BMC_SLAVE_ADDR;
2805 intf->channels[j].lun = 2;
2807 if (slave_addr != 0)
2808 intf->channels[0].address = slave_addr;
2809 INIT_LIST_HEAD(&intf->users);
2810 intf->handlers = handlers;
2811 intf->send_info = send_info;
2812 spin_lock_init(&intf->seq_lock);
2813 for (j = 0; j < IPMI_IPMB_NUM_SEQ; j++) {
2814 intf->seq_table[j].inuse = 0;
2815 intf->seq_table[j].seqid = 0;
2818 #ifdef CONFIG_PROC_FS
2819 mutex_init(&intf->proc_entry_lock);
2821 spin_lock_init(&intf->waiting_rcv_msgs_lock);
2822 INIT_LIST_HEAD(&intf->waiting_rcv_msgs);
2823 tasklet_init(&intf->recv_tasklet,
2825 (unsigned long) intf);
2826 atomic_set(&intf->watchdog_pretimeouts_to_deliver, 0);
2827 spin_lock_init(&intf->xmit_msgs_lock);
2828 INIT_LIST_HEAD(&intf->xmit_msgs);
2829 INIT_LIST_HEAD(&intf->hp_xmit_msgs);
2830 spin_lock_init(&intf->events_lock);
2831 atomic_set(&intf->event_waiters, 0);
2832 intf->ticks_to_req_ev = IPMI_REQUEST_EV_TIME;
2833 INIT_LIST_HEAD(&intf->waiting_events);
2834 intf->waiting_events_count = 0;
2835 mutex_init(&intf->cmd_rcvrs_mutex);
2836 spin_lock_init(&intf->maintenance_mode_lock);
2837 INIT_LIST_HEAD(&intf->cmd_rcvrs);
2838 init_waitqueue_head(&intf->waitq);
2839 for (i = 0; i < IPMI_NUM_STATS; i++)
2840 atomic_set(&intf->stats[i], 0);
2842 intf->proc_dir = NULL;
2844 mutex_lock(&smi_watchers_mutex);
2845 mutex_lock(&ipmi_interfaces_mutex);
2846 /* Look for a hole in the numbers. */
2848 link = &ipmi_interfaces;
2849 list_for_each_entry_rcu(tintf, &ipmi_interfaces, link) {
2850 if (tintf->intf_num != i) {
2851 link = &tintf->link;
2856 /* Add the new interface in numeric order. */
2858 list_add_rcu(&intf->link, &ipmi_interfaces);
2860 list_add_tail_rcu(&intf->link, link);
2862 rv = handlers->start_processing(send_info, intf);
2868 if ((intf->ipmi_version_major > 1)
2869 || ((intf->ipmi_version_major == 1)
2870 && (intf->ipmi_version_minor >= 5))) {
2872 * Start scanning the channels to see what is
2875 intf->null_user_handler = channel_handler;
2876 intf->curr_channel = 0;
2877 rv = send_channel_info_cmd(intf, 0);
2879 printk(KERN_WARNING PFX
2880 "Error sending channel information for channel"
2885 /* Wait for the channel info to be read. */
2886 wait_event(intf->waitq,
2887 intf->curr_channel >= IPMI_MAX_CHANNELS);
2888 intf->null_user_handler = NULL;
2890 /* Assume a single IPMB channel at zero. */
2891 intf->channels[0].medium = IPMI_CHANNEL_MEDIUM_IPMB;
2892 intf->channels[0].protocol = IPMI_CHANNEL_PROTOCOL_IPMB;
2893 intf->curr_channel = IPMI_MAX_CHANNELS;
2897 rv = add_proc_entries(intf, i);
2899 rv = ipmi_bmc_register(intf, i);
2904 remove_proc_entries(intf);
2905 intf->handlers = NULL;
2906 list_del_rcu(&intf->link);
2907 mutex_unlock(&ipmi_interfaces_mutex);
2908 mutex_unlock(&smi_watchers_mutex);
2910 kref_put(&intf->refcount, intf_free);
2913 * Keep memory order straight for RCU readers. Make
2914 * sure everything else is committed to memory before
2915 * setting intf_num to mark the interface valid.
2919 mutex_unlock(&ipmi_interfaces_mutex);
2920 /* After this point the interface is legal to use. */
2921 call_smi_watchers(i, intf->si_dev);
2922 mutex_unlock(&smi_watchers_mutex);
2927 EXPORT_SYMBOL(ipmi_register_smi);
2929 static void deliver_smi_err_response(ipmi_smi_t intf,
2930 struct ipmi_smi_msg *msg,
2933 msg->rsp[0] = msg->data[0] | 4;
2934 msg->rsp[1] = msg->data[1];
2937 /* It's an error, so it will never requeue, no need to check return. */
2938 handle_one_recv_msg(intf, msg);
2941 static void cleanup_smi_msgs(ipmi_smi_t intf)
2944 struct seq_table *ent;
2945 struct ipmi_smi_msg *msg;
2946 struct list_head *entry;
2947 struct list_head tmplist;
2949 /* Clear out our transmit queues and hold the messages. */
2950 INIT_LIST_HEAD(&tmplist);
2951 list_splice_tail(&intf->hp_xmit_msgs, &tmplist);
2952 list_splice_tail(&intf->xmit_msgs, &tmplist);
2954 /* Current message first, to preserve order */
2955 while (intf->curr_msg && !list_empty(&intf->waiting_rcv_msgs)) {
2956 /* Wait for the message to clear out. */
2957 schedule_timeout(1);
2960 /* No need for locks, the interface is down. */
2963 * Return errors for all pending messages in queue and in the
2964 * tables waiting for remote responses.
2966 while (!list_empty(&tmplist)) {
2967 entry = tmplist.next;
2969 msg = list_entry(entry, struct ipmi_smi_msg, link);
2970 deliver_smi_err_response(intf, msg, IPMI_ERR_UNSPECIFIED);
2973 for (i = 0; i < IPMI_IPMB_NUM_SEQ; i++) {
2974 ent = &(intf->seq_table[i]);
2977 deliver_err_response(ent->recv_msg, IPMI_ERR_UNSPECIFIED);
2981 int ipmi_unregister_smi(ipmi_smi_t intf)
2983 struct ipmi_smi_watcher *w;
2984 int intf_num = intf->intf_num;
2987 ipmi_bmc_unregister(intf);
2989 mutex_lock(&smi_watchers_mutex);
2990 mutex_lock(&ipmi_interfaces_mutex);
2991 intf->intf_num = -1;
2992 intf->in_shutdown = true;
2993 list_del_rcu(&intf->link);
2994 mutex_unlock(&ipmi_interfaces_mutex);
2997 cleanup_smi_msgs(intf);
2999 /* Clean up the effects of users on the lower-level software. */
3000 mutex_lock(&ipmi_interfaces_mutex);
3002 list_for_each_entry_rcu(user, &intf->users, link) {
3003 module_put(intf->handlers->owner);
3004 if (intf->handlers->dec_usecount)
3005 intf->handlers->dec_usecount(intf->send_info);
3008 intf->handlers = NULL;
3009 mutex_unlock(&ipmi_interfaces_mutex);
3011 remove_proc_entries(intf);
3014 * Call all the watcher interfaces to tell them that
3015 * an interface is gone.
3017 list_for_each_entry(w, &smi_watchers, link)
3018 w->smi_gone(intf_num);
3019 mutex_unlock(&smi_watchers_mutex);
3021 kref_put(&intf->refcount, intf_free);
3024 EXPORT_SYMBOL(ipmi_unregister_smi);
3026 static int handle_ipmb_get_msg_rsp(ipmi_smi_t intf,
3027 struct ipmi_smi_msg *msg)
3029 struct ipmi_ipmb_addr ipmb_addr;
3030 struct ipmi_recv_msg *recv_msg;
3033 * This is 11, not 10, because the response must contain a
3036 if (msg->rsp_size < 11) {
3037 /* Message not big enough, just ignore it. */
3038 ipmi_inc_stat(intf, invalid_ipmb_responses);
3042 if (msg->rsp[2] != 0) {
3043 /* An error getting the response, just ignore it. */
3047 ipmb_addr.addr_type = IPMI_IPMB_ADDR_TYPE;
3048 ipmb_addr.slave_addr = msg->rsp[6];
3049 ipmb_addr.channel = msg->rsp[3] & 0x0f;
3050 ipmb_addr.lun = msg->rsp[7] & 3;
3053 * It's a response from a remote entity. Look up the sequence
3054 * number and handle the response.
3056 if (intf_find_seq(intf,
3060 (msg->rsp[4] >> 2) & (~1),
3061 (struct ipmi_addr *) &(ipmb_addr),
3064 * We were unable to find the sequence number,
3065 * so just nuke the message.
3067 ipmi_inc_stat(intf, unhandled_ipmb_responses);
3071 memcpy(recv_msg->msg_data,
3075 * The other fields matched, so no need to set them, except
3076 * for netfn, which needs to be the response that was
3077 * returned, not the request value.
3079 recv_msg->msg.netfn = msg->rsp[4] >> 2;
3080 recv_msg->msg.data = recv_msg->msg_data;
3081 recv_msg->msg.data_len = msg->rsp_size - 10;
3082 recv_msg->recv_type = IPMI_RESPONSE_RECV_TYPE;
3083 ipmi_inc_stat(intf, handled_ipmb_responses);
3084 deliver_response(recv_msg);
3089 static int handle_ipmb_get_msg_cmd(ipmi_smi_t intf,
3090 struct ipmi_smi_msg *msg)
3092 struct cmd_rcvr *rcvr;
3094 unsigned char netfn;
3097 ipmi_user_t user = NULL;
3098 struct ipmi_ipmb_addr *ipmb_addr;
3099 struct ipmi_recv_msg *recv_msg;
3101 if (msg->rsp_size < 10) {
3102 /* Message not big enough, just ignore it. */
3103 ipmi_inc_stat(intf, invalid_commands);
3107 if (msg->rsp[2] != 0) {
3108 /* An error getting the response, just ignore it. */
3112 netfn = msg->rsp[4] >> 2;
3114 chan = msg->rsp[3] & 0xf;
3117 rcvr = find_cmd_rcvr(intf, netfn, cmd, chan);
3120 kref_get(&user->refcount);
3126 /* We didn't find a user, deliver an error response. */
3127 ipmi_inc_stat(intf, unhandled_commands);
3129 msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
3130 msg->data[1] = IPMI_SEND_MSG_CMD;
3131 msg->data[2] = msg->rsp[3];
3132 msg->data[3] = msg->rsp[6];
3133 msg->data[4] = ((netfn + 1) << 2) | (msg->rsp[7] & 0x3);
3134 msg->data[5] = ipmb_checksum(&(msg->data[3]), 2);
3135 msg->data[6] = intf->channels[msg->rsp[3] & 0xf].address;
3137 msg->data[7] = (msg->rsp[7] & 0xfc) | (msg->rsp[4] & 0x3);
3138 msg->data[8] = msg->rsp[8]; /* cmd */
3139 msg->data[9] = IPMI_INVALID_CMD_COMPLETION_CODE;
3140 msg->data[10] = ipmb_checksum(&(msg->data[6]), 4);
3141 msg->data_size = 11;
3146 printk("Invalid command:");
3147 for (m = 0; m < msg->data_size; m++)
3148 printk(" %2.2x", msg->data[m]);
3153 if (!intf->in_shutdown) {
3154 smi_send(intf, intf->handlers, msg, 0);
3156 * We used the message, so return the value
3157 * that causes it to not be freed or
3164 /* Deliver the message to the user. */
3165 ipmi_inc_stat(intf, handled_commands);
3167 recv_msg = ipmi_alloc_recv_msg();
3170 * We couldn't allocate memory for the
3171 * message, so requeue it for handling
3175 kref_put(&user->refcount, free_user);
3177 /* Extract the source address from the data. */
3178 ipmb_addr = (struct ipmi_ipmb_addr *) &recv_msg->addr;
3179 ipmb_addr->addr_type = IPMI_IPMB_ADDR_TYPE;
3180 ipmb_addr->slave_addr = msg->rsp[6];
3181 ipmb_addr->lun = msg->rsp[7] & 3;
3182 ipmb_addr->channel = msg->rsp[3] & 0xf;
3185 * Extract the rest of the message information
3186 * from the IPMB header.
3188 recv_msg->user = user;
3189 recv_msg->recv_type = IPMI_CMD_RECV_TYPE;
3190 recv_msg->msgid = msg->rsp[7] >> 2;
3191 recv_msg->msg.netfn = msg->rsp[4] >> 2;
3192 recv_msg->msg.cmd = msg->rsp[8];
3193 recv_msg->msg.data = recv_msg->msg_data;
3196 * We chop off 10, not 9 bytes because the checksum
3197 * at the end also needs to be removed.
3199 recv_msg->msg.data_len = msg->rsp_size - 10;
3200 memcpy(recv_msg->msg_data,
3202 msg->rsp_size - 10);
3203 deliver_response(recv_msg);
3210 static int handle_lan_get_msg_rsp(ipmi_smi_t intf,
3211 struct ipmi_smi_msg *msg)
3213 struct ipmi_lan_addr lan_addr;
3214 struct ipmi_recv_msg *recv_msg;
3218 * This is 13, not 12, because the response must contain a
3221 if (msg->rsp_size < 13) {
3222 /* Message not big enough, just ignore it. */
3223 ipmi_inc_stat(intf, invalid_lan_responses);
3227 if (msg->rsp[2] != 0) {
3228 /* An error getting the response, just ignore it. */
3232 lan_addr.addr_type = IPMI_LAN_ADDR_TYPE;
3233 lan_addr.session_handle = msg->rsp[4];
3234 lan_addr.remote_SWID = msg->rsp[8];
3235 lan_addr.local_SWID = msg->rsp[5];
3236 lan_addr.channel = msg->rsp[3] & 0x0f;
3237 lan_addr.privilege = msg->rsp[3] >> 4;
3238 lan_addr.lun = msg->rsp[9] & 3;
3241 * It's a response from a remote entity. Look up the sequence
3242 * number and handle the response.
3244 if (intf_find_seq(intf,
3248 (msg->rsp[6] >> 2) & (~1),
3249 (struct ipmi_addr *) &(lan_addr),
3252 * We were unable to find the sequence number,
3253 * so just nuke the message.
3255 ipmi_inc_stat(intf, unhandled_lan_responses);
3259 memcpy(recv_msg->msg_data,
3261 msg->rsp_size - 11);
3263 * The other fields matched, so no need to set them, except
3264 * for netfn, which needs to be the response that was
3265 * returned, not the request value.
3267 recv_msg->msg.netfn = msg->rsp[6] >> 2;
3268 recv_msg->msg.data = recv_msg->msg_data;
3269 recv_msg->msg.data_len = msg->rsp_size - 12;
3270 recv_msg->recv_type = IPMI_RESPONSE_RECV_TYPE;
3271 ipmi_inc_stat(intf, handled_lan_responses);
3272 deliver_response(recv_msg);
3277 static int handle_lan_get_msg_cmd(ipmi_smi_t intf,
3278 struct ipmi_smi_msg *msg)
3280 struct cmd_rcvr *rcvr;
3282 unsigned char netfn;
3285 ipmi_user_t user = NULL;
3286 struct ipmi_lan_addr *lan_addr;
3287 struct ipmi_recv_msg *recv_msg;
3289 if (msg->rsp_size < 12) {
3290 /* Message not big enough, just ignore it. */
3291 ipmi_inc_stat(intf, invalid_commands);
3295 if (msg->rsp[2] != 0) {
3296 /* An error getting the response, just ignore it. */
3300 netfn = msg->rsp[6] >> 2;
3302 chan = msg->rsp[3] & 0xf;
3305 rcvr = find_cmd_rcvr(intf, netfn, cmd, chan);
3308 kref_get(&user->refcount);
3314 /* We didn't find a user, just give up. */
3315 ipmi_inc_stat(intf, unhandled_commands);
3318 * Don't do anything with these messages, just allow
3323 /* Deliver the message to the user. */
3324 ipmi_inc_stat(intf, handled_commands);
3326 recv_msg = ipmi_alloc_recv_msg();
3329 * We couldn't allocate memory for the
3330 * message, so requeue it for handling later.
3333 kref_put(&user->refcount, free_user);
3335 /* Extract the source address from the data. */
3336 lan_addr = (struct ipmi_lan_addr *) &recv_msg->addr;
3337 lan_addr->addr_type = IPMI_LAN_ADDR_TYPE;
3338 lan_addr->session_handle = msg->rsp[4];
3339 lan_addr->remote_SWID = msg->rsp[8];
3340 lan_addr->local_SWID = msg->rsp[5];
3341 lan_addr->lun = msg->rsp[9] & 3;
3342 lan_addr->channel = msg->rsp[3] & 0xf;
3343 lan_addr->privilege = msg->rsp[3] >> 4;
3346 * Extract the rest of the message information
3347 * from the IPMB header.
3349 recv_msg->user = user;
3350 recv_msg->recv_type = IPMI_CMD_RECV_TYPE;
3351 recv_msg->msgid = msg->rsp[9] >> 2;
3352 recv_msg->msg.netfn = msg->rsp[6] >> 2;
3353 recv_msg->msg.cmd = msg->rsp[10];
3354 recv_msg->msg.data = recv_msg->msg_data;
3357 * We chop off 12, not 11 bytes because the checksum
3358 * at the end also needs to be removed.
3360 recv_msg->msg.data_len = msg->rsp_size - 12;
3361 memcpy(recv_msg->msg_data,
3363 msg->rsp_size - 12);
3364 deliver_response(recv_msg);
3372 * This routine will handle "Get Message" command responses with
3373 * channels that use an OEM Medium. The message format belongs to
3374 * the OEM. See IPMI 2.0 specification, Chapter 6 and
3375 * Chapter 22, sections 22.6 and 22.24 for more details.
3377 static int handle_oem_get_msg_cmd(ipmi_smi_t intf,
3378 struct ipmi_smi_msg *msg)
3380 struct cmd_rcvr *rcvr;
3382 unsigned char netfn;
3385 ipmi_user_t user = NULL;
3386 struct ipmi_system_interface_addr *smi_addr;
3387 struct ipmi_recv_msg *recv_msg;
3390 * We expect the OEM SW to perform error checking
3391 * so we just do some basic sanity checks
3393 if (msg->rsp_size < 4) {
3394 /* Message not big enough, just ignore it. */
3395 ipmi_inc_stat(intf, invalid_commands);
3399 if (msg->rsp[2] != 0) {
3400 /* An error getting the response, just ignore it. */
3405 * This is an OEM Message so the OEM needs to know how
3406 * handle the message. We do no interpretation.
3408 netfn = msg->rsp[0] >> 2;
3410 chan = msg->rsp[3] & 0xf;
3413 rcvr = find_cmd_rcvr(intf, netfn, cmd, chan);
3416 kref_get(&user->refcount);
3422 /* We didn't find a user, just give up. */
3423 ipmi_inc_stat(intf, unhandled_commands);
3426 * Don't do anything with these messages, just allow
3432 /* Deliver the message to the user. */
3433 ipmi_inc_stat(intf, handled_commands);
3435 recv_msg = ipmi_alloc_recv_msg();
3438 * We couldn't allocate memory for the
3439 * message, so requeue it for handling
3443 kref_put(&user->refcount, free_user);
3446 * OEM Messages are expected to be delivered via
3447 * the system interface to SMS software. We might
3448 * need to visit this again depending on OEM
3451 smi_addr = ((struct ipmi_system_interface_addr *)
3453 smi_addr->addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
3454 smi_addr->channel = IPMI_BMC_CHANNEL;
3455 smi_addr->lun = msg->rsp[0] & 3;
3457 recv_msg->user = user;
3458 recv_msg->user_msg_data = NULL;
3459 recv_msg->recv_type = IPMI_OEM_RECV_TYPE;
3460 recv_msg->msg.netfn = msg->rsp[0] >> 2;
3461 recv_msg->msg.cmd = msg->rsp[1];
3462 recv_msg->msg.data = recv_msg->msg_data;
3465 * The message starts at byte 4 which follows the
3466 * the Channel Byte in the "GET MESSAGE" command
3468 recv_msg->msg.data_len = msg->rsp_size - 4;
3469 memcpy(recv_msg->msg_data,
3472 deliver_response(recv_msg);
3479 static void copy_event_into_recv_msg(struct ipmi_recv_msg *recv_msg,
3480 struct ipmi_smi_msg *msg)
3482 struct ipmi_system_interface_addr *smi_addr;
3484 recv_msg->msgid = 0;
3485 smi_addr = (struct ipmi_system_interface_addr *) &(recv_msg->addr);
3486 smi_addr->addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
3487 smi_addr->channel = IPMI_BMC_CHANNEL;
3488 smi_addr->lun = msg->rsp[0] & 3;
3489 recv_msg->recv_type = IPMI_ASYNC_EVENT_RECV_TYPE;
3490 recv_msg->msg.netfn = msg->rsp[0] >> 2;
3491 recv_msg->msg.cmd = msg->rsp[1];
3492 memcpy(recv_msg->msg_data, &(msg->rsp[3]), msg->rsp_size - 3);
3493 recv_msg->msg.data = recv_msg->msg_data;
3494 recv_msg->msg.data_len = msg->rsp_size - 3;
3497 static int handle_read_event_rsp(ipmi_smi_t intf,
3498 struct ipmi_smi_msg *msg)
3500 struct ipmi_recv_msg *recv_msg, *recv_msg2;
3501 struct list_head msgs;
3504 int deliver_count = 0;
3505 unsigned long flags;
3507 if (msg->rsp_size < 19) {
3508 /* Message is too small to be an IPMB event. */
3509 ipmi_inc_stat(intf, invalid_events);
3513 if (msg->rsp[2] != 0) {
3514 /* An error getting the event, just ignore it. */
3518 INIT_LIST_HEAD(&msgs);
3520 spin_lock_irqsave(&intf->events_lock, flags);
3522 ipmi_inc_stat(intf, events);
3525 * Allocate and fill in one message for every user that is
3529 list_for_each_entry_rcu(user, &intf->users, link) {
3530 if (!user->gets_events)
3533 recv_msg = ipmi_alloc_recv_msg();
3536 list_for_each_entry_safe(recv_msg, recv_msg2, &msgs,
3538 list_del(&recv_msg->link);
3539 ipmi_free_recv_msg(recv_msg);
3542 * We couldn't allocate memory for the
3543 * message, so requeue it for handling
3552 copy_event_into_recv_msg(recv_msg, msg);
3553 recv_msg->user = user;
3554 kref_get(&user->refcount);
3555 list_add_tail(&(recv_msg->link), &msgs);
3559 if (deliver_count) {
3560 /* Now deliver all the messages. */
3561 list_for_each_entry_safe(recv_msg, recv_msg2, &msgs, link) {
3562 list_del(&recv_msg->link);
3563 deliver_response(recv_msg);
3565 } else if (intf->waiting_events_count < MAX_EVENTS_IN_QUEUE) {
3567 * No one to receive the message, put it in queue if there's
3568 * not already too many things in the queue.
3570 recv_msg = ipmi_alloc_recv_msg();
3573 * We couldn't allocate memory for the
3574 * message, so requeue it for handling
3581 copy_event_into_recv_msg(recv_msg, msg);
3582 list_add_tail(&(recv_msg->link), &(intf->waiting_events));
3583 intf->waiting_events_count++;
3584 } else if (!intf->event_msg_printed) {
3586 * There's too many things in the queue, discard this
3589 printk(KERN_WARNING PFX "Event queue full, discarding"
3590 " incoming events\n");
3591 intf->event_msg_printed = 1;
3595 spin_unlock_irqrestore(&(intf->events_lock), flags);
3600 static int handle_bmc_rsp(ipmi_smi_t intf,
3601 struct ipmi_smi_msg *msg)
3603 struct ipmi_recv_msg *recv_msg;
3604 struct ipmi_user *user;
3606 recv_msg = (struct ipmi_recv_msg *) msg->user_data;
3607 if (recv_msg == NULL) {
3609 "IPMI message received with no owner. This\n"
3610 "could be because of a malformed message, or\n"
3611 "because of a hardware error. Contact your\n"
3612 "hardware vender for assistance\n");
3616 user = recv_msg->user;
3617 /* Make sure the user still exists. */
3618 if (user && !user->valid) {
3619 /* The user for the message went away, so give up. */
3620 ipmi_inc_stat(intf, unhandled_local_responses);
3621 ipmi_free_recv_msg(recv_msg);
3623 struct ipmi_system_interface_addr *smi_addr;
3625 ipmi_inc_stat(intf, handled_local_responses);
3626 recv_msg->recv_type = IPMI_RESPONSE_RECV_TYPE;
3627 recv_msg->msgid = msg->msgid;
3628 smi_addr = ((struct ipmi_system_interface_addr *)
3630 smi_addr->addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
3631 smi_addr->channel = IPMI_BMC_CHANNEL;
3632 smi_addr->lun = msg->rsp[0] & 3;
3633 recv_msg->msg.netfn = msg->rsp[0] >> 2;
3634 recv_msg->msg.cmd = msg->rsp[1];
3635 memcpy(recv_msg->msg_data,
3638 recv_msg->msg.data = recv_msg->msg_data;
3639 recv_msg->msg.data_len = msg->rsp_size - 2;
3640 deliver_response(recv_msg);
3647 * Handle a received message. Return 1 if the message should be requeued,
3648 * 0 if the message should be freed, or -1 if the message should not
3649 * be freed or requeued.
3651 static int handle_one_recv_msg(ipmi_smi_t intf,
3652 struct ipmi_smi_msg *msg)
3660 for (m = 0; m < msg->rsp_size; m++)
3661 printk(" %2.2x", msg->rsp[m]);
3664 if (msg->rsp_size < 2) {
3665 /* Message is too small to be correct. */
3666 printk(KERN_WARNING PFX "BMC returned to small a message"
3667 " for netfn %x cmd %x, got %d bytes\n",
3668 (msg->data[0] >> 2) | 1, msg->data[1], msg->rsp_size);
3670 /* Generate an error response for the message. */
3671 msg->rsp[0] = msg->data[0] | (1 << 2);
3672 msg->rsp[1] = msg->data[1];
3673 msg->rsp[2] = IPMI_ERR_UNSPECIFIED;
3675 } else if (((msg->rsp[0] >> 2) != ((msg->data[0] >> 2) | 1))
3676 || (msg->rsp[1] != msg->data[1])) {
3678 * The NetFN and Command in the response is not even
3679 * marginally correct.
3681 printk(KERN_WARNING PFX "BMC returned incorrect response,"
3682 " expected netfn %x cmd %x, got netfn %x cmd %x\n",
3683 (msg->data[0] >> 2) | 1, msg->data[1],
3684 msg->rsp[0] >> 2, msg->rsp[1]);
3686 /* Generate an error response for the message. */
3687 msg->rsp[0] = msg->data[0] | (1 << 2);
3688 msg->rsp[1] = msg->data[1];
3689 msg->rsp[2] = IPMI_ERR_UNSPECIFIED;
3693 if ((msg->rsp[0] == ((IPMI_NETFN_APP_REQUEST|1) << 2))
3694 && (msg->rsp[1] == IPMI_SEND_MSG_CMD)
3695 && (msg->user_data != NULL)) {
3697 * It's a response to a response we sent. For this we
3698 * deliver a send message response to the user.
3700 struct ipmi_recv_msg *recv_msg = msg->user_data;
3703 if (msg->rsp_size < 2)
3704 /* Message is too small to be correct. */
3707 chan = msg->data[2] & 0x0f;
3708 if (chan >= IPMI_MAX_CHANNELS)
3709 /* Invalid channel number */
3715 /* Make sure the user still exists. */
3716 if (!recv_msg->user || !recv_msg->user->valid)
3719 recv_msg->recv_type = IPMI_RESPONSE_RESPONSE_TYPE;
3720 recv_msg->msg.data = recv_msg->msg_data;
3721 recv_msg->msg.data_len = 1;
3722 recv_msg->msg_data[0] = msg->rsp[2];
3723 deliver_response(recv_msg);
3724 } else if ((msg->rsp[0] == ((IPMI_NETFN_APP_REQUEST|1) << 2))
3725 && (msg->rsp[1] == IPMI_GET_MSG_CMD)) {
3726 /* It's from the receive queue. */
3727 chan = msg->rsp[3] & 0xf;
3728 if (chan >= IPMI_MAX_CHANNELS) {
3729 /* Invalid channel number */
3735 * We need to make sure the channels have been initialized.
3736 * The channel_handler routine will set the "curr_channel"
3737 * equal to or greater than IPMI_MAX_CHANNELS when all the
3738 * channels for this interface have been initialized.
3740 if (intf->curr_channel < IPMI_MAX_CHANNELS) {
3741 requeue = 0; /* Throw the message away */
3745 switch (intf->channels[chan].medium) {
3746 case IPMI_CHANNEL_MEDIUM_IPMB:
3747 if (msg->rsp[4] & 0x04) {
3749 * It's a response, so find the
3750 * requesting message and send it up.
3752 requeue = handle_ipmb_get_msg_rsp(intf, msg);
3755 * It's a command to the SMS from some other
3756 * entity. Handle that.
3758 requeue = handle_ipmb_get_msg_cmd(intf, msg);
3762 case IPMI_CHANNEL_MEDIUM_8023LAN:
3763 case IPMI_CHANNEL_MEDIUM_ASYNC:
3764 if (msg->rsp[6] & 0x04) {
3766 * It's a response, so find the
3767 * requesting message and send it up.
3769 requeue = handle_lan_get_msg_rsp(intf, msg);
3772 * It's a command to the SMS from some other
3773 * entity. Handle that.
3775 requeue = handle_lan_get_msg_cmd(intf, msg);
3780 /* Check for OEM Channels. Clients had better
3781 register for these commands. */
3782 if ((intf->channels[chan].medium
3783 >= IPMI_CHANNEL_MEDIUM_OEM_MIN)
3784 && (intf->channels[chan].medium
3785 <= IPMI_CHANNEL_MEDIUM_OEM_MAX)) {
3786 requeue = handle_oem_get_msg_cmd(intf, msg);
3789 * We don't handle the channel type, so just
3796 } else if ((msg->rsp[0] == ((IPMI_NETFN_APP_REQUEST|1) << 2))
3797 && (msg->rsp[1] == IPMI_READ_EVENT_MSG_BUFFER_CMD)) {
3798 /* It's an asynchronous event. */
3799 requeue = handle_read_event_rsp(intf, msg);
3801 /* It's a response from the local BMC. */
3802 requeue = handle_bmc_rsp(intf, msg);
3810 * If there are messages in the queue or pretimeouts, handle them.
3812 static void handle_new_recv_msgs(ipmi_smi_t intf)
3814 struct ipmi_smi_msg *smi_msg;
3815 unsigned long flags = 0;
3817 int run_to_completion = intf->run_to_completion;
3819 /* See if any waiting messages need to be processed. */
3820 if (!run_to_completion)
3821 spin_lock_irqsave(&intf->waiting_rcv_msgs_lock, flags);
3822 while (!list_empty(&intf->waiting_rcv_msgs)) {
3823 smi_msg = list_entry(intf->waiting_rcv_msgs.next,
3824 struct ipmi_smi_msg, link);
3825 if (!run_to_completion)
3826 spin_unlock_irqrestore(&intf->waiting_rcv_msgs_lock,
3828 rv = handle_one_recv_msg(intf, smi_msg);
3829 if (!run_to_completion)
3830 spin_lock_irqsave(&intf->waiting_rcv_msgs_lock, flags);
3833 * To preserve message order, quit if we
3834 * can't handle a message.
3838 list_del(&smi_msg->link);
3840 /* Message handled */
3841 ipmi_free_smi_msg(smi_msg);
3842 /* If rv < 0, fatal error, del but don't free. */
3845 if (!run_to_completion)
3846 spin_unlock_irqrestore(&intf->waiting_rcv_msgs_lock, flags);
3849 * If the pretimout count is non-zero, decrement one from it and
3850 * deliver pretimeouts to all the users.
3852 if (atomic_add_unless(&intf->watchdog_pretimeouts_to_deliver, -1, 0)) {
3856 list_for_each_entry_rcu(user, &intf->users, link) {
3857 if (user->handler->ipmi_watchdog_pretimeout)
3858 user->handler->ipmi_watchdog_pretimeout(
3859 user->handler_data);
3865 static void smi_recv_tasklet(unsigned long val)
3867 unsigned long flags = 0; /* keep us warning-free. */
3868 ipmi_smi_t intf = (ipmi_smi_t) val;
3869 int run_to_completion = intf->run_to_completion;
3870 struct ipmi_smi_msg *newmsg = NULL;
3873 * Start the next message if available.
3875 * Do this here, not in the actual receiver, because we may deadlock
3876 * because the lower layer is allowed to hold locks while calling
3879 if (!run_to_completion)
3880 spin_lock_irqsave(&intf->xmit_msgs_lock, flags);
3881 if (intf->curr_msg == NULL && !intf->in_shutdown) {
3882 struct list_head *entry = NULL;
3884 /* Pick the high priority queue first. */
3885 if (!list_empty(&intf->hp_xmit_msgs))
3886 entry = intf->hp_xmit_msgs.next;
3887 else if (!list_empty(&intf->xmit_msgs))
3888 entry = intf->xmit_msgs.next;
3892 newmsg = list_entry(entry, struct ipmi_smi_msg, link);
3893 intf->curr_msg = newmsg;
3896 if (!run_to_completion)
3897 spin_unlock_irqrestore(&intf->xmit_msgs_lock, flags);
3899 intf->handlers->sender(intf->send_info, newmsg);
3901 handle_new_recv_msgs(intf);
3904 /* Handle a new message from the lower layer. */
3905 void ipmi_smi_msg_received(ipmi_smi_t intf,
3906 struct ipmi_smi_msg *msg)
3908 unsigned long flags = 0; /* keep us warning-free. */
3909 int run_to_completion = intf->run_to_completion;
3911 if ((msg->data_size >= 2)
3912 && (msg->data[0] == (IPMI_NETFN_APP_REQUEST << 2))
3913 && (msg->data[1] == IPMI_SEND_MSG_CMD)
3914 && (msg->user_data == NULL)) {
3916 if (intf->in_shutdown)
3920 * This is the local response to a command send, start
3921 * the timer for these. The user_data will not be
3922 * NULL if this is a response send, and we will let
3923 * response sends just go through.
3927 * Check for errors, if we get certain errors (ones
3928 * that mean basically we can try again later), we
3929 * ignore them and start the timer. Otherwise we
3930 * report the error immediately.
3932 if ((msg->rsp_size >= 3) && (msg->rsp[2] != 0)
3933 && (msg->rsp[2] != IPMI_NODE_BUSY_ERR)
3934 && (msg->rsp[2] != IPMI_LOST_ARBITRATION_ERR)
3935 && (msg->rsp[2] != IPMI_BUS_ERR)
3936 && (msg->rsp[2] != IPMI_NAK_ON_WRITE_ERR)) {
3937 int chan = msg->rsp[3] & 0xf;
3939 /* Got an error sending the message, handle it. */
3940 if (chan >= IPMI_MAX_CHANNELS)
3941 ; /* This shouldn't happen */
3942 else if ((intf->channels[chan].medium
3943 == IPMI_CHANNEL_MEDIUM_8023LAN)
3944 || (intf->channels[chan].medium
3945 == IPMI_CHANNEL_MEDIUM_ASYNC))
3946 ipmi_inc_stat(intf, sent_lan_command_errs);
3948 ipmi_inc_stat(intf, sent_ipmb_command_errs);
3949 intf_err_seq(intf, msg->msgid, msg->rsp[2]);
3951 /* The message was sent, start the timer. */
3952 intf_start_seq_timer(intf, msg->msgid);
3955 ipmi_free_smi_msg(msg);
3958 * To preserve message order, we keep a queue and deliver from
3961 if (!run_to_completion)
3962 spin_lock_irqsave(&intf->waiting_rcv_msgs_lock, flags);
3963 list_add_tail(&msg->link, &intf->waiting_rcv_msgs);
3964 if (!run_to_completion)
3965 spin_unlock_irqrestore(&intf->waiting_rcv_msgs_lock,
3969 if (!run_to_completion)
3970 spin_lock_irqsave(&intf->xmit_msgs_lock, flags);
3971 if (msg == intf->curr_msg)
3972 intf->curr_msg = NULL;
3973 if (!run_to_completion)
3974 spin_unlock_irqrestore(&intf->xmit_msgs_lock, flags);
3976 if (run_to_completion)
3977 smi_recv_tasklet((unsigned long) intf);
3979 tasklet_schedule(&intf->recv_tasklet);
3981 EXPORT_SYMBOL(ipmi_smi_msg_received);
3983 void ipmi_smi_watchdog_pretimeout(ipmi_smi_t intf)
3985 if (intf->in_shutdown)
3988 atomic_set(&intf->watchdog_pretimeouts_to_deliver, 1);
3989 tasklet_schedule(&intf->recv_tasklet);
3991 EXPORT_SYMBOL(ipmi_smi_watchdog_pretimeout);
3993 static struct ipmi_smi_msg *
3994 smi_from_recv_msg(ipmi_smi_t intf, struct ipmi_recv_msg *recv_msg,
3995 unsigned char seq, long seqid)
3997 struct ipmi_smi_msg *smi_msg = ipmi_alloc_smi_msg();
4000 * If we can't allocate the message, then just return, we
4001 * get 4 retries, so this should be ok.
4005 memcpy(smi_msg->data, recv_msg->msg.data, recv_msg->msg.data_len);
4006 smi_msg->data_size = recv_msg->msg.data_len;
4007 smi_msg->msgid = STORE_SEQ_IN_MSGID(seq, seqid);
4013 for (m = 0; m < smi_msg->data_size; m++)
4014 printk(" %2.2x", smi_msg->data[m]);
4021 static void check_msg_timeout(ipmi_smi_t intf, struct seq_table *ent,
4022 struct list_head *timeouts, long timeout_period,
4023 int slot, unsigned long *flags,
4024 unsigned int *waiting_msgs)
4026 struct ipmi_recv_msg *msg;
4027 struct ipmi_smi_handlers *handlers;
4029 if (intf->in_shutdown)
4035 ent->timeout -= timeout_period;
4036 if (ent->timeout > 0) {
4041 if (ent->retries_left == 0) {
4042 /* The message has used all its retries. */
4044 msg = ent->recv_msg;
4045 list_add_tail(&msg->link, timeouts);
4047 ipmi_inc_stat(intf, timed_out_ipmb_broadcasts);
4048 else if (is_lan_addr(&ent->recv_msg->addr))
4049 ipmi_inc_stat(intf, timed_out_lan_commands);
4051 ipmi_inc_stat(intf, timed_out_ipmb_commands);
4053 struct ipmi_smi_msg *smi_msg;
4054 /* More retries, send again. */
4059 * Start with the max timer, set to normal timer after
4060 * the message is sent.
4062 ent->timeout = MAX_MSG_TIMEOUT;
4063 ent->retries_left--;
4064 smi_msg = smi_from_recv_msg(intf, ent->recv_msg, slot,
4067 if (is_lan_addr(&ent->recv_msg->addr))
4069 dropped_rexmit_lan_commands);
4072 dropped_rexmit_ipmb_commands);
4076 spin_unlock_irqrestore(&intf->seq_lock, *flags);
4079 * Send the new message. We send with a zero
4080 * priority. It timed out, I doubt time is that
4081 * critical now, and high priority messages are really
4082 * only for messages to the local MC, which don't get
4085 handlers = intf->handlers;
4087 if (is_lan_addr(&ent->recv_msg->addr))
4089 retransmitted_lan_commands);
4092 retransmitted_ipmb_commands);
4094 smi_send(intf, intf->handlers, smi_msg, 0);
4096 ipmi_free_smi_msg(smi_msg);
4098 spin_lock_irqsave(&intf->seq_lock, *flags);
4102 static unsigned int ipmi_timeout_handler(ipmi_smi_t intf, long timeout_period)
4104 struct list_head timeouts;
4105 struct ipmi_recv_msg *msg, *msg2;
4106 unsigned long flags;
4108 unsigned int waiting_msgs = 0;
4111 * Go through the seq table and find any messages that
4112 * have timed out, putting them in the timeouts
4115 INIT_LIST_HEAD(&timeouts);
4116 spin_lock_irqsave(&intf->seq_lock, flags);
4117 for (i = 0; i < IPMI_IPMB_NUM_SEQ; i++)
4118 check_msg_timeout(intf, &(intf->seq_table[i]),
4119 &timeouts, timeout_period, i,
4120 &flags, &waiting_msgs);
4121 spin_unlock_irqrestore(&intf->seq_lock, flags);
4123 list_for_each_entry_safe(msg, msg2, &timeouts, link)
4124 deliver_err_response(msg, IPMI_TIMEOUT_COMPLETION_CODE);
4127 * Maintenance mode handling. Check the timeout
4128 * optimistically before we claim the lock. It may
4129 * mean a timeout gets missed occasionally, but that
4130 * only means the timeout gets extended by one period
4131 * in that case. No big deal, and it avoids the lock
4134 if (intf->auto_maintenance_timeout > 0) {
4135 spin_lock_irqsave(&intf->maintenance_mode_lock, flags);
4136 if (intf->auto_maintenance_timeout > 0) {
4137 intf->auto_maintenance_timeout
4139 if (!intf->maintenance_mode
4140 && (intf->auto_maintenance_timeout <= 0)) {
4141 intf->maintenance_mode_enable = false;
4142 maintenance_mode_update(intf);
4145 spin_unlock_irqrestore(&intf->maintenance_mode_lock,
4149 tasklet_schedule(&intf->recv_tasklet);
4151 return waiting_msgs;
4154 static void ipmi_request_event(ipmi_smi_t intf)
4156 /* No event requests when in maintenance mode. */
4157 if (intf->maintenance_mode_enable)
4160 if (!intf->in_shutdown)
4161 intf->handlers->request_events(intf->send_info);
4164 static struct timer_list ipmi_timer;
4166 static atomic_t stop_operation;
4168 static void ipmi_timeout(unsigned long data)
4173 if (atomic_read(&stop_operation))
4177 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
4180 if (atomic_read(&intf->event_waiters)) {
4181 intf->ticks_to_req_ev--;
4182 if (intf->ticks_to_req_ev == 0) {
4183 ipmi_request_event(intf);
4184 intf->ticks_to_req_ev = IPMI_REQUEST_EV_TIME;
4189 lnt += ipmi_timeout_handler(intf, IPMI_TIMEOUT_TIME);
4192 if (lnt != intf->last_needs_timer &&
4193 intf->handlers->set_need_watch)
4194 intf->handlers->set_need_watch(intf->send_info, lnt);
4195 intf->last_needs_timer = lnt;
4202 mod_timer(&ipmi_timer, jiffies + IPMI_TIMEOUT_JIFFIES);
4205 static void need_waiter(ipmi_smi_t intf)
4207 /* Racy, but worst case we start the timer twice. */
4208 if (!timer_pending(&ipmi_timer))
4209 mod_timer(&ipmi_timer, jiffies + IPMI_TIMEOUT_JIFFIES);
4212 static atomic_t smi_msg_inuse_count = ATOMIC_INIT(0);
4213 static atomic_t recv_msg_inuse_count = ATOMIC_INIT(0);
4215 /* FIXME - convert these to slabs. */
4216 static void free_smi_msg(struct ipmi_smi_msg *msg)
4218 atomic_dec(&smi_msg_inuse_count);
4222 struct ipmi_smi_msg *ipmi_alloc_smi_msg(void)
4224 struct ipmi_smi_msg *rv;
4225 rv = kmalloc(sizeof(struct ipmi_smi_msg), GFP_ATOMIC);
4227 rv->done = free_smi_msg;
4228 rv->user_data = NULL;
4229 atomic_inc(&smi_msg_inuse_count);
4233 EXPORT_SYMBOL(ipmi_alloc_smi_msg);
4235 static void free_recv_msg(struct ipmi_recv_msg *msg)
4237 atomic_dec(&recv_msg_inuse_count);
4241 static struct ipmi_recv_msg *ipmi_alloc_recv_msg(void)
4243 struct ipmi_recv_msg *rv;
4245 rv = kmalloc(sizeof(struct ipmi_recv_msg), GFP_ATOMIC);
4248 rv->done = free_recv_msg;
4249 atomic_inc(&recv_msg_inuse_count);
4254 void ipmi_free_recv_msg(struct ipmi_recv_msg *msg)
4257 kref_put(&msg->user->refcount, free_user);
4260 EXPORT_SYMBOL(ipmi_free_recv_msg);
4262 #ifdef CONFIG_IPMI_PANIC_EVENT
4264 static atomic_t panic_done_count = ATOMIC_INIT(0);
4266 static void dummy_smi_done_handler(struct ipmi_smi_msg *msg)
4268 atomic_dec(&panic_done_count);
4271 static void dummy_recv_done_handler(struct ipmi_recv_msg *msg)
4273 atomic_dec(&panic_done_count);
4277 * Inside a panic, send a message and wait for a response.
4279 static void ipmi_panic_request_and_wait(ipmi_smi_t intf,
4280 struct ipmi_addr *addr,
4281 struct kernel_ipmi_msg *msg)
4283 struct ipmi_smi_msg smi_msg;
4284 struct ipmi_recv_msg recv_msg;
4287 smi_msg.done = dummy_smi_done_handler;
4288 recv_msg.done = dummy_recv_done_handler;
4289 atomic_add(2, &panic_done_count);
4290 rv = i_ipmi_request(NULL,
4299 intf->channels[0].address,
4300 intf->channels[0].lun,
4301 0, 1); /* Don't retry, and don't wait. */
4303 atomic_sub(2, &panic_done_count);
4304 while (atomic_read(&panic_done_count) != 0)
4308 #ifdef CONFIG_IPMI_PANIC_STRING
4309 static void event_receiver_fetcher(ipmi_smi_t intf, struct ipmi_recv_msg *msg)
4311 if ((msg->addr.addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
4312 && (msg->msg.netfn == IPMI_NETFN_SENSOR_EVENT_RESPONSE)
4313 && (msg->msg.cmd == IPMI_GET_EVENT_RECEIVER_CMD)
4314 && (msg->msg.data[0] == IPMI_CC_NO_ERROR)) {
4315 /* A get event receiver command, save it. */
4316 intf->event_receiver = msg->msg.data[1];
4317 intf->event_receiver_lun = msg->msg.data[2] & 0x3;
4321 static void device_id_fetcher(ipmi_smi_t intf, struct ipmi_recv_msg *msg)
4323 if ((msg->addr.addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
4324 && (msg->msg.netfn == IPMI_NETFN_APP_RESPONSE)
4325 && (msg->msg.cmd == IPMI_GET_DEVICE_ID_CMD)
4326 && (msg->msg.data[0] == IPMI_CC_NO_ERROR)) {
4328 * A get device id command, save if we are an event
4329 * receiver or generator.
4331 intf->local_sel_device = (msg->msg.data[6] >> 2) & 1;
4332 intf->local_event_generator = (msg->msg.data[6] >> 5) & 1;
4337 static void send_panic_events(char *str)
4339 struct kernel_ipmi_msg msg;
4341 unsigned char data[16];
4342 struct ipmi_system_interface_addr *si;
4343 struct ipmi_addr addr;
4345 si = (struct ipmi_system_interface_addr *) &addr;
4346 si->addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
4347 si->channel = IPMI_BMC_CHANNEL;
4350 /* Fill in an event telling that we have failed. */
4351 msg.netfn = 0x04; /* Sensor or Event. */
4352 msg.cmd = 2; /* Platform event command. */
4355 data[0] = 0x41; /* Kernel generator ID, IPMI table 5-4 */
4356 data[1] = 0x03; /* This is for IPMI 1.0. */
4357 data[2] = 0x20; /* OS Critical Stop, IPMI table 36-3 */
4358 data[4] = 0x6f; /* Sensor specific, IPMI table 36-1 */
4359 data[5] = 0xa1; /* Runtime stop OEM bytes 2 & 3. */
4362 * Put a few breadcrumbs in. Hopefully later we can add more things
4363 * to make the panic events more useful.
4371 /* For every registered interface, send the event. */
4372 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
4373 if (!intf->handlers)
4374 /* Interface is not ready. */
4377 intf->run_to_completion = 1;
4378 /* Send the event announcing the panic. */
4379 intf->handlers->set_run_to_completion(intf->send_info, 1);
4380 ipmi_panic_request_and_wait(intf, &addr, &msg);
4383 #ifdef CONFIG_IPMI_PANIC_STRING
4385 * On every interface, dump a bunch of OEM event holding the
4391 /* For every registered interface, send the event. */
4392 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
4394 struct ipmi_ipmb_addr *ipmb;
4397 if (intf->intf_num == -1)
4398 /* Interface was not ready yet. */
4402 * intf_num is used as an marker to tell if the
4403 * interface is valid. Thus we need a read barrier to
4404 * make sure data fetched before checking intf_num
4410 * First job here is to figure out where to send the
4411 * OEM events. There's no way in IPMI to send OEM
4412 * events using an event send command, so we have to
4413 * find the SEL to put them in and stick them in
4417 /* Get capabilities from the get device id. */
4418 intf->local_sel_device = 0;
4419 intf->local_event_generator = 0;
4420 intf->event_receiver = 0;
4422 /* Request the device info from the local MC. */
4423 msg.netfn = IPMI_NETFN_APP_REQUEST;
4424 msg.cmd = IPMI_GET_DEVICE_ID_CMD;
4427 intf->null_user_handler = device_id_fetcher;
4428 ipmi_panic_request_and_wait(intf, &addr, &msg);
4430 if (intf->local_event_generator) {
4431 /* Request the event receiver from the local MC. */
4432 msg.netfn = IPMI_NETFN_SENSOR_EVENT_REQUEST;
4433 msg.cmd = IPMI_GET_EVENT_RECEIVER_CMD;
4436 intf->null_user_handler = event_receiver_fetcher;
4437 ipmi_panic_request_and_wait(intf, &addr, &msg);
4439 intf->null_user_handler = NULL;
4442 * Validate the event receiver. The low bit must not
4443 * be 1 (it must be a valid IPMB address), it cannot
4444 * be zero, and it must not be my address.
4446 if (((intf->event_receiver & 1) == 0)
4447 && (intf->event_receiver != 0)
4448 && (intf->event_receiver != intf->channels[0].address)) {
4450 * The event receiver is valid, send an IPMB
4453 ipmb = (struct ipmi_ipmb_addr *) &addr;
4454 ipmb->addr_type = IPMI_IPMB_ADDR_TYPE;
4455 ipmb->channel = 0; /* FIXME - is this right? */
4456 ipmb->lun = intf->event_receiver_lun;
4457 ipmb->slave_addr = intf->event_receiver;
4458 } else if (intf->local_sel_device) {
4460 * The event receiver was not valid (or was
4461 * me), but I am an SEL device, just dump it
4464 si = (struct ipmi_system_interface_addr *) &addr;
4465 si->addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
4466 si->channel = IPMI_BMC_CHANNEL;
4469 continue; /* No where to send the event. */
4471 msg.netfn = IPMI_NETFN_STORAGE_REQUEST; /* Storage. */
4472 msg.cmd = IPMI_ADD_SEL_ENTRY_CMD;
4478 int size = strlen(p);
4484 data[2] = 0xf0; /* OEM event without timestamp. */
4485 data[3] = intf->channels[0].address;
4486 data[4] = j++; /* sequence # */
4488 * Always give 11 bytes, so strncpy will fill
4489 * it with zeroes for me.
4491 strncpy(data+5, p, 11);
4494 ipmi_panic_request_and_wait(intf, &addr, &msg);
4497 #endif /* CONFIG_IPMI_PANIC_STRING */
4499 #endif /* CONFIG_IPMI_PANIC_EVENT */
4501 static int has_panicked;
4503 static int panic_event(struct notifier_block *this,
4504 unsigned long event,
4513 /* For every registered interface, set it to run to completion. */
4514 list_for_each_entry_rcu(intf, &ipmi_interfaces, link) {
4515 if (!intf->handlers)
4516 /* Interface is not ready. */
4519 intf->run_to_completion = 1;
4520 intf->handlers->set_run_to_completion(intf->send_info, 1);
4523 #ifdef CONFIG_IPMI_PANIC_EVENT
4524 send_panic_events(ptr);
4530 static struct notifier_block panic_block = {
4531 .notifier_call = panic_event,
4533 .priority = 200 /* priority: INT_MAX >= x >= 0 */
4536 static int ipmi_init_msghandler(void)
4543 rv = driver_register(&ipmidriver.driver);
4545 printk(KERN_ERR PFX "Could not register IPMI driver\n");
4549 printk(KERN_INFO "ipmi message handler version "
4550 IPMI_DRIVER_VERSION "\n");
4552 #ifdef CONFIG_PROC_FS
4553 proc_ipmi_root = proc_mkdir("ipmi", NULL);
4554 if (!proc_ipmi_root) {
4555 printk(KERN_ERR PFX "Unable to create IPMI proc dir");
4556 driver_unregister(&ipmidriver.driver);
4560 #endif /* CONFIG_PROC_FS */
4562 setup_timer(&ipmi_timer, ipmi_timeout, 0);
4563 mod_timer(&ipmi_timer, jiffies + IPMI_TIMEOUT_JIFFIES);
4565 atomic_notifier_chain_register(&panic_notifier_list, &panic_block);
4572 static int __init ipmi_init_msghandler_mod(void)
4574 ipmi_init_msghandler();
4578 static void __exit cleanup_ipmi(void)
4585 atomic_notifier_chain_unregister(&panic_notifier_list, &panic_block);
4588 * This can't be called if any interfaces exist, so no worry
4589 * about shutting down the interfaces.
4593 * Tell the timer to stop, then wait for it to stop. This
4594 * avoids problems with race conditions removing the timer
4597 atomic_inc(&stop_operation);
4598 del_timer_sync(&ipmi_timer);
4600 #ifdef CONFIG_PROC_FS
4601 proc_remove(proc_ipmi_root);
4602 #endif /* CONFIG_PROC_FS */
4604 driver_unregister(&ipmidriver.driver);
4608 /* Check for buffer leaks. */
4609 count = atomic_read(&smi_msg_inuse_count);
4611 printk(KERN_WARNING PFX "SMI message count %d at exit\n",
4613 count = atomic_read(&recv_msg_inuse_count);
4615 printk(KERN_WARNING PFX "recv message count %d at exit\n",
4618 module_exit(cleanup_ipmi);
4620 module_init(ipmi_init_msghandler_mod);
4621 MODULE_LICENSE("GPL");
4622 MODULE_AUTHOR("Corey Minyard <minyard@mvista.com>");
4623 MODULE_DESCRIPTION("Incoming and outgoing message routing for an IPMI"
4625 MODULE_VERSION(IPMI_DRIVER_VERSION);