drivers/acpi/apei/ghes.c

   1 /*
   2  * APEI Generic Hardware Error Source support
   3  *
   4  * Generic Hardware Error Source provides a way to report platform
   5  * hardware errors (such as that from chipset). It works in so called
   6  * "Firmware First" mode, that is, hardware errors are reported to
   7  * firmware firstly, then reported to Linux by firmware. This way,
   8  * some non-standard hardware error registers or non-standard hardware
   9  * link can be checked by firmware to produce more hardware error
  10  * information for Linux.
  11  *
  12  * For more information about Generic Hardware Error Source, please
  13  * refer to ACPI Specification version 4.0, section 17.3.2.6
  14  *
  15  * Copyright 2010,2011 Intel Corp.
  16  *   Author: Huang Ying <ying.huang@intel.com>
  17  *
  18  * This program is free software; you can redistribute it and/or
  19  * modify it under the terms of the GNU General Public License version
  20  * 2 as published by the Free Software Foundation;
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program; if not, write to the Free Software
  29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  30  */
  31
  32 #include <linux/kernel.h>
  33 #include <linux/module.h>
  34 #include <linux/init.h>
  35 #include <linux/acpi.h>
  36 #include <linux/io.h>
  37 #include <linux/interrupt.h>
  38 #include <linux/timer.h>
  39 #include <linux/cper.h>
  40 #include <linux/kdebug.h>
  41 #include <linux/platform_device.h>
  42 #include <linux/mutex.h>
  43 #include <linux/ratelimit.h>
  44 #include <linux/vmalloc.h>
  45 #include <linux/irq_work.h>
  46 #include <linux/llist.h>
  47 #include <linux/genalloc.h>
  48 #include <acpi/apei.h>
  49 #include <acpi/atomicio.h>
  50 #include <acpi/hed.h>
  51 #include <asm/mce.h>
  52 #include <asm/tlbflush.h>
  53
  54 #include "apei-internal.h"
  55
  56 #define GHES_PFX        "GHES: "
  57
  58 #define GHES_ESTATUS_MAX_SIZE           65536
  59 #define GHES_ESOURCE_PREALLOC_MAX_SIZE  65536
  60
  61 #define GHES_ESTATUS_POOL_MIN_ALLOC_ORDER 3
  62
  63 /* This is just an estimation for memory pool allocation */
  64 #define GHES_ESTATUS_CACHE_AVG_SIZE     512
  65
  66 #define GHES_ESTATUS_CACHES_SIZE        4
  67
  68 #define GHES_ESTATUS_IN_CACHE_MAX_NSEC  (10 * NSEC_PER_SEC)
  69 /* Prevent too many caches are allocated because of RCU */
  70 #define GHES_ESTATUS_CACHE_ALLOCED_MAX  (GHES_ESTATUS_CACHES_SIZE * 3 / 2)
  71
  72 #define GHES_ESTATUS_CACHE_LEN(estatus_len)                     \
  73         (sizeof(struct ghes_estatus_cache) + (estatus_len))
  74 #define GHES_ESTATUS_FROM_CACHE(estatus_cache)                  \
  75         ((struct acpi_hest_generic_status *)                    \
  76          ((struct ghes_estatus_cache *)(estatus_cache) + 1))
  77
  78 #define GHES_ESTATUS_NODE_LEN(estatus_len)                      \
  79         (sizeof(struct ghes_estatus_node) + (estatus_len))
  80 #define GHES_ESTATUS_FROM_NODE(estatus_node)                            \
  81         ((struct acpi_hest_generic_status *)                            \
  82          ((struct ghes_estatus_node *)(estatus_node) + 1))
  83
  84 /*
  85  * One struct ghes is created for each generic hardware error source.
  86  * It provides the context for APEI hardware error timer/IRQ/SCI/NMI
  87  * handler.
  88  *
  89  * estatus: memory buffer for error status block, allocated during
  90  * HEST parsing.
  91  */
  92 #define GHES_TO_CLEAR           0x0001
  93 #define GHES_EXITING            0x0002
  94
  95 struct ghes {
  96         struct acpi_hest_generic *generic;
  97         struct acpi_hest_generic_status *estatus;
  98         u64 buffer_paddr;
  99         unsigned long flags;
 100         union {
 101                 struct list_head list;
 102                 struct timer_list timer;
 103                 unsigned int irq;
 104         };
 105 };
 106
 107 struct ghes_estatus_node {
 108         struct llist_node llnode;
 109         struct acpi_hest_generic *generic;
 110 };
 111
 112 struct ghes_estatus_cache {
 113         u32 estatus_len;
 114         atomic_t count;
 115         struct acpi_hest_generic *generic;
 116         unsigned long long time_in;
 117         struct rcu_head rcu;
 118 };
 119
 120 int ghes_disable;
 121 module_param_named(disable, ghes_disable, bool, 0);
 122
 123 static int ghes_panic_timeout   __read_mostly = 30;
 124
 125 /*
 126  * All error sources notified with SCI shares one notifier function,
 127  * so they need to be linked and checked one by one.  This is applied
 128  * to NMI too.
 129  *
 130  * RCU is used for these lists, so ghes_list_mutex is only used for
 131  * list changing, not for traversing.
 132  */
 133 static LIST_HEAD(ghes_sci);
 134 static LIST_HEAD(ghes_nmi);
 135 static DEFINE_MUTEX(ghes_list_mutex);
 136
 137 /*
 138  * NMI may be triggered on any CPU, so ghes_nmi_lock is used for
 139  * mutual exclusion.
 140  */
 141 static DEFINE_RAW_SPINLOCK(ghes_nmi_lock);
 142
 143 /*
 144  * Because the memory area used to transfer hardware error information
 145  * from BIOS to Linux can be determined only in NMI, IRQ or timer
 146  * handler, but general ioremap can not be used in atomic context, so
 147  * a special version of atomic ioremap is implemented for that.
 148  */
 149
 150 /*
 151  * Two virtual pages are used, one for NMI context, the other for
 152  * IRQ/PROCESS context
 153  */
 154 #define GHES_IOREMAP_PAGES              2
 155 #define GHES_IOREMAP_NMI_PAGE(base)     (base)
 156 #define GHES_IOREMAP_IRQ_PAGE(base)     ((base) + PAGE_SIZE)
 157
 158 /* virtual memory area for atomic ioremap */
 159 static struct vm_struct *ghes_ioremap_area;
 160 /*
 161  * These 2 spinlock is used to prevent atomic ioremap virtual memory
 162  * area from being mapped simultaneously.
 163  */
 164 static DEFINE_RAW_SPINLOCK(ghes_ioremap_lock_nmi);
 165 static DEFINE_SPINLOCK(ghes_ioremap_lock_irq);
 166
 167 /*
 168  * printk is not safe in NMI context.  So in NMI handler, we allocate
 169  * required memory from lock-less memory allocator
 170  * (ghes_estatus_pool), save estatus into it, put them into lock-less
 171  * list (ghes_estatus_llist), then delay printk into IRQ context via
 172  * irq_work (ghes_proc_irq_work).  ghes_estatus_size_request record
 173  * required pool size by all NMI error source.
 174  */
 175 static struct gen_pool *ghes_estatus_pool;
 176 static unsigned long ghes_estatus_pool_size_request;
 177 static struct llist_head ghes_estatus_llist;
 178 static struct irq_work ghes_proc_irq_work;
 179
 180 struct ghes_estatus_cache *ghes_estatus_caches[GHES_ESTATUS_CACHES_SIZE];
 181 static atomic_t ghes_estatus_cache_alloced;
 182
 183 static int ghes_ioremap_init(void)
 184 {
 185         ghes_ioremap_area = __get_vm_area(PAGE_SIZE * GHES_IOREMAP_PAGES,
 186                 VM_IOREMAP, VMALLOC_START, VMALLOC_END);
 187         if (!ghes_ioremap_area) {
 188                 pr_err(GHES_PFX "Failed to allocate virtual memory area for atomic ioremap.\n");
 189                 return -ENOMEM;
 190         }
 191
 192         return 0;
 193 }
 194
 195 static void ghes_ioremap_exit(void)
 196 {
 197         free_vm_area(ghes_ioremap_area);
 198 }
 199
 200 static void __iomem *ghes_ioremap_pfn_nmi(u64 pfn)
 201 {
 202         unsigned long vaddr;
 203
 204         vaddr = (unsigned long)GHES_IOREMAP_NMI_PAGE(ghes_ioremap_area->addr);
 205         ioremap_page_range(vaddr, vaddr + PAGE_SIZE,
 206                            pfn << PAGE_SHIFT, PAGE_KERNEL);
 207
 208         return (void __iomem *)vaddr;
 209 }
 210
 211 static void __iomem *ghes_ioremap_pfn_irq(u64 pfn)
 212 {
 213         unsigned long vaddr;
 214
 215         vaddr = (unsigned long)GHES_IOREMAP_IRQ_PAGE(ghes_ioremap_area->addr);
 216         ioremap_page_range(vaddr, vaddr + PAGE_SIZE,
 217                            pfn << PAGE_SHIFT, PAGE_KERNEL);
 218
 219         return (void __iomem *)vaddr;
 220 }
 221
 222 static void ghes_iounmap_nmi(void __iomem *vaddr_ptr)
 223 {
 224         unsigned long vaddr = (unsigned long __force)vaddr_ptr;
 225         void *base = ghes_ioremap_area->addr;
 226
 227         BUG_ON(vaddr != (unsigned long)GHES_IOREMAP_NMI_PAGE(base));
 228         unmap_kernel_range_noflush(vaddr, PAGE_SIZE);
 229         __flush_tlb_one(vaddr);
 230 }
 231
 232 static void ghes_iounmap_irq(void __iomem *vaddr_ptr)
 233 {
 234         unsigned long vaddr = (unsigned long __force)vaddr_ptr;
 235         void *base = ghes_ioremap_area->addr;
 236
 237         BUG_ON(vaddr != (unsigned long)GHES_IOREMAP_IRQ_PAGE(base));
 238         unmap_kernel_range_noflush(vaddr, PAGE_SIZE);
 239         __flush_tlb_one(vaddr);
 240 }
 241
 242 static int ghes_estatus_pool_init(void)
 243 {
 244         ghes_estatus_pool = gen_pool_create(GHES_ESTATUS_POOL_MIN_ALLOC_ORDER, -1);
 245         if (!ghes_estatus_pool)
 246                 return -ENOMEM;
 247         return 0;
 248 }
 249
 250 static void ghes_estatus_pool_free_chunk_page(struct gen_pool *pool,
 251                                               struct gen_pool_chunk *chunk,
 252                                               void *data)
 253 {
 254         free_page(chunk->start_addr);
 255 }
 256
 257 static void ghes_estatus_pool_exit(void)
 258 {
 259         gen_pool_for_each_chunk(ghes_estatus_pool,
 260                                 ghes_estatus_pool_free_chunk_page, NULL);
 261         gen_pool_destroy(ghes_estatus_pool);
 262 }
 263
 264 static int ghes_estatus_pool_expand(unsigned long len)
 265 {
 266         unsigned long i, pages, size, addr;
 267         int ret;
 268
 269         ghes_estatus_pool_size_request += PAGE_ALIGN(len);
 270         size = gen_pool_size(ghes_estatus_pool);
 271         if (size >= ghes_estatus_pool_size_request)
 272                 return 0;
 273         pages = (ghes_estatus_pool_size_request - size) / PAGE_SIZE;
 274         for (i = 0; i < pages; i++) {
 275                 addr = __get_free_page(GFP_KERNEL);
 276                 if (!addr)
 277                         return -ENOMEM;
 278                 ret = gen_pool_add(ghes_estatus_pool, addr, PAGE_SIZE, -1);
 279                 if (ret)
 280                         return ret;
 281         }
 282
 283         return 0;
 284 }
 285
 286 static void ghes_estatus_pool_shrink(unsigned long len)
 287 {
 288         ghes_estatus_pool_size_request -= PAGE_ALIGN(len);
 289 }
 290
 291 static struct ghes *ghes_new(struct acpi_hest_generic *generic)
 292 {
 293         struct ghes *ghes;
 294         unsigned int error_block_length;
 295         int rc;
 296
 297         ghes = kzalloc(sizeof(*ghes), GFP_KERNEL);
 298         if (!ghes)
 299                 return ERR_PTR(-ENOMEM);
 300         ghes->generic = generic;
 301         rc = acpi_pre_map_gar(&generic->error_status_address);
 302         if (rc)
 303                 goto err_free;
 304         error_block_length = generic->error_block_length;
 305         if (error_block_length > GHES_ESTATUS_MAX_SIZE) {
 306                 pr_warning(FW_WARN GHES_PFX
 307                            "Error status block length is too long: %u for "
 308                            "generic hardware error source: %d.\n",
 309                            error_block_length, generic->header.source_id);
 310                 error_block_length = GHES_ESTATUS_MAX_SIZE;
 311         }
 312         ghes->estatus = kmalloc(error_block_length, GFP_KERNEL);
 313         if (!ghes->estatus) {
 314                 rc = -ENOMEM;
 315                 goto err_unmap;
 316         }
 317
 318         return ghes;
 319
 320 err_unmap:
 321         acpi_post_unmap_gar(&generic->error_status_address);
 322 err_free:
 323         kfree(ghes);
 324         return ERR_PTR(rc);
 325 }
 326
 327 static void ghes_fini(struct ghes *ghes)
 328 {
 329         kfree(ghes->estatus);
 330         acpi_post_unmap_gar(&ghes->generic->error_status_address);
 331 }
 332
 333 enum {
 334         GHES_SEV_NO = 0x0,
 335         GHES_SEV_CORRECTED = 0x1,
 336         GHES_SEV_RECOVERABLE = 0x2,
 337         GHES_SEV_PANIC = 0x3,
 338 };
 339
 340 static inline int ghes_severity(int severity)
 341 {
 342         switch (severity) {
 343         case CPER_SEV_INFORMATIONAL:
 344                 return GHES_SEV_NO;
 345         case CPER_SEV_CORRECTED:
 346                 return GHES_SEV_CORRECTED;
 347         case CPER_SEV_RECOVERABLE:
 348                 return GHES_SEV_RECOVERABLE;
 349         case CPER_SEV_FATAL:
 350                 return GHES_SEV_PANIC;
 351         default:
 352                 /* Unknown, go panic */
 353                 return GHES_SEV_PANIC;
 354         }
 355 }
 356
 357 static void ghes_copy_tofrom_phys(void *buffer, u64 paddr, u32 len,
 358                                   int from_phys)
 359 {
 360         void __iomem *vaddr;
 361         unsigned long flags = 0;
 362         int in_nmi = in_nmi();
 363         u64 offset;
 364         u32 trunk;
 365
 366         while (len > 0) {
 367                 offset = paddr - (paddr & PAGE_MASK);
 368                 if (in_nmi) {
 369                         raw_spin_lock(&ghes_ioremap_lock_nmi);
 370                         vaddr = ghes_ioremap_pfn_nmi(paddr >> PAGE_SHIFT);
 371                 } else {
 372                         spin_lock_irqsave(&ghes_ioremap_lock_irq, flags);
 373                         vaddr = ghes_ioremap_pfn_irq(paddr >> PAGE_SHIFT);
 374                 }
 375                 trunk = PAGE_SIZE - offset;
 376                 trunk = min(trunk, len);
 377                 if (from_phys)
 378                         memcpy_fromio(buffer, vaddr + offset, trunk);
 379                 else
 380                         memcpy_toio(vaddr + offset, buffer, trunk);
 381                 len -= trunk;
 382                 paddr += trunk;
 383                 buffer += trunk;
 384                 if (in_nmi) {
 385                         ghes_iounmap_nmi(vaddr);
 386                         raw_spin_unlock(&ghes_ioremap_lock_nmi);
 387                 } else {
 388                         ghes_iounmap_irq(vaddr);
 389                         spin_unlock_irqrestore(&ghes_ioremap_lock_irq, flags);
 390                 }
 391         }
 392 }
 393
 394 static int ghes_read_estatus(struct ghes *ghes, int silent)
 395 {
 396         struct acpi_hest_generic *g = ghes->generic;
 397         u64 buf_paddr;
 398         u32 len;
 399         int rc;
 400
 401         rc = acpi_atomic_read(&buf_paddr, &g->error_status_address);
 402         if (rc) {
 403                 if (!silent && printk_ratelimit())
 404                         pr_warning(FW_WARN GHES_PFX
 405 "Failed to read error status block address for hardware error source: %d.\n",
 406                                    g->header.source_id);
 407                 return -EIO;
 408         }
 409         if (!buf_paddr)
 410                 return -ENOENT;
 411
 412         ghes_copy_tofrom_phys(ghes->estatus, buf_paddr,
 413                               sizeof(*ghes->estatus), 1);
 414         if (!ghes->estatus->block_status)
 415                 return -ENOENT;
 416
 417         ghes->buffer_paddr = buf_paddr;
 418         ghes->flags |= GHES_TO_CLEAR;
 419
 420         rc = -EIO;
 421         len = apei_estatus_len(ghes->estatus);
 422         if (len < sizeof(*ghes->estatus))
 423                 goto err_read_block;
 424         if (len > ghes->generic->error_block_length)
 425                 goto err_read_block;
 426         if (apei_estatus_check_header(ghes->estatus))
 427                 goto err_read_block;
 428         ghes_copy_tofrom_phys(ghes->estatus + 1,
 429                               buf_paddr + sizeof(*ghes->estatus),
 430                               len - sizeof(*ghes->estatus), 1);
 431         if (apei_estatus_check(ghes->estatus))
 432                 goto err_read_block;
 433         rc = 0;
 434
 435 err_read_block:
 436         if (rc && !silent && printk_ratelimit())
 437                 pr_warning(FW_WARN GHES_PFX
 438                            "Failed to read error status block!\n");
 439         return rc;
 440 }
 441
 442 static void ghes_clear_estatus(struct ghes *ghes)
 443 {
 444         ghes->estatus->block_status = 0;
 445         if (!(ghes->flags & GHES_TO_CLEAR))
 446                 return;
 447         ghes_copy_tofrom_phys(ghes->estatus, ghes->buffer_paddr,
 448                               sizeof(ghes->estatus->block_status), 0);
 449         ghes->flags &= ~GHES_TO_CLEAR;
 450 }
 451
 452 static void ghes_do_proc(const struct acpi_hest_generic_status *estatus)
 453 {
 454         int sev, processed = 0;
 455         struct acpi_hest_generic_data *gdata;
 456
 457         sev = ghes_severity(estatus->error_severity);
 458         apei_estatus_for_each_section(estatus, gdata) {
 459 #ifdef CONFIG_X86_MCE
 460                 if (!uuid_le_cmp(*(uuid_le *)gdata->section_type,
 461                                  CPER_SEC_PLATFORM_MEM)) {
 462                         apei_mce_report_mem_error(
 463                                 sev == GHES_SEV_CORRECTED,
 464                                 (struct cper_sec_mem_err *)(gdata+1));
 465                         processed = 1;
 466                 }
 467 #endif
 468         }
 469 }
 470
 471 static void __ghes_print_estatus(const char *pfx,
 472                                  const struct acpi_hest_generic *generic,
 473                                  const struct acpi_hest_generic_status *estatus)
 474 {
 475         if (pfx == NULL) {
 476                 if (ghes_severity(estatus->error_severity) <=
 477                     GHES_SEV_CORRECTED)
 478                         pfx = KERN_WARNING HW_ERR;
 479                 else
 480                         pfx = KERN_ERR HW_ERR;
 481         }
 482         printk("%s""Hardware error from APEI Generic Hardware Error Source: %d\n",
 483                pfx, generic->header.source_id);
 484         apei_estatus_print(pfx, estatus);
 485 }
 486
 487 static int ghes_print_estatus(const char *pfx,
 488                               const struct acpi_hest_generic *generic,
 489                               const struct acpi_hest_generic_status *estatus)
 490 {
 491         /* Not more than 2 messages every 5 seconds */
 492         static DEFINE_RATELIMIT_STATE(ratelimit_corrected, 5*HZ, 2);
 493         static DEFINE_RATELIMIT_STATE(ratelimit_uncorrected, 5*HZ, 2);
 494         struct ratelimit_state *ratelimit;
 495
 496         if (ghes_severity(estatus->error_severity) <= GHES_SEV_CORRECTED)
 497                 ratelimit = &ratelimit_corrected;
 498         else
 499                 ratelimit = &ratelimit_uncorrected;
 500         if (__ratelimit(ratelimit)) {
 501                 __ghes_print_estatus(pfx, generic, estatus);
 502                 return 1;
 503         }
 504         return 0;
 505 }
 506
 507 /*
 508  * GHES error status reporting throttle, to report more kinds of
 509  * errors, instead of just most frequently occurred errors.
 510  */
 511 static int ghes_estatus_cached(struct acpi_hest_generic_status *estatus)
 512 {
 513         u32 len;
 514         int i, cached = 0;
 515         unsigned long long now;
 516         struct ghes_estatus_cache *cache;
 517         struct acpi_hest_generic_status *cache_estatus;
 518
 519         len = apei_estatus_len(estatus);
 520         rcu_read_lock();
 521         for (i = 0; i < GHES_ESTATUS_CACHES_SIZE; i++) {
 522                 cache = rcu_dereference(ghes_estatus_caches[i]);
 523                 if (cache == NULL)
 524                         continue;
 525                 if (len != cache->estatus_len)
 526                         continue;
 527                 cache_estatus = GHES_ESTATUS_FROM_CACHE(cache);
 528                 if (memcmp(estatus, cache_estatus, len))
 529                         continue;
 530                 atomic_inc(&cache->count);
 531                 now = sched_clock();
 532                 if (now - cache->time_in < GHES_ESTATUS_IN_CACHE_MAX_NSEC)
 533                         cached = 1;
 534                 break;
 535         }
 536         rcu_read_unlock();
 537         return cached;
 538 }
 539
 540 static struct ghes_estatus_cache *ghes_estatus_cache_alloc(
 541         struct acpi_hest_generic *generic,
 542         struct acpi_hest_generic_status *estatus)
 543 {
 544         int alloced;
 545         u32 len, cache_len;
 546         struct ghes_estatus_cache *cache;
 547         struct acpi_hest_generic_status *cache_estatus;
 548
 549         alloced = atomic_add_return(1, &ghes_estatus_cache_alloced);
 550         if (alloced > GHES_ESTATUS_CACHE_ALLOCED_MAX) {
 551                 atomic_dec(&ghes_estatus_cache_alloced);
 552                 return NULL;
 553         }
 554         len = apei_estatus_len(estatus);
 555         cache_len = GHES_ESTATUS_CACHE_LEN(len);
 556         cache = (void *)gen_pool_alloc(ghes_estatus_pool, cache_len);
 557         if (!cache) {
 558                 atomic_dec(&ghes_estatus_cache_alloced);
 559                 return NULL;
 560         }
 561         cache_estatus = GHES_ESTATUS_FROM_CACHE(cache);
 562         memcpy(cache_estatus, estatus, len);
 563         cache->estatus_len = len;
 564         atomic_set(&cache->count, 0);
 565         cache->generic = generic;
 566         cache->time_in = sched_clock();
 567         return cache;
 568 }
 569
 570 static void ghes_estatus_cache_free(struct ghes_estatus_cache *cache)
 571 {
 572         u32 len;
 573
 574         len = apei_estatus_len(GHES_ESTATUS_FROM_CACHE(cache));
 575         len = GHES_ESTATUS_CACHE_LEN(len);
 576         gen_pool_free(ghes_estatus_pool, (unsigned long)cache, len);
 577         atomic_dec(&ghes_estatus_cache_alloced);
 578 }
 579
 580 static void ghes_estatus_cache_rcu_free(struct rcu_head *head)
 581 {
 582         struct ghes_estatus_cache *cache;
 583
 584         cache = container_of(head, struct ghes_estatus_cache, rcu);
 585         ghes_estatus_cache_free(cache);
 586 }
 587
 588 static void ghes_estatus_cache_add(
 589         struct acpi_hest_generic *generic,
 590         struct acpi_hest_generic_status *estatus)
 591 {
 592         int i, slot = -1, count;
 593         unsigned long long now, duration, period, max_period = 0;
 594         struct ghes_estatus_cache *cache, *slot_cache = NULL, *new_cache;
 595
 596         new_cache = ghes_estatus_cache_alloc(generic, estatus);
 597         if (new_cache == NULL)
 598                 return;
 599         rcu_read_lock();
 600         now = sched_clock();
 601         for (i = 0; i < GHES_ESTATUS_CACHES_SIZE; i++) {
 602                 cache = rcu_dereference(ghes_estatus_caches[i]);
 603                 if (cache == NULL) {
 604                         slot = i;
 605                         slot_cache = NULL;
 606                         break;
 607                 }
 608                 duration = now - cache->time_in;
 609                 if (duration >= GHES_ESTATUS_IN_CACHE_MAX_NSEC) {
 610                         slot = i;
 611                         slot_cache = cache;
 612                         break;
 613                 }
 614                 count = atomic_read(&cache->count);
 615                 period = duration / (count + 1);
 616                 if (period > max_period) {
 617                         max_period = period;
 618                         slot = i;
 619                         slot_cache = cache;
 620                 }
 621         }
 622         /* new_cache must be put into array after its contents are written */
 623         smp_wmb();
 624         if (slot != -1 && cmpxchg(ghes_estatus_caches + slot,
 625                                   slot_cache, new_cache) == slot_cache) {
 626                 if (slot_cache)
 627                         call_rcu(&slot_cache->rcu, ghes_estatus_cache_rcu_free);
 628         } else
 629                 ghes_estatus_cache_free(new_cache);
 630         rcu_read_unlock();
 631 }
 632
 633 static int ghes_proc(struct ghes *ghes)
 634 {
 635         int rc;
 636
 637         rc = ghes_read_estatus(ghes, 0);
 638         if (rc)
 639                 goto out;
 640         if (!ghes_estatus_cached(ghes->estatus)) {
 641                 if (ghes_print_estatus(NULL, ghes->generic, ghes->estatus))
 642                         ghes_estatus_cache_add(ghes->generic, ghes->estatus);
 643         }
 644         ghes_do_proc(ghes->estatus);
 645 out:
 646         ghes_clear_estatus(ghes);
 647         return 0;
 648 }
 649
 650 static void ghes_add_timer(struct ghes *ghes)
 651 {
 652         struct acpi_hest_generic *g = ghes->generic;
 653         unsigned long expire;
 654
 655         if (!g->notify.poll_interval) {
 656                 pr_warning(FW_WARN GHES_PFX "Poll interval is 0 for generic hardware error source: %d, disabled.\n",
 657                            g->header.source_id);
 658                 return;
 659         }
 660         expire = jiffies + msecs_to_jiffies(g->notify.poll_interval);
 661         ghes->timer.expires = round_jiffies_relative(expire);
 662         add_timer(&ghes->timer);
 663 }
 664
 665 static void ghes_poll_func(unsigned long data)
 666 {
 667         struct ghes *ghes = (void *)data;
 668
 669         ghes_proc(ghes);
 670         if (!(ghes->flags & GHES_EXITING))
 671                 ghes_add_timer(ghes);
 672 }
 673
 674 static irqreturn_t ghes_irq_func(int irq, void *data)
 675 {
 676         struct ghes *ghes = data;
 677         int rc;
 678
 679         rc = ghes_proc(ghes);
 680         if (rc)
 681                 return IRQ_NONE;
 682
 683         return IRQ_HANDLED;
 684 }
 685
 686 static int ghes_notify_sci(struct notifier_block *this,
 687                                   unsigned long event, void *data)
 688 {
 689         struct ghes *ghes;
 690         int ret = NOTIFY_DONE;
 691
 692         rcu_read_lock();
 693         list_for_each_entry_rcu(ghes, &ghes_sci, list) {
 694                 if (!ghes_proc(ghes))
 695                         ret = NOTIFY_OK;
 696         }
 697         rcu_read_unlock();
 698
 699         return ret;
 700 }
 701
 702 static void ghes_proc_in_irq(struct irq_work *irq_work)
 703 {
 704         struct llist_node *llnode, *next, *tail = NULL;
 705         struct ghes_estatus_node *estatus_node;
 706         struct acpi_hest_generic *generic;
 707         struct acpi_hest_generic_status *estatus;
 708         u32 len, node_len;
 709
 710         /*
 711          * Because the time order of estatus in list is reversed,
 712          * revert it back to proper order.
 713          */
 714         llnode = llist_del_all(&ghes_estatus_llist);
 715         while (llnode) {
 716                 next = llnode->next;
 717                 llnode->next = tail;
 718                 tail = llnode;
 719                 llnode = next;
 720         }
 721         llnode = tail;
 722         while (llnode) {
 723                 next = llnode->next;
 724                 estatus_node = llist_entry(llnode, struct ghes_estatus_node,
 725                                            llnode);
 726                 estatus = GHES_ESTATUS_FROM_NODE(estatus_node);
 727                 len = apei_estatus_len(estatus);
 728                 node_len = GHES_ESTATUS_NODE_LEN(len);
 729                 ghes_do_proc(estatus);
 730                 if (!ghes_estatus_cached(estatus)) {
 731                         generic = estatus_node->generic;
 732                         if (ghes_print_estatus(NULL, generic, estatus))
 733                                 ghes_estatus_cache_add(generic, estatus);
 734                 }
 735                 gen_pool_free(ghes_estatus_pool, (unsigned long)estatus_node,
 736                               node_len);
 737                 llnode = next;
 738         }
 739 }
 740
 741 static int ghes_notify_nmi(struct notifier_block *this,
 742                                   unsigned long cmd, void *data)
 743 {
 744         struct ghes *ghes, *ghes_global = NULL;
 745         int sev, sev_global = -1;
 746         int ret = NOTIFY_DONE;
 747
 748         if (cmd != DIE_NMI)
 749                 return ret;
 750
 751         raw_spin_lock(&ghes_nmi_lock);
 752         list_for_each_entry_rcu(ghes, &ghes_nmi, list) {
 753                 if (ghes_read_estatus(ghes, 1)) {
 754                         ghes_clear_estatus(ghes);
 755                         continue;
 756                 }
 757                 sev = ghes_severity(ghes->estatus->error_severity);
 758                 if (sev > sev_global) {
 759                         sev_global = sev;
 760                         ghes_global = ghes;
 761                 }
 762                 ret = NOTIFY_STOP;
 763         }
 764
 765         if (ret == NOTIFY_DONE)
 766                 goto out;
 767
 768         if (sev_global >= GHES_SEV_PANIC) {
 769                 oops_begin();
 770                 __ghes_print_estatus(KERN_EMERG HW_ERR, ghes_global->generic,
 771                                      ghes_global->estatus);
 772                 /* reboot to log the error! */
 773                 if (panic_timeout == 0)
 774                         panic_timeout = ghes_panic_timeout;
 775                 panic("Fatal hardware error!");
 776         }
 777
 778         list_for_each_entry_rcu(ghes, &ghes_nmi, list) {
 779 #ifdef CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG
 780                 u32 len, node_len;
 781                 struct ghes_estatus_node *estatus_node;
 782                 struct acpi_hest_generic_status *estatus;
 783 #endif
 784                 if (!(ghes->flags & GHES_TO_CLEAR))
 785                         continue;
 786 #ifdef CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG
 787                 if (ghes_estatus_cached(ghes->estatus))
 788                         goto next;
 789                 /* Save estatus for further processing in IRQ context */
 790                 len = apei_estatus_len(ghes->estatus);
 791                 node_len = GHES_ESTATUS_NODE_LEN(len);
 792                 estatus_node = (void *)gen_pool_alloc(ghes_estatus_pool,
 793                                                       node_len);
 794                 if (estatus_node) {
 795                         estatus_node->generic = ghes->generic;
 796                         estatus = GHES_ESTATUS_FROM_NODE(estatus_node);
 797                         memcpy(estatus, ghes->estatus, len);
 798                         llist_add(&estatus_node->llnode, &ghes_estatus_llist);
 799                 }
 800 next:
 801 #endif
 802                 ghes_clear_estatus(ghes);
 803         }
 804 #ifdef CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG
 805         irq_work_queue(&ghes_proc_irq_work);
 806 #endif
 807
 808 out:
 809         raw_spin_unlock(&ghes_nmi_lock);
 810         return ret;
 811 }
 812
 813 static struct notifier_block ghes_notifier_sci = {
 814         .notifier_call = ghes_notify_sci,
 815 };
 816
 817 static struct notifier_block ghes_notifier_nmi = {
 818         .notifier_call = ghes_notify_nmi,
 819 };
 820
 821 static unsigned long ghes_esource_prealloc_size(
 822         const struct acpi_hest_generic *generic)
 823 {
 824         unsigned long block_length, prealloc_records, prealloc_size;
 825
 826         block_length = min_t(unsigned long, generic->error_block_length,
 827                              GHES_ESTATUS_MAX_SIZE);
 828         prealloc_records = max_t(unsigned long,
 829                                  generic->records_to_preallocate, 1);
 830         prealloc_size = min_t(unsigned long, block_length * prealloc_records,
 831                               GHES_ESOURCE_PREALLOC_MAX_SIZE);
 832
 833         return prealloc_size;
 834 }
 835
 836 static int __devinit ghes_probe(struct platform_device *ghes_dev)
 837 {
 838         struct acpi_hest_generic *generic;
 839         struct ghes *ghes = NULL;
 840         unsigned long len;
 841         int rc = -EINVAL;
 842
 843         generic = *(struct acpi_hest_generic **)ghes_dev->dev.platform_data;
 844         if (!generic->enabled)
 845                 return -ENODEV;
 846
 847         switch (generic->notify.type) {
 848         case ACPI_HEST_NOTIFY_POLLED:
 849         case ACPI_HEST_NOTIFY_EXTERNAL:
 850         case ACPI_HEST_NOTIFY_SCI:
 851         case ACPI_HEST_NOTIFY_NMI:
 852                 break;
 853         case ACPI_HEST_NOTIFY_LOCAL:
 854                 pr_warning(GHES_PFX "Generic hardware error source: %d notified via local interrupt is not supported!\n",
 855                            generic->header.source_id);
 856                 goto err;
 857         default:
 858                 pr_warning(FW_WARN GHES_PFX "Unknown notification type: %u for generic hardware error source: %d\n",
 859                            generic->notify.type, generic->header.source_id);
 860                 goto err;
 861         }
 862
 863         rc = -EIO;
 864         if (generic->error_block_length <
 865             sizeof(struct acpi_hest_generic_status)) {
 866                 pr_warning(FW_BUG GHES_PFX "Invalid error block length: %u for generic hardware error source: %d\n",
 867                            generic->error_block_length,
 868                            generic->header.source_id);
 869                 goto err;
 870         }
 871         ghes = ghes_new(generic);
 872         if (IS_ERR(ghes)) {
 873                 rc = PTR_ERR(ghes);
 874                 ghes = NULL;
 875                 goto err;
 876         }
 877         switch (generic->notify.type) {
 878         case ACPI_HEST_NOTIFY_POLLED:
 879                 ghes->timer.function = ghes_poll_func;
 880                 ghes->timer.data = (unsigned long)ghes;
 881                 init_timer_deferrable(&ghes->timer);
 882                 ghes_add_timer(ghes);
 883                 break;
 884         case ACPI_HEST_NOTIFY_EXTERNAL:
 885                 /* External interrupt vector is GSI */
 886                 if (acpi_gsi_to_irq(generic->notify.vector, &ghes->irq)) {
 887                         pr_err(GHES_PFX "Failed to map GSI to IRQ for generic hardware error source: %d\n",
 888                                generic->header.source_id);
 889                         goto err;
 890                 }
 891                 if (request_irq(ghes->irq, ghes_irq_func,
 892                                 0, "GHES IRQ", ghes)) {
 893                         pr_err(GHES_PFX "Failed to register IRQ for generic hardware error source: %d\n",
 894                                generic->header.source_id);
 895                         goto err;
 896                 }
 897                 break;
 898         case ACPI_HEST_NOTIFY_SCI:
 899                 mutex_lock(&ghes_list_mutex);
 900                 if (list_empty(&ghes_sci))
 901                         register_acpi_hed_notifier(&ghes_notifier_sci);
 902                 list_add_rcu(&ghes->list, &ghes_sci);
 903                 mutex_unlock(&ghes_list_mutex);
 904                 break;
 905         case ACPI_HEST_NOTIFY_NMI:
 906                 len = ghes_esource_prealloc_size(generic);
 907                 ghes_estatus_pool_expand(len);
 908                 mutex_lock(&ghes_list_mutex);
 909                 if (list_empty(&ghes_nmi))
 910                         register_die_notifier(&ghes_notifier_nmi);
 911                 list_add_rcu(&ghes->list, &ghes_nmi);
 912                 mutex_unlock(&ghes_list_mutex);
 913                 break;
 914         default:
 915                 BUG();
 916         }
 917         platform_set_drvdata(ghes_dev, ghes);
 918
 919         return 0;
 920 err:
 921         if (ghes) {
 922                 ghes_fini(ghes);
 923                 kfree(ghes);
 924         }
 925         return rc;
 926 }
 927
 928 static int __devexit ghes_remove(struct platform_device *ghes_dev)
 929 {
 930         struct ghes *ghes;
 931         struct acpi_hest_generic *generic;
 932         unsigned long len;
 933
 934         ghes = platform_get_drvdata(ghes_dev);
 935         generic = ghes->generic;
 936
 937         ghes->flags |= GHES_EXITING;
 938         switch (generic->notify.type) {
 939         case ACPI_HEST_NOTIFY_POLLED:
 940                 del_timer_sync(&ghes->timer);
 941                 break;
 942         case ACPI_HEST_NOTIFY_EXTERNAL:
 943                 free_irq(ghes->irq, ghes);
 944                 break;
 945         case ACPI_HEST_NOTIFY_SCI:
 946                 mutex_lock(&ghes_list_mutex);
 947                 list_del_rcu(&ghes->list);
 948                 if (list_empty(&ghes_sci))
 949                         unregister_acpi_hed_notifier(&ghes_notifier_sci);
 950                 mutex_unlock(&ghes_list_mutex);
 951                 break;
 952         case ACPI_HEST_NOTIFY_NMI:
 953                 mutex_lock(&ghes_list_mutex);
 954                 list_del_rcu(&ghes->list);
 955                 if (list_empty(&ghes_nmi))
 956                         unregister_die_notifier(&ghes_notifier_nmi);
 957                 mutex_unlock(&ghes_list_mutex);
 958                 /*
 959                  * To synchronize with NMI handler, ghes can only be
 960                  * freed after NMI handler finishes.
 961                  */
 962                 synchronize_rcu();
 963                 len = ghes_esource_prealloc_size(generic);
 964                 ghes_estatus_pool_shrink(len);
 965                 break;
 966         default:
 967                 BUG();
 968                 break;
 969         }
 970
 971         ghes_fini(ghes);
 972         kfree(ghes);
 973
 974         platform_set_drvdata(ghes_dev, NULL);
 975
 976         return 0;
 977 }
 978
 979 static struct platform_driver ghes_platform_driver = {
 980         .driver         = {
 981                 .name   = "GHES",
 982                 .owner  = THIS_MODULE,
 983         },
 984         .probe          = ghes_probe,
 985         .remove         = ghes_remove,
 986 };
 987
 988 static int __init ghes_init(void)
 989 {
 990         int rc;
 991
 992         if (acpi_disabled)
 993                 return -ENODEV;
 994
 995         if (hest_disable) {
 996                 pr_info(GHES_PFX "HEST is not enabled!\n");
 997                 return -EINVAL;
 998         }
 999
1000         if (ghes_disable) {
1001                 pr_info(GHES_PFX "GHES is not enabled!\n");
1002                 return -EINVAL;
1003         }
1004
1005         init_irq_work(&ghes_proc_irq_work, ghes_proc_in_irq);
1006
1007         rc = ghes_ioremap_init();
1008         if (rc)
1009                 goto err;
1010
1011         rc = ghes_estatus_pool_init();
1012         if (rc)
1013                 goto err_ioremap_exit;
1014
1015         rc = ghes_estatus_pool_expand(GHES_ESTATUS_CACHE_AVG_SIZE *
1016                                       GHES_ESTATUS_CACHE_ALLOCED_MAX);
1017         if (rc)
1018                 goto err_pool_exit;
1019
1020         rc = platform_driver_register(&ghes_platform_driver);
1021         if (rc)
1022                 goto err_pool_exit;
1023
1024         rc = apei_osc_setup();
1025         if (rc == 0 && osc_sb_apei_support_acked)
1026                 pr_info(GHES_PFX "APEI firmware first mode is enabled by APEI bit and WHEA _OSC.\n");
1027         else if (rc == 0 && !osc_sb_apei_support_acked)
1028                 pr_info(GHES_PFX "APEI firmware first mode is enabled by WHEA _OSC.\n");
1029         else if (rc && osc_sb_apei_support_acked)
1030                 pr_info(GHES_PFX "APEI firmware first mode is enabled by APEI bit.\n");
1031         else
1032                 pr_info(GHES_PFX "Failed to enable APEI firmware first mode.\n");
1033
1034         return 0;
1035 err_pool_exit:
1036         ghes_estatus_pool_exit();
1037 err_ioremap_exit:
1038         ghes_ioremap_exit();
1039 err:
1040         return rc;
1041 }
1042
1043 static void __exit ghes_exit(void)
1044 {
1045         platform_driver_unregister(&ghes_platform_driver);
1046         ghes_estatus_pool_exit();
1047         ghes_ioremap_exit();
1048 }
1049
1050 module_init(ghes_init);
1051 module_exit(ghes_exit);
1052
1053 MODULE_AUTHOR("Huang Ying");
1054 MODULE_DESCRIPTION("APEI Generic Hardware Error Source support");
1055 MODULE_LICENSE("GPL");
1056 MODULE_ALIAS("platform:GHES");