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 add_smi(struct smi_info *smi);
312 static int try_smi_init(struct smi_info *smi);
313 static void cleanup_one_si(struct smi_info *to_clean);
315 static ATOMIC_NOTIFIER_HEAD(xaction_notifier_list);
316 static int register_xaction_notifier(struct notifier_block *nb)
318 return atomic_notifier_chain_register(&xaction_notifier_list, nb);
321 static void deliver_recv_msg(struct smi_info *smi_info,
322 struct ipmi_smi_msg *msg)
324 /* Deliver the message to the upper layer with the lock
326 spin_unlock(&(smi_info->si_lock));
327 ipmi_smi_msg_received(smi_info->intf, msg);
328 spin_lock(&(smi_info->si_lock));
331 static void return_hosed_msg(struct smi_info *smi_info, int cCode)
333 struct ipmi_smi_msg *msg = smi_info->curr_msg;
335 if (cCode < 0 || cCode > IPMI_ERR_UNSPECIFIED)
336 cCode = IPMI_ERR_UNSPECIFIED;
337 /* else use it as is */
339 /* Make it a reponse */
340 msg->rsp[0] = msg->data[0] | 4;
341 msg->rsp[1] = msg->data[1];
345 smi_info->curr_msg = NULL;
346 deliver_recv_msg(smi_info, msg);
349 static enum si_sm_result start_next_msg(struct smi_info *smi_info)
352 struct list_head *entry = NULL;
358 * No need to save flags, we aleady have interrupts off and we
359 * already hold the SMI lock.
361 if (!smi_info->run_to_completion)
362 spin_lock(&(smi_info->msg_lock));
364 /* Pick the high priority queue first. */
365 if (!list_empty(&(smi_info->hp_xmit_msgs))) {
366 entry = smi_info->hp_xmit_msgs.next;
367 } else if (!list_empty(&(smi_info->xmit_msgs))) {
368 entry = smi_info->xmit_msgs.next;
372 smi_info->curr_msg = NULL;
378 smi_info->curr_msg = list_entry(entry,
383 printk(KERN_DEBUG "**Start2: %d.%9.9d\n", t.tv_sec, t.tv_usec);
385 err = atomic_notifier_call_chain(&xaction_notifier_list,
387 if (err & NOTIFY_STOP_MASK) {
388 rv = SI_SM_CALL_WITHOUT_DELAY;
391 err = smi_info->handlers->start_transaction(
393 smi_info->curr_msg->data,
394 smi_info->curr_msg->data_size);
396 return_hosed_msg(smi_info, err);
398 rv = SI_SM_CALL_WITHOUT_DELAY;
401 if (!smi_info->run_to_completion)
402 spin_unlock(&(smi_info->msg_lock));
407 static void start_enable_irq(struct smi_info *smi_info)
409 unsigned char msg[2];
412 * If we are enabling interrupts, we have to tell the
415 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
416 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
418 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
419 smi_info->si_state = SI_ENABLE_INTERRUPTS1;
422 static void start_disable_irq(struct smi_info *smi_info)
424 unsigned char msg[2];
426 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
427 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
429 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
430 smi_info->si_state = SI_DISABLE_INTERRUPTS1;
433 static void start_clear_flags(struct smi_info *smi_info)
435 unsigned char msg[3];
437 /* Make sure the watchdog pre-timeout flag is not set at startup. */
438 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
439 msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
440 msg[2] = WDT_PRE_TIMEOUT_INT;
442 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 3);
443 smi_info->si_state = SI_CLEARING_FLAGS;
447 * When we have a situtaion where we run out of memory and cannot
448 * allocate messages, we just leave them in the BMC and run the system
449 * polled until we can allocate some memory. Once we have some
450 * memory, we will re-enable the interrupt.
452 static inline void disable_si_irq(struct smi_info *smi_info)
454 if ((smi_info->irq) && (!smi_info->interrupt_disabled)) {
455 start_disable_irq(smi_info);
456 smi_info->interrupt_disabled = 1;
460 static inline void enable_si_irq(struct smi_info *smi_info)
462 if ((smi_info->irq) && (smi_info->interrupt_disabled)) {
463 start_enable_irq(smi_info);
464 smi_info->interrupt_disabled = 0;
468 static void handle_flags(struct smi_info *smi_info)
471 if (smi_info->msg_flags & WDT_PRE_TIMEOUT_INT) {
472 /* Watchdog pre-timeout */
473 smi_inc_stat(smi_info, watchdog_pretimeouts);
475 start_clear_flags(smi_info);
476 smi_info->msg_flags &= ~WDT_PRE_TIMEOUT_INT;
477 spin_unlock(&(smi_info->si_lock));
478 ipmi_smi_watchdog_pretimeout(smi_info->intf);
479 spin_lock(&(smi_info->si_lock));
480 } else if (smi_info->msg_flags & RECEIVE_MSG_AVAIL) {
481 /* Messages available. */
482 smi_info->curr_msg = ipmi_alloc_smi_msg();
483 if (!smi_info->curr_msg) {
484 disable_si_irq(smi_info);
485 smi_info->si_state = SI_NORMAL;
488 enable_si_irq(smi_info);
490 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
491 smi_info->curr_msg->data[1] = IPMI_GET_MSG_CMD;
492 smi_info->curr_msg->data_size = 2;
494 smi_info->handlers->start_transaction(
496 smi_info->curr_msg->data,
497 smi_info->curr_msg->data_size);
498 smi_info->si_state = SI_GETTING_MESSAGES;
499 } else if (smi_info->msg_flags & EVENT_MSG_BUFFER_FULL) {
500 /* Events available. */
501 smi_info->curr_msg = ipmi_alloc_smi_msg();
502 if (!smi_info->curr_msg) {
503 disable_si_irq(smi_info);
504 smi_info->si_state = SI_NORMAL;
507 enable_si_irq(smi_info);
509 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
510 smi_info->curr_msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
511 smi_info->curr_msg->data_size = 2;
513 smi_info->handlers->start_transaction(
515 smi_info->curr_msg->data,
516 smi_info->curr_msg->data_size);
517 smi_info->si_state = SI_GETTING_EVENTS;
518 } else if (smi_info->msg_flags & OEM_DATA_AVAIL &&
519 smi_info->oem_data_avail_handler) {
520 if (smi_info->oem_data_avail_handler(smi_info))
523 smi_info->si_state = SI_NORMAL;
526 static void handle_transaction_done(struct smi_info *smi_info)
528 struct ipmi_smi_msg *msg;
533 printk(KERN_DEBUG "**Done: %d.%9.9d\n", t.tv_sec, t.tv_usec);
535 switch (smi_info->si_state) {
537 if (!smi_info->curr_msg)
540 smi_info->curr_msg->rsp_size
541 = smi_info->handlers->get_result(
543 smi_info->curr_msg->rsp,
544 IPMI_MAX_MSG_LENGTH);
547 * Do this here becase deliver_recv_msg() releases the
548 * lock, and a new message can be put in during the
549 * time the lock is released.
551 msg = smi_info->curr_msg;
552 smi_info->curr_msg = NULL;
553 deliver_recv_msg(smi_info, msg);
556 case SI_GETTING_FLAGS:
558 unsigned char msg[4];
561 /* We got the flags from the SMI, now handle them. */
562 len = smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
564 /* Error fetching flags, just give up for now. */
565 smi_info->si_state = SI_NORMAL;
566 } else if (len < 4) {
568 * Hmm, no flags. That's technically illegal, but
569 * don't use uninitialized data.
571 smi_info->si_state = SI_NORMAL;
573 smi_info->msg_flags = msg[3];
574 handle_flags(smi_info);
579 case SI_CLEARING_FLAGS:
580 case SI_CLEARING_FLAGS_THEN_SET_IRQ:
582 unsigned char msg[3];
584 /* We cleared the flags. */
585 smi_info->handlers->get_result(smi_info->si_sm, msg, 3);
587 /* Error clearing flags */
589 "ipmi_si: Error clearing flags: %2.2x\n",
592 if (smi_info->si_state == SI_CLEARING_FLAGS_THEN_SET_IRQ)
593 start_enable_irq(smi_info);
595 smi_info->si_state = SI_NORMAL;
599 case SI_GETTING_EVENTS:
601 smi_info->curr_msg->rsp_size
602 = smi_info->handlers->get_result(
604 smi_info->curr_msg->rsp,
605 IPMI_MAX_MSG_LENGTH);
608 * Do this here becase deliver_recv_msg() releases the
609 * lock, and a new message can be put in during the
610 * time the lock is released.
612 msg = smi_info->curr_msg;
613 smi_info->curr_msg = NULL;
614 if (msg->rsp[2] != 0) {
615 /* Error getting event, probably done. */
618 /* Take off the event flag. */
619 smi_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
620 handle_flags(smi_info);
622 smi_inc_stat(smi_info, events);
625 * Do this before we deliver the message
626 * because delivering the message releases the
627 * lock and something else can mess with the
630 handle_flags(smi_info);
632 deliver_recv_msg(smi_info, msg);
637 case SI_GETTING_MESSAGES:
639 smi_info->curr_msg->rsp_size
640 = smi_info->handlers->get_result(
642 smi_info->curr_msg->rsp,
643 IPMI_MAX_MSG_LENGTH);
646 * Do this here becase deliver_recv_msg() releases the
647 * lock, and a new message can be put in during the
648 * time the lock is released.
650 msg = smi_info->curr_msg;
651 smi_info->curr_msg = NULL;
652 if (msg->rsp[2] != 0) {
653 /* Error getting event, probably done. */
656 /* Take off the msg flag. */
657 smi_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
658 handle_flags(smi_info);
660 smi_inc_stat(smi_info, incoming_messages);
663 * Do this before we deliver the message
664 * because delivering the message releases the
665 * lock and something else can mess with the
668 handle_flags(smi_info);
670 deliver_recv_msg(smi_info, msg);
675 case SI_ENABLE_INTERRUPTS1:
677 unsigned char msg[4];
679 /* We got the flags from the SMI, now handle them. */
680 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
683 "ipmi_si: Could not enable interrupts"
684 ", failed get, using polled mode.\n");
685 smi_info->si_state = SI_NORMAL;
687 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
688 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
690 IPMI_BMC_RCV_MSG_INTR |
691 IPMI_BMC_EVT_MSG_INTR);
692 smi_info->handlers->start_transaction(
693 smi_info->si_sm, msg, 3);
694 smi_info->si_state = SI_ENABLE_INTERRUPTS2;
699 case SI_ENABLE_INTERRUPTS2:
701 unsigned char msg[4];
703 /* We got the flags from the SMI, now handle them. */
704 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
707 "ipmi_si: Could not enable interrupts"
708 ", failed set, using polled mode.\n");
710 smi_info->si_state = SI_NORMAL;
714 case SI_DISABLE_INTERRUPTS1:
716 unsigned char msg[4];
718 /* We got the flags from the SMI, now handle them. */
719 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
722 "ipmi_si: Could not disable interrupts"
724 smi_info->si_state = SI_NORMAL;
726 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
727 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
729 ~(IPMI_BMC_RCV_MSG_INTR |
730 IPMI_BMC_EVT_MSG_INTR));
731 smi_info->handlers->start_transaction(
732 smi_info->si_sm, msg, 3);
733 smi_info->si_state = SI_DISABLE_INTERRUPTS2;
738 case SI_DISABLE_INTERRUPTS2:
740 unsigned char msg[4];
742 /* We got the flags from the SMI, now handle them. */
743 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
746 "ipmi_si: Could not disable interrupts"
749 smi_info->si_state = SI_NORMAL;
756 * Called on timeouts and events. Timeouts should pass the elapsed
757 * time, interrupts should pass in zero. Must be called with
758 * si_lock held and interrupts disabled.
760 static enum si_sm_result smi_event_handler(struct smi_info *smi_info,
763 enum si_sm_result si_sm_result;
767 * There used to be a loop here that waited a little while
768 * (around 25us) before giving up. That turned out to be
769 * pointless, the minimum delays I was seeing were in the 300us
770 * range, which is far too long to wait in an interrupt. So
771 * we just run until the state machine tells us something
772 * happened or it needs a delay.
774 si_sm_result = smi_info->handlers->event(smi_info->si_sm, time);
776 while (si_sm_result == SI_SM_CALL_WITHOUT_DELAY)
777 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
779 if (si_sm_result == SI_SM_TRANSACTION_COMPLETE) {
780 smi_inc_stat(smi_info, complete_transactions);
782 handle_transaction_done(smi_info);
783 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
784 } else if (si_sm_result == SI_SM_HOSED) {
785 smi_inc_stat(smi_info, hosed_count);
788 * Do the before return_hosed_msg, because that
791 smi_info->si_state = SI_NORMAL;
792 if (smi_info->curr_msg != NULL) {
794 * If we were handling a user message, format
795 * a response to send to the upper layer to
796 * tell it about the error.
798 return_hosed_msg(smi_info, IPMI_ERR_UNSPECIFIED);
800 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
804 * We prefer handling attn over new messages. But don't do
805 * this if there is not yet an upper layer to handle anything.
807 if (likely(smi_info->intf) && si_sm_result == SI_SM_ATTN) {
808 unsigned char msg[2];
810 smi_inc_stat(smi_info, attentions);
813 * Got a attn, send down a get message flags to see
814 * what's causing it. It would be better to handle
815 * this in the upper layer, but due to the way
816 * interrupts work with the SMI, that's not really
819 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
820 msg[1] = IPMI_GET_MSG_FLAGS_CMD;
822 smi_info->handlers->start_transaction(
823 smi_info->si_sm, msg, 2);
824 smi_info->si_state = SI_GETTING_FLAGS;
828 /* If we are currently idle, try to start the next message. */
829 if (si_sm_result == SI_SM_IDLE) {
830 smi_inc_stat(smi_info, idles);
832 si_sm_result = start_next_msg(smi_info);
833 if (si_sm_result != SI_SM_IDLE)
837 if ((si_sm_result == SI_SM_IDLE)
838 && (atomic_read(&smi_info->req_events))) {
840 * We are idle and the upper layer requested that I fetch
843 atomic_set(&smi_info->req_events, 0);
845 smi_info->curr_msg = ipmi_alloc_smi_msg();
846 if (!smi_info->curr_msg)
849 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
850 smi_info->curr_msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
851 smi_info->curr_msg->data_size = 2;
853 smi_info->handlers->start_transaction(
855 smi_info->curr_msg->data,
856 smi_info->curr_msg->data_size);
857 smi_info->si_state = SI_GETTING_EVENTS;
864 static void sender(void *send_info,
865 struct ipmi_smi_msg *msg,
868 struct smi_info *smi_info = send_info;
869 enum si_sm_result result;
875 if (atomic_read(&smi_info->stop_operation)) {
876 msg->rsp[0] = msg->data[0] | 4;
877 msg->rsp[1] = msg->data[1];
878 msg->rsp[2] = IPMI_ERR_UNSPECIFIED;
880 deliver_recv_msg(smi_info, msg);
886 printk("**Enqueue: %d.%9.9d\n", t.tv_sec, t.tv_usec);
889 if (smi_info->run_to_completion) {
891 * If we are running to completion, then throw it in
892 * the list and run transactions until everything is
893 * clear. Priority doesn't matter here.
897 * Run to completion means we are single-threaded, no
900 list_add_tail(&(msg->link), &(smi_info->xmit_msgs));
902 result = smi_event_handler(smi_info, 0);
903 while (result != SI_SM_IDLE) {
904 udelay(SI_SHORT_TIMEOUT_USEC);
905 result = smi_event_handler(smi_info,
906 SI_SHORT_TIMEOUT_USEC);
911 spin_lock_irqsave(&smi_info->msg_lock, flags);
913 list_add_tail(&msg->link, &smi_info->hp_xmit_msgs);
915 list_add_tail(&msg->link, &smi_info->xmit_msgs);
916 spin_unlock_irqrestore(&smi_info->msg_lock, flags);
918 spin_lock_irqsave(&smi_info->si_lock, flags);
919 if (smi_info->si_state == SI_NORMAL && smi_info->curr_msg == NULL)
920 start_next_msg(smi_info);
921 spin_unlock_irqrestore(&smi_info->si_lock, flags);
924 static void set_run_to_completion(void *send_info, int i_run_to_completion)
926 struct smi_info *smi_info = send_info;
927 enum si_sm_result result;
929 smi_info->run_to_completion = i_run_to_completion;
930 if (i_run_to_completion) {
931 result = smi_event_handler(smi_info, 0);
932 while (result != SI_SM_IDLE) {
933 udelay(SI_SHORT_TIMEOUT_USEC);
934 result = smi_event_handler(smi_info,
935 SI_SHORT_TIMEOUT_USEC);
941 * Use -1 in the nsec value of the busy waiting timespec to tell that
942 * we are spinning in kipmid looking for something and not delaying
945 static inline void ipmi_si_set_not_busy(struct timespec *ts)
949 static inline int ipmi_si_is_busy(struct timespec *ts)
951 return ts->tv_nsec != -1;
954 static int ipmi_thread_busy_wait(enum si_sm_result smi_result,
955 const struct smi_info *smi_info,
956 struct timespec *busy_until)
958 unsigned int max_busy_us = 0;
960 if (smi_info->intf_num < num_max_busy_us)
961 max_busy_us = kipmid_max_busy_us[smi_info->intf_num];
962 if (max_busy_us == 0 || smi_result != SI_SM_CALL_WITH_DELAY)
963 ipmi_si_set_not_busy(busy_until);
964 else if (!ipmi_si_is_busy(busy_until)) {
965 getnstimeofday(busy_until);
966 timespec_add_ns(busy_until, max_busy_us*NSEC_PER_USEC);
969 getnstimeofday(&now);
970 if (unlikely(timespec_compare(&now, busy_until) > 0)) {
971 ipmi_si_set_not_busy(busy_until);
980 * A busy-waiting loop for speeding up IPMI operation.
982 * Lousy hardware makes this hard. This is only enabled for systems
983 * that are not BT and do not have interrupts. It starts spinning
984 * when an operation is complete or until max_busy tells it to stop
985 * (if that is enabled). See the paragraph on kimid_max_busy_us in
986 * Documentation/IPMI.txt for details.
988 static int ipmi_thread(void *data)
990 struct smi_info *smi_info = data;
992 enum si_sm_result smi_result;
993 struct timespec busy_until;
995 ipmi_si_set_not_busy(&busy_until);
996 set_user_nice(current, 19);
997 while (!kthread_should_stop()) {
1000 spin_lock_irqsave(&(smi_info->si_lock), flags);
1001 smi_result = smi_event_handler(smi_info, 0);
1002 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1003 busy_wait = ipmi_thread_busy_wait(smi_result, smi_info,
1005 if (smi_result == SI_SM_CALL_WITHOUT_DELAY)
1007 else if (smi_result == SI_SM_CALL_WITH_DELAY && busy_wait)
1010 schedule_timeout_interruptible(0);
1016 static void poll(void *send_info)
1018 struct smi_info *smi_info = send_info;
1019 unsigned long flags;
1022 * Make sure there is some delay in the poll loop so we can
1023 * drive time forward and timeout things.
1026 spin_lock_irqsave(&smi_info->si_lock, flags);
1027 smi_event_handler(smi_info, 10);
1028 spin_unlock_irqrestore(&smi_info->si_lock, flags);
1031 static void request_events(void *send_info)
1033 struct smi_info *smi_info = send_info;
1035 if (atomic_read(&smi_info->stop_operation) ||
1036 !smi_info->has_event_buffer)
1039 atomic_set(&smi_info->req_events, 1);
1042 static int initialized;
1044 static void smi_timeout(unsigned long data)
1046 struct smi_info *smi_info = (struct smi_info *) data;
1047 enum si_sm_result smi_result;
1048 unsigned long flags;
1049 unsigned long jiffies_now;
1055 spin_lock_irqsave(&(smi_info->si_lock), flags);
1057 do_gettimeofday(&t);
1058 printk(KERN_DEBUG "**Timer: %d.%9.9d\n", t.tv_sec, t.tv_usec);
1060 jiffies_now = jiffies;
1061 time_diff = (((long)jiffies_now - (long)smi_info->last_timeout_jiffies)
1062 * SI_USEC_PER_JIFFY);
1063 smi_result = smi_event_handler(smi_info, time_diff);
1065 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1067 smi_info->last_timeout_jiffies = jiffies_now;
1069 if ((smi_info->irq) && (!smi_info->interrupt_disabled)) {
1070 /* Running with interrupts, only do long timeouts. */
1071 smi_info->si_timer.expires = jiffies + SI_TIMEOUT_JIFFIES;
1072 smi_inc_stat(smi_info, long_timeouts);
1077 * If the state machine asks for a short delay, then shorten
1078 * the timer timeout.
1080 if (smi_result == SI_SM_CALL_WITH_DELAY) {
1081 smi_inc_stat(smi_info, short_timeouts);
1082 smi_info->si_timer.expires = jiffies + 1;
1084 smi_inc_stat(smi_info, long_timeouts);
1085 smi_info->si_timer.expires = jiffies + SI_TIMEOUT_JIFFIES;
1089 add_timer(&(smi_info->si_timer));
1092 static irqreturn_t si_irq_handler(int irq, void *data)
1094 struct smi_info *smi_info = data;
1095 unsigned long flags;
1100 spin_lock_irqsave(&(smi_info->si_lock), flags);
1102 smi_inc_stat(smi_info, interrupts);
1105 do_gettimeofday(&t);
1106 printk(KERN_DEBUG "**Interrupt: %d.%9.9d\n", t.tv_sec, t.tv_usec);
1108 smi_event_handler(smi_info, 0);
1109 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1113 static irqreturn_t si_bt_irq_handler(int irq, void *data)
1115 struct smi_info *smi_info = data;
1116 /* We need to clear the IRQ flag for the BT interface. */
1117 smi_info->io.outputb(&smi_info->io, IPMI_BT_INTMASK_REG,
1118 IPMI_BT_INTMASK_CLEAR_IRQ_BIT
1119 | IPMI_BT_INTMASK_ENABLE_IRQ_BIT);
1120 return si_irq_handler(irq, data);
1123 static int smi_start_processing(void *send_info,
1126 struct smi_info *new_smi = send_info;
1129 new_smi->intf = intf;
1131 /* Try to claim any interrupts. */
1132 if (new_smi->irq_setup)
1133 new_smi->irq_setup(new_smi);
1135 /* Set up the timer that drives the interface. */
1136 setup_timer(&new_smi->si_timer, smi_timeout, (long)new_smi);
1137 new_smi->last_timeout_jiffies = jiffies;
1138 mod_timer(&new_smi->si_timer, jiffies + SI_TIMEOUT_JIFFIES);
1141 * Check if the user forcefully enabled the daemon.
1143 if (new_smi->intf_num < num_force_kipmid)
1144 enable = force_kipmid[new_smi->intf_num];
1146 * The BT interface is efficient enough to not need a thread,
1147 * and there is no need for a thread if we have interrupts.
1149 else if ((new_smi->si_type != SI_BT) && (!new_smi->irq))
1153 new_smi->thread = kthread_run(ipmi_thread, new_smi,
1154 "kipmi%d", new_smi->intf_num);
1155 if (IS_ERR(new_smi->thread)) {
1156 printk(KERN_NOTICE "ipmi_si_intf: Could not start"
1157 " kernel thread due to error %ld, only using"
1158 " timers to drive the interface\n",
1159 PTR_ERR(new_smi->thread));
1160 new_smi->thread = NULL;
1167 static void set_maintenance_mode(void *send_info, int enable)
1169 struct smi_info *smi_info = send_info;
1172 atomic_set(&smi_info->req_events, 0);
1175 static struct ipmi_smi_handlers handlers = {
1176 .owner = THIS_MODULE,
1177 .start_processing = smi_start_processing,
1179 .request_events = request_events,
1180 .set_maintenance_mode = set_maintenance_mode,
1181 .set_run_to_completion = set_run_to_completion,
1186 * There can be 4 IO ports passed in (with or without IRQs), 4 addresses,
1187 * a default IO port, and 1 ACPI/SPMI address. That sets SI_MAX_DRIVERS.
1190 static LIST_HEAD(smi_infos);
1191 static DEFINE_MUTEX(smi_infos_lock);
1192 static int smi_num; /* Used to sequence the SMIs */
1194 #define DEFAULT_REGSPACING 1
1195 #define DEFAULT_REGSIZE 1
1197 static int si_trydefaults = 1;
1198 static char *si_type[SI_MAX_PARMS];
1199 #define MAX_SI_TYPE_STR 30
1200 static char si_type_str[MAX_SI_TYPE_STR];
1201 static unsigned long addrs[SI_MAX_PARMS];
1202 static unsigned int num_addrs;
1203 static unsigned int ports[SI_MAX_PARMS];
1204 static unsigned int num_ports;
1205 static int irqs[SI_MAX_PARMS];
1206 static unsigned int num_irqs;
1207 static int regspacings[SI_MAX_PARMS];
1208 static unsigned int num_regspacings;
1209 static int regsizes[SI_MAX_PARMS];
1210 static unsigned int num_regsizes;
1211 static int regshifts[SI_MAX_PARMS];
1212 static unsigned int num_regshifts;
1213 static int slave_addrs[SI_MAX_PARMS]; /* Leaving 0 chooses the default value */
1214 static unsigned int num_slave_addrs;
1216 #define IPMI_IO_ADDR_SPACE 0
1217 #define IPMI_MEM_ADDR_SPACE 1
1218 static char *addr_space_to_str[] = { "i/o", "mem" };
1220 static int hotmod_handler(const char *val, struct kernel_param *kp);
1222 module_param_call(hotmod, hotmod_handler, NULL, NULL, 0200);
1223 MODULE_PARM_DESC(hotmod, "Add and remove interfaces. See"
1224 " Documentation/IPMI.txt in the kernel sources for the"
1227 module_param_named(trydefaults, si_trydefaults, bool, 0);
1228 MODULE_PARM_DESC(trydefaults, "Setting this to 'false' will disable the"
1229 " default scan of the KCS and SMIC interface at the standard"
1231 module_param_string(type, si_type_str, MAX_SI_TYPE_STR, 0);
1232 MODULE_PARM_DESC(type, "Defines the type of each interface, each"
1233 " interface separated by commas. The types are 'kcs',"
1234 " 'smic', and 'bt'. For example si_type=kcs,bt will set"
1235 " the first interface to kcs and the second to bt");
1236 module_param_array(addrs, ulong, &num_addrs, 0);
1237 MODULE_PARM_DESC(addrs, "Sets the memory address of each interface, the"
1238 " addresses separated by commas. Only use if an interface"
1239 " is in memory. Otherwise, set it to zero or leave"
1241 module_param_array(ports, uint, &num_ports, 0);
1242 MODULE_PARM_DESC(ports, "Sets the port address of each interface, the"
1243 " addresses separated by commas. Only use if an interface"
1244 " is a port. Otherwise, set it to zero or leave"
1246 module_param_array(irqs, int, &num_irqs, 0);
1247 MODULE_PARM_DESC(irqs, "Sets the interrupt of each interface, the"
1248 " addresses separated by commas. Only use if an interface"
1249 " has an interrupt. Otherwise, set it to zero or leave"
1251 module_param_array(regspacings, int, &num_regspacings, 0);
1252 MODULE_PARM_DESC(regspacings, "The number of bytes between the start address"
1253 " and each successive register used by the interface. For"
1254 " instance, if the start address is 0xca2 and the spacing"
1255 " is 2, then the second address is at 0xca4. Defaults"
1257 module_param_array(regsizes, int, &num_regsizes, 0);
1258 MODULE_PARM_DESC(regsizes, "The size of the specific IPMI register in bytes."
1259 " This should generally be 1, 2, 4, or 8 for an 8-bit,"
1260 " 16-bit, 32-bit, or 64-bit register. Use this if you"
1261 " the 8-bit IPMI register has to be read from a larger"
1263 module_param_array(regshifts, int, &num_regshifts, 0);
1264 MODULE_PARM_DESC(regshifts, "The amount to shift the data read from the."
1265 " IPMI register, in bits. For instance, if the data"
1266 " is read from a 32-bit word and the IPMI data is in"
1267 " bit 8-15, then the shift would be 8");
1268 module_param_array(slave_addrs, int, &num_slave_addrs, 0);
1269 MODULE_PARM_DESC(slave_addrs, "Set the default IPMB slave address for"
1270 " the controller. Normally this is 0x20, but can be"
1271 " overridden by this parm. This is an array indexed"
1272 " by interface number.");
1273 module_param_array(force_kipmid, int, &num_force_kipmid, 0);
1274 MODULE_PARM_DESC(force_kipmid, "Force the kipmi daemon to be enabled (1) or"
1275 " disabled(0). Normally the IPMI driver auto-detects"
1276 " this, but the value may be overridden by this parm.");
1277 module_param(unload_when_empty, int, 0);
1278 MODULE_PARM_DESC(unload_when_empty, "Unload the module if no interfaces are"
1279 " specified or found, default is 1. Setting to 0"
1280 " is useful for hot add of devices using hotmod.");
1281 module_param_array(kipmid_max_busy_us, uint, &num_max_busy_us, 0644);
1282 MODULE_PARM_DESC(kipmid_max_busy_us,
1283 "Max time (in microseconds) to busy-wait for IPMI data before"
1284 " sleeping. 0 (default) means to wait forever. Set to 100-500"
1285 " if kipmid is using up a lot of CPU time.");
1288 static void std_irq_cleanup(struct smi_info *info)
1290 if (info->si_type == SI_BT)
1291 /* Disable the interrupt in the BT interface. */
1292 info->io.outputb(&info->io, IPMI_BT_INTMASK_REG, 0);
1293 free_irq(info->irq, info);
1296 static int std_irq_setup(struct smi_info *info)
1303 if (info->si_type == SI_BT) {
1304 rv = request_irq(info->irq,
1306 IRQF_SHARED | IRQF_DISABLED,
1310 /* Enable the interrupt in the BT interface. */
1311 info->io.outputb(&info->io, IPMI_BT_INTMASK_REG,
1312 IPMI_BT_INTMASK_ENABLE_IRQ_BIT);
1314 rv = request_irq(info->irq,
1316 IRQF_SHARED | IRQF_DISABLED,
1321 "ipmi_si: %s unable to claim interrupt %d,"
1322 " running polled\n",
1323 DEVICE_NAME, info->irq);
1326 info->irq_cleanup = std_irq_cleanup;
1327 printk(" Using irq %d\n", info->irq);
1333 static unsigned char port_inb(struct si_sm_io *io, unsigned int offset)
1335 unsigned int addr = io->addr_data;
1337 return inb(addr + (offset * io->regspacing));
1340 static void port_outb(struct si_sm_io *io, unsigned int offset,
1343 unsigned int addr = io->addr_data;
1345 outb(b, addr + (offset * io->regspacing));
1348 static unsigned char port_inw(struct si_sm_io *io, unsigned int offset)
1350 unsigned int addr = io->addr_data;
1352 return (inw(addr + (offset * io->regspacing)) >> io->regshift) & 0xff;
1355 static void port_outw(struct si_sm_io *io, unsigned int offset,
1358 unsigned int addr = io->addr_data;
1360 outw(b << io->regshift, addr + (offset * io->regspacing));
1363 static unsigned char port_inl(struct si_sm_io *io, unsigned int offset)
1365 unsigned int addr = io->addr_data;
1367 return (inl(addr + (offset * io->regspacing)) >> io->regshift) & 0xff;
1370 static void port_outl(struct si_sm_io *io, unsigned int offset,
1373 unsigned int addr = io->addr_data;
1375 outl(b << io->regshift, addr+(offset * io->regspacing));
1378 static void port_cleanup(struct smi_info *info)
1380 unsigned int addr = info->io.addr_data;
1384 for (idx = 0; idx < info->io_size; idx++)
1385 release_region(addr + idx * info->io.regspacing,
1390 static int port_setup(struct smi_info *info)
1392 unsigned int addr = info->io.addr_data;
1398 info->io_cleanup = port_cleanup;
1401 * Figure out the actual inb/inw/inl/etc routine to use based
1402 * upon the register size.
1404 switch (info->io.regsize) {
1406 info->io.inputb = port_inb;
1407 info->io.outputb = port_outb;
1410 info->io.inputb = port_inw;
1411 info->io.outputb = port_outw;
1414 info->io.inputb = port_inl;
1415 info->io.outputb = port_outl;
1418 printk(KERN_WARNING "ipmi_si: Invalid register size: %d\n",
1424 * Some BIOSes reserve disjoint I/O regions in their ACPI
1425 * tables. This causes problems when trying to register the
1426 * entire I/O region. Therefore we must register each I/O
1429 for (idx = 0; idx < info->io_size; idx++) {
1430 if (request_region(addr + idx * info->io.regspacing,
1431 info->io.regsize, DEVICE_NAME) == NULL) {
1432 /* Undo allocations */
1434 release_region(addr + idx * info->io.regspacing,
1443 static unsigned char intf_mem_inb(struct si_sm_io *io, unsigned int offset)
1445 return readb((io->addr)+(offset * io->regspacing));
1448 static void intf_mem_outb(struct si_sm_io *io, unsigned int offset,
1451 writeb(b, (io->addr)+(offset * io->regspacing));
1454 static unsigned char intf_mem_inw(struct si_sm_io *io, unsigned int offset)
1456 return (readw((io->addr)+(offset * io->regspacing)) >> io->regshift)
1460 static void intf_mem_outw(struct si_sm_io *io, unsigned int offset,
1463 writeb(b << io->regshift, (io->addr)+(offset * io->regspacing));
1466 static unsigned char intf_mem_inl(struct si_sm_io *io, unsigned int offset)
1468 return (readl((io->addr)+(offset * io->regspacing)) >> io->regshift)
1472 static void intf_mem_outl(struct si_sm_io *io, unsigned int offset,
1475 writel(b << io->regshift, (io->addr)+(offset * io->regspacing));
1479 static unsigned char mem_inq(struct si_sm_io *io, unsigned int offset)
1481 return (readq((io->addr)+(offset * io->regspacing)) >> io->regshift)
1485 static void mem_outq(struct si_sm_io *io, unsigned int offset,
1488 writeq(b << io->regshift, (io->addr)+(offset * io->regspacing));
1492 static void mem_cleanup(struct smi_info *info)
1494 unsigned long addr = info->io.addr_data;
1497 if (info->io.addr) {
1498 iounmap(info->io.addr);
1500 mapsize = ((info->io_size * info->io.regspacing)
1501 - (info->io.regspacing - info->io.regsize));
1503 release_mem_region(addr, mapsize);
1507 static int mem_setup(struct smi_info *info)
1509 unsigned long addr = info->io.addr_data;
1515 info->io_cleanup = mem_cleanup;
1518 * Figure out the actual readb/readw/readl/etc routine to use based
1519 * upon the register size.
1521 switch (info->io.regsize) {
1523 info->io.inputb = intf_mem_inb;
1524 info->io.outputb = intf_mem_outb;
1527 info->io.inputb = intf_mem_inw;
1528 info->io.outputb = intf_mem_outw;
1531 info->io.inputb = intf_mem_inl;
1532 info->io.outputb = intf_mem_outl;
1536 info->io.inputb = mem_inq;
1537 info->io.outputb = mem_outq;
1541 printk(KERN_WARNING "ipmi_si: Invalid register size: %d\n",
1547 * Calculate the total amount of memory to claim. This is an
1548 * unusual looking calculation, but it avoids claiming any
1549 * more memory than it has to. It will claim everything
1550 * between the first address to the end of the last full
1553 mapsize = ((info->io_size * info->io.regspacing)
1554 - (info->io.regspacing - info->io.regsize));
1556 if (request_mem_region(addr, mapsize, DEVICE_NAME) == NULL)
1559 info->io.addr = ioremap(addr, mapsize);
1560 if (info->io.addr == NULL) {
1561 release_mem_region(addr, mapsize);
1568 * Parms come in as <op1>[:op2[:op3...]]. ops are:
1569 * add|remove,kcs|bt|smic,mem|i/o,<address>[,<opt1>[,<opt2>[,...]]]
1577 enum hotmod_op { HM_ADD, HM_REMOVE };
1578 struct hotmod_vals {
1582 static struct hotmod_vals hotmod_ops[] = {
1584 { "remove", HM_REMOVE },
1587 static struct hotmod_vals hotmod_si[] = {
1589 { "smic", SI_SMIC },
1593 static struct hotmod_vals hotmod_as[] = {
1594 { "mem", IPMI_MEM_ADDR_SPACE },
1595 { "i/o", IPMI_IO_ADDR_SPACE },
1599 static int parse_str(struct hotmod_vals *v, int *val, char *name, char **curr)
1604 s = strchr(*curr, ',');
1606 printk(KERN_WARNING PFX "No hotmod %s given.\n", name);
1611 for (i = 0; hotmod_ops[i].name; i++) {
1612 if (strcmp(*curr, v[i].name) == 0) {
1619 printk(KERN_WARNING PFX "Invalid hotmod %s '%s'\n", name, *curr);
1623 static int check_hotmod_int_op(const char *curr, const char *option,
1624 const char *name, int *val)
1628 if (strcmp(curr, name) == 0) {
1630 printk(KERN_WARNING PFX
1631 "No option given for '%s'\n",
1635 *val = simple_strtoul(option, &n, 0);
1636 if ((*n != '\0') || (*option == '\0')) {
1637 printk(KERN_WARNING PFX
1638 "Bad option given for '%s'\n",
1647 static int hotmod_handler(const char *val, struct kernel_param *kp)
1649 char *str = kstrdup(val, GFP_KERNEL);
1651 char *next, *curr, *s, *n, *o;
1653 enum si_type si_type;
1663 struct smi_info *info;
1668 /* Kill any trailing spaces, as we can get a "\n" from echo. */
1671 while ((ival >= 0) && isspace(str[ival])) {
1676 for (curr = str; curr; curr = next) {
1681 ipmb = 0; /* Choose the default if not specified */
1683 next = strchr(curr, ':');
1689 rv = parse_str(hotmod_ops, &ival, "operation", &curr);
1694 rv = parse_str(hotmod_si, &ival, "interface type", &curr);
1699 rv = parse_str(hotmod_as, &addr_space, "address space", &curr);
1703 s = strchr(curr, ',');
1708 addr = simple_strtoul(curr, &n, 0);
1709 if ((*n != '\0') || (*curr == '\0')) {
1710 printk(KERN_WARNING PFX "Invalid hotmod address"
1717 s = strchr(curr, ',');
1722 o = strchr(curr, '=');
1727 rv = check_hotmod_int_op(curr, o, "rsp", ®spacing);
1732 rv = check_hotmod_int_op(curr, o, "rsi", ®size);
1737 rv = check_hotmod_int_op(curr, o, "rsh", ®shift);
1742 rv = check_hotmod_int_op(curr, o, "irq", &irq);
1747 rv = check_hotmod_int_op(curr, o, "ipmb", &ipmb);
1754 printk(KERN_WARNING PFX
1755 "Invalid hotmod option '%s'\n",
1761 info = kzalloc(sizeof(*info), GFP_KERNEL);
1767 info->addr_source = SI_HOTMOD;
1768 info->si_type = si_type;
1769 info->io.addr_data = addr;
1770 info->io.addr_type = addr_space;
1771 if (addr_space == IPMI_MEM_ADDR_SPACE)
1772 info->io_setup = mem_setup;
1774 info->io_setup = port_setup;
1776 info->io.addr = NULL;
1777 info->io.regspacing = regspacing;
1778 if (!info->io.regspacing)
1779 info->io.regspacing = DEFAULT_REGSPACING;
1780 info->io.regsize = regsize;
1781 if (!info->io.regsize)
1782 info->io.regsize = DEFAULT_REGSPACING;
1783 info->io.regshift = regshift;
1786 info->irq_setup = std_irq_setup;
1787 info->slave_addr = ipmb;
1790 if (try_smi_init(info))
1791 cleanup_one_si(info);
1794 struct smi_info *e, *tmp_e;
1796 mutex_lock(&smi_infos_lock);
1797 list_for_each_entry_safe(e, tmp_e, &smi_infos, link) {
1798 if (e->io.addr_type != addr_space)
1800 if (e->si_type != si_type)
1802 if (e->io.addr_data == addr)
1805 mutex_unlock(&smi_infos_lock);
1814 static __devinit void hardcode_find_bmc(void)
1817 struct smi_info *info;
1819 for (i = 0; i < SI_MAX_PARMS; i++) {
1820 if (!ports[i] && !addrs[i])
1823 info = kzalloc(sizeof(*info), GFP_KERNEL);
1827 info->addr_source = SI_HARDCODED;
1829 if (!si_type[i] || strcmp(si_type[i], "kcs") == 0) {
1830 info->si_type = SI_KCS;
1831 } else if (strcmp(si_type[i], "smic") == 0) {
1832 info->si_type = SI_SMIC;
1833 } else if (strcmp(si_type[i], "bt") == 0) {
1834 info->si_type = SI_BT;
1837 "ipmi_si: Interface type specified "
1838 "for interface %d, was invalid: %s\n",
1846 info->io_setup = port_setup;
1847 info->io.addr_data = ports[i];
1848 info->io.addr_type = IPMI_IO_ADDR_SPACE;
1849 } else if (addrs[i]) {
1851 info->io_setup = mem_setup;
1852 info->io.addr_data = addrs[i];
1853 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
1856 "ipmi_si: Interface type specified "
1857 "for interface %d, "
1858 "but port and address were not set or "
1859 "set to zero.\n", i);
1864 info->io.addr = NULL;
1865 info->io.regspacing = regspacings[i];
1866 if (!info->io.regspacing)
1867 info->io.regspacing = DEFAULT_REGSPACING;
1868 info->io.regsize = regsizes[i];
1869 if (!info->io.regsize)
1870 info->io.regsize = DEFAULT_REGSPACING;
1871 info->io.regshift = regshifts[i];
1872 info->irq = irqs[i];
1874 info->irq_setup = std_irq_setup;
1875 info->slave_addr = slave_addrs[i];
1878 if (try_smi_init(info))
1879 cleanup_one_si(info);
1885 #include <linux/acpi.h>
1888 * Once we get an ACPI failure, we don't try any more, because we go
1889 * through the tables sequentially. Once we don't find a table, there
1892 static int acpi_failure;
1894 /* For GPE-type interrupts. */
1895 static u32 ipmi_acpi_gpe(void *context)
1897 struct smi_info *smi_info = context;
1898 unsigned long flags;
1903 spin_lock_irqsave(&(smi_info->si_lock), flags);
1905 smi_inc_stat(smi_info, interrupts);
1908 do_gettimeofday(&t);
1909 printk("**ACPI_GPE: %d.%9.9d\n", t.tv_sec, t.tv_usec);
1911 smi_event_handler(smi_info, 0);
1912 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1914 return ACPI_INTERRUPT_HANDLED;
1917 static void acpi_gpe_irq_cleanup(struct smi_info *info)
1922 acpi_remove_gpe_handler(NULL, info->irq, &ipmi_acpi_gpe);
1925 static int acpi_gpe_irq_setup(struct smi_info *info)
1932 /* FIXME - is level triggered right? */
1933 status = acpi_install_gpe_handler(NULL,
1935 ACPI_GPE_LEVEL_TRIGGERED,
1938 if (status != AE_OK) {
1940 "ipmi_si: %s unable to claim ACPI GPE %d,"
1941 " running polled\n",
1942 DEVICE_NAME, info->irq);
1946 info->irq_cleanup = acpi_gpe_irq_cleanup;
1947 printk(" Using ACPI GPE %d\n", info->irq);
1954 * http://h21007.www2.hp.com/dspp/files/unprotected/devresource/
1955 * Docs/TechPapers/IA64/hpspmi.pdf
1966 s8 CreatorRevision[4];
1969 s16 SpecificationRevision;
1972 * Bit 0 - SCI interrupt supported
1973 * Bit 1 - I/O APIC/SAPIC
1978 * If bit 0 of InterruptType is set, then this is the SCI
1979 * interrupt in the GPEx_STS register.
1986 * If bit 1 of InterruptType is set, then this is the I/O
1987 * APIC/SAPIC interrupt.
1989 u32 GlobalSystemInterrupt;
1991 /* The actual register address. */
1992 struct acpi_generic_address addr;
1996 s8 spmi_id[1]; /* A '\0' terminated array starts here. */
1999 static __devinit int try_init_spmi(struct SPMITable *spmi)
2001 struct smi_info *info;
2004 if (spmi->IPMIlegacy != 1) {
2005 printk(KERN_INFO "IPMI: Bad SPMI legacy %d\n", spmi->IPMIlegacy);
2009 if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY)
2010 addr_space = IPMI_MEM_ADDR_SPACE;
2012 addr_space = IPMI_IO_ADDR_SPACE;
2014 info = kzalloc(sizeof(*info), GFP_KERNEL);
2016 printk(KERN_ERR "ipmi_si: Could not allocate SI data (3)\n");
2020 info->addr_source = SI_SPMI;
2022 /* Figure out the interface type. */
2023 switch (spmi->InterfaceType) {
2025 info->si_type = SI_KCS;
2028 info->si_type = SI_SMIC;
2031 info->si_type = SI_BT;
2034 printk(KERN_INFO "ipmi_si: Unknown ACPI/SPMI SI type %d\n",
2035 spmi->InterfaceType);
2040 if (spmi->InterruptType & 1) {
2041 /* We've got a GPE interrupt. */
2042 info->irq = spmi->GPE;
2043 info->irq_setup = acpi_gpe_irq_setup;
2044 } else if (spmi->InterruptType & 2) {
2045 /* We've got an APIC/SAPIC interrupt. */
2046 info->irq = spmi->GlobalSystemInterrupt;
2047 info->irq_setup = std_irq_setup;
2049 /* Use the default interrupt setting. */
2051 info->irq_setup = NULL;
2054 if (spmi->addr.bit_width) {
2055 /* A (hopefully) properly formed register bit width. */
2056 info->io.regspacing = spmi->addr.bit_width / 8;
2058 info->io.regspacing = DEFAULT_REGSPACING;
2060 info->io.regsize = info->io.regspacing;
2061 info->io.regshift = spmi->addr.bit_offset;
2063 if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
2064 info->io_setup = mem_setup;
2065 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2066 } else if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
2067 info->io_setup = port_setup;
2068 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2072 "ipmi_si: Unknown ACPI I/O Address type\n");
2075 info->io.addr_data = spmi->addr.address;
2082 static __devinit void spmi_find_bmc(void)
2085 struct SPMITable *spmi;
2094 for (i = 0; ; i++) {
2095 status = acpi_get_table(ACPI_SIG_SPMI, i+1,
2096 (struct acpi_table_header **)&spmi);
2097 if (status != AE_OK)
2100 try_init_spmi(spmi);
2104 static int __devinit ipmi_pnp_probe(struct pnp_dev *dev,
2105 const struct pnp_device_id *dev_id)
2107 struct acpi_device *acpi_dev;
2108 struct smi_info *info;
2111 unsigned long long tmp;
2113 acpi_dev = pnp_acpi_device(dev);
2117 info = kzalloc(sizeof(*info), GFP_KERNEL);
2121 info->addr_source = SI_ACPI;
2123 handle = acpi_dev->handle;
2125 /* _IFT tells us the interface type: KCS, BT, etc */
2126 status = acpi_evaluate_integer(handle, "_IFT", NULL, &tmp);
2127 if (ACPI_FAILURE(status))
2132 info->si_type = SI_KCS;
2135 info->si_type = SI_SMIC;
2138 info->si_type = SI_BT;
2141 dev_info(&dev->dev, "unknown interface type %lld\n", tmp);
2145 if (pnp_port_valid(dev, 0)) {
2146 info->io_setup = port_setup;
2147 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2148 info->io.addr_data = pnp_port_start(dev, 0);
2149 } else if (pnp_mem_valid(dev, 0)) {
2150 info->io_setup = mem_setup;
2151 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2152 info->io.addr_data = pnp_mem_start(dev, 0);
2154 dev_err(&dev->dev, "no I/O or memory address\n");
2158 info->io.regspacing = DEFAULT_REGSPACING;
2159 info->io.regsize = DEFAULT_REGSPACING;
2160 info->io.regshift = 0;
2162 /* If _GPE exists, use it; otherwise use standard interrupts */
2163 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
2164 if (ACPI_SUCCESS(status)) {
2166 info->irq_setup = acpi_gpe_irq_setup;
2167 } else if (pnp_irq_valid(dev, 0)) {
2168 info->irq = pnp_irq(dev, 0);
2169 info->irq_setup = std_irq_setup;
2172 info->dev = &acpi_dev->dev;
2173 pnp_set_drvdata(dev, info);
2175 return add_smi(info);
2182 static void __devexit ipmi_pnp_remove(struct pnp_dev *dev)
2184 struct smi_info *info = pnp_get_drvdata(dev);
2186 cleanup_one_si(info);
2189 static const struct pnp_device_id pnp_dev_table[] = {
2194 static struct pnp_driver ipmi_pnp_driver = {
2195 .name = DEVICE_NAME,
2196 .probe = ipmi_pnp_probe,
2197 .remove = __devexit_p(ipmi_pnp_remove),
2198 .id_table = pnp_dev_table,
2203 struct dmi_ipmi_data {
2206 unsigned long base_addr;
2212 static int __devinit decode_dmi(const struct dmi_header *dm,
2213 struct dmi_ipmi_data *dmi)
2215 const u8 *data = (const u8 *)dm;
2216 unsigned long base_addr;
2218 u8 len = dm->length;
2220 dmi->type = data[4];
2222 memcpy(&base_addr, data+8, sizeof(unsigned long));
2224 if (base_addr & 1) {
2226 base_addr &= 0xFFFE;
2227 dmi->addr_space = IPMI_IO_ADDR_SPACE;
2230 dmi->addr_space = IPMI_MEM_ADDR_SPACE;
2232 /* If bit 4 of byte 0x10 is set, then the lsb for the address
2234 dmi->base_addr = base_addr | ((data[0x10] & 0x10) >> 4);
2236 dmi->irq = data[0x11];
2238 /* The top two bits of byte 0x10 hold the register spacing. */
2239 reg_spacing = (data[0x10] & 0xC0) >> 6;
2240 switch (reg_spacing) {
2241 case 0x00: /* Byte boundaries */
2244 case 0x01: /* 32-bit boundaries */
2247 case 0x02: /* 16-byte boundaries */
2251 /* Some other interface, just ignore it. */
2257 * Note that technically, the lower bit of the base
2258 * address should be 1 if the address is I/O and 0 if
2259 * the address is in memory. So many systems get that
2260 * wrong (and all that I have seen are I/O) so we just
2261 * ignore that bit and assume I/O. Systems that use
2262 * memory should use the newer spec, anyway.
2264 dmi->base_addr = base_addr & 0xfffe;
2265 dmi->addr_space = IPMI_IO_ADDR_SPACE;
2269 dmi->slave_addr = data[6];
2274 static __devinit void try_init_dmi(struct dmi_ipmi_data *ipmi_data)
2276 struct smi_info *info;
2278 info = kzalloc(sizeof(*info), GFP_KERNEL);
2281 "ipmi_si: Could not allocate SI data\n");
2285 info->addr_source = SI_SMBIOS;
2287 switch (ipmi_data->type) {
2288 case 0x01: /* KCS */
2289 info->si_type = SI_KCS;
2291 case 0x02: /* SMIC */
2292 info->si_type = SI_SMIC;
2295 info->si_type = SI_BT;
2302 switch (ipmi_data->addr_space) {
2303 case IPMI_MEM_ADDR_SPACE:
2304 info->io_setup = mem_setup;
2305 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2308 case IPMI_IO_ADDR_SPACE:
2309 info->io_setup = port_setup;
2310 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2316 "ipmi_si: Unknown SMBIOS I/O Address type: %d.\n",
2317 ipmi_data->addr_space);
2320 info->io.addr_data = ipmi_data->base_addr;
2322 info->io.regspacing = ipmi_data->offset;
2323 if (!info->io.regspacing)
2324 info->io.regspacing = DEFAULT_REGSPACING;
2325 info->io.regsize = DEFAULT_REGSPACING;
2326 info->io.regshift = 0;
2328 info->slave_addr = ipmi_data->slave_addr;
2330 info->irq = ipmi_data->irq;
2332 info->irq_setup = std_irq_setup;
2337 static void __devinit dmi_find_bmc(void)
2339 const struct dmi_device *dev = NULL;
2340 struct dmi_ipmi_data data;
2343 while ((dev = dmi_find_device(DMI_DEV_TYPE_IPMI, NULL, dev))) {
2344 memset(&data, 0, sizeof(data));
2345 rv = decode_dmi((const struct dmi_header *) dev->device_data,
2348 try_init_dmi(&data);
2351 #endif /* CONFIG_DMI */
2355 #define PCI_ERMC_CLASSCODE 0x0C0700
2356 #define PCI_ERMC_CLASSCODE_MASK 0xffffff00
2357 #define PCI_ERMC_CLASSCODE_TYPE_MASK 0xff
2358 #define PCI_ERMC_CLASSCODE_TYPE_SMIC 0x00
2359 #define PCI_ERMC_CLASSCODE_TYPE_KCS 0x01
2360 #define PCI_ERMC_CLASSCODE_TYPE_BT 0x02
2362 #define PCI_HP_VENDOR_ID 0x103C
2363 #define PCI_MMC_DEVICE_ID 0x121A
2364 #define PCI_MMC_ADDR_CW 0x10
2366 static void ipmi_pci_cleanup(struct smi_info *info)
2368 struct pci_dev *pdev = info->addr_source_data;
2370 pci_disable_device(pdev);
2373 static int __devinit ipmi_pci_probe(struct pci_dev *pdev,
2374 const struct pci_device_id *ent)
2377 int class_type = pdev->class & PCI_ERMC_CLASSCODE_TYPE_MASK;
2378 struct smi_info *info;
2380 info = kzalloc(sizeof(*info), GFP_KERNEL);
2384 info->addr_source = SI_PCI;
2386 switch (class_type) {
2387 case PCI_ERMC_CLASSCODE_TYPE_SMIC:
2388 info->si_type = SI_SMIC;
2391 case PCI_ERMC_CLASSCODE_TYPE_KCS:
2392 info->si_type = SI_KCS;
2395 case PCI_ERMC_CLASSCODE_TYPE_BT:
2396 info->si_type = SI_BT;
2401 printk(KERN_INFO "ipmi_si: %s: Unknown IPMI type: %d\n",
2402 pci_name(pdev), class_type);
2406 rv = pci_enable_device(pdev);
2408 printk(KERN_ERR "ipmi_si: %s: couldn't enable PCI device\n",
2414 info->addr_source_cleanup = ipmi_pci_cleanup;
2415 info->addr_source_data = pdev;
2417 if (pci_resource_flags(pdev, 0) & IORESOURCE_IO) {
2418 info->io_setup = port_setup;
2419 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2421 info->io_setup = mem_setup;
2422 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2424 info->io.addr_data = pci_resource_start(pdev, 0);
2426 info->io.regspacing = DEFAULT_REGSPACING;
2427 info->io.regsize = DEFAULT_REGSPACING;
2428 info->io.regshift = 0;
2430 info->irq = pdev->irq;
2432 info->irq_setup = std_irq_setup;
2434 info->dev = &pdev->dev;
2435 pci_set_drvdata(pdev, info);
2437 return add_smi(info);
2440 static void __devexit ipmi_pci_remove(struct pci_dev *pdev)
2442 struct smi_info *info = pci_get_drvdata(pdev);
2443 cleanup_one_si(info);
2447 static int ipmi_pci_suspend(struct pci_dev *pdev, pm_message_t state)
2452 static int ipmi_pci_resume(struct pci_dev *pdev)
2458 static struct pci_device_id ipmi_pci_devices[] = {
2459 { PCI_DEVICE(PCI_HP_VENDOR_ID, PCI_MMC_DEVICE_ID) },
2460 { PCI_DEVICE_CLASS(PCI_ERMC_CLASSCODE, PCI_ERMC_CLASSCODE_MASK) },
2463 MODULE_DEVICE_TABLE(pci, ipmi_pci_devices);
2465 static struct pci_driver ipmi_pci_driver = {
2466 .name = DEVICE_NAME,
2467 .id_table = ipmi_pci_devices,
2468 .probe = ipmi_pci_probe,
2469 .remove = __devexit_p(ipmi_pci_remove),
2471 .suspend = ipmi_pci_suspend,
2472 .resume = ipmi_pci_resume,
2475 #endif /* CONFIG_PCI */
2478 #ifdef CONFIG_PPC_OF
2479 static int __devinit ipmi_of_probe(struct of_device *dev,
2480 const struct of_device_id *match)
2482 struct smi_info *info;
2483 struct resource resource;
2484 const int *regsize, *regspacing, *regshift;
2485 struct device_node *np = dev->dev.of_node;
2489 dev_info(&dev->dev, PFX "probing via device tree\n");
2491 ret = of_address_to_resource(np, 0, &resource);
2493 dev_warn(&dev->dev, PFX "invalid address from OF\n");
2497 regsize = of_get_property(np, "reg-size", &proplen);
2498 if (regsize && proplen != 4) {
2499 dev_warn(&dev->dev, PFX "invalid regsize from OF\n");
2503 regspacing = of_get_property(np, "reg-spacing", &proplen);
2504 if (regspacing && proplen != 4) {
2505 dev_warn(&dev->dev, PFX "invalid regspacing from OF\n");
2509 regshift = of_get_property(np, "reg-shift", &proplen);
2510 if (regshift && proplen != 4) {
2511 dev_warn(&dev->dev, PFX "invalid regshift from OF\n");
2515 info = kzalloc(sizeof(*info), GFP_KERNEL);
2519 PFX "could not allocate memory for OF probe\n");
2523 info->si_type = (enum si_type) match->data;
2524 info->addr_source = SI_DEVICETREE;
2525 info->irq_setup = std_irq_setup;
2527 if (resource.flags & IORESOURCE_IO) {
2528 info->io_setup = port_setup;
2529 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2531 info->io_setup = mem_setup;
2532 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2535 info->io.addr_data = resource.start;
2537 info->io.regsize = regsize ? *regsize : DEFAULT_REGSIZE;
2538 info->io.regspacing = regspacing ? *regspacing : DEFAULT_REGSPACING;
2539 info->io.regshift = regshift ? *regshift : 0;
2541 info->irq = irq_of_parse_and_map(dev->dev.of_node, 0);
2542 info->dev = &dev->dev;
2544 dev_dbg(&dev->dev, "addr 0x%lx regsize %d spacing %d irq %x\n",
2545 info->io.addr_data, info->io.regsize, info->io.regspacing,
2548 dev_set_drvdata(&dev->dev, info);
2550 return add_smi(info);
2553 static int __devexit ipmi_of_remove(struct of_device *dev)
2555 cleanup_one_si(dev_get_drvdata(&dev->dev));
2559 static struct of_device_id ipmi_match[] =
2561 { .type = "ipmi", .compatible = "ipmi-kcs",
2562 .data = (void *)(unsigned long) SI_KCS },
2563 { .type = "ipmi", .compatible = "ipmi-smic",
2564 .data = (void *)(unsigned long) SI_SMIC },
2565 { .type = "ipmi", .compatible = "ipmi-bt",
2566 .data = (void *)(unsigned long) SI_BT },
2570 static struct of_platform_driver ipmi_of_platform_driver = {
2573 .owner = THIS_MODULE,
2574 .of_match_table = ipmi_match,
2576 .probe = ipmi_of_probe,
2577 .remove = __devexit_p(ipmi_of_remove),
2579 #endif /* CONFIG_PPC_OF */
2581 static int wait_for_msg_done(struct smi_info *smi_info)
2583 enum si_sm_result smi_result;
2585 smi_result = smi_info->handlers->event(smi_info->si_sm, 0);
2587 if (smi_result == SI_SM_CALL_WITH_DELAY ||
2588 smi_result == SI_SM_CALL_WITH_TICK_DELAY) {
2589 schedule_timeout_uninterruptible(1);
2590 smi_result = smi_info->handlers->event(
2591 smi_info->si_sm, 100);
2592 } else if (smi_result == SI_SM_CALL_WITHOUT_DELAY) {
2593 smi_result = smi_info->handlers->event(
2594 smi_info->si_sm, 0);
2598 if (smi_result == SI_SM_HOSED)
2600 * We couldn't get the state machine to run, so whatever's at
2601 * the port is probably not an IPMI SMI interface.
2608 static int try_get_dev_id(struct smi_info *smi_info)
2610 unsigned char msg[2];
2611 unsigned char *resp;
2612 unsigned long resp_len;
2615 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
2620 * Do a Get Device ID command, since it comes back with some
2623 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2624 msg[1] = IPMI_GET_DEVICE_ID_CMD;
2625 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
2627 rv = wait_for_msg_done(smi_info);
2631 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2632 resp, IPMI_MAX_MSG_LENGTH);
2634 /* Check and record info from the get device id, in case we need it. */
2635 rv = ipmi_demangle_device_id(resp, resp_len, &smi_info->device_id);
2642 static int try_enable_event_buffer(struct smi_info *smi_info)
2644 unsigned char msg[3];
2645 unsigned char *resp;
2646 unsigned long resp_len;
2649 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
2653 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2654 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
2655 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
2657 rv = wait_for_msg_done(smi_info);
2660 "ipmi_si: Error getting response from get global,"
2661 " enables command, the event buffer is not"
2666 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2667 resp, IPMI_MAX_MSG_LENGTH);
2670 resp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2 ||
2671 resp[1] != IPMI_GET_BMC_GLOBAL_ENABLES_CMD ||
2674 "ipmi_si: Invalid return from get global"
2675 " enables command, cannot enable the event"
2681 if (resp[3] & IPMI_BMC_EVT_MSG_BUFF)
2682 /* buffer is already enabled, nothing to do. */
2685 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2686 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
2687 msg[2] = resp[3] | IPMI_BMC_EVT_MSG_BUFF;
2688 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 3);
2690 rv = wait_for_msg_done(smi_info);
2693 "ipmi_si: Error getting response from set global,"
2694 " enables command, the event buffer is not"
2699 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2700 resp, IPMI_MAX_MSG_LENGTH);
2703 resp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2 ||
2704 resp[1] != IPMI_SET_BMC_GLOBAL_ENABLES_CMD) {
2706 "ipmi_si: Invalid return from get global,"
2707 "enables command, not enable the event"
2715 * An error when setting the event buffer bit means
2716 * that the event buffer is not supported.
2724 static int type_file_read_proc(char *page, char **start, off_t off,
2725 int count, int *eof, void *data)
2727 struct smi_info *smi = data;
2729 return sprintf(page, "%s\n", si_to_str[smi->si_type]);
2732 static int stat_file_read_proc(char *page, char **start, off_t off,
2733 int count, int *eof, void *data)
2735 char *out = (char *) page;
2736 struct smi_info *smi = data;
2738 out += sprintf(out, "interrupts_enabled: %d\n",
2739 smi->irq && !smi->interrupt_disabled);
2740 out += sprintf(out, "short_timeouts: %u\n",
2741 smi_get_stat(smi, short_timeouts));
2742 out += sprintf(out, "long_timeouts: %u\n",
2743 smi_get_stat(smi, long_timeouts));
2744 out += sprintf(out, "idles: %u\n",
2745 smi_get_stat(smi, idles));
2746 out += sprintf(out, "interrupts: %u\n",
2747 smi_get_stat(smi, interrupts));
2748 out += sprintf(out, "attentions: %u\n",
2749 smi_get_stat(smi, attentions));
2750 out += sprintf(out, "flag_fetches: %u\n",
2751 smi_get_stat(smi, flag_fetches));
2752 out += sprintf(out, "hosed_count: %u\n",
2753 smi_get_stat(smi, hosed_count));
2754 out += sprintf(out, "complete_transactions: %u\n",
2755 smi_get_stat(smi, complete_transactions));
2756 out += sprintf(out, "events: %u\n",
2757 smi_get_stat(smi, events));
2758 out += sprintf(out, "watchdog_pretimeouts: %u\n",
2759 smi_get_stat(smi, watchdog_pretimeouts));
2760 out += sprintf(out, "incoming_messages: %u\n",
2761 smi_get_stat(smi, incoming_messages));
2766 static int param_read_proc(char *page, char **start, off_t off,
2767 int count, int *eof, void *data)
2769 struct smi_info *smi = data;
2771 return sprintf(page,
2772 "%s,%s,0x%lx,rsp=%d,rsi=%d,rsh=%d,irq=%d,ipmb=%d\n",
2773 si_to_str[smi->si_type],
2774 addr_space_to_str[smi->io.addr_type],
2784 * oem_data_avail_to_receive_msg_avail
2785 * @info - smi_info structure with msg_flags set
2787 * Converts flags from OEM_DATA_AVAIL to RECEIVE_MSG_AVAIL
2788 * Returns 1 indicating need to re-run handle_flags().
2790 static int oem_data_avail_to_receive_msg_avail(struct smi_info *smi_info)
2792 smi_info->msg_flags = ((smi_info->msg_flags & ~OEM_DATA_AVAIL) |
2798 * setup_dell_poweredge_oem_data_handler
2799 * @info - smi_info.device_id must be populated
2801 * Systems that match, but have firmware version < 1.40 may assert
2802 * OEM0_DATA_AVAIL on their own, without being told via Set Flags that
2803 * it's safe to do so. Such systems will de-assert OEM1_DATA_AVAIL
2804 * upon receipt of IPMI_GET_MSG_CMD, so we should treat these flags
2805 * as RECEIVE_MSG_AVAIL instead.
2807 * As Dell has no plans to release IPMI 1.5 firmware that *ever*
2808 * assert the OEM[012] bits, and if it did, the driver would have to
2809 * change to handle that properly, we don't actually check for the
2811 * Device ID = 0x20 BMC on PowerEdge 8G servers
2812 * Device Revision = 0x80
2813 * Firmware Revision1 = 0x01 BMC version 1.40
2814 * Firmware Revision2 = 0x40 BCD encoded
2815 * IPMI Version = 0x51 IPMI 1.5
2816 * Manufacturer ID = A2 02 00 Dell IANA
2818 * Additionally, PowerEdge systems with IPMI < 1.5 may also assert
2819 * OEM0_DATA_AVAIL and needs to be treated as RECEIVE_MSG_AVAIL.
2822 #define DELL_POWEREDGE_8G_BMC_DEVICE_ID 0x20
2823 #define DELL_POWEREDGE_8G_BMC_DEVICE_REV 0x80
2824 #define DELL_POWEREDGE_8G_BMC_IPMI_VERSION 0x51
2825 #define DELL_IANA_MFR_ID 0x0002a2
2826 static void setup_dell_poweredge_oem_data_handler(struct smi_info *smi_info)
2828 struct ipmi_device_id *id = &smi_info->device_id;
2829 if (id->manufacturer_id == DELL_IANA_MFR_ID) {
2830 if (id->device_id == DELL_POWEREDGE_8G_BMC_DEVICE_ID &&
2831 id->device_revision == DELL_POWEREDGE_8G_BMC_DEVICE_REV &&
2832 id->ipmi_version == DELL_POWEREDGE_8G_BMC_IPMI_VERSION) {
2833 smi_info->oem_data_avail_handler =
2834 oem_data_avail_to_receive_msg_avail;
2835 } else if (ipmi_version_major(id) < 1 ||
2836 (ipmi_version_major(id) == 1 &&
2837 ipmi_version_minor(id) < 5)) {
2838 smi_info->oem_data_avail_handler =
2839 oem_data_avail_to_receive_msg_avail;
2844 #define CANNOT_RETURN_REQUESTED_LENGTH 0xCA
2845 static void return_hosed_msg_badsize(struct smi_info *smi_info)
2847 struct ipmi_smi_msg *msg = smi_info->curr_msg;
2849 /* Make it a reponse */
2850 msg->rsp[0] = msg->data[0] | 4;
2851 msg->rsp[1] = msg->data[1];
2852 msg->rsp[2] = CANNOT_RETURN_REQUESTED_LENGTH;
2854 smi_info->curr_msg = NULL;
2855 deliver_recv_msg(smi_info, msg);
2859 * dell_poweredge_bt_xaction_handler
2860 * @info - smi_info.device_id must be populated
2862 * Dell PowerEdge servers with the BT interface (x6xx and 1750) will
2863 * not respond to a Get SDR command if the length of the data
2864 * requested is exactly 0x3A, which leads to command timeouts and no
2865 * data returned. This intercepts such commands, and causes userspace
2866 * callers to try again with a different-sized buffer, which succeeds.
2869 #define STORAGE_NETFN 0x0A
2870 #define STORAGE_CMD_GET_SDR 0x23
2871 static int dell_poweredge_bt_xaction_handler(struct notifier_block *self,
2872 unsigned long unused,
2875 struct smi_info *smi_info = in;
2876 unsigned char *data = smi_info->curr_msg->data;
2877 unsigned int size = smi_info->curr_msg->data_size;
2879 (data[0]>>2) == STORAGE_NETFN &&
2880 data[1] == STORAGE_CMD_GET_SDR &&
2882 return_hosed_msg_badsize(smi_info);
2888 static struct notifier_block dell_poweredge_bt_xaction_notifier = {
2889 .notifier_call = dell_poweredge_bt_xaction_handler,
2893 * setup_dell_poweredge_bt_xaction_handler
2894 * @info - smi_info.device_id must be filled in already
2896 * Fills in smi_info.device_id.start_transaction_pre_hook
2897 * when we know what function to use there.
2900 setup_dell_poweredge_bt_xaction_handler(struct smi_info *smi_info)
2902 struct ipmi_device_id *id = &smi_info->device_id;
2903 if (id->manufacturer_id == DELL_IANA_MFR_ID &&
2904 smi_info->si_type == SI_BT)
2905 register_xaction_notifier(&dell_poweredge_bt_xaction_notifier);
2909 * setup_oem_data_handler
2910 * @info - smi_info.device_id must be filled in already
2912 * Fills in smi_info.device_id.oem_data_available_handler
2913 * when we know what function to use there.
2916 static void setup_oem_data_handler(struct smi_info *smi_info)
2918 setup_dell_poweredge_oem_data_handler(smi_info);
2921 static void setup_xaction_handlers(struct smi_info *smi_info)
2923 setup_dell_poweredge_bt_xaction_handler(smi_info);
2926 static inline void wait_for_timer_and_thread(struct smi_info *smi_info)
2928 if (smi_info->intf) {
2930 * The timer and thread are only running if the
2931 * interface has been started up and registered.
2933 if (smi_info->thread != NULL)
2934 kthread_stop(smi_info->thread);
2935 del_timer_sync(&smi_info->si_timer);
2939 static __devinitdata struct ipmi_default_vals
2945 { .type = SI_KCS, .port = 0xca2 },
2946 { .type = SI_SMIC, .port = 0xca9 },
2947 { .type = SI_BT, .port = 0xe4 },
2951 static __devinit void default_find_bmc(void)
2953 struct smi_info *info;
2956 for (i = 0; ; i++) {
2957 if (!ipmi_defaults[i].port)
2960 if (check_legacy_ioport(ipmi_defaults[i].port))
2963 info = kzalloc(sizeof(*info), GFP_KERNEL);
2967 info->addr_source = SI_DEFAULT;
2969 info->si_type = ipmi_defaults[i].type;
2970 info->io_setup = port_setup;
2971 info->io.addr_data = ipmi_defaults[i].port;
2972 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2974 info->io.addr = NULL;
2975 info->io.regspacing = DEFAULT_REGSPACING;
2976 info->io.regsize = DEFAULT_REGSPACING;
2977 info->io.regshift = 0;
2979 if (add_smi(info) == 0) {
2980 if ((try_smi_init(info)) == 0) {
2982 printk(KERN_INFO "ipmi_si: Found default %s"
2983 " state machine at %s address 0x%lx\n",
2984 si_to_str[info->si_type],
2985 addr_space_to_str[info->io.addr_type],
2986 info->io.addr_data);
2988 cleanup_one_si(info);
2993 static int is_new_interface(struct smi_info *info)
2997 list_for_each_entry(e, &smi_infos, link) {
2998 if (e->io.addr_type != info->io.addr_type)
3000 if (e->io.addr_data == info->io.addr_data)
3007 static int add_smi(struct smi_info *new_smi)
3011 printk(KERN_INFO "ipmi_si: Adding %s-specified %s state machine",
3012 ipmi_addr_src_to_str[new_smi->addr_source],
3013 si_to_str[new_smi->si_type]);
3014 mutex_lock(&smi_infos_lock);
3015 if (!is_new_interface(new_smi)) {
3016 printk(KERN_CONT ": duplicate interface\n");
3021 printk(KERN_CONT "\n");
3023 /* So we know not to free it unless we have allocated one. */
3024 new_smi->intf = NULL;
3025 new_smi->si_sm = NULL;
3026 new_smi->handlers = NULL;
3028 list_add_tail(&new_smi->link, &smi_infos);
3031 mutex_unlock(&smi_infos_lock);
3035 static int try_smi_init(struct smi_info *new_smi)
3040 printk(KERN_INFO "ipmi_si: Trying %s-specified %s state"
3041 " machine at %s address 0x%lx, slave address 0x%x,"
3043 ipmi_addr_src_to_str[new_smi->addr_source],
3044 si_to_str[new_smi->si_type],
3045 addr_space_to_str[new_smi->io.addr_type],
3046 new_smi->io.addr_data,
3047 new_smi->slave_addr, new_smi->irq);
3049 switch (new_smi->si_type) {
3051 new_smi->handlers = &kcs_smi_handlers;
3055 new_smi->handlers = &smic_smi_handlers;
3059 new_smi->handlers = &bt_smi_handlers;
3063 /* No support for anything else yet. */
3068 /* Allocate the state machine's data and initialize it. */
3069 new_smi->si_sm = kmalloc(new_smi->handlers->size(), GFP_KERNEL);
3070 if (!new_smi->si_sm) {
3071 printk(KERN_ERR "Could not allocate state machine memory\n");
3075 new_smi->io_size = new_smi->handlers->init_data(new_smi->si_sm,
3078 /* Now that we know the I/O size, we can set up the I/O. */
3079 rv = new_smi->io_setup(new_smi);
3081 printk(KERN_ERR "Could not set up I/O space\n");
3085 spin_lock_init(&(new_smi->si_lock));
3086 spin_lock_init(&(new_smi->msg_lock));
3088 /* Do low-level detection first. */
3089 if (new_smi->handlers->detect(new_smi->si_sm)) {
3090 if (new_smi->addr_source)
3091 printk(KERN_INFO "ipmi_si: Interface detection"
3098 * Attempt a get device id command. If it fails, we probably
3099 * don't have a BMC here.
3101 rv = try_get_dev_id(new_smi);
3103 if (new_smi->addr_source)
3104 printk(KERN_INFO "ipmi_si: There appears to be no BMC"
3105 " at this location\n");
3109 setup_oem_data_handler(new_smi);
3110 setup_xaction_handlers(new_smi);
3112 INIT_LIST_HEAD(&(new_smi->xmit_msgs));
3113 INIT_LIST_HEAD(&(new_smi->hp_xmit_msgs));
3114 new_smi->curr_msg = NULL;
3115 atomic_set(&new_smi->req_events, 0);
3116 new_smi->run_to_completion = 0;
3117 for (i = 0; i < SI_NUM_STATS; i++)
3118 atomic_set(&new_smi->stats[i], 0);
3120 new_smi->interrupt_disabled = 0;
3121 atomic_set(&new_smi->stop_operation, 0);
3122 new_smi->intf_num = smi_num;
3125 rv = try_enable_event_buffer(new_smi);
3127 new_smi->has_event_buffer = 1;
3130 * Start clearing the flags before we enable interrupts or the
3131 * timer to avoid racing with the timer.
3133 start_clear_flags(new_smi);
3134 /* IRQ is defined to be set when non-zero. */
3136 new_smi->si_state = SI_CLEARING_FLAGS_THEN_SET_IRQ;
3138 if (!new_smi->dev) {
3140 * If we don't already have a device from something
3141 * else (like PCI), then register a new one.
3143 new_smi->pdev = platform_device_alloc("ipmi_si",
3145 if (!new_smi->pdev) {
3148 " Unable to allocate platform device\n");
3151 new_smi->dev = &new_smi->pdev->dev;
3152 new_smi->dev->driver = &ipmi_driver.driver;
3154 rv = platform_device_add(new_smi->pdev);
3158 " Unable to register system interface device:"
3163 new_smi->dev_registered = 1;
3166 rv = ipmi_register_smi(&handlers,
3168 &new_smi->device_id,
3171 new_smi->slave_addr);
3174 "ipmi_si: Unable to register device: error %d\n",
3176 goto out_err_stop_timer;
3179 rv = ipmi_smi_add_proc_entry(new_smi->intf, "type",
3180 type_file_read_proc,
3184 "ipmi_si: Unable to create proc entry: %d\n",
3186 goto out_err_stop_timer;
3189 rv = ipmi_smi_add_proc_entry(new_smi->intf, "si_stats",
3190 stat_file_read_proc,
3194 "ipmi_si: Unable to create proc entry: %d\n",
3196 goto out_err_stop_timer;
3199 rv = ipmi_smi_add_proc_entry(new_smi->intf, "params",
3204 "ipmi_si: Unable to create proc entry: %d\n",
3206 goto out_err_stop_timer;
3209 printk(KERN_INFO "IPMI %s interface initialized\n",
3210 si_to_str[new_smi->si_type]);
3215 atomic_inc(&new_smi->stop_operation);
3216 wait_for_timer_and_thread(new_smi);
3219 new_smi->interrupt_disabled = 1;
3221 if (new_smi->intf) {
3222 ipmi_unregister_smi(new_smi->intf);
3223 new_smi->intf = NULL;
3226 if (new_smi->irq_cleanup) {
3227 new_smi->irq_cleanup(new_smi);
3228 new_smi->irq_cleanup = NULL;
3232 * Wait until we know that we are out of any interrupt
3233 * handlers might have been running before we freed the
3236 synchronize_sched();
3238 if (new_smi->si_sm) {
3239 if (new_smi->handlers)
3240 new_smi->handlers->cleanup(new_smi->si_sm);
3241 kfree(new_smi->si_sm);
3242 new_smi->si_sm = NULL;
3244 if (new_smi->addr_source_cleanup) {
3245 new_smi->addr_source_cleanup(new_smi);
3246 new_smi->addr_source_cleanup = NULL;
3248 if (new_smi->io_cleanup) {
3249 new_smi->io_cleanup(new_smi);
3250 new_smi->io_cleanup = NULL;
3253 if (new_smi->dev_registered) {
3254 platform_device_unregister(new_smi->pdev);
3255 new_smi->dev_registered = 0;
3261 static __devinit int init_ipmi_si(void)
3272 /* Register the device drivers. */
3273 rv = driver_register(&ipmi_driver.driver);
3276 "init_ipmi_si: Unable to register driver: %d\n",
3282 /* Parse out the si_type string into its components. */
3285 for (i = 0; (i < SI_MAX_PARMS) && (*str != '\0'); i++) {
3287 str = strchr(str, ',');
3297 printk(KERN_INFO "IPMI System Interface driver.\n");
3299 hardcode_find_bmc();
3301 /* If the user gave us a device, they presumably want us to use it */
3302 mutex_lock(&smi_infos_lock);
3303 if (!list_empty(&smi_infos)) {
3304 mutex_unlock(&smi_infos_lock);
3307 mutex_unlock(&smi_infos_lock);
3310 rv = pci_register_driver(&ipmi_pci_driver);
3313 "init_ipmi_si: Unable to register PCI driver: %d\n",
3318 pnp_register_driver(&ipmi_pnp_driver);
3329 #ifdef CONFIG_PPC_OF
3330 of_register_platform_driver(&ipmi_of_platform_driver);
3333 /* Try to register something with interrupts first */
3335 mutex_lock(&smi_infos_lock);
3336 list_for_each_entry(e, &smi_infos, link) {
3338 if (!try_smi_init(e)) {
3339 mutex_unlock(&smi_infos_lock);
3345 /* Fall back to the preferred device */
3347 list_for_each_entry(e, &smi_infos, link) {
3349 if (!try_smi_init(e)) {
3350 mutex_unlock(&smi_infos_lock);
3355 mutex_unlock(&smi_infos_lock);
3357 if (si_trydefaults) {
3358 mutex_lock(&smi_infos_lock);
3359 if (list_empty(&smi_infos)) {
3360 /* No BMC was found, try defaults. */
3361 mutex_unlock(&smi_infos_lock);
3364 mutex_unlock(&smi_infos_lock);
3367 mutex_lock(&smi_infos_lock);
3368 if (unload_when_empty && list_empty(&smi_infos)) {
3369 mutex_unlock(&smi_infos_lock);
3371 pci_unregister_driver(&ipmi_pci_driver);
3374 #ifdef CONFIG_PPC_OF
3375 of_unregister_platform_driver(&ipmi_of_platform_driver);
3377 driver_unregister(&ipmi_driver.driver);
3379 "ipmi_si: Unable to find any System Interface(s)\n");
3382 mutex_unlock(&smi_infos_lock);
3386 module_init(init_ipmi_si);
3388 static void cleanup_one_si(struct smi_info *to_clean)
3391 unsigned long flags;
3396 list_del(&to_clean->link);
3398 /* Tell the driver that we are shutting down. */
3399 atomic_inc(&to_clean->stop_operation);
3402 * Make sure the timer and thread are stopped and will not run
3405 wait_for_timer_and_thread(to_clean);
3408 * Timeouts are stopped, now make sure the interrupts are off
3409 * for the device. A little tricky with locks to make sure
3410 * there are no races.
3412 spin_lock_irqsave(&to_clean->si_lock, flags);
3413 while (to_clean->curr_msg || (to_clean->si_state != SI_NORMAL)) {
3414 spin_unlock_irqrestore(&to_clean->si_lock, flags);
3416 schedule_timeout_uninterruptible(1);
3417 spin_lock_irqsave(&to_clean->si_lock, flags);
3419 disable_si_irq(to_clean);
3420 spin_unlock_irqrestore(&to_clean->si_lock, flags);
3421 while (to_clean->curr_msg || (to_clean->si_state != SI_NORMAL)) {
3423 schedule_timeout_uninterruptible(1);
3426 /* Clean up interrupts and make sure that everything is done. */
3427 if (to_clean->irq_cleanup)
3428 to_clean->irq_cleanup(to_clean);
3429 while (to_clean->curr_msg || (to_clean->si_state != SI_NORMAL)) {
3431 schedule_timeout_uninterruptible(1);
3435 rv = ipmi_unregister_smi(to_clean->intf);
3439 "ipmi_si: Unable to unregister device: errno=%d\n",
3443 if (to_clean->handlers)
3444 to_clean->handlers->cleanup(to_clean->si_sm);
3446 kfree(to_clean->si_sm);
3448 if (to_clean->addr_source_cleanup)
3449 to_clean->addr_source_cleanup(to_clean);
3450 if (to_clean->io_cleanup)
3451 to_clean->io_cleanup(to_clean);
3453 if (to_clean->dev_registered)
3454 platform_device_unregister(to_clean->pdev);
3459 static __exit void cleanup_ipmi_si(void)
3461 struct smi_info *e, *tmp_e;
3467 pci_unregister_driver(&ipmi_pci_driver);
3470 pnp_unregister_driver(&ipmi_pnp_driver);
3473 #ifdef CONFIG_PPC_OF
3474 of_unregister_platform_driver(&ipmi_of_platform_driver);
3477 mutex_lock(&smi_infos_lock);
3478 list_for_each_entry_safe(e, tmp_e, &smi_infos, link)
3480 mutex_unlock(&smi_infos_lock);
3482 driver_unregister(&ipmi_driver.driver);
3484 module_exit(cleanup_ipmi_si);
3486 MODULE_LICENSE("GPL");
3487 MODULE_AUTHOR("Corey Minyard <minyard@mvista.com>");
3488 MODULE_DESCRIPTION("Interface to the IPMI driver for the KCS, SMIC, and BT"
3489 " system interfaces.");