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.
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the
15 * Free Software Foundation; either version 2 of the License, or (at your
16 * option) any later version.
19 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
20 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
25 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
27 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
28 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * You should have received a copy of the GNU General Public License along
31 * with this program; if not, write to the Free Software Foundation, Inc.,
32 * 675 Mass Ave, Cambridge, MA 02139, USA.
36 * This file holds the "policy" for the interface to the SMI state
37 * machine. It does the configuration, handles timers and interrupts,
38 * and drives the real SMI state machine.
41 #include <linux/config.h>
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>
55 #ifdef CONFIG_HIGH_RES_TIMERS
56 #include <linux/hrtime.h>
57 # if defined(schedule_next_int)
58 /* Old high-res timer code, do translations. */
59 # define get_arch_cycles(a) quick_update_jiffies_sub(a)
60 # define arch_cycles_per_jiffy cycles_per_jiffies
62 static inline void add_usec_to_timer(struct timer_list *t, long v)
64 t->sub_expires += nsec_to_arch_cycle(v * 1000);
65 while (t->sub_expires >= arch_cycles_per_jiffy)
68 t->sub_expires -= arch_cycles_per_jiffy;
72 #include <linux/interrupt.h>
73 #include <linux/rcupdate.h>
74 #include <linux/ipmi_smi.h>
76 #include "ipmi_si_sm.h"
77 #include <linux/init.h>
79 #define IPMI_SI_VERSION "v33"
81 /* Measure times between events in the driver. */
84 /* Call every 10 ms. */
85 #define SI_TIMEOUT_TIME_USEC 10000
86 #define SI_USEC_PER_JIFFY (1000000/HZ)
87 #define SI_TIMEOUT_JIFFIES (SI_TIMEOUT_TIME_USEC/SI_USEC_PER_JIFFY)
88 #define SI_SHORT_TIMEOUT_USEC 250 /* .25ms when the SM request a
96 SI_CLEARING_FLAGS_THEN_SET_IRQ,
98 SI_ENABLE_INTERRUPTS1,
100 /* FIXME - add watchdog stuff. */
104 SI_KCS, SI_SMIC, SI_BT
110 struct si_sm_data *si_sm;
111 struct si_sm_handlers *handlers;
112 enum si_type si_type;
115 struct list_head xmit_msgs;
116 struct list_head hp_xmit_msgs;
117 struct ipmi_smi_msg *curr_msg;
118 enum si_intf_state si_state;
120 /* Used to handle the various types of I/O that can occur with
123 int (*io_setup)(struct smi_info *info);
124 void (*io_cleanup)(struct smi_info *info);
125 int (*irq_setup)(struct smi_info *info);
126 void (*irq_cleanup)(struct smi_info *info);
127 unsigned int io_size;
129 /* Flags from the last GET_MSG_FLAGS command, used when an ATTN
130 is set to hold the flags until we are done handling everything
132 #define RECEIVE_MSG_AVAIL 0x01
133 #define EVENT_MSG_BUFFER_FULL 0x02
134 #define WDT_PRE_TIMEOUT_INT 0x08
135 unsigned char msg_flags;
137 /* If set to true, this will request events the next time the
138 state machine is idle. */
141 /* If true, run the state machine to completion on every send
142 call. Generally used after a panic to make sure stuff goes
144 int run_to_completion;
146 /* The I/O port of an SI interface. */
149 /* The space between start addresses of the two ports. For
150 instance, if the first port is 0xca2 and the spacing is 4, then
151 the second port is 0xca6. */
152 unsigned int spacing;
154 /* zero if no irq; */
157 /* The timer for this si. */
158 struct timer_list si_timer;
160 /* The time (in jiffies) the last timeout occurred at. */
161 unsigned long last_timeout_jiffies;
163 /* Used to gracefully stop the timer without race conditions. */
164 volatile int stop_operation;
165 volatile int timer_stopped;
167 /* The driver will disable interrupts when it gets into a
168 situation where it cannot handle messages due to lack of
169 memory. Once that situation clears up, it will re-enable
171 int interrupt_disabled;
173 unsigned char ipmi_si_dev_rev;
174 unsigned char ipmi_si_fw_rev_major;
175 unsigned char ipmi_si_fw_rev_minor;
176 unsigned char ipmi_version_major;
177 unsigned char ipmi_version_minor;
179 /* Counters and things for the proc filesystem. */
180 spinlock_t count_lock;
181 unsigned long short_timeouts;
182 unsigned long long_timeouts;
183 unsigned long timeout_restarts;
185 unsigned long interrupts;
186 unsigned long attentions;
187 unsigned long flag_fetches;
188 unsigned long hosed_count;
189 unsigned long complete_transactions;
190 unsigned long events;
191 unsigned long watchdog_pretimeouts;
192 unsigned long incoming_messages;
195 static void si_restart_short_timer(struct smi_info *smi_info);
197 static void deliver_recv_msg(struct smi_info *smi_info,
198 struct ipmi_smi_msg *msg)
200 /* Deliver the message to the upper layer with the lock
202 spin_unlock(&(smi_info->si_lock));
203 ipmi_smi_msg_received(smi_info->intf, msg);
204 spin_lock(&(smi_info->si_lock));
207 static void return_hosed_msg(struct smi_info *smi_info)
209 struct ipmi_smi_msg *msg = smi_info->curr_msg;
211 /* Make it a reponse */
212 msg->rsp[0] = msg->data[0] | 4;
213 msg->rsp[1] = msg->data[1];
214 msg->rsp[2] = 0xFF; /* Unknown error. */
217 smi_info->curr_msg = NULL;
218 deliver_recv_msg(smi_info, msg);
221 static enum si_sm_result start_next_msg(struct smi_info *smi_info)
224 struct list_head *entry = NULL;
229 /* No need to save flags, we aleady have interrupts off and we
230 already hold the SMI lock. */
231 spin_lock(&(smi_info->msg_lock));
233 /* Pick the high priority queue first. */
234 if (! list_empty(&(smi_info->hp_xmit_msgs))) {
235 entry = smi_info->hp_xmit_msgs.next;
236 } else if (! list_empty(&(smi_info->xmit_msgs))) {
237 entry = smi_info->xmit_msgs.next;
241 smi_info->curr_msg = NULL;
247 smi_info->curr_msg = list_entry(entry,
252 printk("**Start2: %d.%9.9d\n", t.tv_sec, t.tv_usec);
254 err = smi_info->handlers->start_transaction(
256 smi_info->curr_msg->data,
257 smi_info->curr_msg->data_size);
259 return_hosed_msg(smi_info);
262 rv = SI_SM_CALL_WITHOUT_DELAY;
264 spin_unlock(&(smi_info->msg_lock));
269 static void start_enable_irq(struct smi_info *smi_info)
271 unsigned char msg[2];
273 /* If we are enabling interrupts, we have to tell the
275 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
276 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
278 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
279 smi_info->si_state = SI_ENABLE_INTERRUPTS1;
282 static void start_clear_flags(struct smi_info *smi_info)
284 unsigned char msg[3];
286 /* Make sure the watchdog pre-timeout flag is not set at startup. */
287 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
288 msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
289 msg[2] = WDT_PRE_TIMEOUT_INT;
291 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 3);
292 smi_info->si_state = SI_CLEARING_FLAGS;
295 /* When we have a situtaion where we run out of memory and cannot
296 allocate messages, we just leave them in the BMC and run the system
297 polled until we can allocate some memory. Once we have some
298 memory, we will re-enable the interrupt. */
299 static inline void disable_si_irq(struct smi_info *smi_info)
301 if ((smi_info->irq) && (!smi_info->interrupt_disabled)) {
302 disable_irq_nosync(smi_info->irq);
303 smi_info->interrupt_disabled = 1;
307 static inline void enable_si_irq(struct smi_info *smi_info)
309 if ((smi_info->irq) && (smi_info->interrupt_disabled)) {
310 enable_irq(smi_info->irq);
311 smi_info->interrupt_disabled = 0;
315 static void handle_flags(struct smi_info *smi_info)
317 if (smi_info->msg_flags & WDT_PRE_TIMEOUT_INT) {
318 /* Watchdog pre-timeout */
319 spin_lock(&smi_info->count_lock);
320 smi_info->watchdog_pretimeouts++;
321 spin_unlock(&smi_info->count_lock);
323 start_clear_flags(smi_info);
324 smi_info->msg_flags &= ~WDT_PRE_TIMEOUT_INT;
325 spin_unlock(&(smi_info->si_lock));
326 ipmi_smi_watchdog_pretimeout(smi_info->intf);
327 spin_lock(&(smi_info->si_lock));
328 } else if (smi_info->msg_flags & RECEIVE_MSG_AVAIL) {
329 /* Messages available. */
330 smi_info->curr_msg = ipmi_alloc_smi_msg();
331 if (!smi_info->curr_msg) {
332 disable_si_irq(smi_info);
333 smi_info->si_state = SI_NORMAL;
336 enable_si_irq(smi_info);
338 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
339 smi_info->curr_msg->data[1] = IPMI_GET_MSG_CMD;
340 smi_info->curr_msg->data_size = 2;
342 smi_info->handlers->start_transaction(
344 smi_info->curr_msg->data,
345 smi_info->curr_msg->data_size);
346 smi_info->si_state = SI_GETTING_MESSAGES;
347 } else if (smi_info->msg_flags & EVENT_MSG_BUFFER_FULL) {
348 /* Events available. */
349 smi_info->curr_msg = ipmi_alloc_smi_msg();
350 if (!smi_info->curr_msg) {
351 disable_si_irq(smi_info);
352 smi_info->si_state = SI_NORMAL;
355 enable_si_irq(smi_info);
357 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
358 smi_info->curr_msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
359 smi_info->curr_msg->data_size = 2;
361 smi_info->handlers->start_transaction(
363 smi_info->curr_msg->data,
364 smi_info->curr_msg->data_size);
365 smi_info->si_state = SI_GETTING_EVENTS;
367 smi_info->si_state = SI_NORMAL;
371 static void handle_transaction_done(struct smi_info *smi_info)
373 struct ipmi_smi_msg *msg;
378 printk("**Done: %d.%9.9d\n", t.tv_sec, t.tv_usec);
380 switch (smi_info->si_state) {
382 if (!smi_info->curr_msg)
385 smi_info->curr_msg->rsp_size
386 = smi_info->handlers->get_result(
388 smi_info->curr_msg->rsp,
389 IPMI_MAX_MSG_LENGTH);
391 /* Do this here becase deliver_recv_msg() releases the
392 lock, and a new message can be put in during the
393 time the lock is released. */
394 msg = smi_info->curr_msg;
395 smi_info->curr_msg = NULL;
396 deliver_recv_msg(smi_info, msg);
399 case SI_GETTING_FLAGS:
401 unsigned char msg[4];
404 /* We got the flags from the SMI, now handle them. */
405 len = smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
407 /* Error fetching flags, just give up for
409 smi_info->si_state = SI_NORMAL;
410 } else if (len < 3) {
411 /* Hmm, no flags. That's technically illegal, but
412 don't use uninitialized data. */
413 smi_info->si_state = SI_NORMAL;
415 smi_info->msg_flags = msg[3];
416 handle_flags(smi_info);
421 case SI_CLEARING_FLAGS:
422 case SI_CLEARING_FLAGS_THEN_SET_IRQ:
424 unsigned char msg[3];
426 /* We cleared the flags. */
427 smi_info->handlers->get_result(smi_info->si_sm, msg, 3);
429 /* Error clearing flags */
431 "ipmi_si: Error clearing flags: %2.2x\n",
434 if (smi_info->si_state == SI_CLEARING_FLAGS_THEN_SET_IRQ)
435 start_enable_irq(smi_info);
437 smi_info->si_state = SI_NORMAL;
441 case SI_GETTING_EVENTS:
443 smi_info->curr_msg->rsp_size
444 = smi_info->handlers->get_result(
446 smi_info->curr_msg->rsp,
447 IPMI_MAX_MSG_LENGTH);
449 /* Do this here becase deliver_recv_msg() releases the
450 lock, and a new message can be put in during the
451 time the lock is released. */
452 msg = smi_info->curr_msg;
453 smi_info->curr_msg = NULL;
454 if (msg->rsp[2] != 0) {
455 /* Error getting event, probably done. */
458 /* Take off the event flag. */
459 smi_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
460 handle_flags(smi_info);
462 spin_lock(&smi_info->count_lock);
464 spin_unlock(&smi_info->count_lock);
466 /* Do this before we deliver the message
467 because delivering the message releases the
468 lock and something else can mess with the
470 handle_flags(smi_info);
472 deliver_recv_msg(smi_info, msg);
477 case SI_GETTING_MESSAGES:
479 smi_info->curr_msg->rsp_size
480 = smi_info->handlers->get_result(
482 smi_info->curr_msg->rsp,
483 IPMI_MAX_MSG_LENGTH);
485 /* Do this here becase deliver_recv_msg() releases the
486 lock, and a new message can be put in during the
487 time the lock is released. */
488 msg = smi_info->curr_msg;
489 smi_info->curr_msg = NULL;
490 if (msg->rsp[2] != 0) {
491 /* Error getting event, probably done. */
494 /* Take off the msg flag. */
495 smi_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
496 handle_flags(smi_info);
498 spin_lock(&smi_info->count_lock);
499 smi_info->incoming_messages++;
500 spin_unlock(&smi_info->count_lock);
502 /* Do this before we deliver the message
503 because delivering the message releases the
504 lock and something else can mess with the
506 handle_flags(smi_info);
508 deliver_recv_msg(smi_info, msg);
513 case SI_ENABLE_INTERRUPTS1:
515 unsigned char msg[4];
517 /* We got the flags from the SMI, now handle them. */
518 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
521 "ipmi_si: Could not enable interrupts"
522 ", failed get, using polled mode.\n");
523 smi_info->si_state = SI_NORMAL;
525 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
526 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
527 msg[2] = msg[3] | 1; /* enable msg queue int */
528 smi_info->handlers->start_transaction(
529 smi_info->si_sm, msg, 3);
530 smi_info->si_state = SI_ENABLE_INTERRUPTS2;
535 case SI_ENABLE_INTERRUPTS2:
537 unsigned char msg[4];
539 /* We got the flags from the SMI, now handle them. */
540 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
543 "ipmi_si: Could not enable interrupts"
544 ", failed set, using polled mode.\n");
546 smi_info->si_state = SI_NORMAL;
552 /* Called on timeouts and events. Timeouts should pass the elapsed
553 time, interrupts should pass in zero. */
554 static enum si_sm_result smi_event_handler(struct smi_info *smi_info,
557 enum si_sm_result si_sm_result;
560 /* There used to be a loop here that waited a little while
561 (around 25us) before giving up. That turned out to be
562 pointless, the minimum delays I was seeing were in the 300us
563 range, which is far too long to wait in an interrupt. So
564 we just run until the state machine tells us something
565 happened or it needs a delay. */
566 si_sm_result = smi_info->handlers->event(smi_info->si_sm, time);
568 while (si_sm_result == SI_SM_CALL_WITHOUT_DELAY)
570 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
573 if (si_sm_result == SI_SM_TRANSACTION_COMPLETE)
575 spin_lock(&smi_info->count_lock);
576 smi_info->complete_transactions++;
577 spin_unlock(&smi_info->count_lock);
579 handle_transaction_done(smi_info);
580 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
582 else if (si_sm_result == SI_SM_HOSED)
584 spin_lock(&smi_info->count_lock);
585 smi_info->hosed_count++;
586 spin_unlock(&smi_info->count_lock);
588 /* Do the before return_hosed_msg, because that
589 releases the lock. */
590 smi_info->si_state = SI_NORMAL;
591 if (smi_info->curr_msg != NULL) {
592 /* If we were handling a user message, format
593 a response to send to the upper layer to
594 tell it about the error. */
595 return_hosed_msg(smi_info);
597 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
600 /* We prefer handling attn over new messages. */
601 if (si_sm_result == SI_SM_ATTN)
603 unsigned char msg[2];
605 spin_lock(&smi_info->count_lock);
606 smi_info->attentions++;
607 spin_unlock(&smi_info->count_lock);
609 /* Got a attn, send down a get message flags to see
610 what's causing it. It would be better to handle
611 this in the upper layer, but due to the way
612 interrupts work with the SMI, that's not really
614 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
615 msg[1] = IPMI_GET_MSG_FLAGS_CMD;
617 smi_info->handlers->start_transaction(
618 smi_info->si_sm, msg, 2);
619 smi_info->si_state = SI_GETTING_FLAGS;
623 /* If we are currently idle, try to start the next message. */
624 if (si_sm_result == SI_SM_IDLE) {
625 spin_lock(&smi_info->count_lock);
627 spin_unlock(&smi_info->count_lock);
629 si_sm_result = start_next_msg(smi_info);
630 if (si_sm_result != SI_SM_IDLE)
634 if ((si_sm_result == SI_SM_IDLE)
635 && (atomic_read(&smi_info->req_events)))
637 /* We are idle and the upper layer requested that I fetch
639 unsigned char msg[2];
641 spin_lock(&smi_info->count_lock);
642 smi_info->flag_fetches++;
643 spin_unlock(&smi_info->count_lock);
645 atomic_set(&smi_info->req_events, 0);
646 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
647 msg[1] = IPMI_GET_MSG_FLAGS_CMD;
649 smi_info->handlers->start_transaction(
650 smi_info->si_sm, msg, 2);
651 smi_info->si_state = SI_GETTING_FLAGS;
658 static void sender(void *send_info,
659 struct ipmi_smi_msg *msg,
662 struct smi_info *smi_info = send_info;
663 enum si_sm_result result;
669 spin_lock_irqsave(&(smi_info->msg_lock), flags);
672 printk("**Enqueue: %d.%9.9d\n", t.tv_sec, t.tv_usec);
675 if (smi_info->run_to_completion) {
676 /* If we are running to completion, then throw it in
677 the list and run transactions until everything is
678 clear. Priority doesn't matter here. */
679 list_add_tail(&(msg->link), &(smi_info->xmit_msgs));
681 /* We have to release the msg lock and claim the smi
682 lock in this case, because of race conditions. */
683 spin_unlock_irqrestore(&(smi_info->msg_lock), flags);
685 spin_lock_irqsave(&(smi_info->si_lock), flags);
686 result = smi_event_handler(smi_info, 0);
687 while (result != SI_SM_IDLE) {
688 udelay(SI_SHORT_TIMEOUT_USEC);
689 result = smi_event_handler(smi_info,
690 SI_SHORT_TIMEOUT_USEC);
692 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
696 list_add_tail(&(msg->link), &(smi_info->hp_xmit_msgs));
698 list_add_tail(&(msg->link), &(smi_info->xmit_msgs));
701 spin_unlock_irqrestore(&(smi_info->msg_lock), flags);
703 spin_lock_irqsave(&(smi_info->si_lock), flags);
704 if ((smi_info->si_state == SI_NORMAL)
705 && (smi_info->curr_msg == NULL))
707 start_next_msg(smi_info);
708 si_restart_short_timer(smi_info);
710 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
713 static void set_run_to_completion(void *send_info, int i_run_to_completion)
715 struct smi_info *smi_info = send_info;
716 enum si_sm_result result;
719 spin_lock_irqsave(&(smi_info->si_lock), flags);
721 smi_info->run_to_completion = i_run_to_completion;
722 if (i_run_to_completion) {
723 result = smi_event_handler(smi_info, 0);
724 while (result != SI_SM_IDLE) {
725 udelay(SI_SHORT_TIMEOUT_USEC);
726 result = smi_event_handler(smi_info,
727 SI_SHORT_TIMEOUT_USEC);
731 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
734 static void poll(void *send_info)
736 struct smi_info *smi_info = send_info;
738 smi_event_handler(smi_info, 0);
741 static void request_events(void *send_info)
743 struct smi_info *smi_info = send_info;
745 atomic_set(&smi_info->req_events, 1);
748 static int initialized = 0;
750 /* Must be called with interrupts off and with the si_lock held. */
751 static void si_restart_short_timer(struct smi_info *smi_info)
753 #if defined(CONFIG_HIGH_RES_TIMERS)
755 unsigned long jiffies_now;
757 if (del_timer(&(smi_info->si_timer))) {
758 /* If we don't delete the timer, then it will go off
759 immediately, anyway. So we only process if we
760 actually delete the timer. */
762 /* We already have irqsave on, so no need for it
764 read_lock(&xtime_lock);
765 jiffies_now = jiffies;
766 smi_info->si_timer.expires = jiffies_now;
767 smi_info->si_timer.sub_expires = get_arch_cycles(jiffies_now);
769 add_usec_to_timer(&smi_info->si_timer, SI_SHORT_TIMEOUT_USEC);
771 add_timer(&(smi_info->si_timer));
772 spin_lock_irqsave(&smi_info->count_lock, flags);
773 smi_info->timeout_restarts++;
774 spin_unlock_irqrestore(&smi_info->count_lock, flags);
779 static void smi_timeout(unsigned long data)
781 struct smi_info *smi_info = (struct smi_info *) data;
782 enum si_sm_result smi_result;
784 unsigned long jiffies_now;
785 unsigned long time_diff;
790 if (smi_info->stop_operation) {
791 smi_info->timer_stopped = 1;
795 spin_lock_irqsave(&(smi_info->si_lock), flags);
798 printk("**Timer: %d.%9.9d\n", t.tv_sec, t.tv_usec);
800 jiffies_now = jiffies;
801 time_diff = ((jiffies_now - smi_info->last_timeout_jiffies)
802 * SI_USEC_PER_JIFFY);
803 smi_result = smi_event_handler(smi_info, time_diff);
805 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
807 smi_info->last_timeout_jiffies = jiffies_now;
809 if ((smi_info->irq) && (! smi_info->interrupt_disabled)) {
810 /* Running with interrupts, only do long timeouts. */
811 smi_info->si_timer.expires = jiffies + SI_TIMEOUT_JIFFIES;
812 spin_lock_irqsave(&smi_info->count_lock, flags);
813 smi_info->long_timeouts++;
814 spin_unlock_irqrestore(&smi_info->count_lock, flags);
818 /* If the state machine asks for a short delay, then shorten
819 the timer timeout. */
820 if (smi_result == SI_SM_CALL_WITH_DELAY) {
821 spin_lock_irqsave(&smi_info->count_lock, flags);
822 smi_info->short_timeouts++;
823 spin_unlock_irqrestore(&smi_info->count_lock, flags);
824 #if defined(CONFIG_HIGH_RES_TIMERS)
825 read_lock(&xtime_lock);
826 smi_info->si_timer.expires = jiffies;
827 smi_info->si_timer.sub_expires
828 = get_arch_cycles(smi_info->si_timer.expires);
829 read_unlock(&xtime_lock);
830 add_usec_to_timer(&smi_info->si_timer, SI_SHORT_TIMEOUT_USEC);
832 smi_info->si_timer.expires = jiffies + 1;
835 spin_lock_irqsave(&smi_info->count_lock, flags);
836 smi_info->long_timeouts++;
837 spin_unlock_irqrestore(&smi_info->count_lock, flags);
838 smi_info->si_timer.expires = jiffies + SI_TIMEOUT_JIFFIES;
839 #if defined(CONFIG_HIGH_RES_TIMERS)
840 smi_info->si_timer.sub_expires = 0;
845 add_timer(&(smi_info->si_timer));
848 static irqreturn_t si_irq_handler(int irq, void *data, struct pt_regs *regs)
850 struct smi_info *smi_info = data;
856 spin_lock_irqsave(&(smi_info->si_lock), flags);
858 spin_lock(&smi_info->count_lock);
859 smi_info->interrupts++;
860 spin_unlock(&smi_info->count_lock);
862 if (smi_info->stop_operation)
867 printk("**Interrupt: %d.%9.9d\n", t.tv_sec, t.tv_usec);
869 smi_event_handler(smi_info, 0);
871 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
875 static struct ipmi_smi_handlers handlers =
877 .owner = THIS_MODULE,
879 .request_events = request_events,
880 .set_run_to_completion = set_run_to_completion,
884 /* There can be 4 IO ports passed in (with or without IRQs), 4 addresses,
885 a default IO port, and 1 ACPI/SPMI address. That sets SI_MAX_DRIVERS */
887 #define SI_MAX_PARMS 4
888 #define SI_MAX_DRIVERS ((SI_MAX_PARMS * 2) + 2)
889 static struct smi_info *smi_infos[SI_MAX_DRIVERS] =
890 { NULL, NULL, NULL, NULL };
892 #define DEVICE_NAME "ipmi_si"
894 #define DEFAULT_KCS_IO_PORT 0xca2
895 #define DEFAULT_SMIC_IO_PORT 0xca9
896 #define DEFAULT_BT_IO_PORT 0xe4
897 #define DEFAULT_REGSPACING 1
899 static int si_trydefaults = 1;
900 static char *si_type[SI_MAX_PARMS] = { NULL, NULL, NULL, NULL };
901 #define MAX_SI_TYPE_STR 30
902 static char si_type_str[MAX_SI_TYPE_STR];
903 static unsigned long addrs[SI_MAX_PARMS] = { 0, 0, 0, 0 };
904 static int num_addrs = 0;
905 static unsigned int ports[SI_MAX_PARMS] = { 0, 0, 0, 0 };
906 static int num_ports = 0;
907 static int irqs[SI_MAX_PARMS] = { 0, 0, 0, 0 };
908 static int num_irqs = 0;
909 static int regspacings[SI_MAX_PARMS] = { 0, 0, 0, 0 };
910 static int num_regspacings = 0;
911 static int regsizes[SI_MAX_PARMS] = { 0, 0, 0, 0 };
912 static int num_regsizes = 0;
913 static int regshifts[SI_MAX_PARMS] = { 0, 0, 0, 0 };
914 static int num_regshifts = 0;
917 module_param_named(trydefaults, si_trydefaults, bool, 0);
918 MODULE_PARM_DESC(trydefaults, "Setting this to 'false' will disable the"
919 " default scan of the KCS and SMIC interface at the standard"
921 module_param_string(type, si_type_str, MAX_SI_TYPE_STR, 0);
922 MODULE_PARM_DESC(type, "Defines the type of each interface, each"
923 " interface separated by commas. The types are 'kcs',"
924 " 'smic', and 'bt'. For example si_type=kcs,bt will set"
925 " the first interface to kcs and the second to bt");
926 module_param_array(addrs, long, &num_addrs, 0);
927 MODULE_PARM_DESC(addrs, "Sets the memory address of each interface, the"
928 " addresses separated by commas. Only use if an interface"
929 " is in memory. Otherwise, set it to zero or leave"
931 module_param_array(ports, int, &num_ports, 0);
932 MODULE_PARM_DESC(ports, "Sets the port address of each interface, the"
933 " addresses separated by commas. Only use if an interface"
934 " is a port. Otherwise, set it to zero or leave"
936 module_param_array(irqs, int, &num_irqs, 0);
937 MODULE_PARM_DESC(irqs, "Sets the interrupt of each interface, the"
938 " addresses separated by commas. Only use if an interface"
939 " has an interrupt. Otherwise, set it to zero or leave"
941 module_param_array(regspacings, int, &num_regspacings, 0);
942 MODULE_PARM_DESC(regspacings, "The number of bytes between the start address"
943 " and each successive register used by the interface. For"
944 " instance, if the start address is 0xca2 and the spacing"
945 " is 2, then the second address is at 0xca4. Defaults"
947 module_param_array(regsizes, int, &num_regsizes, 0);
948 MODULE_PARM_DESC(regsizes, "The size of the specific IPMI register in bytes."
949 " This should generally be 1, 2, 4, or 8 for an 8-bit,"
950 " 16-bit, 32-bit, or 64-bit register. Use this if you"
951 " the 8-bit IPMI register has to be read from a larger"
953 module_param_array(regshifts, int, &num_regshifts, 0);
954 MODULE_PARM_DESC(regshifts, "The amount to shift the data read from the."
955 " IPMI register, in bits. For instance, if the data"
956 " is read from a 32-bit word and the IPMI data is in"
957 " bit 8-15, then the shift would be 8");
959 #define IPMI_MEM_ADDR_SPACE 1
960 #define IPMI_IO_ADDR_SPACE 2
962 #if defined(CONFIG_ACPI_INTERPRETER) || defined(CONFIG_X86) || defined(CONFIG_PCI)
963 static int is_new_interface(int intf, u8 addr_space, unsigned long base_addr)
967 for (i = 0; i < SI_MAX_PARMS; ++i) {
968 /* Don't check our address. */
971 if (si_type[i] != NULL) {
972 if ((addr_space == IPMI_MEM_ADDR_SPACE &&
973 base_addr == addrs[i]) ||
974 (addr_space == IPMI_IO_ADDR_SPACE &&
975 base_addr == ports[i]))
986 static int std_irq_setup(struct smi_info *info)
993 rv = request_irq(info->irq,
1000 "ipmi_si: %s unable to claim interrupt %d,"
1001 " running polled\n",
1002 DEVICE_NAME, info->irq);
1005 printk(" Using irq %d\n", info->irq);
1011 static void std_irq_cleanup(struct smi_info *info)
1016 free_irq(info->irq, info);
1019 static unsigned char port_inb(struct si_sm_io *io, unsigned int offset)
1021 unsigned int *addr = io->info;
1023 return inb((*addr)+(offset*io->regspacing));
1026 static void port_outb(struct si_sm_io *io, unsigned int offset,
1029 unsigned int *addr = io->info;
1031 outb(b, (*addr)+(offset * io->regspacing));
1034 static unsigned char port_inw(struct si_sm_io *io, unsigned int offset)
1036 unsigned int *addr = io->info;
1038 return (inw((*addr)+(offset * io->regspacing)) >> io->regshift) & 0xff;
1041 static void port_outw(struct si_sm_io *io, unsigned int offset,
1044 unsigned int *addr = io->info;
1046 outw(b << io->regshift, (*addr)+(offset * io->regspacing));
1049 static unsigned char port_inl(struct si_sm_io *io, unsigned int offset)
1051 unsigned int *addr = io->info;
1053 return (inl((*addr)+(offset * io->regspacing)) >> io->regshift) & 0xff;
1056 static void port_outl(struct si_sm_io *io, unsigned int offset,
1059 unsigned int *addr = io->info;
1061 outl(b << io->regshift, (*addr)+(offset * io->regspacing));
1064 static void port_cleanup(struct smi_info *info)
1066 unsigned int *addr = info->io.info;
1069 if (addr && (*addr)) {
1070 mapsize = ((info->io_size * info->io.regspacing)
1071 - (info->io.regspacing - info->io.regsize));
1073 release_region (*addr, mapsize);
1078 static int port_setup(struct smi_info *info)
1080 unsigned int *addr = info->io.info;
1083 if (!addr || (!*addr))
1086 info->io_cleanup = port_cleanup;
1088 /* Figure out the actual inb/inw/inl/etc routine to use based
1089 upon the register size. */
1090 switch (info->io.regsize) {
1092 info->io.inputb = port_inb;
1093 info->io.outputb = port_outb;
1096 info->io.inputb = port_inw;
1097 info->io.outputb = port_outw;
1100 info->io.inputb = port_inl;
1101 info->io.outputb = port_outl;
1104 printk("ipmi_si: Invalid register size: %d\n",
1109 /* Calculate the total amount of memory to claim. This is an
1110 * unusual looking calculation, but it avoids claiming any
1111 * more memory than it has to. It will claim everything
1112 * between the first address to the end of the last full
1114 mapsize = ((info->io_size * info->io.regspacing)
1115 - (info->io.regspacing - info->io.regsize));
1117 if (request_region(*addr, mapsize, DEVICE_NAME) == NULL)
1122 static int try_init_port(int intf_num, struct smi_info **new_info)
1124 struct smi_info *info;
1126 if (!ports[intf_num])
1129 if (!is_new_interface(intf_num, IPMI_IO_ADDR_SPACE,
1133 info = kmalloc(sizeof(*info), GFP_KERNEL);
1135 printk(KERN_ERR "ipmi_si: Could not allocate SI data (1)\n");
1138 memset(info, 0, sizeof(*info));
1140 info->io_setup = port_setup;
1141 info->io.info = &(ports[intf_num]);
1142 info->io.addr = NULL;
1143 info->io.regspacing = regspacings[intf_num];
1144 if (!info->io.regspacing)
1145 info->io.regspacing = DEFAULT_REGSPACING;
1146 info->io.regsize = regsizes[intf_num];
1147 if (!info->io.regsize)
1148 info->io.regsize = DEFAULT_REGSPACING;
1149 info->io.regshift = regshifts[intf_num];
1151 info->irq_setup = NULL;
1154 if (si_type[intf_num] == NULL)
1155 si_type[intf_num] = "kcs";
1157 printk("ipmi_si: Trying \"%s\" at I/O port 0x%x\n",
1158 si_type[intf_num], ports[intf_num]);
1162 static unsigned char mem_inb(struct si_sm_io *io, unsigned int offset)
1164 return readb((io->addr)+(offset * io->regspacing));
1167 static void mem_outb(struct si_sm_io *io, unsigned int offset,
1170 writeb(b, (io->addr)+(offset * io->regspacing));
1173 static unsigned char mem_inw(struct si_sm_io *io, unsigned int offset)
1175 return (readw((io->addr)+(offset * io->regspacing)) >> io->regshift)
1179 static void mem_outw(struct si_sm_io *io, unsigned int offset,
1182 writeb(b << io->regshift, (io->addr)+(offset * io->regspacing));
1185 static unsigned char mem_inl(struct si_sm_io *io, unsigned int offset)
1187 return (readl((io->addr)+(offset * io->regspacing)) >> io->regshift)
1191 static void mem_outl(struct si_sm_io *io, unsigned int offset,
1194 writel(b << io->regshift, (io->addr)+(offset * io->regspacing));
1198 static unsigned char mem_inq(struct si_sm_io *io, unsigned int offset)
1200 return (readq((io->addr)+(offset * io->regspacing)) >> io->regshift)
1204 static void mem_outq(struct si_sm_io *io, unsigned int offset,
1207 writeq(b << io->regshift, (io->addr)+(offset * io->regspacing));
1211 static void mem_cleanup(struct smi_info *info)
1213 unsigned long *addr = info->io.info;
1216 if (info->io.addr) {
1217 iounmap(info->io.addr);
1219 mapsize = ((info->io_size * info->io.regspacing)
1220 - (info->io.regspacing - info->io.regsize));
1222 release_mem_region(*addr, mapsize);
1227 static int mem_setup(struct smi_info *info)
1229 unsigned long *addr = info->io.info;
1232 if (!addr || (!*addr))
1235 info->io_cleanup = mem_cleanup;
1237 /* Figure out the actual readb/readw/readl/etc routine to use based
1238 upon the register size. */
1239 switch (info->io.regsize) {
1241 info->io.inputb = mem_inb;
1242 info->io.outputb = mem_outb;
1245 info->io.inputb = mem_inw;
1246 info->io.outputb = mem_outw;
1249 info->io.inputb = mem_inl;
1250 info->io.outputb = mem_outl;
1254 info->io.inputb = mem_inq;
1255 info->io.outputb = mem_outq;
1259 printk("ipmi_si: Invalid register size: %d\n",
1264 /* Calculate the total amount of memory to claim. This is an
1265 * unusual looking calculation, but it avoids claiming any
1266 * more memory than it has to. It will claim everything
1267 * between the first address to the end of the last full
1269 mapsize = ((info->io_size * info->io.regspacing)
1270 - (info->io.regspacing - info->io.regsize));
1272 if (request_mem_region(*addr, mapsize, DEVICE_NAME) == NULL)
1275 info->io.addr = ioremap(*addr, mapsize);
1276 if (info->io.addr == NULL) {
1277 release_mem_region(*addr, mapsize);
1283 static int try_init_mem(int intf_num, struct smi_info **new_info)
1285 struct smi_info *info;
1287 if (!addrs[intf_num])
1290 if (!is_new_interface(intf_num, IPMI_MEM_ADDR_SPACE,
1294 info = kmalloc(sizeof(*info), GFP_KERNEL);
1296 printk(KERN_ERR "ipmi_si: Could not allocate SI data (2)\n");
1299 memset(info, 0, sizeof(*info));
1301 info->io_setup = mem_setup;
1302 info->io.info = &addrs[intf_num];
1303 info->io.addr = NULL;
1304 info->io.regspacing = regspacings[intf_num];
1305 if (!info->io.regspacing)
1306 info->io.regspacing = DEFAULT_REGSPACING;
1307 info->io.regsize = regsizes[intf_num];
1308 if (!info->io.regsize)
1309 info->io.regsize = DEFAULT_REGSPACING;
1310 info->io.regshift = regshifts[intf_num];
1312 info->irq_setup = NULL;
1315 if (si_type[intf_num] == NULL)
1316 si_type[intf_num] = "kcs";
1318 printk("ipmi_si: Trying \"%s\" at memory address 0x%lx\n",
1319 si_type[intf_num], addrs[intf_num]);
1324 #ifdef CONFIG_ACPI_INTERPRETER
1326 #include <linux/acpi.h>
1328 /* Once we get an ACPI failure, we don't try any more, because we go
1329 through the tables sequentially. Once we don't find a table, there
1331 static int acpi_failure = 0;
1333 /* For GPE-type interrupts. */
1334 static u32 ipmi_acpi_gpe(void *context)
1336 struct smi_info *smi_info = context;
1337 unsigned long flags;
1342 spin_lock_irqsave(&(smi_info->si_lock), flags);
1344 spin_lock(&smi_info->count_lock);
1345 smi_info->interrupts++;
1346 spin_unlock(&smi_info->count_lock);
1348 if (smi_info->stop_operation)
1352 do_gettimeofday(&t);
1353 printk("**ACPI_GPE: %d.%9.9d\n", t.tv_sec, t.tv_usec);
1355 smi_event_handler(smi_info, 0);
1357 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1359 return ACPI_INTERRUPT_HANDLED;
1362 static int acpi_gpe_irq_setup(struct smi_info *info)
1369 /* FIXME - is level triggered right? */
1370 status = acpi_install_gpe_handler(NULL,
1372 ACPI_GPE_LEVEL_TRIGGERED,
1375 if (status != AE_OK) {
1377 "ipmi_si: %s unable to claim ACPI GPE %d,"
1378 " running polled\n",
1379 DEVICE_NAME, info->irq);
1383 printk(" Using ACPI GPE %d\n", info->irq);
1388 static void acpi_gpe_irq_cleanup(struct smi_info *info)
1393 acpi_remove_gpe_handler(NULL, info->irq, &ipmi_acpi_gpe);
1398 * http://h21007.www2.hp.com/dspp/files/unprotected/devresource/Docs/TechPapers/IA64/hpspmi.pdf
1409 s8 CreatorRevision[4];
1412 s16 SpecificationRevision;
1415 * Bit 0 - SCI interrupt supported
1416 * Bit 1 - I/O APIC/SAPIC
1420 /* If bit 0 of InterruptType is set, then this is the SCI
1421 interrupt in the GPEx_STS register. */
1426 /* If bit 1 of InterruptType is set, then this is the I/O
1427 APIC/SAPIC interrupt. */
1428 u32 GlobalSystemInterrupt;
1430 /* The actual register address. */
1431 struct acpi_generic_address addr;
1435 s8 spmi_id[1]; /* A '\0' terminated array starts here. */
1438 static int try_init_acpi(int intf_num, struct smi_info **new_info)
1440 struct smi_info *info;
1442 struct SPMITable *spmi;
1449 status = acpi_get_firmware_table("SPMI", intf_num+1,
1450 ACPI_LOGICAL_ADDRESSING,
1451 (struct acpi_table_header **) &spmi);
1452 if (status != AE_OK) {
1457 if (spmi->IPMIlegacy != 1) {
1458 printk(KERN_INFO "IPMI: Bad SPMI legacy %d\n", spmi->IPMIlegacy);
1462 if (spmi->addr.address_space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY)
1463 addr_space = IPMI_MEM_ADDR_SPACE;
1465 addr_space = IPMI_IO_ADDR_SPACE;
1466 if (!is_new_interface(-1, addr_space, spmi->addr.address))
1469 /* Figure out the interface type. */
1470 switch (spmi->InterfaceType)
1473 si_type[intf_num] = "kcs";
1477 si_type[intf_num] = "smic";
1481 si_type[intf_num] = "bt";
1485 printk(KERN_INFO "ipmi_si: Unknown ACPI/SPMI SI type %d\n",
1486 spmi->InterfaceType);
1490 info = kmalloc(sizeof(*info), GFP_KERNEL);
1492 printk(KERN_ERR "ipmi_si: Could not allocate SI data (3)\n");
1495 memset(info, 0, sizeof(*info));
1497 if (spmi->InterruptType & 1) {
1498 /* We've got a GPE interrupt. */
1499 info->irq = spmi->GPE;
1500 info->irq_setup = acpi_gpe_irq_setup;
1501 info->irq_cleanup = acpi_gpe_irq_cleanup;
1502 } else if (spmi->InterruptType & 2) {
1503 /* We've got an APIC/SAPIC interrupt. */
1504 info->irq = spmi->GlobalSystemInterrupt;
1505 info->irq_setup = std_irq_setup;
1506 info->irq_cleanup = std_irq_cleanup;
1508 /* Use the default interrupt setting. */
1510 info->irq_setup = NULL;
1513 regspacings[intf_num] = spmi->addr.register_bit_width / 8;
1514 info->io.regspacing = spmi->addr.register_bit_width / 8;
1515 regsizes[intf_num] = regspacings[intf_num];
1516 info->io.regsize = regsizes[intf_num];
1517 regshifts[intf_num] = spmi->addr.register_bit_offset;
1518 info->io.regshift = regshifts[intf_num];
1520 if (spmi->addr.address_space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
1522 info->io_setup = mem_setup;
1523 addrs[intf_num] = spmi->addr.address;
1524 info->io.info = &(addrs[intf_num]);
1525 } else if (spmi->addr.address_space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
1527 info->io_setup = port_setup;
1528 ports[intf_num] = spmi->addr.address;
1529 info->io.info = &(ports[intf_num]);
1532 printk("ipmi_si: Unknown ACPI I/O Address type\n");
1538 printk("ipmi_si: ACPI/SPMI specifies \"%s\" %s SI @ 0x%lx\n",
1539 si_type[intf_num], io_type, (unsigned long) spmi->addr.address);
1546 typedef struct dmi_ipmi_data
1550 unsigned long base_addr;
1555 typedef struct dmi_header
1562 static int decode_dmi(dmi_header_t *dm, dmi_ipmi_data_t *ipmi_data)
1564 u8 *data = (u8 *)dm;
1565 unsigned long base_addr;
1567 u8 len = dm->length;
1569 ipmi_data->type = data[4];
1571 memcpy(&base_addr, data+8, sizeof(unsigned long));
1573 if (base_addr & 1) {
1575 base_addr &= 0xFFFE;
1576 ipmi_data->addr_space = IPMI_IO_ADDR_SPACE;
1580 ipmi_data->addr_space = IPMI_MEM_ADDR_SPACE;
1582 /* If bit 4 of byte 0x10 is set, then the lsb for the address
1584 ipmi_data->base_addr = base_addr | ((data[0x10] & 0x10) >> 4);
1586 ipmi_data->irq = data[0x11];
1588 /* The top two bits of byte 0x10 hold the register spacing. */
1589 reg_spacing = (data[0x10] & 0xC0) >> 6;
1590 switch(reg_spacing){
1591 case 0x00: /* Byte boundaries */
1592 ipmi_data->offset = 1;
1594 case 0x01: /* 32-bit boundaries */
1595 ipmi_data->offset = 4;
1597 case 0x02: /* 16-byte boundaries */
1598 ipmi_data->offset = 16;
1601 /* Some other interface, just ignore it. */
1606 ipmi_data->base_addr = base_addr;
1607 ipmi_data->addr_space = IPMI_IO_ADDR_SPACE;
1608 ipmi_data->offset = 1;
1611 if (is_new_interface(-1, ipmi_data->addr_space,ipmi_data->base_addr))
1614 memset(ipmi_data, 0, sizeof(dmi_ipmi_data_t));
1619 static int dmi_table(u32 base, int len, int num,
1620 dmi_ipmi_data_t *ipmi_data)
1623 struct dmi_header *dm;
1628 buf = ioremap(base, len);
1634 while(i<num && (data - buf) < len)
1636 dm=(dmi_header_t *)data;
1638 if((data-buf+dm->length) >= len)
1641 if (dm->type == 38) {
1642 if (decode_dmi(dm, ipmi_data) == 0) {
1649 while((data-buf) < len && (*data || data[1]))
1659 inline static int dmi_checksum(u8 *buf)
1669 static int dmi_iterator(dmi_ipmi_data_t *ipmi_data)
1674 #ifdef CONFIG_SIMNOW
1680 isa_memcpy_fromio(buf, fp, 15);
1681 if(memcmp(buf, "_DMI_", 5)==0 && dmi_checksum(buf))
1683 u16 num=buf[13]<<8|buf[12];
1684 u16 len=buf[7]<<8|buf[6];
1685 u32 base=buf[11]<<24|buf[10]<<16|buf[9]<<8|buf[8];
1687 if(dmi_table(base, len, num, ipmi_data) == 0)
1696 static int try_init_smbios(int intf_num, struct smi_info **new_info)
1698 struct smi_info *info;
1699 dmi_ipmi_data_t ipmi_data;
1703 status = dmi_iterator(&ipmi_data);
1708 switch(ipmi_data.type) {
1709 case 0x01: /* KCS */
1710 si_type[intf_num] = "kcs";
1712 case 0x02: /* SMIC */
1713 si_type[intf_num] = "smic";
1716 si_type[intf_num] = "bt";
1719 printk("ipmi_si: Unknown SMBIOS SI type.\n");
1723 info = kmalloc(sizeof(*info), GFP_KERNEL);
1725 printk(KERN_ERR "ipmi_si: Could not allocate SI data (4)\n");
1728 memset(info, 0, sizeof(*info));
1730 if (ipmi_data.addr_space == 1) {
1732 info->io_setup = mem_setup;
1733 addrs[intf_num] = ipmi_data.base_addr;
1734 info->io.info = &(addrs[intf_num]);
1735 } else if (ipmi_data.addr_space == 2) {
1737 info->io_setup = port_setup;
1738 ports[intf_num] = ipmi_data.base_addr;
1739 info->io.info = &(ports[intf_num]);
1742 printk("ipmi_si: Unknown SMBIOS I/O Address type.\n");
1746 regspacings[intf_num] = ipmi_data.offset;
1747 info->io.regspacing = regspacings[intf_num];
1748 if (!info->io.regspacing)
1749 info->io.regspacing = DEFAULT_REGSPACING;
1750 info->io.regsize = DEFAULT_REGSPACING;
1751 info->io.regshift = regshifts[intf_num];
1753 irqs[intf_num] = ipmi_data.irq;
1757 printk("ipmi_si: Found SMBIOS-specified state machine at %s"
1759 io_type, (unsigned long)ipmi_data.base_addr);
1762 #endif /* CONFIG_X86 */
1766 #define PCI_ERMC_CLASSCODE 0x0C0700
1767 #define PCI_HP_VENDOR_ID 0x103C
1768 #define PCI_MMC_DEVICE_ID 0x121A
1769 #define PCI_MMC_ADDR_CW 0x10
1771 /* Avoid more than one attempt to probe pci smic. */
1772 static int pci_smic_checked = 0;
1774 static int find_pci_smic(int intf_num, struct smi_info **new_info)
1776 struct smi_info *info;
1778 struct pci_dev *pci_dev = NULL;
1782 if (pci_smic_checked)
1785 pci_smic_checked = 1;
1787 if ((pci_dev = pci_get_device(PCI_HP_VENDOR_ID, PCI_MMC_DEVICE_ID,
1790 else if ((pci_dev = pci_get_class(PCI_ERMC_CLASSCODE, NULL)) &&
1791 pci_dev->subsystem_vendor == PCI_HP_VENDOR_ID)
1796 error = pci_read_config_word(pci_dev, PCI_MMC_ADDR_CW, &base_addr);
1799 pci_dev_put(pci_dev);
1801 "ipmi_si: pci_read_config_word() failed (%d).\n",
1806 /* Bit 0: 1 specifies programmed I/O, 0 specifies memory mapped I/O */
1807 if (!(base_addr & 0x0001))
1809 pci_dev_put(pci_dev);
1811 "ipmi_si: memory mapped I/O not supported for PCI"
1816 base_addr &= 0xFFFE;
1818 /* Data register starts at base address + 1 in eRMC */
1821 if (!is_new_interface(-1, IPMI_IO_ADDR_SPACE, base_addr)) {
1822 pci_dev_put(pci_dev);
1826 info = kmalloc(sizeof(*info), GFP_KERNEL);
1828 pci_dev_put(pci_dev);
1829 printk(KERN_ERR "ipmi_si: Could not allocate SI data (5)\n");
1832 memset(info, 0, sizeof(*info));
1834 info->io_setup = port_setup;
1835 ports[intf_num] = base_addr;
1836 info->io.info = &(ports[intf_num]);
1837 info->io.regspacing = regspacings[intf_num];
1838 if (!info->io.regspacing)
1839 info->io.regspacing = DEFAULT_REGSPACING;
1840 info->io.regsize = DEFAULT_REGSPACING;
1841 info->io.regshift = regshifts[intf_num];
1845 irqs[intf_num] = pci_dev->irq;
1846 si_type[intf_num] = "smic";
1848 printk("ipmi_si: Found PCI SMIC at I/O address 0x%lx\n",
1849 (long unsigned int) base_addr);
1851 pci_dev_put(pci_dev);
1854 #endif /* CONFIG_PCI */
1856 static int try_init_plug_and_play(int intf_num, struct smi_info **new_info)
1859 if (find_pci_smic(intf_num, new_info)==0)
1862 /* Include other methods here. */
1868 static int try_get_dev_id(struct smi_info *smi_info)
1870 unsigned char msg[2];
1871 unsigned char *resp;
1872 unsigned long resp_len;
1873 enum si_sm_result smi_result;
1876 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
1880 /* Do a Get Device ID command, since it comes back with some
1882 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1883 msg[1] = IPMI_GET_DEVICE_ID_CMD;
1884 smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
1886 smi_result = smi_info->handlers->event(smi_info->si_sm, 0);
1889 if (smi_result == SI_SM_CALL_WITH_DELAY) {
1890 set_current_state(TASK_UNINTERRUPTIBLE);
1891 schedule_timeout(1);
1892 smi_result = smi_info->handlers->event(
1893 smi_info->si_sm, 100);
1895 else if (smi_result == SI_SM_CALL_WITHOUT_DELAY)
1897 smi_result = smi_info->handlers->event(
1898 smi_info->si_sm, 0);
1903 if (smi_result == SI_SM_HOSED) {
1904 /* We couldn't get the state machine to run, so whatever's at
1905 the port is probably not an IPMI SMI interface. */
1910 /* Otherwise, we got some data. */
1911 resp_len = smi_info->handlers->get_result(smi_info->si_sm,
1912 resp, IPMI_MAX_MSG_LENGTH);
1914 /* That's odd, it should be longer. */
1919 if ((resp[1] != IPMI_GET_DEVICE_ID_CMD) || (resp[2] != 0)) {
1920 /* That's odd, it shouldn't be able to fail. */
1925 /* Record info from the get device id, in case we need it. */
1926 smi_info->ipmi_si_dev_rev = resp[4] & 0xf;
1927 smi_info->ipmi_si_fw_rev_major = resp[5] & 0x7f;
1928 smi_info->ipmi_si_fw_rev_minor = resp[6];
1929 smi_info->ipmi_version_major = resp[7] & 0xf;
1930 smi_info->ipmi_version_minor = resp[7] >> 4;
1937 static int type_file_read_proc(char *page, char **start, off_t off,
1938 int count, int *eof, void *data)
1940 char *out = (char *) page;
1941 struct smi_info *smi = data;
1943 switch (smi->si_type) {
1945 return sprintf(out, "kcs\n");
1947 return sprintf(out, "smic\n");
1949 return sprintf(out, "bt\n");
1955 static int stat_file_read_proc(char *page, char **start, off_t off,
1956 int count, int *eof, void *data)
1958 char *out = (char *) page;
1959 struct smi_info *smi = data;
1961 out += sprintf(out, "interrupts_enabled: %d\n",
1962 smi->irq && !smi->interrupt_disabled);
1963 out += sprintf(out, "short_timeouts: %ld\n",
1964 smi->short_timeouts);
1965 out += sprintf(out, "long_timeouts: %ld\n",
1966 smi->long_timeouts);
1967 out += sprintf(out, "timeout_restarts: %ld\n",
1968 smi->timeout_restarts);
1969 out += sprintf(out, "idles: %ld\n",
1971 out += sprintf(out, "interrupts: %ld\n",
1973 out += sprintf(out, "attentions: %ld\n",
1975 out += sprintf(out, "flag_fetches: %ld\n",
1977 out += sprintf(out, "hosed_count: %ld\n",
1979 out += sprintf(out, "complete_transactions: %ld\n",
1980 smi->complete_transactions);
1981 out += sprintf(out, "events: %ld\n",
1983 out += sprintf(out, "watchdog_pretimeouts: %ld\n",
1984 smi->watchdog_pretimeouts);
1985 out += sprintf(out, "incoming_messages: %ld\n",
1986 smi->incoming_messages);
1988 return (out - ((char *) page));
1991 /* Returns 0 if initialized, or negative on an error. */
1992 static int init_one_smi(int intf_num, struct smi_info **smi)
1995 struct smi_info *new_smi;
1998 rv = try_init_mem(intf_num, &new_smi);
2000 rv = try_init_port(intf_num, &new_smi);
2001 #ifdef CONFIG_ACPI_INTERPRETER
2002 if ((rv) && (si_trydefaults)) {
2003 rv = try_init_acpi(intf_num, &new_smi);
2007 if ((rv) && (si_trydefaults)) {
2008 rv = try_init_smbios(intf_num, &new_smi);
2011 if ((rv) && (si_trydefaults)) {
2012 rv = try_init_plug_and_play(intf_num, &new_smi);
2019 /* So we know not to free it unless we have allocated one. */
2020 new_smi->intf = NULL;
2021 new_smi->si_sm = NULL;
2022 new_smi->handlers = NULL;
2024 if (!new_smi->irq_setup) {
2025 new_smi->irq = irqs[intf_num];
2026 new_smi->irq_setup = std_irq_setup;
2027 new_smi->irq_cleanup = std_irq_cleanup;
2030 /* Default to KCS if no type is specified. */
2031 if (si_type[intf_num] == NULL) {
2033 si_type[intf_num] = "kcs";
2040 /* Set up the state machine to use. */
2041 if (strcmp(si_type[intf_num], "kcs") == 0) {
2042 new_smi->handlers = &kcs_smi_handlers;
2043 new_smi->si_type = SI_KCS;
2044 } else if (strcmp(si_type[intf_num], "smic") == 0) {
2045 new_smi->handlers = &smic_smi_handlers;
2046 new_smi->si_type = SI_SMIC;
2047 } else if (strcmp(si_type[intf_num], "bt") == 0) {
2048 new_smi->handlers = &bt_smi_handlers;
2049 new_smi->si_type = SI_BT;
2051 /* No support for anything else yet. */
2056 /* Allocate the state machine's data and initialize it. */
2057 new_smi->si_sm = kmalloc(new_smi->handlers->size(), GFP_KERNEL);
2058 if (!new_smi->si_sm) {
2059 printk(" Could not allocate state machine memory\n");
2063 new_smi->io_size = new_smi->handlers->init_data(new_smi->si_sm,
2066 /* Now that we know the I/O size, we can set up the I/O. */
2067 rv = new_smi->io_setup(new_smi);
2069 printk(" Could not set up I/O space\n");
2073 spin_lock_init(&(new_smi->si_lock));
2074 spin_lock_init(&(new_smi->msg_lock));
2075 spin_lock_init(&(new_smi->count_lock));
2077 /* Do low-level detection first. */
2078 if (new_smi->handlers->detect(new_smi->si_sm)) {
2083 /* Attempt a get device id command. If it fails, we probably
2084 don't have a SMI here. */
2085 rv = try_get_dev_id(new_smi);
2089 /* Try to claim any interrupts. */
2090 new_smi->irq_setup(new_smi);
2092 INIT_LIST_HEAD(&(new_smi->xmit_msgs));
2093 INIT_LIST_HEAD(&(new_smi->hp_xmit_msgs));
2094 new_smi->curr_msg = NULL;
2095 atomic_set(&new_smi->req_events, 0);
2096 new_smi->run_to_completion = 0;
2098 new_smi->interrupt_disabled = 0;
2099 new_smi->timer_stopped = 0;
2100 new_smi->stop_operation = 0;
2102 /* Start clearing the flags before we enable interrupts or the
2103 timer to avoid racing with the timer. */
2104 start_clear_flags(new_smi);
2105 /* IRQ is defined to be set when non-zero. */
2107 new_smi->si_state = SI_CLEARING_FLAGS_THEN_SET_IRQ;
2109 /* The ipmi_register_smi() code does some operations to
2110 determine the channel information, so we must be ready to
2111 handle operations before it is called. This means we have
2112 to stop the timer if we get an error after this point. */
2113 init_timer(&(new_smi->si_timer));
2114 new_smi->si_timer.data = (long) new_smi;
2115 new_smi->si_timer.function = smi_timeout;
2116 new_smi->last_timeout_jiffies = jiffies;
2117 new_smi->si_timer.expires = jiffies + SI_TIMEOUT_JIFFIES;
2118 add_timer(&(new_smi->si_timer));
2120 rv = ipmi_register_smi(&handlers,
2122 new_smi->ipmi_version_major,
2123 new_smi->ipmi_version_minor,
2127 "ipmi_si: Unable to register device: error %d\n",
2129 goto out_err_stop_timer;
2132 rv = ipmi_smi_add_proc_entry(new_smi->intf, "type",
2133 type_file_read_proc, NULL,
2134 new_smi, THIS_MODULE);
2137 "ipmi_si: Unable to create proc entry: %d\n",
2139 goto out_err_stop_timer;
2142 rv = ipmi_smi_add_proc_entry(new_smi->intf, "si_stats",
2143 stat_file_read_proc, NULL,
2144 new_smi, THIS_MODULE);
2147 "ipmi_si: Unable to create proc entry: %d\n",
2149 goto out_err_stop_timer;
2154 printk(" IPMI %s interface initialized\n", si_type[intf_num]);
2159 new_smi->stop_operation = 1;
2161 /* Wait for the timer to stop. This avoids problems with race
2162 conditions removing the timer here. */
2163 while (!new_smi->timer_stopped) {
2164 set_current_state(TASK_UNINTERRUPTIBLE);
2165 schedule_timeout(1);
2170 ipmi_unregister_smi(new_smi->intf);
2172 new_smi->irq_cleanup(new_smi);
2174 /* Wait until we know that we are out of any interrupt
2175 handlers might have been running before we freed the
2177 synchronize_kernel();
2179 if (new_smi->si_sm) {
2180 if (new_smi->handlers)
2181 new_smi->handlers->cleanup(new_smi->si_sm);
2182 kfree(new_smi->si_sm);
2184 new_smi->io_cleanup(new_smi);
2189 static __init int init_ipmi_si(void)
2200 /* Parse out the si_type string into its components. */
2203 for (i=0; (i<SI_MAX_PARMS) && (*str != '\0'); i++) {
2205 str = strchr(str, ',');
2215 printk(KERN_INFO "IPMI System Interface driver version "
2217 if (kcs_smi_handlers.version)
2218 printk(", KCS version %s", kcs_smi_handlers.version);
2219 if (smic_smi_handlers.version)
2220 printk(", SMIC version %s", smic_smi_handlers.version);
2221 if (bt_smi_handlers.version)
2222 printk(", BT version %s", bt_smi_handlers.version);
2225 rv = init_one_smi(0, &(smi_infos[pos]));
2226 if (rv && !ports[0] && si_trydefaults) {
2227 /* If we are trying defaults and the initial port is
2228 not set, then set it. */
2230 ports[0] = DEFAULT_KCS_IO_PORT;
2231 rv = init_one_smi(0, &(smi_infos[pos]));
2233 /* No KCS - try SMIC */
2234 si_type[0] = "smic";
2235 ports[0] = DEFAULT_SMIC_IO_PORT;
2236 rv = init_one_smi(0, &(smi_infos[pos]));
2239 /* No SMIC - try BT */
2241 ports[0] = DEFAULT_BT_IO_PORT;
2242 rv = init_one_smi(0, &(smi_infos[pos]));
2248 for (i=1; i < SI_MAX_PARMS; i++) {
2249 rv = init_one_smi(i, &(smi_infos[pos]));
2254 if (smi_infos[0] == NULL) {
2255 printk("ipmi_si: Unable to find any System Interface(s)\n");
2261 module_init(init_ipmi_si);
2263 static void __exit cleanup_one_si(struct smi_info *to_clean)
2266 unsigned long flags;
2271 /* Tell the timer and interrupt handlers that we are shutting
2273 spin_lock_irqsave(&(to_clean->si_lock), flags);
2274 spin_lock(&(to_clean->msg_lock));
2276 to_clean->stop_operation = 1;
2278 to_clean->irq_cleanup(to_clean);
2280 spin_unlock(&(to_clean->msg_lock));
2281 spin_unlock_irqrestore(&(to_clean->si_lock), flags);
2283 /* Wait until we know that we are out of any interrupt
2284 handlers might have been running before we freed the
2286 synchronize_kernel();
2288 /* Wait for the timer to stop. This avoids problems with race
2289 conditions removing the timer here. */
2290 while (!to_clean->timer_stopped) {
2291 set_current_state(TASK_UNINTERRUPTIBLE);
2292 schedule_timeout(1);
2295 /* Interrupts and timeouts are stopped, now make sure the
2296 interface is in a clean state. */
2297 while ((to_clean->curr_msg) || (to_clean->si_state != SI_NORMAL)) {
2299 set_current_state(TASK_UNINTERRUPTIBLE);
2300 schedule_timeout(1);
2303 rv = ipmi_unregister_smi(to_clean->intf);
2306 "ipmi_si: Unable to unregister device: errno=%d\n",
2310 to_clean->handlers->cleanup(to_clean->si_sm);
2312 kfree(to_clean->si_sm);
2314 to_clean->io_cleanup(to_clean);
2317 static __exit void cleanup_ipmi_si(void)
2324 for (i=0; i<SI_MAX_DRIVERS; i++) {
2325 cleanup_one_si(smi_infos[i]);
2328 module_exit(cleanup_ipmi_si);
2330 MODULE_LICENSE("GPL");