GNU Linux-libre 4.14.332-gnu1
[releases.git] / arch / ia64 / kernel / mca_drv.c
1 /*
2  * File:        mca_drv.c
3  * Purpose:     Generic MCA handling layer
4  *
5  * Copyright (C) 2004 FUJITSU LIMITED
6  * Copyright (C) 2004 Hidetoshi Seto <seto.hidetoshi@jp.fujitsu.com>
7  * Copyright (C) 2005 Silicon Graphics, Inc
8  * Copyright (C) 2005 Keith Owens <kaos@sgi.com>
9  * Copyright (C) 2006 Russ Anderson <rja@sgi.com>
10  */
11 #include <linux/types.h>
12 #include <linux/init.h>
13 #include <linux/sched.h>
14 #include <linux/sched/task.h>
15 #include <linux/interrupt.h>
16 #include <linux/irq.h>
17 #include <linux/kallsyms.h>
18 #include <linux/bootmem.h>
19 #include <linux/acpi.h>
20 #include <linux/timer.h>
21 #include <linux/module.h>
22 #include <linux/kernel.h>
23 #include <linux/smp.h>
24 #include <linux/workqueue.h>
25 #include <linux/mm.h>
26 #include <linux/slab.h>
27
28 #include <asm/delay.h>
29 #include <asm/machvec.h>
30 #include <asm/page.h>
31 #include <asm/ptrace.h>
32 #include <asm/sal.h>
33 #include <asm/mca.h>
34
35 #include <asm/irq.h>
36 #include <asm/hw_irq.h>
37
38 #include "mca_drv.h"
39
40 /* max size of SAL error record (default) */
41 static int sal_rec_max = 10000;
42
43 /* from mca_drv_asm.S */
44 extern void *mca_handler_bhhook(void);
45
46 static DEFINE_SPINLOCK(mca_bh_lock);
47
48 typedef enum {
49         MCA_IS_LOCAL  = 0,
50         MCA_IS_GLOBAL = 1
51 } mca_type_t;
52
53 #define MAX_PAGE_ISOLATE 1024
54
55 static struct page *page_isolate[MAX_PAGE_ISOLATE];
56 static int num_page_isolate = 0;
57
58 typedef enum {
59         ISOLATE_NG,
60         ISOLATE_OK,
61         ISOLATE_NONE
62 } isolate_status_t;
63
64 typedef enum {
65         MCA_NOT_RECOVERED = 0,
66         MCA_RECOVERED     = 1
67 } recovery_status_t;
68
69 /*
70  *  This pool keeps pointers to the section part of SAL error record
71  */
72 static struct {
73         slidx_list_t *buffer; /* section pointer list pool */
74         int          cur_idx; /* Current index of section pointer list pool */
75         int          max_idx; /* Maximum index of section pointer list pool */
76 } slidx_pool;
77
78 static int
79 fatal_mca(const char *fmt, ...)
80 {
81         va_list args;
82         char buf[256];
83
84         va_start(args, fmt);
85         vsnprintf(buf, sizeof(buf), fmt, args);
86         va_end(args);
87         ia64_mca_printk(KERN_ALERT "MCA: %s\n", buf);
88
89         return MCA_NOT_RECOVERED;
90 }
91
92 static int
93 mca_recovered(const char *fmt, ...)
94 {
95         va_list args;
96         char buf[256];
97
98         va_start(args, fmt);
99         vsnprintf(buf, sizeof(buf), fmt, args);
100         va_end(args);
101         ia64_mca_printk(KERN_INFO "MCA: %s\n", buf);
102
103         return MCA_RECOVERED;
104 }
105
106 /**
107  * mca_page_isolate - isolate a poisoned page in order not to use it later
108  * @paddr:      poisoned memory location
109  *
110  * Return value:
111  *      one of isolate_status_t, ISOLATE_OK/NG/NONE.
112  */
113
114 static isolate_status_t
115 mca_page_isolate(unsigned long paddr)
116 {
117         int i;
118         struct page *p;
119
120         /* whether physical address is valid or not */
121         if (!ia64_phys_addr_valid(paddr))
122                 return ISOLATE_NONE;
123
124         if (!pfn_valid(paddr >> PAGE_SHIFT))
125                 return ISOLATE_NONE;
126
127         /* convert physical address to physical page number */
128         p = pfn_to_page(paddr>>PAGE_SHIFT);
129
130         /* check whether a page number have been already registered or not */
131         for (i = 0; i < num_page_isolate; i++)
132                 if (page_isolate[i] == p)
133                         return ISOLATE_OK; /* already listed */
134
135         /* limitation check */
136         if (num_page_isolate == MAX_PAGE_ISOLATE)
137                 return ISOLATE_NG;
138
139         /* kick pages having attribute 'SLAB' or 'Reserved' */
140         if (PageSlab(p) || PageReserved(p))
141                 return ISOLATE_NG;
142
143         /* add attribute 'Reserved' and register the page */
144         get_page(p);
145         SetPageReserved(p);
146         page_isolate[num_page_isolate++] = p;
147
148         return ISOLATE_OK;
149 }
150
151 /**
152  * mca_hanlder_bh - Kill the process which occurred memory read error
153  * @paddr:      poisoned address received from MCA Handler
154  */
155
156 void
157 mca_handler_bh(unsigned long paddr, void *iip, unsigned long ipsr)
158 {
159         ia64_mlogbuf_dump();
160         printk(KERN_ERR "OS_MCA: process [cpu %d, pid: %d, uid: %d, "
161                 "iip: %p, psr: 0x%lx,paddr: 0x%lx](%s) encounters MCA.\n",
162                raw_smp_processor_id(), current->pid,
163                 from_kuid(&init_user_ns, current_uid()),
164                 iip, ipsr, paddr, current->comm);
165
166         spin_lock(&mca_bh_lock);
167         switch (mca_page_isolate(paddr)) {
168         case ISOLATE_OK:
169                 printk(KERN_DEBUG "Page isolation: ( %lx ) success.\n", paddr);
170                 break;
171         case ISOLATE_NG:
172                 printk(KERN_CRIT "Page isolation: ( %lx ) failure.\n", paddr);
173                 break;
174         default:
175                 break;
176         }
177         spin_unlock(&mca_bh_lock);
178
179         /* This process is about to be killed itself */
180         make_task_dead(SIGKILL);
181 }
182
183 /**
184  * mca_make_peidx - Make index of processor error section
185  * @slpi:       pointer to record of processor error section
186  * @peidx:      pointer to index of processor error section
187  */
188
189 static void
190 mca_make_peidx(sal_log_processor_info_t *slpi, peidx_table_t *peidx)
191 {
192         /*
193          * calculate the start address of
194          *   "struct cpuid_info" and "sal_processor_static_info_t".
195          */
196         u64 total_check_num = slpi->valid.num_cache_check
197                                 + slpi->valid.num_tlb_check
198                                 + slpi->valid.num_bus_check
199                                 + slpi->valid.num_reg_file_check
200                                 + slpi->valid.num_ms_check;
201         u64 head_size = sizeof(sal_log_mod_error_info_t) * total_check_num
202                         + sizeof(sal_log_processor_info_t);
203         u64 mid_size  = slpi->valid.cpuid_info * sizeof(struct sal_cpuid_info);
204
205         peidx_head(peidx)   = slpi;
206         peidx_mid(peidx)    = (struct sal_cpuid_info *)
207                 (slpi->valid.cpuid_info ? ((char*)slpi + head_size) : NULL);
208         peidx_bottom(peidx) = (sal_processor_static_info_t *)
209                 (slpi->valid.psi_static_struct ?
210                         ((char*)slpi + head_size + mid_size) : NULL);
211 }
212
213 /**
214  * mca_make_slidx -  Make index of SAL error record
215  * @buffer:     pointer to SAL error record
216  * @slidx:      pointer to index of SAL error record
217  *
218  * Return value:
219  *      1 if record has platform error / 0 if not
220  */
221 #define LOG_INDEX_ADD_SECT_PTR(sect, ptr) \
222         {slidx_list_t *hl = &slidx_pool.buffer[slidx_pool.cur_idx]; \
223         hl->hdr = ptr; \
224         list_add(&hl->list, &(sect)); \
225         slidx_pool.cur_idx = (slidx_pool.cur_idx + 1)%slidx_pool.max_idx; }
226
227 static int
228 mca_make_slidx(void *buffer, slidx_table_t *slidx)
229 {
230         int platform_err = 0;
231         int record_len = ((sal_log_record_header_t*)buffer)->len;
232         u32 ercd_pos;
233         int sects;
234         sal_log_section_hdr_t *sp;
235
236         /*
237          * Initialize index referring current record
238          */
239         INIT_LIST_HEAD(&(slidx->proc_err));
240         INIT_LIST_HEAD(&(slidx->mem_dev_err));
241         INIT_LIST_HEAD(&(slidx->sel_dev_err));
242         INIT_LIST_HEAD(&(slidx->pci_bus_err));
243         INIT_LIST_HEAD(&(slidx->smbios_dev_err));
244         INIT_LIST_HEAD(&(slidx->pci_comp_err));
245         INIT_LIST_HEAD(&(slidx->plat_specific_err));
246         INIT_LIST_HEAD(&(slidx->host_ctlr_err));
247         INIT_LIST_HEAD(&(slidx->plat_bus_err));
248         INIT_LIST_HEAD(&(slidx->unsupported));
249
250         /*
251          * Extract a Record Header
252          */
253         slidx->header = buffer;
254
255         /*
256          * Extract each section records
257          * (arranged from "int ia64_log_platform_info_print()")
258          */
259         for (ercd_pos = sizeof(sal_log_record_header_t), sects = 0;
260                 ercd_pos < record_len; ercd_pos += sp->len, sects++) {
261                 sp = (sal_log_section_hdr_t *)((char*)buffer + ercd_pos);
262                 if (!efi_guidcmp(sp->guid, SAL_PROC_DEV_ERR_SECT_GUID)) {
263                         LOG_INDEX_ADD_SECT_PTR(slidx->proc_err, sp);
264                 } else if (!efi_guidcmp(sp->guid,
265                                 SAL_PLAT_MEM_DEV_ERR_SECT_GUID)) {
266                         platform_err = 1;
267                         LOG_INDEX_ADD_SECT_PTR(slidx->mem_dev_err, sp);
268                 } else if (!efi_guidcmp(sp->guid,
269                                 SAL_PLAT_SEL_DEV_ERR_SECT_GUID)) {
270                         platform_err = 1;
271                         LOG_INDEX_ADD_SECT_PTR(slidx->sel_dev_err, sp);
272                 } else if (!efi_guidcmp(sp->guid,
273                                 SAL_PLAT_PCI_BUS_ERR_SECT_GUID)) {
274                         platform_err = 1;
275                         LOG_INDEX_ADD_SECT_PTR(slidx->pci_bus_err, sp);
276                 } else if (!efi_guidcmp(sp->guid,
277                                 SAL_PLAT_SMBIOS_DEV_ERR_SECT_GUID)) {
278                         platform_err = 1;
279                         LOG_INDEX_ADD_SECT_PTR(slidx->smbios_dev_err, sp);
280                 } else if (!efi_guidcmp(sp->guid,
281                                 SAL_PLAT_PCI_COMP_ERR_SECT_GUID)) {
282                         platform_err = 1;
283                         LOG_INDEX_ADD_SECT_PTR(slidx->pci_comp_err, sp);
284                 } else if (!efi_guidcmp(sp->guid,
285                                 SAL_PLAT_SPECIFIC_ERR_SECT_GUID)) {
286                         platform_err = 1;
287                         LOG_INDEX_ADD_SECT_PTR(slidx->plat_specific_err, sp);
288                 } else if (!efi_guidcmp(sp->guid,
289                                 SAL_PLAT_HOST_CTLR_ERR_SECT_GUID)) {
290                         platform_err = 1;
291                         LOG_INDEX_ADD_SECT_PTR(slidx->host_ctlr_err, sp);
292                 } else if (!efi_guidcmp(sp->guid,
293                                 SAL_PLAT_BUS_ERR_SECT_GUID)) {
294                         platform_err = 1;
295                         LOG_INDEX_ADD_SECT_PTR(slidx->plat_bus_err, sp);
296                 } else {
297                         LOG_INDEX_ADD_SECT_PTR(slidx->unsupported, sp);
298                 }
299         }
300         slidx->n_sections = sects;
301
302         return platform_err;
303 }
304
305 /**
306  * init_record_index_pools - Initialize pool of lists for SAL record index
307  *
308  * Return value:
309  *      0 on Success / -ENOMEM on Failure
310  */
311 static int
312 init_record_index_pools(void)
313 {
314         int i;
315         int rec_max_size;  /* Maximum size of SAL error records */
316         int sect_min_size; /* Minimum size of SAL error sections */
317         /* minimum size table of each section */
318         static int sal_log_sect_min_sizes[] = {
319                 sizeof(sal_log_processor_info_t)
320                 + sizeof(sal_processor_static_info_t),
321                 sizeof(sal_log_mem_dev_err_info_t),
322                 sizeof(sal_log_sel_dev_err_info_t),
323                 sizeof(sal_log_pci_bus_err_info_t),
324                 sizeof(sal_log_smbios_dev_err_info_t),
325                 sizeof(sal_log_pci_comp_err_info_t),
326                 sizeof(sal_log_plat_specific_err_info_t),
327                 sizeof(sal_log_host_ctlr_err_info_t),
328                 sizeof(sal_log_plat_bus_err_info_t),
329         };
330
331         /*
332          * MCA handler cannot allocate new memory on flight,
333          * so we preallocate enough memory to handle a SAL record.
334          *
335          * Initialize a handling set of slidx_pool:
336          *   1. Pick up the max size of SAL error records
337          *   2. Pick up the min size of SAL error sections
338          *   3. Allocate the pool as enough to 2 SAL records
339          *     (now we can estimate the maxinum of section in a record.)
340          */
341
342         /* - 1 - */
343         rec_max_size = sal_rec_max;
344
345         /* - 2 - */
346         sect_min_size = sal_log_sect_min_sizes[0];
347         for (i = 1; i < ARRAY_SIZE(sal_log_sect_min_sizes); i++)
348                 if (sect_min_size > sal_log_sect_min_sizes[i])
349                         sect_min_size = sal_log_sect_min_sizes[i];
350
351         /* - 3 - */
352         slidx_pool.max_idx = (rec_max_size/sect_min_size) * 2 + 1;
353         slidx_pool.buffer =
354                 kmalloc(slidx_pool.max_idx * sizeof(slidx_list_t), GFP_KERNEL);
355
356         return slidx_pool.buffer ? 0 : -ENOMEM;
357 }
358
359
360 /*****************************************************************************
361  * Recovery functions                                                        *
362  *****************************************************************************/
363
364 /**
365  * is_mca_global - Check whether this MCA is global or not
366  * @peidx:      pointer of index of processor error section
367  * @pbci:       pointer to pal_bus_check_info_t
368  * @sos:        pointer to hand off struct between SAL and OS
369  *
370  * Return value:
371  *      MCA_IS_LOCAL / MCA_IS_GLOBAL
372  */
373
374 static mca_type_t
375 is_mca_global(peidx_table_t *peidx, pal_bus_check_info_t *pbci,
376               struct ia64_sal_os_state *sos)
377 {
378         pal_processor_state_info_t *psp =
379                 (pal_processor_state_info_t*)peidx_psp(peidx);
380
381         /*
382          * PAL can request a rendezvous, if the MCA has a global scope.
383          * If "rz_always" flag is set, SAL requests MCA rendezvous
384          * in spite of global MCA.
385          * Therefore it is local MCA when rendezvous has not been requested.
386          * Failed to rendezvous, the system must be down.
387          */
388         switch (sos->rv_rc) {
389                 case -1: /* SAL rendezvous unsuccessful */
390                         return MCA_IS_GLOBAL;
391                 case  0: /* SAL rendezvous not required */
392                         return MCA_IS_LOCAL;
393                 case  1: /* SAL rendezvous successful int */
394                 case  2: /* SAL rendezvous successful int with init */
395                 default:
396                         break;
397         }
398
399         /*
400          * If One or more Cache/TLB/Reg_File/Uarch_Check is here,
401          * it would be a local MCA. (i.e. processor internal error)
402          */
403         if (psp->tc || psp->cc || psp->rc || psp->uc)
404                 return MCA_IS_LOCAL;
405         
406         /*
407          * Bus_Check structure with Bus_Check.ib (internal bus error) flag set
408          * would be a global MCA. (e.g. a system bus address parity error)
409          */
410         if (!pbci || pbci->ib)
411                 return MCA_IS_GLOBAL;
412
413         /*
414          * Bus_Check structure with Bus_Check.eb (external bus error) flag set
415          * could be either a local MCA or a global MCA.
416          *
417          * Referring Bus_Check.bsi:
418          *   0: Unknown/unclassified
419          *   1: BERR#
420          *   2: BINIT#
421          *   3: Hard Fail
422          * (FIXME: Are these SGI specific or generic bsi values?)
423          */
424         if (pbci->eb)
425                 switch (pbci->bsi) {
426                         case 0:
427                                 /* e.g. a load from poisoned memory */
428                                 return MCA_IS_LOCAL;
429                         case 1:
430                         case 2:
431                         case 3:
432                                 return MCA_IS_GLOBAL;
433                 }
434
435         return MCA_IS_GLOBAL;
436 }
437
438 /**
439  * get_target_identifier - Get the valid Cache or Bus check target identifier.
440  * @peidx:      pointer of index of processor error section
441  *
442  * Return value:
443  *      target address on Success / 0 on Failure
444  */
445 static u64
446 get_target_identifier(peidx_table_t *peidx)
447 {
448         u64 target_address = 0;
449         sal_log_mod_error_info_t *smei;
450         pal_cache_check_info_t *pcci;
451         int i, level = 9;
452
453         /*
454          * Look through the cache checks for a valid target identifier
455          * If more than one valid target identifier, return the one
456          * with the lowest cache level.
457          */
458         for (i = 0; i < peidx_cache_check_num(peidx); i++) {
459                 smei = (sal_log_mod_error_info_t *)peidx_cache_check(peidx, i);
460                 if (smei->valid.target_identifier && smei->target_identifier) {
461                         pcci = (pal_cache_check_info_t *)&(smei->check_info);
462                         if (!target_address || (pcci->level < level)) {
463                                 target_address = smei->target_identifier;
464                                 level = pcci->level;
465                                 continue;
466                         }
467                 }
468         }
469         if (target_address)
470                 return target_address;
471
472         /*
473          * Look at the bus check for a valid target identifier
474          */
475         smei = peidx_bus_check(peidx, 0);
476         if (smei && smei->valid.target_identifier)
477                 return smei->target_identifier;
478
479         return 0;
480 }
481
482 /**
483  * recover_from_read_error - Try to recover the errors which type are "read"s.
484  * @slidx:      pointer of index of SAL error record
485  * @peidx:      pointer of index of processor error section
486  * @pbci:       pointer of pal_bus_check_info
487  * @sos:        pointer to hand off struct between SAL and OS
488  *
489  * Return value:
490  *      1 on Success / 0 on Failure
491  */
492
493 static int
494 recover_from_read_error(slidx_table_t *slidx,
495                         peidx_table_t *peidx, pal_bus_check_info_t *pbci,
496                         struct ia64_sal_os_state *sos)
497 {
498         u64 target_identifier;
499         pal_min_state_area_t *pmsa;
500         struct ia64_psr *psr1, *psr2;
501         ia64_fptr_t *mca_hdlr_bh = (ia64_fptr_t*)mca_handler_bhhook;
502
503         /* Is target address valid? */
504         target_identifier = get_target_identifier(peidx);
505         if (!target_identifier)
506                 return fatal_mca("target address not valid");
507
508         /*
509          * cpu read or memory-mapped io read
510          *
511          *    offending process  affected process  OS MCA do
512          *     kernel mode        kernel mode       down system
513          *     kernel mode        user   mode       kill the process
514          *     user   mode        kernel mode       down system (*)
515          *     user   mode        user   mode       kill the process
516          *
517          * (*) You could terminate offending user-mode process
518          *    if (pbci->pv && pbci->pl != 0) *and* if you sure
519          *    the process not have any locks of kernel.
520          */
521
522         /* Is minstate valid? */
523         if (!peidx_bottom(peidx) || !(peidx_bottom(peidx)->valid.minstate))
524                 return fatal_mca("minstate not valid");
525         psr1 =(struct ia64_psr *)&(peidx_minstate_area(peidx)->pmsa_ipsr);
526         psr2 =(struct ia64_psr *)&(peidx_minstate_area(peidx)->pmsa_xpsr);
527
528         /*
529          *  Check the privilege level of interrupted context.
530          *   If it is user-mode, then terminate affected process.
531          */
532
533         pmsa = sos->pal_min_state;
534         if (psr1->cpl != 0 ||
535            ((psr2->cpl != 0) && mca_recover_range(pmsa->pmsa_iip))) {
536                 /*
537                  *  setup for resume to bottom half of MCA,
538                  * "mca_handler_bhhook"
539                  */
540                 /* pass to bhhook as argument (gr8, ...) */
541                 pmsa->pmsa_gr[8-1] = target_identifier;
542                 pmsa->pmsa_gr[9-1] = pmsa->pmsa_iip;
543                 pmsa->pmsa_gr[10-1] = pmsa->pmsa_ipsr;
544                 /* set interrupted return address (but no use) */
545                 pmsa->pmsa_br0 = pmsa->pmsa_iip;
546                 /* change resume address to bottom half */
547                 pmsa->pmsa_iip = mca_hdlr_bh->fp;
548                 pmsa->pmsa_gr[1-1] = mca_hdlr_bh->gp;
549                 /* set cpl with kernel mode */
550                 psr2 = (struct ia64_psr *)&pmsa->pmsa_ipsr;
551                 psr2->cpl = 0;
552                 psr2->ri  = 0;
553                 psr2->bn  = 1;
554                 psr2->i  = 0;
555
556                 return mca_recovered("user memory corruption. "
557                                 "kill affected process - recovered.");
558         }
559
560         return fatal_mca("kernel context not recovered, iip 0x%lx\n",
561                          pmsa->pmsa_iip);
562 }
563
564 /**
565  * recover_from_platform_error - Recover from platform error.
566  * @slidx:      pointer of index of SAL error record
567  * @peidx:      pointer of index of processor error section
568  * @pbci:       pointer of pal_bus_check_info
569  * @sos:        pointer to hand off struct between SAL and OS
570  *
571  * Return value:
572  *      1 on Success / 0 on Failure
573  */
574
575 static int
576 recover_from_platform_error(slidx_table_t *slidx, peidx_table_t *peidx,
577                             pal_bus_check_info_t *pbci,
578                             struct ia64_sal_os_state *sos)
579 {
580         int status = 0;
581         pal_processor_state_info_t *psp =
582                 (pal_processor_state_info_t*)peidx_psp(peidx);
583
584         if (psp->bc && pbci->eb && pbci->bsi == 0) {
585                 switch(pbci->type) {
586                 case 1: /* partial read */
587                 case 3: /* full line(cpu) read */
588                 case 9: /* I/O space read */
589                         status = recover_from_read_error(slidx, peidx, pbci,
590                                                          sos);
591                         break;
592                 case 0: /* unknown */
593                 case 2: /* partial write */
594                 case 4: /* full line write */
595                 case 5: /* implicit or explicit write-back operation */
596                 case 6: /* snoop probe */
597                 case 7: /* incoming or outgoing ptc.g */
598                 case 8: /* write coalescing transactions */
599                 case 10: /* I/O space write */
600                 case 11: /* inter-processor interrupt message(IPI) */
601                 case 12: /* interrupt acknowledge or
602                                 external task priority cycle */
603                 default:
604                         break;
605                 }
606         } else if (psp->cc && !psp->bc) {       /* Cache error */
607                 status = recover_from_read_error(slidx, peidx, pbci, sos);
608         }
609
610         return status;
611 }
612
613 /*
614  * recover_from_tlb_check
615  * @peidx:      pointer of index of processor error section
616  *
617  * Return value:
618  *      1 on Success / 0 on Failure
619  */
620 static int
621 recover_from_tlb_check(peidx_table_t *peidx)
622 {
623         sal_log_mod_error_info_t *smei;
624         pal_tlb_check_info_t *ptci;
625
626         smei = (sal_log_mod_error_info_t *)peidx_tlb_check(peidx, 0);
627         ptci = (pal_tlb_check_info_t *)&(smei->check_info);
628
629         /*
630          * Look for signature of a duplicate TLB DTC entry, which is
631          * a SW bug and always fatal.
632          */
633         if (ptci->op == PAL_TLB_CHECK_OP_PURGE
634             && !(ptci->itr || ptci->dtc || ptci->itc))
635                 return fatal_mca("Duplicate TLB entry");
636
637         return mca_recovered("TLB check recovered");
638 }
639
640 /**
641  * recover_from_processor_error
642  * @platform:   whether there are some platform error section or not
643  * @slidx:      pointer of index of SAL error record
644  * @peidx:      pointer of index of processor error section
645  * @pbci:       pointer of pal_bus_check_info
646  * @sos:        pointer to hand off struct between SAL and OS
647  *
648  * Return value:
649  *      1 on Success / 0 on Failure
650  */
651
652 static int
653 recover_from_processor_error(int platform, slidx_table_t *slidx,
654                              peidx_table_t *peidx, pal_bus_check_info_t *pbci,
655                              struct ia64_sal_os_state *sos)
656 {
657         pal_processor_state_info_t *psp =
658                 (pal_processor_state_info_t*)peidx_psp(peidx);
659
660         /*
661          * Processor recovery status must key off of the PAL recovery
662          * status in the Processor State Parameter.
663          */
664
665         /*
666          * The machine check is corrected.
667          */
668         if (psp->cm == 1)
669                 return mca_recovered("machine check is already corrected.");
670
671         /*
672          * The error was not contained.  Software must be reset.
673          */
674         if (psp->us || psp->ci == 0)
675                 return fatal_mca("error not contained");
676
677         /*
678          * Look for recoverable TLB check
679          */
680         if (psp->tc && !(psp->cc || psp->bc || psp->rc || psp->uc))
681                 return recover_from_tlb_check(peidx);
682
683         /*
684          * The cache check and bus check bits have four possible states
685          *   cc bc
686          *    1  1      Memory error, attempt recovery
687          *    1  0      Cache error, attempt recovery
688          *    0  1      I/O error, attempt recovery
689          *    0  0      Other error type, not recovered
690          */
691         if (psp->cc == 0 && (psp->bc == 0 || pbci == NULL))
692                 return fatal_mca("No cache or bus check");
693
694         /*
695          * Cannot handle more than one bus check.
696          */
697         if (peidx_bus_check_num(peidx) > 1)
698                 return fatal_mca("Too many bus checks");
699
700         if (pbci->ib)
701                 return fatal_mca("Internal Bus error");
702         if (pbci->eb && pbci->bsi > 0)
703                 return fatal_mca("External bus check fatal status");
704
705         /*
706          * This is a local MCA and estimated as a recoverable error.
707          */
708         if (platform)
709                 return recover_from_platform_error(slidx, peidx, pbci, sos);
710
711         /*
712          * On account of strange SAL error record, we cannot recover.
713          */
714         return fatal_mca("Strange SAL record");
715 }
716
717 /**
718  * mca_try_to_recover - Try to recover from MCA
719  * @rec:        pointer to a SAL error record
720  * @sos:        pointer to hand off struct between SAL and OS
721  *
722  * Return value:
723  *      1 on Success / 0 on Failure
724  */
725
726 static int
727 mca_try_to_recover(void *rec, struct ia64_sal_os_state *sos)
728 {
729         int platform_err;
730         int n_proc_err;
731         slidx_table_t slidx;
732         peidx_table_t peidx;
733         pal_bus_check_info_t pbci;
734
735         /* Make index of SAL error record */
736         platform_err = mca_make_slidx(rec, &slidx);
737
738         /* Count processor error sections */
739         n_proc_err = slidx_count(&slidx, proc_err);
740
741          /* Now, OS can recover when there is one processor error section */
742         if (n_proc_err > 1)
743                 return fatal_mca("Too Many Errors");
744         else if (n_proc_err == 0)
745                 /* Weird SAL record ... We can't do anything */
746                 return fatal_mca("Weird SAL record");
747
748         /* Make index of processor error section */
749         mca_make_peidx((sal_log_processor_info_t*)
750                 slidx_first_entry(&slidx.proc_err)->hdr, &peidx);
751
752         /* Extract Processor BUS_CHECK[0] */
753         *((u64*)&pbci) = peidx_check_info(&peidx, bus_check, 0);
754
755         /* Check whether MCA is global or not */
756         if (is_mca_global(&peidx, &pbci, sos))
757                 return fatal_mca("global MCA");
758         
759         /* Try to recover a processor error */
760         return recover_from_processor_error(platform_err, &slidx, &peidx,
761                                             &pbci, sos);
762 }
763
764 /*
765  * =============================================================================
766  */
767
768 int __init mca_external_handler_init(void)
769 {
770         if (init_record_index_pools())
771                 return -ENOMEM;
772
773         /* register external mca handlers */
774         if (ia64_reg_MCA_extension(mca_try_to_recover)) {       
775                 printk(KERN_ERR "ia64_reg_MCA_extension failed.\n");
776                 kfree(slidx_pool.buffer);
777                 return -EFAULT;
778         }
779         return 0;
780 }
781
782 void __exit mca_external_handler_exit(void)
783 {
784         /* unregister external mca handlers */
785         ia64_unreg_MCA_extension();
786         kfree(slidx_pool.buffer);
787 }
788
789 module_init(mca_external_handler_init);
790 module_exit(mca_external_handler_exit);
791
792 module_param(sal_rec_max, int, 0644);
793 MODULE_PARM_DESC(sal_rec_max, "Max size of SAL error record");
794
795 MODULE_DESCRIPTION("ia64 platform dependent mca handler driver");
796 MODULE_LICENSE("GPL");