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 <linux/sched.h>
45 #include <linux/seq_file.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.h>
61 #include <linux/ipmi_smi.h>
63 #include "ipmi_si_sm.h"
64 #include <linux/dmi.h>
65 #include <linux/string.h>
66 #include <linux/ctype.h>
67 #include <linux/of_device.h>
68 #include <linux/of_platform.h>
69 #include <linux/of_address.h>
70 #include <linux/of_irq.h>
73 #include <asm/hardware.h> /* for register_parisc_driver() stuff */
74 #include <asm/parisc-device.h>
77 #define PFX "ipmi_si: "
79 /* Measure times between events in the driver. */
82 /* Call every 10 ms. */
83 #define SI_TIMEOUT_TIME_USEC 10000
84 #define SI_USEC_PER_JIFFY (1000000/HZ)
85 #define SI_TIMEOUT_JIFFIES (SI_TIMEOUT_TIME_USEC/SI_USEC_PER_JIFFY)
86 #define SI_SHORT_TIMEOUT_USEC 250 /* .25ms when the SM request a
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" };
110 #define DEVICE_NAME "ipmi_si"
112 static struct platform_driver ipmi_driver;
115 * Indexes into stats[] in smi_info below.
117 enum si_stat_indexes {
119 * Number of times the driver requested a timer while an operation
122 SI_STAT_short_timeouts = 0,
125 * Number of times the driver requested a timer while nothing was in
128 SI_STAT_long_timeouts,
130 /* Number of times the interface was idle while being polled. */
133 /* Number of interrupts the driver handled. */
136 /* Number of time the driver got an ATTN from the hardware. */
139 /* Number of times the driver requested flags from the hardware. */
140 SI_STAT_flag_fetches,
142 /* Number of times the hardware didn't follow the state machine. */
145 /* Number of completed messages. */
146 SI_STAT_complete_transactions,
148 /* Number of IPMI events received from the hardware. */
151 /* Number of watchdog pretimeouts. */
152 SI_STAT_watchdog_pretimeouts,
154 /* Number of asynchronous messages received. */
155 SI_STAT_incoming_messages,
158 /* This *must* remain last, add new values above this. */
165 struct si_sm_data *si_sm;
166 const struct si_sm_handlers *handlers;
167 enum si_type si_type;
169 struct ipmi_smi_msg *waiting_msg;
170 struct ipmi_smi_msg *curr_msg;
171 enum si_intf_state si_state;
174 * Used to handle the various types of I/O that can occur with
178 int (*io_setup)(struct smi_info *info);
179 void (*io_cleanup)(struct smi_info *info);
180 int (*irq_setup)(struct smi_info *info);
181 void (*irq_cleanup)(struct smi_info *info);
182 unsigned int io_size;
183 enum ipmi_addr_src addr_source; /* ACPI, PCI, SMBIOS, hardcode, etc. */
184 void (*addr_source_cleanup)(struct smi_info *info);
185 void *addr_source_data;
188 * Per-OEM handler, called from handle_flags(). Returns 1
189 * when handle_flags() needs to be re-run or 0 indicating it
190 * set si_state itself.
192 int (*oem_data_avail_handler)(struct smi_info *smi_info);
195 * Flags from the last GET_MSG_FLAGS command, used when an ATTN
196 * is set to hold the flags until we are done handling everything
199 #define RECEIVE_MSG_AVAIL 0x01
200 #define EVENT_MSG_BUFFER_FULL 0x02
201 #define WDT_PRE_TIMEOUT_INT 0x08
202 #define OEM0_DATA_AVAIL 0x20
203 #define OEM1_DATA_AVAIL 0x40
204 #define OEM2_DATA_AVAIL 0x80
205 #define OEM_DATA_AVAIL (OEM0_DATA_AVAIL | \
208 unsigned char msg_flags;
210 /* Does the BMC have an event buffer? */
211 bool has_event_buffer;
214 * If set to true, this will request events the next time the
215 * state machine is idle.
220 * If true, run the state machine to completion on every send
221 * call. Generally used after a panic to make sure stuff goes
224 bool run_to_completion;
226 /* The I/O port of an SI interface. */
230 * The space between start addresses of the two ports. For
231 * instance, if the first port is 0xca2 and the spacing is 4, then
232 * the second port is 0xca6.
234 unsigned int spacing;
236 /* zero if no irq; */
239 /* The timer for this si. */
240 struct timer_list si_timer;
242 /* This flag is set, if the timer is running (timer_pending() isn't enough) */
245 /* The time (in jiffies) the last timeout occurred at. */
246 unsigned long last_timeout_jiffies;
248 /* Are we waiting for the events, pretimeouts, received msgs? */
252 * The driver will disable interrupts when it gets into a
253 * situation where it cannot handle messages due to lack of
254 * memory. Once that situation clears up, it will re-enable
257 bool interrupt_disabled;
260 * Does the BMC support events?
262 bool supports_event_msg_buff;
265 * Can we disable interrupts the global enables receive irq
266 * bit? There are currently two forms of brokenness, some
267 * systems cannot disable the bit (which is technically within
268 * the spec but a bad idea) and some systems have the bit
269 * forced to zero even though interrupts work (which is
270 * clearly outside the spec). The next bool tells which form
271 * of brokenness is present.
273 bool cannot_disable_irq;
276 * Some systems are broken and cannot set the irq enable
277 * bit, even if they support interrupts.
279 bool irq_enable_broken;
282 * Did we get an attention that we did not handle?
286 /* From the get device id response... */
287 struct ipmi_device_id device_id;
289 /* Driver model stuff. */
291 struct platform_device *pdev;
294 * True if we allocated the device, false if it came from
295 * someplace else (like PCI).
299 /* Slave address, could be reported from DMI. */
300 unsigned char slave_addr;
302 /* Counters and things for the proc filesystem. */
303 atomic_t stats[SI_NUM_STATS];
305 struct task_struct *thread;
307 struct list_head link;
308 union ipmi_smi_info_union addr_info;
311 #define smi_inc_stat(smi, stat) \
312 atomic_inc(&(smi)->stats[SI_STAT_ ## stat])
313 #define smi_get_stat(smi, stat) \
314 ((unsigned int) atomic_read(&(smi)->stats[SI_STAT_ ## stat]))
316 #define SI_MAX_PARMS 4
318 static int force_kipmid[SI_MAX_PARMS];
319 static int num_force_kipmid;
321 static bool pci_registered;
324 static bool parisc_registered;
327 static unsigned int kipmid_max_busy_us[SI_MAX_PARMS];
328 static int num_max_busy_us;
330 static bool unload_when_empty = true;
332 static int add_smi(struct smi_info *smi);
333 static int try_smi_init(struct smi_info *smi);
334 static void cleanup_one_si(struct smi_info *to_clean);
335 static void cleanup_ipmi_si(void);
338 void debug_timestamp(char *msg)
342 getnstimeofday64(&t);
343 pr_debug("**%s: %lld.%9.9ld\n", msg, (long long) t.tv_sec, t.tv_nsec);
346 #define debug_timestamp(x)
349 static ATOMIC_NOTIFIER_HEAD(xaction_notifier_list);
350 static int register_xaction_notifier(struct notifier_block *nb)
352 return atomic_notifier_chain_register(&xaction_notifier_list, nb);
355 static void deliver_recv_msg(struct smi_info *smi_info,
356 struct ipmi_smi_msg *msg)
358 /* Deliver the message to the upper layer. */
360 ipmi_smi_msg_received(smi_info->intf, msg);
362 ipmi_free_smi_msg(msg);
365 static void return_hosed_msg(struct smi_info *smi_info, int cCode)
367 struct ipmi_smi_msg *msg = smi_info->curr_msg;
369 if (cCode < 0 || cCode > IPMI_ERR_UNSPECIFIED)
370 cCode = IPMI_ERR_UNSPECIFIED;
371 /* else use it as is */
373 /* Make it a response */
374 msg->rsp[0] = msg->data[0] | 4;
375 msg->rsp[1] = msg->data[1];
379 smi_info->curr_msg = NULL;
380 deliver_recv_msg(smi_info, msg);
383 static enum si_sm_result start_next_msg(struct smi_info *smi_info)
387 if (!smi_info->waiting_msg) {
388 smi_info->curr_msg = NULL;
393 smi_info->curr_msg = smi_info->waiting_msg;
394 smi_info->waiting_msg = NULL;
395 debug_timestamp("Start2");
396 err = atomic_notifier_call_chain(&xaction_notifier_list,
398 if (err & NOTIFY_STOP_MASK) {
399 rv = SI_SM_CALL_WITHOUT_DELAY;
402 err = smi_info->handlers->start_transaction(
404 smi_info->curr_msg->data,
405 smi_info->curr_msg->data_size);
407 return_hosed_msg(smi_info, err);
409 rv = SI_SM_CALL_WITHOUT_DELAY;
415 static void start_check_enables(struct smi_info *smi_info)
417 unsigned char msg[2];
419 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
420 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
422 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
423 smi_info->si_state = SI_CHECKING_ENABLES;
426 static void start_clear_flags(struct smi_info *smi_info)
428 unsigned char msg[3];
430 /* Make sure the watchdog pre-timeout flag is not set at startup. */
431 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
432 msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
433 msg[2] = WDT_PRE_TIMEOUT_INT;
435 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 3);
436 smi_info->si_state = SI_CLEARING_FLAGS;
439 static void start_getting_msg_queue(struct smi_info *smi_info)
441 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
442 smi_info->curr_msg->data[1] = IPMI_GET_MSG_CMD;
443 smi_info->curr_msg->data_size = 2;
445 smi_info->handlers->start_transaction(
447 smi_info->curr_msg->data,
448 smi_info->curr_msg->data_size);
449 smi_info->si_state = SI_GETTING_MESSAGES;
452 static void start_getting_events(struct smi_info *smi_info)
454 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
455 smi_info->curr_msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
456 smi_info->curr_msg->data_size = 2;
458 smi_info->handlers->start_transaction(
460 smi_info->curr_msg->data,
461 smi_info->curr_msg->data_size);
462 smi_info->si_state = SI_GETTING_EVENTS;
465 static void smi_mod_timer(struct smi_info *smi_info, unsigned long new_val)
467 smi_info->last_timeout_jiffies = jiffies;
468 mod_timer(&smi_info->si_timer, new_val);
469 smi_info->timer_running = true;
473 * When we have a situtaion where we run out of memory and cannot
474 * allocate messages, we just leave them in the BMC and run the system
475 * polled until we can allocate some memory. Once we have some
476 * memory, we will re-enable the interrupt.
478 * Note that we cannot just use disable_irq(), since the interrupt may
481 static inline bool disable_si_irq(struct smi_info *smi_info)
483 if ((smi_info->irq) && (!smi_info->interrupt_disabled)) {
484 smi_info->interrupt_disabled = true;
485 start_check_enables(smi_info);
491 static inline bool enable_si_irq(struct smi_info *smi_info)
493 if ((smi_info->irq) && (smi_info->interrupt_disabled)) {
494 smi_info->interrupt_disabled = false;
495 start_check_enables(smi_info);
502 * Allocate a message. If unable to allocate, start the interrupt
503 * disable process and return NULL. If able to allocate but
504 * interrupts are disabled, free the message and return NULL after
505 * starting the interrupt enable process.
507 static struct ipmi_smi_msg *alloc_msg_handle_irq(struct smi_info *smi_info)
509 struct ipmi_smi_msg *msg;
511 msg = ipmi_alloc_smi_msg();
513 if (!disable_si_irq(smi_info))
514 smi_info->si_state = SI_NORMAL;
515 } else if (enable_si_irq(smi_info)) {
516 ipmi_free_smi_msg(msg);
522 static void handle_flags(struct smi_info *smi_info)
525 if (smi_info->msg_flags & WDT_PRE_TIMEOUT_INT) {
526 /* Watchdog pre-timeout */
527 smi_inc_stat(smi_info, watchdog_pretimeouts);
529 start_clear_flags(smi_info);
530 smi_info->msg_flags &= ~WDT_PRE_TIMEOUT_INT;
532 ipmi_smi_watchdog_pretimeout(smi_info->intf);
533 } else if (smi_info->msg_flags & RECEIVE_MSG_AVAIL) {
534 /* Messages available. */
535 smi_info->curr_msg = alloc_msg_handle_irq(smi_info);
536 if (!smi_info->curr_msg)
539 start_getting_msg_queue(smi_info);
540 } else if (smi_info->msg_flags & EVENT_MSG_BUFFER_FULL) {
541 /* Events available. */
542 smi_info->curr_msg = alloc_msg_handle_irq(smi_info);
543 if (!smi_info->curr_msg)
546 start_getting_events(smi_info);
547 } else if (smi_info->msg_flags & OEM_DATA_AVAIL &&
548 smi_info->oem_data_avail_handler) {
549 if (smi_info->oem_data_avail_handler(smi_info))
552 smi_info->si_state = SI_NORMAL;
556 * Global enables we care about.
558 #define GLOBAL_ENABLES_MASK (IPMI_BMC_EVT_MSG_BUFF | IPMI_BMC_RCV_MSG_INTR | \
559 IPMI_BMC_EVT_MSG_INTR)
561 static u8 current_global_enables(struct smi_info *smi_info, u8 base,
566 if (smi_info->supports_event_msg_buff)
567 enables |= IPMI_BMC_EVT_MSG_BUFF;
569 if (((smi_info->irq && !smi_info->interrupt_disabled) ||
570 smi_info->cannot_disable_irq) &&
571 !smi_info->irq_enable_broken)
572 enables |= IPMI_BMC_RCV_MSG_INTR;
574 if (smi_info->supports_event_msg_buff &&
575 smi_info->irq && !smi_info->interrupt_disabled &&
576 !smi_info->irq_enable_broken)
577 enables |= IPMI_BMC_EVT_MSG_INTR;
579 *irq_on = enables & (IPMI_BMC_EVT_MSG_INTR | IPMI_BMC_RCV_MSG_INTR);
584 static void check_bt_irq(struct smi_info *smi_info, bool irq_on)
586 u8 irqstate = smi_info->io.inputb(&smi_info->io, IPMI_BT_INTMASK_REG);
588 irqstate &= IPMI_BT_INTMASK_ENABLE_IRQ_BIT;
590 if ((bool)irqstate == irq_on)
594 smi_info->io.outputb(&smi_info->io, IPMI_BT_INTMASK_REG,
595 IPMI_BT_INTMASK_ENABLE_IRQ_BIT);
597 smi_info->io.outputb(&smi_info->io, IPMI_BT_INTMASK_REG, 0);
600 static void handle_transaction_done(struct smi_info *smi_info)
602 struct ipmi_smi_msg *msg;
604 debug_timestamp("Done");
605 switch (smi_info->si_state) {
607 if (!smi_info->curr_msg)
610 smi_info->curr_msg->rsp_size
611 = smi_info->handlers->get_result(
613 smi_info->curr_msg->rsp,
614 IPMI_MAX_MSG_LENGTH);
617 * Do this here becase deliver_recv_msg() releases the
618 * lock, and a new message can be put in during the
619 * time the lock is released.
621 msg = smi_info->curr_msg;
622 smi_info->curr_msg = NULL;
623 deliver_recv_msg(smi_info, msg);
626 case SI_GETTING_FLAGS:
628 unsigned char msg[4];
631 /* We got the flags from the SMI, now handle them. */
632 len = smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
634 /* Error fetching flags, just give up for now. */
635 smi_info->si_state = SI_NORMAL;
636 } else if (len < 4) {
638 * Hmm, no flags. That's technically illegal, but
639 * don't use uninitialized data.
641 smi_info->si_state = SI_NORMAL;
643 smi_info->msg_flags = msg[3];
644 handle_flags(smi_info);
649 case SI_CLEARING_FLAGS:
651 unsigned char msg[3];
653 /* We cleared the flags. */
654 smi_info->handlers->get_result(smi_info->si_sm, msg, 3);
656 /* Error clearing flags */
657 dev_warn(smi_info->dev,
658 "Error clearing flags: %2.2x\n", msg[2]);
660 smi_info->si_state = SI_NORMAL;
664 case SI_GETTING_EVENTS:
666 smi_info->curr_msg->rsp_size
667 = smi_info->handlers->get_result(
669 smi_info->curr_msg->rsp,
670 IPMI_MAX_MSG_LENGTH);
673 * Do this here becase deliver_recv_msg() releases the
674 * lock, and a new message can be put in during the
675 * time the lock is released.
677 msg = smi_info->curr_msg;
678 smi_info->curr_msg = NULL;
679 if (msg->rsp[2] != 0) {
680 /* Error getting event, probably done. */
683 /* Take off the event flag. */
684 smi_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
685 handle_flags(smi_info);
687 smi_inc_stat(smi_info, events);
690 * Do this before we deliver the message
691 * because delivering the message releases the
692 * lock and something else can mess with the
695 handle_flags(smi_info);
697 deliver_recv_msg(smi_info, msg);
702 case SI_GETTING_MESSAGES:
704 smi_info->curr_msg->rsp_size
705 = smi_info->handlers->get_result(
707 smi_info->curr_msg->rsp,
708 IPMI_MAX_MSG_LENGTH);
711 * Do this here becase deliver_recv_msg() releases the
712 * lock, and a new message can be put in during the
713 * time the lock is released.
715 msg = smi_info->curr_msg;
716 smi_info->curr_msg = NULL;
717 if (msg->rsp[2] != 0) {
718 /* Error getting event, probably done. */
721 /* Take off the msg flag. */
722 smi_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
723 handle_flags(smi_info);
725 smi_inc_stat(smi_info, incoming_messages);
728 * Do this before we deliver the message
729 * because delivering the message releases the
730 * lock and something else can mess with the
733 handle_flags(smi_info);
735 deliver_recv_msg(smi_info, msg);
740 case SI_CHECKING_ENABLES:
742 unsigned char msg[4];
746 /* We got the flags from the SMI, now handle them. */
747 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
749 dev_warn(smi_info->dev,
750 "Couldn't get irq info: %x.\n", msg[2]);
751 dev_warn(smi_info->dev,
752 "Maybe ok, but ipmi might run very slowly.\n");
753 smi_info->si_state = SI_NORMAL;
756 enables = current_global_enables(smi_info, 0, &irq_on);
757 if (smi_info->si_type == SI_BT)
758 /* BT has its own interrupt enable bit. */
759 check_bt_irq(smi_info, irq_on);
760 if (enables != (msg[3] & GLOBAL_ENABLES_MASK)) {
761 /* Enables are not correct, fix them. */
762 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
763 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
764 msg[2] = enables | (msg[3] & ~GLOBAL_ENABLES_MASK);
765 smi_info->handlers->start_transaction(
766 smi_info->si_sm, msg, 3);
767 smi_info->si_state = SI_SETTING_ENABLES;
768 } else if (smi_info->supports_event_msg_buff) {
769 smi_info->curr_msg = ipmi_alloc_smi_msg();
770 if (!smi_info->curr_msg) {
771 smi_info->si_state = SI_NORMAL;
774 start_getting_msg_queue(smi_info);
776 smi_info->si_state = SI_NORMAL;
781 case SI_SETTING_ENABLES:
783 unsigned char msg[4];
785 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
787 dev_warn(smi_info->dev,
788 "Could not set the global enables: 0x%x.\n",
791 if (smi_info->supports_event_msg_buff) {
792 smi_info->curr_msg = ipmi_alloc_smi_msg();
793 if (!smi_info->curr_msg) {
794 smi_info->si_state = SI_NORMAL;
797 start_getting_msg_queue(smi_info);
799 smi_info->si_state = SI_NORMAL;
807 * Called on timeouts and events. Timeouts should pass the elapsed
808 * time, interrupts should pass in zero. Must be called with
809 * si_lock held and interrupts disabled.
811 static enum si_sm_result smi_event_handler(struct smi_info *smi_info,
814 enum si_sm_result si_sm_result;
818 * There used to be a loop here that waited a little while
819 * (around 25us) before giving up. That turned out to be
820 * pointless, the minimum delays I was seeing were in the 300us
821 * range, which is far too long to wait in an interrupt. So
822 * we just run until the state machine tells us something
823 * happened or it needs a delay.
825 si_sm_result = smi_info->handlers->event(smi_info->si_sm, time);
827 while (si_sm_result == SI_SM_CALL_WITHOUT_DELAY)
828 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
830 if (si_sm_result == SI_SM_TRANSACTION_COMPLETE) {
831 smi_inc_stat(smi_info, complete_transactions);
833 handle_transaction_done(smi_info);
834 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
835 } else if (si_sm_result == SI_SM_HOSED) {
836 smi_inc_stat(smi_info, hosed_count);
839 * Do the before return_hosed_msg, because that
842 smi_info->si_state = SI_NORMAL;
843 if (smi_info->curr_msg != NULL) {
845 * If we were handling a user message, format
846 * a response to send to the upper layer to
847 * tell it about the error.
849 return_hosed_msg(smi_info, IPMI_ERR_UNSPECIFIED);
851 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
855 * We prefer handling attn over new messages. But don't do
856 * this if there is not yet an upper layer to handle anything.
858 if (likely(smi_info->intf) &&
859 (si_sm_result == SI_SM_ATTN || smi_info->got_attn)) {
860 unsigned char msg[2];
862 if (smi_info->si_state != SI_NORMAL) {
864 * We got an ATTN, but we are doing something else.
865 * Handle the ATTN later.
867 smi_info->got_attn = true;
869 smi_info->got_attn = false;
870 smi_inc_stat(smi_info, attentions);
873 * Got a attn, send down a get message flags to see
874 * what's causing it. It would be better to handle
875 * this in the upper layer, but due to the way
876 * interrupts work with the SMI, that's not really
879 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
880 msg[1] = IPMI_GET_MSG_FLAGS_CMD;
882 smi_info->handlers->start_transaction(
883 smi_info->si_sm, msg, 2);
884 smi_info->si_state = SI_GETTING_FLAGS;
889 /* If we are currently idle, try to start the next message. */
890 if (si_sm_result == SI_SM_IDLE) {
891 smi_inc_stat(smi_info, idles);
893 si_sm_result = start_next_msg(smi_info);
894 if (si_sm_result != SI_SM_IDLE)
898 if ((si_sm_result == SI_SM_IDLE)
899 && (atomic_read(&smi_info->req_events))) {
901 * We are idle and the upper layer requested that I fetch
904 atomic_set(&smi_info->req_events, 0);
907 * Take this opportunity to check the interrupt and
908 * message enable state for the BMC. The BMC can be
909 * asynchronously reset, and may thus get interrupts
910 * disable and messages disabled.
912 if (smi_info->supports_event_msg_buff || smi_info->irq) {
913 start_check_enables(smi_info);
915 smi_info->curr_msg = alloc_msg_handle_irq(smi_info);
916 if (!smi_info->curr_msg)
919 start_getting_events(smi_info);
927 static void check_start_timer_thread(struct smi_info *smi_info)
929 if (smi_info->si_state == SI_NORMAL && smi_info->curr_msg == NULL) {
930 smi_mod_timer(smi_info, jiffies + SI_TIMEOUT_JIFFIES);
932 if (smi_info->thread)
933 wake_up_process(smi_info->thread);
935 start_next_msg(smi_info);
936 smi_event_handler(smi_info, 0);
940 static void flush_messages(void *send_info)
942 struct smi_info *smi_info = send_info;
943 enum si_sm_result result;
946 * Currently, this function is called only in run-to-completion
947 * mode. This means we are single-threaded, no need for locks.
949 result = smi_event_handler(smi_info, 0);
950 while (result != SI_SM_IDLE) {
951 udelay(SI_SHORT_TIMEOUT_USEC);
952 result = smi_event_handler(smi_info, SI_SHORT_TIMEOUT_USEC);
956 static void sender(void *send_info,
957 struct ipmi_smi_msg *msg)
959 struct smi_info *smi_info = send_info;
962 debug_timestamp("Enqueue");
964 if (smi_info->run_to_completion) {
966 * If we are running to completion, start it. Upper
967 * layer will call flush_messages to clear it out.
969 smi_info->waiting_msg = msg;
973 spin_lock_irqsave(&smi_info->si_lock, flags);
975 * The following two lines don't need to be under the lock for
976 * the lock's sake, but they do need SMP memory barriers to
977 * avoid getting things out of order. We are already claiming
978 * the lock, anyway, so just do it under the lock to avoid the
981 BUG_ON(smi_info->waiting_msg);
982 smi_info->waiting_msg = msg;
983 check_start_timer_thread(smi_info);
984 spin_unlock_irqrestore(&smi_info->si_lock, flags);
987 static void set_run_to_completion(void *send_info, bool i_run_to_completion)
989 struct smi_info *smi_info = send_info;
991 smi_info->run_to_completion = i_run_to_completion;
992 if (i_run_to_completion)
993 flush_messages(smi_info);
997 * Use -1 in the nsec value of the busy waiting timespec to tell that
998 * we are spinning in kipmid looking for something and not delaying
1001 static inline void ipmi_si_set_not_busy(struct timespec64 *ts)
1005 static inline int ipmi_si_is_busy(struct timespec64 *ts)
1007 return ts->tv_nsec != -1;
1010 static inline int ipmi_thread_busy_wait(enum si_sm_result smi_result,
1011 const struct smi_info *smi_info,
1012 struct timespec64 *busy_until)
1014 unsigned int max_busy_us = 0;
1016 if (smi_info->intf_num < num_max_busy_us)
1017 max_busy_us = kipmid_max_busy_us[smi_info->intf_num];
1018 if (max_busy_us == 0 || smi_result != SI_SM_CALL_WITH_DELAY)
1019 ipmi_si_set_not_busy(busy_until);
1020 else if (!ipmi_si_is_busy(busy_until)) {
1021 getnstimeofday64(busy_until);
1022 timespec64_add_ns(busy_until, max_busy_us*NSEC_PER_USEC);
1024 struct timespec64 now;
1026 getnstimeofday64(&now);
1027 if (unlikely(timespec64_compare(&now, busy_until) > 0)) {
1028 ipmi_si_set_not_busy(busy_until);
1037 * A busy-waiting loop for speeding up IPMI operation.
1039 * Lousy hardware makes this hard. This is only enabled for systems
1040 * that are not BT and do not have interrupts. It starts spinning
1041 * when an operation is complete or until max_busy tells it to stop
1042 * (if that is enabled). See the paragraph on kimid_max_busy_us in
1043 * Documentation/IPMI.txt for details.
1045 static int ipmi_thread(void *data)
1047 struct smi_info *smi_info = data;
1048 unsigned long flags;
1049 enum si_sm_result smi_result;
1050 struct timespec64 busy_until;
1052 ipmi_si_set_not_busy(&busy_until);
1053 set_user_nice(current, MAX_NICE);
1054 while (!kthread_should_stop()) {
1057 spin_lock_irqsave(&(smi_info->si_lock), flags);
1058 smi_result = smi_event_handler(smi_info, 0);
1061 * If the driver is doing something, there is a possible
1062 * race with the timer. If the timer handler see idle,
1063 * and the thread here sees something else, the timer
1064 * handler won't restart the timer even though it is
1065 * required. So start it here if necessary.
1067 if (smi_result != SI_SM_IDLE && !smi_info->timer_running)
1068 smi_mod_timer(smi_info, jiffies + SI_TIMEOUT_JIFFIES);
1070 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1071 busy_wait = ipmi_thread_busy_wait(smi_result, smi_info,
1073 if (smi_result == SI_SM_CALL_WITHOUT_DELAY)
1075 else if (smi_result == SI_SM_CALL_WITH_DELAY && busy_wait)
1077 else if (smi_result == SI_SM_IDLE) {
1078 if (atomic_read(&smi_info->need_watch)) {
1079 schedule_timeout_interruptible(100);
1081 /* Wait to be woken up when we are needed. */
1082 __set_current_state(TASK_INTERRUPTIBLE);
1086 schedule_timeout_interruptible(1);
1092 static void poll(void *send_info)
1094 struct smi_info *smi_info = send_info;
1095 unsigned long flags = 0;
1096 bool run_to_completion = smi_info->run_to_completion;
1099 * Make sure there is some delay in the poll loop so we can
1100 * drive time forward and timeout things.
1103 if (!run_to_completion)
1104 spin_lock_irqsave(&smi_info->si_lock, flags);
1105 smi_event_handler(smi_info, 10);
1106 if (!run_to_completion)
1107 spin_unlock_irqrestore(&smi_info->si_lock, flags);
1110 static void request_events(void *send_info)
1112 struct smi_info *smi_info = send_info;
1114 if (!smi_info->has_event_buffer)
1117 atomic_set(&smi_info->req_events, 1);
1120 static void set_need_watch(void *send_info, bool enable)
1122 struct smi_info *smi_info = send_info;
1123 unsigned long flags;
1125 atomic_set(&smi_info->need_watch, enable);
1126 spin_lock_irqsave(&smi_info->si_lock, flags);
1127 check_start_timer_thread(smi_info);
1128 spin_unlock_irqrestore(&smi_info->si_lock, flags);
1131 static int initialized;
1133 static void smi_timeout(unsigned long data)
1135 struct smi_info *smi_info = (struct smi_info *) data;
1136 enum si_sm_result smi_result;
1137 unsigned long flags;
1138 unsigned long jiffies_now;
1142 spin_lock_irqsave(&(smi_info->si_lock), flags);
1143 debug_timestamp("Timer");
1145 jiffies_now = jiffies;
1146 time_diff = (((long)jiffies_now - (long)smi_info->last_timeout_jiffies)
1147 * SI_USEC_PER_JIFFY);
1148 smi_result = smi_event_handler(smi_info, time_diff);
1150 if ((smi_info->irq) && (!smi_info->interrupt_disabled)) {
1151 /* Running with interrupts, only do long timeouts. */
1152 timeout = jiffies + SI_TIMEOUT_JIFFIES;
1153 smi_inc_stat(smi_info, long_timeouts);
1158 * If the state machine asks for a short delay, then shorten
1159 * the timer timeout.
1161 if (smi_result == SI_SM_CALL_WITH_DELAY) {
1162 smi_inc_stat(smi_info, short_timeouts);
1163 timeout = jiffies + 1;
1165 smi_inc_stat(smi_info, long_timeouts);
1166 timeout = jiffies + SI_TIMEOUT_JIFFIES;
1170 if (smi_result != SI_SM_IDLE)
1171 smi_mod_timer(smi_info, timeout);
1173 smi_info->timer_running = false;
1174 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1177 static irqreturn_t si_irq_handler(int irq, void *data)
1179 struct smi_info *smi_info = data;
1180 unsigned long flags;
1182 spin_lock_irqsave(&(smi_info->si_lock), flags);
1184 smi_inc_stat(smi_info, interrupts);
1186 debug_timestamp("Interrupt");
1188 smi_event_handler(smi_info, 0);
1189 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1193 static irqreturn_t si_bt_irq_handler(int irq, void *data)
1195 struct smi_info *smi_info = data;
1196 /* We need to clear the IRQ flag for the BT interface. */
1197 smi_info->io.outputb(&smi_info->io, IPMI_BT_INTMASK_REG,
1198 IPMI_BT_INTMASK_CLEAR_IRQ_BIT
1199 | IPMI_BT_INTMASK_ENABLE_IRQ_BIT);
1200 return si_irq_handler(irq, data);
1203 static int smi_start_processing(void *send_info,
1206 struct smi_info *new_smi = send_info;
1209 new_smi->intf = intf;
1211 /* Try to claim any interrupts. */
1212 if (new_smi->irq_setup)
1213 new_smi->irq_setup(new_smi);
1215 /* Set up the timer that drives the interface. */
1216 setup_timer(&new_smi->si_timer, smi_timeout, (long)new_smi);
1217 smi_mod_timer(new_smi, jiffies + SI_TIMEOUT_JIFFIES);
1220 * Check if the user forcefully enabled the daemon.
1222 if (new_smi->intf_num < num_force_kipmid)
1223 enable = force_kipmid[new_smi->intf_num];
1225 * The BT interface is efficient enough to not need a thread,
1226 * and there is no need for a thread if we have interrupts.
1228 else if ((new_smi->si_type != SI_BT) && (!new_smi->irq))
1232 new_smi->thread = kthread_run(ipmi_thread, new_smi,
1233 "kipmi%d", new_smi->intf_num);
1234 if (IS_ERR(new_smi->thread)) {
1235 dev_notice(new_smi->dev, "Could not start"
1236 " kernel thread due to error %ld, only using"
1237 " timers to drive the interface\n",
1238 PTR_ERR(new_smi->thread));
1239 new_smi->thread = NULL;
1246 static int get_smi_info(void *send_info, struct ipmi_smi_info *data)
1248 struct smi_info *smi = send_info;
1250 data->addr_src = smi->addr_source;
1251 data->dev = smi->dev;
1252 data->addr_info = smi->addr_info;
1253 get_device(smi->dev);
1258 static void set_maintenance_mode(void *send_info, bool enable)
1260 struct smi_info *smi_info = send_info;
1263 atomic_set(&smi_info->req_events, 0);
1266 static const struct ipmi_smi_handlers handlers = {
1267 .owner = THIS_MODULE,
1268 .start_processing = smi_start_processing,
1269 .get_smi_info = get_smi_info,
1271 .request_events = request_events,
1272 .set_need_watch = set_need_watch,
1273 .set_maintenance_mode = set_maintenance_mode,
1274 .set_run_to_completion = set_run_to_completion,
1275 .flush_messages = flush_messages,
1280 * There can be 4 IO ports passed in (with or without IRQs), 4 addresses,
1281 * a default IO port, and 1 ACPI/SPMI address. That sets SI_MAX_DRIVERS.
1284 static LIST_HEAD(smi_infos);
1285 static DEFINE_MUTEX(smi_infos_lock);
1286 static int smi_num; /* Used to sequence the SMIs */
1288 #define DEFAULT_REGSPACING 1
1289 #define DEFAULT_REGSIZE 1
1292 static bool si_tryacpi = true;
1295 static bool si_trydmi = true;
1297 static bool si_tryplatform = true;
1299 static bool si_trypci = true;
1301 static bool si_trydefaults = IS_ENABLED(CONFIG_IPMI_SI_PROBE_DEFAULTS);
1302 static char *si_type[SI_MAX_PARMS];
1303 #define MAX_SI_TYPE_STR 30
1304 static char si_type_str[MAX_SI_TYPE_STR];
1305 static unsigned long addrs[SI_MAX_PARMS];
1306 static unsigned int num_addrs;
1307 static unsigned int ports[SI_MAX_PARMS];
1308 static unsigned int num_ports;
1309 static int irqs[SI_MAX_PARMS];
1310 static unsigned int num_irqs;
1311 static int regspacings[SI_MAX_PARMS];
1312 static unsigned int num_regspacings;
1313 static int regsizes[SI_MAX_PARMS];
1314 static unsigned int num_regsizes;
1315 static int regshifts[SI_MAX_PARMS];
1316 static unsigned int num_regshifts;
1317 static int slave_addrs[SI_MAX_PARMS]; /* Leaving 0 chooses the default value */
1318 static unsigned int num_slave_addrs;
1320 #define IPMI_IO_ADDR_SPACE 0
1321 #define IPMI_MEM_ADDR_SPACE 1
1322 static char *addr_space_to_str[] = { "i/o", "mem" };
1324 static int hotmod_handler(const char *val, struct kernel_param *kp);
1326 module_param_call(hotmod, hotmod_handler, NULL, NULL, 0200);
1327 MODULE_PARM_DESC(hotmod, "Add and remove interfaces. See"
1328 " Documentation/IPMI.txt in the kernel sources for the"
1332 module_param_named(tryacpi, si_tryacpi, bool, 0);
1333 MODULE_PARM_DESC(tryacpi, "Setting this to zero will disable the"
1334 " default scan of the interfaces identified via ACPI");
1337 module_param_named(trydmi, si_trydmi, bool, 0);
1338 MODULE_PARM_DESC(trydmi, "Setting this to zero will disable the"
1339 " default scan of the interfaces identified via DMI");
1341 module_param_named(tryplatform, si_tryplatform, bool, 0);
1342 MODULE_PARM_DESC(tryacpi, "Setting this to zero will disable the"
1343 " default scan of the interfaces identified via platform"
1344 " interfaces like openfirmware");
1346 module_param_named(trypci, si_trypci, bool, 0);
1347 MODULE_PARM_DESC(tryacpi, "Setting this to zero will disable the"
1348 " default scan of the interfaces identified via pci");
1350 module_param_named(trydefaults, si_trydefaults, bool, 0);
1351 MODULE_PARM_DESC(trydefaults, "Setting this to 'false' will disable the"
1352 " default scan of the KCS and SMIC interface at the standard"
1354 module_param_string(type, si_type_str, MAX_SI_TYPE_STR, 0);
1355 MODULE_PARM_DESC(type, "Defines the type of each interface, each"
1356 " interface separated by commas. The types are 'kcs',"
1357 " 'smic', and 'bt'. For example si_type=kcs,bt will set"
1358 " the first interface to kcs and the second to bt");
1359 module_param_array(addrs, ulong, &num_addrs, 0);
1360 MODULE_PARM_DESC(addrs, "Sets the memory address of each interface, the"
1361 " addresses separated by commas. Only use if an interface"
1362 " is in memory. Otherwise, set it to zero or leave"
1364 module_param_array(ports, uint, &num_ports, 0);
1365 MODULE_PARM_DESC(ports, "Sets the port address of each interface, the"
1366 " addresses separated by commas. Only use if an interface"
1367 " is a port. Otherwise, set it to zero or leave"
1369 module_param_array(irqs, int, &num_irqs, 0);
1370 MODULE_PARM_DESC(irqs, "Sets the interrupt of each interface, the"
1371 " addresses separated by commas. Only use if an interface"
1372 " has an interrupt. Otherwise, set it to zero or leave"
1374 module_param_array(regspacings, int, &num_regspacings, 0);
1375 MODULE_PARM_DESC(regspacings, "The number of bytes between the start address"
1376 " and each successive register used by the interface. For"
1377 " instance, if the start address is 0xca2 and the spacing"
1378 " is 2, then the second address is at 0xca4. Defaults"
1380 module_param_array(regsizes, int, &num_regsizes, 0);
1381 MODULE_PARM_DESC(regsizes, "The size of the specific IPMI register in bytes."
1382 " This should generally be 1, 2, 4, or 8 for an 8-bit,"
1383 " 16-bit, 32-bit, or 64-bit register. Use this if you"
1384 " the 8-bit IPMI register has to be read from a larger"
1386 module_param_array(regshifts, int, &num_regshifts, 0);
1387 MODULE_PARM_DESC(regshifts, "The amount to shift the data read from the."
1388 " IPMI register, in bits. For instance, if the data"
1389 " is read from a 32-bit word and the IPMI data is in"
1390 " bit 8-15, then the shift would be 8");
1391 module_param_array(slave_addrs, int, &num_slave_addrs, 0);
1392 MODULE_PARM_DESC(slave_addrs, "Set the default IPMB slave address for"
1393 " the controller. Normally this is 0x20, but can be"
1394 " overridden by this parm. This is an array indexed"
1395 " by interface number.");
1396 module_param_array(force_kipmid, int, &num_force_kipmid, 0);
1397 MODULE_PARM_DESC(force_kipmid, "Force the kipmi daemon to be enabled (1) or"
1398 " disabled(0). Normally the IPMI driver auto-detects"
1399 " this, but the value may be overridden by this parm.");
1400 module_param(unload_when_empty, bool, 0);
1401 MODULE_PARM_DESC(unload_when_empty, "Unload the module if no interfaces are"
1402 " specified or found, default is 1. Setting to 0"
1403 " is useful for hot add of devices using hotmod.");
1404 module_param_array(kipmid_max_busy_us, uint, &num_max_busy_us, 0644);
1405 MODULE_PARM_DESC(kipmid_max_busy_us,
1406 "Max time (in microseconds) to busy-wait for IPMI data before"
1407 " sleeping. 0 (default) means to wait forever. Set to 100-500"
1408 " if kipmid is using up a lot of CPU time.");
1411 static void std_irq_cleanup(struct smi_info *info)
1413 if (info->si_type == SI_BT)
1414 /* Disable the interrupt in the BT interface. */
1415 info->io.outputb(&info->io, IPMI_BT_INTMASK_REG, 0);
1416 free_irq(info->irq, info);
1419 static int std_irq_setup(struct smi_info *info)
1426 if (info->si_type == SI_BT) {
1427 rv = request_irq(info->irq,
1433 /* Enable the interrupt in the BT interface. */
1434 info->io.outputb(&info->io, IPMI_BT_INTMASK_REG,
1435 IPMI_BT_INTMASK_ENABLE_IRQ_BIT);
1437 rv = request_irq(info->irq,
1443 dev_warn(info->dev, "%s unable to claim interrupt %d,"
1444 " running polled\n",
1445 DEVICE_NAME, info->irq);
1448 info->irq_cleanup = std_irq_cleanup;
1449 dev_info(info->dev, "Using irq %d\n", info->irq);
1455 static unsigned char port_inb(const struct si_sm_io *io, unsigned int offset)
1457 unsigned int addr = io->addr_data;
1459 return inb(addr + (offset * io->regspacing));
1462 static void port_outb(const struct si_sm_io *io, unsigned int offset,
1465 unsigned int addr = io->addr_data;
1467 outb(b, addr + (offset * io->regspacing));
1470 static unsigned char port_inw(const struct si_sm_io *io, unsigned int offset)
1472 unsigned int addr = io->addr_data;
1474 return (inw(addr + (offset * io->regspacing)) >> io->regshift) & 0xff;
1477 static void port_outw(const struct si_sm_io *io, unsigned int offset,
1480 unsigned int addr = io->addr_data;
1482 outw(b << io->regshift, addr + (offset * io->regspacing));
1485 static unsigned char port_inl(const struct si_sm_io *io, unsigned int offset)
1487 unsigned int addr = io->addr_data;
1489 return (inl(addr + (offset * io->regspacing)) >> io->regshift) & 0xff;
1492 static void port_outl(const struct si_sm_io *io, unsigned int offset,
1495 unsigned int addr = io->addr_data;
1497 outl(b << io->regshift, addr+(offset * io->regspacing));
1500 static void port_cleanup(struct smi_info *info)
1502 unsigned int addr = info->io.addr_data;
1506 for (idx = 0; idx < info->io_size; idx++)
1507 release_region(addr + idx * info->io.regspacing,
1512 static int port_setup(struct smi_info *info)
1514 unsigned int addr = info->io.addr_data;
1520 info->io_cleanup = port_cleanup;
1523 * Figure out the actual inb/inw/inl/etc routine to use based
1524 * upon the register size.
1526 switch (info->io.regsize) {
1528 info->io.inputb = port_inb;
1529 info->io.outputb = port_outb;
1532 info->io.inputb = port_inw;
1533 info->io.outputb = port_outw;
1536 info->io.inputb = port_inl;
1537 info->io.outputb = port_outl;
1540 dev_warn(info->dev, "Invalid register size: %d\n",
1546 * Some BIOSes reserve disjoint I/O regions in their ACPI
1547 * tables. This causes problems when trying to register the
1548 * entire I/O region. Therefore we must register each I/O
1551 for (idx = 0; idx < info->io_size; idx++) {
1552 if (request_region(addr + idx * info->io.regspacing,
1553 info->io.regsize, DEVICE_NAME) == NULL) {
1554 /* Undo allocations */
1556 release_region(addr + idx * info->io.regspacing,
1565 static unsigned char intf_mem_inb(const struct si_sm_io *io,
1566 unsigned int offset)
1568 return readb((io->addr)+(offset * io->regspacing));
1571 static void intf_mem_outb(const struct si_sm_io *io, unsigned int offset,
1574 writeb(b, (io->addr)+(offset * io->regspacing));
1577 static unsigned char intf_mem_inw(const struct si_sm_io *io,
1578 unsigned int offset)
1580 return (readw((io->addr)+(offset * io->regspacing)) >> io->regshift)
1584 static void intf_mem_outw(const struct si_sm_io *io, unsigned int offset,
1587 writeb(b << io->regshift, (io->addr)+(offset * io->regspacing));
1590 static unsigned char intf_mem_inl(const struct si_sm_io *io,
1591 unsigned int offset)
1593 return (readl((io->addr)+(offset * io->regspacing)) >> io->regshift)
1597 static void intf_mem_outl(const struct si_sm_io *io, unsigned int offset,
1600 writel(b << io->regshift, (io->addr)+(offset * io->regspacing));
1604 static unsigned char mem_inq(const struct si_sm_io *io, unsigned int offset)
1606 return (readq((io->addr)+(offset * io->regspacing)) >> io->regshift)
1610 static void mem_outq(const struct si_sm_io *io, unsigned int offset,
1613 writeq(b << io->regshift, (io->addr)+(offset * io->regspacing));
1617 static void mem_cleanup(struct smi_info *info)
1619 unsigned long addr = info->io.addr_data;
1622 if (info->io.addr) {
1623 iounmap(info->io.addr);
1625 mapsize = ((info->io_size * info->io.regspacing)
1626 - (info->io.regspacing - info->io.regsize));
1628 release_mem_region(addr, mapsize);
1632 static int mem_setup(struct smi_info *info)
1634 unsigned long addr = info->io.addr_data;
1640 info->io_cleanup = mem_cleanup;
1643 * Figure out the actual readb/readw/readl/etc routine to use based
1644 * upon the register size.
1646 switch (info->io.regsize) {
1648 info->io.inputb = intf_mem_inb;
1649 info->io.outputb = intf_mem_outb;
1652 info->io.inputb = intf_mem_inw;
1653 info->io.outputb = intf_mem_outw;
1656 info->io.inputb = intf_mem_inl;
1657 info->io.outputb = intf_mem_outl;
1661 info->io.inputb = mem_inq;
1662 info->io.outputb = mem_outq;
1666 dev_warn(info->dev, "Invalid register size: %d\n",
1672 * Calculate the total amount of memory to claim. This is an
1673 * unusual looking calculation, but it avoids claiming any
1674 * more memory than it has to. It will claim everything
1675 * between the first address to the end of the last full
1678 mapsize = ((info->io_size * info->io.regspacing)
1679 - (info->io.regspacing - info->io.regsize));
1681 if (request_mem_region(addr, mapsize, DEVICE_NAME) == NULL)
1684 info->io.addr = ioremap(addr, mapsize);
1685 if (info->io.addr == NULL) {
1686 release_mem_region(addr, mapsize);
1693 * Parms come in as <op1>[:op2[:op3...]]. ops are:
1694 * add|remove,kcs|bt|smic,mem|i/o,<address>[,<opt1>[,<opt2>[,...]]]
1702 enum hotmod_op { HM_ADD, HM_REMOVE };
1703 struct hotmod_vals {
1707 static struct hotmod_vals hotmod_ops[] = {
1709 { "remove", HM_REMOVE },
1712 static struct hotmod_vals hotmod_si[] = {
1714 { "smic", SI_SMIC },
1718 static struct hotmod_vals hotmod_as[] = {
1719 { "mem", IPMI_MEM_ADDR_SPACE },
1720 { "i/o", IPMI_IO_ADDR_SPACE },
1724 static int parse_str(struct hotmod_vals *v, int *val, char *name, char **curr)
1729 s = strchr(*curr, ',');
1731 printk(KERN_WARNING PFX "No hotmod %s given.\n", name);
1736 for (i = 0; v[i].name; i++) {
1737 if (strcmp(*curr, v[i].name) == 0) {
1744 printk(KERN_WARNING PFX "Invalid hotmod %s '%s'\n", name, *curr);
1748 static int check_hotmod_int_op(const char *curr, const char *option,
1749 const char *name, int *val)
1753 if (strcmp(curr, name) == 0) {
1755 printk(KERN_WARNING PFX
1756 "No option given for '%s'\n",
1760 *val = simple_strtoul(option, &n, 0);
1761 if ((*n != '\0') || (*option == '\0')) {
1762 printk(KERN_WARNING PFX
1763 "Bad option given for '%s'\n",
1772 static struct smi_info *smi_info_alloc(void)
1774 struct smi_info *info = kzalloc(sizeof(*info), GFP_KERNEL);
1777 spin_lock_init(&info->si_lock);
1781 static int hotmod_handler(const char *val, struct kernel_param *kp)
1783 char *str = kstrdup(val, GFP_KERNEL);
1785 char *next, *curr, *s, *n, *o;
1787 enum si_type si_type;
1797 struct smi_info *info;
1802 /* Kill any trailing spaces, as we can get a "\n" from echo. */
1805 while ((ival >= 0) && isspace(str[ival])) {
1810 for (curr = str; curr; curr = next) {
1815 ipmb = 0; /* Choose the default if not specified */
1817 next = strchr(curr, ':');
1823 rv = parse_str(hotmod_ops, &ival, "operation", &curr);
1828 rv = parse_str(hotmod_si, &ival, "interface type", &curr);
1833 rv = parse_str(hotmod_as, &addr_space, "address space", &curr);
1837 s = strchr(curr, ',');
1842 addr = simple_strtoul(curr, &n, 0);
1843 if ((*n != '\0') || (*curr == '\0')) {
1844 printk(KERN_WARNING PFX "Invalid hotmod address"
1851 s = strchr(curr, ',');
1856 o = strchr(curr, '=');
1861 rv = check_hotmod_int_op(curr, o, "rsp", ®spacing);
1866 rv = check_hotmod_int_op(curr, o, "rsi", ®size);
1871 rv = check_hotmod_int_op(curr, o, "rsh", ®shift);
1876 rv = check_hotmod_int_op(curr, o, "irq", &irq);
1881 rv = check_hotmod_int_op(curr, o, "ipmb", &ipmb);
1888 printk(KERN_WARNING PFX
1889 "Invalid hotmod option '%s'\n",
1895 info = smi_info_alloc();
1901 info->addr_source = SI_HOTMOD;
1902 info->si_type = si_type;
1903 info->io.addr_data = addr;
1904 info->io.addr_type = addr_space;
1905 if (addr_space == IPMI_MEM_ADDR_SPACE)
1906 info->io_setup = mem_setup;
1908 info->io_setup = port_setup;
1910 info->io.addr = NULL;
1911 info->io.regspacing = regspacing;
1912 if (!info->io.regspacing)
1913 info->io.regspacing = DEFAULT_REGSPACING;
1914 info->io.regsize = regsize;
1915 if (!info->io.regsize)
1916 info->io.regsize = DEFAULT_REGSPACING;
1917 info->io.regshift = regshift;
1920 info->irq_setup = std_irq_setup;
1921 info->slave_addr = ipmb;
1928 rv = try_smi_init(info);
1930 cleanup_one_si(info);
1935 struct smi_info *e, *tmp_e;
1937 mutex_lock(&smi_infos_lock);
1938 list_for_each_entry_safe(e, tmp_e, &smi_infos, link) {
1939 if (e->io.addr_type != addr_space)
1941 if (e->si_type != si_type)
1943 if (e->io.addr_data == addr)
1946 mutex_unlock(&smi_infos_lock);
1955 static int hardcode_find_bmc(void)
1959 struct smi_info *info;
1961 for (i = 0; i < SI_MAX_PARMS; i++) {
1962 if (!ports[i] && !addrs[i])
1965 info = smi_info_alloc();
1969 info->addr_source = SI_HARDCODED;
1970 printk(KERN_INFO PFX "probing via hardcoded address\n");
1972 if (!si_type[i] || strcmp(si_type[i], "kcs") == 0) {
1973 info->si_type = SI_KCS;
1974 } else if (strcmp(si_type[i], "smic") == 0) {
1975 info->si_type = SI_SMIC;
1976 } else if (strcmp(si_type[i], "bt") == 0) {
1977 info->si_type = SI_BT;
1979 printk(KERN_WARNING PFX "Interface type specified "
1980 "for interface %d, was invalid: %s\n",
1988 info->io_setup = port_setup;
1989 info->io.addr_data = ports[i];
1990 info->io.addr_type = IPMI_IO_ADDR_SPACE;
1991 } else if (addrs[i]) {
1993 info->io_setup = mem_setup;
1994 info->io.addr_data = addrs[i];
1995 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
1997 printk(KERN_WARNING PFX "Interface type specified "
1998 "for interface %d, but port and address were "
1999 "not set or set to zero.\n", i);
2004 info->io.addr = NULL;
2005 info->io.regspacing = regspacings[i];
2006 if (!info->io.regspacing)
2007 info->io.regspacing = DEFAULT_REGSPACING;
2008 info->io.regsize = regsizes[i];
2009 if (!info->io.regsize)
2010 info->io.regsize = DEFAULT_REGSPACING;
2011 info->io.regshift = regshifts[i];
2012 info->irq = irqs[i];
2014 info->irq_setup = std_irq_setup;
2015 info->slave_addr = slave_addrs[i];
2017 if (!add_smi(info)) {
2018 if (try_smi_init(info))
2019 cleanup_one_si(info);
2030 #include <linux/acpi.h>
2033 * Once we get an ACPI failure, we don't try any more, because we go
2034 * through the tables sequentially. Once we don't find a table, there
2037 static int acpi_failure;
2039 /* For GPE-type interrupts. */
2040 static u32 ipmi_acpi_gpe(acpi_handle gpe_device,
2041 u32 gpe_number, void *context)
2043 struct smi_info *smi_info = context;
2044 unsigned long flags;
2046 spin_lock_irqsave(&(smi_info->si_lock), flags);
2048 smi_inc_stat(smi_info, interrupts);
2050 debug_timestamp("ACPI_GPE");
2052 smi_event_handler(smi_info, 0);
2053 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
2055 return ACPI_INTERRUPT_HANDLED;
2058 static void acpi_gpe_irq_cleanup(struct smi_info *info)
2063 acpi_remove_gpe_handler(NULL, info->irq, &ipmi_acpi_gpe);
2066 static int acpi_gpe_irq_setup(struct smi_info *info)
2073 status = acpi_install_gpe_handler(NULL,
2075 ACPI_GPE_LEVEL_TRIGGERED,
2078 if (status != AE_OK) {
2079 dev_warn(info->dev, "%s unable to claim ACPI GPE %d,"
2080 " running polled\n", DEVICE_NAME, info->irq);
2084 info->irq_cleanup = acpi_gpe_irq_cleanup;
2085 dev_info(info->dev, "Using ACPI GPE %d\n", info->irq);
2092 * http://h21007.www2.hp.com/portal/download/files/unprot/hpspmi.pdf
2103 s8 CreatorRevision[4];
2106 s16 SpecificationRevision;
2109 * Bit 0 - SCI interrupt supported
2110 * Bit 1 - I/O APIC/SAPIC
2115 * If bit 0 of InterruptType is set, then this is the SCI
2116 * interrupt in the GPEx_STS register.
2123 * If bit 1 of InterruptType is set, then this is the I/O
2124 * APIC/SAPIC interrupt.
2126 u32 GlobalSystemInterrupt;
2128 /* The actual register address. */
2129 struct acpi_generic_address addr;
2133 s8 spmi_id[1]; /* A '\0' terminated array starts here. */
2136 static int try_init_spmi(struct SPMITable *spmi)
2138 struct smi_info *info;
2141 if (spmi->IPMIlegacy != 1) {
2142 printk(KERN_INFO PFX "Bad SPMI legacy %d\n", spmi->IPMIlegacy);
2146 info = smi_info_alloc();
2148 printk(KERN_ERR PFX "Could not allocate SI data (3)\n");
2152 info->addr_source = SI_SPMI;
2153 printk(KERN_INFO PFX "probing via SPMI\n");
2155 /* Figure out the interface type. */
2156 switch (spmi->InterfaceType) {
2158 info->si_type = SI_KCS;
2161 info->si_type = SI_SMIC;
2164 info->si_type = SI_BT;
2166 case 4: /* SSIF, just ignore */
2170 printk(KERN_INFO PFX "Unknown ACPI/SPMI SI type %d\n",
2171 spmi->InterfaceType);
2176 if (spmi->InterruptType & 1) {
2177 /* We've got a GPE interrupt. */
2178 info->irq = spmi->GPE;
2179 info->irq_setup = acpi_gpe_irq_setup;
2180 } else if (spmi->InterruptType & 2) {
2181 /* We've got an APIC/SAPIC interrupt. */
2182 info->irq = spmi->GlobalSystemInterrupt;
2183 info->irq_setup = std_irq_setup;
2185 /* Use the default interrupt setting. */
2187 info->irq_setup = NULL;
2190 if (spmi->addr.bit_width) {
2191 /* A (hopefully) properly formed register bit width. */
2192 info->io.regspacing = spmi->addr.bit_width / 8;
2194 info->io.regspacing = DEFAULT_REGSPACING;
2196 info->io.regsize = info->io.regspacing;
2197 info->io.regshift = spmi->addr.bit_offset;
2199 if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
2200 info->io_setup = mem_setup;
2201 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2202 } else if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
2203 info->io_setup = port_setup;
2204 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2207 printk(KERN_WARNING PFX "Unknown ACPI I/O Address type\n");
2210 info->io.addr_data = spmi->addr.address;
2212 pr_info("ipmi_si: SPMI: %s %#lx regsize %d spacing %d irq %d\n",
2213 (info->io.addr_type == IPMI_IO_ADDR_SPACE) ? "io" : "mem",
2214 info->io.addr_data, info->io.regsize, info->io.regspacing,
2224 static void spmi_find_bmc(void)
2227 struct SPMITable *spmi;
2236 for (i = 0; ; i++) {
2237 status = acpi_get_table(ACPI_SIG_SPMI, i+1,
2238 (struct acpi_table_header **)&spmi);
2239 if (status != AE_OK)
2242 try_init_spmi(spmi);
2248 struct dmi_ipmi_data {
2251 unsigned long base_addr;
2257 static int decode_dmi(const struct dmi_header *dm,
2258 struct dmi_ipmi_data *dmi)
2260 const u8 *data = (const u8 *)dm;
2261 unsigned long base_addr;
2263 u8 len = dm->length;
2265 dmi->type = data[4];
2267 memcpy(&base_addr, data+8, sizeof(unsigned long));
2269 if (base_addr & 1) {
2271 base_addr &= 0xFFFE;
2272 dmi->addr_space = IPMI_IO_ADDR_SPACE;
2275 dmi->addr_space = IPMI_MEM_ADDR_SPACE;
2277 /* If bit 4 of byte 0x10 is set, then the lsb for the address
2279 dmi->base_addr = base_addr | ((data[0x10] & 0x10) >> 4);
2281 dmi->irq = data[0x11];
2283 /* The top two bits of byte 0x10 hold the register spacing. */
2284 reg_spacing = (data[0x10] & 0xC0) >> 6;
2285 switch (reg_spacing) {
2286 case 0x00: /* Byte boundaries */
2289 case 0x01: /* 32-bit boundaries */
2292 case 0x02: /* 16-byte boundaries */
2296 /* Some other interface, just ignore it. */
2302 * Note that technically, the lower bit of the base
2303 * address should be 1 if the address is I/O and 0 if
2304 * the address is in memory. So many systems get that
2305 * wrong (and all that I have seen are I/O) so we just
2306 * ignore that bit and assume I/O. Systems that use
2307 * memory should use the newer spec, anyway.
2309 dmi->base_addr = base_addr & 0xfffe;
2310 dmi->addr_space = IPMI_IO_ADDR_SPACE;
2314 dmi->slave_addr = data[6];
2319 static void try_init_dmi(struct dmi_ipmi_data *ipmi_data)
2321 struct smi_info *info;
2323 info = smi_info_alloc();
2325 printk(KERN_ERR PFX "Could not allocate SI data\n");
2329 info->addr_source = SI_SMBIOS;
2330 printk(KERN_INFO PFX "probing via SMBIOS\n");
2332 switch (ipmi_data->type) {
2333 case 0x01: /* KCS */
2334 info->si_type = SI_KCS;
2336 case 0x02: /* SMIC */
2337 info->si_type = SI_SMIC;
2340 info->si_type = SI_BT;
2347 switch (ipmi_data->addr_space) {
2348 case IPMI_MEM_ADDR_SPACE:
2349 info->io_setup = mem_setup;
2350 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2353 case IPMI_IO_ADDR_SPACE:
2354 info->io_setup = port_setup;
2355 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2360 printk(KERN_WARNING PFX "Unknown SMBIOS I/O Address type: %d\n",
2361 ipmi_data->addr_space);
2364 info->io.addr_data = ipmi_data->base_addr;
2366 info->io.regspacing = ipmi_data->offset;
2367 if (!info->io.regspacing)
2368 info->io.regspacing = DEFAULT_REGSPACING;
2369 info->io.regsize = DEFAULT_REGSPACING;
2370 info->io.regshift = 0;
2372 info->slave_addr = ipmi_data->slave_addr;
2374 info->irq = ipmi_data->irq;
2376 info->irq_setup = std_irq_setup;
2378 pr_info("ipmi_si: SMBIOS: %s %#lx regsize %d spacing %d irq %d\n",
2379 (info->io.addr_type == IPMI_IO_ADDR_SPACE) ? "io" : "mem",
2380 info->io.addr_data, info->io.regsize, info->io.regspacing,
2387 static void dmi_find_bmc(void)
2389 const struct dmi_device *dev = NULL;
2390 struct dmi_ipmi_data data;
2393 while ((dev = dmi_find_device(DMI_DEV_TYPE_IPMI, NULL, dev))) {
2394 memset(&data, 0, sizeof(data));
2395 rv = decode_dmi((const struct dmi_header *) dev->device_data,
2398 try_init_dmi(&data);
2401 #endif /* CONFIG_DMI */
2405 #define PCI_ERMC_CLASSCODE 0x0C0700
2406 #define PCI_ERMC_CLASSCODE_MASK 0xffffff00
2407 #define PCI_ERMC_CLASSCODE_TYPE_MASK 0xff
2408 #define PCI_ERMC_CLASSCODE_TYPE_SMIC 0x00
2409 #define PCI_ERMC_CLASSCODE_TYPE_KCS 0x01
2410 #define PCI_ERMC_CLASSCODE_TYPE_BT 0x02
2412 #define PCI_HP_VENDOR_ID 0x103C
2413 #define PCI_MMC_DEVICE_ID 0x121A
2414 #define PCI_MMC_ADDR_CW 0x10
2416 static void ipmi_pci_cleanup(struct smi_info *info)
2418 struct pci_dev *pdev = info->addr_source_data;
2420 pci_disable_device(pdev);
2423 static int ipmi_pci_probe_regspacing(struct smi_info *info)
2425 if (info->si_type == SI_KCS) {
2426 unsigned char status;
2429 info->io.regsize = DEFAULT_REGSIZE;
2430 info->io.regshift = 0;
2432 info->handlers = &kcs_smi_handlers;
2434 /* detect 1, 4, 16byte spacing */
2435 for (regspacing = DEFAULT_REGSPACING; regspacing <= 16;) {
2436 info->io.regspacing = regspacing;
2437 if (info->io_setup(info)) {
2439 "Could not setup I/O space\n");
2440 return DEFAULT_REGSPACING;
2442 /* write invalid cmd */
2443 info->io.outputb(&info->io, 1, 0x10);
2444 /* read status back */
2445 status = info->io.inputb(&info->io, 1);
2446 info->io_cleanup(info);
2452 return DEFAULT_REGSPACING;
2455 static int ipmi_pci_probe(struct pci_dev *pdev,
2456 const struct pci_device_id *ent)
2459 int class_type = pdev->class & PCI_ERMC_CLASSCODE_TYPE_MASK;
2460 struct smi_info *info;
2462 info = smi_info_alloc();
2466 info->addr_source = SI_PCI;
2467 dev_info(&pdev->dev, "probing via PCI");
2469 switch (class_type) {
2470 case PCI_ERMC_CLASSCODE_TYPE_SMIC:
2471 info->si_type = SI_SMIC;
2474 case PCI_ERMC_CLASSCODE_TYPE_KCS:
2475 info->si_type = SI_KCS;
2478 case PCI_ERMC_CLASSCODE_TYPE_BT:
2479 info->si_type = SI_BT;
2484 dev_info(&pdev->dev, "Unknown IPMI type: %d\n", class_type);
2488 rv = pci_enable_device(pdev);
2490 dev_err(&pdev->dev, "couldn't enable PCI device\n");
2495 info->addr_source_cleanup = ipmi_pci_cleanup;
2496 info->addr_source_data = pdev;
2498 if (pci_resource_flags(pdev, 0) & IORESOURCE_IO) {
2499 info->io_setup = port_setup;
2500 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2502 info->io_setup = mem_setup;
2503 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2505 info->io.addr_data = pci_resource_start(pdev, 0);
2507 info->io.regspacing = ipmi_pci_probe_regspacing(info);
2508 info->io.regsize = DEFAULT_REGSIZE;
2509 info->io.regshift = 0;
2511 info->irq = pdev->irq;
2513 info->irq_setup = std_irq_setup;
2515 info->dev = &pdev->dev;
2516 pci_set_drvdata(pdev, info);
2518 dev_info(&pdev->dev, "%pR regsize %d spacing %d irq %d\n",
2519 &pdev->resource[0], info->io.regsize, info->io.regspacing,
2525 pci_disable_device(pdev);
2531 static void ipmi_pci_remove(struct pci_dev *pdev)
2533 struct smi_info *info = pci_get_drvdata(pdev);
2534 cleanup_one_si(info);
2535 pci_disable_device(pdev);
2538 static const struct pci_device_id ipmi_pci_devices[] = {
2539 { PCI_DEVICE(PCI_HP_VENDOR_ID, PCI_MMC_DEVICE_ID) },
2540 { PCI_DEVICE_CLASS(PCI_ERMC_CLASSCODE, PCI_ERMC_CLASSCODE_MASK) },
2543 MODULE_DEVICE_TABLE(pci, ipmi_pci_devices);
2545 static struct pci_driver ipmi_pci_driver = {
2546 .name = DEVICE_NAME,
2547 .id_table = ipmi_pci_devices,
2548 .probe = ipmi_pci_probe,
2549 .remove = ipmi_pci_remove,
2551 #endif /* CONFIG_PCI */
2554 static const struct of_device_id of_ipmi_match[] = {
2555 { .type = "ipmi", .compatible = "ipmi-kcs",
2556 .data = (void *)(unsigned long) SI_KCS },
2557 { .type = "ipmi", .compatible = "ipmi-smic",
2558 .data = (void *)(unsigned long) SI_SMIC },
2559 { .type = "ipmi", .compatible = "ipmi-bt",
2560 .data = (void *)(unsigned long) SI_BT },
2564 static int of_ipmi_probe(struct platform_device *dev)
2566 const struct of_device_id *match;
2567 struct smi_info *info;
2568 struct resource resource;
2569 const __be32 *regsize, *regspacing, *regshift;
2570 struct device_node *np = dev->dev.of_node;
2574 dev_info(&dev->dev, "probing via device tree\n");
2576 match = of_match_device(of_ipmi_match, &dev->dev);
2580 if (!of_device_is_available(np))
2583 ret = of_address_to_resource(np, 0, &resource);
2585 dev_warn(&dev->dev, PFX "invalid address from OF\n");
2589 regsize = of_get_property(np, "reg-size", &proplen);
2590 if (regsize && proplen != 4) {
2591 dev_warn(&dev->dev, PFX "invalid regsize from OF\n");
2595 regspacing = of_get_property(np, "reg-spacing", &proplen);
2596 if (regspacing && proplen != 4) {
2597 dev_warn(&dev->dev, PFX "invalid regspacing from OF\n");
2601 regshift = of_get_property(np, "reg-shift", &proplen);
2602 if (regshift && proplen != 4) {
2603 dev_warn(&dev->dev, PFX "invalid regshift from OF\n");
2607 info = smi_info_alloc();
2611 "could not allocate memory for OF probe\n");
2615 info->si_type = (enum si_type) match->data;
2616 info->addr_source = SI_DEVICETREE;
2617 info->irq_setup = std_irq_setup;
2619 if (resource.flags & IORESOURCE_IO) {
2620 info->io_setup = port_setup;
2621 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2623 info->io_setup = mem_setup;
2624 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2627 info->io.addr_data = resource.start;
2629 info->io.regsize = regsize ? be32_to_cpup(regsize) : DEFAULT_REGSIZE;
2630 info->io.regspacing = regspacing ? be32_to_cpup(regspacing) : DEFAULT_REGSPACING;
2631 info->io.regshift = regshift ? be32_to_cpup(regshift) : 0;
2633 info->irq = irq_of_parse_and_map(dev->dev.of_node, 0);
2634 info->dev = &dev->dev;
2636 dev_dbg(&dev->dev, "addr 0x%lx regsize %d spacing %d irq %d\n",
2637 info->io.addr_data, info->io.regsize, info->io.regspacing,
2640 dev_set_drvdata(&dev->dev, info);
2642 ret = add_smi(info);
2649 MODULE_DEVICE_TABLE(of, of_ipmi_match);
2651 #define of_ipmi_match NULL
2652 static int of_ipmi_probe(struct platform_device *dev)
2659 static int acpi_ipmi_probe(struct platform_device *dev)
2661 struct smi_info *info;
2662 struct resource *res, *res_second;
2665 unsigned long long tmp;
2668 handle = ACPI_HANDLE(&dev->dev);
2672 info = smi_info_alloc();
2676 info->addr_source = SI_ACPI;
2677 dev_info(&dev->dev, PFX "probing via ACPI\n");
2679 info->addr_info.acpi_info.acpi_handle = handle;
2681 /* _IFT tells us the interface type: KCS, BT, etc */
2682 status = acpi_evaluate_integer(handle, "_IFT", NULL, &tmp);
2683 if (ACPI_FAILURE(status)) {
2684 dev_err(&dev->dev, "Could not find ACPI IPMI interface type\n");
2690 info->si_type = SI_KCS;
2693 info->si_type = SI_SMIC;
2696 info->si_type = SI_BT;
2698 case 4: /* SSIF, just ignore */
2702 dev_info(&dev->dev, "unknown IPMI type %lld\n", tmp);
2706 res = platform_get_resource(dev, IORESOURCE_IO, 0);
2708 info->io_setup = port_setup;
2709 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2711 res = platform_get_resource(dev, IORESOURCE_MEM, 0);
2713 info->io_setup = mem_setup;
2714 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2718 dev_err(&dev->dev, "no I/O or memory address\n");
2721 info->io.addr_data = res->start;
2723 info->io.regspacing = DEFAULT_REGSPACING;
2724 res_second = platform_get_resource(dev,
2725 (info->io.addr_type == IPMI_IO_ADDR_SPACE) ?
2726 IORESOURCE_IO : IORESOURCE_MEM,
2729 if (res_second->start > info->io.addr_data)
2730 info->io.regspacing =
2731 res_second->start - info->io.addr_data;
2733 info->io.regsize = DEFAULT_REGSPACING;
2734 info->io.regshift = 0;
2736 /* If _GPE exists, use it; otherwise use standard interrupts */
2737 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
2738 if (ACPI_SUCCESS(status)) {
2740 info->irq_setup = acpi_gpe_irq_setup;
2742 int irq = platform_get_irq(dev, 0);
2746 info->irq_setup = std_irq_setup;
2750 info->dev = &dev->dev;
2751 platform_set_drvdata(dev, info);
2753 dev_info(info->dev, "%pR regsize %d spacing %d irq %d\n",
2754 res, info->io.regsize, info->io.regspacing,
2768 static const struct acpi_device_id acpi_ipmi_match[] = {
2772 MODULE_DEVICE_TABLE(acpi, acpi_ipmi_match);
2774 static int acpi_ipmi_probe(struct platform_device *dev)
2780 static int ipmi_probe(struct platform_device *dev)
2782 if (of_ipmi_probe(dev) == 0)
2785 return acpi_ipmi_probe(dev);
2788 static int ipmi_remove(struct platform_device *dev)
2790 struct smi_info *info = dev_get_drvdata(&dev->dev);
2792 cleanup_one_si(info);
2796 static struct platform_driver ipmi_driver = {
2798 .name = DEVICE_NAME,
2799 .of_match_table = of_ipmi_match,
2800 .acpi_match_table = ACPI_PTR(acpi_ipmi_match),
2802 .probe = ipmi_probe,
2803 .remove = ipmi_remove,
2806 #ifdef CONFIG_PARISC
2807 static int ipmi_parisc_probe(struct parisc_device *dev)
2809 struct smi_info *info;
2812 info = smi_info_alloc();
2816 "could not allocate memory for PARISC probe\n");
2820 info->si_type = SI_KCS;
2821 info->addr_source = SI_DEVICETREE;
2822 info->io_setup = mem_setup;
2823 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2824 info->io.addr_data = dev->hpa.start;
2825 info->io.regsize = 1;
2826 info->io.regspacing = 1;
2827 info->io.regshift = 0;
2828 info->irq = 0; /* no interrupt */
2829 info->irq_setup = NULL;
2830 info->dev = &dev->dev;
2832 dev_dbg(&dev->dev, "addr 0x%lx\n", info->io.addr_data);
2834 dev_set_drvdata(&dev->dev, info);
2845 static int ipmi_parisc_remove(struct parisc_device *dev)
2847 cleanup_one_si(dev_get_drvdata(&dev->dev));
2851 static struct parisc_device_id ipmi_parisc_tbl[] = {
2852 { HPHW_MC, HVERSION_REV_ANY_ID, 0x004, 0xC0 },
2856 static struct parisc_driver ipmi_parisc_driver = {
2858 .id_table = ipmi_parisc_tbl,
2859 .probe = ipmi_parisc_probe,
2860 .remove = ipmi_parisc_remove,
2862 #endif /* CONFIG_PARISC */
2864 static int wait_for_msg_done(struct smi_info *smi_info)
2866 enum si_sm_result smi_result;
2868 smi_result = smi_info->handlers->event(smi_info->si_sm, 0);
2870 if (smi_result == SI_SM_CALL_WITH_DELAY ||
2871 smi_result == SI_SM_CALL_WITH_TICK_DELAY) {
2872 schedule_timeout_uninterruptible(1);
2873 smi_result = smi_info->handlers->event(
2874 smi_info->si_sm, jiffies_to_usecs(1));
2875 } else if (smi_result == SI_SM_CALL_WITHOUT_DELAY) {
2876 smi_result = smi_info->handlers->event(
2877 smi_info->si_sm, 0);
2881 if (smi_result == SI_SM_HOSED)
2883 * We couldn't get the state machine to run, so whatever's at
2884 * the port is probably not an IPMI SMI interface.
2891 static int try_get_dev_id(struct smi_info *smi_info)
2893 unsigned char msg[2];
2894 unsigned char *resp;
2895 unsigned long resp_len;
2898 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
2903 * Do a Get Device ID command, since it comes back with some
2906 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2907 msg[1] = IPMI_GET_DEVICE_ID_CMD;
2908 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
2910 rv = wait_for_msg_done(smi_info);
2914 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2915 resp, IPMI_MAX_MSG_LENGTH);
2917 /* Check and record info from the get device id, in case we need it. */
2918 rv = ipmi_demangle_device_id(resp, resp_len, &smi_info->device_id);
2925 static int get_global_enables(struct smi_info *smi_info, u8 *enables)
2927 unsigned char msg[3];
2928 unsigned char *resp;
2929 unsigned long resp_len;
2932 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
2936 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2937 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
2938 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
2940 rv = wait_for_msg_done(smi_info);
2942 dev_warn(smi_info->dev,
2943 "Error getting response from get global enables command: %d\n",
2948 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2949 resp, IPMI_MAX_MSG_LENGTH);
2952 resp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2 ||
2953 resp[1] != IPMI_GET_BMC_GLOBAL_ENABLES_CMD ||
2955 dev_warn(smi_info->dev,
2956 "Invalid return from get global enables command: %ld %x %x %x\n",
2957 resp_len, resp[0], resp[1], resp[2]);
2970 * Returns 1 if it gets an error from the command.
2972 static int set_global_enables(struct smi_info *smi_info, u8 enables)
2974 unsigned char msg[3];
2975 unsigned char *resp;
2976 unsigned long resp_len;
2979 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
2983 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2984 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
2986 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 3);
2988 rv = wait_for_msg_done(smi_info);
2990 dev_warn(smi_info->dev,
2991 "Error getting response from set global enables command: %d\n",
2996 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2997 resp, IPMI_MAX_MSG_LENGTH);
3000 resp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2 ||
3001 resp[1] != IPMI_SET_BMC_GLOBAL_ENABLES_CMD) {
3002 dev_warn(smi_info->dev,
3003 "Invalid return from set global enables command: %ld %x %x\n",
3004 resp_len, resp[0], resp[1]);
3018 * Some BMCs do not support clearing the receive irq bit in the global
3019 * enables (even if they don't support interrupts on the BMC). Check
3020 * for this and handle it properly.
3022 static void check_clr_rcv_irq(struct smi_info *smi_info)
3027 rv = get_global_enables(smi_info, &enables);
3029 if ((enables & IPMI_BMC_RCV_MSG_INTR) == 0)
3030 /* Already clear, should work ok. */
3033 enables &= ~IPMI_BMC_RCV_MSG_INTR;
3034 rv = set_global_enables(smi_info, enables);
3038 dev_err(smi_info->dev,
3039 "Cannot check clearing the rcv irq: %d\n", rv);
3045 * An error when setting the event buffer bit means
3046 * clearing the bit is not supported.
3048 dev_warn(smi_info->dev,
3049 "The BMC does not support clearing the recv irq bit, compensating, but the BMC needs to be fixed.\n");
3050 smi_info->cannot_disable_irq = true;
3055 * Some BMCs do not support setting the interrupt bits in the global
3056 * enables even if they support interrupts. Clearly bad, but we can
3059 static void check_set_rcv_irq(struct smi_info *smi_info)
3067 rv = get_global_enables(smi_info, &enables);
3069 enables |= IPMI_BMC_RCV_MSG_INTR;
3070 rv = set_global_enables(smi_info, enables);
3074 dev_err(smi_info->dev,
3075 "Cannot check setting the rcv irq: %d\n", rv);
3081 * An error when setting the event buffer bit means
3082 * setting the bit is not supported.
3084 dev_warn(smi_info->dev,
3085 "The BMC does not support setting the recv irq bit, compensating, but the BMC needs to be fixed.\n");
3086 smi_info->cannot_disable_irq = true;
3087 smi_info->irq_enable_broken = true;
3091 static int try_enable_event_buffer(struct smi_info *smi_info)
3093 unsigned char msg[3];
3094 unsigned char *resp;
3095 unsigned long resp_len;
3098 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
3102 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
3103 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
3104 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
3106 rv = wait_for_msg_done(smi_info);
3108 printk(KERN_WARNING PFX "Error getting response from get"
3109 " global enables command, the event buffer is not"
3114 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
3115 resp, IPMI_MAX_MSG_LENGTH);
3118 resp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2 ||
3119 resp[1] != IPMI_GET_BMC_GLOBAL_ENABLES_CMD ||
3121 printk(KERN_WARNING PFX "Invalid return from get global"
3122 " enables command, cannot enable the event buffer.\n");
3127 if (resp[3] & IPMI_BMC_EVT_MSG_BUFF) {
3128 /* buffer is already enabled, nothing to do. */
3129 smi_info->supports_event_msg_buff = true;
3133 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
3134 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
3135 msg[2] = resp[3] | IPMI_BMC_EVT_MSG_BUFF;
3136 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 3);
3138 rv = wait_for_msg_done(smi_info);
3140 printk(KERN_WARNING PFX "Error getting response from set"
3141 " global, enables command, the event buffer is not"
3146 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
3147 resp, IPMI_MAX_MSG_LENGTH);
3150 resp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2 ||
3151 resp[1] != IPMI_SET_BMC_GLOBAL_ENABLES_CMD) {
3152 printk(KERN_WARNING PFX "Invalid return from get global,"
3153 "enables command, not enable the event buffer.\n");
3160 * An error when setting the event buffer bit means
3161 * that the event buffer is not supported.
3165 smi_info->supports_event_msg_buff = true;
3172 static int smi_type_proc_show(struct seq_file *m, void *v)
3174 struct smi_info *smi = m->private;
3176 seq_printf(m, "%s\n", si_to_str[smi->si_type]);
3181 static int smi_type_proc_open(struct inode *inode, struct file *file)
3183 return single_open(file, smi_type_proc_show, PDE_DATA(inode));
3186 static const struct file_operations smi_type_proc_ops = {
3187 .open = smi_type_proc_open,
3189 .llseek = seq_lseek,
3190 .release = single_release,
3193 static int smi_si_stats_proc_show(struct seq_file *m, void *v)
3195 struct smi_info *smi = m->private;
3197 seq_printf(m, "interrupts_enabled: %d\n",
3198 smi->irq && !smi->interrupt_disabled);
3199 seq_printf(m, "short_timeouts: %u\n",
3200 smi_get_stat(smi, short_timeouts));
3201 seq_printf(m, "long_timeouts: %u\n",
3202 smi_get_stat(smi, long_timeouts));
3203 seq_printf(m, "idles: %u\n",
3204 smi_get_stat(smi, idles));
3205 seq_printf(m, "interrupts: %u\n",
3206 smi_get_stat(smi, interrupts));
3207 seq_printf(m, "attentions: %u\n",
3208 smi_get_stat(smi, attentions));
3209 seq_printf(m, "flag_fetches: %u\n",
3210 smi_get_stat(smi, flag_fetches));
3211 seq_printf(m, "hosed_count: %u\n",
3212 smi_get_stat(smi, hosed_count));
3213 seq_printf(m, "complete_transactions: %u\n",
3214 smi_get_stat(smi, complete_transactions));
3215 seq_printf(m, "events: %u\n",
3216 smi_get_stat(smi, events));
3217 seq_printf(m, "watchdog_pretimeouts: %u\n",
3218 smi_get_stat(smi, watchdog_pretimeouts));
3219 seq_printf(m, "incoming_messages: %u\n",
3220 smi_get_stat(smi, incoming_messages));
3224 static int smi_si_stats_proc_open(struct inode *inode, struct file *file)
3226 return single_open(file, smi_si_stats_proc_show, PDE_DATA(inode));
3229 static const struct file_operations smi_si_stats_proc_ops = {
3230 .open = smi_si_stats_proc_open,
3232 .llseek = seq_lseek,
3233 .release = single_release,
3236 static int smi_params_proc_show(struct seq_file *m, void *v)
3238 struct smi_info *smi = m->private;
3241 "%s,%s,0x%lx,rsp=%d,rsi=%d,rsh=%d,irq=%d,ipmb=%d\n",
3242 si_to_str[smi->si_type],
3243 addr_space_to_str[smi->io.addr_type],
3254 static int smi_params_proc_open(struct inode *inode, struct file *file)
3256 return single_open(file, smi_params_proc_show, PDE_DATA(inode));
3259 static const struct file_operations smi_params_proc_ops = {
3260 .open = smi_params_proc_open,
3262 .llseek = seq_lseek,
3263 .release = single_release,
3267 * oem_data_avail_to_receive_msg_avail
3268 * @info - smi_info structure with msg_flags set
3270 * Converts flags from OEM_DATA_AVAIL to RECEIVE_MSG_AVAIL
3271 * Returns 1 indicating need to re-run handle_flags().
3273 static int oem_data_avail_to_receive_msg_avail(struct smi_info *smi_info)
3275 smi_info->msg_flags = ((smi_info->msg_flags & ~OEM_DATA_AVAIL) |
3281 * setup_dell_poweredge_oem_data_handler
3282 * @info - smi_info.device_id must be populated
3284 * Systems that match, but have firmware version < 1.40 may assert
3285 * OEM0_DATA_AVAIL on their own, without being told via Set Flags that
3286 * it's safe to do so. Such systems will de-assert OEM1_DATA_AVAIL
3287 * upon receipt of IPMI_GET_MSG_CMD, so we should treat these flags
3288 * as RECEIVE_MSG_AVAIL instead.
3290 * As Dell has no plans to release IPMI 1.5 firmware that *ever*
3291 * assert the OEM[012] bits, and if it did, the driver would have to
3292 * change to handle that properly, we don't actually check for the
3294 * Device ID = 0x20 BMC on PowerEdge 8G servers
3295 * Device Revision = 0x80
3296 * Firmware Revision1 = 0x01 BMC version 1.40
3297 * Firmware Revision2 = 0x40 BCD encoded
3298 * IPMI Version = 0x51 IPMI 1.5
3299 * Manufacturer ID = A2 02 00 Dell IANA
3301 * Additionally, PowerEdge systems with IPMI < 1.5 may also assert
3302 * OEM0_DATA_AVAIL and needs to be treated as RECEIVE_MSG_AVAIL.
3305 #define DELL_POWEREDGE_8G_BMC_DEVICE_ID 0x20
3306 #define DELL_POWEREDGE_8G_BMC_DEVICE_REV 0x80
3307 #define DELL_POWEREDGE_8G_BMC_IPMI_VERSION 0x51
3308 #define DELL_IANA_MFR_ID 0x0002a2
3309 static void setup_dell_poweredge_oem_data_handler(struct smi_info *smi_info)
3311 struct ipmi_device_id *id = &smi_info->device_id;
3312 if (id->manufacturer_id == DELL_IANA_MFR_ID) {
3313 if (id->device_id == DELL_POWEREDGE_8G_BMC_DEVICE_ID &&
3314 id->device_revision == DELL_POWEREDGE_8G_BMC_DEVICE_REV &&
3315 id->ipmi_version == DELL_POWEREDGE_8G_BMC_IPMI_VERSION) {
3316 smi_info->oem_data_avail_handler =
3317 oem_data_avail_to_receive_msg_avail;
3318 } else if (ipmi_version_major(id) < 1 ||
3319 (ipmi_version_major(id) == 1 &&
3320 ipmi_version_minor(id) < 5)) {
3321 smi_info->oem_data_avail_handler =
3322 oem_data_avail_to_receive_msg_avail;
3327 #define CANNOT_RETURN_REQUESTED_LENGTH 0xCA
3328 static void return_hosed_msg_badsize(struct smi_info *smi_info)
3330 struct ipmi_smi_msg *msg = smi_info->curr_msg;
3332 /* Make it a response */
3333 msg->rsp[0] = msg->data[0] | 4;
3334 msg->rsp[1] = msg->data[1];
3335 msg->rsp[2] = CANNOT_RETURN_REQUESTED_LENGTH;
3337 smi_info->curr_msg = NULL;
3338 deliver_recv_msg(smi_info, msg);
3342 * dell_poweredge_bt_xaction_handler
3343 * @info - smi_info.device_id must be populated
3345 * Dell PowerEdge servers with the BT interface (x6xx and 1750) will
3346 * not respond to a Get SDR command if the length of the data
3347 * requested is exactly 0x3A, which leads to command timeouts and no
3348 * data returned. This intercepts such commands, and causes userspace
3349 * callers to try again with a different-sized buffer, which succeeds.
3352 #define STORAGE_NETFN 0x0A
3353 #define STORAGE_CMD_GET_SDR 0x23
3354 static int dell_poweredge_bt_xaction_handler(struct notifier_block *self,
3355 unsigned long unused,
3358 struct smi_info *smi_info = in;
3359 unsigned char *data = smi_info->curr_msg->data;
3360 unsigned int size = smi_info->curr_msg->data_size;
3362 (data[0]>>2) == STORAGE_NETFN &&
3363 data[1] == STORAGE_CMD_GET_SDR &&
3365 return_hosed_msg_badsize(smi_info);
3371 static struct notifier_block dell_poweredge_bt_xaction_notifier = {
3372 .notifier_call = dell_poweredge_bt_xaction_handler,
3376 * setup_dell_poweredge_bt_xaction_handler
3377 * @info - smi_info.device_id must be filled in already
3379 * Fills in smi_info.device_id.start_transaction_pre_hook
3380 * when we know what function to use there.
3383 setup_dell_poweredge_bt_xaction_handler(struct smi_info *smi_info)
3385 struct ipmi_device_id *id = &smi_info->device_id;
3386 if (id->manufacturer_id == DELL_IANA_MFR_ID &&
3387 smi_info->si_type == SI_BT)
3388 register_xaction_notifier(&dell_poweredge_bt_xaction_notifier);
3392 * setup_oem_data_handler
3393 * @info - smi_info.device_id must be filled in already
3395 * Fills in smi_info.device_id.oem_data_available_handler
3396 * when we know what function to use there.
3399 static void setup_oem_data_handler(struct smi_info *smi_info)
3401 setup_dell_poweredge_oem_data_handler(smi_info);
3404 static void setup_xaction_handlers(struct smi_info *smi_info)
3406 setup_dell_poweredge_bt_xaction_handler(smi_info);
3409 static void check_for_broken_irqs(struct smi_info *smi_info)
3411 check_clr_rcv_irq(smi_info);
3412 check_set_rcv_irq(smi_info);
3415 static inline void wait_for_timer_and_thread(struct smi_info *smi_info)
3417 if (smi_info->thread != NULL)
3418 kthread_stop(smi_info->thread);
3419 if (smi_info->timer_running)
3420 del_timer_sync(&smi_info->si_timer);
3423 static const struct ipmi_default_vals
3429 { .type = SI_KCS, .port = 0xca2 },
3430 { .type = SI_SMIC, .port = 0xca9 },
3431 { .type = SI_BT, .port = 0xe4 },
3435 static void default_find_bmc(void)
3437 struct smi_info *info;
3440 for (i = 0; ; i++) {
3441 if (!ipmi_defaults[i].port)
3444 if (check_legacy_ioport(ipmi_defaults[i].port))
3447 info = smi_info_alloc();
3451 info->addr_source = SI_DEFAULT;
3453 info->si_type = ipmi_defaults[i].type;
3454 info->io_setup = port_setup;
3455 info->io.addr_data = ipmi_defaults[i].port;
3456 info->io.addr_type = IPMI_IO_ADDR_SPACE;
3458 info->io.addr = NULL;
3459 info->io.regspacing = DEFAULT_REGSPACING;
3460 info->io.regsize = DEFAULT_REGSPACING;
3461 info->io.regshift = 0;
3463 if (add_smi(info) == 0) {
3464 if ((try_smi_init(info)) == 0) {
3466 printk(KERN_INFO PFX "Found default %s"
3467 " state machine at %s address 0x%lx\n",
3468 si_to_str[info->si_type],
3469 addr_space_to_str[info->io.addr_type],
3470 info->io.addr_data);
3472 cleanup_one_si(info);
3479 static int is_new_interface(struct smi_info *info)
3483 list_for_each_entry(e, &smi_infos, link) {
3484 if (e->io.addr_type != info->io.addr_type)
3486 if (e->io.addr_data == info->io.addr_data)
3493 static int add_smi(struct smi_info *new_smi)
3497 printk(KERN_INFO PFX "Adding %s-specified %s state machine",
3498 ipmi_addr_src_to_str(new_smi->addr_source),
3499 si_to_str[new_smi->si_type]);
3500 mutex_lock(&smi_infos_lock);
3501 if (!is_new_interface(new_smi)) {
3502 printk(KERN_CONT " duplicate interface\n");
3507 printk(KERN_CONT "\n");
3509 /* So we know not to free it unless we have allocated one. */
3510 new_smi->intf = NULL;
3511 new_smi->si_sm = NULL;
3512 new_smi->handlers = NULL;
3514 list_add_tail(&new_smi->link, &smi_infos);
3517 mutex_unlock(&smi_infos_lock);
3521 static int try_smi_init(struct smi_info *new_smi)
3526 printk(KERN_INFO PFX "Trying %s-specified %s state"
3527 " machine at %s address 0x%lx, slave address 0x%x,"
3529 ipmi_addr_src_to_str(new_smi->addr_source),
3530 si_to_str[new_smi->si_type],
3531 addr_space_to_str[new_smi->io.addr_type],
3532 new_smi->io.addr_data,
3533 new_smi->slave_addr, new_smi->irq);
3535 switch (new_smi->si_type) {
3537 new_smi->handlers = &kcs_smi_handlers;
3541 new_smi->handlers = &smic_smi_handlers;
3545 new_smi->handlers = &bt_smi_handlers;
3549 /* No support for anything else yet. */
3554 /* Allocate the state machine's data and initialize it. */
3555 new_smi->si_sm = kmalloc(new_smi->handlers->size(), GFP_KERNEL);
3556 if (!new_smi->si_sm) {
3558 "Could not allocate state machine memory\n");
3562 new_smi->io_size = new_smi->handlers->init_data(new_smi->si_sm,
3565 /* Now that we know the I/O size, we can set up the I/O. */
3566 rv = new_smi->io_setup(new_smi);
3568 printk(KERN_ERR PFX "Could not set up I/O space\n");
3572 /* Do low-level detection first. */
3573 if (new_smi->handlers->detect(new_smi->si_sm)) {
3574 if (new_smi->addr_source)
3575 printk(KERN_INFO PFX "Interface detection failed\n");
3581 * Attempt a get device id command. If it fails, we probably
3582 * don't have a BMC here.
3584 rv = try_get_dev_id(new_smi);
3586 if (new_smi->addr_source)
3587 printk(KERN_INFO PFX "There appears to be no BMC"
3588 " at this location\n");
3592 setup_oem_data_handler(new_smi);
3593 setup_xaction_handlers(new_smi);
3594 check_for_broken_irqs(new_smi);
3596 new_smi->waiting_msg = NULL;
3597 new_smi->curr_msg = NULL;
3598 atomic_set(&new_smi->req_events, 0);
3599 new_smi->run_to_completion = false;
3600 for (i = 0; i < SI_NUM_STATS; i++)
3601 atomic_set(&new_smi->stats[i], 0);
3603 new_smi->interrupt_disabled = true;
3604 atomic_set(&new_smi->need_watch, 0);
3605 new_smi->intf_num = smi_num;
3608 rv = try_enable_event_buffer(new_smi);
3610 new_smi->has_event_buffer = true;
3613 * Start clearing the flags before we enable interrupts or the
3614 * timer to avoid racing with the timer.
3616 start_clear_flags(new_smi);
3619 * IRQ is defined to be set when non-zero. req_events will
3620 * cause a global flags check that will enable interrupts.
3623 new_smi->interrupt_disabled = false;
3624 atomic_set(&new_smi->req_events, 1);
3627 if (!new_smi->dev) {
3629 * If we don't already have a device from something
3630 * else (like PCI), then register a new one.
3632 new_smi->pdev = platform_device_alloc("ipmi_si",
3634 if (!new_smi->pdev) {
3636 "Unable to allocate platform device\n");
3639 new_smi->dev = &new_smi->pdev->dev;
3640 new_smi->dev->driver = &ipmi_driver.driver;
3642 rv = platform_device_add(new_smi->pdev);
3645 "Unable to register system interface device:"
3650 new_smi->dev_registered = true;
3653 rv = ipmi_register_smi(&handlers,
3655 &new_smi->device_id,
3657 new_smi->slave_addr);
3659 dev_err(new_smi->dev, "Unable to register device: error %d\n",
3661 goto out_err_stop_timer;
3664 rv = ipmi_smi_add_proc_entry(new_smi->intf, "type",
3668 dev_err(new_smi->dev, "Unable to create proc entry: %d\n", rv);
3669 goto out_err_stop_timer;
3672 rv = ipmi_smi_add_proc_entry(new_smi->intf, "si_stats",
3673 &smi_si_stats_proc_ops,
3676 dev_err(new_smi->dev, "Unable to create proc entry: %d\n", rv);
3677 goto out_err_stop_timer;
3680 rv = ipmi_smi_add_proc_entry(new_smi->intf, "params",
3681 &smi_params_proc_ops,
3684 dev_err(new_smi->dev, "Unable to create proc entry: %d\n", rv);
3685 goto out_err_stop_timer;
3688 dev_info(new_smi->dev, "IPMI %s interface initialized\n",
3689 si_to_str[new_smi->si_type]);
3694 wait_for_timer_and_thread(new_smi);
3697 new_smi->interrupt_disabled = true;
3699 if (new_smi->intf) {
3700 ipmi_smi_t intf = new_smi->intf;
3701 new_smi->intf = NULL;
3702 ipmi_unregister_smi(intf);
3705 if (new_smi->irq_cleanup) {
3706 new_smi->irq_cleanup(new_smi);
3707 new_smi->irq_cleanup = NULL;
3711 * Wait until we know that we are out of any interrupt
3712 * handlers might have been running before we freed the
3715 synchronize_sched();
3717 if (new_smi->si_sm) {
3718 if (new_smi->handlers)
3719 new_smi->handlers->cleanup(new_smi->si_sm);
3720 kfree(new_smi->si_sm);
3721 new_smi->si_sm = NULL;
3723 if (new_smi->addr_source_cleanup) {
3724 new_smi->addr_source_cleanup(new_smi);
3725 new_smi->addr_source_cleanup = NULL;
3727 if (new_smi->io_cleanup) {
3728 new_smi->io_cleanup(new_smi);
3729 new_smi->io_cleanup = NULL;
3732 if (new_smi->dev_registered) {
3733 platform_device_unregister(new_smi->pdev);
3734 new_smi->dev_registered = false;
3740 static int init_ipmi_si(void)
3746 enum ipmi_addr_src type = SI_INVALID;
3752 if (si_tryplatform) {
3753 rv = platform_driver_register(&ipmi_driver);
3755 printk(KERN_ERR PFX "Unable to register "
3756 "driver: %d\n", rv);
3761 /* Parse out the si_type string into its components. */
3764 for (i = 0; (i < SI_MAX_PARMS) && (*str != '\0'); i++) {
3766 str = strchr(str, ',');
3776 printk(KERN_INFO "IPMI System Interface driver.\n");
3778 /* If the user gave us a device, they presumably want us to use it */
3779 if (!hardcode_find_bmc())
3784 rv = pci_register_driver(&ipmi_pci_driver);
3786 printk(KERN_ERR PFX "Unable to register "
3787 "PCI driver: %d\n", rv);
3789 pci_registered = true;
3803 #ifdef CONFIG_PARISC
3804 register_parisc_driver(&ipmi_parisc_driver);
3805 parisc_registered = true;
3806 /* poking PC IO addresses will crash machine, don't do it */
3810 /* We prefer devices with interrupts, but in the case of a machine
3811 with multiple BMCs we assume that there will be several instances
3812 of a given type so if we succeed in registering a type then also
3813 try to register everything else of the same type */
3815 mutex_lock(&smi_infos_lock);
3816 list_for_each_entry(e, &smi_infos, link) {
3817 /* Try to register a device if it has an IRQ and we either
3818 haven't successfully registered a device yet or this
3819 device has the same type as one we successfully registered */
3820 if (e->irq && (!type || e->addr_source == type)) {
3821 if (!try_smi_init(e)) {
3822 type = e->addr_source;
3827 /* type will only have been set if we successfully registered an si */
3829 mutex_unlock(&smi_infos_lock);
3833 /* Fall back to the preferred device */
3835 list_for_each_entry(e, &smi_infos, link) {
3836 if (!e->irq && (!type || e->addr_source == type)) {
3837 if (!try_smi_init(e)) {
3838 type = e->addr_source;
3842 mutex_unlock(&smi_infos_lock);
3847 if (si_trydefaults) {
3848 mutex_lock(&smi_infos_lock);
3849 if (list_empty(&smi_infos)) {
3850 /* No BMC was found, try defaults. */
3851 mutex_unlock(&smi_infos_lock);
3854 mutex_unlock(&smi_infos_lock);
3857 mutex_lock(&smi_infos_lock);
3858 if (unload_when_empty && list_empty(&smi_infos)) {
3859 mutex_unlock(&smi_infos_lock);
3861 printk(KERN_WARNING PFX
3862 "Unable to find any System Interface(s)\n");
3865 mutex_unlock(&smi_infos_lock);
3869 module_init(init_ipmi_si);
3871 static void cleanup_one_si(struct smi_info *to_clean)
3878 if (to_clean->intf) {
3879 ipmi_smi_t intf = to_clean->intf;
3881 to_clean->intf = NULL;
3882 rv = ipmi_unregister_smi(intf);
3884 pr_err(PFX "Unable to unregister device: errno=%d\n",
3890 dev_set_drvdata(to_clean->dev, NULL);
3892 list_del(&to_clean->link);
3895 * Make sure that interrupts, the timer and the thread are
3896 * stopped and will not run again.
3898 if (to_clean->irq_cleanup)
3899 to_clean->irq_cleanup(to_clean);
3900 wait_for_timer_and_thread(to_clean);
3903 * Timeouts are stopped, now make sure the interrupts are off
3904 * in the BMC. Note that timers and CPU interrupts are off,
3905 * so no need for locks.
3907 while (to_clean->curr_msg || (to_clean->si_state != SI_NORMAL)) {
3909 schedule_timeout_uninterruptible(1);
3911 disable_si_irq(to_clean);
3912 while (to_clean->curr_msg || (to_clean->si_state != SI_NORMAL)) {
3914 schedule_timeout_uninterruptible(1);
3917 if (to_clean->handlers)
3918 to_clean->handlers->cleanup(to_clean->si_sm);
3920 kfree(to_clean->si_sm);
3922 if (to_clean->addr_source_cleanup)
3923 to_clean->addr_source_cleanup(to_clean);
3924 if (to_clean->io_cleanup)
3925 to_clean->io_cleanup(to_clean);
3927 if (to_clean->dev_registered)
3928 platform_device_unregister(to_clean->pdev);
3933 static void cleanup_ipmi_si(void)
3935 struct smi_info *e, *tmp_e;
3942 pci_unregister_driver(&ipmi_pci_driver);
3944 #ifdef CONFIG_PARISC
3945 if (parisc_registered)
3946 unregister_parisc_driver(&ipmi_parisc_driver);
3949 platform_driver_unregister(&ipmi_driver);
3951 mutex_lock(&smi_infos_lock);
3952 list_for_each_entry_safe(e, tmp_e, &smi_infos, link)
3954 mutex_unlock(&smi_infos_lock);
3956 module_exit(cleanup_ipmi_si);
3958 MODULE_LICENSE("GPL");
3959 MODULE_AUTHOR("Corey Minyard <minyard@mvista.com>");
3960 MODULE_DESCRIPTION("Interface to the IPMI driver for the KCS, SMIC, and BT"
3961 " system interfaces.");