2 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
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.
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.
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/list.h>
19 #include <linux/acpi.h>
20 #include <linux/sort.h>
21 #include <linux/pmem.h>
23 #include <asm/cacheflush.h>
27 * For readq() and writeq() on 32-bit builds, the hi-lo, lo-hi order is
30 #include <linux/io-64-nonatomic-hi-lo.h>
32 static bool force_enable_dimms;
33 module_param(force_enable_dimms, bool, S_IRUGO|S_IWUSR);
34 MODULE_PARM_DESC(force_enable_dimms, "Ignore _STA (ACPI DIMM device) status");
36 struct nfit_table_prev {
37 struct list_head spas;
38 struct list_head memdevs;
39 struct list_head dcrs;
40 struct list_head bdws;
41 struct list_head idts;
42 struct list_head flushes;
45 static u8 nfit_uuid[NFIT_UUID_MAX][16];
47 const u8 *to_nfit_uuid(enum nfit_uuids id)
51 EXPORT_SYMBOL(to_nfit_uuid);
53 static struct acpi_nfit_desc *to_acpi_nfit_desc(
54 struct nvdimm_bus_descriptor *nd_desc)
56 return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
59 static struct acpi_device *to_acpi_dev(struct acpi_nfit_desc *acpi_desc)
61 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
64 * If provider == 'ACPI.NFIT' we can assume 'dev' is a struct
67 if (!nd_desc->provider_name
68 || strcmp(nd_desc->provider_name, "ACPI.NFIT") != 0)
71 return to_acpi_device(acpi_desc->dev);
74 static int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc,
75 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
78 struct acpi_nfit_desc *acpi_desc = to_acpi_nfit_desc(nd_desc);
79 const struct nd_cmd_desc *desc = NULL;
80 union acpi_object in_obj, in_buf, *out_obj;
81 struct device *dev = acpi_desc->dev;
82 const char *cmd_name, *dimm_name;
83 unsigned long dsm_mask;
90 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
91 struct acpi_device *adev = nfit_mem->adev;
95 dimm_name = nvdimm_name(nvdimm);
96 cmd_name = nvdimm_cmd_name(cmd);
97 dsm_mask = nfit_mem->dsm_mask;
98 desc = nd_cmd_dimm_desc(cmd);
99 uuid = to_nfit_uuid(NFIT_DEV_DIMM);
100 handle = adev->handle;
102 struct acpi_device *adev = to_acpi_dev(acpi_desc);
104 cmd_name = nvdimm_bus_cmd_name(cmd);
105 dsm_mask = nd_desc->dsm_mask;
106 desc = nd_cmd_bus_desc(cmd);
107 uuid = to_nfit_uuid(NFIT_DEV_BUS);
108 handle = adev->handle;
112 if (!desc || (cmd && (desc->out_num + desc->in_num == 0)))
115 if (!test_bit(cmd, &dsm_mask))
118 in_obj.type = ACPI_TYPE_PACKAGE;
119 in_obj.package.count = 1;
120 in_obj.package.elements = &in_buf;
121 in_buf.type = ACPI_TYPE_BUFFER;
122 in_buf.buffer.pointer = buf;
123 in_buf.buffer.length = 0;
125 /* libnvdimm has already validated the input envelope */
126 for (i = 0; i < desc->in_num; i++)
127 in_buf.buffer.length += nd_cmd_in_size(nvdimm, cmd, desc,
130 if (IS_ENABLED(CONFIG_ACPI_NFIT_DEBUG)) {
131 dev_dbg(dev, "%s:%s cmd: %s input length: %d\n", __func__,
132 dimm_name, cmd_name, in_buf.buffer.length);
133 print_hex_dump_debug(cmd_name, DUMP_PREFIX_OFFSET, 4,
134 4, in_buf.buffer.pointer, min_t(u32, 128,
135 in_buf.buffer.length), true);
138 out_obj = acpi_evaluate_dsm(handle, uuid, 1, cmd, &in_obj);
140 dev_dbg(dev, "%s:%s _DSM failed cmd: %s\n", __func__, dimm_name,
145 if (out_obj->package.type != ACPI_TYPE_BUFFER) {
146 dev_dbg(dev, "%s:%s unexpected output object type cmd: %s type: %d\n",
147 __func__, dimm_name, cmd_name, out_obj->type);
152 if (IS_ENABLED(CONFIG_ACPI_NFIT_DEBUG)) {
153 dev_dbg(dev, "%s:%s cmd: %s output length: %d\n", __func__,
154 dimm_name, cmd_name, out_obj->buffer.length);
155 print_hex_dump_debug(cmd_name, DUMP_PREFIX_OFFSET, 4,
156 4, out_obj->buffer.pointer, min_t(u32, 128,
157 out_obj->buffer.length), true);
160 for (i = 0, offset = 0; i < desc->out_num; i++) {
161 u32 out_size = nd_cmd_out_size(nvdimm, cmd, desc, i, buf,
162 (u32 *) out_obj->buffer.pointer);
164 if (offset + out_size > out_obj->buffer.length) {
165 dev_dbg(dev, "%s:%s output object underflow cmd: %s field: %d\n",
166 __func__, dimm_name, cmd_name, i);
170 if (in_buf.buffer.length + offset + out_size > buf_len) {
171 dev_dbg(dev, "%s:%s output overrun cmd: %s field: %d\n",
172 __func__, dimm_name, cmd_name, i);
176 memcpy(buf + in_buf.buffer.length + offset,
177 out_obj->buffer.pointer + offset, out_size);
180 if (offset + in_buf.buffer.length < buf_len) {
183 * status valid, return the number of bytes left
184 * unfilled in the output buffer
186 rc = buf_len - offset - in_buf.buffer.length;
188 dev_err(dev, "%s:%s underrun cmd: %s buf_len: %d out_len: %d\n",
189 __func__, dimm_name, cmd_name, buf_len,
202 static const char *spa_type_name(u16 type)
204 static const char *to_name[] = {
205 [NFIT_SPA_VOLATILE] = "volatile",
206 [NFIT_SPA_PM] = "pmem",
207 [NFIT_SPA_DCR] = "dimm-control-region",
208 [NFIT_SPA_BDW] = "block-data-window",
209 [NFIT_SPA_VDISK] = "volatile-disk",
210 [NFIT_SPA_VCD] = "volatile-cd",
211 [NFIT_SPA_PDISK] = "persistent-disk",
212 [NFIT_SPA_PCD] = "persistent-cd",
216 if (type > NFIT_SPA_PCD)
219 return to_name[type];
222 static int nfit_spa_type(struct acpi_nfit_system_address *spa)
226 for (i = 0; i < NFIT_UUID_MAX; i++)
227 if (memcmp(to_nfit_uuid(i), spa->range_guid, 16) == 0)
232 static bool add_spa(struct acpi_nfit_desc *acpi_desc,
233 struct nfit_table_prev *prev,
234 struct acpi_nfit_system_address *spa)
236 size_t length = min_t(size_t, sizeof(*spa), spa->header.length);
237 struct device *dev = acpi_desc->dev;
238 struct nfit_spa *nfit_spa;
240 list_for_each_entry(nfit_spa, &prev->spas, list) {
241 if (memcmp(nfit_spa->spa, spa, length) == 0) {
242 list_move_tail(&nfit_spa->list, &acpi_desc->spas);
247 nfit_spa = devm_kzalloc(dev, sizeof(*nfit_spa), GFP_KERNEL);
250 INIT_LIST_HEAD(&nfit_spa->list);
252 list_add_tail(&nfit_spa->list, &acpi_desc->spas);
253 dev_dbg(dev, "%s: spa index: %d type: %s\n", __func__,
255 spa_type_name(nfit_spa_type(spa)));
259 static bool add_memdev(struct acpi_nfit_desc *acpi_desc,
260 struct nfit_table_prev *prev,
261 struct acpi_nfit_memory_map *memdev)
263 size_t length = min_t(size_t, sizeof(*memdev), memdev->header.length);
264 struct device *dev = acpi_desc->dev;
265 struct nfit_memdev *nfit_memdev;
267 list_for_each_entry(nfit_memdev, &prev->memdevs, list)
268 if (memcmp(nfit_memdev->memdev, memdev, length) == 0) {
269 list_move_tail(&nfit_memdev->list, &acpi_desc->memdevs);
273 nfit_memdev = devm_kzalloc(dev, sizeof(*nfit_memdev), GFP_KERNEL);
276 INIT_LIST_HEAD(&nfit_memdev->list);
277 nfit_memdev->memdev = memdev;
278 list_add_tail(&nfit_memdev->list, &acpi_desc->memdevs);
279 dev_dbg(dev, "%s: memdev handle: %#x spa: %d dcr: %d\n",
280 __func__, memdev->device_handle, memdev->range_index,
281 memdev->region_index);
285 static bool add_dcr(struct acpi_nfit_desc *acpi_desc,
286 struct nfit_table_prev *prev,
287 struct acpi_nfit_control_region *dcr)
289 size_t length = min_t(size_t, sizeof(*dcr), dcr->header.length);
290 struct device *dev = acpi_desc->dev;
291 struct nfit_dcr *nfit_dcr;
293 list_for_each_entry(nfit_dcr, &prev->dcrs, list)
294 if (memcmp(nfit_dcr->dcr, dcr, length) == 0) {
295 list_move_tail(&nfit_dcr->list, &acpi_desc->dcrs);
299 nfit_dcr = devm_kzalloc(dev, sizeof(*nfit_dcr), GFP_KERNEL);
302 INIT_LIST_HEAD(&nfit_dcr->list);
304 list_add_tail(&nfit_dcr->list, &acpi_desc->dcrs);
305 dev_dbg(dev, "%s: dcr index: %d windows: %d\n", __func__,
306 dcr->region_index, dcr->windows);
310 static bool add_bdw(struct acpi_nfit_desc *acpi_desc,
311 struct nfit_table_prev *prev,
312 struct acpi_nfit_data_region *bdw)
314 size_t length = min_t(size_t, sizeof(*bdw), bdw->header.length);
315 struct device *dev = acpi_desc->dev;
316 struct nfit_bdw *nfit_bdw;
318 list_for_each_entry(nfit_bdw, &prev->bdws, list)
319 if (memcmp(nfit_bdw->bdw, bdw, length) == 0) {
320 list_move_tail(&nfit_bdw->list, &acpi_desc->bdws);
324 nfit_bdw = devm_kzalloc(dev, sizeof(*nfit_bdw), GFP_KERNEL);
327 INIT_LIST_HEAD(&nfit_bdw->list);
329 list_add_tail(&nfit_bdw->list, &acpi_desc->bdws);
330 dev_dbg(dev, "%s: bdw dcr: %d windows: %d\n", __func__,
331 bdw->region_index, bdw->windows);
335 static bool add_idt(struct acpi_nfit_desc *acpi_desc,
336 struct nfit_table_prev *prev,
337 struct acpi_nfit_interleave *idt)
339 size_t length = min_t(size_t, sizeof(*idt), idt->header.length);
340 struct device *dev = acpi_desc->dev;
341 struct nfit_idt *nfit_idt;
343 list_for_each_entry(nfit_idt, &prev->idts, list)
344 if (memcmp(nfit_idt->idt, idt, length) == 0) {
345 list_move_tail(&nfit_idt->list, &acpi_desc->idts);
349 nfit_idt = devm_kzalloc(dev, sizeof(*nfit_idt), GFP_KERNEL);
352 INIT_LIST_HEAD(&nfit_idt->list);
354 list_add_tail(&nfit_idt->list, &acpi_desc->idts);
355 dev_dbg(dev, "%s: idt index: %d num_lines: %d\n", __func__,
356 idt->interleave_index, idt->line_count);
360 static bool add_flush(struct acpi_nfit_desc *acpi_desc,
361 struct nfit_table_prev *prev,
362 struct acpi_nfit_flush_address *flush)
364 size_t length = min_t(size_t, sizeof(*flush), flush->header.length);
365 struct device *dev = acpi_desc->dev;
366 struct nfit_flush *nfit_flush;
368 list_for_each_entry(nfit_flush, &prev->flushes, list)
369 if (memcmp(nfit_flush->flush, flush, length) == 0) {
370 list_move_tail(&nfit_flush->list, &acpi_desc->flushes);
374 nfit_flush = devm_kzalloc(dev, sizeof(*nfit_flush), GFP_KERNEL);
377 INIT_LIST_HEAD(&nfit_flush->list);
378 nfit_flush->flush = flush;
379 list_add_tail(&nfit_flush->list, &acpi_desc->flushes);
380 dev_dbg(dev, "%s: nfit_flush handle: %d hint_count: %d\n", __func__,
381 flush->device_handle, flush->hint_count);
385 static void *add_table(struct acpi_nfit_desc *acpi_desc,
386 struct nfit_table_prev *prev, void *table, const void *end)
388 struct device *dev = acpi_desc->dev;
389 struct acpi_nfit_header *hdr;
390 void *err = ERR_PTR(-ENOMEM);
397 dev_warn(dev, "found a zero length table '%d' parsing nfit\n",
403 case ACPI_NFIT_TYPE_SYSTEM_ADDRESS:
404 if (!add_spa(acpi_desc, prev, table))
407 case ACPI_NFIT_TYPE_MEMORY_MAP:
408 if (!add_memdev(acpi_desc, prev, table))
411 case ACPI_NFIT_TYPE_CONTROL_REGION:
412 if (!add_dcr(acpi_desc, prev, table))
415 case ACPI_NFIT_TYPE_DATA_REGION:
416 if (!add_bdw(acpi_desc, prev, table))
419 case ACPI_NFIT_TYPE_INTERLEAVE:
420 if (!add_idt(acpi_desc, prev, table))
423 case ACPI_NFIT_TYPE_FLUSH_ADDRESS:
424 if (!add_flush(acpi_desc, prev, table))
427 case ACPI_NFIT_TYPE_SMBIOS:
428 dev_dbg(dev, "%s: smbios\n", __func__);
431 dev_err(dev, "unknown table '%d' parsing nfit\n", hdr->type);
435 return table + hdr->length;
438 static void nfit_mem_find_spa_bdw(struct acpi_nfit_desc *acpi_desc,
439 struct nfit_mem *nfit_mem)
441 u32 device_handle = __to_nfit_memdev(nfit_mem)->device_handle;
442 u16 dcr = nfit_mem->dcr->region_index;
443 struct nfit_spa *nfit_spa;
445 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
446 u16 range_index = nfit_spa->spa->range_index;
447 int type = nfit_spa_type(nfit_spa->spa);
448 struct nfit_memdev *nfit_memdev;
450 if (type != NFIT_SPA_BDW)
453 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
454 if (nfit_memdev->memdev->range_index != range_index)
456 if (nfit_memdev->memdev->device_handle != device_handle)
458 if (nfit_memdev->memdev->region_index != dcr)
461 nfit_mem->spa_bdw = nfit_spa->spa;
466 dev_dbg(acpi_desc->dev, "SPA-BDW not found for SPA-DCR %d\n",
467 nfit_mem->spa_dcr->range_index);
468 nfit_mem->bdw = NULL;
471 static void nfit_mem_init_bdw(struct acpi_nfit_desc *acpi_desc,
472 struct nfit_mem *nfit_mem, struct acpi_nfit_system_address *spa)
474 u16 dcr = __to_nfit_memdev(nfit_mem)->region_index;
475 struct nfit_memdev *nfit_memdev;
476 struct nfit_flush *nfit_flush;
477 struct nfit_bdw *nfit_bdw;
478 struct nfit_idt *nfit_idt;
479 u16 idt_idx, range_index;
481 list_for_each_entry(nfit_bdw, &acpi_desc->bdws, list) {
482 if (nfit_bdw->bdw->region_index != dcr)
484 nfit_mem->bdw = nfit_bdw->bdw;
491 nfit_mem_find_spa_bdw(acpi_desc, nfit_mem);
493 if (!nfit_mem->spa_bdw)
496 range_index = nfit_mem->spa_bdw->range_index;
497 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
498 if (nfit_memdev->memdev->range_index != range_index ||
499 nfit_memdev->memdev->region_index != dcr)
501 nfit_mem->memdev_bdw = nfit_memdev->memdev;
502 idt_idx = nfit_memdev->memdev->interleave_index;
503 list_for_each_entry(nfit_idt, &acpi_desc->idts, list) {
504 if (nfit_idt->idt->interleave_index != idt_idx)
506 nfit_mem->idt_bdw = nfit_idt->idt;
510 list_for_each_entry(nfit_flush, &acpi_desc->flushes, list) {
511 if (nfit_flush->flush->device_handle !=
512 nfit_memdev->memdev->device_handle)
514 nfit_mem->nfit_flush = nfit_flush;
521 static int nfit_mem_dcr_init(struct acpi_nfit_desc *acpi_desc,
522 struct acpi_nfit_system_address *spa)
524 struct nfit_mem *nfit_mem, *found;
525 struct nfit_memdev *nfit_memdev;
526 int type = nfit_spa_type(spa);
536 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
537 struct nfit_dcr *nfit_dcr;
541 if (nfit_memdev->memdev->range_index != spa->range_index)
544 dcr = nfit_memdev->memdev->region_index;
545 device_handle = nfit_memdev->memdev->device_handle;
546 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list)
547 if (__to_nfit_memdev(nfit_mem)->device_handle
556 nfit_mem = devm_kzalloc(acpi_desc->dev,
557 sizeof(*nfit_mem), GFP_KERNEL);
560 INIT_LIST_HEAD(&nfit_mem->list);
561 list_add(&nfit_mem->list, &acpi_desc->dimms);
564 list_for_each_entry(nfit_dcr, &acpi_desc->dcrs, list) {
565 if (nfit_dcr->dcr->region_index != dcr)
568 * Record the control region for the dimm. For
569 * the ACPI 6.1 case, where there are separate
570 * control regions for the pmem vs blk
571 * interfaces, be sure to record the extended
575 nfit_mem->dcr = nfit_dcr->dcr;
576 else if (nfit_mem->dcr->windows == 0
577 && nfit_dcr->dcr->windows)
578 nfit_mem->dcr = nfit_dcr->dcr;
582 if (dcr && !nfit_mem->dcr) {
583 dev_err(acpi_desc->dev, "SPA %d missing DCR %d\n",
584 spa->range_index, dcr);
588 if (type == NFIT_SPA_DCR) {
589 struct nfit_idt *nfit_idt;
592 /* multiple dimms may share a SPA when interleaved */
593 nfit_mem->spa_dcr = spa;
594 nfit_mem->memdev_dcr = nfit_memdev->memdev;
595 idt_idx = nfit_memdev->memdev->interleave_index;
596 list_for_each_entry(nfit_idt, &acpi_desc->idts, list) {
597 if (nfit_idt->idt->interleave_index != idt_idx)
599 nfit_mem->idt_dcr = nfit_idt->idt;
602 nfit_mem_init_bdw(acpi_desc, nfit_mem, spa);
605 * A single dimm may belong to multiple SPA-PM
606 * ranges, record at least one in addition to
609 nfit_mem->memdev_pmem = nfit_memdev->memdev;
616 static int nfit_mem_cmp(void *priv, struct list_head *_a, struct list_head *_b)
618 struct nfit_mem *a = container_of(_a, typeof(*a), list);
619 struct nfit_mem *b = container_of(_b, typeof(*b), list);
620 u32 handleA, handleB;
622 handleA = __to_nfit_memdev(a)->device_handle;
623 handleB = __to_nfit_memdev(b)->device_handle;
624 if (handleA < handleB)
626 else if (handleA > handleB)
631 static int nfit_mem_init(struct acpi_nfit_desc *acpi_desc)
633 struct nfit_spa *nfit_spa;
636 * For each SPA-DCR or SPA-PMEM address range find its
637 * corresponding MEMDEV(s). From each MEMDEV find the
638 * corresponding DCR. Then, if we're operating on a SPA-DCR,
639 * try to find a SPA-BDW and a corresponding BDW that references
640 * the DCR. Throw it all into an nfit_mem object. Note, that
643 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
646 rc = nfit_mem_dcr_init(acpi_desc, nfit_spa->spa);
651 list_sort(NULL, &acpi_desc->dimms, nfit_mem_cmp);
656 static ssize_t revision_show(struct device *dev,
657 struct device_attribute *attr, char *buf)
659 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
660 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
661 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
663 return sprintf(buf, "%d\n", acpi_desc->acpi_header.revision);
665 static DEVICE_ATTR_RO(revision);
667 static struct attribute *acpi_nfit_attributes[] = {
668 &dev_attr_revision.attr,
672 static struct attribute_group acpi_nfit_attribute_group = {
674 .attrs = acpi_nfit_attributes,
677 const struct attribute_group *acpi_nfit_attribute_groups[] = {
678 &nvdimm_bus_attribute_group,
679 &acpi_nfit_attribute_group,
682 EXPORT_SYMBOL_GPL(acpi_nfit_attribute_groups);
684 static struct acpi_nfit_memory_map *to_nfit_memdev(struct device *dev)
686 struct nvdimm *nvdimm = to_nvdimm(dev);
687 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
689 return __to_nfit_memdev(nfit_mem);
692 static struct acpi_nfit_control_region *to_nfit_dcr(struct device *dev)
694 struct nvdimm *nvdimm = to_nvdimm(dev);
695 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
697 return nfit_mem->dcr;
700 static ssize_t handle_show(struct device *dev,
701 struct device_attribute *attr, char *buf)
703 struct acpi_nfit_memory_map *memdev = to_nfit_memdev(dev);
705 return sprintf(buf, "%#x\n", memdev->device_handle);
707 static DEVICE_ATTR_RO(handle);
709 static ssize_t phys_id_show(struct device *dev,
710 struct device_attribute *attr, char *buf)
712 struct acpi_nfit_memory_map *memdev = to_nfit_memdev(dev);
714 return sprintf(buf, "%#x\n", memdev->physical_id);
716 static DEVICE_ATTR_RO(phys_id);
718 static ssize_t vendor_show(struct device *dev,
719 struct device_attribute *attr, char *buf)
721 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
723 return sprintf(buf, "%#x\n", dcr->vendor_id);
725 static DEVICE_ATTR_RO(vendor);
727 static ssize_t rev_id_show(struct device *dev,
728 struct device_attribute *attr, char *buf)
730 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
732 return sprintf(buf, "%#x\n", dcr->revision_id);
734 static DEVICE_ATTR_RO(rev_id);
736 static ssize_t device_show(struct device *dev,
737 struct device_attribute *attr, char *buf)
739 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
741 return sprintf(buf, "%#x\n", dcr->device_id);
743 static DEVICE_ATTR_RO(device);
745 static ssize_t format_show(struct device *dev,
746 struct device_attribute *attr, char *buf)
748 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
750 return sprintf(buf, "%#x\n", dcr->code);
752 static DEVICE_ATTR_RO(format);
754 static ssize_t serial_show(struct device *dev,
755 struct device_attribute *attr, char *buf)
757 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
759 return sprintf(buf, "%#x\n", dcr->serial_number);
761 static DEVICE_ATTR_RO(serial);
763 static ssize_t flags_show(struct device *dev,
764 struct device_attribute *attr, char *buf)
766 u16 flags = to_nfit_memdev(dev)->flags;
768 return sprintf(buf, "%s%s%s%s%s\n",
769 flags & ACPI_NFIT_MEM_SAVE_FAILED ? "save_fail " : "",
770 flags & ACPI_NFIT_MEM_RESTORE_FAILED ? "restore_fail " : "",
771 flags & ACPI_NFIT_MEM_FLUSH_FAILED ? "flush_fail " : "",
772 flags & ACPI_NFIT_MEM_NOT_ARMED ? "not_armed " : "",
773 flags & ACPI_NFIT_MEM_HEALTH_OBSERVED ? "smart_event " : "");
775 static DEVICE_ATTR_RO(flags);
777 static struct attribute *acpi_nfit_dimm_attributes[] = {
778 &dev_attr_handle.attr,
779 &dev_attr_phys_id.attr,
780 &dev_attr_vendor.attr,
781 &dev_attr_device.attr,
782 &dev_attr_format.attr,
783 &dev_attr_serial.attr,
784 &dev_attr_rev_id.attr,
785 &dev_attr_flags.attr,
789 static umode_t acpi_nfit_dimm_attr_visible(struct kobject *kobj,
790 struct attribute *a, int n)
792 struct device *dev = container_of(kobj, struct device, kobj);
794 if (to_nfit_dcr(dev))
800 static struct attribute_group acpi_nfit_dimm_attribute_group = {
802 .attrs = acpi_nfit_dimm_attributes,
803 .is_visible = acpi_nfit_dimm_attr_visible,
806 static const struct attribute_group *acpi_nfit_dimm_attribute_groups[] = {
807 &nvdimm_attribute_group,
808 &nd_device_attribute_group,
809 &acpi_nfit_dimm_attribute_group,
813 static struct nvdimm *acpi_nfit_dimm_by_handle(struct acpi_nfit_desc *acpi_desc,
816 struct nfit_mem *nfit_mem;
818 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list)
819 if (__to_nfit_memdev(nfit_mem)->device_handle == device_handle)
820 return nfit_mem->nvdimm;
825 static int acpi_nfit_add_dimm(struct acpi_nfit_desc *acpi_desc,
826 struct nfit_mem *nfit_mem, u32 device_handle)
828 struct acpi_device *adev, *adev_dimm;
829 struct device *dev = acpi_desc->dev;
830 const u8 *uuid = to_nfit_uuid(NFIT_DEV_DIMM);
833 nfit_mem->dsm_mask = acpi_desc->dimm_dsm_force_en;
834 adev = to_acpi_dev(acpi_desc);
838 adev_dimm = acpi_find_child_device(adev, device_handle, false);
839 nfit_mem->adev = adev_dimm;
841 dev_err(dev, "no ACPI.NFIT device with _ADR %#x, disabling...\n",
843 return force_enable_dimms ? 0 : -ENODEV;
846 for (i = ND_CMD_SMART; i <= ND_CMD_VENDOR; i++)
847 if (acpi_check_dsm(adev_dimm->handle, uuid, 1, 1ULL << i))
848 set_bit(i, &nfit_mem->dsm_mask);
853 static int acpi_nfit_register_dimms(struct acpi_nfit_desc *acpi_desc)
855 struct nfit_mem *nfit_mem;
858 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
859 struct nvdimm *nvdimm;
860 unsigned long flags = 0;
865 device_handle = __to_nfit_memdev(nfit_mem)->device_handle;
866 nvdimm = acpi_nfit_dimm_by_handle(acpi_desc, device_handle);
872 if (nfit_mem->bdw && nfit_mem->memdev_pmem)
873 flags |= NDD_ALIASING;
875 mem_flags = __to_nfit_memdev(nfit_mem)->flags;
876 if (mem_flags & ACPI_NFIT_MEM_NOT_ARMED)
877 flags |= NDD_UNARMED;
879 rc = acpi_nfit_add_dimm(acpi_desc, nfit_mem, device_handle);
883 nvdimm = nvdimm_create(acpi_desc->nvdimm_bus, nfit_mem,
884 acpi_nfit_dimm_attribute_groups,
885 flags, &nfit_mem->dsm_mask);
889 nfit_mem->nvdimm = nvdimm;
892 if ((mem_flags & ACPI_NFIT_MEM_FAILED_MASK) == 0)
895 dev_info(acpi_desc->dev, "%s flags:%s%s%s%s\n",
897 mem_flags & ACPI_NFIT_MEM_SAVE_FAILED ? " save_fail" : "",
898 mem_flags & ACPI_NFIT_MEM_RESTORE_FAILED ? " restore_fail":"",
899 mem_flags & ACPI_NFIT_MEM_FLUSH_FAILED ? " flush_fail" : "",
900 mem_flags & ACPI_NFIT_MEM_NOT_ARMED ? " not_armed" : "");
904 return nvdimm_bus_check_dimm_count(acpi_desc->nvdimm_bus, dimm_count);
907 static void acpi_nfit_init_dsms(struct acpi_nfit_desc *acpi_desc)
909 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
910 const u8 *uuid = to_nfit_uuid(NFIT_DEV_BUS);
911 struct acpi_device *adev;
914 nd_desc->dsm_mask = acpi_desc->bus_dsm_force_en;
915 adev = to_acpi_dev(acpi_desc);
919 for (i = ND_CMD_ARS_CAP; i <= ND_CMD_ARS_STATUS; i++)
920 if (acpi_check_dsm(adev->handle, uuid, 1, 1ULL << i))
921 set_bit(i, &nd_desc->dsm_mask);
924 static ssize_t range_index_show(struct device *dev,
925 struct device_attribute *attr, char *buf)
927 struct nd_region *nd_region = to_nd_region(dev);
928 struct nfit_spa *nfit_spa = nd_region_provider_data(nd_region);
930 return sprintf(buf, "%d\n", nfit_spa->spa->range_index);
932 static DEVICE_ATTR_RO(range_index);
934 static struct attribute *acpi_nfit_region_attributes[] = {
935 &dev_attr_range_index.attr,
939 static struct attribute_group acpi_nfit_region_attribute_group = {
941 .attrs = acpi_nfit_region_attributes,
944 static const struct attribute_group *acpi_nfit_region_attribute_groups[] = {
945 &nd_region_attribute_group,
946 &nd_mapping_attribute_group,
947 &nd_device_attribute_group,
948 &nd_numa_attribute_group,
949 &acpi_nfit_region_attribute_group,
953 /* enough info to uniquely specify an interleave set */
954 struct nfit_set_info {
955 struct nfit_set_info_map {
962 static size_t sizeof_nfit_set_info(int num_mappings)
964 return sizeof(struct nfit_set_info)
965 + num_mappings * sizeof(struct nfit_set_info_map);
968 static int cmp_map_compat(const void *m0, const void *m1)
970 const struct nfit_set_info_map *map0 = m0;
971 const struct nfit_set_info_map *map1 = m1;
973 return memcmp(&map0->region_offset, &map1->region_offset,
977 static int cmp_map(const void *m0, const void *m1)
979 const struct nfit_set_info_map *map0 = m0;
980 const struct nfit_set_info_map *map1 = m1;
982 if (map0->region_offset < map1->region_offset)
984 else if (map0->region_offset > map1->region_offset)
989 /* Retrieve the nth entry referencing this spa */
990 static struct acpi_nfit_memory_map *memdev_from_spa(
991 struct acpi_nfit_desc *acpi_desc, u16 range_index, int n)
993 struct nfit_memdev *nfit_memdev;
995 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list)
996 if (nfit_memdev->memdev->range_index == range_index)
998 return nfit_memdev->memdev;
1002 static int acpi_nfit_init_interleave_set(struct acpi_nfit_desc *acpi_desc,
1003 struct nd_region_desc *ndr_desc,
1004 struct acpi_nfit_system_address *spa)
1006 int i, spa_type = nfit_spa_type(spa);
1007 struct device *dev = acpi_desc->dev;
1008 struct nd_interleave_set *nd_set;
1009 u16 nr = ndr_desc->num_mappings;
1010 struct nfit_set_info *info;
1012 if (spa_type == NFIT_SPA_PM || spa_type == NFIT_SPA_VOLATILE)
1017 nd_set = devm_kzalloc(dev, sizeof(*nd_set), GFP_KERNEL);
1021 info = devm_kzalloc(dev, sizeof_nfit_set_info(nr), GFP_KERNEL);
1024 for (i = 0; i < nr; i++) {
1025 struct nd_mapping *nd_mapping = &ndr_desc->nd_mapping[i];
1026 struct nfit_set_info_map *map = &info->mapping[i];
1027 struct nvdimm *nvdimm = nd_mapping->nvdimm;
1028 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1029 struct acpi_nfit_memory_map *memdev = memdev_from_spa(acpi_desc,
1030 spa->range_index, i);
1032 if (!memdev || !nfit_mem->dcr) {
1033 dev_err(dev, "%s: failed to find DCR\n", __func__);
1037 map->region_offset = memdev->region_offset;
1038 map->serial_number = nfit_mem->dcr->serial_number;
1041 sort(&info->mapping[0], nr, sizeof(struct nfit_set_info_map),
1043 nd_set->cookie = nd_fletcher64(info, sizeof_nfit_set_info(nr), 0);
1045 /* support namespaces created with the wrong sort order */
1046 sort(&info->mapping[0], nr, sizeof(struct nfit_set_info_map),
1047 cmp_map_compat, NULL);
1048 nd_set->altcookie = nd_fletcher64(info, sizeof_nfit_set_info(nr), 0);
1050 ndr_desc->nd_set = nd_set;
1051 devm_kfree(dev, info);
1056 static u64 to_interleave_offset(u64 offset, struct nfit_blk_mmio *mmio)
1058 struct acpi_nfit_interleave *idt = mmio->idt;
1059 u32 sub_line_offset, line_index, line_offset;
1060 u64 line_no, table_skip_count, table_offset;
1062 line_no = div_u64_rem(offset, mmio->line_size, &sub_line_offset);
1063 table_skip_count = div_u64_rem(line_no, mmio->num_lines, &line_index);
1064 line_offset = idt->line_offset[line_index]
1066 table_offset = table_skip_count * mmio->table_size;
1068 return mmio->base_offset + line_offset + table_offset + sub_line_offset;
1071 static void wmb_blk(struct nfit_blk *nfit_blk)
1074 if (nfit_blk->nvdimm_flush) {
1076 * The first wmb() is needed to 'sfence' all previous writes
1077 * such that they are architecturally visible for the platform
1078 * buffer flush. Note that we've already arranged for pmem
1079 * writes to avoid the cache via arch_memcpy_to_pmem(). The
1080 * final wmb() ensures ordering for the NVDIMM flush write.
1083 writeq(1, nfit_blk->nvdimm_flush);
1089 static u32 read_blk_stat(struct nfit_blk *nfit_blk, unsigned int bw)
1091 struct nfit_blk_mmio *mmio = &nfit_blk->mmio[DCR];
1092 u64 offset = nfit_blk->stat_offset + mmio->size * bw;
1093 const u32 STATUS_MASK = 0x80000037;
1095 if (mmio->num_lines)
1096 offset = to_interleave_offset(offset, mmio);
1098 return readl(mmio->addr.base + offset) & STATUS_MASK;
1101 static void write_blk_ctl(struct nfit_blk *nfit_blk, unsigned int bw,
1102 resource_size_t dpa, unsigned int len, unsigned int write)
1105 struct nfit_blk_mmio *mmio = &nfit_blk->mmio[DCR];
1108 BCW_OFFSET_MASK = (1ULL << 48)-1,
1110 BCW_LEN_MASK = (1ULL << 8) - 1,
1114 cmd = (dpa >> L1_CACHE_SHIFT) & BCW_OFFSET_MASK;
1115 len = len >> L1_CACHE_SHIFT;
1116 cmd |= ((u64) len & BCW_LEN_MASK) << BCW_LEN_SHIFT;
1117 cmd |= ((u64) write) << BCW_CMD_SHIFT;
1119 offset = nfit_blk->cmd_offset + mmio->size * bw;
1120 if (mmio->num_lines)
1121 offset = to_interleave_offset(offset, mmio);
1123 writeq(cmd, mmio->addr.base + offset);
1126 if (nfit_blk->dimm_flags & ND_BLK_DCR_LATCH)
1127 readq(mmio->addr.base + offset);
1130 static int acpi_nfit_blk_single_io(struct nfit_blk *nfit_blk,
1131 resource_size_t dpa, void *iobuf, size_t len, int rw,
1134 struct nfit_blk_mmio *mmio = &nfit_blk->mmio[BDW];
1135 unsigned int copied = 0;
1139 base_offset = nfit_blk->bdw_offset + dpa % L1_CACHE_BYTES
1140 + lane * mmio->size;
1141 write_blk_ctl(nfit_blk, lane, dpa, len, rw);
1146 if (mmio->num_lines) {
1149 offset = to_interleave_offset(base_offset + copied,
1151 div_u64_rem(offset, mmio->line_size, &line_offset);
1152 c = min_t(size_t, len, mmio->line_size - line_offset);
1154 offset = base_offset + nfit_blk->bdw_offset;
1159 memcpy_to_pmem(mmio->addr.aperture + offset,
1162 if (nfit_blk->dimm_flags & ND_BLK_READ_FLUSH)
1163 mmio_flush_range((void __force *)
1164 mmio->addr.aperture + offset, c);
1166 memcpy_from_pmem(iobuf + copied,
1167 mmio->addr.aperture + offset, c);
1177 rc = read_blk_stat(nfit_blk, lane) ? -EIO : 0;
1181 static int acpi_nfit_blk_region_do_io(struct nd_blk_region *ndbr,
1182 resource_size_t dpa, void *iobuf, u64 len, int rw)
1184 struct nfit_blk *nfit_blk = nd_blk_region_provider_data(ndbr);
1185 struct nfit_blk_mmio *mmio = &nfit_blk->mmio[BDW];
1186 struct nd_region *nd_region = nfit_blk->nd_region;
1187 unsigned int lane, copied = 0;
1190 lane = nd_region_acquire_lane(nd_region);
1192 u64 c = min(len, mmio->size);
1194 rc = acpi_nfit_blk_single_io(nfit_blk, dpa + copied,
1195 iobuf + copied, c, rw, lane);
1202 nd_region_release_lane(nd_region, lane);
1207 static void nfit_spa_mapping_release(struct kref *kref)
1209 struct nfit_spa_mapping *spa_map = to_spa_map(kref);
1210 struct acpi_nfit_system_address *spa = spa_map->spa;
1211 struct acpi_nfit_desc *acpi_desc = spa_map->acpi_desc;
1213 WARN_ON(!mutex_is_locked(&acpi_desc->spa_map_mutex));
1214 dev_dbg(acpi_desc->dev, "%s: SPA%d\n", __func__, spa->range_index);
1215 if (spa_map->type == SPA_MAP_APERTURE)
1216 memunmap((void __force *)spa_map->addr.aperture);
1218 iounmap(spa_map->addr.base);
1219 release_mem_region(spa->address, spa->length);
1220 list_del(&spa_map->list);
1224 static struct nfit_spa_mapping *find_spa_mapping(
1225 struct acpi_nfit_desc *acpi_desc,
1226 struct acpi_nfit_system_address *spa)
1228 struct nfit_spa_mapping *spa_map;
1230 WARN_ON(!mutex_is_locked(&acpi_desc->spa_map_mutex));
1231 list_for_each_entry(spa_map, &acpi_desc->spa_maps, list)
1232 if (spa_map->spa == spa)
1238 static void nfit_spa_unmap(struct acpi_nfit_desc *acpi_desc,
1239 struct acpi_nfit_system_address *spa)
1241 struct nfit_spa_mapping *spa_map;
1243 mutex_lock(&acpi_desc->spa_map_mutex);
1244 spa_map = find_spa_mapping(acpi_desc, spa);
1247 kref_put(&spa_map->kref, nfit_spa_mapping_release);
1248 mutex_unlock(&acpi_desc->spa_map_mutex);
1251 static void __iomem *__nfit_spa_map(struct acpi_nfit_desc *acpi_desc,
1252 struct acpi_nfit_system_address *spa, enum spa_map_type type)
1254 resource_size_t start = spa->address;
1255 resource_size_t n = spa->length;
1256 struct nfit_spa_mapping *spa_map;
1257 struct resource *res;
1259 WARN_ON(!mutex_is_locked(&acpi_desc->spa_map_mutex));
1261 spa_map = find_spa_mapping(acpi_desc, spa);
1263 kref_get(&spa_map->kref);
1264 return spa_map->addr.base;
1267 spa_map = kzalloc(sizeof(*spa_map), GFP_KERNEL);
1271 INIT_LIST_HEAD(&spa_map->list);
1273 kref_init(&spa_map->kref);
1274 spa_map->acpi_desc = acpi_desc;
1276 res = request_mem_region(start, n, dev_name(acpi_desc->dev));
1280 spa_map->type = type;
1281 if (type == SPA_MAP_APERTURE)
1282 spa_map->addr.aperture = (void __pmem *)memremap(start, n,
1283 ARCH_MEMREMAP_PMEM);
1285 spa_map->addr.base = ioremap_nocache(start, n);
1288 if (!spa_map->addr.base)
1291 list_add_tail(&spa_map->list, &acpi_desc->spa_maps);
1292 return spa_map->addr.base;
1295 release_mem_region(start, n);
1302 * nfit_spa_map - interleave-aware managed-mappings of acpi_nfit_system_address ranges
1303 * @nvdimm_bus: NFIT-bus that provided the spa table entry
1304 * @nfit_spa: spa table to map
1305 * @type: aperture or control region
1307 * In the case where block-data-window apertures and
1308 * dimm-control-regions are interleaved they will end up sharing a
1309 * single request_mem_region() + ioremap() for the address range. In
1310 * the style of devm nfit_spa_map() mappings are automatically dropped
1311 * when all region devices referencing the same mapping are disabled /
1314 static void __iomem *nfit_spa_map(struct acpi_nfit_desc *acpi_desc,
1315 struct acpi_nfit_system_address *spa, enum spa_map_type type)
1317 void __iomem *iomem;
1319 mutex_lock(&acpi_desc->spa_map_mutex);
1320 iomem = __nfit_spa_map(acpi_desc, spa, type);
1321 mutex_unlock(&acpi_desc->spa_map_mutex);
1326 static int nfit_blk_init_interleave(struct nfit_blk_mmio *mmio,
1327 struct acpi_nfit_interleave *idt, u16 interleave_ways)
1330 mmio->num_lines = idt->line_count;
1331 mmio->line_size = idt->line_size;
1332 if (interleave_ways == 0)
1334 mmio->table_size = mmio->num_lines * interleave_ways
1341 static int acpi_nfit_blk_get_flags(struct nvdimm_bus_descriptor *nd_desc,
1342 struct nvdimm *nvdimm, struct nfit_blk *nfit_blk)
1344 struct nd_cmd_dimm_flags flags;
1347 memset(&flags, 0, sizeof(flags));
1348 rc = nd_desc->ndctl(nd_desc, nvdimm, ND_CMD_DIMM_FLAGS, &flags,
1351 if (rc >= 0 && flags.status == 0)
1352 nfit_blk->dimm_flags = flags.flags;
1353 else if (rc == -ENOTTY) {
1354 /* fall back to a conservative default */
1355 nfit_blk->dimm_flags = ND_BLK_DCR_LATCH | ND_BLK_READ_FLUSH;
1363 static int acpi_nfit_blk_region_enable(struct nvdimm_bus *nvdimm_bus,
1366 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1367 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1368 struct nd_blk_region *ndbr = to_nd_blk_region(dev);
1369 struct nfit_flush *nfit_flush;
1370 struct nfit_blk_mmio *mmio;
1371 struct nfit_blk *nfit_blk;
1372 struct nfit_mem *nfit_mem;
1373 struct nvdimm *nvdimm;
1376 nvdimm = nd_blk_region_to_dimm(ndbr);
1377 nfit_mem = nvdimm_provider_data(nvdimm);
1378 if (!nfit_mem || !nfit_mem->dcr || !nfit_mem->bdw) {
1379 dev_dbg(dev, "%s: missing%s%s%s\n", __func__,
1380 nfit_mem ? "" : " nfit_mem",
1381 (nfit_mem && nfit_mem->dcr) ? "" : " dcr",
1382 (nfit_mem && nfit_mem->bdw) ? "" : " bdw");
1386 nfit_blk = devm_kzalloc(dev, sizeof(*nfit_blk), GFP_KERNEL);
1389 nd_blk_region_set_provider_data(ndbr, nfit_blk);
1390 nfit_blk->nd_region = to_nd_region(dev);
1392 /* map block aperture memory */
1393 nfit_blk->bdw_offset = nfit_mem->bdw->offset;
1394 mmio = &nfit_blk->mmio[BDW];
1395 mmio->addr.base = nfit_spa_map(acpi_desc, nfit_mem->spa_bdw,
1397 if (!mmio->addr.base) {
1398 dev_dbg(dev, "%s: %s failed to map bdw\n", __func__,
1399 nvdimm_name(nvdimm));
1402 mmio->size = nfit_mem->bdw->size;
1403 mmio->base_offset = nfit_mem->memdev_bdw->region_offset;
1404 mmio->idt = nfit_mem->idt_bdw;
1405 mmio->spa = nfit_mem->spa_bdw;
1406 rc = nfit_blk_init_interleave(mmio, nfit_mem->idt_bdw,
1407 nfit_mem->memdev_bdw->interleave_ways);
1409 dev_dbg(dev, "%s: %s failed to init bdw interleave\n",
1410 __func__, nvdimm_name(nvdimm));
1414 /* map block control memory */
1415 nfit_blk->cmd_offset = nfit_mem->dcr->command_offset;
1416 nfit_blk->stat_offset = nfit_mem->dcr->status_offset;
1417 mmio = &nfit_blk->mmio[DCR];
1418 mmio->addr.base = nfit_spa_map(acpi_desc, nfit_mem->spa_dcr,
1420 if (!mmio->addr.base) {
1421 dev_dbg(dev, "%s: %s failed to map dcr\n", __func__,
1422 nvdimm_name(nvdimm));
1425 mmio->size = nfit_mem->dcr->window_size;
1426 mmio->base_offset = nfit_mem->memdev_dcr->region_offset;
1427 mmio->idt = nfit_mem->idt_dcr;
1428 mmio->spa = nfit_mem->spa_dcr;
1429 rc = nfit_blk_init_interleave(mmio, nfit_mem->idt_dcr,
1430 nfit_mem->memdev_dcr->interleave_ways);
1432 dev_dbg(dev, "%s: %s failed to init dcr interleave\n",
1433 __func__, nvdimm_name(nvdimm));
1437 rc = acpi_nfit_blk_get_flags(nd_desc, nvdimm, nfit_blk);
1439 dev_dbg(dev, "%s: %s failed get DIMM flags\n",
1440 __func__, nvdimm_name(nvdimm));
1444 nfit_flush = nfit_mem->nfit_flush;
1445 if (nfit_flush && nfit_flush->flush->hint_count != 0) {
1446 nfit_blk->nvdimm_flush = devm_ioremap_nocache(dev,
1447 nfit_flush->flush->hint_address[0], 8);
1448 if (!nfit_blk->nvdimm_flush)
1452 if (!arch_has_wmb_pmem() && !nfit_blk->nvdimm_flush)
1453 dev_warn(dev, "unable to guarantee persistence of writes\n");
1455 if (mmio->line_size == 0)
1458 if ((u32) nfit_blk->cmd_offset % mmio->line_size
1459 + 8 > mmio->line_size) {
1460 dev_dbg(dev, "cmd_offset crosses interleave boundary\n");
1462 } else if ((u32) nfit_blk->stat_offset % mmio->line_size
1463 + 8 > mmio->line_size) {
1464 dev_dbg(dev, "stat_offset crosses interleave boundary\n");
1471 static void acpi_nfit_blk_region_disable(struct nvdimm_bus *nvdimm_bus,
1474 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1475 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1476 struct nd_blk_region *ndbr = to_nd_blk_region(dev);
1477 struct nfit_blk *nfit_blk = nd_blk_region_provider_data(ndbr);
1481 return; /* never enabled */
1483 /* auto-free BLK spa mappings */
1484 for (i = 0; i < 2; i++) {
1485 struct nfit_blk_mmio *mmio = &nfit_blk->mmio[i];
1487 if (mmio->addr.base)
1488 nfit_spa_unmap(acpi_desc, mmio->spa);
1490 nd_blk_region_set_provider_data(ndbr, NULL);
1491 /* devm will free nfit_blk */
1494 static int acpi_nfit_init_mapping(struct acpi_nfit_desc *acpi_desc,
1495 struct nd_mapping *nd_mapping, struct nd_region_desc *ndr_desc,
1496 struct acpi_nfit_memory_map *memdev,
1497 struct acpi_nfit_system_address *spa)
1499 struct nvdimm *nvdimm = acpi_nfit_dimm_by_handle(acpi_desc,
1500 memdev->device_handle);
1501 struct nd_blk_region_desc *ndbr_desc;
1502 struct nfit_mem *nfit_mem;
1506 dev_err(acpi_desc->dev, "spa%d dimm: %#x not found\n",
1507 spa->range_index, memdev->device_handle);
1511 nd_mapping->nvdimm = nvdimm;
1512 switch (nfit_spa_type(spa)) {
1514 case NFIT_SPA_VOLATILE:
1515 nd_mapping->start = memdev->address;
1516 nd_mapping->size = memdev->region_size;
1519 nfit_mem = nvdimm_provider_data(nvdimm);
1520 if (!nfit_mem || !nfit_mem->bdw) {
1521 dev_dbg(acpi_desc->dev, "spa%d %s missing bdw\n",
1522 spa->range_index, nvdimm_name(nvdimm));
1524 nd_mapping->size = nfit_mem->bdw->capacity;
1525 nd_mapping->start = nfit_mem->bdw->start_address;
1526 ndr_desc->num_lanes = nfit_mem->bdw->windows;
1530 ndr_desc->nd_mapping = nd_mapping;
1531 ndr_desc->num_mappings = blk_valid;
1532 ndbr_desc = to_blk_region_desc(ndr_desc);
1533 ndbr_desc->enable = acpi_nfit_blk_region_enable;
1534 ndbr_desc->disable = acpi_nfit_blk_region_disable;
1535 ndbr_desc->do_io = acpi_desc->blk_do_io;
1536 if (!nvdimm_blk_region_create(acpi_desc->nvdimm_bus, ndr_desc))
1544 static int acpi_nfit_register_region(struct acpi_nfit_desc *acpi_desc,
1545 struct nfit_spa *nfit_spa)
1547 static struct nd_mapping nd_mappings[ND_MAX_MAPPINGS];
1548 struct acpi_nfit_system_address *spa = nfit_spa->spa;
1549 struct nd_blk_region_desc ndbr_desc;
1550 struct nd_region_desc *ndr_desc;
1551 struct nfit_memdev *nfit_memdev;
1552 struct nvdimm_bus *nvdimm_bus;
1553 struct resource res;
1556 if (nfit_spa->is_registered)
1559 if (spa->range_index == 0) {
1560 dev_dbg(acpi_desc->dev, "%s: detected invalid spa index\n",
1565 memset(&res, 0, sizeof(res));
1566 memset(&nd_mappings, 0, sizeof(nd_mappings));
1567 memset(&ndbr_desc, 0, sizeof(ndbr_desc));
1568 res.start = spa->address;
1569 res.end = res.start + spa->length - 1;
1570 ndr_desc = &ndbr_desc.ndr_desc;
1571 ndr_desc->res = &res;
1572 ndr_desc->provider_data = nfit_spa;
1573 ndr_desc->attr_groups = acpi_nfit_region_attribute_groups;
1574 if (spa->flags & ACPI_NFIT_PROXIMITY_VALID)
1575 ndr_desc->numa_node = acpi_map_pxm_to_online_node(
1576 spa->proximity_domain);
1578 ndr_desc->numa_node = NUMA_NO_NODE;
1580 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
1581 struct acpi_nfit_memory_map *memdev = nfit_memdev->memdev;
1582 struct nd_mapping *nd_mapping;
1584 if (memdev->range_index != spa->range_index)
1586 if (count >= ND_MAX_MAPPINGS) {
1587 dev_err(acpi_desc->dev, "spa%d exceeds max mappings %d\n",
1588 spa->range_index, ND_MAX_MAPPINGS);
1591 nd_mapping = &nd_mappings[count++];
1592 rc = acpi_nfit_init_mapping(acpi_desc, nd_mapping, ndr_desc,
1598 ndr_desc->nd_mapping = nd_mappings;
1599 ndr_desc->num_mappings = count;
1600 rc = acpi_nfit_init_interleave_set(acpi_desc, ndr_desc, spa);
1604 nvdimm_bus = acpi_desc->nvdimm_bus;
1605 if (nfit_spa_type(spa) == NFIT_SPA_PM) {
1606 if (!nvdimm_pmem_region_create(nvdimm_bus, ndr_desc))
1608 } else if (nfit_spa_type(spa) == NFIT_SPA_VOLATILE) {
1609 if (!nvdimm_volatile_region_create(nvdimm_bus, ndr_desc))
1613 nfit_spa->is_registered = 1;
1617 static int acpi_nfit_register_regions(struct acpi_nfit_desc *acpi_desc)
1619 struct nfit_spa *nfit_spa;
1621 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
1622 int rc = acpi_nfit_register_region(acpi_desc, nfit_spa);
1630 static int acpi_nfit_check_deletions(struct acpi_nfit_desc *acpi_desc,
1631 struct nfit_table_prev *prev)
1633 struct device *dev = acpi_desc->dev;
1635 if (!list_empty(&prev->spas) ||
1636 !list_empty(&prev->memdevs) ||
1637 !list_empty(&prev->dcrs) ||
1638 !list_empty(&prev->bdws) ||
1639 !list_empty(&prev->idts) ||
1640 !list_empty(&prev->flushes)) {
1641 dev_err(dev, "new nfit deletes entries (unsupported)\n");
1647 int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, acpi_size sz)
1649 struct device *dev = acpi_desc->dev;
1650 struct nfit_table_prev prev;
1655 mutex_lock(&acpi_desc->init_mutex);
1657 INIT_LIST_HEAD(&prev.spas);
1658 INIT_LIST_HEAD(&prev.memdevs);
1659 INIT_LIST_HEAD(&prev.dcrs);
1660 INIT_LIST_HEAD(&prev.bdws);
1661 INIT_LIST_HEAD(&prev.idts);
1662 INIT_LIST_HEAD(&prev.flushes);
1664 list_cut_position(&prev.spas, &acpi_desc->spas,
1665 acpi_desc->spas.prev);
1666 list_cut_position(&prev.memdevs, &acpi_desc->memdevs,
1667 acpi_desc->memdevs.prev);
1668 list_cut_position(&prev.dcrs, &acpi_desc->dcrs,
1669 acpi_desc->dcrs.prev);
1670 list_cut_position(&prev.bdws, &acpi_desc->bdws,
1671 acpi_desc->bdws.prev);
1672 list_cut_position(&prev.idts, &acpi_desc->idts,
1673 acpi_desc->idts.prev);
1674 list_cut_position(&prev.flushes, &acpi_desc->flushes,
1675 acpi_desc->flushes.prev);
1677 data = (u8 *) acpi_desc->nfit;
1679 while (!IS_ERR_OR_NULL(data))
1680 data = add_table(acpi_desc, &prev, data, end);
1683 dev_dbg(dev, "%s: nfit table parsing error: %ld\n", __func__,
1689 rc = acpi_nfit_check_deletions(acpi_desc, &prev);
1693 if (nfit_mem_init(acpi_desc) != 0) {
1698 acpi_nfit_init_dsms(acpi_desc);
1700 rc = acpi_nfit_register_dimms(acpi_desc);
1704 rc = acpi_nfit_register_regions(acpi_desc);
1707 mutex_unlock(&acpi_desc->init_mutex);
1710 EXPORT_SYMBOL_GPL(acpi_nfit_init);
1712 static struct acpi_nfit_desc *acpi_nfit_desc_init(struct acpi_device *adev)
1714 struct nvdimm_bus_descriptor *nd_desc;
1715 struct acpi_nfit_desc *acpi_desc;
1716 struct device *dev = &adev->dev;
1718 acpi_desc = devm_kzalloc(dev, sizeof(*acpi_desc), GFP_KERNEL);
1720 return ERR_PTR(-ENOMEM);
1722 dev_set_drvdata(dev, acpi_desc);
1723 acpi_desc->dev = dev;
1724 acpi_desc->blk_do_io = acpi_nfit_blk_region_do_io;
1725 nd_desc = &acpi_desc->nd_desc;
1726 nd_desc->provider_name = "ACPI.NFIT";
1727 nd_desc->ndctl = acpi_nfit_ctl;
1728 nd_desc->attr_groups = acpi_nfit_attribute_groups;
1730 acpi_desc->nvdimm_bus = nvdimm_bus_register(dev, nd_desc);
1731 if (!acpi_desc->nvdimm_bus) {
1732 devm_kfree(dev, acpi_desc);
1733 return ERR_PTR(-ENXIO);
1736 INIT_LIST_HEAD(&acpi_desc->spa_maps);
1737 INIT_LIST_HEAD(&acpi_desc->spas);
1738 INIT_LIST_HEAD(&acpi_desc->dcrs);
1739 INIT_LIST_HEAD(&acpi_desc->bdws);
1740 INIT_LIST_HEAD(&acpi_desc->idts);
1741 INIT_LIST_HEAD(&acpi_desc->flushes);
1742 INIT_LIST_HEAD(&acpi_desc->memdevs);
1743 INIT_LIST_HEAD(&acpi_desc->dimms);
1744 mutex_init(&acpi_desc->spa_map_mutex);
1745 mutex_init(&acpi_desc->init_mutex);
1750 static int acpi_nfit_add(struct acpi_device *adev)
1752 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
1753 struct acpi_nfit_desc *acpi_desc;
1754 struct device *dev = &adev->dev;
1755 struct acpi_table_header *tbl;
1756 acpi_status status = AE_OK;
1760 status = acpi_get_table_with_size("NFIT", 0, &tbl, &sz);
1761 if (ACPI_FAILURE(status)) {
1762 /* This is ok, we could have an nvdimm hotplugged later */
1763 dev_dbg(dev, "failed to find NFIT at startup\n");
1767 acpi_desc = acpi_nfit_desc_init(adev);
1768 if (IS_ERR(acpi_desc)) {
1769 dev_err(dev, "%s: error initializing acpi_desc: %ld\n",
1770 __func__, PTR_ERR(acpi_desc));
1771 return PTR_ERR(acpi_desc);
1775 * Save the acpi header for later and then skip it,
1776 * making nfit point to the first nfit table header.
1778 acpi_desc->acpi_header = *tbl;
1779 acpi_desc->nfit = (void *) tbl + sizeof(struct acpi_table_nfit);
1780 sz -= sizeof(struct acpi_table_nfit);
1782 /* Evaluate _FIT and override with that if present */
1783 status = acpi_evaluate_object(adev->handle, "_FIT", NULL, &buf);
1784 if (ACPI_SUCCESS(status) && buf.length > 0) {
1785 union acpi_object *obj;
1787 * Adjust for the acpi_object header of the _FIT
1790 if (obj->type == ACPI_TYPE_BUFFER) {
1792 (struct acpi_nfit_header *)obj->buffer.pointer;
1793 sz = obj->buffer.length;
1795 dev_dbg(dev, "%s invalid type %d, ignoring _FIT\n",
1796 __func__, (int) obj->type);
1799 rc = acpi_nfit_init(acpi_desc, sz);
1801 nvdimm_bus_unregister(acpi_desc->nvdimm_bus);
1807 static int acpi_nfit_remove(struct acpi_device *adev)
1809 struct acpi_nfit_desc *acpi_desc = dev_get_drvdata(&adev->dev);
1811 nvdimm_bus_unregister(acpi_desc->nvdimm_bus);
1815 static void acpi_nfit_notify(struct acpi_device *adev, u32 event)
1817 struct acpi_nfit_desc *acpi_desc = dev_get_drvdata(&adev->dev);
1818 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
1819 struct acpi_nfit_header *nfit_saved;
1820 union acpi_object *obj;
1821 struct device *dev = &adev->dev;
1825 dev_dbg(dev, "%s: event: %d\n", __func__, event);
1827 if (event != NFIT_NOTIFY_UPDATE)
1832 /* dev->driver may be null if we're being removed */
1833 dev_dbg(dev, "%s: no driver found for dev\n", __func__);
1838 acpi_desc = acpi_nfit_desc_init(adev);
1839 if (IS_ERR(acpi_desc)) {
1840 dev_err(dev, "%s: error initializing acpi_desc: %ld\n",
1841 __func__, PTR_ERR(acpi_desc));
1847 status = acpi_evaluate_object(adev->handle, "_FIT", NULL, &buf);
1848 if (ACPI_FAILURE(status)) {
1849 dev_err(dev, "failed to evaluate _FIT\n");
1853 nfit_saved = acpi_desc->nfit;
1855 if (obj->type == ACPI_TYPE_BUFFER) {
1857 (struct acpi_nfit_header *)obj->buffer.pointer;
1858 ret = acpi_nfit_init(acpi_desc, obj->buffer.length);
1860 /* Merge failed, restore old nfit, and exit */
1861 acpi_desc->nfit = nfit_saved;
1862 dev_err(dev, "failed to merge updated NFIT\n");
1865 /* Bad _FIT, restore old nfit */
1866 dev_err(dev, "Invalid _FIT\n");
1874 static const struct acpi_device_id acpi_nfit_ids[] = {
1878 MODULE_DEVICE_TABLE(acpi, acpi_nfit_ids);
1880 static struct acpi_driver acpi_nfit_driver = {
1881 .name = KBUILD_MODNAME,
1882 .ids = acpi_nfit_ids,
1884 .add = acpi_nfit_add,
1885 .remove = acpi_nfit_remove,
1886 .notify = acpi_nfit_notify,
1890 static __init int nfit_init(void)
1892 BUILD_BUG_ON(sizeof(struct acpi_table_nfit) != 40);
1893 BUILD_BUG_ON(sizeof(struct acpi_nfit_system_address) != 56);
1894 BUILD_BUG_ON(sizeof(struct acpi_nfit_memory_map) != 48);
1895 BUILD_BUG_ON(sizeof(struct acpi_nfit_interleave) != 20);
1896 BUILD_BUG_ON(sizeof(struct acpi_nfit_smbios) != 9);
1897 BUILD_BUG_ON(sizeof(struct acpi_nfit_control_region) != 80);
1898 BUILD_BUG_ON(sizeof(struct acpi_nfit_data_region) != 40);
1900 acpi_str_to_uuid(UUID_VOLATILE_MEMORY, nfit_uuid[NFIT_SPA_VOLATILE]);
1901 acpi_str_to_uuid(UUID_PERSISTENT_MEMORY, nfit_uuid[NFIT_SPA_PM]);
1902 acpi_str_to_uuid(UUID_CONTROL_REGION, nfit_uuid[NFIT_SPA_DCR]);
1903 acpi_str_to_uuid(UUID_DATA_REGION, nfit_uuid[NFIT_SPA_BDW]);
1904 acpi_str_to_uuid(UUID_VOLATILE_VIRTUAL_DISK, nfit_uuid[NFIT_SPA_VDISK]);
1905 acpi_str_to_uuid(UUID_VOLATILE_VIRTUAL_CD, nfit_uuid[NFIT_SPA_VCD]);
1906 acpi_str_to_uuid(UUID_PERSISTENT_VIRTUAL_DISK, nfit_uuid[NFIT_SPA_PDISK]);
1907 acpi_str_to_uuid(UUID_PERSISTENT_VIRTUAL_CD, nfit_uuid[NFIT_SPA_PCD]);
1908 acpi_str_to_uuid(UUID_NFIT_BUS, nfit_uuid[NFIT_DEV_BUS]);
1909 acpi_str_to_uuid(UUID_NFIT_DIMM, nfit_uuid[NFIT_DEV_DIMM]);
1911 return acpi_bus_register_driver(&acpi_nfit_driver);
1914 static __exit void nfit_exit(void)
1916 acpi_bus_unregister_driver(&acpi_nfit_driver);
1919 module_init(nfit_init);
1920 module_exit(nfit_exit);
1921 MODULE_LICENSE("GPL v2");
1922 MODULE_AUTHOR("Intel Corporation");