4 * The interface to the IPMI driver for the system interfaces (KCS, SMIC,
7 * Author: MontaVista Software, Inc.
8 * Corey Minyard <minyard@mvista.com>
11 * Copyright 2002 MontaVista Software Inc.
12 * Copyright 2006 IBM Corp., Christian Krafft <krafft@de.ibm.com>
14 * This program is free software; you can redistribute it and/or modify it
15 * under the terms of the GNU General Public License as published by the
16 * Free Software Foundation; either version 2 of the License, or (at your
17 * option) any later version.
20 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
21 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
26 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
28 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
29 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 * You should have received a copy of the GNU General Public License along
32 * with this program; if not, write to the Free Software Foundation, Inc.,
33 * 675 Mass Ave, Cambridge, MA 02139, USA.
37 * This file holds the "policy" for the interface to the SMI state
38 * machine. It does the configuration, handles timers and interrupts,
39 * and drives the real SMI state machine.
42 #include <linux/module.h>
43 #include <linux/moduleparam.h>
44 #include <asm/system.h>
45 #include <linux/sched.h>
46 #include <linux/timer.h>
47 #include <linux/errno.h>
48 #include <linux/spinlock.h>
49 #include <linux/slab.h>
50 #include <linux/delay.h>
51 #include <linux/list.h>
52 #include <linux/pci.h>
53 #include <linux/ioport.h>
54 #include <linux/notifier.h>
55 #include <linux/mutex.h>
56 #include <linux/kthread.h>
58 #include <linux/interrupt.h>
59 #include <linux/rcupdate.h>
60 #include <linux/ipmi_smi.h>
62 #include "ipmi_si_sm.h"
63 #include <linux/init.h>
64 #include <linux/dmi.h>
65 #include <linux/string.h>
66 #include <linux/ctype.h>
67 #include <linux/pnp.h>
70 #include <linux/of_device.h>
71 #include <linux/of_platform.h>
74 #define PFX "ipmi_si: "
76 /* Measure times between events in the driver. */
79 /* Call every 10 ms. */
80 #define SI_TIMEOUT_TIME_USEC 10000
81 #define SI_USEC_PER_JIFFY (1000000/HZ)
82 #define SI_TIMEOUT_JIFFIES (SI_TIMEOUT_TIME_USEC/SI_USEC_PER_JIFFY)
83 #define SI_SHORT_TIMEOUT_USEC 250 /* .25ms when the SM request a
91 SI_CLEARING_FLAGS_THEN_SET_IRQ,
93 SI_ENABLE_INTERRUPTS1,
94 SI_ENABLE_INTERRUPTS2,
95 SI_DISABLE_INTERRUPTS1,
96 SI_DISABLE_INTERRUPTS2
97 /* FIXME - add watchdog stuff. */
100 /* Some BT-specific defines we need here. */
101 #define IPMI_BT_INTMASK_REG 2
102 #define IPMI_BT_INTMASK_CLEAR_IRQ_BIT 2
103 #define IPMI_BT_INTMASK_ENABLE_IRQ_BIT 1
106 SI_KCS, SI_SMIC, SI_BT
108 static char *si_to_str[] = { "kcs", "smic", "bt" };
111 SI_INVALID = 0, SI_HOTMOD, SI_HARDCODED, SI_SPMI, SI_ACPI, SI_SMBIOS,
112 SI_PCI, SI_DEVICETREE, SI_DEFAULT
114 static char *ipmi_addr_src_to_str[] = { NULL, "hotmod", "hardcoded", "SPMI",
115 "ACPI", "SMBIOS", "PCI",
116 "device-tree", "default" };
118 #define DEVICE_NAME "ipmi_si"
120 static struct platform_driver ipmi_driver = {
123 .bus = &platform_bus_type
129 * Indexes into stats[] in smi_info below.
131 enum si_stat_indexes {
133 * Number of times the driver requested a timer while an operation
136 SI_STAT_short_timeouts = 0,
139 * Number of times the driver requested a timer while nothing was in
142 SI_STAT_long_timeouts,
144 /* Number of times the interface was idle while being polled. */
147 /* Number of interrupts the driver handled. */
150 /* Number of time the driver got an ATTN from the hardware. */
153 /* Number of times the driver requested flags from the hardware. */
154 SI_STAT_flag_fetches,
156 /* Number of times the hardware didn't follow the state machine. */
159 /* Number of completed messages. */
160 SI_STAT_complete_transactions,
162 /* Number of IPMI events received from the hardware. */
165 /* Number of watchdog pretimeouts. */
166 SI_STAT_watchdog_pretimeouts,
168 /* Number of asyncronous messages received. */
169 SI_STAT_incoming_messages,
172 /* This *must* remain last, add new values above this. */
179 struct si_sm_data *si_sm;
180 struct si_sm_handlers *handlers;
181 enum si_type si_type;
184 struct list_head xmit_msgs;
185 struct list_head hp_xmit_msgs;
186 struct ipmi_smi_msg *curr_msg;
187 enum si_intf_state si_state;
190 * Used to handle the various types of I/O that can occur with
194 int (*io_setup)(struct smi_info *info);
195 void (*io_cleanup)(struct smi_info *info);
196 int (*irq_setup)(struct smi_info *info);
197 void (*irq_cleanup)(struct smi_info *info);
198 unsigned int io_size;
199 enum ipmi_addr_src addr_source; /* ACPI, PCI, SMBIOS, hardcode, etc. */
200 void (*addr_source_cleanup)(struct smi_info *info);
201 void *addr_source_data;
204 * Per-OEM handler, called from handle_flags(). Returns 1
205 * when handle_flags() needs to be re-run or 0 indicating it
206 * set si_state itself.
208 int (*oem_data_avail_handler)(struct smi_info *smi_info);
211 * Flags from the last GET_MSG_FLAGS command, used when an ATTN
212 * is set to hold the flags until we are done handling everything
215 #define RECEIVE_MSG_AVAIL 0x01
216 #define EVENT_MSG_BUFFER_FULL 0x02
217 #define WDT_PRE_TIMEOUT_INT 0x08
218 #define OEM0_DATA_AVAIL 0x20
219 #define OEM1_DATA_AVAIL 0x40
220 #define OEM2_DATA_AVAIL 0x80
221 #define OEM_DATA_AVAIL (OEM0_DATA_AVAIL | \
224 unsigned char msg_flags;
226 /* Does the BMC have an event buffer? */
227 char has_event_buffer;
230 * If set to true, this will request events the next time the
231 * state machine is idle.
236 * If true, run the state machine to completion on every send
237 * call. Generally used after a panic to make sure stuff goes
240 int run_to_completion;
242 /* The I/O port of an SI interface. */
246 * The space between start addresses of the two ports. For
247 * instance, if the first port is 0xca2 and the spacing is 4, then
248 * the second port is 0xca6.
250 unsigned int spacing;
252 /* zero if no irq; */
255 /* The timer for this si. */
256 struct timer_list si_timer;
258 /* The time (in jiffies) the last timeout occurred at. */
259 unsigned long last_timeout_jiffies;
261 /* Used to gracefully stop the timer without race conditions. */
262 atomic_t stop_operation;
265 * The driver will disable interrupts when it gets into a
266 * situation where it cannot handle messages due to lack of
267 * memory. Once that situation clears up, it will re-enable
270 int interrupt_disabled;
272 /* From the get device id response... */
273 struct ipmi_device_id device_id;
275 /* Driver model stuff. */
277 struct platform_device *pdev;
280 * True if we allocated the device, false if it came from
281 * someplace else (like PCI).
285 /* Slave address, could be reported from DMI. */
286 unsigned char slave_addr;
288 /* Counters and things for the proc filesystem. */
289 atomic_t stats[SI_NUM_STATS];
291 struct task_struct *thread;
293 struct list_head link;
296 #define smi_inc_stat(smi, stat) \
297 atomic_inc(&(smi)->stats[SI_STAT_ ## stat])
298 #define smi_get_stat(smi, stat) \
299 ((unsigned int) atomic_read(&(smi)->stats[SI_STAT_ ## stat]))
301 #define SI_MAX_PARMS 4
303 static int force_kipmid[SI_MAX_PARMS];
304 static int num_force_kipmid;
306 static unsigned int kipmid_max_busy_us[SI_MAX_PARMS];
307 static int num_max_busy_us;
309 static int unload_when_empty = 1;
311 static int try_smi_init(struct smi_info *smi);
312 static void cleanup_one_si(struct smi_info *to_clean);
314 static ATOMIC_NOTIFIER_HEAD(xaction_notifier_list);
315 static int register_xaction_notifier(struct notifier_block *nb)
317 return atomic_notifier_chain_register(&xaction_notifier_list, nb);
320 static void deliver_recv_msg(struct smi_info *smi_info,
321 struct ipmi_smi_msg *msg)
323 /* Deliver the message to the upper layer with the lock
325 spin_unlock(&(smi_info->si_lock));
326 ipmi_smi_msg_received(smi_info->intf, msg);
327 spin_lock(&(smi_info->si_lock));
330 static void return_hosed_msg(struct smi_info *smi_info, int cCode)
332 struct ipmi_smi_msg *msg = smi_info->curr_msg;
334 if (cCode < 0 || cCode > IPMI_ERR_UNSPECIFIED)
335 cCode = IPMI_ERR_UNSPECIFIED;
336 /* else use it as is */
338 /* Make it a reponse */
339 msg->rsp[0] = msg->data[0] | 4;
340 msg->rsp[1] = msg->data[1];
344 smi_info->curr_msg = NULL;
345 deliver_recv_msg(smi_info, msg);
348 static enum si_sm_result start_next_msg(struct smi_info *smi_info)
351 struct list_head *entry = NULL;
357 * No need to save flags, we aleady have interrupts off and we
358 * already hold the SMI lock.
360 if (!smi_info->run_to_completion)
361 spin_lock(&(smi_info->msg_lock));
363 /* Pick the high priority queue first. */
364 if (!list_empty(&(smi_info->hp_xmit_msgs))) {
365 entry = smi_info->hp_xmit_msgs.next;
366 } else if (!list_empty(&(smi_info->xmit_msgs))) {
367 entry = smi_info->xmit_msgs.next;
371 smi_info->curr_msg = NULL;
377 smi_info->curr_msg = list_entry(entry,
382 printk(KERN_DEBUG "**Start2: %d.%9.9d\n", t.tv_sec, t.tv_usec);
384 err = atomic_notifier_call_chain(&xaction_notifier_list,
386 if (err & NOTIFY_STOP_MASK) {
387 rv = SI_SM_CALL_WITHOUT_DELAY;
390 err = smi_info->handlers->start_transaction(
392 smi_info->curr_msg->data,
393 smi_info->curr_msg->data_size);
395 return_hosed_msg(smi_info, err);
397 rv = SI_SM_CALL_WITHOUT_DELAY;
400 if (!smi_info->run_to_completion)
401 spin_unlock(&(smi_info->msg_lock));
406 static void start_enable_irq(struct smi_info *smi_info)
408 unsigned char msg[2];
411 * If we are enabling interrupts, we have to tell the
414 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
415 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
417 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
418 smi_info->si_state = SI_ENABLE_INTERRUPTS1;
421 static void start_disable_irq(struct smi_info *smi_info)
423 unsigned char msg[2];
425 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
426 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
428 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
429 smi_info->si_state = SI_DISABLE_INTERRUPTS1;
432 static void start_clear_flags(struct smi_info *smi_info)
434 unsigned char msg[3];
436 /* Make sure the watchdog pre-timeout flag is not set at startup. */
437 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
438 msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
439 msg[2] = WDT_PRE_TIMEOUT_INT;
441 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 3);
442 smi_info->si_state = SI_CLEARING_FLAGS;
446 * When we have a situtaion where we run out of memory and cannot
447 * allocate messages, we just leave them in the BMC and run the system
448 * polled until we can allocate some memory. Once we have some
449 * memory, we will re-enable the interrupt.
451 static inline void disable_si_irq(struct smi_info *smi_info)
453 if ((smi_info->irq) && (!smi_info->interrupt_disabled)) {
454 start_disable_irq(smi_info);
455 smi_info->interrupt_disabled = 1;
459 static inline void enable_si_irq(struct smi_info *smi_info)
461 if ((smi_info->irq) && (smi_info->interrupt_disabled)) {
462 start_enable_irq(smi_info);
463 smi_info->interrupt_disabled = 0;
467 static void handle_flags(struct smi_info *smi_info)
470 if (smi_info->msg_flags & WDT_PRE_TIMEOUT_INT) {
471 /* Watchdog pre-timeout */
472 smi_inc_stat(smi_info, watchdog_pretimeouts);
474 start_clear_flags(smi_info);
475 smi_info->msg_flags &= ~WDT_PRE_TIMEOUT_INT;
476 spin_unlock(&(smi_info->si_lock));
477 ipmi_smi_watchdog_pretimeout(smi_info->intf);
478 spin_lock(&(smi_info->si_lock));
479 } else if (smi_info->msg_flags & RECEIVE_MSG_AVAIL) {
480 /* Messages available. */
481 smi_info->curr_msg = ipmi_alloc_smi_msg();
482 if (!smi_info->curr_msg) {
483 disable_si_irq(smi_info);
484 smi_info->si_state = SI_NORMAL;
487 enable_si_irq(smi_info);
489 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
490 smi_info->curr_msg->data[1] = IPMI_GET_MSG_CMD;
491 smi_info->curr_msg->data_size = 2;
493 smi_info->handlers->start_transaction(
495 smi_info->curr_msg->data,
496 smi_info->curr_msg->data_size);
497 smi_info->si_state = SI_GETTING_MESSAGES;
498 } else if (smi_info->msg_flags & EVENT_MSG_BUFFER_FULL) {
499 /* Events available. */
500 smi_info->curr_msg = ipmi_alloc_smi_msg();
501 if (!smi_info->curr_msg) {
502 disable_si_irq(smi_info);
503 smi_info->si_state = SI_NORMAL;
506 enable_si_irq(smi_info);
508 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
509 smi_info->curr_msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
510 smi_info->curr_msg->data_size = 2;
512 smi_info->handlers->start_transaction(
514 smi_info->curr_msg->data,
515 smi_info->curr_msg->data_size);
516 smi_info->si_state = SI_GETTING_EVENTS;
517 } else if (smi_info->msg_flags & OEM_DATA_AVAIL &&
518 smi_info->oem_data_avail_handler) {
519 if (smi_info->oem_data_avail_handler(smi_info))
522 smi_info->si_state = SI_NORMAL;
525 static void handle_transaction_done(struct smi_info *smi_info)
527 struct ipmi_smi_msg *msg;
532 printk(KERN_DEBUG "**Done: %d.%9.9d\n", t.tv_sec, t.tv_usec);
534 switch (smi_info->si_state) {
536 if (!smi_info->curr_msg)
539 smi_info->curr_msg->rsp_size
540 = smi_info->handlers->get_result(
542 smi_info->curr_msg->rsp,
543 IPMI_MAX_MSG_LENGTH);
546 * Do this here becase deliver_recv_msg() releases the
547 * lock, and a new message can be put in during the
548 * time the lock is released.
550 msg = smi_info->curr_msg;
551 smi_info->curr_msg = NULL;
552 deliver_recv_msg(smi_info, msg);
555 case SI_GETTING_FLAGS:
557 unsigned char msg[4];
560 /* We got the flags from the SMI, now handle them. */
561 len = smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
563 /* Error fetching flags, just give up for now. */
564 smi_info->si_state = SI_NORMAL;
565 } else if (len < 4) {
567 * Hmm, no flags. That's technically illegal, but
568 * don't use uninitialized data.
570 smi_info->si_state = SI_NORMAL;
572 smi_info->msg_flags = msg[3];
573 handle_flags(smi_info);
578 case SI_CLEARING_FLAGS:
579 case SI_CLEARING_FLAGS_THEN_SET_IRQ:
581 unsigned char msg[3];
583 /* We cleared the flags. */
584 smi_info->handlers->get_result(smi_info->si_sm, msg, 3);
586 /* Error clearing flags */
588 "ipmi_si: Error clearing flags: %2.2x\n",
591 if (smi_info->si_state == SI_CLEARING_FLAGS_THEN_SET_IRQ)
592 start_enable_irq(smi_info);
594 smi_info->si_state = SI_NORMAL;
598 case SI_GETTING_EVENTS:
600 smi_info->curr_msg->rsp_size
601 = smi_info->handlers->get_result(
603 smi_info->curr_msg->rsp,
604 IPMI_MAX_MSG_LENGTH);
607 * Do this here becase deliver_recv_msg() releases the
608 * lock, and a new message can be put in during the
609 * time the lock is released.
611 msg = smi_info->curr_msg;
612 smi_info->curr_msg = NULL;
613 if (msg->rsp[2] != 0) {
614 /* Error getting event, probably done. */
617 /* Take off the event flag. */
618 smi_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
619 handle_flags(smi_info);
621 smi_inc_stat(smi_info, events);
624 * Do this before we deliver the message
625 * because delivering the message releases the
626 * lock and something else can mess with the
629 handle_flags(smi_info);
631 deliver_recv_msg(smi_info, msg);
636 case SI_GETTING_MESSAGES:
638 smi_info->curr_msg->rsp_size
639 = smi_info->handlers->get_result(
641 smi_info->curr_msg->rsp,
642 IPMI_MAX_MSG_LENGTH);
645 * Do this here becase deliver_recv_msg() releases the
646 * lock, and a new message can be put in during the
647 * time the lock is released.
649 msg = smi_info->curr_msg;
650 smi_info->curr_msg = NULL;
651 if (msg->rsp[2] != 0) {
652 /* Error getting event, probably done. */
655 /* Take off the msg flag. */
656 smi_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
657 handle_flags(smi_info);
659 smi_inc_stat(smi_info, incoming_messages);
662 * Do this before we deliver the message
663 * because delivering the message releases the
664 * lock and something else can mess with the
667 handle_flags(smi_info);
669 deliver_recv_msg(smi_info, msg);
674 case SI_ENABLE_INTERRUPTS1:
676 unsigned char msg[4];
678 /* We got the flags from the SMI, now handle them. */
679 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
682 "ipmi_si: Could not enable interrupts"
683 ", failed get, using polled mode.\n");
684 smi_info->si_state = SI_NORMAL;
686 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
687 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
689 IPMI_BMC_RCV_MSG_INTR |
690 IPMI_BMC_EVT_MSG_INTR);
691 smi_info->handlers->start_transaction(
692 smi_info->si_sm, msg, 3);
693 smi_info->si_state = SI_ENABLE_INTERRUPTS2;
698 case SI_ENABLE_INTERRUPTS2:
700 unsigned char msg[4];
702 /* We got the flags from the SMI, now handle them. */
703 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
706 "ipmi_si: Could not enable interrupts"
707 ", failed set, using polled mode.\n");
709 smi_info->si_state = SI_NORMAL;
713 case SI_DISABLE_INTERRUPTS1:
715 unsigned char msg[4];
717 /* We got the flags from the SMI, now handle them. */
718 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
721 "ipmi_si: Could not disable interrupts"
723 smi_info->si_state = SI_NORMAL;
725 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
726 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
728 ~(IPMI_BMC_RCV_MSG_INTR |
729 IPMI_BMC_EVT_MSG_INTR));
730 smi_info->handlers->start_transaction(
731 smi_info->si_sm, msg, 3);
732 smi_info->si_state = SI_DISABLE_INTERRUPTS2;
737 case SI_DISABLE_INTERRUPTS2:
739 unsigned char msg[4];
741 /* We got the flags from the SMI, now handle them. */
742 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
745 "ipmi_si: Could not disable interrupts"
748 smi_info->si_state = SI_NORMAL;
755 * Called on timeouts and events. Timeouts should pass the elapsed
756 * time, interrupts should pass in zero. Must be called with
757 * si_lock held and interrupts disabled.
759 static enum si_sm_result smi_event_handler(struct smi_info *smi_info,
762 enum si_sm_result si_sm_result;
766 * There used to be a loop here that waited a little while
767 * (around 25us) before giving up. That turned out to be
768 * pointless, the minimum delays I was seeing were in the 300us
769 * range, which is far too long to wait in an interrupt. So
770 * we just run until the state machine tells us something
771 * happened or it needs a delay.
773 si_sm_result = smi_info->handlers->event(smi_info->si_sm, time);
775 while (si_sm_result == SI_SM_CALL_WITHOUT_DELAY)
776 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
778 if (si_sm_result == SI_SM_TRANSACTION_COMPLETE) {
779 smi_inc_stat(smi_info, complete_transactions);
781 handle_transaction_done(smi_info);
782 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
783 } else if (si_sm_result == SI_SM_HOSED) {
784 smi_inc_stat(smi_info, hosed_count);
787 * Do the before return_hosed_msg, because that
790 smi_info->si_state = SI_NORMAL;
791 if (smi_info->curr_msg != NULL) {
793 * If we were handling a user message, format
794 * a response to send to the upper layer to
795 * tell it about the error.
797 return_hosed_msg(smi_info, IPMI_ERR_UNSPECIFIED);
799 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
803 * We prefer handling attn over new messages. But don't do
804 * this if there is not yet an upper layer to handle anything.
806 if (likely(smi_info->intf) && si_sm_result == SI_SM_ATTN) {
807 unsigned char msg[2];
809 smi_inc_stat(smi_info, attentions);
812 * Got a attn, send down a get message flags to see
813 * what's causing it. It would be better to handle
814 * this in the upper layer, but due to the way
815 * interrupts work with the SMI, that's not really
818 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
819 msg[1] = IPMI_GET_MSG_FLAGS_CMD;
821 smi_info->handlers->start_transaction(
822 smi_info->si_sm, msg, 2);
823 smi_info->si_state = SI_GETTING_FLAGS;
827 /* If we are currently idle, try to start the next message. */
828 if (si_sm_result == SI_SM_IDLE) {
829 smi_inc_stat(smi_info, idles);
831 si_sm_result = start_next_msg(smi_info);
832 if (si_sm_result != SI_SM_IDLE)
836 if ((si_sm_result == SI_SM_IDLE)
837 && (atomic_read(&smi_info->req_events))) {
839 * We are idle and the upper layer requested that I fetch
842 atomic_set(&smi_info->req_events, 0);
844 smi_info->curr_msg = ipmi_alloc_smi_msg();
845 if (!smi_info->curr_msg)
848 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
849 smi_info->curr_msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
850 smi_info->curr_msg->data_size = 2;
852 smi_info->handlers->start_transaction(
854 smi_info->curr_msg->data,
855 smi_info->curr_msg->data_size);
856 smi_info->si_state = SI_GETTING_EVENTS;
863 static void sender(void *send_info,
864 struct ipmi_smi_msg *msg,
867 struct smi_info *smi_info = send_info;
868 enum si_sm_result result;
874 if (atomic_read(&smi_info->stop_operation)) {
875 msg->rsp[0] = msg->data[0] | 4;
876 msg->rsp[1] = msg->data[1];
877 msg->rsp[2] = IPMI_ERR_UNSPECIFIED;
879 deliver_recv_msg(smi_info, msg);
885 printk("**Enqueue: %d.%9.9d\n", t.tv_sec, t.tv_usec);
888 if (smi_info->run_to_completion) {
890 * If we are running to completion, then throw it in
891 * the list and run transactions until everything is
892 * clear. Priority doesn't matter here.
896 * Run to completion means we are single-threaded, no
899 list_add_tail(&(msg->link), &(smi_info->xmit_msgs));
901 result = smi_event_handler(smi_info, 0);
902 while (result != SI_SM_IDLE) {
903 udelay(SI_SHORT_TIMEOUT_USEC);
904 result = smi_event_handler(smi_info,
905 SI_SHORT_TIMEOUT_USEC);
910 spin_lock_irqsave(&smi_info->msg_lock, flags);
912 list_add_tail(&msg->link, &smi_info->hp_xmit_msgs);
914 list_add_tail(&msg->link, &smi_info->xmit_msgs);
915 spin_unlock_irqrestore(&smi_info->msg_lock, flags);
917 spin_lock_irqsave(&smi_info->si_lock, flags);
918 if (smi_info->si_state == SI_NORMAL && smi_info->curr_msg == NULL)
919 start_next_msg(smi_info);
920 spin_unlock_irqrestore(&smi_info->si_lock, flags);
923 static void set_run_to_completion(void *send_info, int i_run_to_completion)
925 struct smi_info *smi_info = send_info;
926 enum si_sm_result result;
928 smi_info->run_to_completion = i_run_to_completion;
929 if (i_run_to_completion) {
930 result = smi_event_handler(smi_info, 0);
931 while (result != SI_SM_IDLE) {
932 udelay(SI_SHORT_TIMEOUT_USEC);
933 result = smi_event_handler(smi_info,
934 SI_SHORT_TIMEOUT_USEC);
940 * Use -1 in the nsec value of the busy waiting timespec to tell that
941 * we are spinning in kipmid looking for something and not delaying
944 static inline void ipmi_si_set_not_busy(struct timespec *ts)
948 static inline int ipmi_si_is_busy(struct timespec *ts)
950 return ts->tv_nsec != -1;
953 static int ipmi_thread_busy_wait(enum si_sm_result smi_result,
954 const struct smi_info *smi_info,
955 struct timespec *busy_until)
957 unsigned int max_busy_us = 0;
959 if (smi_info->intf_num < num_max_busy_us)
960 max_busy_us = kipmid_max_busy_us[smi_info->intf_num];
961 if (max_busy_us == 0 || smi_result != SI_SM_CALL_WITH_DELAY)
962 ipmi_si_set_not_busy(busy_until);
963 else if (!ipmi_si_is_busy(busy_until)) {
964 getnstimeofday(busy_until);
965 timespec_add_ns(busy_until, max_busy_us*NSEC_PER_USEC);
968 getnstimeofday(&now);
969 if (unlikely(timespec_compare(&now, busy_until) > 0)) {
970 ipmi_si_set_not_busy(busy_until);
979 * A busy-waiting loop for speeding up IPMI operation.
981 * Lousy hardware makes this hard. This is only enabled for systems
982 * that are not BT and do not have interrupts. It starts spinning
983 * when an operation is complete or until max_busy tells it to stop
984 * (if that is enabled). See the paragraph on kimid_max_busy_us in
985 * Documentation/IPMI.txt for details.
987 static int ipmi_thread(void *data)
989 struct smi_info *smi_info = data;
991 enum si_sm_result smi_result;
992 struct timespec busy_until;
994 ipmi_si_set_not_busy(&busy_until);
995 set_user_nice(current, 19);
996 while (!kthread_should_stop()) {
999 spin_lock_irqsave(&(smi_info->si_lock), flags);
1000 smi_result = smi_event_handler(smi_info, 0);
1001 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1002 busy_wait = ipmi_thread_busy_wait(smi_result, smi_info,
1004 if (smi_result == SI_SM_CALL_WITHOUT_DELAY)
1006 else if (smi_result == SI_SM_CALL_WITH_DELAY && busy_wait)
1009 schedule_timeout_interruptible(0);
1015 static void poll(void *send_info)
1017 struct smi_info *smi_info = send_info;
1018 unsigned long flags;
1021 * Make sure there is some delay in the poll loop so we can
1022 * drive time forward and timeout things.
1025 spin_lock_irqsave(&smi_info->si_lock, flags);
1026 smi_event_handler(smi_info, 10);
1027 spin_unlock_irqrestore(&smi_info->si_lock, flags);
1030 static void request_events(void *send_info)
1032 struct smi_info *smi_info = send_info;
1034 if (atomic_read(&smi_info->stop_operation) ||
1035 !smi_info->has_event_buffer)
1038 atomic_set(&smi_info->req_events, 1);
1041 static int initialized;
1043 static void smi_timeout(unsigned long data)
1045 struct smi_info *smi_info = (struct smi_info *) data;
1046 enum si_sm_result smi_result;
1047 unsigned long flags;
1048 unsigned long jiffies_now;
1054 spin_lock_irqsave(&(smi_info->si_lock), flags);
1056 do_gettimeofday(&t);
1057 printk(KERN_DEBUG "**Timer: %d.%9.9d\n", t.tv_sec, t.tv_usec);
1059 jiffies_now = jiffies;
1060 time_diff = (((long)jiffies_now - (long)smi_info->last_timeout_jiffies)
1061 * SI_USEC_PER_JIFFY);
1062 smi_result = smi_event_handler(smi_info, time_diff);
1064 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1066 smi_info->last_timeout_jiffies = jiffies_now;
1068 if ((smi_info->irq) && (!smi_info->interrupt_disabled)) {
1069 /* Running with interrupts, only do long timeouts. */
1070 smi_info->si_timer.expires = jiffies + SI_TIMEOUT_JIFFIES;
1071 smi_inc_stat(smi_info, long_timeouts);
1076 * If the state machine asks for a short delay, then shorten
1077 * the timer timeout.
1079 if (smi_result == SI_SM_CALL_WITH_DELAY) {
1080 smi_inc_stat(smi_info, short_timeouts);
1081 smi_info->si_timer.expires = jiffies + 1;
1083 smi_inc_stat(smi_info, long_timeouts);
1084 smi_info->si_timer.expires = jiffies + SI_TIMEOUT_JIFFIES;
1088 add_timer(&(smi_info->si_timer));
1091 static irqreturn_t si_irq_handler(int irq, void *data)
1093 struct smi_info *smi_info = data;
1094 unsigned long flags;
1099 spin_lock_irqsave(&(smi_info->si_lock), flags);
1101 smi_inc_stat(smi_info, interrupts);
1104 do_gettimeofday(&t);
1105 printk(KERN_DEBUG "**Interrupt: %d.%9.9d\n", t.tv_sec, t.tv_usec);
1107 smi_event_handler(smi_info, 0);
1108 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1112 static irqreturn_t si_bt_irq_handler(int irq, void *data)
1114 struct smi_info *smi_info = data;
1115 /* We need to clear the IRQ flag for the BT interface. */
1116 smi_info->io.outputb(&smi_info->io, IPMI_BT_INTMASK_REG,
1117 IPMI_BT_INTMASK_CLEAR_IRQ_BIT
1118 | IPMI_BT_INTMASK_ENABLE_IRQ_BIT);
1119 return si_irq_handler(irq, data);
1122 static int smi_start_processing(void *send_info,
1125 struct smi_info *new_smi = send_info;
1128 new_smi->intf = intf;
1130 /* Try to claim any interrupts. */
1131 if (new_smi->irq_setup)
1132 new_smi->irq_setup(new_smi);
1134 /* Set up the timer that drives the interface. */
1135 setup_timer(&new_smi->si_timer, smi_timeout, (long)new_smi);
1136 new_smi->last_timeout_jiffies = jiffies;
1137 mod_timer(&new_smi->si_timer, jiffies + SI_TIMEOUT_JIFFIES);
1140 * Check if the user forcefully enabled the daemon.
1142 if (new_smi->intf_num < num_force_kipmid)
1143 enable = force_kipmid[new_smi->intf_num];
1145 * The BT interface is efficient enough to not need a thread,
1146 * and there is no need for a thread if we have interrupts.
1148 else if ((new_smi->si_type != SI_BT) && (!new_smi->irq))
1152 new_smi->thread = kthread_run(ipmi_thread, new_smi,
1153 "kipmi%d", new_smi->intf_num);
1154 if (IS_ERR(new_smi->thread)) {
1155 printk(KERN_NOTICE "ipmi_si_intf: Could not start"
1156 " kernel thread due to error %ld, only using"
1157 " timers to drive the interface\n",
1158 PTR_ERR(new_smi->thread));
1159 new_smi->thread = NULL;
1166 static void set_maintenance_mode(void *send_info, int enable)
1168 struct smi_info *smi_info = send_info;
1171 atomic_set(&smi_info->req_events, 0);
1174 static struct ipmi_smi_handlers handlers = {
1175 .owner = THIS_MODULE,
1176 .start_processing = smi_start_processing,
1178 .request_events = request_events,
1179 .set_maintenance_mode = set_maintenance_mode,
1180 .set_run_to_completion = set_run_to_completion,
1185 * There can be 4 IO ports passed in (with or without IRQs), 4 addresses,
1186 * a default IO port, and 1 ACPI/SPMI address. That sets SI_MAX_DRIVERS.
1189 static LIST_HEAD(smi_infos);
1190 static DEFINE_MUTEX(smi_infos_lock);
1191 static int smi_num; /* Used to sequence the SMIs */
1193 #define DEFAULT_REGSPACING 1
1194 #define DEFAULT_REGSIZE 1
1196 static int si_trydefaults = 1;
1197 static char *si_type[SI_MAX_PARMS];
1198 #define MAX_SI_TYPE_STR 30
1199 static char si_type_str[MAX_SI_TYPE_STR];
1200 static unsigned long addrs[SI_MAX_PARMS];
1201 static unsigned int num_addrs;
1202 static unsigned int ports[SI_MAX_PARMS];
1203 static unsigned int num_ports;
1204 static int irqs[SI_MAX_PARMS];
1205 static unsigned int num_irqs;
1206 static int regspacings[SI_MAX_PARMS];
1207 static unsigned int num_regspacings;
1208 static int regsizes[SI_MAX_PARMS];
1209 static unsigned int num_regsizes;
1210 static int regshifts[SI_MAX_PARMS];
1211 static unsigned int num_regshifts;
1212 static int slave_addrs[SI_MAX_PARMS]; /* Leaving 0 chooses the default value */
1213 static unsigned int num_slave_addrs;
1215 #define IPMI_IO_ADDR_SPACE 0
1216 #define IPMI_MEM_ADDR_SPACE 1
1217 static char *addr_space_to_str[] = { "i/o", "mem" };
1219 static int hotmod_handler(const char *val, struct kernel_param *kp);
1221 module_param_call(hotmod, hotmod_handler, NULL, NULL, 0200);
1222 MODULE_PARM_DESC(hotmod, "Add and remove interfaces. See"
1223 " Documentation/IPMI.txt in the kernel sources for the"
1226 module_param_named(trydefaults, si_trydefaults, bool, 0);
1227 MODULE_PARM_DESC(trydefaults, "Setting this to 'false' will disable the"
1228 " default scan of the KCS and SMIC interface at the standard"
1230 module_param_string(type, si_type_str, MAX_SI_TYPE_STR, 0);
1231 MODULE_PARM_DESC(type, "Defines the type of each interface, each"
1232 " interface separated by commas. The types are 'kcs',"
1233 " 'smic', and 'bt'. For example si_type=kcs,bt will set"
1234 " the first interface to kcs and the second to bt");
1235 module_param_array(addrs, ulong, &num_addrs, 0);
1236 MODULE_PARM_DESC(addrs, "Sets the memory address of each interface, the"
1237 " addresses separated by commas. Only use if an interface"
1238 " is in memory. Otherwise, set it to zero or leave"
1240 module_param_array(ports, uint, &num_ports, 0);
1241 MODULE_PARM_DESC(ports, "Sets the port address of each interface, the"
1242 " addresses separated by commas. Only use if an interface"
1243 " is a port. Otherwise, set it to zero or leave"
1245 module_param_array(irqs, int, &num_irqs, 0);
1246 MODULE_PARM_DESC(irqs, "Sets the interrupt of each interface, the"
1247 " addresses separated by commas. Only use if an interface"
1248 " has an interrupt. Otherwise, set it to zero or leave"
1250 module_param_array(regspacings, int, &num_regspacings, 0);
1251 MODULE_PARM_DESC(regspacings, "The number of bytes between the start address"
1252 " and each successive register used by the interface. For"
1253 " instance, if the start address is 0xca2 and the spacing"
1254 " is 2, then the second address is at 0xca4. Defaults"
1256 module_param_array(regsizes, int, &num_regsizes, 0);
1257 MODULE_PARM_DESC(regsizes, "The size of the specific IPMI register in bytes."
1258 " This should generally be 1, 2, 4, or 8 for an 8-bit,"
1259 " 16-bit, 32-bit, or 64-bit register. Use this if you"
1260 " the 8-bit IPMI register has to be read from a larger"
1262 module_param_array(regshifts, int, &num_regshifts, 0);
1263 MODULE_PARM_DESC(regshifts, "The amount to shift the data read from the."
1264 " IPMI register, in bits. For instance, if the data"
1265 " is read from a 32-bit word and the IPMI data is in"
1266 " bit 8-15, then the shift would be 8");
1267 module_param_array(slave_addrs, int, &num_slave_addrs, 0);
1268 MODULE_PARM_DESC(slave_addrs, "Set the default IPMB slave address for"
1269 " the controller. Normally this is 0x20, but can be"
1270 " overridden by this parm. This is an array indexed"
1271 " by interface number.");
1272 module_param_array(force_kipmid, int, &num_force_kipmid, 0);
1273 MODULE_PARM_DESC(force_kipmid, "Force the kipmi daemon to be enabled (1) or"
1274 " disabled(0). Normally the IPMI driver auto-detects"
1275 " this, but the value may be overridden by this parm.");
1276 module_param(unload_when_empty, int, 0);
1277 MODULE_PARM_DESC(unload_when_empty, "Unload the module if no interfaces are"
1278 " specified or found, default is 1. Setting to 0"
1279 " is useful for hot add of devices using hotmod.");
1280 module_param_array(kipmid_max_busy_us, uint, &num_max_busy_us, 0644);
1281 MODULE_PARM_DESC(kipmid_max_busy_us,
1282 "Max time (in microseconds) to busy-wait for IPMI data before"
1283 " sleeping. 0 (default) means to wait forever. Set to 100-500"
1284 " if kipmid is using up a lot of CPU time.");
1287 static void std_irq_cleanup(struct smi_info *info)
1289 if (info->si_type == SI_BT)
1290 /* Disable the interrupt in the BT interface. */
1291 info->io.outputb(&info->io, IPMI_BT_INTMASK_REG, 0);
1292 free_irq(info->irq, info);
1295 static int std_irq_setup(struct smi_info *info)
1302 if (info->si_type == SI_BT) {
1303 rv = request_irq(info->irq,
1305 IRQF_SHARED | IRQF_DISABLED,
1309 /* Enable the interrupt in the BT interface. */
1310 info->io.outputb(&info->io, IPMI_BT_INTMASK_REG,
1311 IPMI_BT_INTMASK_ENABLE_IRQ_BIT);
1313 rv = request_irq(info->irq,
1315 IRQF_SHARED | IRQF_DISABLED,
1320 "ipmi_si: %s unable to claim interrupt %d,"
1321 " running polled\n",
1322 DEVICE_NAME, info->irq);
1325 info->irq_cleanup = std_irq_cleanup;
1326 printk(" Using irq %d\n", info->irq);
1332 static unsigned char port_inb(struct si_sm_io *io, unsigned int offset)
1334 unsigned int addr = io->addr_data;
1336 return inb(addr + (offset * io->regspacing));
1339 static void port_outb(struct si_sm_io *io, unsigned int offset,
1342 unsigned int addr = io->addr_data;
1344 outb(b, addr + (offset * io->regspacing));
1347 static unsigned char port_inw(struct si_sm_io *io, unsigned int offset)
1349 unsigned int addr = io->addr_data;
1351 return (inw(addr + (offset * io->regspacing)) >> io->regshift) & 0xff;
1354 static void port_outw(struct si_sm_io *io, unsigned int offset,
1357 unsigned int addr = io->addr_data;
1359 outw(b << io->regshift, addr + (offset * io->regspacing));
1362 static unsigned char port_inl(struct si_sm_io *io, unsigned int offset)
1364 unsigned int addr = io->addr_data;
1366 return (inl(addr + (offset * io->regspacing)) >> io->regshift) & 0xff;
1369 static void port_outl(struct si_sm_io *io, unsigned int offset,
1372 unsigned int addr = io->addr_data;
1374 outl(b << io->regshift, addr+(offset * io->regspacing));
1377 static void port_cleanup(struct smi_info *info)
1379 unsigned int addr = info->io.addr_data;
1383 for (idx = 0; idx < info->io_size; idx++)
1384 release_region(addr + idx * info->io.regspacing,
1389 static int port_setup(struct smi_info *info)
1391 unsigned int addr = info->io.addr_data;
1397 info->io_cleanup = port_cleanup;
1400 * Figure out the actual inb/inw/inl/etc routine to use based
1401 * upon the register size.
1403 switch (info->io.regsize) {
1405 info->io.inputb = port_inb;
1406 info->io.outputb = port_outb;
1409 info->io.inputb = port_inw;
1410 info->io.outputb = port_outw;
1413 info->io.inputb = port_inl;
1414 info->io.outputb = port_outl;
1417 printk(KERN_WARNING "ipmi_si: Invalid register size: %d\n",
1423 * Some BIOSes reserve disjoint I/O regions in their ACPI
1424 * tables. This causes problems when trying to register the
1425 * entire I/O region. Therefore we must register each I/O
1428 for (idx = 0; idx < info->io_size; idx++) {
1429 if (request_region(addr + idx * info->io.regspacing,
1430 info->io.regsize, DEVICE_NAME) == NULL) {
1431 /* Undo allocations */
1433 release_region(addr + idx * info->io.regspacing,
1442 static unsigned char intf_mem_inb(struct si_sm_io *io, unsigned int offset)
1444 return readb((io->addr)+(offset * io->regspacing));
1447 static void intf_mem_outb(struct si_sm_io *io, unsigned int offset,
1450 writeb(b, (io->addr)+(offset * io->regspacing));
1453 static unsigned char intf_mem_inw(struct si_sm_io *io, unsigned int offset)
1455 return (readw((io->addr)+(offset * io->regspacing)) >> io->regshift)
1459 static void intf_mem_outw(struct si_sm_io *io, unsigned int offset,
1462 writeb(b << io->regshift, (io->addr)+(offset * io->regspacing));
1465 static unsigned char intf_mem_inl(struct si_sm_io *io, unsigned int offset)
1467 return (readl((io->addr)+(offset * io->regspacing)) >> io->regshift)
1471 static void intf_mem_outl(struct si_sm_io *io, unsigned int offset,
1474 writel(b << io->regshift, (io->addr)+(offset * io->regspacing));
1478 static unsigned char mem_inq(struct si_sm_io *io, unsigned int offset)
1480 return (readq((io->addr)+(offset * io->regspacing)) >> io->regshift)
1484 static void mem_outq(struct si_sm_io *io, unsigned int offset,
1487 writeq(b << io->regshift, (io->addr)+(offset * io->regspacing));
1491 static void mem_cleanup(struct smi_info *info)
1493 unsigned long addr = info->io.addr_data;
1496 if (info->io.addr) {
1497 iounmap(info->io.addr);
1499 mapsize = ((info->io_size * info->io.regspacing)
1500 - (info->io.regspacing - info->io.regsize));
1502 release_mem_region(addr, mapsize);
1506 static int mem_setup(struct smi_info *info)
1508 unsigned long addr = info->io.addr_data;
1514 info->io_cleanup = mem_cleanup;
1517 * Figure out the actual readb/readw/readl/etc routine to use based
1518 * upon the register size.
1520 switch (info->io.regsize) {
1522 info->io.inputb = intf_mem_inb;
1523 info->io.outputb = intf_mem_outb;
1526 info->io.inputb = intf_mem_inw;
1527 info->io.outputb = intf_mem_outw;
1530 info->io.inputb = intf_mem_inl;
1531 info->io.outputb = intf_mem_outl;
1535 info->io.inputb = mem_inq;
1536 info->io.outputb = mem_outq;
1540 printk(KERN_WARNING "ipmi_si: Invalid register size: %d\n",
1546 * Calculate the total amount of memory to claim. This is an
1547 * unusual looking calculation, but it avoids claiming any
1548 * more memory than it has to. It will claim everything
1549 * between the first address to the end of the last full
1552 mapsize = ((info->io_size * info->io.regspacing)
1553 - (info->io.regspacing - info->io.regsize));
1555 if (request_mem_region(addr, mapsize, DEVICE_NAME) == NULL)
1558 info->io.addr = ioremap(addr, mapsize);
1559 if (info->io.addr == NULL) {
1560 release_mem_region(addr, mapsize);
1567 * Parms come in as <op1>[:op2[:op3...]]. ops are:
1568 * add|remove,kcs|bt|smic,mem|i/o,<address>[,<opt1>[,<opt2>[,...]]]
1576 enum hotmod_op { HM_ADD, HM_REMOVE };
1577 struct hotmod_vals {
1581 static struct hotmod_vals hotmod_ops[] = {
1583 { "remove", HM_REMOVE },
1586 static struct hotmod_vals hotmod_si[] = {
1588 { "smic", SI_SMIC },
1592 static struct hotmod_vals hotmod_as[] = {
1593 { "mem", IPMI_MEM_ADDR_SPACE },
1594 { "i/o", IPMI_IO_ADDR_SPACE },
1598 static int parse_str(struct hotmod_vals *v, int *val, char *name, char **curr)
1603 s = strchr(*curr, ',');
1605 printk(KERN_WARNING PFX "No hotmod %s given.\n", name);
1610 for (i = 0; hotmod_ops[i].name; i++) {
1611 if (strcmp(*curr, v[i].name) == 0) {
1618 printk(KERN_WARNING PFX "Invalid hotmod %s '%s'\n", name, *curr);
1622 static int check_hotmod_int_op(const char *curr, const char *option,
1623 const char *name, int *val)
1627 if (strcmp(curr, name) == 0) {
1629 printk(KERN_WARNING PFX
1630 "No option given for '%s'\n",
1634 *val = simple_strtoul(option, &n, 0);
1635 if ((*n != '\0') || (*option == '\0')) {
1636 printk(KERN_WARNING PFX
1637 "Bad option given for '%s'\n",
1646 static int hotmod_handler(const char *val, struct kernel_param *kp)
1648 char *str = kstrdup(val, GFP_KERNEL);
1650 char *next, *curr, *s, *n, *o;
1652 enum si_type si_type;
1662 struct smi_info *info;
1667 /* Kill any trailing spaces, as we can get a "\n" from echo. */
1670 while ((ival >= 0) && isspace(str[ival])) {
1675 for (curr = str; curr; curr = next) {
1680 ipmb = 0; /* Choose the default if not specified */
1682 next = strchr(curr, ':');
1688 rv = parse_str(hotmod_ops, &ival, "operation", &curr);
1693 rv = parse_str(hotmod_si, &ival, "interface type", &curr);
1698 rv = parse_str(hotmod_as, &addr_space, "address space", &curr);
1702 s = strchr(curr, ',');
1707 addr = simple_strtoul(curr, &n, 0);
1708 if ((*n != '\0') || (*curr == '\0')) {
1709 printk(KERN_WARNING PFX "Invalid hotmod address"
1716 s = strchr(curr, ',');
1721 o = strchr(curr, '=');
1726 rv = check_hotmod_int_op(curr, o, "rsp", ®spacing);
1731 rv = check_hotmod_int_op(curr, o, "rsi", ®size);
1736 rv = check_hotmod_int_op(curr, o, "rsh", ®shift);
1741 rv = check_hotmod_int_op(curr, o, "irq", &irq);
1746 rv = check_hotmod_int_op(curr, o, "ipmb", &ipmb);
1753 printk(KERN_WARNING PFX
1754 "Invalid hotmod option '%s'\n",
1760 info = kzalloc(sizeof(*info), GFP_KERNEL);
1766 info->addr_source = SI_HOTMOD;
1767 info->si_type = si_type;
1768 info->io.addr_data = addr;
1769 info->io.addr_type = addr_space;
1770 if (addr_space == IPMI_MEM_ADDR_SPACE)
1771 info->io_setup = mem_setup;
1773 info->io_setup = port_setup;
1775 info->io.addr = NULL;
1776 info->io.regspacing = regspacing;
1777 if (!info->io.regspacing)
1778 info->io.regspacing = DEFAULT_REGSPACING;
1779 info->io.regsize = regsize;
1780 if (!info->io.regsize)
1781 info->io.regsize = DEFAULT_REGSPACING;
1782 info->io.regshift = regshift;
1785 info->irq_setup = std_irq_setup;
1786 info->slave_addr = ipmb;
1791 struct smi_info *e, *tmp_e;
1793 mutex_lock(&smi_infos_lock);
1794 list_for_each_entry_safe(e, tmp_e, &smi_infos, link) {
1795 if (e->io.addr_type != addr_space)
1797 if (e->si_type != si_type)
1799 if (e->io.addr_data == addr)
1802 mutex_unlock(&smi_infos_lock);
1811 static __devinit void hardcode_find_bmc(void)
1814 struct smi_info *info;
1816 for (i = 0; i < SI_MAX_PARMS; i++) {
1817 if (!ports[i] && !addrs[i])
1820 info = kzalloc(sizeof(*info), GFP_KERNEL);
1824 info->addr_source = SI_HARDCODED;
1826 if (!si_type[i] || strcmp(si_type[i], "kcs") == 0) {
1827 info->si_type = SI_KCS;
1828 } else if (strcmp(si_type[i], "smic") == 0) {
1829 info->si_type = SI_SMIC;
1830 } else if (strcmp(si_type[i], "bt") == 0) {
1831 info->si_type = SI_BT;
1834 "ipmi_si: Interface type specified "
1835 "for interface %d, was invalid: %s\n",
1843 info->io_setup = port_setup;
1844 info->io.addr_data = ports[i];
1845 info->io.addr_type = IPMI_IO_ADDR_SPACE;
1846 } else if (addrs[i]) {
1848 info->io_setup = mem_setup;
1849 info->io.addr_data = addrs[i];
1850 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
1853 "ipmi_si: Interface type specified "
1854 "for interface %d, "
1855 "but port and address were not set or "
1856 "set to zero.\n", i);
1861 info->io.addr = NULL;
1862 info->io.regspacing = regspacings[i];
1863 if (!info->io.regspacing)
1864 info->io.regspacing = DEFAULT_REGSPACING;
1865 info->io.regsize = regsizes[i];
1866 if (!info->io.regsize)
1867 info->io.regsize = DEFAULT_REGSPACING;
1868 info->io.regshift = regshifts[i];
1869 info->irq = irqs[i];
1871 info->irq_setup = std_irq_setup;
1872 info->slave_addr = slave_addrs[i];
1880 #include <linux/acpi.h>
1883 * Once we get an ACPI failure, we don't try any more, because we go
1884 * through the tables sequentially. Once we don't find a table, there
1887 static int acpi_failure;
1889 /* For GPE-type interrupts. */
1890 static u32 ipmi_acpi_gpe(void *context)
1892 struct smi_info *smi_info = context;
1893 unsigned long flags;
1898 spin_lock_irqsave(&(smi_info->si_lock), flags);
1900 smi_inc_stat(smi_info, interrupts);
1903 do_gettimeofday(&t);
1904 printk("**ACPI_GPE: %d.%9.9d\n", t.tv_sec, t.tv_usec);
1906 smi_event_handler(smi_info, 0);
1907 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1909 return ACPI_INTERRUPT_HANDLED;
1912 static void acpi_gpe_irq_cleanup(struct smi_info *info)
1917 acpi_remove_gpe_handler(NULL, info->irq, &ipmi_acpi_gpe);
1920 static int acpi_gpe_irq_setup(struct smi_info *info)
1927 /* FIXME - is level triggered right? */
1928 status = acpi_install_gpe_handler(NULL,
1930 ACPI_GPE_LEVEL_TRIGGERED,
1933 if (status != AE_OK) {
1935 "ipmi_si: %s unable to claim ACPI GPE %d,"
1936 " running polled\n",
1937 DEVICE_NAME, info->irq);
1941 info->irq_cleanup = acpi_gpe_irq_cleanup;
1942 printk(" Using ACPI GPE %d\n", info->irq);
1949 * http://h21007.www2.hp.com/dspp/files/unprotected/devresource/
1950 * Docs/TechPapers/IA64/hpspmi.pdf
1961 s8 CreatorRevision[4];
1964 s16 SpecificationRevision;
1967 * Bit 0 - SCI interrupt supported
1968 * Bit 1 - I/O APIC/SAPIC
1973 * If bit 0 of InterruptType is set, then this is the SCI
1974 * interrupt in the GPEx_STS register.
1981 * If bit 1 of InterruptType is set, then this is the I/O
1982 * APIC/SAPIC interrupt.
1984 u32 GlobalSystemInterrupt;
1986 /* The actual register address. */
1987 struct acpi_generic_address addr;
1991 s8 spmi_id[1]; /* A '\0' terminated array starts here. */
1994 static __devinit int try_init_spmi(struct SPMITable *spmi)
1996 struct smi_info *info;
1999 if (spmi->IPMIlegacy != 1) {
2000 printk(KERN_INFO "IPMI: Bad SPMI legacy %d\n", spmi->IPMIlegacy);
2004 if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY)
2005 addr_space = IPMI_MEM_ADDR_SPACE;
2007 addr_space = IPMI_IO_ADDR_SPACE;
2009 info = kzalloc(sizeof(*info), GFP_KERNEL);
2011 printk(KERN_ERR "ipmi_si: Could not allocate SI data (3)\n");
2015 info->addr_source = SI_SPMI;
2017 /* Figure out the interface type. */
2018 switch (spmi->InterfaceType) {
2020 info->si_type = SI_KCS;
2023 info->si_type = SI_SMIC;
2026 info->si_type = SI_BT;
2029 printk(KERN_INFO "ipmi_si: Unknown ACPI/SPMI SI type %d\n",
2030 spmi->InterfaceType);
2035 if (spmi->InterruptType & 1) {
2036 /* We've got a GPE interrupt. */
2037 info->irq = spmi->GPE;
2038 info->irq_setup = acpi_gpe_irq_setup;
2039 } else if (spmi->InterruptType & 2) {
2040 /* We've got an APIC/SAPIC interrupt. */
2041 info->irq = spmi->GlobalSystemInterrupt;
2042 info->irq_setup = std_irq_setup;
2044 /* Use the default interrupt setting. */
2046 info->irq_setup = NULL;
2049 if (spmi->addr.bit_width) {
2050 /* A (hopefully) properly formed register bit width. */
2051 info->io.regspacing = spmi->addr.bit_width / 8;
2053 info->io.regspacing = DEFAULT_REGSPACING;
2055 info->io.regsize = info->io.regspacing;
2056 info->io.regshift = spmi->addr.bit_offset;
2058 if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
2059 info->io_setup = mem_setup;
2060 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2061 } else if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
2062 info->io_setup = port_setup;
2063 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2067 "ipmi_si: Unknown ACPI I/O Address type\n");
2070 info->io.addr_data = spmi->addr.address;
2077 static __devinit void spmi_find_bmc(void)
2080 struct SPMITable *spmi;
2089 for (i = 0; ; i++) {
2090 status = acpi_get_table(ACPI_SIG_SPMI, i+1,
2091 (struct acpi_table_header **)&spmi);
2092 if (status != AE_OK)
2095 try_init_spmi(spmi);
2099 static int __devinit ipmi_pnp_probe(struct pnp_dev *dev,
2100 const struct pnp_device_id *dev_id)
2102 struct acpi_device *acpi_dev;
2103 struct smi_info *info;
2106 unsigned long long tmp;
2108 acpi_dev = pnp_acpi_device(dev);
2112 info = kzalloc(sizeof(*info), GFP_KERNEL);
2116 info->addr_source = SI_ACPI;
2118 handle = acpi_dev->handle;
2120 /* _IFT tells us the interface type: KCS, BT, etc */
2121 status = acpi_evaluate_integer(handle, "_IFT", NULL, &tmp);
2122 if (ACPI_FAILURE(status))
2127 info->si_type = SI_KCS;
2130 info->si_type = SI_SMIC;
2133 info->si_type = SI_BT;
2136 dev_info(&dev->dev, "unknown interface type %lld\n", tmp);
2140 if (pnp_port_valid(dev, 0)) {
2141 info->io_setup = port_setup;
2142 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2143 info->io.addr_data = pnp_port_start(dev, 0);
2144 } else if (pnp_mem_valid(dev, 0)) {
2145 info->io_setup = mem_setup;
2146 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2147 info->io.addr_data = pnp_mem_start(dev, 0);
2149 dev_err(&dev->dev, "no I/O or memory address\n");
2153 info->io.regspacing = DEFAULT_REGSPACING;
2154 info->io.regsize = DEFAULT_REGSPACING;
2155 info->io.regshift = 0;
2157 /* If _GPE exists, use it; otherwise use standard interrupts */
2158 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
2159 if (ACPI_SUCCESS(status)) {
2161 info->irq_setup = acpi_gpe_irq_setup;
2162 } else if (pnp_irq_valid(dev, 0)) {
2163 info->irq = pnp_irq(dev, 0);
2164 info->irq_setup = std_irq_setup;
2167 info->dev = &acpi_dev->dev;
2168 pnp_set_drvdata(dev, info);
2170 return try_smi_init(info);
2177 static void __devexit ipmi_pnp_remove(struct pnp_dev *dev)
2179 struct smi_info *info = pnp_get_drvdata(dev);
2181 cleanup_one_si(info);
2184 static const struct pnp_device_id pnp_dev_table[] = {
2189 static struct pnp_driver ipmi_pnp_driver = {
2190 .name = DEVICE_NAME,
2191 .probe = ipmi_pnp_probe,
2192 .remove = __devexit_p(ipmi_pnp_remove),
2193 .id_table = pnp_dev_table,
2198 struct dmi_ipmi_data {
2201 unsigned long base_addr;
2207 static int __devinit decode_dmi(const struct dmi_header *dm,
2208 struct dmi_ipmi_data *dmi)
2210 const u8 *data = (const u8 *)dm;
2211 unsigned long base_addr;
2213 u8 len = dm->length;
2215 dmi->type = data[4];
2217 memcpy(&base_addr, data+8, sizeof(unsigned long));
2219 if (base_addr & 1) {
2221 base_addr &= 0xFFFE;
2222 dmi->addr_space = IPMI_IO_ADDR_SPACE;
2225 dmi->addr_space = IPMI_MEM_ADDR_SPACE;
2227 /* If bit 4 of byte 0x10 is set, then the lsb for the address
2229 dmi->base_addr = base_addr | ((data[0x10] & 0x10) >> 4);
2231 dmi->irq = data[0x11];
2233 /* The top two bits of byte 0x10 hold the register spacing. */
2234 reg_spacing = (data[0x10] & 0xC0) >> 6;
2235 switch (reg_spacing) {
2236 case 0x00: /* Byte boundaries */
2239 case 0x01: /* 32-bit boundaries */
2242 case 0x02: /* 16-byte boundaries */
2246 /* Some other interface, just ignore it. */
2252 * Note that technically, the lower bit of the base
2253 * address should be 1 if the address is I/O and 0 if
2254 * the address is in memory. So many systems get that
2255 * wrong (and all that I have seen are I/O) so we just
2256 * ignore that bit and assume I/O. Systems that use
2257 * memory should use the newer spec, anyway.
2259 dmi->base_addr = base_addr & 0xfffe;
2260 dmi->addr_space = IPMI_IO_ADDR_SPACE;
2264 dmi->slave_addr = data[6];
2269 static __devinit void try_init_dmi(struct dmi_ipmi_data *ipmi_data)
2271 struct smi_info *info;
2273 info = kzalloc(sizeof(*info), GFP_KERNEL);
2276 "ipmi_si: Could not allocate SI data\n");
2280 info->addr_source = SI_SMBIOS;
2282 switch (ipmi_data->type) {
2283 case 0x01: /* KCS */
2284 info->si_type = SI_KCS;
2286 case 0x02: /* SMIC */
2287 info->si_type = SI_SMIC;
2290 info->si_type = SI_BT;
2297 switch (ipmi_data->addr_space) {
2298 case IPMI_MEM_ADDR_SPACE:
2299 info->io_setup = mem_setup;
2300 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2303 case IPMI_IO_ADDR_SPACE:
2304 info->io_setup = port_setup;
2305 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2311 "ipmi_si: Unknown SMBIOS I/O Address type: %d.\n",
2312 ipmi_data->addr_space);
2315 info->io.addr_data = ipmi_data->base_addr;
2317 info->io.regspacing = ipmi_data->offset;
2318 if (!info->io.regspacing)
2319 info->io.regspacing = DEFAULT_REGSPACING;
2320 info->io.regsize = DEFAULT_REGSPACING;
2321 info->io.regshift = 0;
2323 info->slave_addr = ipmi_data->slave_addr;
2325 info->irq = ipmi_data->irq;
2327 info->irq_setup = std_irq_setup;
2332 static void __devinit dmi_find_bmc(void)
2334 const struct dmi_device *dev = NULL;
2335 struct dmi_ipmi_data data;
2338 while ((dev = dmi_find_device(DMI_DEV_TYPE_IPMI, NULL, dev))) {
2339 memset(&data, 0, sizeof(data));
2340 rv = decode_dmi((const struct dmi_header *) dev->device_data,
2343 try_init_dmi(&data);
2346 #endif /* CONFIG_DMI */
2350 #define PCI_ERMC_CLASSCODE 0x0C0700
2351 #define PCI_ERMC_CLASSCODE_MASK 0xffffff00
2352 #define PCI_ERMC_CLASSCODE_TYPE_MASK 0xff
2353 #define PCI_ERMC_CLASSCODE_TYPE_SMIC 0x00
2354 #define PCI_ERMC_CLASSCODE_TYPE_KCS 0x01
2355 #define PCI_ERMC_CLASSCODE_TYPE_BT 0x02
2357 #define PCI_HP_VENDOR_ID 0x103C
2358 #define PCI_MMC_DEVICE_ID 0x121A
2359 #define PCI_MMC_ADDR_CW 0x10
2361 static void ipmi_pci_cleanup(struct smi_info *info)
2363 struct pci_dev *pdev = info->addr_source_data;
2365 pci_disable_device(pdev);
2368 static int __devinit ipmi_pci_probe(struct pci_dev *pdev,
2369 const struct pci_device_id *ent)
2372 int class_type = pdev->class & PCI_ERMC_CLASSCODE_TYPE_MASK;
2373 struct smi_info *info;
2375 info = kzalloc(sizeof(*info), GFP_KERNEL);
2379 info->addr_source = SI_PCI;
2381 switch (class_type) {
2382 case PCI_ERMC_CLASSCODE_TYPE_SMIC:
2383 info->si_type = SI_SMIC;
2386 case PCI_ERMC_CLASSCODE_TYPE_KCS:
2387 info->si_type = SI_KCS;
2390 case PCI_ERMC_CLASSCODE_TYPE_BT:
2391 info->si_type = SI_BT;
2396 printk(KERN_INFO "ipmi_si: %s: Unknown IPMI type: %d\n",
2397 pci_name(pdev), class_type);
2401 rv = pci_enable_device(pdev);
2403 printk(KERN_ERR "ipmi_si: %s: couldn't enable PCI device\n",
2409 info->addr_source_cleanup = ipmi_pci_cleanup;
2410 info->addr_source_data = pdev;
2412 if (pci_resource_flags(pdev, 0) & IORESOURCE_IO) {
2413 info->io_setup = port_setup;
2414 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2416 info->io_setup = mem_setup;
2417 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2419 info->io.addr_data = pci_resource_start(pdev, 0);
2421 info->io.regspacing = DEFAULT_REGSPACING;
2422 info->io.regsize = DEFAULT_REGSPACING;
2423 info->io.regshift = 0;
2425 info->irq = pdev->irq;
2427 info->irq_setup = std_irq_setup;
2429 info->dev = &pdev->dev;
2430 pci_set_drvdata(pdev, info);
2432 return try_smi_init(info);
2435 static void __devexit ipmi_pci_remove(struct pci_dev *pdev)
2437 struct smi_info *info = pci_get_drvdata(pdev);
2438 cleanup_one_si(info);
2442 static int ipmi_pci_suspend(struct pci_dev *pdev, pm_message_t state)
2447 static int ipmi_pci_resume(struct pci_dev *pdev)
2453 static struct pci_device_id ipmi_pci_devices[] = {
2454 { PCI_DEVICE(PCI_HP_VENDOR_ID, PCI_MMC_DEVICE_ID) },
2455 { PCI_DEVICE_CLASS(PCI_ERMC_CLASSCODE, PCI_ERMC_CLASSCODE_MASK) },
2458 MODULE_DEVICE_TABLE(pci, ipmi_pci_devices);
2460 static struct pci_driver ipmi_pci_driver = {
2461 .name = DEVICE_NAME,
2462 .id_table = ipmi_pci_devices,
2463 .probe = ipmi_pci_probe,
2464 .remove = __devexit_p(ipmi_pci_remove),
2466 .suspend = ipmi_pci_suspend,
2467 .resume = ipmi_pci_resume,
2470 #endif /* CONFIG_PCI */
2473 #ifdef CONFIG_PPC_OF
2474 static int __devinit ipmi_of_probe(struct of_device *dev,
2475 const struct of_device_id *match)
2477 struct smi_info *info;
2478 struct resource resource;
2479 const int *regsize, *regspacing, *regshift;
2480 struct device_node *np = dev->dev.of_node;
2484 dev_info(&dev->dev, PFX "probing via device tree\n");
2486 ret = of_address_to_resource(np, 0, &resource);
2488 dev_warn(&dev->dev, PFX "invalid address from OF\n");
2492 regsize = of_get_property(np, "reg-size", &proplen);
2493 if (regsize && proplen != 4) {
2494 dev_warn(&dev->dev, PFX "invalid regsize from OF\n");
2498 regspacing = of_get_property(np, "reg-spacing", &proplen);
2499 if (regspacing && proplen != 4) {
2500 dev_warn(&dev->dev, PFX "invalid regspacing from OF\n");
2504 regshift = of_get_property(np, "reg-shift", &proplen);
2505 if (regshift && proplen != 4) {
2506 dev_warn(&dev->dev, PFX "invalid regshift from OF\n");
2510 info = kzalloc(sizeof(*info), GFP_KERNEL);
2514 PFX "could not allocate memory for OF probe\n");
2518 info->si_type = (enum si_type) match->data;
2519 info->addr_source = SI_DEVICETREE;
2520 info->irq_setup = std_irq_setup;
2522 if (resource.flags & IORESOURCE_IO) {
2523 info->io_setup = port_setup;
2524 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2526 info->io_setup = mem_setup;
2527 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2530 info->io.addr_data = resource.start;
2532 info->io.regsize = regsize ? *regsize : DEFAULT_REGSIZE;
2533 info->io.regspacing = regspacing ? *regspacing : DEFAULT_REGSPACING;
2534 info->io.regshift = regshift ? *regshift : 0;
2536 info->irq = irq_of_parse_and_map(dev->dev.of_node, 0);
2537 info->dev = &dev->dev;
2539 dev_dbg(&dev->dev, "addr 0x%lx regsize %d spacing %d irq %x\n",
2540 info->io.addr_data, info->io.regsize, info->io.regspacing,
2543 dev_set_drvdata(&dev->dev, info);
2545 return try_smi_init(info);
2548 static int __devexit ipmi_of_remove(struct of_device *dev)
2550 cleanup_one_si(dev_get_drvdata(&dev->dev));
2554 static struct of_device_id ipmi_match[] =
2556 { .type = "ipmi", .compatible = "ipmi-kcs",
2557 .data = (void *)(unsigned long) SI_KCS },
2558 { .type = "ipmi", .compatible = "ipmi-smic",
2559 .data = (void *)(unsigned long) SI_SMIC },
2560 { .type = "ipmi", .compatible = "ipmi-bt",
2561 .data = (void *)(unsigned long) SI_BT },
2565 static struct of_platform_driver ipmi_of_platform_driver = {
2568 .owner = THIS_MODULE,
2569 .of_match_table = ipmi_match,
2571 .probe = ipmi_of_probe,
2572 .remove = __devexit_p(ipmi_of_remove),
2574 #endif /* CONFIG_PPC_OF */
2576 static int wait_for_msg_done(struct smi_info *smi_info)
2578 enum si_sm_result smi_result;
2580 smi_result = smi_info->handlers->event(smi_info->si_sm, 0);
2582 if (smi_result == SI_SM_CALL_WITH_DELAY ||
2583 smi_result == SI_SM_CALL_WITH_TICK_DELAY) {
2584 schedule_timeout_uninterruptible(1);
2585 smi_result = smi_info->handlers->event(
2586 smi_info->si_sm, 100);
2587 } else if (smi_result == SI_SM_CALL_WITHOUT_DELAY) {
2588 smi_result = smi_info->handlers->event(
2589 smi_info->si_sm, 0);
2593 if (smi_result == SI_SM_HOSED)
2595 * We couldn't get the state machine to run, so whatever's at
2596 * the port is probably not an IPMI SMI interface.
2603 static int try_get_dev_id(struct smi_info *smi_info)
2605 unsigned char msg[2];
2606 unsigned char *resp;
2607 unsigned long resp_len;
2610 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
2615 * Do a Get Device ID command, since it comes back with some
2618 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2619 msg[1] = IPMI_GET_DEVICE_ID_CMD;
2620 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
2622 rv = wait_for_msg_done(smi_info);
2626 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2627 resp, IPMI_MAX_MSG_LENGTH);
2629 /* Check and record info from the get device id, in case we need it. */
2630 rv = ipmi_demangle_device_id(resp, resp_len, &smi_info->device_id);
2637 static int try_enable_event_buffer(struct smi_info *smi_info)
2639 unsigned char msg[3];
2640 unsigned char *resp;
2641 unsigned long resp_len;
2644 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
2648 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2649 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
2650 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
2652 rv = wait_for_msg_done(smi_info);
2655 "ipmi_si: Error getting response from get global,"
2656 " enables command, the event buffer is not"
2661 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2662 resp, IPMI_MAX_MSG_LENGTH);
2665 resp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2 ||
2666 resp[1] != IPMI_GET_BMC_GLOBAL_ENABLES_CMD ||
2669 "ipmi_si: Invalid return from get global"
2670 " enables command, cannot enable the event"
2676 if (resp[3] & IPMI_BMC_EVT_MSG_BUFF)
2677 /* buffer is already enabled, nothing to do. */
2680 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2681 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
2682 msg[2] = resp[3] | IPMI_BMC_EVT_MSG_BUFF;
2683 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 3);
2685 rv = wait_for_msg_done(smi_info);
2688 "ipmi_si: Error getting response from set global,"
2689 " enables command, the event buffer is not"
2694 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2695 resp, IPMI_MAX_MSG_LENGTH);
2698 resp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2 ||
2699 resp[1] != IPMI_SET_BMC_GLOBAL_ENABLES_CMD) {
2701 "ipmi_si: Invalid return from get global,"
2702 "enables command, not enable the event"
2710 * An error when setting the event buffer bit means
2711 * that the event buffer is not supported.
2719 static int type_file_read_proc(char *page, char **start, off_t off,
2720 int count, int *eof, void *data)
2722 struct smi_info *smi = data;
2724 return sprintf(page, "%s\n", si_to_str[smi->si_type]);
2727 static int stat_file_read_proc(char *page, char **start, off_t off,
2728 int count, int *eof, void *data)
2730 char *out = (char *) page;
2731 struct smi_info *smi = data;
2733 out += sprintf(out, "interrupts_enabled: %d\n",
2734 smi->irq && !smi->interrupt_disabled);
2735 out += sprintf(out, "short_timeouts: %u\n",
2736 smi_get_stat(smi, short_timeouts));
2737 out += sprintf(out, "long_timeouts: %u\n",
2738 smi_get_stat(smi, long_timeouts));
2739 out += sprintf(out, "idles: %u\n",
2740 smi_get_stat(smi, idles));
2741 out += sprintf(out, "interrupts: %u\n",
2742 smi_get_stat(smi, interrupts));
2743 out += sprintf(out, "attentions: %u\n",
2744 smi_get_stat(smi, attentions));
2745 out += sprintf(out, "flag_fetches: %u\n",
2746 smi_get_stat(smi, flag_fetches));
2747 out += sprintf(out, "hosed_count: %u\n",
2748 smi_get_stat(smi, hosed_count));
2749 out += sprintf(out, "complete_transactions: %u\n",
2750 smi_get_stat(smi, complete_transactions));
2751 out += sprintf(out, "events: %u\n",
2752 smi_get_stat(smi, events));
2753 out += sprintf(out, "watchdog_pretimeouts: %u\n",
2754 smi_get_stat(smi, watchdog_pretimeouts));
2755 out += sprintf(out, "incoming_messages: %u\n",
2756 smi_get_stat(smi, incoming_messages));
2761 static int param_read_proc(char *page, char **start, off_t off,
2762 int count, int *eof, void *data)
2764 struct smi_info *smi = data;
2766 return sprintf(page,
2767 "%s,%s,0x%lx,rsp=%d,rsi=%d,rsh=%d,irq=%d,ipmb=%d\n",
2768 si_to_str[smi->si_type],
2769 addr_space_to_str[smi->io.addr_type],
2779 * oem_data_avail_to_receive_msg_avail
2780 * @info - smi_info structure with msg_flags set
2782 * Converts flags from OEM_DATA_AVAIL to RECEIVE_MSG_AVAIL
2783 * Returns 1 indicating need to re-run handle_flags().
2785 static int oem_data_avail_to_receive_msg_avail(struct smi_info *smi_info)
2787 smi_info->msg_flags = ((smi_info->msg_flags & ~OEM_DATA_AVAIL) |
2793 * setup_dell_poweredge_oem_data_handler
2794 * @info - smi_info.device_id must be populated
2796 * Systems that match, but have firmware version < 1.40 may assert
2797 * OEM0_DATA_AVAIL on their own, without being told via Set Flags that
2798 * it's safe to do so. Such systems will de-assert OEM1_DATA_AVAIL
2799 * upon receipt of IPMI_GET_MSG_CMD, so we should treat these flags
2800 * as RECEIVE_MSG_AVAIL instead.
2802 * As Dell has no plans to release IPMI 1.5 firmware that *ever*
2803 * assert the OEM[012] bits, and if it did, the driver would have to
2804 * change to handle that properly, we don't actually check for the
2806 * Device ID = 0x20 BMC on PowerEdge 8G servers
2807 * Device Revision = 0x80
2808 * Firmware Revision1 = 0x01 BMC version 1.40
2809 * Firmware Revision2 = 0x40 BCD encoded
2810 * IPMI Version = 0x51 IPMI 1.5
2811 * Manufacturer ID = A2 02 00 Dell IANA
2813 * Additionally, PowerEdge systems with IPMI < 1.5 may also assert
2814 * OEM0_DATA_AVAIL and needs to be treated as RECEIVE_MSG_AVAIL.
2817 #define DELL_POWEREDGE_8G_BMC_DEVICE_ID 0x20
2818 #define DELL_POWEREDGE_8G_BMC_DEVICE_REV 0x80
2819 #define DELL_POWEREDGE_8G_BMC_IPMI_VERSION 0x51
2820 #define DELL_IANA_MFR_ID 0x0002a2
2821 static void setup_dell_poweredge_oem_data_handler(struct smi_info *smi_info)
2823 struct ipmi_device_id *id = &smi_info->device_id;
2824 if (id->manufacturer_id == DELL_IANA_MFR_ID) {
2825 if (id->device_id == DELL_POWEREDGE_8G_BMC_DEVICE_ID &&
2826 id->device_revision == DELL_POWEREDGE_8G_BMC_DEVICE_REV &&
2827 id->ipmi_version == DELL_POWEREDGE_8G_BMC_IPMI_VERSION) {
2828 smi_info->oem_data_avail_handler =
2829 oem_data_avail_to_receive_msg_avail;
2830 } else if (ipmi_version_major(id) < 1 ||
2831 (ipmi_version_major(id) == 1 &&
2832 ipmi_version_minor(id) < 5)) {
2833 smi_info->oem_data_avail_handler =
2834 oem_data_avail_to_receive_msg_avail;
2839 #define CANNOT_RETURN_REQUESTED_LENGTH 0xCA
2840 static void return_hosed_msg_badsize(struct smi_info *smi_info)
2842 struct ipmi_smi_msg *msg = smi_info->curr_msg;
2844 /* Make it a reponse */
2845 msg->rsp[0] = msg->data[0] | 4;
2846 msg->rsp[1] = msg->data[1];
2847 msg->rsp[2] = CANNOT_RETURN_REQUESTED_LENGTH;
2849 smi_info->curr_msg = NULL;
2850 deliver_recv_msg(smi_info, msg);
2854 * dell_poweredge_bt_xaction_handler
2855 * @info - smi_info.device_id must be populated
2857 * Dell PowerEdge servers with the BT interface (x6xx and 1750) will
2858 * not respond to a Get SDR command if the length of the data
2859 * requested is exactly 0x3A, which leads to command timeouts and no
2860 * data returned. This intercepts such commands, and causes userspace
2861 * callers to try again with a different-sized buffer, which succeeds.
2864 #define STORAGE_NETFN 0x0A
2865 #define STORAGE_CMD_GET_SDR 0x23
2866 static int dell_poweredge_bt_xaction_handler(struct notifier_block *self,
2867 unsigned long unused,
2870 struct smi_info *smi_info = in;
2871 unsigned char *data = smi_info->curr_msg->data;
2872 unsigned int size = smi_info->curr_msg->data_size;
2874 (data[0]>>2) == STORAGE_NETFN &&
2875 data[1] == STORAGE_CMD_GET_SDR &&
2877 return_hosed_msg_badsize(smi_info);
2883 static struct notifier_block dell_poweredge_bt_xaction_notifier = {
2884 .notifier_call = dell_poweredge_bt_xaction_handler,
2888 * setup_dell_poweredge_bt_xaction_handler
2889 * @info - smi_info.device_id must be filled in already
2891 * Fills in smi_info.device_id.start_transaction_pre_hook
2892 * when we know what function to use there.
2895 setup_dell_poweredge_bt_xaction_handler(struct smi_info *smi_info)
2897 struct ipmi_device_id *id = &smi_info->device_id;
2898 if (id->manufacturer_id == DELL_IANA_MFR_ID &&
2899 smi_info->si_type == SI_BT)
2900 register_xaction_notifier(&dell_poweredge_bt_xaction_notifier);
2904 * setup_oem_data_handler
2905 * @info - smi_info.device_id must be filled in already
2907 * Fills in smi_info.device_id.oem_data_available_handler
2908 * when we know what function to use there.
2911 static void setup_oem_data_handler(struct smi_info *smi_info)
2913 setup_dell_poweredge_oem_data_handler(smi_info);
2916 static void setup_xaction_handlers(struct smi_info *smi_info)
2918 setup_dell_poweredge_bt_xaction_handler(smi_info);
2921 static inline void wait_for_timer_and_thread(struct smi_info *smi_info)
2923 if (smi_info->intf) {
2925 * The timer and thread are only running if the
2926 * interface has been started up and registered.
2928 if (smi_info->thread != NULL)
2929 kthread_stop(smi_info->thread);
2930 del_timer_sync(&smi_info->si_timer);
2934 static __devinitdata struct ipmi_default_vals
2940 { .type = SI_KCS, .port = 0xca2 },
2941 { .type = SI_SMIC, .port = 0xca9 },
2942 { .type = SI_BT, .port = 0xe4 },
2946 static __devinit void default_find_bmc(void)
2948 struct smi_info *info;
2951 for (i = 0; ; i++) {
2952 if (!ipmi_defaults[i].port)
2955 if (check_legacy_ioport(ipmi_defaults[i].port))
2958 info = kzalloc(sizeof(*info), GFP_KERNEL);
2962 info->addr_source = SI_DEFAULT;
2964 info->si_type = ipmi_defaults[i].type;
2965 info->io_setup = port_setup;
2966 info->io.addr_data = ipmi_defaults[i].port;
2967 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2969 info->io.addr = NULL;
2970 info->io.regspacing = DEFAULT_REGSPACING;
2971 info->io.regsize = DEFAULT_REGSPACING;
2972 info->io.regshift = 0;
2974 if (try_smi_init(info) == 0) {
2976 printk(KERN_INFO "ipmi_si: Found default %s state"
2977 " machine at %s address 0x%lx\n",
2978 si_to_str[info->si_type],
2979 addr_space_to_str[info->io.addr_type],
2980 info->io.addr_data);
2986 static int is_new_interface(struct smi_info *info)
2990 list_for_each_entry(e, &smi_infos, link) {
2991 if (e->io.addr_type != info->io.addr_type)
2993 if (e->io.addr_data == info->io.addr_data)
3000 static int try_smi_init(struct smi_info *new_smi)
3005 printk(KERN_INFO "ipmi_si: Trying %s-specified %s state"
3006 " machine at %s address 0x%lx, slave address 0x%x,"
3008 ipmi_addr_src_to_str[new_smi->addr_source],
3009 si_to_str[new_smi->si_type],
3010 addr_space_to_str[new_smi->io.addr_type],
3011 new_smi->io.addr_data,
3012 new_smi->slave_addr, new_smi->irq);
3014 mutex_lock(&smi_infos_lock);
3015 if (!is_new_interface(new_smi)) {
3016 printk(KERN_WARNING "ipmi_si: duplicate interface\n");
3021 /* So we know not to free it unless we have allocated one. */
3022 new_smi->intf = NULL;
3023 new_smi->si_sm = NULL;
3024 new_smi->handlers = NULL;
3026 switch (new_smi->si_type) {
3028 new_smi->handlers = &kcs_smi_handlers;
3032 new_smi->handlers = &smic_smi_handlers;
3036 new_smi->handlers = &bt_smi_handlers;
3040 /* No support for anything else yet. */
3045 /* Allocate the state machine's data and initialize it. */
3046 new_smi->si_sm = kmalloc(new_smi->handlers->size(), GFP_KERNEL);
3047 if (!new_smi->si_sm) {
3048 printk(KERN_ERR "Could not allocate state machine memory\n");
3052 new_smi->io_size = new_smi->handlers->init_data(new_smi->si_sm,
3055 /* Now that we know the I/O size, we can set up the I/O. */
3056 rv = new_smi->io_setup(new_smi);
3058 printk(KERN_ERR "Could not set up I/O space\n");
3062 spin_lock_init(&(new_smi->si_lock));
3063 spin_lock_init(&(new_smi->msg_lock));
3065 /* Do low-level detection first. */
3066 if (new_smi->handlers->detect(new_smi->si_sm)) {
3067 if (new_smi->addr_source)
3068 printk(KERN_INFO "ipmi_si: Interface detection"
3075 * Attempt a get device id command. If it fails, we probably
3076 * don't have a BMC here.
3078 rv = try_get_dev_id(new_smi);
3080 if (new_smi->addr_source)
3081 printk(KERN_INFO "ipmi_si: There appears to be no BMC"
3082 " at this location\n");
3086 setup_oem_data_handler(new_smi);
3087 setup_xaction_handlers(new_smi);
3089 INIT_LIST_HEAD(&(new_smi->xmit_msgs));
3090 INIT_LIST_HEAD(&(new_smi->hp_xmit_msgs));
3091 new_smi->curr_msg = NULL;
3092 atomic_set(&new_smi->req_events, 0);
3093 new_smi->run_to_completion = 0;
3094 for (i = 0; i < SI_NUM_STATS; i++)
3095 atomic_set(&new_smi->stats[i], 0);
3097 new_smi->interrupt_disabled = 0;
3098 atomic_set(&new_smi->stop_operation, 0);
3099 new_smi->intf_num = smi_num;
3102 rv = try_enable_event_buffer(new_smi);
3104 new_smi->has_event_buffer = 1;
3107 * Start clearing the flags before we enable interrupts or the
3108 * timer to avoid racing with the timer.
3110 start_clear_flags(new_smi);
3111 /* IRQ is defined to be set when non-zero. */
3113 new_smi->si_state = SI_CLEARING_FLAGS_THEN_SET_IRQ;
3115 if (!new_smi->dev) {
3117 * If we don't already have a device from something
3118 * else (like PCI), then register a new one.
3120 new_smi->pdev = platform_device_alloc("ipmi_si",
3122 if (!new_smi->pdev) {
3125 " Unable to allocate platform device\n");
3128 new_smi->dev = &new_smi->pdev->dev;
3129 new_smi->dev->driver = &ipmi_driver.driver;
3131 rv = platform_device_add(new_smi->pdev);
3135 " Unable to register system interface device:"
3140 new_smi->dev_registered = 1;
3143 rv = ipmi_register_smi(&handlers,
3145 &new_smi->device_id,
3148 new_smi->slave_addr);
3151 "ipmi_si: Unable to register device: error %d\n",
3153 goto out_err_stop_timer;
3156 rv = ipmi_smi_add_proc_entry(new_smi->intf, "type",
3157 type_file_read_proc,
3161 "ipmi_si: Unable to create proc entry: %d\n",
3163 goto out_err_stop_timer;
3166 rv = ipmi_smi_add_proc_entry(new_smi->intf, "si_stats",
3167 stat_file_read_proc,
3171 "ipmi_si: Unable to create proc entry: %d\n",
3173 goto out_err_stop_timer;
3176 rv = ipmi_smi_add_proc_entry(new_smi->intf, "params",
3181 "ipmi_si: Unable to create proc entry: %d\n",
3183 goto out_err_stop_timer;
3186 list_add_tail(&new_smi->link, &smi_infos);
3188 mutex_unlock(&smi_infos_lock);
3190 printk(KERN_INFO "IPMI %s interface initialized\n",
3191 si_to_str[new_smi->si_type]);
3196 atomic_inc(&new_smi->stop_operation);
3197 wait_for_timer_and_thread(new_smi);
3201 ipmi_unregister_smi(new_smi->intf);
3203 if (new_smi->irq_cleanup)
3204 new_smi->irq_cleanup(new_smi);
3207 * Wait until we know that we are out of any interrupt
3208 * handlers might have been running before we freed the
3211 synchronize_sched();
3213 if (new_smi->si_sm) {
3214 if (new_smi->handlers)
3215 new_smi->handlers->cleanup(new_smi->si_sm);
3216 kfree(new_smi->si_sm);
3218 if (new_smi->addr_source_cleanup)
3219 new_smi->addr_source_cleanup(new_smi);
3220 if (new_smi->io_cleanup)
3221 new_smi->io_cleanup(new_smi);
3223 if (new_smi->dev_registered)
3224 platform_device_unregister(new_smi->pdev);
3228 mutex_unlock(&smi_infos_lock);
3233 static __devinit int init_ipmi_si(void)
3243 /* Register the device drivers. */
3244 rv = driver_register(&ipmi_driver.driver);
3247 "init_ipmi_si: Unable to register driver: %d\n",
3253 /* Parse out the si_type string into its components. */
3256 for (i = 0; (i < SI_MAX_PARMS) && (*str != '\0'); i++) {
3258 str = strchr(str, ',');
3268 printk(KERN_INFO "IPMI System Interface driver.\n");
3270 hardcode_find_bmc();
3280 pnp_register_driver(&ipmi_pnp_driver);
3284 rv = pci_register_driver(&ipmi_pci_driver);
3287 "init_ipmi_si: Unable to register PCI driver: %d\n",
3291 #ifdef CONFIG_PPC_OF
3292 of_register_platform_driver(&ipmi_of_platform_driver);
3295 if (si_trydefaults) {
3296 mutex_lock(&smi_infos_lock);
3297 if (list_empty(&smi_infos)) {
3298 /* No BMC was found, try defaults. */
3299 mutex_unlock(&smi_infos_lock);
3302 mutex_unlock(&smi_infos_lock);
3306 mutex_lock(&smi_infos_lock);
3307 if (unload_when_empty && list_empty(&smi_infos)) {
3308 mutex_unlock(&smi_infos_lock);
3310 pci_unregister_driver(&ipmi_pci_driver);
3313 #ifdef CONFIG_PPC_OF
3314 of_unregister_platform_driver(&ipmi_of_platform_driver);
3316 driver_unregister(&ipmi_driver.driver);
3318 "ipmi_si: Unable to find any System Interface(s)\n");
3321 mutex_unlock(&smi_infos_lock);
3325 module_init(init_ipmi_si);
3327 static void cleanup_one_si(struct smi_info *to_clean)
3330 unsigned long flags;
3335 list_del(&to_clean->link);
3337 /* Tell the driver that we are shutting down. */
3338 atomic_inc(&to_clean->stop_operation);
3341 * Make sure the timer and thread are stopped and will not run
3344 wait_for_timer_and_thread(to_clean);
3347 * Timeouts are stopped, now make sure the interrupts are off
3348 * for the device. A little tricky with locks to make sure
3349 * there are no races.
3351 spin_lock_irqsave(&to_clean->si_lock, flags);
3352 while (to_clean->curr_msg || (to_clean->si_state != SI_NORMAL)) {
3353 spin_unlock_irqrestore(&to_clean->si_lock, flags);
3355 schedule_timeout_uninterruptible(1);
3356 spin_lock_irqsave(&to_clean->si_lock, flags);
3358 disable_si_irq(to_clean);
3359 spin_unlock_irqrestore(&to_clean->si_lock, flags);
3360 while (to_clean->curr_msg || (to_clean->si_state != SI_NORMAL)) {
3362 schedule_timeout_uninterruptible(1);
3365 /* Clean up interrupts and make sure that everything is done. */
3366 if (to_clean->irq_cleanup)
3367 to_clean->irq_cleanup(to_clean);
3368 while (to_clean->curr_msg || (to_clean->si_state != SI_NORMAL)) {
3370 schedule_timeout_uninterruptible(1);
3373 rv = ipmi_unregister_smi(to_clean->intf);
3376 "ipmi_si: Unable to unregister device: errno=%d\n",
3380 to_clean->handlers->cleanup(to_clean->si_sm);
3382 kfree(to_clean->si_sm);
3384 if (to_clean->addr_source_cleanup)
3385 to_clean->addr_source_cleanup(to_clean);
3386 if (to_clean->io_cleanup)
3387 to_clean->io_cleanup(to_clean);
3389 if (to_clean->dev_registered)
3390 platform_device_unregister(to_clean->pdev);
3395 static __exit void cleanup_ipmi_si(void)
3397 struct smi_info *e, *tmp_e;
3403 pci_unregister_driver(&ipmi_pci_driver);
3406 pnp_unregister_driver(&ipmi_pnp_driver);
3409 #ifdef CONFIG_PPC_OF
3410 of_unregister_platform_driver(&ipmi_of_platform_driver);
3413 mutex_lock(&smi_infos_lock);
3414 list_for_each_entry_safe(e, tmp_e, &smi_infos, link)
3416 mutex_unlock(&smi_infos_lock);
3418 driver_unregister(&ipmi_driver.driver);
3420 module_exit(cleanup_ipmi_si);
3422 MODULE_LICENSE("GPL");
3423 MODULE_AUTHOR("Corey Minyard <minyard@mvista.com>");
3424 MODULE_DESCRIPTION("Interface to the IPMI driver for the KCS, SMIC, and BT"
3425 " system interfaces.");