drivers/acpi/nfit.c

   1 /*
   2  * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of version 2 of the GNU General Public License as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  */
  13 #include <linux/list_sort.h>
  14 #include <linux/libnvdimm.h>
  15 #include <linux/module.h>
  16 #include <linux/mutex.h>
  17 #include <linux/ndctl.h>
  18 #include <linux/delay.h>
  19 #include <linux/list.h>
  20 #include <linux/acpi.h>
  21 #include <linux/sort.h>
  22 #include <linux/pmem.h>
  23 #include <linux/io.h>
  24 #include <asm/cacheflush.h>
  25 #include "nfit.h"
  26
  27 /*
  28  * For readq() and writeq() on 32-bit builds, the hi-lo, lo-hi order is
  29  * irrelevant.
  30  */
  31 #include <linux/io-64-nonatomic-hi-lo.h>
  32
  33 static bool force_enable_dimms;
  34 module_param(force_enable_dimms, bool, S_IRUGO|S_IWUSR);
  35 MODULE_PARM_DESC(force_enable_dimms, "Ignore _STA (ACPI DIMM device) status");
  36
  37 struct nfit_table_prev {
  38         struct list_head spas;
  39         struct list_head memdevs;
  40         struct list_head dcrs;
  41         struct list_head bdws;
  42         struct list_head idts;
  43         struct list_head flushes;
  44 };
  45
  46 static u8 nfit_uuid[NFIT_UUID_MAX][16];
  47
  48 const u8 *to_nfit_uuid(enum nfit_uuids id)
  49 {
  50         return nfit_uuid[id];
  51 }
  52 EXPORT_SYMBOL(to_nfit_uuid);
  53
  54 static struct acpi_nfit_desc *to_acpi_nfit_desc(
  55                 struct nvdimm_bus_descriptor *nd_desc)
  56 {
  57         return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
  58 }
  59
  60 static struct acpi_device *to_acpi_dev(struct acpi_nfit_desc *acpi_desc)
  61 {
  62         struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
  63
  64         /*
  65          * If provider == 'ACPI.NFIT' we can assume 'dev' is a struct
  66          * acpi_device.
  67          */
  68         if (!nd_desc->provider_name
  69                         || strcmp(nd_desc->provider_name, "ACPI.NFIT") != 0)
  70                 return NULL;
  71
  72         return to_acpi_device(acpi_desc->dev);
  73 }
  74
  75 static int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc,
  76                 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
  77                 unsigned int buf_len)
  78 {
  79         struct acpi_nfit_desc *acpi_desc = to_acpi_nfit_desc(nd_desc);
  80         const struct nd_cmd_desc *desc = NULL;
  81         union acpi_object in_obj, in_buf, *out_obj;
  82         struct device *dev = acpi_desc->dev;
  83         const char *cmd_name, *dimm_name;
  84         unsigned long dsm_mask;
  85         acpi_handle handle;
  86         const u8 *uuid;
  87         u32 offset;
  88         int rc, i;
  89
  90         if (nvdimm) {
  91                 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
  92                 struct acpi_device *adev = nfit_mem->adev;
  93
  94                 if (!adev)
  95                         return -ENOTTY;
  96                 dimm_name = nvdimm_name(nvdimm);
  97                 cmd_name = nvdimm_cmd_name(cmd);
  98                 dsm_mask = nfit_mem->dsm_mask;
  99                 desc = nd_cmd_dimm_desc(cmd);
 100                 uuid = to_nfit_uuid(NFIT_DEV_DIMM);
 101                 handle = adev->handle;
 102         } else {
 103                 struct acpi_device *adev = to_acpi_dev(acpi_desc);
 104
 105                 cmd_name = nvdimm_bus_cmd_name(cmd);
 106                 dsm_mask = nd_desc->dsm_mask;
 107                 desc = nd_cmd_bus_desc(cmd);
 108                 uuid = to_nfit_uuid(NFIT_DEV_BUS);
 109                 handle = adev->handle;
 110                 dimm_name = "bus";
 111         }
 112
 113         if (!desc || (cmd && (desc->out_num + desc->in_num == 0)))
 114                 return -ENOTTY;
 115
 116         if (!test_bit(cmd, &dsm_mask))
 117                 return -ENOTTY;
 118
 119         in_obj.type = ACPI_TYPE_PACKAGE;
 120         in_obj.package.count = 1;
 121         in_obj.package.elements = &in_buf;
 122         in_buf.type = ACPI_TYPE_BUFFER;
 123         in_buf.buffer.pointer = buf;
 124         in_buf.buffer.length = 0;
 125
 126         /* libnvdimm has already validated the input envelope */
 127         for (i = 0; i < desc->in_num; i++)
 128                 in_buf.buffer.length += nd_cmd_in_size(nvdimm, cmd, desc,
 129                                 i, buf);
 130
 131         if (IS_ENABLED(CONFIG_ACPI_NFIT_DEBUG)) {
 132                 dev_dbg(dev, "%s:%s cmd: %s input length: %d\n", __func__,
 133                                 dimm_name, cmd_name, in_buf.buffer.length);
 134                 print_hex_dump_debug(cmd_name, DUMP_PREFIX_OFFSET, 4,
 135                                 4, in_buf.buffer.pointer, min_t(u32, 128,
 136                                         in_buf.buffer.length), true);
 137         }
 138
 139         out_obj = acpi_evaluate_dsm(handle, uuid, 1, cmd, &in_obj);
 140         if (!out_obj) {
 141                 dev_dbg(dev, "%s:%s _DSM failed cmd: %s\n", __func__, dimm_name,
 142                                 cmd_name);
 143                 return -EINVAL;
 144         }
 145
 146         if (out_obj->package.type != ACPI_TYPE_BUFFER) {
 147                 dev_dbg(dev, "%s:%s unexpected output object type cmd: %s type: %d\n",
 148                                 __func__, dimm_name, cmd_name, out_obj->type);
 149                 rc = -EINVAL;
 150                 goto out;
 151         }
 152
 153         if (IS_ENABLED(CONFIG_ACPI_NFIT_DEBUG)) {
 154                 dev_dbg(dev, "%s:%s cmd: %s output length: %d\n", __func__,
 155                                 dimm_name, cmd_name, out_obj->buffer.length);
 156                 print_hex_dump_debug(cmd_name, DUMP_PREFIX_OFFSET, 4,
 157                                 4, out_obj->buffer.pointer, min_t(u32, 128,
 158                                         out_obj->buffer.length), true);
 159         }
 160
 161         for (i = 0, offset = 0; i < desc->out_num; i++) {
 162                 u32 out_size = nd_cmd_out_size(nvdimm, cmd, desc, i, buf,
 163                                 (u32 *) out_obj->buffer.pointer);
 164
 165                 if (offset + out_size > out_obj->buffer.length) {
 166                         dev_dbg(dev, "%s:%s output object underflow cmd: %s field: %d\n",
 167                                         __func__, dimm_name, cmd_name, i);
 168                         break;
 169                 }
 170
 171                 if (in_buf.buffer.length + offset + out_size > buf_len) {
 172                         dev_dbg(dev, "%s:%s output overrun cmd: %s field: %d\n",
 173                                         __func__, dimm_name, cmd_name, i);
 174                         rc = -ENXIO;
 175                         goto out;
 176                 }
 177                 memcpy(buf + in_buf.buffer.length + offset,
 178                                 out_obj->buffer.pointer + offset, out_size);
 179                 offset += out_size;
 180         }
 181         if (offset + in_buf.buffer.length < buf_len) {
 182                 if (i >= 1) {
 183                         /*
 184                          * status valid, return the number of bytes left
 185                          * unfilled in the output buffer
 186                          */
 187                         rc = buf_len - offset - in_buf.buffer.length;
 188                 } else {
 189                         dev_err(dev, "%s:%s underrun cmd: %s buf_len: %d out_len: %d\n",
 190                                         __func__, dimm_name, cmd_name, buf_len,
 191                                         offset);
 192                         rc = -ENXIO;
 193                 }
 194         } else
 195                 rc = 0;
 196
 197  out:
 198         ACPI_FREE(out_obj);
 199
 200         return rc;
 201 }
 202
 203 static const char *spa_type_name(u16 type)
 204 {
 205         static const char *to_name[] = {
 206                 [NFIT_SPA_VOLATILE] = "volatile",
 207                 [NFIT_SPA_PM] = "pmem",
 208                 [NFIT_SPA_DCR] = "dimm-control-region",
 209                 [NFIT_SPA_BDW] = "block-data-window",
 210                 [NFIT_SPA_VDISK] = "volatile-disk",
 211                 [NFIT_SPA_VCD] = "volatile-cd",
 212                 [NFIT_SPA_PDISK] = "persistent-disk",
 213                 [NFIT_SPA_PCD] = "persistent-cd",
 214
 215         };
 216
 217         if (type > NFIT_SPA_PCD)
 218                 return "unknown";
 219
 220         return to_name[type];
 221 }
 222
 223 static int nfit_spa_type(struct acpi_nfit_system_address *spa)
 224 {
 225         int i;
 226
 227         for (i = 0; i < NFIT_UUID_MAX; i++)
 228                 if (memcmp(to_nfit_uuid(i), spa->range_guid, 16) == 0)
 229                         return i;
 230         return -1;
 231 }
 232
 233 static bool add_spa(struct acpi_nfit_desc *acpi_desc,
 234                 struct nfit_table_prev *prev,
 235                 struct acpi_nfit_system_address *spa)
 236 {
 237         size_t length = min_t(size_t, sizeof(*spa), spa->header.length);
 238         struct device *dev = acpi_desc->dev;
 239         struct nfit_spa *nfit_spa;
 240
 241         list_for_each_entry(nfit_spa, &prev->spas, list) {
 242                 if (memcmp(nfit_spa->spa, spa, length) == 0) {
 243                         list_move_tail(&nfit_spa->list, &acpi_desc->spas);
 244                         return true;
 245                 }
 246         }
 247
 248         nfit_spa = devm_kzalloc(dev, sizeof(*nfit_spa), GFP_KERNEL);
 249         if (!nfit_spa)
 250                 return false;
 251         INIT_LIST_HEAD(&nfit_spa->list);
 252         nfit_spa->spa = spa;
 253         list_add_tail(&nfit_spa->list, &acpi_desc->spas);
 254         dev_dbg(dev, "%s: spa index: %d type: %s\n", __func__,
 255                         spa->range_index,
 256                         spa_type_name(nfit_spa_type(spa)));
 257         return true;
 258 }
 259
 260 static bool add_memdev(struct acpi_nfit_desc *acpi_desc,
 261                 struct nfit_table_prev *prev,
 262                 struct acpi_nfit_memory_map *memdev)
 263 {
 264         size_t length = min_t(size_t, sizeof(*memdev), memdev->header.length);
 265         struct device *dev = acpi_desc->dev;
 266         struct nfit_memdev *nfit_memdev;
 267
 268         list_for_each_entry(nfit_memdev, &prev->memdevs, list)
 269                 if (memcmp(nfit_memdev->memdev, memdev, length) == 0) {
 270                         list_move_tail(&nfit_memdev->list, &acpi_desc->memdevs);
 271                         return true;
 272                 }
 273
 274         nfit_memdev = devm_kzalloc(dev, sizeof(*nfit_memdev), GFP_KERNEL);
 275         if (!nfit_memdev)
 276                 return false;
 277         INIT_LIST_HEAD(&nfit_memdev->list);
 278         nfit_memdev->memdev = memdev;
 279         list_add_tail(&nfit_memdev->list, &acpi_desc->memdevs);
 280         dev_dbg(dev, "%s: memdev handle: %#x spa: %d dcr: %d\n",
 281                         __func__, memdev->device_handle, memdev->range_index,
 282                         memdev->region_index);
 283         return true;
 284 }
 285
 286 static bool add_dcr(struct acpi_nfit_desc *acpi_desc,
 287                 struct nfit_table_prev *prev,
 288                 struct acpi_nfit_control_region *dcr)
 289 {
 290         size_t length = min_t(size_t, sizeof(*dcr), dcr->header.length);
 291         struct device *dev = acpi_desc->dev;
 292         struct nfit_dcr *nfit_dcr;
 293
 294         list_for_each_entry(nfit_dcr, &prev->dcrs, list)
 295                 if (memcmp(nfit_dcr->dcr, dcr, length) == 0) {
 296                         list_move_tail(&nfit_dcr->list, &acpi_desc->dcrs);
 297                         return true;
 298                 }
 299
 300         nfit_dcr = devm_kzalloc(dev, sizeof(*nfit_dcr), GFP_KERNEL);
 301         if (!nfit_dcr)
 302                 return false;
 303         INIT_LIST_HEAD(&nfit_dcr->list);
 304         nfit_dcr->dcr = dcr;
 305         list_add_tail(&nfit_dcr->list, &acpi_desc->dcrs);
 306         dev_dbg(dev, "%s: dcr index: %d windows: %d\n", __func__,
 307                         dcr->region_index, dcr->windows);
 308         return true;
 309 }
 310
 311 static bool add_bdw(struct acpi_nfit_desc *acpi_desc,
 312                 struct nfit_table_prev *prev,
 313                 struct acpi_nfit_data_region *bdw)
 314 {
 315         size_t length = min_t(size_t, sizeof(*bdw), bdw->header.length);
 316         struct device *dev = acpi_desc->dev;
 317         struct nfit_bdw *nfit_bdw;
 318
 319         list_for_each_entry(nfit_bdw, &prev->bdws, list)
 320                 if (memcmp(nfit_bdw->bdw, bdw, length) == 0) {
 321                         list_move_tail(&nfit_bdw->list, &acpi_desc->bdws);
 322                         return true;
 323                 }
 324
 325         nfit_bdw = devm_kzalloc(dev, sizeof(*nfit_bdw), GFP_KERNEL);
 326         if (!nfit_bdw)
 327                 return false;
 328         INIT_LIST_HEAD(&nfit_bdw->list);
 329         nfit_bdw->bdw = bdw;
 330         list_add_tail(&nfit_bdw->list, &acpi_desc->bdws);
 331         dev_dbg(dev, "%s: bdw dcr: %d windows: %d\n", __func__,
 332                         bdw->region_index, bdw->windows);
 333         return true;
 334 }
 335
 336 static bool add_idt(struct acpi_nfit_desc *acpi_desc,
 337                 struct nfit_table_prev *prev,
 338                 struct acpi_nfit_interleave *idt)
 339 {
 340         size_t length = min_t(size_t, sizeof(*idt), idt->header.length);
 341         struct device *dev = acpi_desc->dev;
 342         struct nfit_idt *nfit_idt;
 343
 344         list_for_each_entry(nfit_idt, &prev->idts, list)
 345                 if (memcmp(nfit_idt->idt, idt, length) == 0) {
 346                         list_move_tail(&nfit_idt->list, &acpi_desc->idts);
 347                         return true;
 348                 }
 349
 350         nfit_idt = devm_kzalloc(dev, sizeof(*nfit_idt), GFP_KERNEL);
 351         if (!nfit_idt)
 352                 return false;
 353         INIT_LIST_HEAD(&nfit_idt->list);
 354         nfit_idt->idt = idt;
 355         list_add_tail(&nfit_idt->list, &acpi_desc->idts);
 356         dev_dbg(dev, "%s: idt index: %d num_lines: %d\n", __func__,
 357                         idt->interleave_index, idt->line_count);
 358         return true;
 359 }
 360
 361 static bool add_flush(struct acpi_nfit_desc *acpi_desc,
 362                 struct nfit_table_prev *prev,
 363                 struct acpi_nfit_flush_address *flush)
 364 {
 365         size_t length = min_t(size_t, sizeof(*flush), flush->header.length);
 366         struct device *dev = acpi_desc->dev;
 367         struct nfit_flush *nfit_flush;
 368
 369         list_for_each_entry(nfit_flush, &prev->flushes, list)
 370                 if (memcmp(nfit_flush->flush, flush, length) == 0) {
 371                         list_move_tail(&nfit_flush->list, &acpi_desc->flushes);
 372                         return true;
 373                 }
 374
 375         nfit_flush = devm_kzalloc(dev, sizeof(*nfit_flush), GFP_KERNEL);
 376         if (!nfit_flush)
 377                 return false;
 378         INIT_LIST_HEAD(&nfit_flush->list);
 379         nfit_flush->flush = flush;
 380         list_add_tail(&nfit_flush->list, &acpi_desc->flushes);
 381         dev_dbg(dev, "%s: nfit_flush handle: %d hint_count: %d\n", __func__,
 382                         flush->device_handle, flush->hint_count);
 383         return true;
 384 }
 385
 386 static void *add_table(struct acpi_nfit_desc *acpi_desc,
 387                 struct nfit_table_prev *prev, void *table, const void *end)
 388 {
 389         struct device *dev = acpi_desc->dev;
 390         struct acpi_nfit_header *hdr;
 391         void *err = ERR_PTR(-ENOMEM);
 392
 393         if (table >= end)
 394                 return NULL;
 395
 396         hdr = table;
 397         if (!hdr->length) {
 398                 dev_warn(dev, "found a zero length table '%d' parsing nfit\n",
 399                         hdr->type);
 400                 return NULL;
 401         }
 402
 403         switch (hdr->type) {
 404         case ACPI_NFIT_TYPE_SYSTEM_ADDRESS:
 405                 if (!add_spa(acpi_desc, prev, table))
 406                         return err;
 407                 break;
 408         case ACPI_NFIT_TYPE_MEMORY_MAP:
 409                 if (!add_memdev(acpi_desc, prev, table))
 410                         return err;
 411                 break;
 412         case ACPI_NFIT_TYPE_CONTROL_REGION:
 413                 if (!add_dcr(acpi_desc, prev, table))
 414                         return err;
 415                 break;
 416         case ACPI_NFIT_TYPE_DATA_REGION:
 417                 if (!add_bdw(acpi_desc, prev, table))
 418                         return err;
 419                 break;
 420         case ACPI_NFIT_TYPE_INTERLEAVE:
 421                 if (!add_idt(acpi_desc, prev, table))
 422                         return err;
 423                 break;
 424         case ACPI_NFIT_TYPE_FLUSH_ADDRESS:
 425                 if (!add_flush(acpi_desc, prev, table))
 426                         return err;
 427                 break;
 428         case ACPI_NFIT_TYPE_SMBIOS:
 429                 dev_dbg(dev, "%s: smbios\n", __func__);
 430                 break;
 431         default:
 432                 dev_err(dev, "unknown table '%d' parsing nfit\n", hdr->type);
 433                 break;
 434         }
 435
 436         return table + hdr->length;
 437 }
 438
 439 static void nfit_mem_find_spa_bdw(struct acpi_nfit_desc *acpi_desc,
 440                 struct nfit_mem *nfit_mem)
 441 {
 442         u32 device_handle = __to_nfit_memdev(nfit_mem)->device_handle;
 443         u16 dcr = nfit_mem->dcr->region_index;
 444         struct nfit_spa *nfit_spa;
 445
 446         list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
 447                 u16 range_index = nfit_spa->spa->range_index;
 448                 int type = nfit_spa_type(nfit_spa->spa);
 449                 struct nfit_memdev *nfit_memdev;
 450
 451                 if (type != NFIT_SPA_BDW)
 452                         continue;
 453
 454                 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
 455                         if (nfit_memdev->memdev->range_index != range_index)
 456                                 continue;
 457                         if (nfit_memdev->memdev->device_handle != device_handle)
 458                                 continue;
 459                         if (nfit_memdev->memdev->region_index != dcr)
 460                                 continue;
 461
 462                         nfit_mem->spa_bdw = nfit_spa->spa;
 463                         return;
 464                 }
 465         }
 466
 467         dev_dbg(acpi_desc->dev, "SPA-BDW not found for SPA-DCR %d\n",
 468                         nfit_mem->spa_dcr->range_index);
 469         nfit_mem->bdw = NULL;
 470 }
 471
 472 static int nfit_mem_add(struct acpi_nfit_desc *acpi_desc,
 473                 struct nfit_mem *nfit_mem, struct acpi_nfit_system_address *spa)
 474 {
 475         u16 dcr = __to_nfit_memdev(nfit_mem)->region_index;
 476         struct nfit_memdev *nfit_memdev;
 477         struct nfit_flush *nfit_flush;
 478         struct nfit_dcr *nfit_dcr;
 479         struct nfit_bdw *nfit_bdw;
 480         struct nfit_idt *nfit_idt;
 481         u16 idt_idx, range_index;
 482
 483         list_for_each_entry(nfit_dcr, &acpi_desc->dcrs, list) {
 484                 if (nfit_dcr->dcr->region_index != dcr)
 485                         continue;
 486                 nfit_mem->dcr = nfit_dcr->dcr;
 487                 break;
 488         }
 489
 490         if (!nfit_mem->dcr) {
 491                 dev_dbg(acpi_desc->dev, "SPA %d missing:%s%s\n",
 492                                 spa->range_index, __to_nfit_memdev(nfit_mem)
 493                                 ? "" : " MEMDEV", nfit_mem->dcr ? "" : " DCR");
 494                 return -ENODEV;
 495         }
 496
 497         /*
 498          * We've found enough to create an nvdimm, optionally
 499          * find an associated BDW
 500          */
 501         list_add(&nfit_mem->list, &acpi_desc->dimms);
 502
 503         list_for_each_entry(nfit_bdw, &acpi_desc->bdws, list) {
 504                 if (nfit_bdw->bdw->region_index != dcr)
 505                         continue;
 506                 nfit_mem->bdw = nfit_bdw->bdw;
 507                 break;
 508         }
 509
 510         if (!nfit_mem->bdw)
 511                 return 0;
 512
 513         nfit_mem_find_spa_bdw(acpi_desc, nfit_mem);
 514
 515         if (!nfit_mem->spa_bdw)
 516                 return 0;
 517
 518         range_index = nfit_mem->spa_bdw->range_index;
 519         list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
 520                 if (nfit_memdev->memdev->range_index != range_index ||
 521                                 nfit_memdev->memdev->region_index != dcr)
 522                         continue;
 523                 nfit_mem->memdev_bdw = nfit_memdev->memdev;
 524                 idt_idx = nfit_memdev->memdev->interleave_index;
 525                 list_for_each_entry(nfit_idt, &acpi_desc->idts, list) {
 526                         if (nfit_idt->idt->interleave_index != idt_idx)
 527                                 continue;
 528                         nfit_mem->idt_bdw = nfit_idt->idt;
 529                         break;
 530                 }
 531
 532                 list_for_each_entry(nfit_flush, &acpi_desc->flushes, list) {
 533                         if (nfit_flush->flush->device_handle !=
 534                                         nfit_memdev->memdev->device_handle)
 535                                 continue;
 536                         nfit_mem->nfit_flush = nfit_flush;
 537                         break;
 538                 }
 539                 break;
 540         }
 541
 542         return 0;
 543 }
 544
 545 static int nfit_mem_dcr_init(struct acpi_nfit_desc *acpi_desc,
 546                 struct acpi_nfit_system_address *spa)
 547 {
 548         struct nfit_mem *nfit_mem, *found;
 549         struct nfit_memdev *nfit_memdev;
 550         int type = nfit_spa_type(spa);
 551         u16 dcr;
 552
 553         switch (type) {
 554         case NFIT_SPA_DCR:
 555         case NFIT_SPA_PM:
 556                 break;
 557         default:
 558                 return 0;
 559         }
 560
 561         list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
 562                 int rc;
 563
 564                 if (nfit_memdev->memdev->range_index != spa->range_index)
 565                         continue;
 566                 found = NULL;
 567                 dcr = nfit_memdev->memdev->region_index;
 568                 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list)
 569                         if (__to_nfit_memdev(nfit_mem)->region_index == dcr) {
 570                                 found = nfit_mem;
 571                                 break;
 572                         }
 573
 574                 if (found)
 575                         nfit_mem = found;
 576                 else {
 577                         nfit_mem = devm_kzalloc(acpi_desc->dev,
 578                                         sizeof(*nfit_mem), GFP_KERNEL);
 579                         if (!nfit_mem)
 580                                 return -ENOMEM;
 581                         INIT_LIST_HEAD(&nfit_mem->list);
 582                 }
 583
 584                 if (type == NFIT_SPA_DCR) {
 585                         struct nfit_idt *nfit_idt;
 586                         u16 idt_idx;
 587
 588                         /* multiple dimms may share a SPA when interleaved */
 589                         nfit_mem->spa_dcr = spa;
 590                         nfit_mem->memdev_dcr = nfit_memdev->memdev;
 591                         idt_idx = nfit_memdev->memdev->interleave_index;
 592                         list_for_each_entry(nfit_idt, &acpi_desc->idts, list) {
 593                                 if (nfit_idt->idt->interleave_index != idt_idx)
 594                                         continue;
 595                                 nfit_mem->idt_dcr = nfit_idt->idt;
 596                                 break;
 597                         }
 598                 } else {
 599                         /*
 600                          * A single dimm may belong to multiple SPA-PM
 601                          * ranges, record at least one in addition to
 602                          * any SPA-DCR range.
 603                          */
 604                         nfit_mem->memdev_pmem = nfit_memdev->memdev;
 605                 }
 606
 607                 if (found)
 608                         continue;
 609
 610                 rc = nfit_mem_add(acpi_desc, nfit_mem, spa);
 611                 if (rc)
 612                         return rc;
 613         }
 614
 615         return 0;
 616 }
 617
 618 static int nfit_mem_cmp(void *priv, struct list_head *_a, struct list_head *_b)
 619 {
 620         struct nfit_mem *a = container_of(_a, typeof(*a), list);
 621         struct nfit_mem *b = container_of(_b, typeof(*b), list);
 622         u32 handleA, handleB;
 623
 624         handleA = __to_nfit_memdev(a)->device_handle;
 625         handleB = __to_nfit_memdev(b)->device_handle;
 626         if (handleA < handleB)
 627                 return -1;
 628         else if (handleA > handleB)
 629                 return 1;
 630         return 0;
 631 }
 632
 633 static int nfit_mem_init(struct acpi_nfit_desc *acpi_desc)
 634 {
 635         struct nfit_spa *nfit_spa;
 636
 637         /*
 638          * For each SPA-DCR or SPA-PMEM address range find its
 639          * corresponding MEMDEV(s).  From each MEMDEV find the
 640          * corresponding DCR.  Then, if we're operating on a SPA-DCR,
 641          * try to find a SPA-BDW and a corresponding BDW that references
 642          * the DCR.  Throw it all into an nfit_mem object.  Note, that
 643          * BDWs are optional.
 644          */
 645         list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
 646                 int rc;
 647
 648                 rc = nfit_mem_dcr_init(acpi_desc, nfit_spa->spa);
 649                 if (rc)
 650                         return rc;
 651         }
 652
 653         list_sort(NULL, &acpi_desc->dimms, nfit_mem_cmp);
 654
 655         return 0;
 656 }
 657
 658 static ssize_t revision_show(struct device *dev,
 659                 struct device_attribute *attr, char *buf)
 660 {
 661         struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
 662         struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
 663         struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
 664
 665         return sprintf(buf, "%d\n", acpi_desc->acpi_header.revision);
 666 }
 667 static DEVICE_ATTR_RO(revision);
 668
 669 static struct attribute *acpi_nfit_attributes[] = {
 670         &dev_attr_revision.attr,
 671         NULL,
 672 };
 673
 674 static struct attribute_group acpi_nfit_attribute_group = {
 675         .name = "nfit",
 676         .attrs = acpi_nfit_attributes,
 677 };
 678
 679 const struct attribute_group *acpi_nfit_attribute_groups[] = {
 680         &nvdimm_bus_attribute_group,
 681         &acpi_nfit_attribute_group,
 682         NULL,
 683 };
 684 EXPORT_SYMBOL_GPL(acpi_nfit_attribute_groups);
 685
 686 static struct acpi_nfit_memory_map *to_nfit_memdev(struct device *dev)
 687 {
 688         struct nvdimm *nvdimm = to_nvdimm(dev);
 689         struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
 690
 691         return __to_nfit_memdev(nfit_mem);
 692 }
 693
 694 static struct acpi_nfit_control_region *to_nfit_dcr(struct device *dev)
 695 {
 696         struct nvdimm *nvdimm = to_nvdimm(dev);
 697         struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
 698
 699         return nfit_mem->dcr;
 700 }
 701
 702 static ssize_t handle_show(struct device *dev,
 703                 struct device_attribute *attr, char *buf)
 704 {
 705         struct acpi_nfit_memory_map *memdev = to_nfit_memdev(dev);
 706
 707         return sprintf(buf, "%#x\n", memdev->device_handle);
 708 }
 709 static DEVICE_ATTR_RO(handle);
 710
 711 static ssize_t phys_id_show(struct device *dev,
 712                 struct device_attribute *attr, char *buf)
 713 {
 714         struct acpi_nfit_memory_map *memdev = to_nfit_memdev(dev);
 715
 716         return sprintf(buf, "%#x\n", memdev->physical_id);
 717 }
 718 static DEVICE_ATTR_RO(phys_id);
 719
 720 static ssize_t vendor_show(struct device *dev,
 721                 struct device_attribute *attr, char *buf)
 722 {
 723         struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
 724
 725         return sprintf(buf, "%#x\n", dcr->vendor_id);
 726 }
 727 static DEVICE_ATTR_RO(vendor);
 728
 729 static ssize_t rev_id_show(struct device *dev,
 730                 struct device_attribute *attr, char *buf)
 731 {
 732         struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
 733
 734         return sprintf(buf, "%#x\n", dcr->revision_id);
 735 }
 736 static DEVICE_ATTR_RO(rev_id);
 737
 738 static ssize_t device_show(struct device *dev,
 739                 struct device_attribute *attr, char *buf)
 740 {
 741         struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
 742
 743         return sprintf(buf, "%#x\n", dcr->device_id);
 744 }
 745 static DEVICE_ATTR_RO(device);
 746
 747 static ssize_t format_show(struct device *dev,
 748                 struct device_attribute *attr, char *buf)
 749 {
 750         struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
 751
 752         return sprintf(buf, "%#x\n", dcr->code);
 753 }
 754 static DEVICE_ATTR_RO(format);
 755
 756 static ssize_t serial_show(struct device *dev,
 757                 struct device_attribute *attr, char *buf)
 758 {
 759         struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
 760
 761         return sprintf(buf, "%#x\n", dcr->serial_number);
 762 }
 763 static DEVICE_ATTR_RO(serial);
 764
 765 static ssize_t flags_show(struct device *dev,
 766                 struct device_attribute *attr, char *buf)
 767 {
 768         u16 flags = to_nfit_memdev(dev)->flags;
 769
 770         return sprintf(buf, "%s%s%s%s%s\n",
 771                 flags & ACPI_NFIT_MEM_SAVE_FAILED ? "save_fail " : "",
 772                 flags & ACPI_NFIT_MEM_RESTORE_FAILED ? "restore_fail " : "",
 773                 flags & ACPI_NFIT_MEM_FLUSH_FAILED ? "flush_fail " : "",
 774                 flags & ACPI_NFIT_MEM_NOT_ARMED ? "not_armed " : "",
 775                 flags & ACPI_NFIT_MEM_HEALTH_OBSERVED ? "smart_event " : "");
 776 }
 777 static DEVICE_ATTR_RO(flags);
 778
 779 static struct attribute *acpi_nfit_dimm_attributes[] = {
 780         &dev_attr_handle.attr,
 781         &dev_attr_phys_id.attr,
 782         &dev_attr_vendor.attr,
 783         &dev_attr_device.attr,
 784         &dev_attr_format.attr,
 785         &dev_attr_serial.attr,
 786         &dev_attr_rev_id.attr,
 787         &dev_attr_flags.attr,
 788         NULL,
 789 };
 790
 791 static umode_t acpi_nfit_dimm_attr_visible(struct kobject *kobj,
 792                 struct attribute *a, int n)
 793 {
 794         struct device *dev = container_of(kobj, struct device, kobj);
 795
 796         if (to_nfit_dcr(dev))
 797                 return a->mode;
 798         else
 799                 return 0;
 800 }
 801
 802 static struct attribute_group acpi_nfit_dimm_attribute_group = {
 803         .name = "nfit",
 804         .attrs = acpi_nfit_dimm_attributes,
 805         .is_visible = acpi_nfit_dimm_attr_visible,
 806 };
 807
 808 static const struct attribute_group *acpi_nfit_dimm_attribute_groups[] = {
 809         &nvdimm_attribute_group,
 810         &nd_device_attribute_group,
 811         &acpi_nfit_dimm_attribute_group,
 812         NULL,
 813 };
 814
 815 static struct nvdimm *acpi_nfit_dimm_by_handle(struct acpi_nfit_desc *acpi_desc,
 816                 u32 device_handle)
 817 {
 818         struct nfit_mem *nfit_mem;
 819
 820         list_for_each_entry(nfit_mem, &acpi_desc->dimms, list)
 821                 if (__to_nfit_memdev(nfit_mem)->device_handle == device_handle)
 822                         return nfit_mem->nvdimm;
 823
 824         return NULL;
 825 }
 826
 827 static int acpi_nfit_add_dimm(struct acpi_nfit_desc *acpi_desc,
 828                 struct nfit_mem *nfit_mem, u32 device_handle)
 829 {
 830         struct acpi_device *adev, *adev_dimm;
 831         struct device *dev = acpi_desc->dev;
 832         const u8 *uuid = to_nfit_uuid(NFIT_DEV_DIMM);
 833         int i;
 834
 835         nfit_mem->dsm_mask = acpi_desc->dimm_dsm_force_en;
 836         adev = to_acpi_dev(acpi_desc);
 837         if (!adev)
 838                 return 0;
 839
 840         adev_dimm = acpi_find_child_device(adev, device_handle, false);
 841         nfit_mem->adev = adev_dimm;
 842         if (!adev_dimm) {
 843                 dev_err(dev, "no ACPI.NFIT device with _ADR %#x, disabling...\n",
 844                                 device_handle);
 845                 return force_enable_dimms ? 0 : -ENODEV;
 846         }
 847
 848         for (i = ND_CMD_SMART; i <= ND_CMD_VENDOR; i++)
 849                 if (acpi_check_dsm(adev_dimm->handle, uuid, 1, 1ULL << i))
 850                         set_bit(i, &nfit_mem->dsm_mask);
 851
 852         return 0;
 853 }
 854
 855 static int acpi_nfit_register_dimms(struct acpi_nfit_desc *acpi_desc)
 856 {
 857         struct nfit_mem *nfit_mem;
 858         int dimm_count = 0;
 859
 860         list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
 861                 struct nvdimm *nvdimm;
 862                 unsigned long flags = 0;
 863                 u32 device_handle;
 864                 u16 mem_flags;
 865                 int rc;
 866
 867                 device_handle = __to_nfit_memdev(nfit_mem)->device_handle;
 868                 nvdimm = acpi_nfit_dimm_by_handle(acpi_desc, device_handle);
 869                 if (nvdimm) {
 870                         dimm_count++;
 871                         continue;
 872                 }
 873
 874                 if (nfit_mem->bdw && nfit_mem->memdev_pmem)
 875                         flags |= NDD_ALIASING;
 876
 877                 mem_flags = __to_nfit_memdev(nfit_mem)->flags;
 878                 if (mem_flags & ACPI_NFIT_MEM_NOT_ARMED)
 879                         flags |= NDD_UNARMED;
 880
 881                 rc = acpi_nfit_add_dimm(acpi_desc, nfit_mem, device_handle);
 882                 if (rc)
 883                         continue;
 884
 885                 nvdimm = nvdimm_create(acpi_desc->nvdimm_bus, nfit_mem,
 886                                 acpi_nfit_dimm_attribute_groups,
 887                                 flags, &nfit_mem->dsm_mask);
 888                 if (!nvdimm)
 889                         return -ENOMEM;
 890
 891                 nfit_mem->nvdimm = nvdimm;
 892                 dimm_count++;
 893
 894                 if ((mem_flags & ACPI_NFIT_MEM_FAILED_MASK) == 0)
 895                         continue;
 896
 897                 dev_info(acpi_desc->dev, "%s flags:%s%s%s%s\n",
 898                                 nvdimm_name(nvdimm),
 899                   mem_flags & ACPI_NFIT_MEM_SAVE_FAILED ? " save_fail" : "",
 900                   mem_flags & ACPI_NFIT_MEM_RESTORE_FAILED ? " restore_fail":"",
 901                   mem_flags & ACPI_NFIT_MEM_FLUSH_FAILED ? " flush_fail" : "",
 902                   mem_flags & ACPI_NFIT_MEM_NOT_ARMED ? " not_armed" : "");
 903
 904         }
 905
 906         return nvdimm_bus_check_dimm_count(acpi_desc->nvdimm_bus, dimm_count);
 907 }
 908
 909 static void acpi_nfit_init_dsms(struct acpi_nfit_desc *acpi_desc)
 910 {
 911         struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
 912         const u8 *uuid = to_nfit_uuid(NFIT_DEV_BUS);
 913         struct acpi_device *adev;
 914         int i;
 915
 916         nd_desc->dsm_mask = acpi_desc->bus_dsm_force_en;
 917         adev = to_acpi_dev(acpi_desc);
 918         if (!adev)
 919                 return;
 920
 921         for (i = ND_CMD_ARS_CAP; i <= ND_CMD_ARS_STATUS; i++)
 922                 if (acpi_check_dsm(adev->handle, uuid, 1, 1ULL << i))
 923                         set_bit(i, &nd_desc->dsm_mask);
 924 }
 925
 926 static ssize_t range_index_show(struct device *dev,
 927                 struct device_attribute *attr, char *buf)
 928 {
 929         struct nd_region *nd_region = to_nd_region(dev);
 930         struct nfit_spa *nfit_spa = nd_region_provider_data(nd_region);
 931
 932         return sprintf(buf, "%d\n", nfit_spa->spa->range_index);
 933 }
 934 static DEVICE_ATTR_RO(range_index);
 935
 936 static struct attribute *acpi_nfit_region_attributes[] = {
 937         &dev_attr_range_index.attr,
 938         NULL,
 939 };
 940
 941 static struct attribute_group acpi_nfit_region_attribute_group = {
 942         .name = "nfit",
 943         .attrs = acpi_nfit_region_attributes,
 944 };
 945
 946 static const struct attribute_group *acpi_nfit_region_attribute_groups[] = {
 947         &nd_region_attribute_group,
 948         &nd_mapping_attribute_group,
 949         &nd_device_attribute_group,
 950         &nd_numa_attribute_group,
 951         &acpi_nfit_region_attribute_group,
 952         NULL,
 953 };
 954
 955 /* enough info to uniquely specify an interleave set */
 956 struct nfit_set_info {
 957         struct nfit_set_info_map {
 958                 u64 region_offset;
 959                 u32 serial_number;
 960                 u32 pad;
 961         } mapping[0];
 962 };
 963
 964 static size_t sizeof_nfit_set_info(int num_mappings)
 965 {
 966         return sizeof(struct nfit_set_info)
 967                 + num_mappings * sizeof(struct nfit_set_info_map);
 968 }
 969
 970 static int cmp_map(const void *m0, const void *m1)
 971 {
 972         const struct nfit_set_info_map *map0 = m0;
 973         const struct nfit_set_info_map *map1 = m1;
 974
 975         return memcmp(&map0->region_offset, &map1->region_offset,
 976                         sizeof(u64));
 977 }
 978
 979 /* Retrieve the nth entry referencing this spa */
 980 static struct acpi_nfit_memory_map *memdev_from_spa(
 981                 struct acpi_nfit_desc *acpi_desc, u16 range_index, int n)
 982 {
 983         struct nfit_memdev *nfit_memdev;
 984
 985         list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list)
 986                 if (nfit_memdev->memdev->range_index == range_index)
 987                         if (n-- == 0)
 988                                 return nfit_memdev->memdev;
 989         return NULL;
 990 }
 991
 992 static int acpi_nfit_init_interleave_set(struct acpi_nfit_desc *acpi_desc,
 993                 struct nd_region_desc *ndr_desc,
 994                 struct acpi_nfit_system_address *spa)
 995 {
 996         int i, spa_type = nfit_spa_type(spa);
 997         struct device *dev = acpi_desc->dev;
 998         struct nd_interleave_set *nd_set;
 999         u16 nr = ndr_desc->num_mappings;
1000         struct nfit_set_info *info;
1001
1002         if (spa_type == NFIT_SPA_PM || spa_type == NFIT_SPA_VOLATILE)
1003                 /* pass */;
1004         else
1005                 return 0;
1006
1007         nd_set = devm_kzalloc(dev, sizeof(*nd_set), GFP_KERNEL);
1008         if (!nd_set)
1009                 return -ENOMEM;
1010
1011         info = devm_kzalloc(dev, sizeof_nfit_set_info(nr), GFP_KERNEL);
1012         if (!info)
1013                 return -ENOMEM;
1014         for (i = 0; i < nr; i++) {
1015                 struct nd_mapping *nd_mapping = &ndr_desc->nd_mapping[i];
1016                 struct nfit_set_info_map *map = &info->mapping[i];
1017                 struct nvdimm *nvdimm = nd_mapping->nvdimm;
1018                 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1019                 struct acpi_nfit_memory_map *memdev = memdev_from_spa(acpi_desc,
1020                                 spa->range_index, i);
1021
1022                 if (!memdev || !nfit_mem->dcr) {
1023                         dev_err(dev, "%s: failed to find DCR\n", __func__);
1024                         return -ENODEV;
1025                 }
1026
1027                 map->region_offset = memdev->region_offset;
1028                 map->serial_number = nfit_mem->dcr->serial_number;
1029         }
1030
1031         sort(&info->mapping[0], nr, sizeof(struct nfit_set_info_map),
1032                         cmp_map, NULL);
1033         nd_set->cookie = nd_fletcher64(info, sizeof_nfit_set_info(nr), 0);
1034         ndr_desc->nd_set = nd_set;
1035         devm_kfree(dev, info);
1036
1037         return 0;
1038 }
1039
1040 static u64 to_interleave_offset(u64 offset, struct nfit_blk_mmio *mmio)
1041 {
1042         struct acpi_nfit_interleave *idt = mmio->idt;
1043         u32 sub_line_offset, line_index, line_offset;
1044         u64 line_no, table_skip_count, table_offset;
1045
1046         line_no = div_u64_rem(offset, mmio->line_size, &sub_line_offset);
1047         table_skip_count = div_u64_rem(line_no, mmio->num_lines, &line_index);
1048         line_offset = idt->line_offset[line_index]
1049                 * mmio->line_size;
1050         table_offset = table_skip_count * mmio->table_size;
1051
1052         return mmio->base_offset + line_offset + table_offset + sub_line_offset;
1053 }
1054
1055 static void wmb_blk(struct nfit_blk *nfit_blk)
1056 {
1057
1058         if (nfit_blk->nvdimm_flush) {
1059                 /*
1060                  * The first wmb() is needed to 'sfence' all previous writes
1061                  * such that they are architecturally visible for the platform
1062                  * buffer flush.  Note that we've already arranged for pmem
1063                  * writes to avoid the cache via arch_memcpy_to_pmem().  The
1064                  * final wmb() ensures ordering for the NVDIMM flush write.
1065                  */
1066                 wmb();
1067                 writeq(1, nfit_blk->nvdimm_flush);
1068                 wmb();
1069         } else
1070                 wmb_pmem();
1071 }
1072
1073 static u32 read_blk_stat(struct nfit_blk *nfit_blk, unsigned int bw)
1074 {
1075         struct nfit_blk_mmio *mmio = &nfit_blk->mmio[DCR];
1076         u64 offset = nfit_blk->stat_offset + mmio->size * bw;
1077
1078         if (mmio->num_lines)
1079                 offset = to_interleave_offset(offset, mmio);
1080
1081         return readl(mmio->addr.base + offset);
1082 }
1083
1084 static void write_blk_ctl(struct nfit_blk *nfit_blk, unsigned int bw,
1085                 resource_size_t dpa, unsigned int len, unsigned int write)
1086 {
1087         u64 cmd, offset;
1088         struct nfit_blk_mmio *mmio = &nfit_blk->mmio[DCR];
1089
1090         enum {
1091                 BCW_OFFSET_MASK = (1ULL << 48)-1,
1092                 BCW_LEN_SHIFT = 48,
1093                 BCW_LEN_MASK = (1ULL << 8) - 1,
1094                 BCW_CMD_SHIFT = 56,
1095         };
1096
1097         cmd = (dpa >> L1_CACHE_SHIFT) & BCW_OFFSET_MASK;
1098         len = len >> L1_CACHE_SHIFT;
1099         cmd |= ((u64) len & BCW_LEN_MASK) << BCW_LEN_SHIFT;
1100         cmd |= ((u64) write) << BCW_CMD_SHIFT;
1101
1102         offset = nfit_blk->cmd_offset + mmio->size * bw;
1103         if (mmio->num_lines)
1104                 offset = to_interleave_offset(offset, mmio);
1105
1106         writeq(cmd, mmio->addr.base + offset);
1107         wmb_blk(nfit_blk);
1108
1109         if (nfit_blk->dimm_flags & ND_BLK_DCR_LATCH)
1110                 readq(mmio->addr.base + offset);
1111 }
1112
1113 static int acpi_nfit_blk_single_io(struct nfit_blk *nfit_blk,
1114                 resource_size_t dpa, void *iobuf, size_t len, int rw,
1115                 unsigned int lane)
1116 {
1117         struct nfit_blk_mmio *mmio = &nfit_blk->mmio[BDW];
1118         unsigned int copied = 0;
1119         u64 base_offset;
1120         int rc;
1121
1122         base_offset = nfit_blk->bdw_offset + dpa % L1_CACHE_BYTES
1123                 + lane * mmio->size;
1124         write_blk_ctl(nfit_blk, lane, dpa, len, rw);
1125         while (len) {
1126                 unsigned int c;
1127                 u64 offset;
1128
1129                 if (mmio->num_lines) {
1130                         u32 line_offset;
1131
1132                         offset = to_interleave_offset(base_offset + copied,
1133                                         mmio);
1134                         div_u64_rem(offset, mmio->line_size, &line_offset);
1135                         c = min_t(size_t, len, mmio->line_size - line_offset);
1136                 } else {
1137                         offset = base_offset + nfit_blk->bdw_offset;
1138                         c = len;
1139                 }
1140
1141                 if (rw)
1142                         memcpy_to_pmem(mmio->addr.aperture + offset,
1143                                         iobuf + copied, c);
1144                 else {
1145                         if (nfit_blk->dimm_flags & ND_BLK_READ_FLUSH)
1146                                 mmio_flush_range((void __force *)
1147                                         mmio->addr.aperture + offset, c);
1148
1149                         memcpy_from_pmem(iobuf + copied,
1150                                         mmio->addr.aperture + offset, c);
1151                 }
1152
1153                 copied += c;
1154                 len -= c;
1155         }
1156
1157         if (rw)
1158                 wmb_blk(nfit_blk);
1159
1160         rc = read_blk_stat(nfit_blk, lane) ? -EIO : 0;
1161         return rc;
1162 }
1163
1164 static int acpi_nfit_blk_region_do_io(struct nd_blk_region *ndbr,
1165                 resource_size_t dpa, void *iobuf, u64 len, int rw)
1166 {
1167         struct nfit_blk *nfit_blk = nd_blk_region_provider_data(ndbr);
1168         struct nfit_blk_mmio *mmio = &nfit_blk->mmio[BDW];
1169         struct nd_region *nd_region = nfit_blk->nd_region;
1170         unsigned int lane, copied = 0;
1171         int rc = 0;
1172
1173         lane = nd_region_acquire_lane(nd_region);
1174         while (len) {
1175                 u64 c = min(len, mmio->size);
1176
1177                 rc = acpi_nfit_blk_single_io(nfit_blk, dpa + copied,
1178                                 iobuf + copied, c, rw, lane);
1179                 if (rc)
1180                         break;
1181
1182                 copied += c;
1183                 len -= c;
1184         }
1185         nd_region_release_lane(nd_region, lane);
1186
1187         return rc;
1188 }
1189
1190 static void nfit_spa_mapping_release(struct kref *kref)
1191 {
1192         struct nfit_spa_mapping *spa_map = to_spa_map(kref);
1193         struct acpi_nfit_system_address *spa = spa_map->spa;
1194         struct acpi_nfit_desc *acpi_desc = spa_map->acpi_desc;
1195
1196         WARN_ON(!mutex_is_locked(&acpi_desc->spa_map_mutex));
1197         dev_dbg(acpi_desc->dev, "%s: SPA%d\n", __func__, spa->range_index);
1198         if (spa_map->type == SPA_MAP_APERTURE)
1199                 memunmap((void __force *)spa_map->addr.aperture);
1200         else
1201                 iounmap(spa_map->addr.base);
1202         release_mem_region(spa->address, spa->length);
1203         list_del(&spa_map->list);
1204         kfree(spa_map);
1205 }
1206
1207 static struct nfit_spa_mapping *find_spa_mapping(
1208                 struct acpi_nfit_desc *acpi_desc,
1209                 struct acpi_nfit_system_address *spa)
1210 {
1211         struct nfit_spa_mapping *spa_map;
1212
1213         WARN_ON(!mutex_is_locked(&acpi_desc->spa_map_mutex));
1214         list_for_each_entry(spa_map, &acpi_desc->spa_maps, list)
1215                 if (spa_map->spa == spa)
1216                         return spa_map;
1217
1218         return NULL;
1219 }
1220
1221 static void nfit_spa_unmap(struct acpi_nfit_desc *acpi_desc,
1222                 struct acpi_nfit_system_address *spa)
1223 {
1224         struct nfit_spa_mapping *spa_map;
1225
1226         mutex_lock(&acpi_desc->spa_map_mutex);
1227         spa_map = find_spa_mapping(acpi_desc, spa);
1228
1229         if (spa_map)
1230                 kref_put(&spa_map->kref, nfit_spa_mapping_release);
1231         mutex_unlock(&acpi_desc->spa_map_mutex);
1232 }
1233
1234 static void __iomem *__nfit_spa_map(struct acpi_nfit_desc *acpi_desc,
1235                 struct acpi_nfit_system_address *spa, enum spa_map_type type)
1236 {
1237         resource_size_t start = spa->address;
1238         resource_size_t n = spa->length;
1239         struct nfit_spa_mapping *spa_map;
1240         struct resource *res;
1241
1242         WARN_ON(!mutex_is_locked(&acpi_desc->spa_map_mutex));
1243
1244         spa_map = find_spa_mapping(acpi_desc, spa);
1245         if (spa_map) {
1246                 kref_get(&spa_map->kref);
1247                 return spa_map->addr.base;
1248         }
1249
1250         spa_map = kzalloc(sizeof(*spa_map), GFP_KERNEL);
1251         if (!spa_map)
1252                 return NULL;
1253
1254         INIT_LIST_HEAD(&spa_map->list);
1255         spa_map->spa = spa;
1256         kref_init(&spa_map->kref);
1257         spa_map->acpi_desc = acpi_desc;
1258
1259         res = request_mem_region(start, n, dev_name(acpi_desc->dev));
1260         if (!res)
1261                 goto err_mem;
1262
1263         spa_map->type = type;
1264         if (type == SPA_MAP_APERTURE)
1265                 spa_map->addr.aperture = (void __pmem *)memremap(start, n,
1266                                                         ARCH_MEMREMAP_PMEM);
1267         else
1268                 spa_map->addr.base = ioremap_nocache(start, n);
1269
1270
1271         if (!spa_map->addr.base)
1272                 goto err_map;
1273
1274         list_add_tail(&spa_map->list, &acpi_desc->spa_maps);
1275         return spa_map->addr.base;
1276
1277  err_map:
1278         release_mem_region(start, n);
1279  err_mem:
1280         kfree(spa_map);
1281         return NULL;
1282 }
1283
1284 /**
1285  * nfit_spa_map - interleave-aware managed-mappings of acpi_nfit_system_address ranges
1286  * @nvdimm_bus: NFIT-bus that provided the spa table entry
1287  * @nfit_spa: spa table to map
1288  * @type: aperture or control region
1289  *
1290  * In the case where block-data-window apertures and
1291  * dimm-control-regions are interleaved they will end up sharing a
1292  * single request_mem_region() + ioremap() for the address range.  In
1293  * the style of devm nfit_spa_map() mappings are automatically dropped
1294  * when all region devices referencing the same mapping are disabled /
1295  * unbound.
1296  */
1297 static void __iomem *nfit_spa_map(struct acpi_nfit_desc *acpi_desc,
1298                 struct acpi_nfit_system_address *spa, enum spa_map_type type)
1299 {
1300         void __iomem *iomem;
1301
1302         mutex_lock(&acpi_desc->spa_map_mutex);
1303         iomem = __nfit_spa_map(acpi_desc, spa, type);
1304         mutex_unlock(&acpi_desc->spa_map_mutex);
1305
1306         return iomem;
1307 }
1308
1309 static int nfit_blk_init_interleave(struct nfit_blk_mmio *mmio,
1310                 struct acpi_nfit_interleave *idt, u16 interleave_ways)
1311 {
1312         if (idt) {
1313                 mmio->num_lines = idt->line_count;
1314                 mmio->line_size = idt->line_size;
1315                 if (interleave_ways == 0)
1316                         return -ENXIO;
1317                 mmio->table_size = mmio->num_lines * interleave_ways
1318                         * mmio->line_size;
1319         }
1320
1321         return 0;
1322 }
1323
1324 static int acpi_nfit_blk_get_flags(struct nvdimm_bus_descriptor *nd_desc,
1325                 struct nvdimm *nvdimm, struct nfit_blk *nfit_blk)
1326 {
1327         struct nd_cmd_dimm_flags flags;
1328         int rc;
1329
1330         memset(&flags, 0, sizeof(flags));
1331         rc = nd_desc->ndctl(nd_desc, nvdimm, ND_CMD_DIMM_FLAGS, &flags,
1332                         sizeof(flags));
1333
1334         if (rc >= 0 && flags.status == 0)
1335                 nfit_blk->dimm_flags = flags.flags;
1336         else if (rc == -ENOTTY) {
1337                 /* fall back to a conservative default */
1338                 nfit_blk->dimm_flags = ND_BLK_DCR_LATCH | ND_BLK_READ_FLUSH;
1339                 rc = 0;
1340         } else
1341                 rc = -ENXIO;
1342
1343         return rc;
1344 }
1345
1346 static int acpi_nfit_blk_region_enable(struct nvdimm_bus *nvdimm_bus,
1347                 struct device *dev)
1348 {
1349         struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1350         struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1351         struct nd_blk_region *ndbr = to_nd_blk_region(dev);
1352         struct nfit_flush *nfit_flush;
1353         struct nfit_blk_mmio *mmio;
1354         struct nfit_blk *nfit_blk;
1355         struct nfit_mem *nfit_mem;
1356         struct nvdimm *nvdimm;
1357         int rc;
1358
1359         nvdimm = nd_blk_region_to_dimm(ndbr);
1360         nfit_mem = nvdimm_provider_data(nvdimm);
1361         if (!nfit_mem || !nfit_mem->dcr || !nfit_mem->bdw) {
1362                 dev_dbg(dev, "%s: missing%s%s%s\n", __func__,
1363                                 nfit_mem ? "" : " nfit_mem",
1364                                 (nfit_mem && nfit_mem->dcr) ? "" : " dcr",
1365                                 (nfit_mem && nfit_mem->bdw) ? "" : " bdw");
1366                 return -ENXIO;
1367         }
1368
1369         nfit_blk = devm_kzalloc(dev, sizeof(*nfit_blk), GFP_KERNEL);
1370         if (!nfit_blk)
1371                 return -ENOMEM;
1372         nd_blk_region_set_provider_data(ndbr, nfit_blk);
1373         nfit_blk->nd_region = to_nd_region(dev);
1374
1375         /* map block aperture memory */
1376         nfit_blk->bdw_offset = nfit_mem->bdw->offset;
1377         mmio = &nfit_blk->mmio[BDW];
1378         mmio->addr.base = nfit_spa_map(acpi_desc, nfit_mem->spa_bdw,
1379                         SPA_MAP_APERTURE);
1380         if (!mmio->addr.base) {
1381                 dev_dbg(dev, "%s: %s failed to map bdw\n", __func__,
1382                                 nvdimm_name(nvdimm));
1383                 return -ENOMEM;
1384         }
1385         mmio->size = nfit_mem->bdw->size;
1386         mmio->base_offset = nfit_mem->memdev_bdw->region_offset;
1387         mmio->idt = nfit_mem->idt_bdw;
1388         mmio->spa = nfit_mem->spa_bdw;
1389         rc = nfit_blk_init_interleave(mmio, nfit_mem->idt_bdw,
1390                         nfit_mem->memdev_bdw->interleave_ways);
1391         if (rc) {
1392                 dev_dbg(dev, "%s: %s failed to init bdw interleave\n",
1393                                 __func__, nvdimm_name(nvdimm));
1394                 return rc;
1395         }
1396
1397         /* map block control memory */
1398         nfit_blk->cmd_offset = nfit_mem->dcr->command_offset;
1399         nfit_blk->stat_offset = nfit_mem->dcr->status_offset;
1400         mmio = &nfit_blk->mmio[DCR];
1401         mmio->addr.base = nfit_spa_map(acpi_desc, nfit_mem->spa_dcr,
1402                         SPA_MAP_CONTROL);
1403         if (!mmio->addr.base) {
1404                 dev_dbg(dev, "%s: %s failed to map dcr\n", __func__,
1405                                 nvdimm_name(nvdimm));
1406                 return -ENOMEM;
1407         }
1408         mmio->size = nfit_mem->dcr->window_size;
1409         mmio->base_offset = nfit_mem->memdev_dcr->region_offset;
1410         mmio->idt = nfit_mem->idt_dcr;
1411         mmio->spa = nfit_mem->spa_dcr;
1412         rc = nfit_blk_init_interleave(mmio, nfit_mem->idt_dcr,
1413                         nfit_mem->memdev_dcr->interleave_ways);
1414         if (rc) {
1415                 dev_dbg(dev, "%s: %s failed to init dcr interleave\n",
1416                                 __func__, nvdimm_name(nvdimm));
1417                 return rc;
1418         }
1419
1420         rc = acpi_nfit_blk_get_flags(nd_desc, nvdimm, nfit_blk);
1421         if (rc < 0) {
1422                 dev_dbg(dev, "%s: %s failed get DIMM flags\n",
1423                                 __func__, nvdimm_name(nvdimm));
1424                 return rc;
1425         }
1426
1427         nfit_flush = nfit_mem->nfit_flush;
1428         if (nfit_flush && nfit_flush->flush->hint_count != 0) {
1429                 nfit_blk->nvdimm_flush = devm_ioremap_nocache(dev,
1430                                 nfit_flush->flush->hint_address[0], 8);
1431                 if (!nfit_blk->nvdimm_flush)
1432                         return -ENOMEM;
1433         }
1434
1435         if (!arch_has_wmb_pmem() && !nfit_blk->nvdimm_flush)
1436                 dev_warn(dev, "unable to guarantee persistence of writes\n");
1437
1438         if (mmio->line_size == 0)
1439                 return 0;
1440
1441         if ((u32) nfit_blk->cmd_offset % mmio->line_size
1442                         + 8 > mmio->line_size) {
1443                 dev_dbg(dev, "cmd_offset crosses interleave boundary\n");
1444                 return -ENXIO;
1445         } else if ((u32) nfit_blk->stat_offset % mmio->line_size
1446                         + 8 > mmio->line_size) {
1447                 dev_dbg(dev, "stat_offset crosses interleave boundary\n");
1448                 return -ENXIO;
1449         }
1450
1451         return 0;
1452 }
1453
1454 static void acpi_nfit_blk_region_disable(struct nvdimm_bus *nvdimm_bus,
1455                 struct device *dev)
1456 {
1457         struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1458         struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1459         struct nd_blk_region *ndbr = to_nd_blk_region(dev);
1460         struct nfit_blk *nfit_blk = nd_blk_region_provider_data(ndbr);
1461         int i;
1462
1463         if (!nfit_blk)
1464                 return; /* never enabled */
1465
1466         /* auto-free BLK spa mappings */
1467         for (i = 0; i < 2; i++) {
1468                 struct nfit_blk_mmio *mmio = &nfit_blk->mmio[i];
1469
1470                 if (mmio->addr.base)
1471                         nfit_spa_unmap(acpi_desc, mmio->spa);
1472         }
1473         nd_blk_region_set_provider_data(ndbr, NULL);
1474         /* devm will free nfit_blk */
1475 }
1476
1477 static int ars_get_cap(struct nvdimm_bus_descriptor *nd_desc,
1478                 struct nd_cmd_ars_cap *cmd, u64 addr, u64 length)
1479 {
1480         cmd->address = addr;
1481         cmd->length = length;
1482
1483         return nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_CAP, cmd,
1484                         sizeof(*cmd));
1485 }
1486
1487 static int ars_do_start(struct nvdimm_bus_descriptor *nd_desc,
1488                 struct nd_cmd_ars_start *cmd, u64 addr, u64 length)
1489 {
1490         int rc;
1491
1492         cmd->address = addr;
1493         cmd->length = length;
1494         cmd->type = ND_ARS_PERSISTENT;
1495
1496         while (1) {
1497                 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_START, cmd,
1498                                 sizeof(*cmd));
1499                 if (rc)
1500                         return rc;
1501                 switch (cmd->status) {
1502                 case 0:
1503                         return 0;
1504                 case 1:
1505                         /* ARS unsupported, but we should never get here */
1506                         return 0;
1507                 case 2:
1508                         return -EINVAL;
1509                 case 3:
1510                         /* ARS is in progress */
1511                         msleep(1000);
1512                         break;
1513                 default:
1514                         return -ENXIO;
1515                 }
1516         }
1517 }
1518
1519 static int ars_get_status(struct nvdimm_bus_descriptor *nd_desc,
1520                 struct nd_cmd_ars_status *cmd)
1521 {
1522         int rc;
1523
1524         while (1) {
1525                 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_STATUS, cmd,
1526                         sizeof(*cmd));
1527                 if (rc || cmd->status & 0xffff)
1528                         return -ENXIO;
1529
1530                 /* Check extended status (Upper two bytes) */
1531                 switch (cmd->status >> 16) {
1532                 case 0:
1533                         return 0;
1534                 case 1:
1535                         /* ARS is in progress */
1536                         msleep(1000);
1537                         break;
1538                 case 2:
1539                         /* No ARS performed for the current boot */
1540                         return 0;
1541                 default:
1542                         return -ENXIO;
1543                 }
1544         }
1545 }
1546
1547 static int ars_status_process_records(struct nvdimm_bus *nvdimm_bus,
1548                 struct nd_cmd_ars_status *ars_status, u64 start)
1549 {
1550         int rc;
1551         u32 i;
1552
1553         /*
1554          * The address field returned by ars_status should be either
1555          * less than or equal to the address we last started ARS for.
1556          * The (start, length) returned by ars_status should also have
1557          * non-zero overlap with the range we started ARS for.
1558          * If this is not the case, bail.
1559          */
1560         if (ars_status->address > start ||
1561                         (ars_status->address + ars_status->length < start))
1562                 return -ENXIO;
1563
1564         for (i = 0; i < ars_status->num_records; i++) {
1565                 rc = nvdimm_bus_add_poison(nvdimm_bus,
1566                                 ars_status->records[i].err_address,
1567                                 ars_status->records[i].length);
1568                 if (rc)
1569                         return rc;
1570         }
1571
1572         return 0;
1573 }
1574
1575 static int acpi_nfit_find_poison(struct acpi_nfit_desc *acpi_desc,
1576                 struct nd_region_desc *ndr_desc)
1577 {
1578         struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
1579         struct nvdimm_bus *nvdimm_bus = acpi_desc->nvdimm_bus;
1580         struct nd_cmd_ars_status *ars_status = NULL;
1581         struct nd_cmd_ars_start *ars_start = NULL;
1582         struct nd_cmd_ars_cap *ars_cap = NULL;
1583         u64 start, len, cur, remaining;
1584         int rc;
1585
1586         ars_cap = kzalloc(sizeof(*ars_cap), GFP_KERNEL);
1587         if (!ars_cap)
1588                 return -ENOMEM;
1589
1590         start = ndr_desc->res->start;
1591         len = ndr_desc->res->end - ndr_desc->res->start + 1;
1592
1593         rc = ars_get_cap(nd_desc, ars_cap, start, len);
1594         if (rc)
1595                 goto out;
1596
1597         /*
1598          * If ARS is unsupported, or if the 'Persistent Memory Scrub' flag in
1599          * extended status is not set, skip this but continue initialization
1600          */
1601         if ((ars_cap->status & 0xffff) ||
1602                 !(ars_cap->status >> 16 & ND_ARS_PERSISTENT)) {
1603                 dev_warn(acpi_desc->dev,
1604                         "ARS unsupported (status: 0x%x), won't create an error list\n",
1605                         ars_cap->status);
1606                 goto out;
1607         }
1608
1609         /*
1610          * Check if a full-range ARS has been run. If so, use those results
1611          * without having to start a new ARS.
1612          */
1613         ars_status = kzalloc(ars_cap->max_ars_out + sizeof(*ars_status),
1614                         GFP_KERNEL);
1615         if (!ars_status) {
1616                 rc = -ENOMEM;
1617                 goto out;
1618         }
1619
1620         rc = ars_get_status(nd_desc, ars_status);
1621         if (rc)
1622                 goto out;
1623
1624         if (ars_status->address <= start &&
1625                 (ars_status->address + ars_status->length >= start + len)) {
1626                 rc = ars_status_process_records(nvdimm_bus, ars_status, start);
1627                 goto out;
1628         }
1629
1630         /*
1631          * ARS_STATUS can overflow if the number of poison entries found is
1632          * greater than the maximum buffer size (ars_cap->max_ars_out)
1633          * To detect overflow, check if the length field of ars_status
1634          * is less than the length we supplied. If so, process the
1635          * error entries we got, adjust the start point, and start again
1636          */
1637         ars_start = kzalloc(sizeof(*ars_start), GFP_KERNEL);
1638         if (!ars_start)
1639                 return -ENOMEM;
1640
1641         cur = start;
1642         remaining = len;
1643         do {
1644                 u64 done, end;
1645
1646                 rc = ars_do_start(nd_desc, ars_start, cur, remaining);
1647                 if (rc)
1648                         goto out;
1649
1650                 rc = ars_get_status(nd_desc, ars_status);
1651                 if (rc)
1652                         goto out;
1653
1654                 rc = ars_status_process_records(nvdimm_bus, ars_status, cur);
1655                 if (rc)
1656                         goto out;
1657
1658                 end = min(cur + remaining,
1659                         ars_status->address + ars_status->length);
1660                 done = end - cur;
1661                 cur += done;
1662                 remaining -= done;
1663         } while (remaining);
1664
1665  out:
1666         kfree(ars_cap);
1667         kfree(ars_start);
1668         kfree(ars_status);
1669         return rc;
1670 }
1671
1672 static int acpi_nfit_init_mapping(struct acpi_nfit_desc *acpi_desc,
1673                 struct nd_mapping *nd_mapping, struct nd_region_desc *ndr_desc,
1674                 struct acpi_nfit_memory_map *memdev,
1675                 struct acpi_nfit_system_address *spa)
1676 {
1677         struct nvdimm *nvdimm = acpi_nfit_dimm_by_handle(acpi_desc,
1678                         memdev->device_handle);
1679         struct nd_blk_region_desc *ndbr_desc;
1680         struct nfit_mem *nfit_mem;
1681         int blk_valid = 0;
1682
1683         if (!nvdimm) {
1684                 dev_err(acpi_desc->dev, "spa%d dimm: %#x not found\n",
1685                                 spa->range_index, memdev->device_handle);
1686                 return -ENODEV;
1687         }
1688
1689         nd_mapping->nvdimm = nvdimm;
1690         switch (nfit_spa_type(spa)) {
1691         case NFIT_SPA_PM:
1692         case NFIT_SPA_VOLATILE:
1693                 nd_mapping->start = memdev->address;
1694                 nd_mapping->size = memdev->region_size;
1695                 break;
1696         case NFIT_SPA_DCR:
1697                 nfit_mem = nvdimm_provider_data(nvdimm);
1698                 if (!nfit_mem || !nfit_mem->bdw) {
1699                         dev_dbg(acpi_desc->dev, "spa%d %s missing bdw\n",
1700                                         spa->range_index, nvdimm_name(nvdimm));
1701                 } else {
1702                         nd_mapping->size = nfit_mem->bdw->capacity;
1703                         nd_mapping->start = nfit_mem->bdw->start_address;
1704                         ndr_desc->num_lanes = nfit_mem->bdw->windows;
1705                         blk_valid = 1;
1706                 }
1707
1708                 ndr_desc->nd_mapping = nd_mapping;
1709                 ndr_desc->num_mappings = blk_valid;
1710                 ndbr_desc = to_blk_region_desc(ndr_desc);
1711                 ndbr_desc->enable = acpi_nfit_blk_region_enable;
1712                 ndbr_desc->disable = acpi_nfit_blk_region_disable;
1713                 ndbr_desc->do_io = acpi_desc->blk_do_io;
1714                 if (!nvdimm_blk_region_create(acpi_desc->nvdimm_bus, ndr_desc))
1715                         return -ENOMEM;
1716                 break;
1717         }
1718
1719         return 0;
1720 }
1721
1722 static int acpi_nfit_register_region(struct acpi_nfit_desc *acpi_desc,
1723                 struct nfit_spa *nfit_spa)
1724 {
1725         static struct nd_mapping nd_mappings[ND_MAX_MAPPINGS];
1726         struct acpi_nfit_system_address *spa = nfit_spa->spa;
1727         struct nd_blk_region_desc ndbr_desc;
1728         struct nd_region_desc *ndr_desc;
1729         struct nfit_memdev *nfit_memdev;
1730         struct nvdimm_bus *nvdimm_bus;
1731         struct resource res;
1732         int count = 0, rc;
1733
1734         if (nfit_spa->is_registered)
1735                 return 0;
1736
1737         if (spa->range_index == 0) {
1738                 dev_dbg(acpi_desc->dev, "%s: detected invalid spa index\n",
1739                                 __func__);
1740                 return 0;
1741         }
1742
1743         memset(&res, 0, sizeof(res));
1744         memset(&nd_mappings, 0, sizeof(nd_mappings));
1745         memset(&ndbr_desc, 0, sizeof(ndbr_desc));
1746         res.start = spa->address;
1747         res.end = res.start + spa->length - 1;
1748         ndr_desc = &ndbr_desc.ndr_desc;
1749         ndr_desc->res = &res;
1750         ndr_desc->provider_data = nfit_spa;
1751         ndr_desc->attr_groups = acpi_nfit_region_attribute_groups;
1752         if (spa->flags & ACPI_NFIT_PROXIMITY_VALID)
1753                 ndr_desc->numa_node = acpi_map_pxm_to_online_node(
1754                                                 spa->proximity_domain);
1755         else
1756                 ndr_desc->numa_node = NUMA_NO_NODE;
1757
1758         list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
1759                 struct acpi_nfit_memory_map *memdev = nfit_memdev->memdev;
1760                 struct nd_mapping *nd_mapping;
1761
1762                 if (memdev->range_index != spa->range_index)
1763                         continue;
1764                 if (count >= ND_MAX_MAPPINGS) {
1765                         dev_err(acpi_desc->dev, "spa%d exceeds max mappings %d\n",
1766                                         spa->range_index, ND_MAX_MAPPINGS);
1767                         return -ENXIO;
1768                 }
1769                 nd_mapping = &nd_mappings[count++];
1770                 rc = acpi_nfit_init_mapping(acpi_desc, nd_mapping, ndr_desc,
1771                                 memdev, spa);
1772                 if (rc)
1773                         return rc;
1774         }
1775
1776         ndr_desc->nd_mapping = nd_mappings;
1777         ndr_desc->num_mappings = count;
1778         rc = acpi_nfit_init_interleave_set(acpi_desc, ndr_desc, spa);
1779         if (rc)
1780                 return rc;
1781
1782         nvdimm_bus = acpi_desc->nvdimm_bus;
1783         if (nfit_spa_type(spa) == NFIT_SPA_PM) {
1784                 rc = acpi_nfit_find_poison(acpi_desc, ndr_desc);
1785                 if (rc) {
1786                         dev_err(acpi_desc->dev,
1787                                 "error while performing ARS to find poison: %d\n",
1788                                 rc);
1789                         return rc;
1790                 }
1791                 if (!nvdimm_pmem_region_create(nvdimm_bus, ndr_desc))
1792                         return -ENOMEM;
1793         } else if (nfit_spa_type(spa) == NFIT_SPA_VOLATILE) {
1794                 if (!nvdimm_volatile_region_create(nvdimm_bus, ndr_desc))
1795                         return -ENOMEM;
1796         }
1797
1798         nfit_spa->is_registered = 1;
1799         return 0;
1800 }
1801
1802 static int acpi_nfit_register_regions(struct acpi_nfit_desc *acpi_desc)
1803 {
1804         struct nfit_spa *nfit_spa;
1805
1806         list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
1807                 int rc = acpi_nfit_register_region(acpi_desc, nfit_spa);
1808
1809                 if (rc)
1810                         return rc;
1811         }
1812         return 0;
1813 }
1814
1815 static int acpi_nfit_check_deletions(struct acpi_nfit_desc *acpi_desc,
1816                 struct nfit_table_prev *prev)
1817 {
1818         struct device *dev = acpi_desc->dev;
1819
1820         if (!list_empty(&prev->spas) ||
1821                         !list_empty(&prev->memdevs) ||
1822                         !list_empty(&prev->dcrs) ||
1823                         !list_empty(&prev->bdws) ||
1824                         !list_empty(&prev->idts) ||
1825                         !list_empty(&prev->flushes)) {
1826                 dev_err(dev, "new nfit deletes entries (unsupported)\n");
1827                 return -ENXIO;
1828         }
1829         return 0;
1830 }
1831
1832 int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, acpi_size sz)
1833 {
1834         struct device *dev = acpi_desc->dev;
1835         struct nfit_table_prev prev;
1836         const void *end;
1837         u8 *data;
1838         int rc;
1839
1840         mutex_lock(&acpi_desc->init_mutex);
1841
1842         INIT_LIST_HEAD(&prev.spas);
1843         INIT_LIST_HEAD(&prev.memdevs);
1844         INIT_LIST_HEAD(&prev.dcrs);
1845         INIT_LIST_HEAD(&prev.bdws);
1846         INIT_LIST_HEAD(&prev.idts);
1847         INIT_LIST_HEAD(&prev.flushes);
1848
1849         list_cut_position(&prev.spas, &acpi_desc->spas,
1850                                 acpi_desc->spas.prev);
1851         list_cut_position(&prev.memdevs, &acpi_desc->memdevs,
1852                                 acpi_desc->memdevs.prev);
1853         list_cut_position(&prev.dcrs, &acpi_desc->dcrs,
1854                                 acpi_desc->dcrs.prev);
1855         list_cut_position(&prev.bdws, &acpi_desc->bdws,
1856                                 acpi_desc->bdws.prev);
1857         list_cut_position(&prev.idts, &acpi_desc->idts,
1858                                 acpi_desc->idts.prev);
1859         list_cut_position(&prev.flushes, &acpi_desc->flushes,
1860                                 acpi_desc->flushes.prev);
1861
1862         data = (u8 *) acpi_desc->nfit;
1863         end = data + sz;
1864         while (!IS_ERR_OR_NULL(data))
1865                 data = add_table(acpi_desc, &prev, data, end);
1866
1867         if (IS_ERR(data)) {
1868                 dev_dbg(dev, "%s: nfit table parsing error: %ld\n", __func__,
1869                                 PTR_ERR(data));
1870                 rc = PTR_ERR(data);
1871                 goto out_unlock;
1872         }
1873
1874         rc = acpi_nfit_check_deletions(acpi_desc, &prev);
1875         if (rc)
1876                 goto out_unlock;
1877
1878         if (nfit_mem_init(acpi_desc) != 0) {
1879                 rc = -ENOMEM;
1880                 goto out_unlock;
1881         }
1882
1883         acpi_nfit_init_dsms(acpi_desc);
1884
1885         rc = acpi_nfit_register_dimms(acpi_desc);
1886         if (rc)
1887                 goto out_unlock;
1888
1889         rc = acpi_nfit_register_regions(acpi_desc);
1890
1891  out_unlock:
1892         mutex_unlock(&acpi_desc->init_mutex);
1893         return rc;
1894 }
1895 EXPORT_SYMBOL_GPL(acpi_nfit_init);
1896
1897 static struct acpi_nfit_desc *acpi_nfit_desc_init(struct acpi_device *adev)
1898 {
1899         struct nvdimm_bus_descriptor *nd_desc;
1900         struct acpi_nfit_desc *acpi_desc;
1901         struct device *dev = &adev->dev;
1902
1903         acpi_desc = devm_kzalloc(dev, sizeof(*acpi_desc), GFP_KERNEL);
1904         if (!acpi_desc)
1905                 return ERR_PTR(-ENOMEM);
1906
1907         dev_set_drvdata(dev, acpi_desc);
1908         acpi_desc->dev = dev;
1909         acpi_desc->blk_do_io = acpi_nfit_blk_region_do_io;
1910         nd_desc = &acpi_desc->nd_desc;
1911         nd_desc->provider_name = "ACPI.NFIT";
1912         nd_desc->ndctl = acpi_nfit_ctl;
1913         nd_desc->attr_groups = acpi_nfit_attribute_groups;
1914
1915         acpi_desc->nvdimm_bus = nvdimm_bus_register(dev, nd_desc);
1916         if (!acpi_desc->nvdimm_bus) {
1917                 devm_kfree(dev, acpi_desc);
1918                 return ERR_PTR(-ENXIO);
1919         }
1920
1921         INIT_LIST_HEAD(&acpi_desc->spa_maps);
1922         INIT_LIST_HEAD(&acpi_desc->spas);
1923         INIT_LIST_HEAD(&acpi_desc->dcrs);
1924         INIT_LIST_HEAD(&acpi_desc->bdws);
1925         INIT_LIST_HEAD(&acpi_desc->idts);
1926         INIT_LIST_HEAD(&acpi_desc->flushes);
1927         INIT_LIST_HEAD(&acpi_desc->memdevs);
1928         INIT_LIST_HEAD(&acpi_desc->dimms);
1929         mutex_init(&acpi_desc->spa_map_mutex);
1930         mutex_init(&acpi_desc->init_mutex);
1931
1932         return acpi_desc;
1933 }
1934
1935 static int acpi_nfit_add(struct acpi_device *adev)
1936 {
1937         struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
1938         struct acpi_nfit_desc *acpi_desc;
1939         struct device *dev = &adev->dev;
1940         struct acpi_table_header *tbl;
1941         acpi_status status = AE_OK;
1942         acpi_size sz;
1943         int rc;
1944
1945         status = acpi_get_table_with_size("NFIT", 0, &tbl, &sz);
1946         if (ACPI_FAILURE(status)) {
1947                 /* This is ok, we could have an nvdimm hotplugged later */
1948                 dev_dbg(dev, "failed to find NFIT at startup\n");
1949                 return 0;
1950         }
1951
1952         acpi_desc = acpi_nfit_desc_init(adev);
1953         if (IS_ERR(acpi_desc)) {
1954                 dev_err(dev, "%s: error initializing acpi_desc: %ld\n",
1955                                 __func__, PTR_ERR(acpi_desc));
1956                 return PTR_ERR(acpi_desc);
1957         }
1958
1959         /*
1960          * Save the acpi header for later and then skip it,
1961          * making nfit point to the first nfit table header.
1962          */
1963         acpi_desc->acpi_header = *tbl;
1964         acpi_desc->nfit = (void *) tbl + sizeof(struct acpi_table_nfit);
1965         sz -= sizeof(struct acpi_table_nfit);
1966
1967         /* Evaluate _FIT and override with that if present */
1968         status = acpi_evaluate_object(adev->handle, "_FIT", NULL, &buf);
1969         if (ACPI_SUCCESS(status) && buf.length > 0) {
1970                 union acpi_object *obj;
1971                 /*
1972                  * Adjust for the acpi_object header of the _FIT
1973                  */
1974                 obj = buf.pointer;
1975                 if (obj->type == ACPI_TYPE_BUFFER) {
1976                         acpi_desc->nfit =
1977                                 (struct acpi_nfit_header *)obj->buffer.pointer;
1978                         sz = obj->buffer.length;
1979                 } else
1980                         dev_dbg(dev, "%s invalid type %d, ignoring _FIT\n",
1981                                  __func__, (int) obj->type);
1982         }
1983
1984         rc = acpi_nfit_init(acpi_desc, sz);
1985         if (rc) {
1986                 nvdimm_bus_unregister(acpi_desc->nvdimm_bus);
1987                 return rc;
1988         }
1989         return 0;
1990 }
1991
1992 static int acpi_nfit_remove(struct acpi_device *adev)
1993 {
1994         struct acpi_nfit_desc *acpi_desc = dev_get_drvdata(&adev->dev);
1995
1996         nvdimm_bus_unregister(acpi_desc->nvdimm_bus);
1997         return 0;
1998 }
1999
2000 static void acpi_nfit_notify(struct acpi_device *adev, u32 event)
2001 {
2002         struct acpi_nfit_desc *acpi_desc = dev_get_drvdata(&adev->dev);
2003         struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
2004         struct acpi_nfit_header *nfit_saved;
2005         union acpi_object *obj;
2006         struct device *dev = &adev->dev;
2007         acpi_status status;
2008         int ret;
2009
2010         dev_dbg(dev, "%s: event: %d\n", __func__, event);
2011
2012         device_lock(dev);
2013         if (!dev->driver) {
2014                 /* dev->driver may be null if we're being removed */
2015                 dev_dbg(dev, "%s: no driver found for dev\n", __func__);
2016                 goto out_unlock;
2017         }
2018
2019         if (!acpi_desc) {
2020                 acpi_desc = acpi_nfit_desc_init(adev);
2021                 if (IS_ERR(acpi_desc)) {
2022                         dev_err(dev, "%s: error initializing acpi_desc: %ld\n",
2023                                 __func__, PTR_ERR(acpi_desc));
2024                         goto out_unlock;
2025                 }
2026         }
2027
2028         /* Evaluate _FIT */
2029         status = acpi_evaluate_object(adev->handle, "_FIT", NULL, &buf);
2030         if (ACPI_FAILURE(status)) {
2031                 dev_err(dev, "failed to evaluate _FIT\n");
2032                 goto out_unlock;
2033         }
2034
2035         nfit_saved = acpi_desc->nfit;
2036         obj = buf.pointer;
2037         if (obj->type == ACPI_TYPE_BUFFER) {
2038                 acpi_desc->nfit =
2039                         (struct acpi_nfit_header *)obj->buffer.pointer;
2040                 ret = acpi_nfit_init(acpi_desc, obj->buffer.length);
2041                 if (ret) {
2042                         /* Merge failed, restore old nfit, and exit */
2043                         acpi_desc->nfit = nfit_saved;
2044                         dev_err(dev, "failed to merge updated NFIT\n");
2045                 }
2046         } else {
2047                 /* Bad _FIT, restore old nfit */
2048                 dev_err(dev, "Invalid _FIT\n");
2049         }
2050         kfree(buf.pointer);
2051
2052  out_unlock:
2053         device_unlock(dev);
2054 }
2055
2056 static const struct acpi_device_id acpi_nfit_ids[] = {
2057         { "ACPI0012", 0 },
2058         { "", 0 },
2059 };
2060 MODULE_DEVICE_TABLE(acpi, acpi_nfit_ids);
2061
2062 static struct acpi_driver acpi_nfit_driver = {
2063         .name = KBUILD_MODNAME,
2064         .ids = acpi_nfit_ids,
2065         .ops = {
2066                 .add = acpi_nfit_add,
2067                 .remove = acpi_nfit_remove,
2068                 .notify = acpi_nfit_notify,
2069         },
2070 };
2071
2072 static __init int nfit_init(void)
2073 {
2074         BUILD_BUG_ON(sizeof(struct acpi_table_nfit) != 40);
2075         BUILD_BUG_ON(sizeof(struct acpi_nfit_system_address) != 56);
2076         BUILD_BUG_ON(sizeof(struct acpi_nfit_memory_map) != 48);
2077         BUILD_BUG_ON(sizeof(struct acpi_nfit_interleave) != 20);
2078         BUILD_BUG_ON(sizeof(struct acpi_nfit_smbios) != 9);
2079         BUILD_BUG_ON(sizeof(struct acpi_nfit_control_region) != 80);
2080         BUILD_BUG_ON(sizeof(struct acpi_nfit_data_region) != 40);
2081
2082         acpi_str_to_uuid(UUID_VOLATILE_MEMORY, nfit_uuid[NFIT_SPA_VOLATILE]);
2083         acpi_str_to_uuid(UUID_PERSISTENT_MEMORY, nfit_uuid[NFIT_SPA_PM]);
2084         acpi_str_to_uuid(UUID_CONTROL_REGION, nfit_uuid[NFIT_SPA_DCR]);
2085         acpi_str_to_uuid(UUID_DATA_REGION, nfit_uuid[NFIT_SPA_BDW]);
2086         acpi_str_to_uuid(UUID_VOLATILE_VIRTUAL_DISK, nfit_uuid[NFIT_SPA_VDISK]);
2087         acpi_str_to_uuid(UUID_VOLATILE_VIRTUAL_CD, nfit_uuid[NFIT_SPA_VCD]);
2088         acpi_str_to_uuid(UUID_PERSISTENT_VIRTUAL_DISK, nfit_uuid[NFIT_SPA_PDISK]);
2089         acpi_str_to_uuid(UUID_PERSISTENT_VIRTUAL_CD, nfit_uuid[NFIT_SPA_PCD]);
2090         acpi_str_to_uuid(UUID_NFIT_BUS, nfit_uuid[NFIT_DEV_BUS]);
2091         acpi_str_to_uuid(UUID_NFIT_DIMM, nfit_uuid[NFIT_DEV_DIMM]);
2092
2093         return acpi_bus_register_driver(&acpi_nfit_driver);
2094 }
2095
2096 static __exit void nfit_exit(void)
2097 {
2098         acpi_bus_unregister_driver(&acpi_nfit_driver);
2099 }
2100
2101 module_init(nfit_init);
2102 module_exit(nfit_exit);
2103 MODULE_LICENSE("GPL v2");
2104 MODULE_AUTHOR("Intel Corporation");