ipmi: make sure drivers were registered before unregistering them
[sfrench/cifs-2.6.git] / drivers / char / ipmi / ipmi_si_intf.c
1 /*
2  * ipmi_si.c
3  *
4  * The interface to the IPMI driver for the system interfaces (KCS, SMIC,
5  * BT).
6  *
7  * Author: MontaVista Software, Inc.
8  *         Corey Minyard <minyard@mvista.com>
9  *         source@mvista.com
10  *
11  * Copyright 2002 MontaVista Software Inc.
12  * Copyright 2006 IBM Corp., Christian Krafft <krafft@de.ibm.com>
13  *
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.
18  *
19  *
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.
30  *
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.
34  */
35
36 /*
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.
40  */
41
42 #include <linux/module.h>
43 #include <linux/moduleparam.h>
44 #include <asm/system.h>
45 #include <linux/sched.h>
46 #include <linux/timer.h>
47 #include <linux/errno.h>
48 #include <linux/spinlock.h>
49 #include <linux/slab.h>
50 #include <linux/delay.h>
51 #include <linux/list.h>
52 #include <linux/pci.h>
53 #include <linux/ioport.h>
54 #include <linux/notifier.h>
55 #include <linux/mutex.h>
56 #include <linux/kthread.h>
57 #include <asm/irq.h>
58 #include <linux/interrupt.h>
59 #include <linux/rcupdate.h>
60 #include <linux/ipmi_smi.h>
61 #include <asm/io.h>
62 #include "ipmi_si_sm.h"
63 #include <linux/init.h>
64 #include <linux/dmi.h>
65 #include <linux/string.h>
66 #include <linux/ctype.h>
67 #include <linux/pnp.h>
68
69 #ifdef CONFIG_PPC_OF
70 #include <linux/of_device.h>
71 #include <linux/of_platform.h>
72 #endif
73
74 #define PFX "ipmi_si: "
75
76 /* Measure times between events in the driver. */
77 #undef DEBUG_TIMING
78
79 /* Call every 10 ms. */
80 #define SI_TIMEOUT_TIME_USEC    10000
81 #define SI_USEC_PER_JIFFY       (1000000/HZ)
82 #define SI_TIMEOUT_JIFFIES      (SI_TIMEOUT_TIME_USEC/SI_USEC_PER_JIFFY)
83 #define SI_SHORT_TIMEOUT_USEC  250 /* .25ms when the SM request a
84                                       short timeout */
85
86 enum si_intf_state {
87         SI_NORMAL,
88         SI_GETTING_FLAGS,
89         SI_GETTING_EVENTS,
90         SI_CLEARING_FLAGS,
91         SI_CLEARING_FLAGS_THEN_SET_IRQ,
92         SI_GETTING_MESSAGES,
93         SI_ENABLE_INTERRUPTS1,
94         SI_ENABLE_INTERRUPTS2,
95         SI_DISABLE_INTERRUPTS1,
96         SI_DISABLE_INTERRUPTS2
97         /* FIXME - add watchdog stuff. */
98 };
99
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
104
105 enum si_type {
106     SI_KCS, SI_SMIC, SI_BT
107 };
108 static char *si_to_str[] = { "kcs", "smic", "bt" };
109
110 enum ipmi_addr_src {
111         SI_INVALID = 0, SI_HOTMOD, SI_HARDCODED, SI_SPMI, SI_ACPI, SI_SMBIOS,
112         SI_PCI, SI_DEVICETREE, SI_DEFAULT
113 };
114 static char *ipmi_addr_src_to_str[] = { NULL, "hotmod", "hardcoded", "SPMI",
115                                         "ACPI", "SMBIOS", "PCI",
116                                         "device-tree", "default" };
117
118 #define DEVICE_NAME "ipmi_si"
119
120 static struct platform_driver ipmi_driver = {
121         .driver = {
122                 .name = DEVICE_NAME,
123                 .bus = &platform_bus_type
124         }
125 };
126
127
128 /*
129  * Indexes into stats[] in smi_info below.
130  */
131 enum si_stat_indexes {
132         /*
133          * Number of times the driver requested a timer while an operation
134          * was in progress.
135          */
136         SI_STAT_short_timeouts = 0,
137
138         /*
139          * Number of times the driver requested a timer while nothing was in
140          * progress.
141          */
142         SI_STAT_long_timeouts,
143
144         /* Number of times the interface was idle while being polled. */
145         SI_STAT_idles,
146
147         /* Number of interrupts the driver handled. */
148         SI_STAT_interrupts,
149
150         /* Number of time the driver got an ATTN from the hardware. */
151         SI_STAT_attentions,
152
153         /* Number of times the driver requested flags from the hardware. */
154         SI_STAT_flag_fetches,
155
156         /* Number of times the hardware didn't follow the state machine. */
157         SI_STAT_hosed_count,
158
159         /* Number of completed messages. */
160         SI_STAT_complete_transactions,
161
162         /* Number of IPMI events received from the hardware. */
163         SI_STAT_events,
164
165         /* Number of watchdog pretimeouts. */
166         SI_STAT_watchdog_pretimeouts,
167
168         /* Number of asyncronous messages received. */
169         SI_STAT_incoming_messages,
170
171
172         /* This *must* remain last, add new values above this. */
173         SI_NUM_STATS
174 };
175
176 struct smi_info {
177         int                    intf_num;
178         ipmi_smi_t             intf;
179         struct si_sm_data      *si_sm;
180         struct si_sm_handlers  *handlers;
181         enum si_type           si_type;
182         spinlock_t             si_lock;
183         spinlock_t             msg_lock;
184         struct list_head       xmit_msgs;
185         struct list_head       hp_xmit_msgs;
186         struct ipmi_smi_msg    *curr_msg;
187         enum si_intf_state     si_state;
188
189         /*
190          * Used to handle the various types of I/O that can occur with
191          * IPMI
192          */
193         struct si_sm_io io;
194         int (*io_setup)(struct smi_info *info);
195         void (*io_cleanup)(struct smi_info *info);
196         int (*irq_setup)(struct smi_info *info);
197         void (*irq_cleanup)(struct smi_info *info);
198         unsigned int io_size;
199         enum ipmi_addr_src addr_source; /* ACPI, PCI, SMBIOS, hardcode, etc. */
200         void (*addr_source_cleanup)(struct smi_info *info);
201         void *addr_source_data;
202
203         /*
204          * Per-OEM handler, called from handle_flags().  Returns 1
205          * when handle_flags() needs to be re-run or 0 indicating it
206          * set si_state itself.
207          */
208         int (*oem_data_avail_handler)(struct smi_info *smi_info);
209
210         /*
211          * Flags from the last GET_MSG_FLAGS command, used when an ATTN
212          * is set to hold the flags until we are done handling everything
213          * from the flags.
214          */
215 #define RECEIVE_MSG_AVAIL       0x01
216 #define EVENT_MSG_BUFFER_FULL   0x02
217 #define WDT_PRE_TIMEOUT_INT     0x08
218 #define OEM0_DATA_AVAIL     0x20
219 #define OEM1_DATA_AVAIL     0x40
220 #define OEM2_DATA_AVAIL     0x80
221 #define OEM_DATA_AVAIL      (OEM0_DATA_AVAIL | \
222                              OEM1_DATA_AVAIL | \
223                              OEM2_DATA_AVAIL)
224         unsigned char       msg_flags;
225
226         /* Does the BMC have an event buffer? */
227         char                has_event_buffer;
228
229         /*
230          * If set to true, this will request events the next time the
231          * state machine is idle.
232          */
233         atomic_t            req_events;
234
235         /*
236          * If true, run the state machine to completion on every send
237          * call.  Generally used after a panic to make sure stuff goes
238          * out.
239          */
240         int                 run_to_completion;
241
242         /* The I/O port of an SI interface. */
243         int                 port;
244
245         /*
246          * The space between start addresses of the two ports.  For
247          * instance, if the first port is 0xca2 and the spacing is 4, then
248          * the second port is 0xca6.
249          */
250         unsigned int        spacing;
251
252         /* zero if no irq; */
253         int                 irq;
254
255         /* The timer for this si. */
256         struct timer_list   si_timer;
257
258         /* The time (in jiffies) the last timeout occurred at. */
259         unsigned long       last_timeout_jiffies;
260
261         /* Used to gracefully stop the timer without race conditions. */
262         atomic_t            stop_operation;
263
264         /*
265          * The driver will disable interrupts when it gets into a
266          * situation where it cannot handle messages due to lack of
267          * memory.  Once that situation clears up, it will re-enable
268          * interrupts.
269          */
270         int interrupt_disabled;
271
272         /* From the get device id response... */
273         struct ipmi_device_id device_id;
274
275         /* Driver model stuff. */
276         struct device *dev;
277         struct platform_device *pdev;
278
279         /*
280          * True if we allocated the device, false if it came from
281          * someplace else (like PCI).
282          */
283         int dev_registered;
284
285         /* Slave address, could be reported from DMI. */
286         unsigned char slave_addr;
287
288         /* Counters and things for the proc filesystem. */
289         atomic_t stats[SI_NUM_STATS];
290
291         struct task_struct *thread;
292
293         struct list_head link;
294 };
295
296 #define smi_inc_stat(smi, stat) \
297         atomic_inc(&(smi)->stats[SI_STAT_ ## stat])
298 #define smi_get_stat(smi, stat) \
299         ((unsigned int) atomic_read(&(smi)->stats[SI_STAT_ ## stat]))
300
301 #define SI_MAX_PARMS 4
302
303 static int force_kipmid[SI_MAX_PARMS];
304 static int num_force_kipmid;
305 #ifdef CONFIG_PCI
306 static int pci_registered;
307 #endif
308 #ifdef CONFIG_PPC_OF
309 static int of_registered;
310 #endif
311
312 static unsigned int kipmid_max_busy_us[SI_MAX_PARMS];
313 static int num_max_busy_us;
314
315 static int unload_when_empty = 1;
316
317 static int add_smi(struct smi_info *smi);
318 static int try_smi_init(struct smi_info *smi);
319 static void cleanup_one_si(struct smi_info *to_clean);
320
321 static ATOMIC_NOTIFIER_HEAD(xaction_notifier_list);
322 static int register_xaction_notifier(struct notifier_block *nb)
323 {
324         return atomic_notifier_chain_register(&xaction_notifier_list, nb);
325 }
326
327 static void deliver_recv_msg(struct smi_info *smi_info,
328                              struct ipmi_smi_msg *msg)
329 {
330         /* Deliver the message to the upper layer with the lock
331            released. */
332
333         if (smi_info->run_to_completion) {
334                 ipmi_smi_msg_received(smi_info->intf, msg);
335         } else {
336                 spin_unlock(&(smi_info->si_lock));
337                 ipmi_smi_msg_received(smi_info->intf, msg);
338                 spin_lock(&(smi_info->si_lock));
339         }
340 }
341
342 static void return_hosed_msg(struct smi_info *smi_info, int cCode)
343 {
344         struct ipmi_smi_msg *msg = smi_info->curr_msg;
345
346         if (cCode < 0 || cCode > IPMI_ERR_UNSPECIFIED)
347                 cCode = IPMI_ERR_UNSPECIFIED;
348         /* else use it as is */
349
350         /* Make it a reponse */
351         msg->rsp[0] = msg->data[0] | 4;
352         msg->rsp[1] = msg->data[1];
353         msg->rsp[2] = cCode;
354         msg->rsp_size = 3;
355
356         smi_info->curr_msg = NULL;
357         deliver_recv_msg(smi_info, msg);
358 }
359
360 static enum si_sm_result start_next_msg(struct smi_info *smi_info)
361 {
362         int              rv;
363         struct list_head *entry = NULL;
364 #ifdef DEBUG_TIMING
365         struct timeval t;
366 #endif
367
368         /*
369          * No need to save flags, we aleady have interrupts off and we
370          * already hold the SMI lock.
371          */
372         if (!smi_info->run_to_completion)
373                 spin_lock(&(smi_info->msg_lock));
374
375         /* Pick the high priority queue first. */
376         if (!list_empty(&(smi_info->hp_xmit_msgs))) {
377                 entry = smi_info->hp_xmit_msgs.next;
378         } else if (!list_empty(&(smi_info->xmit_msgs))) {
379                 entry = smi_info->xmit_msgs.next;
380         }
381
382         if (!entry) {
383                 smi_info->curr_msg = NULL;
384                 rv = SI_SM_IDLE;
385         } else {
386                 int err;
387
388                 list_del(entry);
389                 smi_info->curr_msg = list_entry(entry,
390                                                 struct ipmi_smi_msg,
391                                                 link);
392 #ifdef DEBUG_TIMING
393                 do_gettimeofday(&t);
394                 printk(KERN_DEBUG "**Start2: %d.%9.9d\n", t.tv_sec, t.tv_usec);
395 #endif
396                 err = atomic_notifier_call_chain(&xaction_notifier_list,
397                                 0, smi_info);
398                 if (err & NOTIFY_STOP_MASK) {
399                         rv = SI_SM_CALL_WITHOUT_DELAY;
400                         goto out;
401                 }
402                 err = smi_info->handlers->start_transaction(
403                         smi_info->si_sm,
404                         smi_info->curr_msg->data,
405                         smi_info->curr_msg->data_size);
406                 if (err)
407                         return_hosed_msg(smi_info, err);
408
409                 rv = SI_SM_CALL_WITHOUT_DELAY;
410         }
411  out:
412         if (!smi_info->run_to_completion)
413                 spin_unlock(&(smi_info->msg_lock));
414
415         return rv;
416 }
417
418 static void start_enable_irq(struct smi_info *smi_info)
419 {
420         unsigned char msg[2];
421
422         /*
423          * If we are enabling interrupts, we have to tell the
424          * BMC to use them.
425          */
426         msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
427         msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
428
429         smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
430         smi_info->si_state = SI_ENABLE_INTERRUPTS1;
431 }
432
433 static void start_disable_irq(struct smi_info *smi_info)
434 {
435         unsigned char msg[2];
436
437         msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
438         msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
439
440         smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
441         smi_info->si_state = SI_DISABLE_INTERRUPTS1;
442 }
443
444 static void start_clear_flags(struct smi_info *smi_info)
445 {
446         unsigned char msg[3];
447
448         /* Make sure the watchdog pre-timeout flag is not set at startup. */
449         msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
450         msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
451         msg[2] = WDT_PRE_TIMEOUT_INT;
452
453         smi_info->handlers->start_transaction(smi_info->si_sm, msg, 3);
454         smi_info->si_state = SI_CLEARING_FLAGS;
455 }
456
457 /*
458  * When we have a situtaion where we run out of memory and cannot
459  * allocate messages, we just leave them in the BMC and run the system
460  * polled until we can allocate some memory.  Once we have some
461  * memory, we will re-enable the interrupt.
462  */
463 static inline void disable_si_irq(struct smi_info *smi_info)
464 {
465         if ((smi_info->irq) && (!smi_info->interrupt_disabled)) {
466                 start_disable_irq(smi_info);
467                 smi_info->interrupt_disabled = 1;
468                 if (!atomic_read(&smi_info->stop_operation))
469                         mod_timer(&smi_info->si_timer,
470                                   jiffies + SI_TIMEOUT_JIFFIES);
471         }
472 }
473
474 static inline void enable_si_irq(struct smi_info *smi_info)
475 {
476         if ((smi_info->irq) && (smi_info->interrupt_disabled)) {
477                 start_enable_irq(smi_info);
478                 smi_info->interrupt_disabled = 0;
479         }
480 }
481
482 static void handle_flags(struct smi_info *smi_info)
483 {
484  retry:
485         if (smi_info->msg_flags & WDT_PRE_TIMEOUT_INT) {
486                 /* Watchdog pre-timeout */
487                 smi_inc_stat(smi_info, watchdog_pretimeouts);
488
489                 start_clear_flags(smi_info);
490                 smi_info->msg_flags &= ~WDT_PRE_TIMEOUT_INT;
491                 spin_unlock(&(smi_info->si_lock));
492                 ipmi_smi_watchdog_pretimeout(smi_info->intf);
493                 spin_lock(&(smi_info->si_lock));
494         } else if (smi_info->msg_flags & RECEIVE_MSG_AVAIL) {
495                 /* Messages available. */
496                 smi_info->curr_msg = ipmi_alloc_smi_msg();
497                 if (!smi_info->curr_msg) {
498                         disable_si_irq(smi_info);
499                         smi_info->si_state = SI_NORMAL;
500                         return;
501                 }
502                 enable_si_irq(smi_info);
503
504                 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
505                 smi_info->curr_msg->data[1] = IPMI_GET_MSG_CMD;
506                 smi_info->curr_msg->data_size = 2;
507
508                 smi_info->handlers->start_transaction(
509                         smi_info->si_sm,
510                         smi_info->curr_msg->data,
511                         smi_info->curr_msg->data_size);
512                 smi_info->si_state = SI_GETTING_MESSAGES;
513         } else if (smi_info->msg_flags & EVENT_MSG_BUFFER_FULL) {
514                 /* Events available. */
515                 smi_info->curr_msg = ipmi_alloc_smi_msg();
516                 if (!smi_info->curr_msg) {
517                         disable_si_irq(smi_info);
518                         smi_info->si_state = SI_NORMAL;
519                         return;
520                 }
521                 enable_si_irq(smi_info);
522
523                 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
524                 smi_info->curr_msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
525                 smi_info->curr_msg->data_size = 2;
526
527                 smi_info->handlers->start_transaction(
528                         smi_info->si_sm,
529                         smi_info->curr_msg->data,
530                         smi_info->curr_msg->data_size);
531                 smi_info->si_state = SI_GETTING_EVENTS;
532         } else if (smi_info->msg_flags & OEM_DATA_AVAIL &&
533                    smi_info->oem_data_avail_handler) {
534                 if (smi_info->oem_data_avail_handler(smi_info))
535                         goto retry;
536         } else
537                 smi_info->si_state = SI_NORMAL;
538 }
539
540 static void handle_transaction_done(struct smi_info *smi_info)
541 {
542         struct ipmi_smi_msg *msg;
543 #ifdef DEBUG_TIMING
544         struct timeval t;
545
546         do_gettimeofday(&t);
547         printk(KERN_DEBUG "**Done: %d.%9.9d\n", t.tv_sec, t.tv_usec);
548 #endif
549         switch (smi_info->si_state) {
550         case SI_NORMAL:
551                 if (!smi_info->curr_msg)
552                         break;
553
554                 smi_info->curr_msg->rsp_size
555                         = smi_info->handlers->get_result(
556                                 smi_info->si_sm,
557                                 smi_info->curr_msg->rsp,
558                                 IPMI_MAX_MSG_LENGTH);
559
560                 /*
561                  * Do this here becase deliver_recv_msg() releases the
562                  * lock, and a new message can be put in during the
563                  * time the lock is released.
564                  */
565                 msg = smi_info->curr_msg;
566                 smi_info->curr_msg = NULL;
567                 deliver_recv_msg(smi_info, msg);
568                 break;
569
570         case SI_GETTING_FLAGS:
571         {
572                 unsigned char msg[4];
573                 unsigned int  len;
574
575                 /* We got the flags from the SMI, now handle them. */
576                 len = smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
577                 if (msg[2] != 0) {
578                         /* Error fetching flags, just give up for now. */
579                         smi_info->si_state = SI_NORMAL;
580                 } else if (len < 4) {
581                         /*
582                          * Hmm, no flags.  That's technically illegal, but
583                          * don't use uninitialized data.
584                          */
585                         smi_info->si_state = SI_NORMAL;
586                 } else {
587                         smi_info->msg_flags = msg[3];
588                         handle_flags(smi_info);
589                 }
590                 break;
591         }
592
593         case SI_CLEARING_FLAGS:
594         case SI_CLEARING_FLAGS_THEN_SET_IRQ:
595         {
596                 unsigned char msg[3];
597
598                 /* We cleared the flags. */
599                 smi_info->handlers->get_result(smi_info->si_sm, msg, 3);
600                 if (msg[2] != 0) {
601                         /* Error clearing flags */
602                         dev_warn(smi_info->dev,
603                                  "Error clearing flags: %2.2x\n", msg[2]);
604                 }
605                 if (smi_info->si_state == SI_CLEARING_FLAGS_THEN_SET_IRQ)
606                         start_enable_irq(smi_info);
607                 else
608                         smi_info->si_state = SI_NORMAL;
609                 break;
610         }
611
612         case SI_GETTING_EVENTS:
613         {
614                 smi_info->curr_msg->rsp_size
615                         = smi_info->handlers->get_result(
616                                 smi_info->si_sm,
617                                 smi_info->curr_msg->rsp,
618                                 IPMI_MAX_MSG_LENGTH);
619
620                 /*
621                  * Do this here becase deliver_recv_msg() releases the
622                  * lock, and a new message can be put in during the
623                  * time the lock is released.
624                  */
625                 msg = smi_info->curr_msg;
626                 smi_info->curr_msg = NULL;
627                 if (msg->rsp[2] != 0) {
628                         /* Error getting event, probably done. */
629                         msg->done(msg);
630
631                         /* Take off the event flag. */
632                         smi_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
633                         handle_flags(smi_info);
634                 } else {
635                         smi_inc_stat(smi_info, events);
636
637                         /*
638                          * Do this before we deliver the message
639                          * because delivering the message releases the
640                          * lock and something else can mess with the
641                          * state.
642                          */
643                         handle_flags(smi_info);
644
645                         deliver_recv_msg(smi_info, msg);
646                 }
647                 break;
648         }
649
650         case SI_GETTING_MESSAGES:
651         {
652                 smi_info->curr_msg->rsp_size
653                         = smi_info->handlers->get_result(
654                                 smi_info->si_sm,
655                                 smi_info->curr_msg->rsp,
656                                 IPMI_MAX_MSG_LENGTH);
657
658                 /*
659                  * Do this here becase deliver_recv_msg() releases the
660                  * lock, and a new message can be put in during the
661                  * time the lock is released.
662                  */
663                 msg = smi_info->curr_msg;
664                 smi_info->curr_msg = NULL;
665                 if (msg->rsp[2] != 0) {
666                         /* Error getting event, probably done. */
667                         msg->done(msg);
668
669                         /* Take off the msg flag. */
670                         smi_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
671                         handle_flags(smi_info);
672                 } else {
673                         smi_inc_stat(smi_info, incoming_messages);
674
675                         /*
676                          * Do this before we deliver the message
677                          * because delivering the message releases the
678                          * lock and something else can mess with the
679                          * state.
680                          */
681                         handle_flags(smi_info);
682
683                         deliver_recv_msg(smi_info, msg);
684                 }
685                 break;
686         }
687
688         case SI_ENABLE_INTERRUPTS1:
689         {
690                 unsigned char msg[4];
691
692                 /* We got the flags from the SMI, now handle them. */
693                 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
694                 if (msg[2] != 0) {
695                         dev_warn(smi_info->dev, "Could not enable interrupts"
696                                  ", failed get, using polled mode.\n");
697                         smi_info->si_state = SI_NORMAL;
698                 } else {
699                         msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
700                         msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
701                         msg[2] = (msg[3] |
702                                   IPMI_BMC_RCV_MSG_INTR |
703                                   IPMI_BMC_EVT_MSG_INTR);
704                         smi_info->handlers->start_transaction(
705                                 smi_info->si_sm, msg, 3);
706                         smi_info->si_state = SI_ENABLE_INTERRUPTS2;
707                 }
708                 break;
709         }
710
711         case SI_ENABLE_INTERRUPTS2:
712         {
713                 unsigned char msg[4];
714
715                 /* We got the flags from the SMI, now handle them. */
716                 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
717                 if (msg[2] != 0)
718                         dev_warn(smi_info->dev, "Could not enable interrupts"
719                                  ", failed set, using polled mode.\n");
720                 else
721                         smi_info->interrupt_disabled = 0;
722                 smi_info->si_state = SI_NORMAL;
723                 break;
724         }
725
726         case SI_DISABLE_INTERRUPTS1:
727         {
728                 unsigned char msg[4];
729
730                 /* We got the flags from the SMI, now handle them. */
731                 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
732                 if (msg[2] != 0) {
733                         dev_warn(smi_info->dev, "Could not disable interrupts"
734                                  ", failed get.\n");
735                         smi_info->si_state = SI_NORMAL;
736                 } else {
737                         msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
738                         msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
739                         msg[2] = (msg[3] &
740                                   ~(IPMI_BMC_RCV_MSG_INTR |
741                                     IPMI_BMC_EVT_MSG_INTR));
742                         smi_info->handlers->start_transaction(
743                                 smi_info->si_sm, msg, 3);
744                         smi_info->si_state = SI_DISABLE_INTERRUPTS2;
745                 }
746                 break;
747         }
748
749         case SI_DISABLE_INTERRUPTS2:
750         {
751                 unsigned char msg[4];
752
753                 /* We got the flags from the SMI, now handle them. */
754                 smi_info->handlers->get_result(smi_info->si_sm, msg, 4);
755                 if (msg[2] != 0) {
756                         dev_warn(smi_info->dev, "Could not disable interrupts"
757                                  ", failed set.\n");
758                 }
759                 smi_info->si_state = SI_NORMAL;
760                 break;
761         }
762         }
763 }
764
765 /*
766  * Called on timeouts and events.  Timeouts should pass the elapsed
767  * time, interrupts should pass in zero.  Must be called with
768  * si_lock held and interrupts disabled.
769  */
770 static enum si_sm_result smi_event_handler(struct smi_info *smi_info,
771                                            int time)
772 {
773         enum si_sm_result si_sm_result;
774
775  restart:
776         /*
777          * There used to be a loop here that waited a little while
778          * (around 25us) before giving up.  That turned out to be
779          * pointless, the minimum delays I was seeing were in the 300us
780          * range, which is far too long to wait in an interrupt.  So
781          * we just run until the state machine tells us something
782          * happened or it needs a delay.
783          */
784         si_sm_result = smi_info->handlers->event(smi_info->si_sm, time);
785         time = 0;
786         while (si_sm_result == SI_SM_CALL_WITHOUT_DELAY)
787                 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
788
789         if (si_sm_result == SI_SM_TRANSACTION_COMPLETE) {
790                 smi_inc_stat(smi_info, complete_transactions);
791
792                 handle_transaction_done(smi_info);
793                 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
794         } else if (si_sm_result == SI_SM_HOSED) {
795                 smi_inc_stat(smi_info, hosed_count);
796
797                 /*
798                  * Do the before return_hosed_msg, because that
799                  * releases the lock.
800                  */
801                 smi_info->si_state = SI_NORMAL;
802                 if (smi_info->curr_msg != NULL) {
803                         /*
804                          * If we were handling a user message, format
805                          * a response to send to the upper layer to
806                          * tell it about the error.
807                          */
808                         return_hosed_msg(smi_info, IPMI_ERR_UNSPECIFIED);
809                 }
810                 si_sm_result = smi_info->handlers->event(smi_info->si_sm, 0);
811         }
812
813         /*
814          * We prefer handling attn over new messages.  But don't do
815          * this if there is not yet an upper layer to handle anything.
816          */
817         if (likely(smi_info->intf) && si_sm_result == SI_SM_ATTN) {
818                 unsigned char msg[2];
819
820                 smi_inc_stat(smi_info, attentions);
821
822                 /*
823                  * Got a attn, send down a get message flags to see
824                  * what's causing it.  It would be better to handle
825                  * this in the upper layer, but due to the way
826                  * interrupts work with the SMI, that's not really
827                  * possible.
828                  */
829                 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
830                 msg[1] = IPMI_GET_MSG_FLAGS_CMD;
831
832                 smi_info->handlers->start_transaction(
833                         smi_info->si_sm, msg, 2);
834                 smi_info->si_state = SI_GETTING_FLAGS;
835                 goto restart;
836         }
837
838         /* If we are currently idle, try to start the next message. */
839         if (si_sm_result == SI_SM_IDLE) {
840                 smi_inc_stat(smi_info, idles);
841
842                 si_sm_result = start_next_msg(smi_info);
843                 if (si_sm_result != SI_SM_IDLE)
844                         goto restart;
845         }
846
847         if ((si_sm_result == SI_SM_IDLE)
848             && (atomic_read(&smi_info->req_events))) {
849                 /*
850                  * We are idle and the upper layer requested that I fetch
851                  * events, so do so.
852                  */
853                 atomic_set(&smi_info->req_events, 0);
854
855                 smi_info->curr_msg = ipmi_alloc_smi_msg();
856                 if (!smi_info->curr_msg)
857                         goto out;
858
859                 smi_info->curr_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
860                 smi_info->curr_msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
861                 smi_info->curr_msg->data_size = 2;
862
863                 smi_info->handlers->start_transaction(
864                         smi_info->si_sm,
865                         smi_info->curr_msg->data,
866                         smi_info->curr_msg->data_size);
867                 smi_info->si_state = SI_GETTING_EVENTS;
868                 goto restart;
869         }
870  out:
871         return si_sm_result;
872 }
873
874 static void sender(void                *send_info,
875                    struct ipmi_smi_msg *msg,
876                    int                 priority)
877 {
878         struct smi_info   *smi_info = send_info;
879         enum si_sm_result result;
880         unsigned long     flags;
881 #ifdef DEBUG_TIMING
882         struct timeval    t;
883 #endif
884
885         if (atomic_read(&smi_info->stop_operation)) {
886                 msg->rsp[0] = msg->data[0] | 4;
887                 msg->rsp[1] = msg->data[1];
888                 msg->rsp[2] = IPMI_ERR_UNSPECIFIED;
889                 msg->rsp_size = 3;
890                 deliver_recv_msg(smi_info, msg);
891                 return;
892         }
893
894 #ifdef DEBUG_TIMING
895         do_gettimeofday(&t);
896         printk("**Enqueue: %d.%9.9d\n", t.tv_sec, t.tv_usec);
897 #endif
898
899         mod_timer(&smi_info->si_timer, jiffies + SI_TIMEOUT_JIFFIES);
900
901         if (smi_info->thread)
902                 wake_up_process(smi_info->thread);
903
904         if (smi_info->run_to_completion) {
905                 /*
906                  * If we are running to completion, then throw it in
907                  * the list and run transactions until everything is
908                  * clear.  Priority doesn't matter here.
909                  */
910
911                 /*
912                  * Run to completion means we are single-threaded, no
913                  * need for locks.
914                  */
915                 list_add_tail(&(msg->link), &(smi_info->xmit_msgs));
916
917                 result = smi_event_handler(smi_info, 0);
918                 while (result != SI_SM_IDLE) {
919                         udelay(SI_SHORT_TIMEOUT_USEC);
920                         result = smi_event_handler(smi_info,
921                                                    SI_SHORT_TIMEOUT_USEC);
922                 }
923                 return;
924         }
925
926         spin_lock_irqsave(&smi_info->msg_lock, flags);
927         if (priority > 0)
928                 list_add_tail(&msg->link, &smi_info->hp_xmit_msgs);
929         else
930                 list_add_tail(&msg->link, &smi_info->xmit_msgs);
931         spin_unlock_irqrestore(&smi_info->msg_lock, flags);
932
933         spin_lock_irqsave(&smi_info->si_lock, flags);
934         if (smi_info->si_state == SI_NORMAL && smi_info->curr_msg == NULL)
935                 start_next_msg(smi_info);
936         spin_unlock_irqrestore(&smi_info->si_lock, flags);
937 }
938
939 static void set_run_to_completion(void *send_info, int i_run_to_completion)
940 {
941         struct smi_info   *smi_info = send_info;
942         enum si_sm_result result;
943
944         smi_info->run_to_completion = i_run_to_completion;
945         if (i_run_to_completion) {
946                 result = smi_event_handler(smi_info, 0);
947                 while (result != SI_SM_IDLE) {
948                         udelay(SI_SHORT_TIMEOUT_USEC);
949                         result = smi_event_handler(smi_info,
950                                                    SI_SHORT_TIMEOUT_USEC);
951                 }
952         }
953 }
954
955 /*
956  * Use -1 in the nsec value of the busy waiting timespec to tell that
957  * we are spinning in kipmid looking for something and not delaying
958  * between checks
959  */
960 static inline void ipmi_si_set_not_busy(struct timespec *ts)
961 {
962         ts->tv_nsec = -1;
963 }
964 static inline int ipmi_si_is_busy(struct timespec *ts)
965 {
966         return ts->tv_nsec != -1;
967 }
968
969 static int ipmi_thread_busy_wait(enum si_sm_result smi_result,
970                                  const struct smi_info *smi_info,
971                                  struct timespec *busy_until)
972 {
973         unsigned int max_busy_us = 0;
974
975         if (smi_info->intf_num < num_max_busy_us)
976                 max_busy_us = kipmid_max_busy_us[smi_info->intf_num];
977         if (max_busy_us == 0 || smi_result != SI_SM_CALL_WITH_DELAY)
978                 ipmi_si_set_not_busy(busy_until);
979         else if (!ipmi_si_is_busy(busy_until)) {
980                 getnstimeofday(busy_until);
981                 timespec_add_ns(busy_until, max_busy_us*NSEC_PER_USEC);
982         } else {
983                 struct timespec now;
984                 getnstimeofday(&now);
985                 if (unlikely(timespec_compare(&now, busy_until) > 0)) {
986                         ipmi_si_set_not_busy(busy_until);
987                         return 0;
988                 }
989         }
990         return 1;
991 }
992
993
994 /*
995  * A busy-waiting loop for speeding up IPMI operation.
996  *
997  * Lousy hardware makes this hard.  This is only enabled for systems
998  * that are not BT and do not have interrupts.  It starts spinning
999  * when an operation is complete or until max_busy tells it to stop
1000  * (if that is enabled).  See the paragraph on kimid_max_busy_us in
1001  * Documentation/IPMI.txt for details.
1002  */
1003 static int ipmi_thread(void *data)
1004 {
1005         struct smi_info *smi_info = data;
1006         unsigned long flags;
1007         enum si_sm_result smi_result;
1008         struct timespec busy_until;
1009
1010         ipmi_si_set_not_busy(&busy_until);
1011         set_user_nice(current, 19);
1012         while (!kthread_should_stop()) {
1013                 int busy_wait;
1014
1015                 spin_lock_irqsave(&(smi_info->si_lock), flags);
1016                 smi_result = smi_event_handler(smi_info, 0);
1017                 spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1018                 busy_wait = ipmi_thread_busy_wait(smi_result, smi_info,
1019                                                   &busy_until);
1020                 if (smi_result == SI_SM_CALL_WITHOUT_DELAY)
1021                         ; /* do nothing */
1022                 else if (smi_result == SI_SM_CALL_WITH_DELAY && busy_wait)
1023                         schedule();
1024                 else if (smi_result == SI_SM_IDLE)
1025                         schedule_timeout_interruptible(100);
1026                 else
1027                         schedule_timeout_interruptible(0);
1028         }
1029         return 0;
1030 }
1031
1032
1033 static void poll(void *send_info)
1034 {
1035         struct smi_info *smi_info = send_info;
1036         unsigned long flags;
1037
1038         /*
1039          * Make sure there is some delay in the poll loop so we can
1040          * drive time forward and timeout things.
1041          */
1042         udelay(10);
1043         spin_lock_irqsave(&smi_info->si_lock, flags);
1044         smi_event_handler(smi_info, 10);
1045         spin_unlock_irqrestore(&smi_info->si_lock, flags);
1046 }
1047
1048 static void request_events(void *send_info)
1049 {
1050         struct smi_info *smi_info = send_info;
1051
1052         if (atomic_read(&smi_info->stop_operation) ||
1053                                 !smi_info->has_event_buffer)
1054                 return;
1055
1056         atomic_set(&smi_info->req_events, 1);
1057 }
1058
1059 static int initialized;
1060
1061 static void smi_timeout(unsigned long data)
1062 {
1063         struct smi_info   *smi_info = (struct smi_info *) data;
1064         enum si_sm_result smi_result;
1065         unsigned long     flags;
1066         unsigned long     jiffies_now;
1067         long              time_diff;
1068         long              timeout;
1069 #ifdef DEBUG_TIMING
1070         struct timeval    t;
1071 #endif
1072
1073         spin_lock_irqsave(&(smi_info->si_lock), flags);
1074 #ifdef DEBUG_TIMING
1075         do_gettimeofday(&t);
1076         printk(KERN_DEBUG "**Timer: %d.%9.9d\n", t.tv_sec, t.tv_usec);
1077 #endif
1078         jiffies_now = jiffies;
1079         time_diff = (((long)jiffies_now - (long)smi_info->last_timeout_jiffies)
1080                      * SI_USEC_PER_JIFFY);
1081         smi_result = smi_event_handler(smi_info, time_diff);
1082
1083         spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1084
1085         smi_info->last_timeout_jiffies = jiffies_now;
1086
1087         if ((smi_info->irq) && (!smi_info->interrupt_disabled)) {
1088                 /* Running with interrupts, only do long timeouts. */
1089                 timeout = jiffies + SI_TIMEOUT_JIFFIES;
1090                 smi_inc_stat(smi_info, long_timeouts);
1091                 goto do_mod_timer;
1092         }
1093
1094         /*
1095          * If the state machine asks for a short delay, then shorten
1096          * the timer timeout.
1097          */
1098         if (smi_result == SI_SM_CALL_WITH_DELAY) {
1099                 smi_inc_stat(smi_info, short_timeouts);
1100                 timeout = jiffies + 1;
1101         } else {
1102                 smi_inc_stat(smi_info, long_timeouts);
1103                 timeout = jiffies + SI_TIMEOUT_JIFFIES;
1104         }
1105
1106  do_mod_timer:
1107         if (smi_result != SI_SM_IDLE)
1108                 mod_timer(&(smi_info->si_timer), timeout);
1109 }
1110
1111 static irqreturn_t si_irq_handler(int irq, void *data)
1112 {
1113         struct smi_info *smi_info = data;
1114         unsigned long   flags;
1115 #ifdef DEBUG_TIMING
1116         struct timeval  t;
1117 #endif
1118
1119         spin_lock_irqsave(&(smi_info->si_lock), flags);
1120
1121         smi_inc_stat(smi_info, interrupts);
1122
1123 #ifdef DEBUG_TIMING
1124         do_gettimeofday(&t);
1125         printk(KERN_DEBUG "**Interrupt: %d.%9.9d\n", t.tv_sec, t.tv_usec);
1126 #endif
1127         smi_event_handler(smi_info, 0);
1128         spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1129         return IRQ_HANDLED;
1130 }
1131
1132 static irqreturn_t si_bt_irq_handler(int irq, void *data)
1133 {
1134         struct smi_info *smi_info = data;
1135         /* We need to clear the IRQ flag for the BT interface. */
1136         smi_info->io.outputb(&smi_info->io, IPMI_BT_INTMASK_REG,
1137                              IPMI_BT_INTMASK_CLEAR_IRQ_BIT
1138                              | IPMI_BT_INTMASK_ENABLE_IRQ_BIT);
1139         return si_irq_handler(irq, data);
1140 }
1141
1142 static int smi_start_processing(void       *send_info,
1143                                 ipmi_smi_t intf)
1144 {
1145         struct smi_info *new_smi = send_info;
1146         int             enable = 0;
1147
1148         new_smi->intf = intf;
1149
1150         /* Try to claim any interrupts. */
1151         if (new_smi->irq_setup)
1152                 new_smi->irq_setup(new_smi);
1153
1154         /* Set up the timer that drives the interface. */
1155         setup_timer(&new_smi->si_timer, smi_timeout, (long)new_smi);
1156         new_smi->last_timeout_jiffies = jiffies;
1157         mod_timer(&new_smi->si_timer, jiffies + SI_TIMEOUT_JIFFIES);
1158
1159         /*
1160          * Check if the user forcefully enabled the daemon.
1161          */
1162         if (new_smi->intf_num < num_force_kipmid)
1163                 enable = force_kipmid[new_smi->intf_num];
1164         /*
1165          * The BT interface is efficient enough to not need a thread,
1166          * and there is no need for a thread if we have interrupts.
1167          */
1168         else if ((new_smi->si_type != SI_BT) && (!new_smi->irq))
1169                 enable = 1;
1170
1171         if (enable) {
1172                 new_smi->thread = kthread_run(ipmi_thread, new_smi,
1173                                               "kipmi%d", new_smi->intf_num);
1174                 if (IS_ERR(new_smi->thread)) {
1175                         dev_notice(new_smi->dev, "Could not start"
1176                                    " kernel thread due to error %ld, only using"
1177                                    " timers to drive the interface\n",
1178                                    PTR_ERR(new_smi->thread));
1179                         new_smi->thread = NULL;
1180                 }
1181         }
1182
1183         return 0;
1184 }
1185
1186 static void set_maintenance_mode(void *send_info, int enable)
1187 {
1188         struct smi_info   *smi_info = send_info;
1189
1190         if (!enable)
1191                 atomic_set(&smi_info->req_events, 0);
1192 }
1193
1194 static struct ipmi_smi_handlers handlers = {
1195         .owner                  = THIS_MODULE,
1196         .start_processing       = smi_start_processing,
1197         .sender                 = sender,
1198         .request_events         = request_events,
1199         .set_maintenance_mode   = set_maintenance_mode,
1200         .set_run_to_completion  = set_run_to_completion,
1201         .poll                   = poll,
1202 };
1203
1204 /*
1205  * There can be 4 IO ports passed in (with or without IRQs), 4 addresses,
1206  * a default IO port, and 1 ACPI/SPMI address.  That sets SI_MAX_DRIVERS.
1207  */
1208
1209 static LIST_HEAD(smi_infos);
1210 static DEFINE_MUTEX(smi_infos_lock);
1211 static int smi_num; /* Used to sequence the SMIs */
1212
1213 #define DEFAULT_REGSPACING      1
1214 #define DEFAULT_REGSIZE         1
1215
1216 static int           si_trydefaults = 1;
1217 static char          *si_type[SI_MAX_PARMS];
1218 #define MAX_SI_TYPE_STR 30
1219 static char          si_type_str[MAX_SI_TYPE_STR];
1220 static unsigned long addrs[SI_MAX_PARMS];
1221 static unsigned int num_addrs;
1222 static unsigned int  ports[SI_MAX_PARMS];
1223 static unsigned int num_ports;
1224 static int           irqs[SI_MAX_PARMS];
1225 static unsigned int num_irqs;
1226 static int           regspacings[SI_MAX_PARMS];
1227 static unsigned int num_regspacings;
1228 static int           regsizes[SI_MAX_PARMS];
1229 static unsigned int num_regsizes;
1230 static int           regshifts[SI_MAX_PARMS];
1231 static unsigned int num_regshifts;
1232 static int slave_addrs[SI_MAX_PARMS]; /* Leaving 0 chooses the default value */
1233 static unsigned int num_slave_addrs;
1234
1235 #define IPMI_IO_ADDR_SPACE  0
1236 #define IPMI_MEM_ADDR_SPACE 1
1237 static char *addr_space_to_str[] = { "i/o", "mem" };
1238
1239 static int hotmod_handler(const char *val, struct kernel_param *kp);
1240
1241 module_param_call(hotmod, hotmod_handler, NULL, NULL, 0200);
1242 MODULE_PARM_DESC(hotmod, "Add and remove interfaces.  See"
1243                  " Documentation/IPMI.txt in the kernel sources for the"
1244                  " gory details.");
1245
1246 module_param_named(trydefaults, si_trydefaults, bool, 0);
1247 MODULE_PARM_DESC(trydefaults, "Setting this to 'false' will disable the"
1248                  " default scan of the KCS and SMIC interface at the standard"
1249                  " address");
1250 module_param_string(type, si_type_str, MAX_SI_TYPE_STR, 0);
1251 MODULE_PARM_DESC(type, "Defines the type of each interface, each"
1252                  " interface separated by commas.  The types are 'kcs',"
1253                  " 'smic', and 'bt'.  For example si_type=kcs,bt will set"
1254                  " the first interface to kcs and the second to bt");
1255 module_param_array(addrs, ulong, &num_addrs, 0);
1256 MODULE_PARM_DESC(addrs, "Sets the memory address of each interface, the"
1257                  " addresses separated by commas.  Only use if an interface"
1258                  " is in memory.  Otherwise, set it to zero or leave"
1259                  " it blank.");
1260 module_param_array(ports, uint, &num_ports, 0);
1261 MODULE_PARM_DESC(ports, "Sets the port address of each interface, the"
1262                  " addresses separated by commas.  Only use if an interface"
1263                  " is a port.  Otherwise, set it to zero or leave"
1264                  " it blank.");
1265 module_param_array(irqs, int, &num_irqs, 0);
1266 MODULE_PARM_DESC(irqs, "Sets the interrupt of each interface, the"
1267                  " addresses separated by commas.  Only use if an interface"
1268                  " has an interrupt.  Otherwise, set it to zero or leave"
1269                  " it blank.");
1270 module_param_array(regspacings, int, &num_regspacings, 0);
1271 MODULE_PARM_DESC(regspacings, "The number of bytes between the start address"
1272                  " and each successive register used by the interface.  For"
1273                  " instance, if the start address is 0xca2 and the spacing"
1274                  " is 2, then the second address is at 0xca4.  Defaults"
1275                  " to 1.");
1276 module_param_array(regsizes, int, &num_regsizes, 0);
1277 MODULE_PARM_DESC(regsizes, "The size of the specific IPMI register in bytes."
1278                  " This should generally be 1, 2, 4, or 8 for an 8-bit,"
1279                  " 16-bit, 32-bit, or 64-bit register.  Use this if you"
1280                  " the 8-bit IPMI register has to be read from a larger"
1281                  " register.");
1282 module_param_array(regshifts, int, &num_regshifts, 0);
1283 MODULE_PARM_DESC(regshifts, "The amount to shift the data read from the."
1284                  " IPMI register, in bits.  For instance, if the data"
1285                  " is read from a 32-bit word and the IPMI data is in"
1286                  " bit 8-15, then the shift would be 8");
1287 module_param_array(slave_addrs, int, &num_slave_addrs, 0);
1288 MODULE_PARM_DESC(slave_addrs, "Set the default IPMB slave address for"
1289                  " the controller.  Normally this is 0x20, but can be"
1290                  " overridden by this parm.  This is an array indexed"
1291                  " by interface number.");
1292 module_param_array(force_kipmid, int, &num_force_kipmid, 0);
1293 MODULE_PARM_DESC(force_kipmid, "Force the kipmi daemon to be enabled (1) or"
1294                  " disabled(0).  Normally the IPMI driver auto-detects"
1295                  " this, but the value may be overridden by this parm.");
1296 module_param(unload_when_empty, int, 0);
1297 MODULE_PARM_DESC(unload_when_empty, "Unload the module if no interfaces are"
1298                  " specified or found, default is 1.  Setting to 0"
1299                  " is useful for hot add of devices using hotmod.");
1300 module_param_array(kipmid_max_busy_us, uint, &num_max_busy_us, 0644);
1301 MODULE_PARM_DESC(kipmid_max_busy_us,
1302                  "Max time (in microseconds) to busy-wait for IPMI data before"
1303                  " sleeping. 0 (default) means to wait forever. Set to 100-500"
1304                  " if kipmid is using up a lot of CPU time.");
1305
1306
1307 static void std_irq_cleanup(struct smi_info *info)
1308 {
1309         if (info->si_type == SI_BT)
1310                 /* Disable the interrupt in the BT interface. */
1311                 info->io.outputb(&info->io, IPMI_BT_INTMASK_REG, 0);
1312         free_irq(info->irq, info);
1313 }
1314
1315 static int std_irq_setup(struct smi_info *info)
1316 {
1317         int rv;
1318
1319         if (!info->irq)
1320                 return 0;
1321
1322         if (info->si_type == SI_BT) {
1323                 rv = request_irq(info->irq,
1324                                  si_bt_irq_handler,
1325                                  IRQF_SHARED | IRQF_DISABLED,
1326                                  DEVICE_NAME,
1327                                  info);
1328                 if (!rv)
1329                         /* Enable the interrupt in the BT interface. */
1330                         info->io.outputb(&info->io, IPMI_BT_INTMASK_REG,
1331                                          IPMI_BT_INTMASK_ENABLE_IRQ_BIT);
1332         } else
1333                 rv = request_irq(info->irq,
1334                                  si_irq_handler,
1335                                  IRQF_SHARED | IRQF_DISABLED,
1336                                  DEVICE_NAME,
1337                                  info);
1338         if (rv) {
1339                 dev_warn(info->dev, "%s unable to claim interrupt %d,"
1340                          " running polled\n",
1341                          DEVICE_NAME, info->irq);
1342                 info->irq = 0;
1343         } else {
1344                 info->irq_cleanup = std_irq_cleanup;
1345                 dev_info(info->dev, "Using irq %d\n", info->irq);
1346         }
1347
1348         return rv;
1349 }
1350
1351 static unsigned char port_inb(struct si_sm_io *io, unsigned int offset)
1352 {
1353         unsigned int addr = io->addr_data;
1354
1355         return inb(addr + (offset * io->regspacing));
1356 }
1357
1358 static void port_outb(struct si_sm_io *io, unsigned int offset,
1359                       unsigned char b)
1360 {
1361         unsigned int addr = io->addr_data;
1362
1363         outb(b, addr + (offset * io->regspacing));
1364 }
1365
1366 static unsigned char port_inw(struct si_sm_io *io, unsigned int offset)
1367 {
1368         unsigned int addr = io->addr_data;
1369
1370         return (inw(addr + (offset * io->regspacing)) >> io->regshift) & 0xff;
1371 }
1372
1373 static void port_outw(struct si_sm_io *io, unsigned int offset,
1374                       unsigned char b)
1375 {
1376         unsigned int addr = io->addr_data;
1377
1378         outw(b << io->regshift, addr + (offset * io->regspacing));
1379 }
1380
1381 static unsigned char port_inl(struct si_sm_io *io, unsigned int offset)
1382 {
1383         unsigned int addr = io->addr_data;
1384
1385         return (inl(addr + (offset * io->regspacing)) >> io->regshift) & 0xff;
1386 }
1387
1388 static void port_outl(struct si_sm_io *io, unsigned int offset,
1389                       unsigned char b)
1390 {
1391         unsigned int addr = io->addr_data;
1392
1393         outl(b << io->regshift, addr+(offset * io->regspacing));
1394 }
1395
1396 static void port_cleanup(struct smi_info *info)
1397 {
1398         unsigned int addr = info->io.addr_data;
1399         int          idx;
1400
1401         if (addr) {
1402                 for (idx = 0; idx < info->io_size; idx++)
1403                         release_region(addr + idx * info->io.regspacing,
1404                                        info->io.regsize);
1405         }
1406 }
1407
1408 static int port_setup(struct smi_info *info)
1409 {
1410         unsigned int addr = info->io.addr_data;
1411         int          idx;
1412
1413         if (!addr)
1414                 return -ENODEV;
1415
1416         info->io_cleanup = port_cleanup;
1417
1418         /*
1419          * Figure out the actual inb/inw/inl/etc routine to use based
1420          * upon the register size.
1421          */
1422         switch (info->io.regsize) {
1423         case 1:
1424                 info->io.inputb = port_inb;
1425                 info->io.outputb = port_outb;
1426                 break;
1427         case 2:
1428                 info->io.inputb = port_inw;
1429                 info->io.outputb = port_outw;
1430                 break;
1431         case 4:
1432                 info->io.inputb = port_inl;
1433                 info->io.outputb = port_outl;
1434                 break;
1435         default:
1436                 dev_warn(info->dev, "Invalid register size: %d\n",
1437                          info->io.regsize);
1438                 return -EINVAL;
1439         }
1440
1441         /*
1442          * Some BIOSes reserve disjoint I/O regions in their ACPI
1443          * tables.  This causes problems when trying to register the
1444          * entire I/O region.  Therefore we must register each I/O
1445          * port separately.
1446          */
1447         for (idx = 0; idx < info->io_size; idx++) {
1448                 if (request_region(addr + idx * info->io.regspacing,
1449                                    info->io.regsize, DEVICE_NAME) == NULL) {
1450                         /* Undo allocations */
1451                         while (idx--) {
1452                                 release_region(addr + idx * info->io.regspacing,
1453                                                info->io.regsize);
1454                         }
1455                         return -EIO;
1456                 }
1457         }
1458         return 0;
1459 }
1460
1461 static unsigned char intf_mem_inb(struct si_sm_io *io, unsigned int offset)
1462 {
1463         return readb((io->addr)+(offset * io->regspacing));
1464 }
1465
1466 static void intf_mem_outb(struct si_sm_io *io, unsigned int offset,
1467                      unsigned char b)
1468 {
1469         writeb(b, (io->addr)+(offset * io->regspacing));
1470 }
1471
1472 static unsigned char intf_mem_inw(struct si_sm_io *io, unsigned int offset)
1473 {
1474         return (readw((io->addr)+(offset * io->regspacing)) >> io->regshift)
1475                 & 0xff;
1476 }
1477
1478 static void intf_mem_outw(struct si_sm_io *io, unsigned int offset,
1479                      unsigned char b)
1480 {
1481         writeb(b << io->regshift, (io->addr)+(offset * io->regspacing));
1482 }
1483
1484 static unsigned char intf_mem_inl(struct si_sm_io *io, unsigned int offset)
1485 {
1486         return (readl((io->addr)+(offset * io->regspacing)) >> io->regshift)
1487                 & 0xff;
1488 }
1489
1490 static void intf_mem_outl(struct si_sm_io *io, unsigned int offset,
1491                      unsigned char b)
1492 {
1493         writel(b << io->regshift, (io->addr)+(offset * io->regspacing));
1494 }
1495
1496 #ifdef readq
1497 static unsigned char mem_inq(struct si_sm_io *io, unsigned int offset)
1498 {
1499         return (readq((io->addr)+(offset * io->regspacing)) >> io->regshift)
1500                 & 0xff;
1501 }
1502
1503 static void mem_outq(struct si_sm_io *io, unsigned int offset,
1504                      unsigned char b)
1505 {
1506         writeq(b << io->regshift, (io->addr)+(offset * io->regspacing));
1507 }
1508 #endif
1509
1510 static void mem_cleanup(struct smi_info *info)
1511 {
1512         unsigned long addr = info->io.addr_data;
1513         int           mapsize;
1514
1515         if (info->io.addr) {
1516                 iounmap(info->io.addr);
1517
1518                 mapsize = ((info->io_size * info->io.regspacing)
1519                            - (info->io.regspacing - info->io.regsize));
1520
1521                 release_mem_region(addr, mapsize);
1522         }
1523 }
1524
1525 static int mem_setup(struct smi_info *info)
1526 {
1527         unsigned long addr = info->io.addr_data;
1528         int           mapsize;
1529
1530         if (!addr)
1531                 return -ENODEV;
1532
1533         info->io_cleanup = mem_cleanup;
1534
1535         /*
1536          * Figure out the actual readb/readw/readl/etc routine to use based
1537          * upon the register size.
1538          */
1539         switch (info->io.regsize) {
1540         case 1:
1541                 info->io.inputb = intf_mem_inb;
1542                 info->io.outputb = intf_mem_outb;
1543                 break;
1544         case 2:
1545                 info->io.inputb = intf_mem_inw;
1546                 info->io.outputb = intf_mem_outw;
1547                 break;
1548         case 4:
1549                 info->io.inputb = intf_mem_inl;
1550                 info->io.outputb = intf_mem_outl;
1551                 break;
1552 #ifdef readq
1553         case 8:
1554                 info->io.inputb = mem_inq;
1555                 info->io.outputb = mem_outq;
1556                 break;
1557 #endif
1558         default:
1559                 dev_warn(info->dev, "Invalid register size: %d\n",
1560                          info->io.regsize);
1561                 return -EINVAL;
1562         }
1563
1564         /*
1565          * Calculate the total amount of memory to claim.  This is an
1566          * unusual looking calculation, but it avoids claiming any
1567          * more memory than it has to.  It will claim everything
1568          * between the first address to the end of the last full
1569          * register.
1570          */
1571         mapsize = ((info->io_size * info->io.regspacing)
1572                    - (info->io.regspacing - info->io.regsize));
1573
1574         if (request_mem_region(addr, mapsize, DEVICE_NAME) == NULL)
1575                 return -EIO;
1576
1577         info->io.addr = ioremap(addr, mapsize);
1578         if (info->io.addr == NULL) {
1579                 release_mem_region(addr, mapsize);
1580                 return -EIO;
1581         }
1582         return 0;
1583 }
1584
1585 /*
1586  * Parms come in as <op1>[:op2[:op3...]].  ops are:
1587  *   add|remove,kcs|bt|smic,mem|i/o,<address>[,<opt1>[,<opt2>[,...]]]
1588  * Options are:
1589  *   rsp=<regspacing>
1590  *   rsi=<regsize>
1591  *   rsh=<regshift>
1592  *   irq=<irq>
1593  *   ipmb=<ipmb addr>
1594  */
1595 enum hotmod_op { HM_ADD, HM_REMOVE };
1596 struct hotmod_vals {
1597         char *name;
1598         int  val;
1599 };
1600 static struct hotmod_vals hotmod_ops[] = {
1601         { "add",        HM_ADD },
1602         { "remove",     HM_REMOVE },
1603         { NULL }
1604 };
1605 static struct hotmod_vals hotmod_si[] = {
1606         { "kcs",        SI_KCS },
1607         { "smic",       SI_SMIC },
1608         { "bt",         SI_BT },
1609         { NULL }
1610 };
1611 static struct hotmod_vals hotmod_as[] = {
1612         { "mem",        IPMI_MEM_ADDR_SPACE },
1613         { "i/o",        IPMI_IO_ADDR_SPACE },
1614         { NULL }
1615 };
1616
1617 static int parse_str(struct hotmod_vals *v, int *val, char *name, char **curr)
1618 {
1619         char *s;
1620         int  i;
1621
1622         s = strchr(*curr, ',');
1623         if (!s) {
1624                 printk(KERN_WARNING PFX "No hotmod %s given.\n", name);
1625                 return -EINVAL;
1626         }
1627         *s = '\0';
1628         s++;
1629         for (i = 0; hotmod_ops[i].name; i++) {
1630                 if (strcmp(*curr, v[i].name) == 0) {
1631                         *val = v[i].val;
1632                         *curr = s;
1633                         return 0;
1634                 }
1635         }
1636
1637         printk(KERN_WARNING PFX "Invalid hotmod %s '%s'\n", name, *curr);
1638         return -EINVAL;
1639 }
1640
1641 static int check_hotmod_int_op(const char *curr, const char *option,
1642                                const char *name, int *val)
1643 {
1644         char *n;
1645
1646         if (strcmp(curr, name) == 0) {
1647                 if (!option) {
1648                         printk(KERN_WARNING PFX
1649                                "No option given for '%s'\n",
1650                                curr);
1651                         return -EINVAL;
1652                 }
1653                 *val = simple_strtoul(option, &n, 0);
1654                 if ((*n != '\0') || (*option == '\0')) {
1655                         printk(KERN_WARNING PFX
1656                                "Bad option given for '%s'\n",
1657                                curr);
1658                         return -EINVAL;
1659                 }
1660                 return 1;
1661         }
1662         return 0;
1663 }
1664
1665 static int hotmod_handler(const char *val, struct kernel_param *kp)
1666 {
1667         char *str = kstrdup(val, GFP_KERNEL);
1668         int  rv;
1669         char *next, *curr, *s, *n, *o;
1670         enum hotmod_op op;
1671         enum si_type si_type;
1672         int  addr_space;
1673         unsigned long addr;
1674         int regspacing;
1675         int regsize;
1676         int regshift;
1677         int irq;
1678         int ipmb;
1679         int ival;
1680         int len;
1681         struct smi_info *info;
1682
1683         if (!str)
1684                 return -ENOMEM;
1685
1686         /* Kill any trailing spaces, as we can get a "\n" from echo. */
1687         len = strlen(str);
1688         ival = len - 1;
1689         while ((ival >= 0) && isspace(str[ival])) {
1690                 str[ival] = '\0';
1691                 ival--;
1692         }
1693
1694         for (curr = str; curr; curr = next) {
1695                 regspacing = 1;
1696                 regsize = 1;
1697                 regshift = 0;
1698                 irq = 0;
1699                 ipmb = 0; /* Choose the default if not specified */
1700
1701                 next = strchr(curr, ':');
1702                 if (next) {
1703                         *next = '\0';
1704                         next++;
1705                 }
1706
1707                 rv = parse_str(hotmod_ops, &ival, "operation", &curr);
1708                 if (rv)
1709                         break;
1710                 op = ival;
1711
1712                 rv = parse_str(hotmod_si, &ival, "interface type", &curr);
1713                 if (rv)
1714                         break;
1715                 si_type = ival;
1716
1717                 rv = parse_str(hotmod_as, &addr_space, "address space", &curr);
1718                 if (rv)
1719                         break;
1720
1721                 s = strchr(curr, ',');
1722                 if (s) {
1723                         *s = '\0';
1724                         s++;
1725                 }
1726                 addr = simple_strtoul(curr, &n, 0);
1727                 if ((*n != '\0') || (*curr == '\0')) {
1728                         printk(KERN_WARNING PFX "Invalid hotmod address"
1729                                " '%s'\n", curr);
1730                         break;
1731                 }
1732
1733                 while (s) {
1734                         curr = s;
1735                         s = strchr(curr, ',');
1736                         if (s) {
1737                                 *s = '\0';
1738                                 s++;
1739                         }
1740                         o = strchr(curr, '=');
1741                         if (o) {
1742                                 *o = '\0';
1743                                 o++;
1744                         }
1745                         rv = check_hotmod_int_op(curr, o, "rsp", &regspacing);
1746                         if (rv < 0)
1747                                 goto out;
1748                         else if (rv)
1749                                 continue;
1750                         rv = check_hotmod_int_op(curr, o, "rsi", &regsize);
1751                         if (rv < 0)
1752                                 goto out;
1753                         else if (rv)
1754                                 continue;
1755                         rv = check_hotmod_int_op(curr, o, "rsh", &regshift);
1756                         if (rv < 0)
1757                                 goto out;
1758                         else if (rv)
1759                                 continue;
1760                         rv = check_hotmod_int_op(curr, o, "irq", &irq);
1761                         if (rv < 0)
1762                                 goto out;
1763                         else if (rv)
1764                                 continue;
1765                         rv = check_hotmod_int_op(curr, o, "ipmb", &ipmb);
1766                         if (rv < 0)
1767                                 goto out;
1768                         else if (rv)
1769                                 continue;
1770
1771                         rv = -EINVAL;
1772                         printk(KERN_WARNING PFX
1773                                "Invalid hotmod option '%s'\n",
1774                                curr);
1775                         goto out;
1776                 }
1777
1778                 if (op == HM_ADD) {
1779                         info = kzalloc(sizeof(*info), GFP_KERNEL);
1780                         if (!info) {
1781                                 rv = -ENOMEM;
1782                                 goto out;
1783                         }
1784
1785                         info->addr_source = SI_HOTMOD;
1786                         info->si_type = si_type;
1787                         info->io.addr_data = addr;
1788                         info->io.addr_type = addr_space;
1789                         if (addr_space == IPMI_MEM_ADDR_SPACE)
1790                                 info->io_setup = mem_setup;
1791                         else
1792                                 info->io_setup = port_setup;
1793
1794                         info->io.addr = NULL;
1795                         info->io.regspacing = regspacing;
1796                         if (!info->io.regspacing)
1797                                 info->io.regspacing = DEFAULT_REGSPACING;
1798                         info->io.regsize = regsize;
1799                         if (!info->io.regsize)
1800                                 info->io.regsize = DEFAULT_REGSPACING;
1801                         info->io.regshift = regshift;
1802                         info->irq = irq;
1803                         if (info->irq)
1804                                 info->irq_setup = std_irq_setup;
1805                         info->slave_addr = ipmb;
1806
1807                         if (!add_smi(info))
1808                                 if (try_smi_init(info))
1809                                         cleanup_one_si(info);
1810                 } else {
1811                         /* remove */
1812                         struct smi_info *e, *tmp_e;
1813
1814                         mutex_lock(&smi_infos_lock);
1815                         list_for_each_entry_safe(e, tmp_e, &smi_infos, link) {
1816                                 if (e->io.addr_type != addr_space)
1817                                         continue;
1818                                 if (e->si_type != si_type)
1819                                         continue;
1820                                 if (e->io.addr_data == addr)
1821                                         cleanup_one_si(e);
1822                         }
1823                         mutex_unlock(&smi_infos_lock);
1824                 }
1825         }
1826         rv = len;
1827  out:
1828         kfree(str);
1829         return rv;
1830 }
1831
1832 static __devinit void hardcode_find_bmc(void)
1833 {
1834         int             i;
1835         struct smi_info *info;
1836
1837         for (i = 0; i < SI_MAX_PARMS; i++) {
1838                 if (!ports[i] && !addrs[i])
1839                         continue;
1840
1841                 info = kzalloc(sizeof(*info), GFP_KERNEL);
1842                 if (!info)
1843                         return;
1844
1845                 info->addr_source = SI_HARDCODED;
1846                 printk(KERN_INFO PFX "probing via hardcoded address\n");
1847
1848                 if (!si_type[i] || strcmp(si_type[i], "kcs") == 0) {
1849                         info->si_type = SI_KCS;
1850                 } else if (strcmp(si_type[i], "smic") == 0) {
1851                         info->si_type = SI_SMIC;
1852                 } else if (strcmp(si_type[i], "bt") == 0) {
1853                         info->si_type = SI_BT;
1854                 } else {
1855                         printk(KERN_WARNING PFX "Interface type specified "
1856                                "for interface %d, was invalid: %s\n",
1857                                i, si_type[i]);
1858                         kfree(info);
1859                         continue;
1860                 }
1861
1862                 if (ports[i]) {
1863                         /* An I/O port */
1864                         info->io_setup = port_setup;
1865                         info->io.addr_data = ports[i];
1866                         info->io.addr_type = IPMI_IO_ADDR_SPACE;
1867                 } else if (addrs[i]) {
1868                         /* A memory port */
1869                         info->io_setup = mem_setup;
1870                         info->io.addr_data = addrs[i];
1871                         info->io.addr_type = IPMI_MEM_ADDR_SPACE;
1872                 } else {
1873                         printk(KERN_WARNING PFX "Interface type specified "
1874                                "for interface %d, but port and address were "
1875                                "not set or set to zero.\n", i);
1876                         kfree(info);
1877                         continue;
1878                 }
1879
1880                 info->io.addr = NULL;
1881                 info->io.regspacing = regspacings[i];
1882                 if (!info->io.regspacing)
1883                         info->io.regspacing = DEFAULT_REGSPACING;
1884                 info->io.regsize = regsizes[i];
1885                 if (!info->io.regsize)
1886                         info->io.regsize = DEFAULT_REGSPACING;
1887                 info->io.regshift = regshifts[i];
1888                 info->irq = irqs[i];
1889                 if (info->irq)
1890                         info->irq_setup = std_irq_setup;
1891                 info->slave_addr = slave_addrs[i];
1892
1893                 if (!add_smi(info))
1894                         if (try_smi_init(info))
1895                                 cleanup_one_si(info);
1896         }
1897 }
1898
1899 #ifdef CONFIG_ACPI
1900
1901 #include <linux/acpi.h>
1902
1903 /*
1904  * Once we get an ACPI failure, we don't try any more, because we go
1905  * through the tables sequentially.  Once we don't find a table, there
1906  * are no more.
1907  */
1908 static int acpi_failure;
1909
1910 /* For GPE-type interrupts. */
1911 static u32 ipmi_acpi_gpe(void *context)
1912 {
1913         struct smi_info *smi_info = context;
1914         unsigned long   flags;
1915 #ifdef DEBUG_TIMING
1916         struct timeval t;
1917 #endif
1918
1919         spin_lock_irqsave(&(smi_info->si_lock), flags);
1920
1921         smi_inc_stat(smi_info, interrupts);
1922
1923 #ifdef DEBUG_TIMING
1924         do_gettimeofday(&t);
1925         printk("**ACPI_GPE: %d.%9.9d\n", t.tv_sec, t.tv_usec);
1926 #endif
1927         smi_event_handler(smi_info, 0);
1928         spin_unlock_irqrestore(&(smi_info->si_lock), flags);
1929
1930         return ACPI_INTERRUPT_HANDLED;
1931 }
1932
1933 static void acpi_gpe_irq_cleanup(struct smi_info *info)
1934 {
1935         if (!info->irq)
1936                 return;
1937
1938         acpi_remove_gpe_handler(NULL, info->irq, &ipmi_acpi_gpe);
1939 }
1940
1941 static int acpi_gpe_irq_setup(struct smi_info *info)
1942 {
1943         acpi_status status;
1944
1945         if (!info->irq)
1946                 return 0;
1947
1948         /* FIXME - is level triggered right? */
1949         status = acpi_install_gpe_handler(NULL,
1950                                           info->irq,
1951                                           ACPI_GPE_LEVEL_TRIGGERED,
1952                                           &ipmi_acpi_gpe,
1953                                           info);
1954         if (status != AE_OK) {
1955                 dev_warn(info->dev, "%s unable to claim ACPI GPE %d,"
1956                          " running polled\n", DEVICE_NAME, info->irq);
1957                 info->irq = 0;
1958                 return -EINVAL;
1959         } else {
1960                 info->irq_cleanup = acpi_gpe_irq_cleanup;
1961                 dev_info(info->dev, "Using ACPI GPE %d\n", info->irq);
1962                 return 0;
1963         }
1964 }
1965
1966 /*
1967  * Defined at
1968  * http://h21007.www2.hp.com/dspp/files/unprotected/devresource/
1969  * Docs/TechPapers/IA64/hpspmi.pdf
1970  */
1971 struct SPMITable {
1972         s8      Signature[4];
1973         u32     Length;
1974         u8      Revision;
1975         u8      Checksum;
1976         s8      OEMID[6];
1977         s8      OEMTableID[8];
1978         s8      OEMRevision[4];
1979         s8      CreatorID[4];
1980         s8      CreatorRevision[4];
1981         u8      InterfaceType;
1982         u8      IPMIlegacy;
1983         s16     SpecificationRevision;
1984
1985         /*
1986          * Bit 0 - SCI interrupt supported
1987          * Bit 1 - I/O APIC/SAPIC
1988          */
1989         u8      InterruptType;
1990
1991         /*
1992          * If bit 0 of InterruptType is set, then this is the SCI
1993          * interrupt in the GPEx_STS register.
1994          */
1995         u8      GPE;
1996
1997         s16     Reserved;
1998
1999         /*
2000          * If bit 1 of InterruptType is set, then this is the I/O
2001          * APIC/SAPIC interrupt.
2002          */
2003         u32     GlobalSystemInterrupt;
2004
2005         /* The actual register address. */
2006         struct acpi_generic_address addr;
2007
2008         u8      UID[4];
2009
2010         s8      spmi_id[1]; /* A '\0' terminated array starts here. */
2011 };
2012
2013 static __devinit int try_init_spmi(struct SPMITable *spmi)
2014 {
2015         struct smi_info  *info;
2016         u8               addr_space;
2017
2018         if (spmi->IPMIlegacy != 1) {
2019                 printk(KERN_INFO PFX "Bad SPMI legacy %d\n", spmi->IPMIlegacy);
2020                 return -ENODEV;
2021         }
2022
2023         if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY)
2024                 addr_space = IPMI_MEM_ADDR_SPACE;
2025         else
2026                 addr_space = IPMI_IO_ADDR_SPACE;
2027
2028         info = kzalloc(sizeof(*info), GFP_KERNEL);
2029         if (!info) {
2030                 printk(KERN_ERR PFX "Could not allocate SI data (3)\n");
2031                 return -ENOMEM;
2032         }
2033
2034         info->addr_source = SI_SPMI;
2035         printk(KERN_INFO PFX "probing via SPMI\n");
2036
2037         /* Figure out the interface type. */
2038         switch (spmi->InterfaceType) {
2039         case 1: /* KCS */
2040                 info->si_type = SI_KCS;
2041                 break;
2042         case 2: /* SMIC */
2043                 info->si_type = SI_SMIC;
2044                 break;
2045         case 3: /* BT */
2046                 info->si_type = SI_BT;
2047                 break;
2048         default:
2049                 printk(KERN_INFO PFX "Unknown ACPI/SPMI SI type %d\n",
2050                        spmi->InterfaceType);
2051                 kfree(info);
2052                 return -EIO;
2053         }
2054
2055         if (spmi->InterruptType & 1) {
2056                 /* We've got a GPE interrupt. */
2057                 info->irq = spmi->GPE;
2058                 info->irq_setup = acpi_gpe_irq_setup;
2059         } else if (spmi->InterruptType & 2) {
2060                 /* We've got an APIC/SAPIC interrupt. */
2061                 info->irq = spmi->GlobalSystemInterrupt;
2062                 info->irq_setup = std_irq_setup;
2063         } else {
2064                 /* Use the default interrupt setting. */
2065                 info->irq = 0;
2066                 info->irq_setup = NULL;
2067         }
2068
2069         if (spmi->addr.bit_width) {
2070                 /* A (hopefully) properly formed register bit width. */
2071                 info->io.regspacing = spmi->addr.bit_width / 8;
2072         } else {
2073                 info->io.regspacing = DEFAULT_REGSPACING;
2074         }
2075         info->io.regsize = info->io.regspacing;
2076         info->io.regshift = spmi->addr.bit_offset;
2077
2078         if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
2079                 info->io_setup = mem_setup;
2080                 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2081         } else if (spmi->addr.space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
2082                 info->io_setup = port_setup;
2083                 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2084         } else {
2085                 kfree(info);
2086                 printk(KERN_WARNING PFX "Unknown ACPI I/O Address type\n");
2087                 return -EIO;
2088         }
2089         info->io.addr_data = spmi->addr.address;
2090
2091         add_smi(info);
2092
2093         return 0;
2094 }
2095
2096 static __devinit void spmi_find_bmc(void)
2097 {
2098         acpi_status      status;
2099         struct SPMITable *spmi;
2100         int              i;
2101
2102         if (acpi_disabled)
2103                 return;
2104
2105         if (acpi_failure)
2106                 return;
2107
2108         for (i = 0; ; i++) {
2109                 status = acpi_get_table(ACPI_SIG_SPMI, i+1,
2110                                         (struct acpi_table_header **)&spmi);
2111                 if (status != AE_OK)
2112                         return;
2113
2114                 try_init_spmi(spmi);
2115         }
2116 }
2117
2118 static int __devinit ipmi_pnp_probe(struct pnp_dev *dev,
2119                                     const struct pnp_device_id *dev_id)
2120 {
2121         struct acpi_device *acpi_dev;
2122         struct smi_info *info;
2123         struct resource *res;
2124         acpi_handle handle;
2125         acpi_status status;
2126         unsigned long long tmp;
2127
2128         acpi_dev = pnp_acpi_device(dev);
2129         if (!acpi_dev)
2130                 return -ENODEV;
2131
2132         info = kzalloc(sizeof(*info), GFP_KERNEL);
2133         if (!info)
2134                 return -ENOMEM;
2135
2136         info->addr_source = SI_ACPI;
2137         printk(KERN_INFO PFX "probing via ACPI\n");
2138
2139         handle = acpi_dev->handle;
2140
2141         /* _IFT tells us the interface type: KCS, BT, etc */
2142         status = acpi_evaluate_integer(handle, "_IFT", NULL, &tmp);
2143         if (ACPI_FAILURE(status))
2144                 goto err_free;
2145
2146         switch (tmp) {
2147         case 1:
2148                 info->si_type = SI_KCS;
2149                 break;
2150         case 2:
2151                 info->si_type = SI_SMIC;
2152                 break;
2153         case 3:
2154                 info->si_type = SI_BT;
2155                 break;
2156         default:
2157                 dev_info(&dev->dev, "unknown IPMI type %lld\n", tmp);
2158                 goto err_free;
2159         }
2160
2161         res = pnp_get_resource(dev, IORESOURCE_IO, 0);
2162         if (res) {
2163                 info->io_setup = port_setup;
2164                 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2165         } else {
2166                 res = pnp_get_resource(dev, IORESOURCE_MEM, 0);
2167                 if (res) {
2168                         info->io_setup = mem_setup;
2169                         info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2170                 }
2171         }
2172         if (!res) {
2173                 dev_err(&dev->dev, "no I/O or memory address\n");
2174                 goto err_free;
2175         }
2176         info->io.addr_data = res->start;
2177
2178         info->io.regspacing = DEFAULT_REGSPACING;
2179         info->io.regsize = DEFAULT_REGSPACING;
2180         info->io.regshift = 0;
2181
2182         /* If _GPE exists, use it; otherwise use standard interrupts */
2183         status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
2184         if (ACPI_SUCCESS(status)) {
2185                 info->irq = tmp;
2186                 info->irq_setup = acpi_gpe_irq_setup;
2187         } else if (pnp_irq_valid(dev, 0)) {
2188                 info->irq = pnp_irq(dev, 0);
2189                 info->irq_setup = std_irq_setup;
2190         }
2191
2192         info->dev = &dev->dev;
2193         pnp_set_drvdata(dev, info);
2194
2195         dev_info(info->dev, "%pR regsize %d spacing %d irq %d\n",
2196                  res, info->io.regsize, info->io.regspacing,
2197                  info->irq);
2198
2199         return add_smi(info);
2200
2201 err_free:
2202         kfree(info);
2203         return -EINVAL;
2204 }
2205
2206 static void __devexit ipmi_pnp_remove(struct pnp_dev *dev)
2207 {
2208         struct smi_info *info = pnp_get_drvdata(dev);
2209
2210         cleanup_one_si(info);
2211 }
2212
2213 static const struct pnp_device_id pnp_dev_table[] = {
2214         {"IPI0001", 0},
2215         {"", 0},
2216 };
2217
2218 static struct pnp_driver ipmi_pnp_driver = {
2219         .name           = DEVICE_NAME,
2220         .probe          = ipmi_pnp_probe,
2221         .remove         = __devexit_p(ipmi_pnp_remove),
2222         .id_table       = pnp_dev_table,
2223 };
2224 #endif
2225
2226 #ifdef CONFIG_DMI
2227 struct dmi_ipmi_data {
2228         u8              type;
2229         u8              addr_space;
2230         unsigned long   base_addr;
2231         u8              irq;
2232         u8              offset;
2233         u8              slave_addr;
2234 };
2235
2236 static int __devinit decode_dmi(const struct dmi_header *dm,
2237                                 struct dmi_ipmi_data *dmi)
2238 {
2239         const u8        *data = (const u8 *)dm;
2240         unsigned long   base_addr;
2241         u8              reg_spacing;
2242         u8              len = dm->length;
2243
2244         dmi->type = data[4];
2245
2246         memcpy(&base_addr, data+8, sizeof(unsigned long));
2247         if (len >= 0x11) {
2248                 if (base_addr & 1) {
2249                         /* I/O */
2250                         base_addr &= 0xFFFE;
2251                         dmi->addr_space = IPMI_IO_ADDR_SPACE;
2252                 } else
2253                         /* Memory */
2254                         dmi->addr_space = IPMI_MEM_ADDR_SPACE;
2255
2256                 /* If bit 4 of byte 0x10 is set, then the lsb for the address
2257                    is odd. */
2258                 dmi->base_addr = base_addr | ((data[0x10] & 0x10) >> 4);
2259
2260                 dmi->irq = data[0x11];
2261
2262                 /* The top two bits of byte 0x10 hold the register spacing. */
2263                 reg_spacing = (data[0x10] & 0xC0) >> 6;
2264                 switch (reg_spacing) {
2265                 case 0x00: /* Byte boundaries */
2266                     dmi->offset = 1;
2267                     break;
2268                 case 0x01: /* 32-bit boundaries */
2269                     dmi->offset = 4;
2270                     break;
2271                 case 0x02: /* 16-byte boundaries */
2272                     dmi->offset = 16;
2273                     break;
2274                 default:
2275                     /* Some other interface, just ignore it. */
2276                     return -EIO;
2277                 }
2278         } else {
2279                 /* Old DMI spec. */
2280                 /*
2281                  * Note that technically, the lower bit of the base
2282                  * address should be 1 if the address is I/O and 0 if
2283                  * the address is in memory.  So many systems get that
2284                  * wrong (and all that I have seen are I/O) so we just
2285                  * ignore that bit and assume I/O.  Systems that use
2286                  * memory should use the newer spec, anyway.
2287                  */
2288                 dmi->base_addr = base_addr & 0xfffe;
2289                 dmi->addr_space = IPMI_IO_ADDR_SPACE;
2290                 dmi->offset = 1;
2291         }
2292
2293         dmi->slave_addr = data[6];
2294
2295         return 0;
2296 }
2297
2298 static __devinit void try_init_dmi(struct dmi_ipmi_data *ipmi_data)
2299 {
2300         struct smi_info *info;
2301
2302         info = kzalloc(sizeof(*info), GFP_KERNEL);
2303         if (!info) {
2304                 printk(KERN_ERR PFX "Could not allocate SI data\n");
2305                 return;
2306         }
2307
2308         info->addr_source = SI_SMBIOS;
2309         printk(KERN_INFO PFX "probing via SMBIOS\n");
2310
2311         switch (ipmi_data->type) {
2312         case 0x01: /* KCS */
2313                 info->si_type = SI_KCS;
2314                 break;
2315         case 0x02: /* SMIC */
2316                 info->si_type = SI_SMIC;
2317                 break;
2318         case 0x03: /* BT */
2319                 info->si_type = SI_BT;
2320                 break;
2321         default:
2322                 kfree(info);
2323                 return;
2324         }
2325
2326         switch (ipmi_data->addr_space) {
2327         case IPMI_MEM_ADDR_SPACE:
2328                 info->io_setup = mem_setup;
2329                 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2330                 break;
2331
2332         case IPMI_IO_ADDR_SPACE:
2333                 info->io_setup = port_setup;
2334                 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2335                 break;
2336
2337         default:
2338                 kfree(info);
2339                 printk(KERN_WARNING PFX "Unknown SMBIOS I/O Address type: %d\n",
2340                        ipmi_data->addr_space);
2341                 return;
2342         }
2343         info->io.addr_data = ipmi_data->base_addr;
2344
2345         info->io.regspacing = ipmi_data->offset;
2346         if (!info->io.regspacing)
2347                 info->io.regspacing = DEFAULT_REGSPACING;
2348         info->io.regsize = DEFAULT_REGSPACING;
2349         info->io.regshift = 0;
2350
2351         info->slave_addr = ipmi_data->slave_addr;
2352
2353         info->irq = ipmi_data->irq;
2354         if (info->irq)
2355                 info->irq_setup = std_irq_setup;
2356
2357         add_smi(info);
2358 }
2359
2360 static void __devinit dmi_find_bmc(void)
2361 {
2362         const struct dmi_device *dev = NULL;
2363         struct dmi_ipmi_data data;
2364         int                  rv;
2365
2366         while ((dev = dmi_find_device(DMI_DEV_TYPE_IPMI, NULL, dev))) {
2367                 memset(&data, 0, sizeof(data));
2368                 rv = decode_dmi((const struct dmi_header *) dev->device_data,
2369                                 &data);
2370                 if (!rv)
2371                         try_init_dmi(&data);
2372         }
2373 }
2374 #endif /* CONFIG_DMI */
2375
2376 #ifdef CONFIG_PCI
2377
2378 #define PCI_ERMC_CLASSCODE              0x0C0700
2379 #define PCI_ERMC_CLASSCODE_MASK         0xffffff00
2380 #define PCI_ERMC_CLASSCODE_TYPE_MASK    0xff
2381 #define PCI_ERMC_CLASSCODE_TYPE_SMIC    0x00
2382 #define PCI_ERMC_CLASSCODE_TYPE_KCS     0x01
2383 #define PCI_ERMC_CLASSCODE_TYPE_BT      0x02
2384
2385 #define PCI_HP_VENDOR_ID    0x103C
2386 #define PCI_MMC_DEVICE_ID   0x121A
2387 #define PCI_MMC_ADDR_CW     0x10
2388
2389 static void ipmi_pci_cleanup(struct smi_info *info)
2390 {
2391         struct pci_dev *pdev = info->addr_source_data;
2392
2393         pci_disable_device(pdev);
2394 }
2395
2396 static int __devinit ipmi_pci_probe(struct pci_dev *pdev,
2397                                     const struct pci_device_id *ent)
2398 {
2399         int rv;
2400         int class_type = pdev->class & PCI_ERMC_CLASSCODE_TYPE_MASK;
2401         struct smi_info *info;
2402
2403         info = kzalloc(sizeof(*info), GFP_KERNEL);
2404         if (!info)
2405                 return -ENOMEM;
2406
2407         info->addr_source = SI_PCI;
2408         dev_info(&pdev->dev, "probing via PCI");
2409
2410         switch (class_type) {
2411         case PCI_ERMC_CLASSCODE_TYPE_SMIC:
2412                 info->si_type = SI_SMIC;
2413                 break;
2414
2415         case PCI_ERMC_CLASSCODE_TYPE_KCS:
2416                 info->si_type = SI_KCS;
2417                 break;
2418
2419         case PCI_ERMC_CLASSCODE_TYPE_BT:
2420                 info->si_type = SI_BT;
2421                 break;
2422
2423         default:
2424                 kfree(info);
2425                 dev_info(&pdev->dev, "Unknown IPMI type: %d\n", class_type);
2426                 return -ENOMEM;
2427         }
2428
2429         rv = pci_enable_device(pdev);
2430         if (rv) {
2431                 dev_err(&pdev->dev, "couldn't enable PCI device\n");
2432                 kfree(info);
2433                 return rv;
2434         }
2435
2436         info->addr_source_cleanup = ipmi_pci_cleanup;
2437         info->addr_source_data = pdev;
2438
2439         if (pci_resource_flags(pdev, 0) & IORESOURCE_IO) {
2440                 info->io_setup = port_setup;
2441                 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2442         } else {
2443                 info->io_setup = mem_setup;
2444                 info->io.addr_type = IPMI_MEM_ADDR_SPACE;
2445         }
2446         info->io.addr_data = pci_resource_start(pdev, 0);
2447
2448         info->io.regspacing = DEFAULT_REGSPACING;
2449         info->io.regsize = DEFAULT_REGSPACING;
2450         info->io.regshift = 0;
2451
2452         info->irq = pdev->irq;
2453         if (info->irq)
2454                 info->irq_setup = std_irq_setup;
2455
2456         info->dev = &pdev->dev;
2457         pci_set_drvdata(pdev, info);
2458
2459         dev_info(&pdev->dev, "%pR regsize %d spacing %d irq %d\n",
2460                 &pdev->resource[0], info->io.regsize, info->io.regspacing,
2461                 info->irq);
2462
2463         return add_smi(info);
2464 }
2465
2466 static void __devexit ipmi_pci_remove(struct pci_dev *pdev)
2467 {
2468         struct smi_info *info = pci_get_drvdata(pdev);
2469         cleanup_one_si(info);
2470 }
2471
2472 #ifdef CONFIG_PM
2473 static int ipmi_pci_suspend(struct pci_dev *pdev, pm_message_t state)
2474 {
2475         return 0;
2476 }
2477
2478 static int ipmi_pci_resume(struct pci_dev *pdev)
2479 {
2480         return 0;
2481 }
2482 #endif
2483
2484 static struct pci_device_id ipmi_pci_devices[] = {
2485         { PCI_DEVICE(PCI_HP_VENDOR_ID, PCI_MMC_DEVICE_ID) },
2486         { PCI_DEVICE_CLASS(PCI_ERMC_CLASSCODE, PCI_ERMC_CLASSCODE_MASK) },
2487         { 0, }
2488 };
2489 MODULE_DEVICE_TABLE(pci, ipmi_pci_devices);
2490
2491 static struct pci_driver ipmi_pci_driver = {
2492         .name =         DEVICE_NAME,
2493         .id_table =     ipmi_pci_devices,
2494         .probe =        ipmi_pci_probe,
2495         .remove =       __devexit_p(ipmi_pci_remove),
2496 #ifdef CONFIG_PM
2497         .suspend =      ipmi_pci_suspend,
2498         .resume =       ipmi_pci_resume,
2499 #endif
2500 };
2501 #endif /* CONFIG_PCI */
2502
2503
2504 #ifdef CONFIG_PPC_OF
2505 static int __devinit ipmi_of_probe(struct of_device *dev,
2506                          const struct of_device_id *match)
2507 {
2508         struct smi_info *info;
2509         struct resource resource;
2510         const int *regsize, *regspacing, *regshift;
2511         struct device_node *np = dev->dev.of_node;
2512         int ret;
2513         int proplen;
2514
2515         dev_info(&dev->dev, "probing via device tree\n");
2516
2517         ret = of_address_to_resource(np, 0, &resource);
2518         if (ret) {
2519                 dev_warn(&dev->dev, PFX "invalid address from OF\n");
2520                 return ret;
2521         }
2522
2523         regsize = of_get_property(np, "reg-size", &proplen);
2524         if (regsize && proplen != 4) {
2525                 dev_warn(&dev->dev, PFX "invalid regsize from OF\n");
2526                 return -EINVAL;
2527         }
2528
2529         regspacing = of_get_property(np, "reg-spacing", &proplen);
2530         if (regspacing && proplen != 4) {
2531                 dev_warn(&dev->dev, PFX "invalid regspacing from OF\n");
2532                 return -EINVAL;
2533         }
2534
2535         regshift = of_get_property(np, "reg-shift", &proplen);
2536         if (regshift && proplen != 4) {
2537                 dev_warn(&dev->dev, PFX "invalid regshift from OF\n");
2538                 return -EINVAL;
2539         }
2540
2541         info = kzalloc(sizeof(*info), GFP_KERNEL);
2542
2543         if (!info) {
2544                 dev_err(&dev->dev,
2545                         "could not allocate memory for OF probe\n");
2546                 return -ENOMEM;
2547         }
2548
2549         info->si_type           = (enum si_type) match->data;
2550         info->addr_source       = SI_DEVICETREE;
2551         info->irq_setup         = std_irq_setup;
2552
2553         if (resource.flags & IORESOURCE_IO) {
2554                 info->io_setup          = port_setup;
2555                 info->io.addr_type      = IPMI_IO_ADDR_SPACE;
2556         } else {
2557                 info->io_setup          = mem_setup;
2558                 info->io.addr_type      = IPMI_MEM_ADDR_SPACE;
2559         }
2560
2561         info->io.addr_data      = resource.start;
2562
2563         info->io.regsize        = regsize ? *regsize : DEFAULT_REGSIZE;
2564         info->io.regspacing     = regspacing ? *regspacing : DEFAULT_REGSPACING;
2565         info->io.regshift       = regshift ? *regshift : 0;
2566
2567         info->irq               = irq_of_parse_and_map(dev->dev.of_node, 0);
2568         info->dev               = &dev->dev;
2569
2570         dev_dbg(&dev->dev, "addr 0x%lx regsize %d spacing %d irq %d\n",
2571                 info->io.addr_data, info->io.regsize, info->io.regspacing,
2572                 info->irq);
2573
2574         dev_set_drvdata(&dev->dev, info);
2575
2576         return add_smi(info);
2577 }
2578
2579 static int __devexit ipmi_of_remove(struct of_device *dev)
2580 {
2581         cleanup_one_si(dev_get_drvdata(&dev->dev));
2582         return 0;
2583 }
2584
2585 static struct of_device_id ipmi_match[] =
2586 {
2587         { .type = "ipmi", .compatible = "ipmi-kcs",
2588           .data = (void *)(unsigned long) SI_KCS },
2589         { .type = "ipmi", .compatible = "ipmi-smic",
2590           .data = (void *)(unsigned long) SI_SMIC },
2591         { .type = "ipmi", .compatible = "ipmi-bt",
2592           .data = (void *)(unsigned long) SI_BT },
2593         {},
2594 };
2595
2596 static struct of_platform_driver ipmi_of_platform_driver = {
2597         .driver = {
2598                 .name = "ipmi",
2599                 .owner = THIS_MODULE,
2600                 .of_match_table = ipmi_match,
2601         },
2602         .probe          = ipmi_of_probe,
2603         .remove         = __devexit_p(ipmi_of_remove),
2604 };
2605 #endif /* CONFIG_PPC_OF */
2606
2607 static int wait_for_msg_done(struct smi_info *smi_info)
2608 {
2609         enum si_sm_result     smi_result;
2610
2611         smi_result = smi_info->handlers->event(smi_info->si_sm, 0);
2612         for (;;) {
2613                 if (smi_result == SI_SM_CALL_WITH_DELAY ||
2614                     smi_result == SI_SM_CALL_WITH_TICK_DELAY) {
2615                         schedule_timeout_uninterruptible(1);
2616                         smi_result = smi_info->handlers->event(
2617                                 smi_info->si_sm, 100);
2618                 } else if (smi_result == SI_SM_CALL_WITHOUT_DELAY) {
2619                         smi_result = smi_info->handlers->event(
2620                                 smi_info->si_sm, 0);
2621                 } else
2622                         break;
2623         }
2624         if (smi_result == SI_SM_HOSED)
2625                 /*
2626                  * We couldn't get the state machine to run, so whatever's at
2627                  * the port is probably not an IPMI SMI interface.
2628                  */
2629                 return -ENODEV;
2630
2631         return 0;
2632 }
2633
2634 static int try_get_dev_id(struct smi_info *smi_info)
2635 {
2636         unsigned char         msg[2];
2637         unsigned char         *resp;
2638         unsigned long         resp_len;
2639         int                   rv = 0;
2640
2641         resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
2642         if (!resp)
2643                 return -ENOMEM;
2644
2645         /*
2646          * Do a Get Device ID command, since it comes back with some
2647          * useful info.
2648          */
2649         msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2650         msg[1] = IPMI_GET_DEVICE_ID_CMD;
2651         smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
2652
2653         rv = wait_for_msg_done(smi_info);
2654         if (rv)
2655                 goto out;
2656
2657         resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2658                                                   resp, IPMI_MAX_MSG_LENGTH);
2659
2660         /* Check and record info from the get device id, in case we need it. */
2661         rv = ipmi_demangle_device_id(resp, resp_len, &smi_info->device_id);
2662
2663  out:
2664         kfree(resp);
2665         return rv;
2666 }
2667
2668 static int try_enable_event_buffer(struct smi_info *smi_info)
2669 {
2670         unsigned char         msg[3];
2671         unsigned char         *resp;
2672         unsigned long         resp_len;
2673         int                   rv = 0;
2674
2675         resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
2676         if (!resp)
2677                 return -ENOMEM;
2678
2679         msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2680         msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
2681         smi_info->handlers->start_transaction(smi_info->si_sm, msg, 2);
2682
2683         rv = wait_for_msg_done(smi_info);
2684         if (rv) {
2685                 printk(KERN_WARNING PFX "Error getting response from get"
2686                        " global enables command, the event buffer is not"
2687                        " enabled.\n");
2688                 goto out;
2689         }
2690
2691         resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2692                                                   resp, IPMI_MAX_MSG_LENGTH);
2693
2694         if (resp_len < 4 ||
2695                         resp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2 ||
2696                         resp[1] != IPMI_GET_BMC_GLOBAL_ENABLES_CMD   ||
2697                         resp[2] != 0) {
2698                 printk(KERN_WARNING PFX "Invalid return from get global"
2699                        " enables command, cannot enable the event buffer.\n");
2700                 rv = -EINVAL;
2701                 goto out;
2702         }
2703
2704         if (resp[3] & IPMI_BMC_EVT_MSG_BUFF)
2705                 /* buffer is already enabled, nothing to do. */
2706                 goto out;
2707
2708         msg[0] = IPMI_NETFN_APP_REQUEST << 2;
2709         msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
2710         msg[2] = resp[3] | IPMI_BMC_EVT_MSG_BUFF;
2711         smi_info->handlers->start_transaction(smi_info->si_sm, msg, 3);
2712
2713         rv = wait_for_msg_done(smi_info);
2714         if (rv) {
2715                 printk(KERN_WARNING PFX "Error getting response from set"
2716                        " global, enables command, the event buffer is not"
2717                        " enabled.\n");
2718                 goto out;
2719         }
2720
2721         resp_len = smi_info->handlers->get_result(smi_info->si_sm,
2722                                                   resp, IPMI_MAX_MSG_LENGTH);
2723
2724         if (resp_len < 3 ||
2725                         resp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2 ||
2726                         resp[1] != IPMI_SET_BMC_GLOBAL_ENABLES_CMD) {
2727                 printk(KERN_WARNING PFX "Invalid return from get global,"
2728                        "enables command, not enable the event buffer.\n");
2729                 rv = -EINVAL;
2730                 goto out;
2731         }
2732
2733         if (resp[2] != 0)
2734                 /*
2735                  * An error when setting the event buffer bit means
2736                  * that the event buffer is not supported.
2737                  */
2738                 rv = -ENOENT;
2739  out:
2740         kfree(resp);
2741         return rv;
2742 }
2743
2744 static int type_file_read_proc(char *page, char **start, off_t off,
2745                                int count, int *eof, void *data)
2746 {
2747         struct smi_info *smi = data;
2748
2749         return sprintf(page, "%s\n", si_to_str[smi->si_type]);
2750 }
2751
2752 static int stat_file_read_proc(char *page, char **start, off_t off,
2753                                int count, int *eof, void *data)
2754 {
2755         char            *out = (char *) page;
2756         struct smi_info *smi = data;
2757
2758         out += sprintf(out, "interrupts_enabled:    %d\n",
2759                        smi->irq && !smi->interrupt_disabled);
2760         out += sprintf(out, "short_timeouts:        %u\n",
2761                        smi_get_stat(smi, short_timeouts));
2762         out += sprintf(out, "long_timeouts:         %u\n",
2763                        smi_get_stat(smi, long_timeouts));
2764         out += sprintf(out, "idles:                 %u\n",
2765                        smi_get_stat(smi, idles));
2766         out += sprintf(out, "interrupts:            %u\n",
2767                        smi_get_stat(smi, interrupts));
2768         out += sprintf(out, "attentions:            %u\n",
2769                        smi_get_stat(smi, attentions));
2770         out += sprintf(out, "flag_fetches:          %u\n",
2771                        smi_get_stat(smi, flag_fetches));
2772         out += sprintf(out, "hosed_count:           %u\n",
2773                        smi_get_stat(smi, hosed_count));
2774         out += sprintf(out, "complete_transactions: %u\n",
2775                        smi_get_stat(smi, complete_transactions));
2776         out += sprintf(out, "events:                %u\n",
2777                        smi_get_stat(smi, events));
2778         out += sprintf(out, "watchdog_pretimeouts:  %u\n",
2779                        smi_get_stat(smi, watchdog_pretimeouts));
2780         out += sprintf(out, "incoming_messages:     %u\n",
2781                        smi_get_stat(smi, incoming_messages));
2782
2783         return out - page;
2784 }
2785
2786 static int param_read_proc(char *page, char **start, off_t off,
2787                            int count, int *eof, void *data)
2788 {
2789         struct smi_info *smi = data;
2790
2791         return sprintf(page,
2792                        "%s,%s,0x%lx,rsp=%d,rsi=%d,rsh=%d,irq=%d,ipmb=%d\n",
2793                        si_to_str[smi->si_type],
2794                        addr_space_to_str[smi->io.addr_type],
2795                        smi->io.addr_data,
2796                        smi->io.regspacing,
2797                        smi->io.regsize,
2798                        smi->io.regshift,
2799                        smi->irq,
2800                        smi->slave_addr);
2801 }
2802
2803 /*
2804  * oem_data_avail_to_receive_msg_avail
2805  * @info - smi_info structure with msg_flags set
2806  *
2807  * Converts flags from OEM_DATA_AVAIL to RECEIVE_MSG_AVAIL
2808  * Returns 1 indicating need to re-run handle_flags().
2809  */
2810 static int oem_data_avail_to_receive_msg_avail(struct smi_info *smi_info)
2811 {
2812         smi_info->msg_flags = ((smi_info->msg_flags & ~OEM_DATA_AVAIL) |
2813                                RECEIVE_MSG_AVAIL);
2814         return 1;
2815 }
2816
2817 /*
2818  * setup_dell_poweredge_oem_data_handler
2819  * @info - smi_info.device_id must be populated
2820  *
2821  * Systems that match, but have firmware version < 1.40 may assert
2822  * OEM0_DATA_AVAIL on their own, without being told via Set Flags that
2823  * it's safe to do so.  Such systems will de-assert OEM1_DATA_AVAIL
2824  * upon receipt of IPMI_GET_MSG_CMD, so we should treat these flags
2825  * as RECEIVE_MSG_AVAIL instead.
2826  *
2827  * As Dell has no plans to release IPMI 1.5 firmware that *ever*
2828  * assert the OEM[012] bits, and if it did, the driver would have to
2829  * change to handle that properly, we don't actually check for the
2830  * firmware version.
2831  * Device ID = 0x20                BMC on PowerEdge 8G servers
2832  * Device Revision = 0x80
2833  * Firmware Revision1 = 0x01       BMC version 1.40
2834  * Firmware Revision2 = 0x40       BCD encoded
2835  * IPMI Version = 0x51             IPMI 1.5
2836  * Manufacturer ID = A2 02 00      Dell IANA
2837  *
2838  * Additionally, PowerEdge systems with IPMI < 1.5 may also assert
2839  * OEM0_DATA_AVAIL and needs to be treated as RECEIVE_MSG_AVAIL.
2840  *
2841  */
2842 #define DELL_POWEREDGE_8G_BMC_DEVICE_ID  0x20
2843 #define DELL_POWEREDGE_8G_BMC_DEVICE_REV 0x80
2844 #define DELL_POWEREDGE_8G_BMC_IPMI_VERSION 0x51
2845 #define DELL_IANA_MFR_ID 0x0002a2
2846 static void setup_dell_poweredge_oem_data_handler(struct smi_info *smi_info)
2847 {
2848         struct ipmi_device_id *id = &smi_info->device_id;
2849         if (id->manufacturer_id == DELL_IANA_MFR_ID) {
2850                 if (id->device_id       == DELL_POWEREDGE_8G_BMC_DEVICE_ID  &&
2851                     id->device_revision == DELL_POWEREDGE_8G_BMC_DEVICE_REV &&
2852                     id->ipmi_version   == DELL_POWEREDGE_8G_BMC_IPMI_VERSION) {
2853                         smi_info->oem_data_avail_handler =
2854                                 oem_data_avail_to_receive_msg_avail;
2855                 } else if (ipmi_version_major(id) < 1 ||
2856                            (ipmi_version_major(id) == 1 &&
2857                             ipmi_version_minor(id) < 5)) {
2858                         smi_info->oem_data_avail_handler =
2859                                 oem_data_avail_to_receive_msg_avail;
2860                 }
2861         }
2862 }
2863
2864 #define CANNOT_RETURN_REQUESTED_LENGTH 0xCA
2865 static void return_hosed_msg_badsize(struct smi_info *smi_info)
2866 {
2867         struct ipmi_smi_msg *msg = smi_info->curr_msg;
2868
2869         /* Make it a reponse */
2870         msg->rsp[0] = msg->data[0] | 4;
2871         msg->rsp[1] = msg->data[1];
2872         msg->rsp[2] = CANNOT_RETURN_REQUESTED_LENGTH;
2873         msg->rsp_size = 3;
2874         smi_info->curr_msg = NULL;
2875         deliver_recv_msg(smi_info, msg);
2876 }
2877
2878 /*
2879  * dell_poweredge_bt_xaction_handler
2880  * @info - smi_info.device_id must be populated
2881  *
2882  * Dell PowerEdge servers with the BT interface (x6xx and 1750) will
2883  * not respond to a Get SDR command if the length of the data
2884  * requested is exactly 0x3A, which leads to command timeouts and no
2885  * data returned.  This intercepts such commands, and causes userspace
2886  * callers to try again with a different-sized buffer, which succeeds.
2887  */
2888
2889 #define STORAGE_NETFN 0x0A
2890 #define STORAGE_CMD_GET_SDR 0x23
2891 static int dell_poweredge_bt_xaction_handler(struct notifier_block *self,
2892                                              unsigned long unused,
2893                                              void *in)
2894 {
2895         struct smi_info *smi_info = in;
2896         unsigned char *data = smi_info->curr_msg->data;
2897         unsigned int size   = smi_info->curr_msg->data_size;
2898         if (size >= 8 &&
2899             (data[0]>>2) == STORAGE_NETFN &&
2900             data[1] == STORAGE_CMD_GET_SDR &&
2901             data[7] == 0x3A) {
2902                 return_hosed_msg_badsize(smi_info);
2903                 return NOTIFY_STOP;
2904         }
2905         return NOTIFY_DONE;
2906 }
2907
2908 static struct notifier_block dell_poweredge_bt_xaction_notifier = {
2909         .notifier_call  = dell_poweredge_bt_xaction_handler,
2910 };
2911
2912 /*
2913  * setup_dell_poweredge_bt_xaction_handler
2914  * @info - smi_info.device_id must be filled in already
2915  *
2916  * Fills in smi_info.device_id.start_transaction_pre_hook
2917  * when we know what function to use there.
2918  */
2919 static void
2920 setup_dell_poweredge_bt_xaction_handler(struct smi_info *smi_info)
2921 {
2922         struct ipmi_device_id *id = &smi_info->device_id;
2923         if (id->manufacturer_id == DELL_IANA_MFR_ID &&
2924             smi_info->si_type == SI_BT)
2925                 register_xaction_notifier(&dell_poweredge_bt_xaction_notifier);
2926 }
2927
2928 /*
2929  * setup_oem_data_handler
2930  * @info - smi_info.device_id must be filled in already
2931  *
2932  * Fills in smi_info.device_id.oem_data_available_handler
2933  * when we know what function to use there.
2934  */
2935
2936 static void setup_oem_data_handler(struct smi_info *smi_info)
2937 {
2938         setup_dell_poweredge_oem_data_handler(smi_info);
2939 }
2940
2941 static void setup_xaction_handlers(struct smi_info *smi_info)
2942 {
2943         setup_dell_poweredge_bt_xaction_handler(smi_info);
2944 }
2945
2946 static inline void wait_for_timer_and_thread(struct smi_info *smi_info)
2947 {
2948         if (smi_info->intf) {
2949                 /*
2950                  * The timer and thread are only running if the
2951                  * interface has been started up and registered.
2952                  */
2953                 if (smi_info->thread != NULL)
2954                         kthread_stop(smi_info->thread);
2955                 del_timer_sync(&smi_info->si_timer);
2956         }
2957 }
2958
2959 static __devinitdata struct ipmi_default_vals
2960 {
2961         int type;
2962         int port;
2963 } ipmi_defaults[] =
2964 {
2965         { .type = SI_KCS, .port = 0xca2 },
2966         { .type = SI_SMIC, .port = 0xca9 },
2967         { .type = SI_BT, .port = 0xe4 },
2968         { .port = 0 }
2969 };
2970
2971 static __devinit void default_find_bmc(void)
2972 {
2973         struct smi_info *info;
2974         int             i;
2975
2976         for (i = 0; ; i++) {
2977                 if (!ipmi_defaults[i].port)
2978                         break;
2979 #ifdef CONFIG_PPC
2980                 if (check_legacy_ioport(ipmi_defaults[i].port))
2981                         continue;
2982 #endif
2983                 info = kzalloc(sizeof(*info), GFP_KERNEL);
2984                 if (!info)
2985                         return;
2986
2987                 info->addr_source = SI_DEFAULT;
2988
2989                 info->si_type = ipmi_defaults[i].type;
2990                 info->io_setup = port_setup;
2991                 info->io.addr_data = ipmi_defaults[i].port;
2992                 info->io.addr_type = IPMI_IO_ADDR_SPACE;
2993
2994                 info->io.addr = NULL;
2995                 info->io.regspacing = DEFAULT_REGSPACING;
2996                 info->io.regsize = DEFAULT_REGSPACING;
2997                 info->io.regshift = 0;
2998
2999                 if (add_smi(info) == 0) {
3000                         if ((try_smi_init(info)) == 0) {
3001                                 /* Found one... */
3002                                 printk(KERN_INFO PFX "Found default %s"
3003                                 " state machine at %s address 0x%lx\n",
3004                                 si_to_str[info->si_type],
3005                                 addr_space_to_str[info->io.addr_type],
3006                                 info->io.addr_data);
3007                         } else
3008                                 cleanup_one_si(info);
3009                 }
3010         }
3011 }
3012
3013 static int is_new_interface(struct smi_info *info)
3014 {
3015         struct smi_info *e;
3016
3017         list_for_each_entry(e, &smi_infos, link) {
3018                 if (e->io.addr_type != info->io.addr_type)
3019                         continue;
3020                 if (e->io.addr_data == info->io.addr_data)
3021                         return 0;
3022         }
3023
3024         return 1;
3025 }
3026
3027 static int add_smi(struct smi_info *new_smi)
3028 {
3029         int rv = 0;
3030
3031         printk(KERN_INFO PFX "Adding %s-specified %s state machine",
3032                         ipmi_addr_src_to_str[new_smi->addr_source],
3033                         si_to_str[new_smi->si_type]);
3034         mutex_lock(&smi_infos_lock);
3035         if (!is_new_interface(new_smi)) {
3036                 printk(KERN_CONT PFX "duplicate interface\n");
3037                 rv = -EBUSY;
3038                 goto out_err;
3039         }
3040
3041         printk(KERN_CONT "\n");
3042
3043         /* So we know not to free it unless we have allocated one. */
3044         new_smi->intf = NULL;
3045         new_smi->si_sm = NULL;
3046         new_smi->handlers = NULL;
3047
3048         list_add_tail(&new_smi->link, &smi_infos);
3049
3050 out_err:
3051         mutex_unlock(&smi_infos_lock);
3052         return rv;
3053 }
3054
3055 static int try_smi_init(struct smi_info *new_smi)
3056 {
3057         int rv = 0;
3058         int i;
3059
3060         printk(KERN_INFO PFX "Trying %s-specified %s state"
3061                " machine at %s address 0x%lx, slave address 0x%x,"
3062                " irq %d\n",
3063                ipmi_addr_src_to_str[new_smi->addr_source],
3064                si_to_str[new_smi->si_type],
3065                addr_space_to_str[new_smi->io.addr_type],
3066                new_smi->io.addr_data,
3067                new_smi->slave_addr, new_smi->irq);
3068
3069         switch (new_smi->si_type) {
3070         case SI_KCS:
3071                 new_smi->handlers = &kcs_smi_handlers;
3072                 break;
3073
3074         case SI_SMIC:
3075                 new_smi->handlers = &smic_smi_handlers;
3076                 break;
3077
3078         case SI_BT:
3079                 new_smi->handlers = &bt_smi_handlers;
3080                 break;
3081
3082         default:
3083                 /* No support for anything else yet. */
3084                 rv = -EIO;
3085                 goto out_err;
3086         }
3087
3088         /* Allocate the state machine's data and initialize it. */
3089         new_smi->si_sm = kmalloc(new_smi->handlers->size(), GFP_KERNEL);
3090         if (!new_smi->si_sm) {
3091                 printk(KERN_ERR PFX
3092                        "Could not allocate state machine memory\n");
3093                 rv = -ENOMEM;
3094                 goto out_err;
3095         }
3096         new_smi->io_size = new_smi->handlers->init_data(new_smi->si_sm,
3097                                                         &new_smi->io);
3098
3099         /* Now that we know the I/O size, we can set up the I/O. */
3100         rv = new_smi->io_setup(new_smi);
3101         if (rv) {
3102                 printk(KERN_ERR PFX "Could not set up I/O space\n");
3103                 goto out_err;
3104         }
3105
3106         spin_lock_init(&(new_smi->si_lock));
3107         spin_lock_init(&(new_smi->msg_lock));
3108
3109         /* Do low-level detection first. */
3110         if (new_smi->handlers->detect(new_smi->si_sm)) {
3111                 if (new_smi->addr_source)
3112                         printk(KERN_INFO PFX "Interface detection failed\n");
3113                 rv = -ENODEV;
3114                 goto out_err;
3115         }
3116
3117         /*
3118          * Attempt a get device id command.  If it fails, we probably
3119          * don't have a BMC here.
3120          */
3121         rv = try_get_dev_id(new_smi);
3122         if (rv) {
3123                 if (new_smi->addr_source)
3124