Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
4 */
5#include <linux/list_sort.h>
6#include <linux/libnvdimm.h>
7#include <linux/module.h>
8#include <linux/mutex.h>
9#include <linux/ndctl.h>
10#include <linux/sysfs.h>
11#include <linux/delay.h>
12#include <linux/list.h>
13#include <linux/acpi.h>
14#include <linux/sort.h>
15#include <linux/io.h>
16#include <linux/nd.h>
17#include <asm/cacheflush.h>
18#include <acpi/nfit.h>
19#include "intel.h"
20#include "nfit.h"
21
22/*
23 * For readq() and writeq() on 32-bit builds, the hi-lo, lo-hi order is
24 * irrelevant.
25 */
26#include <linux/io-64-nonatomic-hi-lo.h>
27
28static bool force_enable_dimms;
29module_param(force_enable_dimms, bool, S_IRUGO|S_IWUSR);
30MODULE_PARM_DESC(force_enable_dimms, "Ignore _STA (ACPI DIMM device) status");
31
32static bool disable_vendor_specific;
33module_param(disable_vendor_specific, bool, S_IRUGO);
34MODULE_PARM_DESC(disable_vendor_specific,
35 "Limit commands to the publicly specified set");
36
37static unsigned long override_dsm_mask;
38module_param(override_dsm_mask, ulong, S_IRUGO);
39MODULE_PARM_DESC(override_dsm_mask, "Bitmask of allowed NVDIMM DSM functions");
40
41static int default_dsm_family = -1;
42module_param(default_dsm_family, int, S_IRUGO);
43MODULE_PARM_DESC(default_dsm_family,
44 "Try this DSM type first when identifying NVDIMM family");
45
46static bool no_init_ars;
47module_param(no_init_ars, bool, 0644);
48MODULE_PARM_DESC(no_init_ars, "Skip ARS run at nfit init time");
49
50static bool force_labels;
51module_param(force_labels, bool, 0444);
52MODULE_PARM_DESC(force_labels, "Opt-in to labels despite missing methods");
53
54LIST_HEAD(acpi_descs);
55DEFINE_MUTEX(acpi_desc_lock);
56
57static struct workqueue_struct *nfit_wq;
58
59struct nfit_table_prev {
60 struct list_head spas;
61 struct list_head memdevs;
62 struct list_head dcrs;
63 struct list_head bdws;
64 struct list_head idts;
65 struct list_head flushes;
66};
67
68static guid_t nfit_uuid[NFIT_UUID_MAX];
69
70const guid_t *to_nfit_uuid(enum nfit_uuids id)
71{
72 return &nfit_uuid[id];
73}
74EXPORT_SYMBOL(to_nfit_uuid);
75
76static const guid_t *to_nfit_bus_uuid(int family)
77{
78 if (WARN_ONCE(family == NVDIMM_BUS_FAMILY_NFIT,
79 "only secondary bus families can be translated\n"))
80 return NULL;
81 /*
82 * The index of bus UUIDs starts immediately following the last
83 * NVDIMM/leaf family.
84 */
85 return to_nfit_uuid(family + NVDIMM_FAMILY_MAX);
86}
87
88static struct acpi_device *to_acpi_dev(struct acpi_nfit_desc *acpi_desc)
89{
90 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
91
92 /*
93 * If provider == 'ACPI.NFIT' we can assume 'dev' is a struct
94 * acpi_device.
95 */
96 if (!nd_desc->provider_name
97 || strcmp(nd_desc->provider_name, "ACPI.NFIT") != 0)
98 return NULL;
99
100 return to_acpi_device(acpi_desc->dev);
101}
102
103static int xlat_bus_status(void *buf, unsigned int cmd, u32 status)
104{
105 struct nd_cmd_clear_error *clear_err;
106 struct nd_cmd_ars_status *ars_status;
107 u16 flags;
108
109 switch (cmd) {
110 case ND_CMD_ARS_CAP:
111 if ((status & 0xffff) == NFIT_ARS_CAP_NONE)
112 return -ENOTTY;
113
114 /* Command failed */
115 if (status & 0xffff)
116 return -EIO;
117
118 /* No supported scan types for this range */
119 flags = ND_ARS_PERSISTENT | ND_ARS_VOLATILE;
120 if ((status >> 16 & flags) == 0)
121 return -ENOTTY;
122 return 0;
123 case ND_CMD_ARS_START:
124 /* ARS is in progress */
125 if ((status & 0xffff) == NFIT_ARS_START_BUSY)
126 return -EBUSY;
127
128 /* Command failed */
129 if (status & 0xffff)
130 return -EIO;
131 return 0;
132 case ND_CMD_ARS_STATUS:
133 ars_status = buf;
134 /* Command failed */
135 if (status & 0xffff)
136 return -EIO;
137 /* Check extended status (Upper two bytes) */
138 if (status == NFIT_ARS_STATUS_DONE)
139 return 0;
140
141 /* ARS is in progress */
142 if (status == NFIT_ARS_STATUS_BUSY)
143 return -EBUSY;
144
145 /* No ARS performed for the current boot */
146 if (status == NFIT_ARS_STATUS_NONE)
147 return -EAGAIN;
148
149 /*
150 * ARS interrupted, either we overflowed or some other
151 * agent wants the scan to stop. If we didn't overflow
152 * then just continue with the returned results.
153 */
154 if (status == NFIT_ARS_STATUS_INTR) {
155 if (ars_status->out_length >= 40 && (ars_status->flags
156 & NFIT_ARS_F_OVERFLOW))
157 return -ENOSPC;
158 return 0;
159 }
160
161 /* Unknown status */
162 if (status >> 16)
163 return -EIO;
164 return 0;
165 case ND_CMD_CLEAR_ERROR:
166 clear_err = buf;
167 if (status & 0xffff)
168 return -EIO;
169 if (!clear_err->cleared)
170 return -EIO;
171 if (clear_err->length > clear_err->cleared)
172 return clear_err->cleared;
173 return 0;
174 default:
175 break;
176 }
177
178 /* all other non-zero status results in an error */
179 if (status)
180 return -EIO;
181 return 0;
182}
183
184#define ACPI_LABELS_LOCKED 3
185
186static int xlat_nvdimm_status(struct nvdimm *nvdimm, void *buf, unsigned int cmd,
187 u32 status)
188{
189 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
190
191 switch (cmd) {
192 case ND_CMD_GET_CONFIG_SIZE:
193 /*
194 * In the _LSI, _LSR, _LSW case the locked status is
195 * communicated via the read/write commands
196 */
197 if (test_bit(NFIT_MEM_LSR, &nfit_mem->flags))
198 break;
199
200 if (status >> 16 & ND_CONFIG_LOCKED)
201 return -EACCES;
202 break;
203 case ND_CMD_GET_CONFIG_DATA:
204 if (test_bit(NFIT_MEM_LSR, &nfit_mem->flags)
205 && status == ACPI_LABELS_LOCKED)
206 return -EACCES;
207 break;
208 case ND_CMD_SET_CONFIG_DATA:
209 if (test_bit(NFIT_MEM_LSW, &nfit_mem->flags)
210 && status == ACPI_LABELS_LOCKED)
211 return -EACCES;
212 break;
213 default:
214 break;
215 }
216
217 /* all other non-zero status results in an error */
218 if (status)
219 return -EIO;
220 return 0;
221}
222
223static int xlat_status(struct nvdimm *nvdimm, void *buf, unsigned int cmd,
224 u32 status)
225{
226 if (!nvdimm)
227 return xlat_bus_status(buf, cmd, status);
228 return xlat_nvdimm_status(nvdimm, buf, cmd, status);
229}
230
231/* convert _LS{I,R} packages to the buffer object acpi_nfit_ctl expects */
232static union acpi_object *pkg_to_buf(union acpi_object *pkg)
233{
234 int i;
235 void *dst;
236 size_t size = 0;
237 union acpi_object *buf = NULL;
238
239 if (pkg->type != ACPI_TYPE_PACKAGE) {
240 WARN_ONCE(1, "BIOS bug, unexpected element type: %d\n",
241 pkg->type);
242 goto err;
243 }
244
245 for (i = 0; i < pkg->package.count; i++) {
246 union acpi_object *obj = &pkg->package.elements[i];
247
248 if (obj->type == ACPI_TYPE_INTEGER)
249 size += 4;
250 else if (obj->type == ACPI_TYPE_BUFFER)
251 size += obj->buffer.length;
252 else {
253 WARN_ONCE(1, "BIOS bug, unexpected element type: %d\n",
254 obj->type);
255 goto err;
256 }
257 }
258
259 buf = ACPI_ALLOCATE(sizeof(*buf) + size);
260 if (!buf)
261 goto err;
262
263 dst = buf + 1;
264 buf->type = ACPI_TYPE_BUFFER;
265 buf->buffer.length = size;
266 buf->buffer.pointer = dst;
267 for (i = 0; i < pkg->package.count; i++) {
268 union acpi_object *obj = &pkg->package.elements[i];
269
270 if (obj->type == ACPI_TYPE_INTEGER) {
271 memcpy(dst, &obj->integer.value, 4);
272 dst += 4;
273 } else if (obj->type == ACPI_TYPE_BUFFER) {
274 memcpy(dst, obj->buffer.pointer, obj->buffer.length);
275 dst += obj->buffer.length;
276 }
277 }
278err:
279 ACPI_FREE(pkg);
280 return buf;
281}
282
283static union acpi_object *int_to_buf(union acpi_object *integer)
284{
285 union acpi_object *buf = ACPI_ALLOCATE(sizeof(*buf) + 4);
286 void *dst = NULL;
287
288 if (!buf)
289 goto err;
290
291 if (integer->type != ACPI_TYPE_INTEGER) {
292 WARN_ONCE(1, "BIOS bug, unexpected element type: %d\n",
293 integer->type);
294 goto err;
295 }
296
297 dst = buf + 1;
298 buf->type = ACPI_TYPE_BUFFER;
299 buf->buffer.length = 4;
300 buf->buffer.pointer = dst;
301 memcpy(dst, &integer->integer.value, 4);
302err:
303 ACPI_FREE(integer);
304 return buf;
305}
306
307static union acpi_object *acpi_label_write(acpi_handle handle, u32 offset,
308 u32 len, void *data)
309{
310 acpi_status rc;
311 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
312 struct acpi_object_list input = {
313 .count = 3,
314 .pointer = (union acpi_object []) {
315 [0] = {
316 .integer.type = ACPI_TYPE_INTEGER,
317 .integer.value = offset,
318 },
319 [1] = {
320 .integer.type = ACPI_TYPE_INTEGER,
321 .integer.value = len,
322 },
323 [2] = {
324 .buffer.type = ACPI_TYPE_BUFFER,
325 .buffer.pointer = data,
326 .buffer.length = len,
327 },
328 },
329 };
330
331 rc = acpi_evaluate_object(handle, "_LSW", &input, &buf);
332 if (ACPI_FAILURE(rc))
333 return NULL;
334 return int_to_buf(buf.pointer);
335}
336
337static union acpi_object *acpi_label_read(acpi_handle handle, u32 offset,
338 u32 len)
339{
340 acpi_status rc;
341 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
342 struct acpi_object_list input = {
343 .count = 2,
344 .pointer = (union acpi_object []) {
345 [0] = {
346 .integer.type = ACPI_TYPE_INTEGER,
347 .integer.value = offset,
348 },
349 [1] = {
350 .integer.type = ACPI_TYPE_INTEGER,
351 .integer.value = len,
352 },
353 },
354 };
355
356 rc = acpi_evaluate_object(handle, "_LSR", &input, &buf);
357 if (ACPI_FAILURE(rc))
358 return NULL;
359 return pkg_to_buf(buf.pointer);
360}
361
362static union acpi_object *acpi_label_info(acpi_handle handle)
363{
364 acpi_status rc;
365 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
366
367 rc = acpi_evaluate_object(handle, "_LSI", NULL, &buf);
368 if (ACPI_FAILURE(rc))
369 return NULL;
370 return pkg_to_buf(buf.pointer);
371}
372
373static u8 nfit_dsm_revid(unsigned family, unsigned func)
374{
375 static const u8 revid_table[NVDIMM_FAMILY_MAX+1][NVDIMM_CMD_MAX+1] = {
376 [NVDIMM_FAMILY_INTEL] = {
377 [NVDIMM_INTEL_GET_MODES ...
378 NVDIMM_INTEL_FW_ACTIVATE_ARM] = 2,
379 },
380 };
381 u8 id;
382
383 if (family > NVDIMM_FAMILY_MAX)
384 return 0;
385 if (func > NVDIMM_CMD_MAX)
386 return 0;
387 id = revid_table[family][func];
388 if (id == 0)
389 return 1; /* default */
390 return id;
391}
392
393static bool payload_dumpable(struct nvdimm *nvdimm, unsigned int func)
394{
395 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
396
397 if (nfit_mem && nfit_mem->family == NVDIMM_FAMILY_INTEL
398 && func >= NVDIMM_INTEL_GET_SECURITY_STATE
399 && func <= NVDIMM_INTEL_MASTER_SECURE_ERASE)
400 return IS_ENABLED(CONFIG_NFIT_SECURITY_DEBUG);
401 return true;
402}
403
404static int cmd_to_func(struct nfit_mem *nfit_mem, unsigned int cmd,
405 struct nd_cmd_pkg *call_pkg, int *family)
406{
407 if (call_pkg) {
408 int i;
409
410 if (nfit_mem && nfit_mem->family != call_pkg->nd_family)
411 return -ENOTTY;
412
413 for (i = 0; i < ARRAY_SIZE(call_pkg->nd_reserved2); i++)
414 if (call_pkg->nd_reserved2[i])
415 return -EINVAL;
416 *family = call_pkg->nd_family;
417 return call_pkg->nd_command;
418 }
419
420 /* In the !call_pkg case, bus commands == bus functions */
421 if (!nfit_mem)
422 return cmd;
423
424 /* Linux ND commands == NVDIMM_FAMILY_INTEL function numbers */
425 if (nfit_mem->family == NVDIMM_FAMILY_INTEL)
426 return cmd;
427
428 /*
429 * Force function number validation to fail since 0 is never
430 * published as a valid function in dsm_mask.
431 */
432 return 0;
433}
434
435int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc, struct nvdimm *nvdimm,
436 unsigned int cmd, void *buf, unsigned int buf_len, int *cmd_rc)
437{
438 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
439 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
440 union acpi_object in_obj, in_buf, *out_obj;
441 const struct nd_cmd_desc *desc = NULL;
442 struct device *dev = acpi_desc->dev;
443 struct nd_cmd_pkg *call_pkg = NULL;
444 const char *cmd_name, *dimm_name;
445 unsigned long cmd_mask, dsm_mask;
446 u32 offset, fw_status = 0;
447 acpi_handle handle;
448 const guid_t *guid;
449 int func, rc, i;
450 int family = 0;
451
452 if (cmd_rc)
453 *cmd_rc = -EINVAL;
454
455 if (cmd == ND_CMD_CALL)
456 call_pkg = buf;
457 func = cmd_to_func(nfit_mem, cmd, call_pkg, &family);
458 if (func < 0)
459 return func;
460
461 if (nvdimm) {
462 struct acpi_device *adev = nfit_mem->adev;
463
464 if (!adev)
465 return -ENOTTY;
466
467 dimm_name = nvdimm_name(nvdimm);
468 cmd_name = nvdimm_cmd_name(cmd);
469 cmd_mask = nvdimm_cmd_mask(nvdimm);
470 dsm_mask = nfit_mem->dsm_mask;
471 desc = nd_cmd_dimm_desc(cmd);
472 guid = to_nfit_uuid(nfit_mem->family);
473 handle = adev->handle;
474 } else {
475 struct acpi_device *adev = to_acpi_dev(acpi_desc);
476
477 cmd_name = nvdimm_bus_cmd_name(cmd);
478 cmd_mask = nd_desc->cmd_mask;
479 if (cmd == ND_CMD_CALL && call_pkg->nd_family) {
480 family = call_pkg->nd_family;
481 if (!test_bit(family, &nd_desc->bus_family_mask))
482 return -EINVAL;
483 dsm_mask = acpi_desc->family_dsm_mask[family];
484 guid = to_nfit_bus_uuid(family);
485 } else {
486 dsm_mask = acpi_desc->bus_dsm_mask;
487 guid = to_nfit_uuid(NFIT_DEV_BUS);
488 }
489 desc = nd_cmd_bus_desc(cmd);
490 handle = adev->handle;
491 dimm_name = "bus";
492 }
493
494 if (!desc || (cmd && (desc->out_num + desc->in_num == 0)))
495 return -ENOTTY;
496
497 /*
498 * Check for a valid command. For ND_CMD_CALL, we also have to
499 * make sure that the DSM function is supported.
500 */
501 if (cmd == ND_CMD_CALL &&
502 (func > NVDIMM_CMD_MAX || !test_bit(func, &dsm_mask)))
503 return -ENOTTY;
504 else if (!test_bit(cmd, &cmd_mask))
505 return -ENOTTY;
506
507 in_obj.type = ACPI_TYPE_PACKAGE;
508 in_obj.package.count = 1;
509 in_obj.package.elements = &in_buf;
510 in_buf.type = ACPI_TYPE_BUFFER;
511 in_buf.buffer.pointer = buf;
512 in_buf.buffer.length = 0;
513
514 /* libnvdimm has already validated the input envelope */
515 for (i = 0; i < desc->in_num; i++)
516 in_buf.buffer.length += nd_cmd_in_size(nvdimm, cmd, desc,
517 i, buf);
518
519 if (call_pkg) {
520 /* skip over package wrapper */
521 in_buf.buffer.pointer = (void *) &call_pkg->nd_payload;
522 in_buf.buffer.length = call_pkg->nd_size_in;
523 }
524
525 dev_dbg(dev, "%s cmd: %d: family: %d func: %d input length: %d\n",
526 dimm_name, cmd, family, func, in_buf.buffer.length);
527 if (payload_dumpable(nvdimm, func))
528 print_hex_dump_debug("nvdimm in ", DUMP_PREFIX_OFFSET, 4, 4,
529 in_buf.buffer.pointer,
530 min_t(u32, 256, in_buf.buffer.length), true);
531
532 /* call the BIOS, prefer the named methods over _DSM if available */
533 if (nvdimm && cmd == ND_CMD_GET_CONFIG_SIZE
534 && test_bit(NFIT_MEM_LSR, &nfit_mem->flags))
535 out_obj = acpi_label_info(handle);
536 else if (nvdimm && cmd == ND_CMD_GET_CONFIG_DATA
537 && test_bit(NFIT_MEM_LSR, &nfit_mem->flags)) {
538 struct nd_cmd_get_config_data_hdr *p = buf;
539
540 out_obj = acpi_label_read(handle, p->in_offset, p->in_length);
541 } else if (nvdimm && cmd == ND_CMD_SET_CONFIG_DATA
542 && test_bit(NFIT_MEM_LSW, &nfit_mem->flags)) {
543 struct nd_cmd_set_config_hdr *p = buf;
544
545 out_obj = acpi_label_write(handle, p->in_offset, p->in_length,
546 p->in_buf);
547 } else {
548 u8 revid;
549
550 if (nvdimm)
551 revid = nfit_dsm_revid(nfit_mem->family, func);
552 else
553 revid = 1;
554 out_obj = acpi_evaluate_dsm(handle, guid, revid, func, &in_obj);
555 }
556
557 if (!out_obj) {
558 dev_dbg(dev, "%s _DSM failed cmd: %s\n", dimm_name, cmd_name);
559 return -EINVAL;
560 }
561
562 if (out_obj->type != ACPI_TYPE_BUFFER) {
563 dev_dbg(dev, "%s unexpected output object type cmd: %s type: %d\n",
564 dimm_name, cmd_name, out_obj->type);
565 rc = -EINVAL;
566 goto out;
567 }
568
569 dev_dbg(dev, "%s cmd: %s output length: %d\n", dimm_name,
570 cmd_name, out_obj->buffer.length);
571 print_hex_dump_debug(cmd_name, DUMP_PREFIX_OFFSET, 4, 4,
572 out_obj->buffer.pointer,
573 min_t(u32, 128, out_obj->buffer.length), true);
574
575 if (call_pkg) {
576 call_pkg->nd_fw_size = out_obj->buffer.length;
577 memcpy(call_pkg->nd_payload + call_pkg->nd_size_in,
578 out_obj->buffer.pointer,
579 min(call_pkg->nd_fw_size, call_pkg->nd_size_out));
580
581 ACPI_FREE(out_obj);
582 /*
583 * Need to support FW function w/o known size in advance.
584 * Caller can determine required size based upon nd_fw_size.
585 * If we return an error (like elsewhere) then caller wouldn't
586 * be able to rely upon data returned to make calculation.
587 */
588 if (cmd_rc)
589 *cmd_rc = 0;
590 return 0;
591 }
592
593 for (i = 0, offset = 0; i < desc->out_num; i++) {
594 u32 out_size = nd_cmd_out_size(nvdimm, cmd, desc, i, buf,
595 (u32 *) out_obj->buffer.pointer,
596 out_obj->buffer.length - offset);
597
598 if (offset + out_size > out_obj->buffer.length) {
599 dev_dbg(dev, "%s output object underflow cmd: %s field: %d\n",
600 dimm_name, cmd_name, i);
601 break;
602 }
603
604 if (in_buf.buffer.length + offset + out_size > buf_len) {
605 dev_dbg(dev, "%s output overrun cmd: %s field: %d\n",
606 dimm_name, cmd_name, i);
607 rc = -ENXIO;
608 goto out;
609 }
610 memcpy(buf + in_buf.buffer.length + offset,
611 out_obj->buffer.pointer + offset, out_size);
612 offset += out_size;
613 }
614
615 /*
616 * Set fw_status for all the commands with a known format to be
617 * later interpreted by xlat_status().
618 */
619 if (i >= 1 && ((!nvdimm && cmd >= ND_CMD_ARS_CAP
620 && cmd <= ND_CMD_CLEAR_ERROR)
621 || (nvdimm && cmd >= ND_CMD_SMART
622 && cmd <= ND_CMD_VENDOR)))
623 fw_status = *(u32 *) out_obj->buffer.pointer;
624
625 if (offset + in_buf.buffer.length < buf_len) {
626 if (i >= 1) {
627 /*
628 * status valid, return the number of bytes left
629 * unfilled in the output buffer
630 */
631 rc = buf_len - offset - in_buf.buffer.length;
632 if (cmd_rc)
633 *cmd_rc = xlat_status(nvdimm, buf, cmd,
634 fw_status);
635 } else {
636 dev_err(dev, "%s:%s underrun cmd: %s buf_len: %d out_len: %d\n",
637 __func__, dimm_name, cmd_name, buf_len,
638 offset);
639 rc = -ENXIO;
640 }
641 } else {
642 rc = 0;
643 if (cmd_rc)
644 *cmd_rc = xlat_status(nvdimm, buf, cmd, fw_status);
645 }
646
647 out:
648 ACPI_FREE(out_obj);
649
650 return rc;
651}
652EXPORT_SYMBOL_GPL(acpi_nfit_ctl);
653
654static const char *spa_type_name(u16 type)
655{
656 static const char *to_name[] = {
657 [NFIT_SPA_VOLATILE] = "volatile",
658 [NFIT_SPA_PM] = "pmem",
659 [NFIT_SPA_DCR] = "dimm-control-region",
660 [NFIT_SPA_BDW] = "block-data-window",
661 [NFIT_SPA_VDISK] = "volatile-disk",
662 [NFIT_SPA_VCD] = "volatile-cd",
663 [NFIT_SPA_PDISK] = "persistent-disk",
664 [NFIT_SPA_PCD] = "persistent-cd",
665
666 };
667
668 if (type > NFIT_SPA_PCD)
669 return "unknown";
670
671 return to_name[type];
672}
673
674int nfit_spa_type(struct acpi_nfit_system_address *spa)
675{
676 int i;
677
678 for (i = 0; i < NFIT_UUID_MAX; i++)
679 if (guid_equal(to_nfit_uuid(i), (guid_t *)&spa->range_guid))
680 return i;
681 return -1;
682}
683
684static bool add_spa(struct acpi_nfit_desc *acpi_desc,
685 struct nfit_table_prev *prev,
686 struct acpi_nfit_system_address *spa)
687{
688 struct device *dev = acpi_desc->dev;
689 struct nfit_spa *nfit_spa;
690
691 if (spa->header.length != sizeof(*spa))
692 return false;
693
694 list_for_each_entry(nfit_spa, &prev->spas, list) {
695 if (memcmp(nfit_spa->spa, spa, sizeof(*spa)) == 0) {
696 list_move_tail(&nfit_spa->list, &acpi_desc->spas);
697 return true;
698 }
699 }
700
701 nfit_spa = devm_kzalloc(dev, sizeof(*nfit_spa) + sizeof(*spa),
702 GFP_KERNEL);
703 if (!nfit_spa)
704 return false;
705 INIT_LIST_HEAD(&nfit_spa->list);
706 memcpy(nfit_spa->spa, spa, sizeof(*spa));
707 list_add_tail(&nfit_spa->list, &acpi_desc->spas);
708 dev_dbg(dev, "spa index: %d type: %s\n",
709 spa->range_index,
710 spa_type_name(nfit_spa_type(spa)));
711 return true;
712}
713
714static bool add_memdev(struct acpi_nfit_desc *acpi_desc,
715 struct nfit_table_prev *prev,
716 struct acpi_nfit_memory_map *memdev)
717{
718 struct device *dev = acpi_desc->dev;
719 struct nfit_memdev *nfit_memdev;
720
721 if (memdev->header.length != sizeof(*memdev))
722 return false;
723
724 list_for_each_entry(nfit_memdev, &prev->memdevs, list)
725 if (memcmp(nfit_memdev->memdev, memdev, sizeof(*memdev)) == 0) {
726 list_move_tail(&nfit_memdev->list, &acpi_desc->memdevs);
727 return true;
728 }
729
730 nfit_memdev = devm_kzalloc(dev, sizeof(*nfit_memdev) + sizeof(*memdev),
731 GFP_KERNEL);
732 if (!nfit_memdev)
733 return false;
734 INIT_LIST_HEAD(&nfit_memdev->list);
735 memcpy(nfit_memdev->memdev, memdev, sizeof(*memdev));
736 list_add_tail(&nfit_memdev->list, &acpi_desc->memdevs);
737 dev_dbg(dev, "memdev handle: %#x spa: %d dcr: %d flags: %#x\n",
738 memdev->device_handle, memdev->range_index,
739 memdev->region_index, memdev->flags);
740 return true;
741}
742
743int nfit_get_smbios_id(u32 device_handle, u16 *flags)
744{
745 struct acpi_nfit_memory_map *memdev;
746 struct acpi_nfit_desc *acpi_desc;
747 struct nfit_mem *nfit_mem;
748 u16 physical_id;
749
750 mutex_lock(&acpi_desc_lock);
751 list_for_each_entry(acpi_desc, &acpi_descs, list) {
752 mutex_lock(&acpi_desc->init_mutex);
753 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
754 memdev = __to_nfit_memdev(nfit_mem);
755 if (memdev->device_handle == device_handle) {
756 *flags = memdev->flags;
757 physical_id = memdev->physical_id;
758 mutex_unlock(&acpi_desc->init_mutex);
759 mutex_unlock(&acpi_desc_lock);
760 return physical_id;
761 }
762 }
763 mutex_unlock(&acpi_desc->init_mutex);
764 }
765 mutex_unlock(&acpi_desc_lock);
766
767 return -ENODEV;
768}
769EXPORT_SYMBOL_GPL(nfit_get_smbios_id);
770
771/*
772 * An implementation may provide a truncated control region if no block windows
773 * are defined.
774 */
775static size_t sizeof_dcr(struct acpi_nfit_control_region *dcr)
776{
777 if (dcr->header.length < offsetof(struct acpi_nfit_control_region,
778 window_size))
779 return 0;
780 if (dcr->windows)
781 return sizeof(*dcr);
782 return offsetof(struct acpi_nfit_control_region, window_size);
783}
784
785static bool add_dcr(struct acpi_nfit_desc *acpi_desc,
786 struct nfit_table_prev *prev,
787 struct acpi_nfit_control_region *dcr)
788{
789 struct device *dev = acpi_desc->dev;
790 struct nfit_dcr *nfit_dcr;
791
792 if (!sizeof_dcr(dcr))
793 return false;
794
795 list_for_each_entry(nfit_dcr, &prev->dcrs, list)
796 if (memcmp(nfit_dcr->dcr, dcr, sizeof_dcr(dcr)) == 0) {
797 list_move_tail(&nfit_dcr->list, &acpi_desc->dcrs);
798 return true;
799 }
800
801 nfit_dcr = devm_kzalloc(dev, sizeof(*nfit_dcr) + sizeof(*dcr),
802 GFP_KERNEL);
803 if (!nfit_dcr)
804 return false;
805 INIT_LIST_HEAD(&nfit_dcr->list);
806 memcpy(nfit_dcr->dcr, dcr, sizeof_dcr(dcr));
807 list_add_tail(&nfit_dcr->list, &acpi_desc->dcrs);
808 dev_dbg(dev, "dcr index: %d windows: %d\n",
809 dcr->region_index, dcr->windows);
810 return true;
811}
812
813static bool add_bdw(struct acpi_nfit_desc *acpi_desc,
814 struct nfit_table_prev *prev,
815 struct acpi_nfit_data_region *bdw)
816{
817 struct device *dev = acpi_desc->dev;
818 struct nfit_bdw *nfit_bdw;
819
820 if (bdw->header.length != sizeof(*bdw))
821 return false;
822 list_for_each_entry(nfit_bdw, &prev->bdws, list)
823 if (memcmp(nfit_bdw->bdw, bdw, sizeof(*bdw)) == 0) {
824 list_move_tail(&nfit_bdw->list, &acpi_desc->bdws);
825 return true;
826 }
827
828 nfit_bdw = devm_kzalloc(dev, sizeof(*nfit_bdw) + sizeof(*bdw),
829 GFP_KERNEL);
830 if (!nfit_bdw)
831 return false;
832 INIT_LIST_HEAD(&nfit_bdw->list);
833 memcpy(nfit_bdw->bdw, bdw, sizeof(*bdw));
834 list_add_tail(&nfit_bdw->list, &acpi_desc->bdws);
835 dev_dbg(dev, "bdw dcr: %d windows: %d\n",
836 bdw->region_index, bdw->windows);
837 return true;
838}
839
840static size_t sizeof_idt(struct acpi_nfit_interleave *idt)
841{
842 if (idt->header.length < sizeof(*idt))
843 return 0;
844 return sizeof(*idt) + sizeof(u32) * (idt->line_count - 1);
845}
846
847static bool add_idt(struct acpi_nfit_desc *acpi_desc,
848 struct nfit_table_prev *prev,
849 struct acpi_nfit_interleave *idt)
850{
851 struct device *dev = acpi_desc->dev;
852 struct nfit_idt *nfit_idt;
853
854 if (!sizeof_idt(idt))
855 return false;
856
857 list_for_each_entry(nfit_idt, &prev->idts, list) {
858 if (sizeof_idt(nfit_idt->idt) != sizeof_idt(idt))
859 continue;
860
861 if (memcmp(nfit_idt->idt, idt, sizeof_idt(idt)) == 0) {
862 list_move_tail(&nfit_idt->list, &acpi_desc->idts);
863 return true;
864 }
865 }
866
867 nfit_idt = devm_kzalloc(dev, sizeof(*nfit_idt) + sizeof_idt(idt),
868 GFP_KERNEL);
869 if (!nfit_idt)
870 return false;
871 INIT_LIST_HEAD(&nfit_idt->list);
872 memcpy(nfit_idt->idt, idt, sizeof_idt(idt));
873 list_add_tail(&nfit_idt->list, &acpi_desc->idts);
874 dev_dbg(dev, "idt index: %d num_lines: %d\n",
875 idt->interleave_index, idt->line_count);
876 return true;
877}
878
879static size_t sizeof_flush(struct acpi_nfit_flush_address *flush)
880{
881 if (flush->header.length < sizeof(*flush))
882 return 0;
883 return sizeof(*flush) + sizeof(u64) * (flush->hint_count - 1);
884}
885
886static bool add_flush(struct acpi_nfit_desc *acpi_desc,
887 struct nfit_table_prev *prev,
888 struct acpi_nfit_flush_address *flush)
889{
890 struct device *dev = acpi_desc->dev;
891 struct nfit_flush *nfit_flush;
892
893 if (!sizeof_flush(flush))
894 return false;
895
896 list_for_each_entry(nfit_flush, &prev->flushes, list) {
897 if (sizeof_flush(nfit_flush->flush) != sizeof_flush(flush))
898 continue;
899
900 if (memcmp(nfit_flush->flush, flush,
901 sizeof_flush(flush)) == 0) {
902 list_move_tail(&nfit_flush->list, &acpi_desc->flushes);
903 return true;
904 }
905 }
906
907 nfit_flush = devm_kzalloc(dev, sizeof(*nfit_flush)
908 + sizeof_flush(flush), GFP_KERNEL);
909 if (!nfit_flush)
910 return false;
911 INIT_LIST_HEAD(&nfit_flush->list);
912 memcpy(nfit_flush->flush, flush, sizeof_flush(flush));
913 list_add_tail(&nfit_flush->list, &acpi_desc->flushes);
914 dev_dbg(dev, "nfit_flush handle: %d hint_count: %d\n",
915 flush->device_handle, flush->hint_count);
916 return true;
917}
918
919static bool add_platform_cap(struct acpi_nfit_desc *acpi_desc,
920 struct acpi_nfit_capabilities *pcap)
921{
922 struct device *dev = acpi_desc->dev;
923 u32 mask;
924
925 mask = (1 << (pcap->highest_capability + 1)) - 1;
926 acpi_desc->platform_cap = pcap->capabilities & mask;
927 dev_dbg(dev, "cap: %#x\n", acpi_desc->platform_cap);
928 return true;
929}
930
931static void *add_table(struct acpi_nfit_desc *acpi_desc,
932 struct nfit_table_prev *prev, void *table, const void *end)
933{
934 struct device *dev = acpi_desc->dev;
935 struct acpi_nfit_header *hdr;
936 void *err = ERR_PTR(-ENOMEM);
937
938 if (table >= end)
939 return NULL;
940
941 hdr = table;
942 if (!hdr->length) {
943 dev_warn(dev, "found a zero length table '%d' parsing nfit\n",
944 hdr->type);
945 return NULL;
946 }
947
948 switch (hdr->type) {
949 case ACPI_NFIT_TYPE_SYSTEM_ADDRESS:
950 if (!add_spa(acpi_desc, prev, table))
951 return err;
952 break;
953 case ACPI_NFIT_TYPE_MEMORY_MAP:
954 if (!add_memdev(acpi_desc, prev, table))
955 return err;
956 break;
957 case ACPI_NFIT_TYPE_CONTROL_REGION:
958 if (!add_dcr(acpi_desc, prev, table))
959 return err;
960 break;
961 case ACPI_NFIT_TYPE_DATA_REGION:
962 if (!add_bdw(acpi_desc, prev, table))
963 return err;
964 break;
965 case ACPI_NFIT_TYPE_INTERLEAVE:
966 if (!add_idt(acpi_desc, prev, table))
967 return err;
968 break;
969 case ACPI_NFIT_TYPE_FLUSH_ADDRESS:
970 if (!add_flush(acpi_desc, prev, table))
971 return err;
972 break;
973 case ACPI_NFIT_TYPE_SMBIOS:
974 dev_dbg(dev, "smbios\n");
975 break;
976 case ACPI_NFIT_TYPE_CAPABILITIES:
977 if (!add_platform_cap(acpi_desc, table))
978 return err;
979 break;
980 default:
981 dev_err(dev, "unknown table '%d' parsing nfit\n", hdr->type);
982 break;
983 }
984
985 return table + hdr->length;
986}
987
988static void nfit_mem_find_spa_bdw(struct acpi_nfit_desc *acpi_desc,
989 struct nfit_mem *nfit_mem)
990{
991 u32 device_handle = __to_nfit_memdev(nfit_mem)->device_handle;
992 u16 dcr = nfit_mem->dcr->region_index;
993 struct nfit_spa *nfit_spa;
994
995 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
996 u16 range_index = nfit_spa->spa->range_index;
997 int type = nfit_spa_type(nfit_spa->spa);
998 struct nfit_memdev *nfit_memdev;
999
1000 if (type != NFIT_SPA_BDW)
1001 continue;
1002
1003 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
1004 if (nfit_memdev->memdev->range_index != range_index)
1005 continue;
1006 if (nfit_memdev->memdev->device_handle != device_handle)
1007 continue;
1008 if (nfit_memdev->memdev->region_index != dcr)
1009 continue;
1010
1011 nfit_mem->spa_bdw = nfit_spa->spa;
1012 return;
1013 }
1014 }
1015
1016 dev_dbg(acpi_desc->dev, "SPA-BDW not found for SPA-DCR %d\n",
1017 nfit_mem->spa_dcr->range_index);
1018 nfit_mem->bdw = NULL;
1019}
1020
1021static void nfit_mem_init_bdw(struct acpi_nfit_desc *acpi_desc,
1022 struct nfit_mem *nfit_mem, struct acpi_nfit_system_address *spa)
1023{
1024 u16 dcr = __to_nfit_memdev(nfit_mem)->region_index;
1025 struct nfit_memdev *nfit_memdev;
1026 struct nfit_bdw *nfit_bdw;
1027 struct nfit_idt *nfit_idt;
1028 u16 idt_idx, range_index;
1029
1030 list_for_each_entry(nfit_bdw, &acpi_desc->bdws, list) {
1031 if (nfit_bdw->bdw->region_index != dcr)
1032 continue;
1033 nfit_mem->bdw = nfit_bdw->bdw;
1034 break;
1035 }
1036
1037 if (!nfit_mem->bdw)
1038 return;
1039
1040 nfit_mem_find_spa_bdw(acpi_desc, nfit_mem);
1041
1042 if (!nfit_mem->spa_bdw)
1043 return;
1044
1045 range_index = nfit_mem->spa_bdw->range_index;
1046 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
1047 if (nfit_memdev->memdev->range_index != range_index ||
1048 nfit_memdev->memdev->region_index != dcr)
1049 continue;
1050 nfit_mem->memdev_bdw = nfit_memdev->memdev;
1051 idt_idx = nfit_memdev->memdev->interleave_index;
1052 list_for_each_entry(nfit_idt, &acpi_desc->idts, list) {
1053 if (nfit_idt->idt->interleave_index != idt_idx)
1054 continue;
1055 nfit_mem->idt_bdw = nfit_idt->idt;
1056 break;
1057 }
1058 break;
1059 }
1060}
1061
1062static int __nfit_mem_init(struct acpi_nfit_desc *acpi_desc,
1063 struct acpi_nfit_system_address *spa)
1064{
1065 struct nfit_mem *nfit_mem, *found;
1066 struct nfit_memdev *nfit_memdev;
1067 int type = spa ? nfit_spa_type(spa) : 0;
1068
1069 switch (type) {
1070 case NFIT_SPA_DCR:
1071 case NFIT_SPA_PM:
1072 break;
1073 default:
1074 if (spa)
1075 return 0;
1076 }
1077
1078 /*
1079 * This loop runs in two modes, when a dimm is mapped the loop
1080 * adds memdev associations to an existing dimm, or creates a
1081 * dimm. In the unmapped dimm case this loop sweeps for memdev
1082 * instances with an invalid / zero range_index and adds those
1083 * dimms without spa associations.
1084 */
1085 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
1086 struct nfit_flush *nfit_flush;
1087 struct nfit_dcr *nfit_dcr;
1088 u32 device_handle;
1089 u16 dcr;
1090
1091 if (spa && nfit_memdev->memdev->range_index != spa->range_index)
1092 continue;
1093 if (!spa && nfit_memdev->memdev->range_index)
1094 continue;
1095 found = NULL;
1096 dcr = nfit_memdev->memdev->region_index;
1097 device_handle = nfit_memdev->memdev->device_handle;
1098 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list)
1099 if (__to_nfit_memdev(nfit_mem)->device_handle
1100 == device_handle) {
1101 found = nfit_mem;
1102 break;
1103 }
1104
1105 if (found)
1106 nfit_mem = found;
1107 else {
1108 nfit_mem = devm_kzalloc(acpi_desc->dev,
1109 sizeof(*nfit_mem), GFP_KERNEL);
1110 if (!nfit_mem)
1111 return -ENOMEM;
1112 INIT_LIST_HEAD(&nfit_mem->list);
1113 nfit_mem->acpi_desc = acpi_desc;
1114 list_add(&nfit_mem->list, &acpi_desc->dimms);
1115 }
1116
1117 list_for_each_entry(nfit_dcr, &acpi_desc->dcrs, list) {
1118 if (nfit_dcr->dcr->region_index != dcr)
1119 continue;
1120 /*
1121 * Record the control region for the dimm. For
1122 * the ACPI 6.1 case, where there are separate
1123 * control regions for the pmem vs blk
1124 * interfaces, be sure to record the extended
1125 * blk details.
1126 */
1127 if (!nfit_mem->dcr)
1128 nfit_mem->dcr = nfit_dcr->dcr;
1129 else if (nfit_mem->dcr->windows == 0
1130 && nfit_dcr->dcr->windows)
1131 nfit_mem->dcr = nfit_dcr->dcr;
1132 break;
1133 }
1134
1135 list_for_each_entry(nfit_flush, &acpi_desc->flushes, list) {
1136 struct acpi_nfit_flush_address *flush;
1137 u16 i;
1138
1139 if (nfit_flush->flush->device_handle != device_handle)
1140 continue;
1141 nfit_mem->nfit_flush = nfit_flush;
1142 flush = nfit_flush->flush;
1143 nfit_mem->flush_wpq = devm_kcalloc(acpi_desc->dev,
1144 flush->hint_count,
1145 sizeof(struct resource),
1146 GFP_KERNEL);
1147 if (!nfit_mem->flush_wpq)
1148 return -ENOMEM;
1149 for (i = 0; i < flush->hint_count; i++) {
1150 struct resource *res = &nfit_mem->flush_wpq[i];
1151
1152 res->start = flush->hint_address[i];
1153 res->end = res->start + 8 - 1;
1154 }
1155 break;
1156 }
1157
1158 if (dcr && !nfit_mem->dcr) {
1159 dev_err(acpi_desc->dev, "SPA %d missing DCR %d\n",
1160 spa->range_index, dcr);
1161 return -ENODEV;
1162 }
1163
1164 if (type == NFIT_SPA_DCR) {
1165 struct nfit_idt *nfit_idt;
1166 u16 idt_idx;
1167
1168 /* multiple dimms may share a SPA when interleaved */
1169 nfit_mem->spa_dcr = spa;
1170 nfit_mem->memdev_dcr = nfit_memdev->memdev;
1171 idt_idx = nfit_memdev->memdev->interleave_index;
1172 list_for_each_entry(nfit_idt, &acpi_desc->idts, list) {
1173 if (nfit_idt->idt->interleave_index != idt_idx)
1174 continue;
1175 nfit_mem->idt_dcr = nfit_idt->idt;
1176 break;
1177 }
1178 nfit_mem_init_bdw(acpi_desc, nfit_mem, spa);
1179 } else if (type == NFIT_SPA_PM) {
1180 /*
1181 * A single dimm may belong to multiple SPA-PM
1182 * ranges, record at least one in addition to
1183 * any SPA-DCR range.
1184 */
1185 nfit_mem->memdev_pmem = nfit_memdev->memdev;
1186 } else
1187 nfit_mem->memdev_dcr = nfit_memdev->memdev;
1188 }
1189
1190 return 0;
1191}
1192
1193static int nfit_mem_cmp(void *priv, struct list_head *_a, struct list_head *_b)
1194{
1195 struct nfit_mem *a = container_of(_a, typeof(*a), list);
1196 struct nfit_mem *b = container_of(_b, typeof(*b), list);
1197 u32 handleA, handleB;
1198
1199 handleA = __to_nfit_memdev(a)->device_handle;
1200 handleB = __to_nfit_memdev(b)->device_handle;
1201 if (handleA < handleB)
1202 return -1;
1203 else if (handleA > handleB)
1204 return 1;
1205 return 0;
1206}
1207
1208static int nfit_mem_init(struct acpi_nfit_desc *acpi_desc)
1209{
1210 struct nfit_spa *nfit_spa;
1211 int rc;
1212
1213
1214 /*
1215 * For each SPA-DCR or SPA-PMEM address range find its
1216 * corresponding MEMDEV(s). From each MEMDEV find the
1217 * corresponding DCR. Then, if we're operating on a SPA-DCR,
1218 * try to find a SPA-BDW and a corresponding BDW that references
1219 * the DCR. Throw it all into an nfit_mem object. Note, that
1220 * BDWs are optional.
1221 */
1222 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
1223 rc = __nfit_mem_init(acpi_desc, nfit_spa->spa);
1224 if (rc)
1225 return rc;
1226 }
1227
1228 /*
1229 * If a DIMM has failed to be mapped into SPA there will be no
1230 * SPA entries above. Find and register all the unmapped DIMMs
1231 * for reporting and recovery purposes.
1232 */
1233 rc = __nfit_mem_init(acpi_desc, NULL);
1234 if (rc)
1235 return rc;
1236
1237 list_sort(NULL, &acpi_desc->dimms, nfit_mem_cmp);
1238
1239 return 0;
1240}
1241
1242static ssize_t bus_dsm_mask_show(struct device *dev,
1243 struct device_attribute *attr, char *buf)
1244{
1245 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
1246 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1247 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1248
1249 return sprintf(buf, "%#lx\n", acpi_desc->bus_dsm_mask);
1250}
1251static struct device_attribute dev_attr_bus_dsm_mask =
1252 __ATTR(dsm_mask, 0444, bus_dsm_mask_show, NULL);
1253
1254static ssize_t revision_show(struct device *dev,
1255 struct device_attribute *attr, char *buf)
1256{
1257 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
1258 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1259 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1260
1261 return sprintf(buf, "%d\n", acpi_desc->acpi_header.revision);
1262}
1263static DEVICE_ATTR_RO(revision);
1264
1265static ssize_t hw_error_scrub_show(struct device *dev,
1266 struct device_attribute *attr, char *buf)
1267{
1268 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
1269 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1270 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1271
1272 return sprintf(buf, "%d\n", acpi_desc->scrub_mode);
1273}
1274
1275/*
1276 * The 'hw_error_scrub' attribute can have the following values written to it:
1277 * '0': Switch to the default mode where an exception will only insert
1278 * the address of the memory error into the poison and badblocks lists.
1279 * '1': Enable a full scrub to happen if an exception for a memory error is
1280 * received.
1281 */
1282static ssize_t hw_error_scrub_store(struct device *dev,
1283 struct device_attribute *attr, const char *buf, size_t size)
1284{
1285 struct nvdimm_bus_descriptor *nd_desc;
1286 ssize_t rc;
1287 long val;
1288
1289 rc = kstrtol(buf, 0, &val);
1290 if (rc)
1291 return rc;
1292
1293 nfit_device_lock(dev);
1294 nd_desc = dev_get_drvdata(dev);
1295 if (nd_desc) {
1296 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1297
1298 switch (val) {
1299 case HW_ERROR_SCRUB_ON:
1300 acpi_desc->scrub_mode = HW_ERROR_SCRUB_ON;
1301 break;
1302 case HW_ERROR_SCRUB_OFF:
1303 acpi_desc->scrub_mode = HW_ERROR_SCRUB_OFF;
1304 break;
1305 default:
1306 rc = -EINVAL;
1307 break;
1308 }
1309 }
1310 nfit_device_unlock(dev);
1311 if (rc)
1312 return rc;
1313 return size;
1314}
1315static DEVICE_ATTR_RW(hw_error_scrub);
1316
1317/*
1318 * This shows the number of full Address Range Scrubs that have been
1319 * completed since driver load time. Userspace can wait on this using
1320 * select/poll etc. A '+' at the end indicates an ARS is in progress
1321 */
1322static ssize_t scrub_show(struct device *dev,
1323 struct device_attribute *attr, char *buf)
1324{
1325 struct nvdimm_bus_descriptor *nd_desc;
1326 struct acpi_nfit_desc *acpi_desc;
1327 ssize_t rc = -ENXIO;
1328 bool busy;
1329
1330 nfit_device_lock(dev);
1331 nd_desc = dev_get_drvdata(dev);
1332 if (!nd_desc) {
1333 nfit_device_unlock(dev);
1334 return rc;
1335 }
1336 acpi_desc = to_acpi_desc(nd_desc);
1337
1338 mutex_lock(&acpi_desc->init_mutex);
1339 busy = test_bit(ARS_BUSY, &acpi_desc->scrub_flags)
1340 && !test_bit(ARS_CANCEL, &acpi_desc->scrub_flags);
1341 rc = sprintf(buf, "%d%s", acpi_desc->scrub_count, busy ? "+\n" : "\n");
1342 /* Allow an admin to poll the busy state at a higher rate */
1343 if (busy && capable(CAP_SYS_RAWIO) && !test_and_set_bit(ARS_POLL,
1344 &acpi_desc->scrub_flags)) {
1345 acpi_desc->scrub_tmo = 1;
1346 mod_delayed_work(nfit_wq, &acpi_desc->dwork, HZ);
1347 }
1348
1349 mutex_unlock(&acpi_desc->init_mutex);
1350 nfit_device_unlock(dev);
1351 return rc;
1352}
1353
1354static ssize_t scrub_store(struct device *dev,
1355 struct device_attribute *attr, const char *buf, size_t size)
1356{
1357 struct nvdimm_bus_descriptor *nd_desc;
1358 ssize_t rc;
1359 long val;
1360
1361 rc = kstrtol(buf, 0, &val);
1362 if (rc)
1363 return rc;
1364 if (val != 1)
1365 return -EINVAL;
1366
1367 nfit_device_lock(dev);
1368 nd_desc = dev_get_drvdata(dev);
1369 if (nd_desc) {
1370 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1371
1372 rc = acpi_nfit_ars_rescan(acpi_desc, ARS_REQ_LONG);
1373 }
1374 nfit_device_unlock(dev);
1375 if (rc)
1376 return rc;
1377 return size;
1378}
1379static DEVICE_ATTR_RW(scrub);
1380
1381static bool ars_supported(struct nvdimm_bus *nvdimm_bus)
1382{
1383 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1384 const unsigned long mask = 1 << ND_CMD_ARS_CAP | 1 << ND_CMD_ARS_START
1385 | 1 << ND_CMD_ARS_STATUS;
1386
1387 return (nd_desc->cmd_mask & mask) == mask;
1388}
1389
1390static umode_t nfit_visible(struct kobject *kobj, struct attribute *a, int n)
1391{
1392 struct device *dev = container_of(kobj, struct device, kobj);
1393 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
1394
1395 if (a == &dev_attr_scrub.attr)
1396 return ars_supported(nvdimm_bus) ? a->mode : 0;
1397
1398 if (a == &dev_attr_firmware_activate_noidle.attr)
1399 return intel_fwa_supported(nvdimm_bus) ? a->mode : 0;
1400
1401 return a->mode;
1402}
1403
1404static struct attribute *acpi_nfit_attributes[] = {
1405 &dev_attr_revision.attr,
1406 &dev_attr_scrub.attr,
1407 &dev_attr_hw_error_scrub.attr,
1408 &dev_attr_bus_dsm_mask.attr,
1409 &dev_attr_firmware_activate_noidle.attr,
1410 NULL,
1411};
1412
1413static const struct attribute_group acpi_nfit_attribute_group = {
1414 .name = "nfit",
1415 .attrs = acpi_nfit_attributes,
1416 .is_visible = nfit_visible,
1417};
1418
1419static const struct attribute_group *acpi_nfit_attribute_groups[] = {
1420 &acpi_nfit_attribute_group,
1421 NULL,
1422};
1423
1424static struct acpi_nfit_memory_map *to_nfit_memdev(struct device *dev)
1425{
1426 struct nvdimm *nvdimm = to_nvdimm(dev);
1427 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1428
1429 return __to_nfit_memdev(nfit_mem);
1430}
1431
1432static struct acpi_nfit_control_region *to_nfit_dcr(struct device *dev)
1433{
1434 struct nvdimm *nvdimm = to_nvdimm(dev);
1435 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1436
1437 return nfit_mem->dcr;
1438}
1439
1440static ssize_t handle_show(struct device *dev,
1441 struct device_attribute *attr, char *buf)
1442{
1443 struct acpi_nfit_memory_map *memdev = to_nfit_memdev(dev);
1444
1445 return sprintf(buf, "%#x\n", memdev->device_handle);
1446}
1447static DEVICE_ATTR_RO(handle);
1448
1449static ssize_t phys_id_show(struct device *dev,
1450 struct device_attribute *attr, char *buf)
1451{
1452 struct acpi_nfit_memory_map *memdev = to_nfit_memdev(dev);
1453
1454 return sprintf(buf, "%#x\n", memdev->physical_id);
1455}
1456static DEVICE_ATTR_RO(phys_id);
1457
1458static ssize_t vendor_show(struct device *dev,
1459 struct device_attribute *attr, char *buf)
1460{
1461 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1462
1463 return sprintf(buf, "0x%04x\n", be16_to_cpu(dcr->vendor_id));
1464}
1465static DEVICE_ATTR_RO(vendor);
1466
1467static ssize_t rev_id_show(struct device *dev,
1468 struct device_attribute *attr, char *buf)
1469{
1470 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1471
1472 return sprintf(buf, "0x%04x\n", be16_to_cpu(dcr->revision_id));
1473}
1474static DEVICE_ATTR_RO(rev_id);
1475
1476static ssize_t device_show(struct device *dev,
1477 struct device_attribute *attr, char *buf)
1478{
1479 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1480
1481 return sprintf(buf, "0x%04x\n", be16_to_cpu(dcr->device_id));
1482}
1483static DEVICE_ATTR_RO(device);
1484
1485static ssize_t subsystem_vendor_show(struct device *dev,
1486 struct device_attribute *attr, char *buf)
1487{
1488 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1489
1490 return sprintf(buf, "0x%04x\n", be16_to_cpu(dcr->subsystem_vendor_id));
1491}
1492static DEVICE_ATTR_RO(subsystem_vendor);
1493
1494static ssize_t subsystem_rev_id_show(struct device *dev,
1495 struct device_attribute *attr, char *buf)
1496{
1497 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1498
1499 return sprintf(buf, "0x%04x\n",
1500 be16_to_cpu(dcr->subsystem_revision_id));
1501}
1502static DEVICE_ATTR_RO(subsystem_rev_id);
1503
1504static ssize_t subsystem_device_show(struct device *dev,
1505 struct device_attribute *attr, char *buf)
1506{
1507 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1508
1509 return sprintf(buf, "0x%04x\n", be16_to_cpu(dcr->subsystem_device_id));
1510}
1511static DEVICE_ATTR_RO(subsystem_device);
1512
1513static int num_nvdimm_formats(struct nvdimm *nvdimm)
1514{
1515 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1516 int formats = 0;
1517
1518 if (nfit_mem->memdev_pmem)
1519 formats++;
1520 if (nfit_mem->memdev_bdw)
1521 formats++;
1522 return formats;
1523}
1524
1525static ssize_t format_show(struct device *dev,
1526 struct device_attribute *attr, char *buf)
1527{
1528 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1529
1530 return sprintf(buf, "0x%04x\n", le16_to_cpu(dcr->code));
1531}
1532static DEVICE_ATTR_RO(format);
1533
1534static ssize_t format1_show(struct device *dev,
1535 struct device_attribute *attr, char *buf)
1536{
1537 u32 handle;
1538 ssize_t rc = -ENXIO;
1539 struct nfit_mem *nfit_mem;
1540 struct nfit_memdev *nfit_memdev;
1541 struct acpi_nfit_desc *acpi_desc;
1542 struct nvdimm *nvdimm = to_nvdimm(dev);
1543 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1544
1545 nfit_mem = nvdimm_provider_data(nvdimm);
1546 acpi_desc = nfit_mem->acpi_desc;
1547 handle = to_nfit_memdev(dev)->device_handle;
1548
1549 /* assumes DIMMs have at most 2 published interface codes */
1550 mutex_lock(&acpi_desc->init_mutex);
1551 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
1552 struct acpi_nfit_memory_map *memdev = nfit_memdev->memdev;
1553 struct nfit_dcr *nfit_dcr;
1554
1555 if (memdev->device_handle != handle)
1556 continue;
1557
1558 list_for_each_entry(nfit_dcr, &acpi_desc->dcrs, list) {
1559 if (nfit_dcr->dcr->region_index != memdev->region_index)
1560 continue;
1561 if (nfit_dcr->dcr->code == dcr->code)
1562 continue;
1563 rc = sprintf(buf, "0x%04x\n",
1564 le16_to_cpu(nfit_dcr->dcr->code));
1565 break;
1566 }
1567 if (rc != ENXIO)
1568 break;
1569 }
1570 mutex_unlock(&acpi_desc->init_mutex);
1571 return rc;
1572}
1573static DEVICE_ATTR_RO(format1);
1574
1575static ssize_t formats_show(struct device *dev,
1576 struct device_attribute *attr, char *buf)
1577{
1578 struct nvdimm *nvdimm = to_nvdimm(dev);
1579
1580 return sprintf(buf, "%d\n", num_nvdimm_formats(nvdimm));
1581}
1582static DEVICE_ATTR_RO(formats);
1583
1584static ssize_t serial_show(struct device *dev,
1585 struct device_attribute *attr, char *buf)
1586{
1587 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1588
1589 return sprintf(buf, "0x%08x\n", be32_to_cpu(dcr->serial_number));
1590}
1591static DEVICE_ATTR_RO(serial);
1592
1593static ssize_t family_show(struct device *dev,
1594 struct device_attribute *attr, char *buf)
1595{
1596 struct nvdimm *nvdimm = to_nvdimm(dev);
1597 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1598
1599 if (nfit_mem->family < 0)
1600 return -ENXIO;
1601 return sprintf(buf, "%d\n", nfit_mem->family);
1602}
1603static DEVICE_ATTR_RO(family);
1604
1605static ssize_t dsm_mask_show(struct device *dev,
1606 struct device_attribute *attr, char *buf)
1607{
1608 struct nvdimm *nvdimm = to_nvdimm(dev);
1609 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1610
1611 if (nfit_mem->family < 0)
1612 return -ENXIO;
1613 return sprintf(buf, "%#lx\n", nfit_mem->dsm_mask);
1614}
1615static DEVICE_ATTR_RO(dsm_mask);
1616
1617static ssize_t flags_show(struct device *dev,
1618 struct device_attribute *attr, char *buf)
1619{
1620 struct nvdimm *nvdimm = to_nvdimm(dev);
1621 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1622 u16 flags = __to_nfit_memdev(nfit_mem)->flags;
1623
1624 if (test_bit(NFIT_MEM_DIRTY, &nfit_mem->flags))
1625 flags |= ACPI_NFIT_MEM_FLUSH_FAILED;
1626
1627 return sprintf(buf, "%s%s%s%s%s%s%s\n",
1628 flags & ACPI_NFIT_MEM_SAVE_FAILED ? "save_fail " : "",
1629 flags & ACPI_NFIT_MEM_RESTORE_FAILED ? "restore_fail " : "",
1630 flags & ACPI_NFIT_MEM_FLUSH_FAILED ? "flush_fail " : "",
1631 flags & ACPI_NFIT_MEM_NOT_ARMED ? "not_armed " : "",
1632 flags & ACPI_NFIT_MEM_HEALTH_OBSERVED ? "smart_event " : "",
1633 flags & ACPI_NFIT_MEM_MAP_FAILED ? "map_fail " : "",
1634 flags & ACPI_NFIT_MEM_HEALTH_ENABLED ? "smart_notify " : "");
1635}
1636static DEVICE_ATTR_RO(flags);
1637
1638static ssize_t id_show(struct device *dev,
1639 struct device_attribute *attr, char *buf)
1640{
1641 struct nvdimm *nvdimm = to_nvdimm(dev);
1642 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1643
1644 return sprintf(buf, "%s\n", nfit_mem->id);
1645}
1646static DEVICE_ATTR_RO(id);
1647
1648static ssize_t dirty_shutdown_show(struct device *dev,
1649 struct device_attribute *attr, char *buf)
1650{
1651 struct nvdimm *nvdimm = to_nvdimm(dev);
1652 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1653
1654 return sprintf(buf, "%d\n", nfit_mem->dirty_shutdown);
1655}
1656static DEVICE_ATTR_RO(dirty_shutdown);
1657
1658static struct attribute *acpi_nfit_dimm_attributes[] = {
1659 &dev_attr_handle.attr,
1660 &dev_attr_phys_id.attr,
1661 &dev_attr_vendor.attr,
1662 &dev_attr_device.attr,
1663 &dev_attr_rev_id.attr,
1664 &dev_attr_subsystem_vendor.attr,
1665 &dev_attr_subsystem_device.attr,
1666 &dev_attr_subsystem_rev_id.attr,
1667 &dev_attr_format.attr,
1668 &dev_attr_formats.attr,
1669 &dev_attr_format1.attr,
1670 &dev_attr_serial.attr,
1671 &dev_attr_flags.attr,
1672 &dev_attr_id.attr,
1673 &dev_attr_family.attr,
1674 &dev_attr_dsm_mask.attr,
1675 &dev_attr_dirty_shutdown.attr,
1676 NULL,
1677};
1678
1679static umode_t acpi_nfit_dimm_attr_visible(struct kobject *kobj,
1680 struct attribute *a, int n)
1681{
1682 struct device *dev = container_of(kobj, struct device, kobj);
1683 struct nvdimm *nvdimm = to_nvdimm(dev);
1684 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1685
1686 if (!to_nfit_dcr(dev)) {
1687 /* Without a dcr only the memdev attributes can be surfaced */
1688 if (a == &dev_attr_handle.attr || a == &dev_attr_phys_id.attr
1689 || a == &dev_attr_flags.attr
1690 || a == &dev_attr_family.attr
1691 || a == &dev_attr_dsm_mask.attr)
1692 return a->mode;
1693 return 0;
1694 }
1695
1696 if (a == &dev_attr_format1.attr && num_nvdimm_formats(nvdimm) <= 1)
1697 return 0;
1698
1699 if (!test_bit(NFIT_MEM_DIRTY_COUNT, &nfit_mem->flags)
1700 && a == &dev_attr_dirty_shutdown.attr)
1701 return 0;
1702
1703 return a->mode;
1704}
1705
1706static const struct attribute_group acpi_nfit_dimm_attribute_group = {
1707 .name = "nfit",
1708 .attrs = acpi_nfit_dimm_attributes,
1709 .is_visible = acpi_nfit_dimm_attr_visible,
1710};
1711
1712static const struct attribute_group *acpi_nfit_dimm_attribute_groups[] = {
1713 &acpi_nfit_dimm_attribute_group,
1714 NULL,
1715};
1716
1717static struct nvdimm *acpi_nfit_dimm_by_handle(struct acpi_nfit_desc *acpi_desc,
1718 u32 device_handle)
1719{
1720 struct nfit_mem *nfit_mem;
1721
1722 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list)
1723 if (__to_nfit_memdev(nfit_mem)->device_handle == device_handle)
1724 return nfit_mem->nvdimm;
1725
1726 return NULL;
1727}
1728
1729void __acpi_nvdimm_notify(struct device *dev, u32 event)
1730{
1731 struct nfit_mem *nfit_mem;
1732 struct acpi_nfit_desc *acpi_desc;
1733
1734 dev_dbg(dev->parent, "%s: event: %d\n", dev_name(dev),
1735 event);
1736
1737 if (event != NFIT_NOTIFY_DIMM_HEALTH) {
1738 dev_dbg(dev->parent, "%s: unknown event: %d\n", dev_name(dev),
1739 event);
1740 return;
1741 }
1742
1743 acpi_desc = dev_get_drvdata(dev->parent);
1744 if (!acpi_desc)
1745 return;
1746
1747 /*
1748 * If we successfully retrieved acpi_desc, then we know nfit_mem data
1749 * is still valid.
1750 */
1751 nfit_mem = dev_get_drvdata(dev);
1752 if (nfit_mem && nfit_mem->flags_attr)
1753 sysfs_notify_dirent(nfit_mem->flags_attr);
1754}
1755EXPORT_SYMBOL_GPL(__acpi_nvdimm_notify);
1756
1757static void acpi_nvdimm_notify(acpi_handle handle, u32 event, void *data)
1758{
1759 struct acpi_device *adev = data;
1760 struct device *dev = &adev->dev;
1761
1762 nfit_device_lock(dev->parent);
1763 __acpi_nvdimm_notify(dev, event);
1764 nfit_device_unlock(dev->parent);
1765}
1766
1767static bool acpi_nvdimm_has_method(struct acpi_device *adev, char *method)
1768{
1769 acpi_handle handle;
1770 acpi_status status;
1771
1772 status = acpi_get_handle(adev->handle, method, &handle);
1773
1774 if (ACPI_SUCCESS(status))
1775 return true;
1776 return false;
1777}
1778
1779__weak void nfit_intel_shutdown_status(struct nfit_mem *nfit_mem)
1780{
1781 struct device *dev = &nfit_mem->adev->dev;
1782 struct nd_intel_smart smart = { 0 };
1783 union acpi_object in_buf = {
1784 .buffer.type = ACPI_TYPE_BUFFER,
1785 .buffer.length = 0,
1786 };
1787 union acpi_object in_obj = {
1788 .package.type = ACPI_TYPE_PACKAGE,
1789 .package.count = 1,
1790 .package.elements = &in_buf,
1791 };
1792 const u8 func = ND_INTEL_SMART;
1793 const guid_t *guid = to_nfit_uuid(nfit_mem->family);
1794 u8 revid = nfit_dsm_revid(nfit_mem->family, func);
1795 struct acpi_device *adev = nfit_mem->adev;
1796 acpi_handle handle = adev->handle;
1797 union acpi_object *out_obj;
1798
1799 if ((nfit_mem->dsm_mask & (1 << func)) == 0)
1800 return;
1801
1802 out_obj = acpi_evaluate_dsm(handle, guid, revid, func, &in_obj);
1803 if (!out_obj || out_obj->type != ACPI_TYPE_BUFFER
1804 || out_obj->buffer.length < sizeof(smart)) {
1805 dev_dbg(dev->parent, "%s: failed to retrieve initial health\n",
1806 dev_name(dev));
1807 ACPI_FREE(out_obj);
1808 return;
1809 }
1810 memcpy(&smart, out_obj->buffer.pointer, sizeof(smart));
1811 ACPI_FREE(out_obj);
1812
1813 if (smart.flags & ND_INTEL_SMART_SHUTDOWN_VALID) {
1814 if (smart.shutdown_state)
1815 set_bit(NFIT_MEM_DIRTY, &nfit_mem->flags);
1816 }
1817
1818 if (smart.flags & ND_INTEL_SMART_SHUTDOWN_COUNT_VALID) {
1819 set_bit(NFIT_MEM_DIRTY_COUNT, &nfit_mem->flags);
1820 nfit_mem->dirty_shutdown = smart.shutdown_count;
1821 }
1822}
1823
1824static void populate_shutdown_status(struct nfit_mem *nfit_mem)
1825{
1826 /*
1827 * For DIMMs that provide a dynamic facility to retrieve a
1828 * dirty-shutdown status and/or a dirty-shutdown count, cache
1829 * these values in nfit_mem.
1830 */
1831 if (nfit_mem->family == NVDIMM_FAMILY_INTEL)
1832 nfit_intel_shutdown_status(nfit_mem);
1833}
1834
1835static int acpi_nfit_add_dimm(struct acpi_nfit_desc *acpi_desc,
1836 struct nfit_mem *nfit_mem, u32 device_handle)
1837{
1838 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
1839 struct acpi_device *adev, *adev_dimm;
1840 struct device *dev = acpi_desc->dev;
1841 unsigned long dsm_mask, label_mask;
1842 const guid_t *guid;
1843 int i;
1844 int family = -1;
1845 struct acpi_nfit_control_region *dcr = nfit_mem->dcr;
1846
1847 /* nfit test assumes 1:1 relationship between commands and dsms */
1848 nfit_mem->dsm_mask = acpi_desc->dimm_cmd_force_en;
1849 nfit_mem->family = NVDIMM_FAMILY_INTEL;
1850 set_bit(NVDIMM_FAMILY_INTEL, &nd_desc->dimm_family_mask);
1851
1852 if (dcr->valid_fields & ACPI_NFIT_CONTROL_MFG_INFO_VALID)
1853 sprintf(nfit_mem->id, "%04x-%02x-%04x-%08x",
1854 be16_to_cpu(dcr->vendor_id),
1855 dcr->manufacturing_location,
1856 be16_to_cpu(dcr->manufacturing_date),
1857 be32_to_cpu(dcr->serial_number));
1858 else
1859 sprintf(nfit_mem->id, "%04x-%08x",
1860 be16_to_cpu(dcr->vendor_id),
1861 be32_to_cpu(dcr->serial_number));
1862
1863 adev = to_acpi_dev(acpi_desc);
1864 if (!adev) {
1865 /* unit test case */
1866 populate_shutdown_status(nfit_mem);
1867 return 0;
1868 }
1869
1870 adev_dimm = acpi_find_child_device(adev, device_handle, false);
1871 nfit_mem->adev = adev_dimm;
1872 if (!adev_dimm) {
1873 dev_err(dev, "no ACPI.NFIT device with _ADR %#x, disabling...\n",
1874 device_handle);
1875 return force_enable_dimms ? 0 : -ENODEV;
1876 }
1877
1878 if (ACPI_FAILURE(acpi_install_notify_handler(adev_dimm->handle,
1879 ACPI_DEVICE_NOTIFY, acpi_nvdimm_notify, adev_dimm))) {
1880 dev_err(dev, "%s: notification registration failed\n",
1881 dev_name(&adev_dimm->dev));
1882 return -ENXIO;
1883 }
1884 /*
1885 * Record nfit_mem for the notification path to track back to
1886 * the nfit sysfs attributes for this dimm device object.
1887 */
1888 dev_set_drvdata(&adev_dimm->dev, nfit_mem);
1889
1890 /*
1891 * There are 4 "legacy" NVDIMM command sets
1892 * (NVDIMM_FAMILY_{INTEL,MSFT,HPE1,HPE2}) that were created before
1893 * an EFI working group was established to constrain this
1894 * proliferation. The nfit driver probes for the supported command
1895 * set by GUID. Note, if you're a platform developer looking to add
1896 * a new command set to this probe, consider using an existing set,
1897 * or otherwise seek approval to publish the command set at
1898 * http://www.uefi.org/RFIC_LIST.
1899 *
1900 * Note, that checking for function0 (bit0) tells us if any commands
1901 * are reachable through this GUID.
1902 */
1903 clear_bit(NVDIMM_FAMILY_INTEL, &nd_desc->dimm_family_mask);
1904 for (i = 0; i <= NVDIMM_FAMILY_MAX; i++)
1905 if (acpi_check_dsm(adev_dimm->handle, to_nfit_uuid(i), 1, 1)) {
1906 set_bit(i, &nd_desc->dimm_family_mask);
1907 if (family < 0 || i == default_dsm_family)
1908 family = i;
1909 }
1910
1911 /* limit the supported commands to those that are publicly documented */
1912 nfit_mem->family = family;
1913 if (override_dsm_mask && !disable_vendor_specific)
1914 dsm_mask = override_dsm_mask;
1915 else if (nfit_mem->family == NVDIMM_FAMILY_INTEL) {
1916 dsm_mask = NVDIMM_INTEL_CMDMASK;
1917 if (disable_vendor_specific)
1918 dsm_mask &= ~(1 << ND_CMD_VENDOR);
1919 } else if (nfit_mem->family == NVDIMM_FAMILY_HPE1) {
1920 dsm_mask = 0x1c3c76;
1921 } else if (nfit_mem->family == NVDIMM_FAMILY_HPE2) {
1922 dsm_mask = 0x1fe;
1923 if (disable_vendor_specific)
1924 dsm_mask &= ~(1 << 8);
1925 } else if (nfit_mem->family == NVDIMM_FAMILY_MSFT) {
1926 dsm_mask = 0xffffffff;
1927 } else if (nfit_mem->family == NVDIMM_FAMILY_HYPERV) {
1928 dsm_mask = 0x1f;
1929 } else {
1930 dev_dbg(dev, "unknown dimm command family\n");
1931 nfit_mem->family = -1;
1932 /* DSMs are optional, continue loading the driver... */
1933 return 0;
1934 }
1935
1936 /*
1937 * Function 0 is the command interrogation function, don't
1938 * export it to potential userspace use, and enable it to be
1939 * used as an error value in acpi_nfit_ctl().
1940 */
1941 dsm_mask &= ~1UL;
1942
1943 guid = to_nfit_uuid(nfit_mem->family);
1944 for_each_set_bit(i, &dsm_mask, BITS_PER_LONG)
1945 if (acpi_check_dsm(adev_dimm->handle, guid,
1946 nfit_dsm_revid(nfit_mem->family, i),
1947 1ULL << i))
1948 set_bit(i, &nfit_mem->dsm_mask);
1949
1950 /*
1951 * Prefer the NVDIMM_FAMILY_INTEL label read commands if present
1952 * due to their better semantics handling locked capacity.
1953 */
1954 label_mask = 1 << ND_CMD_GET_CONFIG_SIZE | 1 << ND_CMD_GET_CONFIG_DATA
1955 | 1 << ND_CMD_SET_CONFIG_DATA;
1956 if (family == NVDIMM_FAMILY_INTEL
1957 && (dsm_mask & label_mask) == label_mask)
1958 /* skip _LS{I,R,W} enabling */;
1959 else {
1960 if (acpi_nvdimm_has_method(adev_dimm, "_LSI")
1961 && acpi_nvdimm_has_method(adev_dimm, "_LSR")) {
1962 dev_dbg(dev, "%s: has _LSR\n", dev_name(&adev_dimm->dev));
1963 set_bit(NFIT_MEM_LSR, &nfit_mem->flags);
1964 }
1965
1966 if (test_bit(NFIT_MEM_LSR, &nfit_mem->flags)
1967 && acpi_nvdimm_has_method(adev_dimm, "_LSW")) {
1968 dev_dbg(dev, "%s: has _LSW\n", dev_name(&adev_dimm->dev));
1969 set_bit(NFIT_MEM_LSW, &nfit_mem->flags);
1970 }
1971
1972 /*
1973 * Quirk read-only label configurations to preserve
1974 * access to label-less namespaces by default.
1975 */
1976 if (!test_bit(NFIT_MEM_LSW, &nfit_mem->flags)
1977 && !force_labels) {
1978 dev_dbg(dev, "%s: No _LSW, disable labels\n",
1979 dev_name(&adev_dimm->dev));
1980 clear_bit(NFIT_MEM_LSR, &nfit_mem->flags);
1981 } else
1982 dev_dbg(dev, "%s: Force enable labels\n",
1983 dev_name(&adev_dimm->dev));
1984 }
1985
1986 populate_shutdown_status(nfit_mem);
1987
1988 return 0;
1989}
1990
1991static void shutdown_dimm_notify(void *data)
1992{
1993 struct acpi_nfit_desc *acpi_desc = data;
1994 struct nfit_mem *nfit_mem;
1995
1996 mutex_lock(&acpi_desc->init_mutex);
1997 /*
1998 * Clear out the nfit_mem->flags_attr and shut down dimm event
1999 * notifications.
2000 */
2001 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
2002 struct acpi_device *adev_dimm = nfit_mem->adev;
2003
2004 if (nfit_mem->flags_attr) {
2005 sysfs_put(nfit_mem->flags_attr);
2006 nfit_mem->flags_attr = NULL;
2007 }
2008 if (adev_dimm) {
2009 acpi_remove_notify_handler(adev_dimm->handle,
2010 ACPI_DEVICE_NOTIFY, acpi_nvdimm_notify);
2011 dev_set_drvdata(&adev_dimm->dev, NULL);
2012 }
2013 }
2014 mutex_unlock(&acpi_desc->init_mutex);
2015}
2016
2017static const struct nvdimm_security_ops *acpi_nfit_get_security_ops(int family)
2018{
2019 switch (family) {
2020 case NVDIMM_FAMILY_INTEL:
2021 return intel_security_ops;
2022 default:
2023 return NULL;
2024 }
2025}
2026
2027static const struct nvdimm_fw_ops *acpi_nfit_get_fw_ops(
2028 struct nfit_mem *nfit_mem)
2029{
2030 unsigned long mask;
2031 struct acpi_nfit_desc *acpi_desc = nfit_mem->acpi_desc;
2032 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2033
2034 if (!nd_desc->fw_ops)
2035 return NULL;
2036
2037 if (nfit_mem->family != NVDIMM_FAMILY_INTEL)
2038 return NULL;
2039
2040 mask = nfit_mem->dsm_mask & NVDIMM_INTEL_FW_ACTIVATE_CMDMASK;
2041 if (mask != NVDIMM_INTEL_FW_ACTIVATE_CMDMASK)
2042 return NULL;
2043
2044 return intel_fw_ops;
2045}
2046
2047static int acpi_nfit_register_dimms(struct acpi_nfit_desc *acpi_desc)
2048{
2049 struct nfit_mem *nfit_mem;
2050 int dimm_count = 0, rc;
2051 struct nvdimm *nvdimm;
2052
2053 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
2054 struct acpi_nfit_flush_address *flush;
2055 unsigned long flags = 0, cmd_mask;
2056 struct nfit_memdev *nfit_memdev;
2057 u32 device_handle;
2058 u16 mem_flags;
2059
2060 device_handle = __to_nfit_memdev(nfit_mem)->device_handle;
2061 nvdimm = acpi_nfit_dimm_by_handle(acpi_desc, device_handle);
2062 if (nvdimm) {
2063 dimm_count++;
2064 continue;
2065 }
2066
2067 if (nfit_mem->bdw && nfit_mem->memdev_pmem) {
2068 set_bit(NDD_ALIASING, &flags);
2069 set_bit(NDD_LABELING, &flags);
2070 }
2071
2072 /* collate flags across all memdevs for this dimm */
2073 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
2074 struct acpi_nfit_memory_map *dimm_memdev;
2075
2076 dimm_memdev = __to_nfit_memdev(nfit_mem);
2077 if (dimm_memdev->device_handle
2078 != nfit_memdev->memdev->device_handle)
2079 continue;
2080 dimm_memdev->flags |= nfit_memdev->memdev->flags;
2081 }
2082
2083 mem_flags = __to_nfit_memdev(nfit_mem)->flags;
2084 if (mem_flags & ACPI_NFIT_MEM_NOT_ARMED)
2085 set_bit(NDD_UNARMED, &flags);
2086
2087 rc = acpi_nfit_add_dimm(acpi_desc, nfit_mem, device_handle);
2088 if (rc)
2089 continue;
2090
2091 /*
2092 * TODO: provide translation for non-NVDIMM_FAMILY_INTEL
2093 * devices (i.e. from nd_cmd to acpi_dsm) to standardize the
2094 * userspace interface.
2095 */
2096 cmd_mask = 1UL << ND_CMD_CALL;
2097 if (nfit_mem->family == NVDIMM_FAMILY_INTEL) {
2098 /*
2099 * These commands have a 1:1 correspondence
2100 * between DSM payload and libnvdimm ioctl
2101 * payload format.
2102 */
2103 cmd_mask |= nfit_mem->dsm_mask & NVDIMM_STANDARD_CMDMASK;
2104 }
2105
2106 /* Quirk to ignore LOCAL for labels on HYPERV DIMMs */
2107 if (nfit_mem->family == NVDIMM_FAMILY_HYPERV)
2108 set_bit(NDD_NOBLK, &flags);
2109
2110 if (test_bit(NFIT_MEM_LSR, &nfit_mem->flags)) {
2111 set_bit(ND_CMD_GET_CONFIG_SIZE, &cmd_mask);
2112 set_bit(ND_CMD_GET_CONFIG_DATA, &cmd_mask);
2113 }
2114 if (test_bit(NFIT_MEM_LSW, &nfit_mem->flags))
2115 set_bit(ND_CMD_SET_CONFIG_DATA, &cmd_mask);
2116
2117 flush = nfit_mem->nfit_flush ? nfit_mem->nfit_flush->flush
2118 : NULL;
2119 nvdimm = __nvdimm_create(acpi_desc->nvdimm_bus, nfit_mem,
2120 acpi_nfit_dimm_attribute_groups,
2121 flags, cmd_mask, flush ? flush->hint_count : 0,
2122 nfit_mem->flush_wpq, &nfit_mem->id[0],
2123 acpi_nfit_get_security_ops(nfit_mem->family),
2124 acpi_nfit_get_fw_ops(nfit_mem));
2125 if (!nvdimm)
2126 return -ENOMEM;
2127
2128 nfit_mem->nvdimm = nvdimm;
2129 dimm_count++;
2130
2131 if ((mem_flags & ACPI_NFIT_MEM_FAILED_MASK) == 0)
2132 continue;
2133
2134 dev_err(acpi_desc->dev, "Error found in NVDIMM %s flags:%s%s%s%s%s\n",
2135 nvdimm_name(nvdimm),
2136 mem_flags & ACPI_NFIT_MEM_SAVE_FAILED ? " save_fail" : "",
2137 mem_flags & ACPI_NFIT_MEM_RESTORE_FAILED ? " restore_fail":"",
2138 mem_flags & ACPI_NFIT_MEM_FLUSH_FAILED ? " flush_fail" : "",
2139 mem_flags & ACPI_NFIT_MEM_NOT_ARMED ? " not_armed" : "",
2140 mem_flags & ACPI_NFIT_MEM_MAP_FAILED ? " map_fail" : "");
2141
2142 }
2143
2144 rc = nvdimm_bus_check_dimm_count(acpi_desc->nvdimm_bus, dimm_count);
2145 if (rc)
2146 return rc;
2147
2148 /*
2149 * Now that dimms are successfully registered, and async registration
2150 * is flushed, attempt to enable event notification.
2151 */
2152 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
2153 struct kernfs_node *nfit_kernfs;
2154
2155 nvdimm = nfit_mem->nvdimm;
2156 if (!nvdimm)
2157 continue;
2158
2159 nfit_kernfs = sysfs_get_dirent(nvdimm_kobj(nvdimm)->sd, "nfit");
2160 if (nfit_kernfs)
2161 nfit_mem->flags_attr = sysfs_get_dirent(nfit_kernfs,
2162 "flags");
2163 sysfs_put(nfit_kernfs);
2164 if (!nfit_mem->flags_attr)
2165 dev_warn(acpi_desc->dev, "%s: notifications disabled\n",
2166 nvdimm_name(nvdimm));
2167 }
2168
2169 return devm_add_action_or_reset(acpi_desc->dev, shutdown_dimm_notify,
2170 acpi_desc);
2171}
2172
2173/*
2174 * These constants are private because there are no kernel consumers of
2175 * these commands.
2176 */
2177enum nfit_aux_cmds {
2178 NFIT_CMD_TRANSLATE_SPA = 5,
2179 NFIT_CMD_ARS_INJECT_SET = 7,
2180 NFIT_CMD_ARS_INJECT_CLEAR = 8,
2181 NFIT_CMD_ARS_INJECT_GET = 9,
2182};
2183
2184static void acpi_nfit_init_dsms(struct acpi_nfit_desc *acpi_desc)
2185{
2186 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2187 const guid_t *guid = to_nfit_uuid(NFIT_DEV_BUS);
2188 unsigned long dsm_mask, *mask;
2189 struct acpi_device *adev;
2190 int i;
2191
2192 set_bit(ND_CMD_CALL, &nd_desc->cmd_mask);
2193 set_bit(NVDIMM_BUS_FAMILY_NFIT, &nd_desc->bus_family_mask);
2194
2195 /* enable nfit_test to inject bus command emulation */
2196 if (acpi_desc->bus_cmd_force_en) {
2197 nd_desc->cmd_mask = acpi_desc->bus_cmd_force_en;
2198 mask = &nd_desc->bus_family_mask;
2199 if (acpi_desc->family_dsm_mask[NVDIMM_BUS_FAMILY_INTEL]) {
2200 set_bit(NVDIMM_BUS_FAMILY_INTEL, mask);
2201 nd_desc->fw_ops = intel_bus_fw_ops;
2202 }
2203 }
2204
2205 adev = to_acpi_dev(acpi_desc);
2206 if (!adev)
2207 return;
2208
2209 for (i = ND_CMD_ARS_CAP; i <= ND_CMD_CLEAR_ERROR; i++)
2210 if (acpi_check_dsm(adev->handle, guid, 1, 1ULL << i))
2211 set_bit(i, &nd_desc->cmd_mask);
2212
2213 dsm_mask =
2214 (1 << ND_CMD_ARS_CAP) |
2215 (1 << ND_CMD_ARS_START) |
2216 (1 << ND_CMD_ARS_STATUS) |
2217 (1 << ND_CMD_CLEAR_ERROR) |
2218 (1 << NFIT_CMD_TRANSLATE_SPA) |
2219 (1 << NFIT_CMD_ARS_INJECT_SET) |
2220 (1 << NFIT_CMD_ARS_INJECT_CLEAR) |
2221 (1 << NFIT_CMD_ARS_INJECT_GET);
2222 for_each_set_bit(i, &dsm_mask, BITS_PER_LONG)
2223 if (acpi_check_dsm(adev->handle, guid, 1, 1ULL << i))
2224 set_bit(i, &acpi_desc->bus_dsm_mask);
2225
2226 /* Enumerate allowed NVDIMM_BUS_FAMILY_INTEL commands */
2227 dsm_mask = NVDIMM_BUS_INTEL_FW_ACTIVATE_CMDMASK;
2228 guid = to_nfit_bus_uuid(NVDIMM_BUS_FAMILY_INTEL);
2229 mask = &acpi_desc->family_dsm_mask[NVDIMM_BUS_FAMILY_INTEL];
2230 for_each_set_bit(i, &dsm_mask, BITS_PER_LONG)
2231 if (acpi_check_dsm(adev->handle, guid, 1, 1ULL << i))
2232 set_bit(i, mask);
2233
2234 if (*mask == dsm_mask) {
2235 set_bit(NVDIMM_BUS_FAMILY_INTEL, &nd_desc->bus_family_mask);
2236 nd_desc->fw_ops = intel_bus_fw_ops;
2237 }
2238}
2239
2240static ssize_t range_index_show(struct device *dev,
2241 struct device_attribute *attr, char *buf)
2242{
2243 struct nd_region *nd_region = to_nd_region(dev);
2244 struct nfit_spa *nfit_spa = nd_region_provider_data(nd_region);
2245
2246 return sprintf(buf, "%d\n", nfit_spa->spa->range_index);
2247}
2248static DEVICE_ATTR_RO(range_index);
2249
2250static struct attribute *acpi_nfit_region_attributes[] = {
2251 &dev_attr_range_index.attr,
2252 NULL,
2253};
2254
2255static const struct attribute_group acpi_nfit_region_attribute_group = {
2256 .name = "nfit",
2257 .attrs = acpi_nfit_region_attributes,
2258};
2259
2260static const struct attribute_group *acpi_nfit_region_attribute_groups[] = {
2261 &acpi_nfit_region_attribute_group,
2262 NULL,
2263};
2264
2265/* enough info to uniquely specify an interleave set */
2266struct nfit_set_info {
2267 struct nfit_set_info_map {
2268 u64 region_offset;
2269 u32 serial_number;
2270 u32 pad;
2271 } mapping[0];
2272};
2273
2274struct nfit_set_info2 {
2275 struct nfit_set_info_map2 {
2276 u64 region_offset;
2277 u32 serial_number;
2278 u16 vendor_id;
2279 u16 manufacturing_date;
2280 u8 manufacturing_location;
2281 u8 reserved[31];
2282 } mapping[0];
2283};
2284
2285static size_t sizeof_nfit_set_info(int num_mappings)
2286{
2287 return sizeof(struct nfit_set_info)
2288 + num_mappings * sizeof(struct nfit_set_info_map);
2289}
2290
2291static size_t sizeof_nfit_set_info2(int num_mappings)
2292{
2293 return sizeof(struct nfit_set_info2)
2294 + num_mappings * sizeof(struct nfit_set_info_map2);
2295}
2296
2297static int cmp_map_compat(const void *m0, const void *m1)
2298{
2299 const struct nfit_set_info_map *map0 = m0;
2300 const struct nfit_set_info_map *map1 = m1;
2301
2302 return memcmp(&map0->region_offset, &map1->region_offset,
2303 sizeof(u64));
2304}
2305
2306static int cmp_map(const void *m0, const void *m1)
2307{
2308 const struct nfit_set_info_map *map0 = m0;
2309 const struct nfit_set_info_map *map1 = m1;
2310
2311 if (map0->region_offset < map1->region_offset)
2312 return -1;
2313 else if (map0->region_offset > map1->region_offset)
2314 return 1;
2315 return 0;
2316}
2317
2318static int cmp_map2(const void *m0, const void *m1)
2319{
2320 const struct nfit_set_info_map2 *map0 = m0;
2321 const struct nfit_set_info_map2 *map1 = m1;
2322
2323 if (map0->region_offset < map1->region_offset)
2324 return -1;
2325 else if (map0->region_offset > map1->region_offset)
2326 return 1;
2327 return 0;
2328}
2329
2330/* Retrieve the nth entry referencing this spa */
2331static struct acpi_nfit_memory_map *memdev_from_spa(
2332 struct acpi_nfit_desc *acpi_desc, u16 range_index, int n)
2333{
2334 struct nfit_memdev *nfit_memdev;
2335
2336 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list)
2337 if (nfit_memdev->memdev->range_index == range_index)
2338 if (n-- == 0)
2339 return nfit_memdev->memdev;
2340 return NULL;
2341}
2342
2343static int acpi_nfit_init_interleave_set(struct acpi_nfit_desc *acpi_desc,
2344 struct nd_region_desc *ndr_desc,
2345 struct acpi_nfit_system_address *spa)
2346{
2347 struct device *dev = acpi_desc->dev;
2348 struct nd_interleave_set *nd_set;
2349 u16 nr = ndr_desc->num_mappings;
2350 struct nfit_set_info2 *info2;
2351 struct nfit_set_info *info;
2352 int i;
2353
2354 nd_set = devm_kzalloc(dev, sizeof(*nd_set), GFP_KERNEL);
2355 if (!nd_set)
2356 return -ENOMEM;
2357 import_guid(&nd_set->type_guid, spa->range_guid);
2358
2359 info = devm_kzalloc(dev, sizeof_nfit_set_info(nr), GFP_KERNEL);
2360 if (!info)
2361 return -ENOMEM;
2362
2363 info2 = devm_kzalloc(dev, sizeof_nfit_set_info2(nr), GFP_KERNEL);
2364 if (!info2)
2365 return -ENOMEM;
2366
2367 for (i = 0; i < nr; i++) {
2368 struct nd_mapping_desc *mapping = &ndr_desc->mapping[i];
2369 struct nfit_set_info_map *map = &info->mapping[i];
2370 struct nfit_set_info_map2 *map2 = &info2->mapping[i];
2371 struct nvdimm *nvdimm = mapping->nvdimm;
2372 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
2373 struct acpi_nfit_memory_map *memdev = memdev_from_spa(acpi_desc,
2374 spa->range_index, i);
2375 struct acpi_nfit_control_region *dcr = nfit_mem->dcr;
2376
2377 if (!memdev || !nfit_mem->dcr) {
2378 dev_err(dev, "%s: failed to find DCR\n", __func__);
2379 return -ENODEV;
2380 }
2381
2382 map->region_offset = memdev->region_offset;
2383 map->serial_number = dcr->serial_number;
2384
2385 map2->region_offset = memdev->region_offset;
2386 map2->serial_number = dcr->serial_number;
2387 map2->vendor_id = dcr->vendor_id;
2388 map2->manufacturing_date = dcr->manufacturing_date;
2389 map2->manufacturing_location = dcr->manufacturing_location;
2390 }
2391
2392 /* v1.1 namespaces */
2393 sort(&info->mapping[0], nr, sizeof(struct nfit_set_info_map),
2394 cmp_map, NULL);
2395 nd_set->cookie1 = nd_fletcher64(info, sizeof_nfit_set_info(nr), 0);
2396
2397 /* v1.2 namespaces */
2398 sort(&info2->mapping[0], nr, sizeof(struct nfit_set_info_map2),
2399 cmp_map2, NULL);
2400 nd_set->cookie2 = nd_fletcher64(info2, sizeof_nfit_set_info2(nr), 0);
2401
2402 /* support v1.1 namespaces created with the wrong sort order */
2403 sort(&info->mapping[0], nr, sizeof(struct nfit_set_info_map),
2404 cmp_map_compat, NULL);
2405 nd_set->altcookie = nd_fletcher64(info, sizeof_nfit_set_info(nr), 0);
2406
2407 /* record the result of the sort for the mapping position */
2408 for (i = 0; i < nr; i++) {
2409 struct nfit_set_info_map2 *map2 = &info2->mapping[i];
2410 int j;
2411
2412 for (j = 0; j < nr; j++) {
2413 struct nd_mapping_desc *mapping = &ndr_desc->mapping[j];
2414 struct nvdimm *nvdimm = mapping->nvdimm;
2415 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
2416 struct acpi_nfit_control_region *dcr = nfit_mem->dcr;
2417
2418 if (map2->serial_number == dcr->serial_number &&
2419 map2->vendor_id == dcr->vendor_id &&
2420 map2->manufacturing_date == dcr->manufacturing_date &&
2421 map2->manufacturing_location
2422 == dcr->manufacturing_location) {
2423 mapping->position = i;
2424 break;
2425 }
2426 }
2427 }
2428
2429 ndr_desc->nd_set = nd_set;
2430 devm_kfree(dev, info);
2431 devm_kfree(dev, info2);
2432
2433 return 0;
2434}
2435
2436static u64 to_interleave_offset(u64 offset, struct nfit_blk_mmio *mmio)
2437{
2438 struct acpi_nfit_interleave *idt = mmio->idt;
2439 u32 sub_line_offset, line_index, line_offset;
2440 u64 line_no, table_skip_count, table_offset;
2441
2442 line_no = div_u64_rem(offset, mmio->line_size, &sub_line_offset);
2443 table_skip_count = div_u64_rem(line_no, mmio->num_lines, &line_index);
2444 line_offset = idt->line_offset[line_index]
2445 * mmio->line_size;
2446 table_offset = table_skip_count * mmio->table_size;
2447
2448 return mmio->base_offset + line_offset + table_offset + sub_line_offset;
2449}
2450
2451static u32 read_blk_stat(struct nfit_blk *nfit_blk, unsigned int bw)
2452{
2453 struct nfit_blk_mmio *mmio = &nfit_blk->mmio[DCR];
2454 u64 offset = nfit_blk->stat_offset + mmio->size * bw;
2455 const u32 STATUS_MASK = 0x80000037;
2456
2457 if (mmio->num_lines)
2458 offset = to_interleave_offset(offset, mmio);
2459
2460 return readl(mmio->addr.base + offset) & STATUS_MASK;
2461}
2462
2463static void write_blk_ctl(struct nfit_blk *nfit_blk, unsigned int bw,
2464 resource_size_t dpa, unsigned int len, unsigned int write)
2465{
2466 u64 cmd, offset;
2467 struct nfit_blk_mmio *mmio = &nfit_blk->mmio[DCR];
2468
2469 enum {
2470 BCW_OFFSET_MASK = (1ULL << 48)-1,
2471 BCW_LEN_SHIFT = 48,
2472 BCW_LEN_MASK = (1ULL << 8) - 1,
2473 BCW_CMD_SHIFT = 56,
2474 };
2475
2476 cmd = (dpa >> L1_CACHE_SHIFT) & BCW_OFFSET_MASK;
2477 len = len >> L1_CACHE_SHIFT;
2478 cmd |= ((u64) len & BCW_LEN_MASK) << BCW_LEN_SHIFT;
2479 cmd |= ((u64) write) << BCW_CMD_SHIFT;
2480
2481 offset = nfit_blk->cmd_offset + mmio->size * bw;
2482 if (mmio->num_lines)
2483 offset = to_interleave_offset(offset, mmio);
2484
2485 writeq(cmd, mmio->addr.base + offset);
2486 nvdimm_flush(nfit_blk->nd_region, NULL);
2487
2488 if (nfit_blk->dimm_flags & NFIT_BLK_DCR_LATCH)
2489 readq(mmio->addr.base + offset);
2490}
2491
2492static int acpi_nfit_blk_single_io(struct nfit_blk *nfit_blk,
2493 resource_size_t dpa, void *iobuf, size_t len, int rw,
2494 unsigned int lane)
2495{
2496 struct nfit_blk_mmio *mmio = &nfit_blk->mmio[BDW];
2497 unsigned int copied = 0;
2498 u64 base_offset;
2499 int rc;
2500
2501 base_offset = nfit_blk->bdw_offset + dpa % L1_CACHE_BYTES
2502 + lane * mmio->size;
2503 write_blk_ctl(nfit_blk, lane, dpa, len, rw);
2504 while (len) {
2505 unsigned int c;
2506 u64 offset;
2507
2508 if (mmio->num_lines) {
2509 u32 line_offset;
2510
2511 offset = to_interleave_offset(base_offset + copied,
2512 mmio);
2513 div_u64_rem(offset, mmio->line_size, &line_offset);
2514 c = min_t(size_t, len, mmio->line_size - line_offset);
2515 } else {
2516 offset = base_offset + nfit_blk->bdw_offset;
2517 c = len;
2518 }
2519
2520 if (rw)
2521 memcpy_flushcache(mmio->addr.aperture + offset, iobuf + copied, c);
2522 else {
2523 if (nfit_blk->dimm_flags & NFIT_BLK_READ_FLUSH)
2524 arch_invalidate_pmem((void __force *)
2525 mmio->addr.aperture + offset, c);
2526
2527 memcpy(iobuf + copied, mmio->addr.aperture + offset, c);
2528 }
2529
2530 copied += c;
2531 len -= c;
2532 }
2533
2534 if (rw)
2535 nvdimm_flush(nfit_blk->nd_region, NULL);
2536
2537 rc = read_blk_stat(nfit_blk, lane) ? -EIO : 0;
2538 return rc;
2539}
2540
2541static int acpi_nfit_blk_region_do_io(struct nd_blk_region *ndbr,
2542 resource_size_t dpa, void *iobuf, u64 len, int rw)
2543{
2544 struct nfit_blk *nfit_blk = nd_blk_region_provider_data(ndbr);
2545 struct nfit_blk_mmio *mmio = &nfit_blk->mmio[BDW];
2546 struct nd_region *nd_region = nfit_blk->nd_region;
2547 unsigned int lane, copied = 0;
2548 int rc = 0;
2549
2550 lane = nd_region_acquire_lane(nd_region);
2551 while (len) {
2552 u64 c = min(len, mmio->size);
2553
2554 rc = acpi_nfit_blk_single_io(nfit_blk, dpa + copied,
2555 iobuf + copied, c, rw, lane);
2556 if (rc)
2557 break;
2558
2559 copied += c;
2560 len -= c;
2561 }
2562 nd_region_release_lane(nd_region, lane);
2563
2564 return rc;
2565}
2566
2567static int nfit_blk_init_interleave(struct nfit_blk_mmio *mmio,
2568 struct acpi_nfit_interleave *idt, u16 interleave_ways)
2569{
2570 if (idt) {
2571 mmio->num_lines = idt->line_count;
2572 mmio->line_size = idt->line_size;
2573 if (interleave_ways == 0)
2574 return -ENXIO;
2575 mmio->table_size = mmio->num_lines * interleave_ways
2576 * mmio->line_size;
2577 }
2578
2579 return 0;
2580}
2581
2582static int acpi_nfit_blk_get_flags(struct nvdimm_bus_descriptor *nd_desc,
2583 struct nvdimm *nvdimm, struct nfit_blk *nfit_blk)
2584{
2585 struct nd_cmd_dimm_flags flags;
2586 int rc;
2587
2588 memset(&flags, 0, sizeof(flags));
2589 rc = nd_desc->ndctl(nd_desc, nvdimm, ND_CMD_DIMM_FLAGS, &flags,
2590 sizeof(flags), NULL);
2591
2592 if (rc >= 0 && flags.status == 0)
2593 nfit_blk->dimm_flags = flags.flags;
2594 else if (rc == -ENOTTY) {
2595 /* fall back to a conservative default */
2596 nfit_blk->dimm_flags = NFIT_BLK_DCR_LATCH | NFIT_BLK_READ_FLUSH;
2597 rc = 0;
2598 } else
2599 rc = -ENXIO;
2600
2601 return rc;
2602}
2603
2604static int acpi_nfit_blk_region_enable(struct nvdimm_bus *nvdimm_bus,
2605 struct device *dev)
2606{
2607 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
2608 struct nd_blk_region *ndbr = to_nd_blk_region(dev);
2609 struct nfit_blk_mmio *mmio;
2610 struct nfit_blk *nfit_blk;
2611 struct nfit_mem *nfit_mem;
2612 struct nvdimm *nvdimm;
2613 int rc;
2614
2615 nvdimm = nd_blk_region_to_dimm(ndbr);
2616 nfit_mem = nvdimm_provider_data(nvdimm);
2617 if (!nfit_mem || !nfit_mem->dcr || !nfit_mem->bdw) {
2618 dev_dbg(dev, "missing%s%s%s\n",
2619 nfit_mem ? "" : " nfit_mem",
2620 (nfit_mem && nfit_mem->dcr) ? "" : " dcr",
2621 (nfit_mem && nfit_mem->bdw) ? "" : " bdw");
2622 return -ENXIO;
2623 }
2624
2625 nfit_blk = devm_kzalloc(dev, sizeof(*nfit_blk), GFP_KERNEL);
2626 if (!nfit_blk)
2627 return -ENOMEM;
2628 nd_blk_region_set_provider_data(ndbr, nfit_blk);
2629 nfit_blk->nd_region = to_nd_region(dev);
2630
2631 /* map block aperture memory */
2632 nfit_blk->bdw_offset = nfit_mem->bdw->offset;
2633 mmio = &nfit_blk->mmio[BDW];
2634 mmio->addr.base = devm_nvdimm_memremap(dev, nfit_mem->spa_bdw->address,
2635 nfit_mem->spa_bdw->length, nd_blk_memremap_flags(ndbr));
2636 if (!mmio->addr.base) {
2637 dev_dbg(dev, "%s failed to map bdw\n",
2638 nvdimm_name(nvdimm));
2639 return -ENOMEM;
2640 }
2641 mmio->size = nfit_mem->bdw->size;
2642 mmio->base_offset = nfit_mem->memdev_bdw->region_offset;
2643 mmio->idt = nfit_mem->idt_bdw;
2644 mmio->spa = nfit_mem->spa_bdw;
2645 rc = nfit_blk_init_interleave(mmio, nfit_mem->idt_bdw,
2646 nfit_mem->memdev_bdw->interleave_ways);
2647 if (rc) {
2648 dev_dbg(dev, "%s failed to init bdw interleave\n",
2649 nvdimm_name(nvdimm));
2650 return rc;
2651 }
2652
2653 /* map block control memory */
2654 nfit_blk->cmd_offset = nfit_mem->dcr->command_offset;
2655 nfit_blk->stat_offset = nfit_mem->dcr->status_offset;
2656 mmio = &nfit_blk->mmio[DCR];
2657 mmio->addr.base = devm_nvdimm_ioremap(dev, nfit_mem->spa_dcr->address,
2658 nfit_mem->spa_dcr->length);
2659 if (!mmio->addr.base) {
2660 dev_dbg(dev, "%s failed to map dcr\n",
2661 nvdimm_name(nvdimm));
2662 return -ENOMEM;
2663 }
2664 mmio->size = nfit_mem->dcr->window_size;
2665 mmio->base_offset = nfit_mem->memdev_dcr->region_offset;
2666 mmio->idt = nfit_mem->idt_dcr;
2667 mmio->spa = nfit_mem->spa_dcr;
2668 rc = nfit_blk_init_interleave(mmio, nfit_mem->idt_dcr,
2669 nfit_mem->memdev_dcr->interleave_ways);
2670 if (rc) {
2671 dev_dbg(dev, "%s failed to init dcr interleave\n",
2672 nvdimm_name(nvdimm));
2673 return rc;
2674 }
2675
2676 rc = acpi_nfit_blk_get_flags(nd_desc, nvdimm, nfit_blk);
2677 if (rc < 0) {
2678 dev_dbg(dev, "%s failed get DIMM flags\n",
2679 nvdimm_name(nvdimm));
2680 return rc;
2681 }
2682
2683 if (nvdimm_has_flush(nfit_blk->nd_region) < 0)
2684 dev_warn(dev, "unable to guarantee persistence of writes\n");
2685
2686 if (mmio->line_size == 0)
2687 return 0;
2688
2689 if ((u32) nfit_blk->cmd_offset % mmio->line_size
2690 + 8 > mmio->line_size) {
2691 dev_dbg(dev, "cmd_offset crosses interleave boundary\n");
2692 return -ENXIO;
2693 } else if ((u32) nfit_blk->stat_offset % mmio->line_size
2694 + 8 > mmio->line_size) {
2695 dev_dbg(dev, "stat_offset crosses interleave boundary\n");
2696 return -ENXIO;
2697 }
2698
2699 return 0;
2700}
2701
2702static int ars_get_cap(struct acpi_nfit_desc *acpi_desc,
2703 struct nd_cmd_ars_cap *cmd, struct nfit_spa *nfit_spa)
2704{
2705 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2706 struct acpi_nfit_system_address *spa = nfit_spa->spa;
2707 int cmd_rc, rc;
2708
2709 cmd->address = spa->address;
2710 cmd->length = spa->length;
2711 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_CAP, cmd,
2712 sizeof(*cmd), &cmd_rc);
2713 if (rc < 0)
2714 return rc;
2715 return cmd_rc;
2716}
2717
2718static int ars_start(struct acpi_nfit_desc *acpi_desc,
2719 struct nfit_spa *nfit_spa, enum nfit_ars_state req_type)
2720{
2721 int rc;
2722 int cmd_rc;
2723 struct nd_cmd_ars_start ars_start;
2724 struct acpi_nfit_system_address *spa = nfit_spa->spa;
2725 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2726
2727 memset(&ars_start, 0, sizeof(ars_start));
2728 ars_start.address = spa->address;
2729 ars_start.length = spa->length;
2730 if (req_type == ARS_REQ_SHORT)
2731 ars_start.flags = ND_ARS_RETURN_PREV_DATA;
2732 if (nfit_spa_type(spa) == NFIT_SPA_PM)
2733 ars_start.type = ND_ARS_PERSISTENT;
2734 else if (nfit_spa_type(spa) == NFIT_SPA_VOLATILE)
2735 ars_start.type = ND_ARS_VOLATILE;
2736 else
2737 return -ENOTTY;
2738
2739 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_START, &ars_start,
2740 sizeof(ars_start), &cmd_rc);
2741
2742 if (rc < 0)
2743 return rc;
2744 if (cmd_rc < 0)
2745 return cmd_rc;
2746 set_bit(ARS_VALID, &acpi_desc->scrub_flags);
2747 return 0;
2748}
2749
2750static int ars_continue(struct acpi_nfit_desc *acpi_desc)
2751{
2752 int rc, cmd_rc;
2753 struct nd_cmd_ars_start ars_start;
2754 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2755 struct nd_cmd_ars_status *ars_status = acpi_desc->ars_status;
2756
2757 ars_start = (struct nd_cmd_ars_start) {
2758 .address = ars_status->restart_address,
2759 .length = ars_status->restart_length,
2760 .type = ars_status->type,
2761 };
2762 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_START, &ars_start,
2763 sizeof(ars_start), &cmd_rc);
2764 if (rc < 0)
2765 return rc;
2766 return cmd_rc;
2767}
2768
2769static int ars_get_status(struct acpi_nfit_desc *acpi_desc)
2770{
2771 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2772 struct nd_cmd_ars_status *ars_status = acpi_desc->ars_status;
2773 int rc, cmd_rc;
2774
2775 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_STATUS, ars_status,
2776 acpi_desc->max_ars, &cmd_rc);
2777 if (rc < 0)
2778 return rc;
2779 return cmd_rc;
2780}
2781
2782static void ars_complete(struct acpi_nfit_desc *acpi_desc,
2783 struct nfit_spa *nfit_spa)
2784{
2785 struct nd_cmd_ars_status *ars_status = acpi_desc->ars_status;
2786 struct acpi_nfit_system_address *spa = nfit_spa->spa;
2787 struct nd_region *nd_region = nfit_spa->nd_region;
2788 struct device *dev;
2789
2790 lockdep_assert_held(&acpi_desc->init_mutex);
2791 /*
2792 * Only advance the ARS state for ARS runs initiated by the
2793 * kernel, ignore ARS results from BIOS initiated runs for scrub
2794 * completion tracking.
2795 */
2796 if (acpi_desc->scrub_spa != nfit_spa)
2797 return;
2798
2799 if ((ars_status->address >= spa->address && ars_status->address
2800 < spa->address + spa->length)
2801 || (ars_status->address < spa->address)) {
2802 /*
2803 * Assume that if a scrub starts at an offset from the
2804 * start of nfit_spa that we are in the continuation
2805 * case.
2806 *
2807 * Otherwise, if the scrub covers the spa range, mark
2808 * any pending request complete.
2809 */
2810 if (ars_status->address + ars_status->length
2811 >= spa->address + spa->length)
2812 /* complete */;
2813 else
2814 return;
2815 } else
2816 return;
2817
2818 acpi_desc->scrub_spa = NULL;
2819 if (nd_region) {
2820 dev = nd_region_dev(nd_region);
2821 nvdimm_region_notify(nd_region, NVDIMM_REVALIDATE_POISON);
2822 } else
2823 dev = acpi_desc->dev;
2824 dev_dbg(dev, "ARS: range %d complete\n", spa->range_index);
2825}
2826
2827static int ars_status_process_records(struct acpi_nfit_desc *acpi_desc)
2828{
2829 struct nvdimm_bus *nvdimm_bus = acpi_desc->nvdimm_bus;
2830 struct nd_cmd_ars_status *ars_status = acpi_desc->ars_status;
2831 int rc;
2832 u32 i;
2833
2834 /*
2835 * First record starts at 44 byte offset from the start of the
2836 * payload.
2837 */
2838 if (ars_status->out_length < 44)
2839 return 0;
2840
2841 /*
2842 * Ignore potentially stale results that are only refreshed
2843 * after a start-ARS event.
2844 */
2845 if (!test_and_clear_bit(ARS_VALID, &acpi_desc->scrub_flags)) {
2846 dev_dbg(acpi_desc->dev, "skip %d stale records\n",
2847 ars_status->num_records);
2848 return 0;
2849 }
2850
2851 for (i = 0; i < ars_status->num_records; i++) {
2852 /* only process full records */
2853 if (ars_status->out_length
2854 < 44 + sizeof(struct nd_ars_record) * (i + 1))
2855 break;
2856 rc = nvdimm_bus_add_badrange(nvdimm_bus,
2857 ars_status->records[i].err_address,
2858 ars_status->records[i].length);
2859 if (rc)
2860 return rc;
2861 }
2862 if (i < ars_status->num_records)
2863 dev_warn(acpi_desc->dev, "detected truncated ars results\n");
2864
2865 return 0;
2866}
2867
2868static void acpi_nfit_remove_resource(void *data)
2869{
2870 struct resource *res = data;
2871
2872 remove_resource(res);
2873}
2874
2875static int acpi_nfit_insert_resource(struct acpi_nfit_desc *acpi_desc,
2876 struct nd_region_desc *ndr_desc)
2877{
2878 struct resource *res, *nd_res = ndr_desc->res;
2879 int is_pmem, ret;
2880
2881 /* No operation if the region is already registered as PMEM */
2882 is_pmem = region_intersects(nd_res->start, resource_size(nd_res),
2883 IORESOURCE_MEM, IORES_DESC_PERSISTENT_MEMORY);
2884 if (is_pmem == REGION_INTERSECTS)
2885 return 0;
2886
2887 res = devm_kzalloc(acpi_desc->dev, sizeof(*res), GFP_KERNEL);
2888 if (!res)
2889 return -ENOMEM;
2890
2891 res->name = "Persistent Memory";
2892 res->start = nd_res->start;
2893 res->end = nd_res->end;
2894 res->flags = IORESOURCE_MEM;
2895 res->desc = IORES_DESC_PERSISTENT_MEMORY;
2896
2897 ret = insert_resource(&iomem_resource, res);
2898 if (ret)
2899 return ret;
2900
2901 ret = devm_add_action_or_reset(acpi_desc->dev,
2902 acpi_nfit_remove_resource,
2903 res);
2904 if (ret)
2905 return ret;
2906
2907 return 0;
2908}
2909
2910static int acpi_nfit_init_mapping(struct acpi_nfit_desc *acpi_desc,
2911 struct nd_mapping_desc *mapping, struct nd_region_desc *ndr_desc,
2912 struct acpi_nfit_memory_map *memdev,
2913 struct nfit_spa *nfit_spa)
2914{
2915 struct nvdimm *nvdimm = acpi_nfit_dimm_by_handle(acpi_desc,
2916 memdev->device_handle);
2917 struct acpi_nfit_system_address *spa = nfit_spa->spa;
2918 struct nd_blk_region_desc *ndbr_desc;
2919 struct nfit_mem *nfit_mem;
2920 int rc;
2921
2922 if (!nvdimm) {
2923 dev_err(acpi_desc->dev, "spa%d dimm: %#x not found\n",
2924 spa->range_index, memdev->device_handle);
2925 return -ENODEV;
2926 }
2927
2928 mapping->nvdimm = nvdimm;
2929 switch (nfit_spa_type(spa)) {
2930 case NFIT_SPA_PM:
2931 case NFIT_SPA_VOLATILE:
2932 mapping->start = memdev->address;
2933 mapping->size = memdev->region_size;
2934 break;
2935 case NFIT_SPA_DCR:
2936 nfit_mem = nvdimm_provider_data(nvdimm);
2937 if (!nfit_mem || !nfit_mem->bdw) {
2938 dev_dbg(acpi_desc->dev, "spa%d %s missing bdw\n",
2939 spa->range_index, nvdimm_name(nvdimm));
2940 break;
2941 }
2942
2943 mapping->size = nfit_mem->bdw->capacity;
2944 mapping->start = nfit_mem->bdw->start_address;
2945 ndr_desc->num_lanes = nfit_mem->bdw->windows;
2946 ndr_desc->mapping = mapping;
2947 ndr_desc->num_mappings = 1;
2948 ndbr_desc = to_blk_region_desc(ndr_desc);
2949 ndbr_desc->enable = acpi_nfit_blk_region_enable;
2950 ndbr_desc->do_io = acpi_desc->blk_do_io;
2951 rc = acpi_nfit_init_interleave_set(acpi_desc, ndr_desc, spa);
2952 if (rc)
2953 return rc;
2954 nfit_spa->nd_region = nvdimm_blk_region_create(acpi_desc->nvdimm_bus,
2955 ndr_desc);
2956 if (!nfit_spa->nd_region)
2957 return -ENOMEM;
2958 break;
2959 }
2960
2961 return 0;
2962}
2963
2964static bool nfit_spa_is_virtual(struct acpi_nfit_system_address *spa)
2965{
2966 return (nfit_spa_type(spa) == NFIT_SPA_VDISK ||
2967 nfit_spa_type(spa) == NFIT_SPA_VCD ||
2968 nfit_spa_type(spa) == NFIT_SPA_PDISK ||
2969 nfit_spa_type(spa) == NFIT_SPA_PCD);
2970}
2971
2972static bool nfit_spa_is_volatile(struct acpi_nfit_system_address *spa)
2973{
2974 return (nfit_spa_type(spa) == NFIT_SPA_VDISK ||
2975 nfit_spa_type(spa) == NFIT_SPA_VCD ||
2976 nfit_spa_type(spa) == NFIT_SPA_VOLATILE);
2977}
2978
2979static int acpi_nfit_register_region(struct acpi_nfit_desc *acpi_desc,
2980 struct nfit_spa *nfit_spa)
2981{
2982 static struct nd_mapping_desc mappings[ND_MAX_MAPPINGS];
2983 struct acpi_nfit_system_address *spa = nfit_spa->spa;
2984 struct nd_blk_region_desc ndbr_desc;
2985 struct nd_region_desc *ndr_desc;
2986 struct nfit_memdev *nfit_memdev;
2987 struct nvdimm_bus *nvdimm_bus;
2988 struct resource res;
2989 int count = 0, rc;
2990
2991 if (nfit_spa->nd_region)
2992 return 0;
2993
2994 if (spa->range_index == 0 && !nfit_spa_is_virtual(spa)) {
2995 dev_dbg(acpi_desc->dev, "detected invalid spa index\n");
2996 return 0;
2997 }
2998
2999 memset(&res, 0, sizeof(res));
3000 memset(&mappings, 0, sizeof(mappings));
3001 memset(&ndbr_desc, 0, sizeof(ndbr_desc));
3002 res.start = spa->address;
3003 res.end = res.start + spa->length - 1;
3004 ndr_desc = &ndbr_desc.ndr_desc;
3005 ndr_desc->res = &res;
3006 ndr_desc->provider_data = nfit_spa;
3007 ndr_desc->attr_groups = acpi_nfit_region_attribute_groups;
3008 if (spa->flags & ACPI_NFIT_PROXIMITY_VALID) {
3009 ndr_desc->numa_node = acpi_map_pxm_to_online_node(
3010 spa->proximity_domain);
3011 ndr_desc->target_node = acpi_map_pxm_to_node(
3012 spa->proximity_domain);
3013 } else {
3014 ndr_desc->numa_node = NUMA_NO_NODE;
3015 ndr_desc->target_node = NUMA_NO_NODE;
3016 }
3017
3018 /*
3019 * Persistence domain bits are hierarchical, if
3020 * ACPI_NFIT_CAPABILITY_CACHE_FLUSH is set then
3021 * ACPI_NFIT_CAPABILITY_MEM_FLUSH is implied.
3022 */
3023 if (acpi_desc->platform_cap & ACPI_NFIT_CAPABILITY_CACHE_FLUSH)
3024 set_bit(ND_REGION_PERSIST_CACHE, &ndr_desc->flags);
3025 else if (acpi_desc->platform_cap & ACPI_NFIT_CAPABILITY_MEM_FLUSH)
3026 set_bit(ND_REGION_PERSIST_MEMCTRL, &ndr_desc->flags);
3027
3028 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
3029 struct acpi_nfit_memory_map *memdev = nfit_memdev->memdev;
3030 struct nd_mapping_desc *mapping;
3031
3032 if (memdev->range_index != spa->range_index)
3033 continue;
3034 if (count >= ND_MAX_MAPPINGS) {
3035 dev_err(acpi_desc->dev, "spa%d exceeds max mappings %d\n",
3036 spa->range_index, ND_MAX_MAPPINGS);
3037 return -ENXIO;
3038 }
3039 mapping = &mappings[count++];
3040 rc = acpi_nfit_init_mapping(acpi_desc, mapping, ndr_desc,
3041 memdev, nfit_spa);
3042 if (rc)
3043 goto out;
3044 }
3045
3046 ndr_desc->mapping = mappings;
3047 ndr_desc->num_mappings = count;
3048 rc = acpi_nfit_init_interleave_set(acpi_desc, ndr_desc, spa);
3049 if (rc)
3050 goto out;
3051
3052 nvdimm_bus = acpi_desc->nvdimm_bus;
3053 if (nfit_spa_type(spa) == NFIT_SPA_PM) {
3054 rc = acpi_nfit_insert_resource(acpi_desc, ndr_desc);
3055 if (rc) {
3056 dev_warn(acpi_desc->dev,
3057 "failed to insert pmem resource to iomem: %d\n",
3058 rc);
3059 goto out;
3060 }
3061
3062 nfit_spa->nd_region = nvdimm_pmem_region_create(nvdimm_bus,
3063 ndr_desc);
3064 if (!nfit_spa->nd_region)
3065 rc = -ENOMEM;
3066 } else if (nfit_spa_is_volatile(spa)) {
3067 nfit_spa->nd_region = nvdimm_volatile_region_create(nvdimm_bus,
3068 ndr_desc);
3069 if (!nfit_spa->nd_region)
3070 rc = -ENOMEM;
3071 } else if (nfit_spa_is_virtual(spa)) {
3072 nfit_spa->nd_region = nvdimm_pmem_region_create(nvdimm_bus,
3073 ndr_desc);
3074 if (!nfit_spa->nd_region)
3075 rc = -ENOMEM;
3076 }
3077
3078 out:
3079 if (rc)
3080 dev_err(acpi_desc->dev, "failed to register spa range %d\n",
3081 nfit_spa->spa->range_index);
3082 return rc;
3083}
3084
3085static int ars_status_alloc(struct acpi_nfit_desc *acpi_desc)
3086{
3087 struct device *dev = acpi_desc->dev;
3088 struct nd_cmd_ars_status *ars_status;
3089
3090 if (acpi_desc->ars_status) {
3091 memset(acpi_desc->ars_status, 0, acpi_desc->max_ars);
3092 return 0;
3093 }
3094
3095 ars_status = devm_kzalloc(dev, acpi_desc->max_ars, GFP_KERNEL);
3096 if (!ars_status)
3097 return -ENOMEM;
3098 acpi_desc->ars_status = ars_status;
3099 return 0;
3100}
3101
3102static int acpi_nfit_query_poison(struct acpi_nfit_desc *acpi_desc)
3103{
3104 int rc;
3105
3106 if (ars_status_alloc(acpi_desc))
3107 return -ENOMEM;
3108
3109 rc = ars_get_status(acpi_desc);
3110
3111 if (rc < 0 && rc != -ENOSPC)
3112 return rc;
3113
3114 if (ars_status_process_records(acpi_desc))
3115 dev_err(acpi_desc->dev, "Failed to process ARS records\n");
3116
3117 return rc;
3118}
3119
3120static int ars_register(struct acpi_nfit_desc *acpi_desc,
3121 struct nfit_spa *nfit_spa)
3122{
3123 int rc;
3124
3125 if (test_bit(ARS_FAILED, &nfit_spa->ars_state))
3126 return acpi_nfit_register_region(acpi_desc, nfit_spa);
3127
3128 set_bit(ARS_REQ_SHORT, &nfit_spa->ars_state);
3129 if (!no_init_ars)
3130 set_bit(ARS_REQ_LONG, &nfit_spa->ars_state);
3131
3132 switch (acpi_nfit_query_poison(acpi_desc)) {
3133 case 0:
3134 case -ENOSPC:
3135 case -EAGAIN:
3136 rc = ars_start(acpi_desc, nfit_spa, ARS_REQ_SHORT);
3137 /* shouldn't happen, try again later */
3138 if (rc == -EBUSY)
3139 break;
3140 if (rc) {
3141 set_bit(ARS_FAILED, &nfit_spa->ars_state);
3142 break;
3143 }
3144 clear_bit(ARS_REQ_SHORT, &nfit_spa->ars_state);
3145 rc = acpi_nfit_query_poison(acpi_desc);
3146 if (rc)
3147 break;
3148 acpi_desc->scrub_spa = nfit_spa;
3149 ars_complete(acpi_desc, nfit_spa);
3150 /*
3151 * If ars_complete() says we didn't complete the
3152 * short scrub, we'll try again with a long
3153 * request.
3154 */
3155 acpi_desc->scrub_spa = NULL;
3156 break;
3157 case -EBUSY:
3158 case -ENOMEM:
3159 /*
3160 * BIOS was using ARS, wait for it to complete (or
3161 * resources to become available) and then perform our
3162 * own scrubs.
3163 */
3164 break;
3165 default:
3166 set_bit(ARS_FAILED, &nfit_spa->ars_state);
3167 break;
3168 }
3169
3170 return acpi_nfit_register_region(acpi_desc, nfit_spa);
3171}
3172
3173static void ars_complete_all(struct acpi_nfit_desc *acpi_desc)
3174{
3175 struct nfit_spa *nfit_spa;
3176
3177 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
3178 if (test_bit(ARS_FAILED, &nfit_spa->ars_state))
3179 continue;
3180 ars_complete(acpi_desc, nfit_spa);
3181 }
3182}
3183
3184static unsigned int __acpi_nfit_scrub(struct acpi_nfit_desc *acpi_desc,
3185 int query_rc)
3186{
3187 unsigned int tmo = acpi_desc->scrub_tmo;
3188 struct device *dev = acpi_desc->dev;
3189 struct nfit_spa *nfit_spa;
3190
3191 lockdep_assert_held(&acpi_desc->init_mutex);
3192
3193 if (test_bit(ARS_CANCEL, &acpi_desc->scrub_flags))
3194 return 0;
3195
3196 if (query_rc == -EBUSY) {
3197 dev_dbg(dev, "ARS: ARS busy\n");
3198 return min(30U * 60U, tmo * 2);
3199 }
3200 if (query_rc == -ENOSPC) {
3201 dev_dbg(dev, "ARS: ARS continue\n");
3202 ars_continue(acpi_desc);
3203 return 1;
3204 }
3205 if (query_rc && query_rc != -EAGAIN) {
3206 unsigned long long addr, end;
3207
3208 addr = acpi_desc->ars_status->address;
3209 end = addr + acpi_desc->ars_status->length;
3210 dev_dbg(dev, "ARS: %llx-%llx failed (%d)\n", addr, end,
3211 query_rc);
3212 }
3213
3214 ars_complete_all(acpi_desc);
3215 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
3216 enum nfit_ars_state req_type;
3217 int rc;
3218
3219 if (test_bit(ARS_FAILED, &nfit_spa->ars_state))
3220 continue;
3221
3222 /* prefer short ARS requests first */
3223 if (test_bit(ARS_REQ_SHORT, &nfit_spa->ars_state))
3224 req_type = ARS_REQ_SHORT;
3225 else if (test_bit(ARS_REQ_LONG, &nfit_spa->ars_state))
3226 req_type = ARS_REQ_LONG;
3227 else
3228 continue;
3229 rc = ars_start(acpi_desc, nfit_spa, req_type);
3230
3231 dev = nd_region_dev(nfit_spa->nd_region);
3232 dev_dbg(dev, "ARS: range %d ARS start %s (%d)\n",
3233 nfit_spa->spa->range_index,
3234 req_type == ARS_REQ_SHORT ? "short" : "long",
3235 rc);
3236 /*
3237 * Hmm, we raced someone else starting ARS? Try again in
3238 * a bit.
3239 */
3240 if (rc == -EBUSY)
3241 return 1;
3242 if (rc == 0) {
3243 dev_WARN_ONCE(dev, acpi_desc->scrub_spa,
3244 "scrub start while range %d active\n",
3245 acpi_desc->scrub_spa->spa->range_index);
3246 clear_bit(req_type, &nfit_spa->ars_state);
3247 acpi_desc->scrub_spa = nfit_spa;
3248 /*
3249 * Consider this spa last for future scrub
3250 * requests
3251 */
3252 list_move_tail(&nfit_spa->list, &acpi_desc->spas);
3253 return 1;
3254 }
3255
3256 dev_err(dev, "ARS: range %d ARS failed (%d)\n",
3257 nfit_spa->spa->range_index, rc);
3258 set_bit(ARS_FAILED, &nfit_spa->ars_state);
3259 }
3260 return 0;
3261}
3262
3263static void __sched_ars(struct acpi_nfit_desc *acpi_desc, unsigned int tmo)
3264{
3265 lockdep_assert_held(&acpi_desc->init_mutex);
3266
3267 set_bit(ARS_BUSY, &acpi_desc->scrub_flags);
3268 /* note this should only be set from within the workqueue */
3269 if (tmo)
3270 acpi_desc->scrub_tmo = tmo;
3271 queue_delayed_work(nfit_wq, &acpi_desc->dwork, tmo * HZ);
3272}
3273
3274static void sched_ars(struct acpi_nfit_desc *acpi_desc)
3275{
3276 __sched_ars(acpi_desc, 0);
3277}
3278
3279static void notify_ars_done(struct acpi_nfit_desc *acpi_desc)
3280{
3281 lockdep_assert_held(&acpi_desc->init_mutex);
3282
3283 clear_bit(ARS_BUSY, &acpi_desc->scrub_flags);
3284 acpi_desc->scrub_count++;
3285 if (acpi_desc->scrub_count_state)
3286 sysfs_notify_dirent(acpi_desc->scrub_count_state);
3287}
3288
3289static void acpi_nfit_scrub(struct work_struct *work)
3290{
3291 struct acpi_nfit_desc *acpi_desc;
3292 unsigned int tmo;
3293 int query_rc;
3294
3295 acpi_desc = container_of(work, typeof(*acpi_desc), dwork.work);
3296 mutex_lock(&acpi_desc->init_mutex);
3297 query_rc = acpi_nfit_query_poison(acpi_desc);
3298 tmo = __acpi_nfit_scrub(acpi_desc, query_rc);
3299 if (tmo)
3300 __sched_ars(acpi_desc, tmo);
3301 else
3302 notify_ars_done(acpi_desc);
3303 memset(acpi_desc->ars_status, 0, acpi_desc->max_ars);
3304 clear_bit(ARS_POLL, &acpi_desc->scrub_flags);
3305 mutex_unlock(&acpi_desc->init_mutex);
3306}
3307
3308static void acpi_nfit_init_ars(struct acpi_nfit_desc *acpi_desc,
3309 struct nfit_spa *nfit_spa)
3310{
3311 int type = nfit_spa_type(nfit_spa->spa);
3312 struct nd_cmd_ars_cap ars_cap;
3313 int rc;
3314
3315 set_bit(ARS_FAILED, &nfit_spa->ars_state);
3316 memset(&ars_cap, 0, sizeof(ars_cap));
3317 rc = ars_get_cap(acpi_desc, &ars_cap, nfit_spa);
3318 if (rc < 0)
3319 return;
3320 /* check that the supported scrub types match the spa type */
3321 if (type == NFIT_SPA_VOLATILE && ((ars_cap.status >> 16)
3322 & ND_ARS_VOLATILE) == 0)
3323 return;
3324 if (type == NFIT_SPA_PM && ((ars_cap.status >> 16)
3325 & ND_ARS_PERSISTENT) == 0)
3326 return;
3327
3328 nfit_spa->max_ars = ars_cap.max_ars_out;
3329 nfit_spa->clear_err_unit = ars_cap.clear_err_unit;
3330 acpi_desc->max_ars = max(nfit_spa->max_ars, acpi_desc->max_ars);
3331 clear_bit(ARS_FAILED, &nfit_spa->ars_state);
3332}
3333
3334static int acpi_nfit_register_regions(struct acpi_nfit_desc *acpi_desc)
3335{
3336 struct nfit_spa *nfit_spa;
3337 int rc, do_sched_ars = 0;
3338
3339 set_bit(ARS_VALID, &acpi_desc->scrub_flags);
3340 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
3341 switch (nfit_spa_type(nfit_spa->spa)) {
3342 case NFIT_SPA_VOLATILE:
3343 case NFIT_SPA_PM:
3344 acpi_nfit_init_ars(acpi_desc, nfit_spa);
3345 break;
3346 }
3347 }
3348
3349 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
3350 switch (nfit_spa_type(nfit_spa->spa)) {
3351 case NFIT_SPA_VOLATILE:
3352 case NFIT_SPA_PM:
3353 /* register regions and kick off initial ARS run */
3354 rc = ars_register(acpi_desc, nfit_spa);
3355 if (rc)
3356 return rc;
3357
3358 /*
3359 * Kick off background ARS if at least one
3360 * region successfully registered ARS
3361 */
3362 if (!test_bit(ARS_FAILED, &nfit_spa->ars_state))
3363 do_sched_ars++;
3364 break;
3365 case NFIT_SPA_BDW:
3366 /* nothing to register */
3367 break;
3368 case NFIT_SPA_DCR:
3369 case NFIT_SPA_VDISK:
3370 case NFIT_SPA_VCD:
3371 case NFIT_SPA_PDISK:
3372 case NFIT_SPA_PCD:
3373 /* register known regions that don't support ARS */
3374 rc = acpi_nfit_register_region(acpi_desc, nfit_spa);
3375 if (rc)
3376 return rc;
3377 break;
3378 default:
3379 /* don't register unknown regions */
3380 break;
3381 }
3382 }
3383
3384 if (do_sched_ars)
3385 sched_ars(acpi_desc);
3386 return 0;
3387}
3388
3389static int acpi_nfit_check_deletions(struct acpi_nfit_desc *acpi_desc,
3390 struct nfit_table_prev *prev)
3391{
3392 struct device *dev = acpi_desc->dev;
3393
3394 if (!list_empty(&prev->spas) ||
3395 !list_empty(&prev->memdevs) ||
3396 !list_empty(&prev->dcrs) ||
3397 !list_empty(&prev->bdws) ||
3398 !list_empty(&prev->idts) ||
3399 !list_empty(&prev->flushes)) {
3400 dev_err(dev, "new nfit deletes entries (unsupported)\n");
3401 return -ENXIO;
3402 }
3403 return 0;
3404}
3405
3406static int acpi_nfit_desc_init_scrub_attr(struct acpi_nfit_desc *acpi_desc)
3407{
3408 struct device *dev = acpi_desc->dev;
3409 struct kernfs_node *nfit;
3410 struct device *bus_dev;
3411
3412 if (!ars_supported(acpi_desc->nvdimm_bus))
3413 return 0;
3414
3415 bus_dev = to_nvdimm_bus_dev(acpi_desc->nvdimm_bus);
3416 nfit = sysfs_get_dirent(bus_dev->kobj.sd, "nfit");
3417 if (!nfit) {
3418 dev_err(dev, "sysfs_get_dirent 'nfit' failed\n");
3419 return -ENODEV;
3420 }
3421 acpi_desc->scrub_count_state = sysfs_get_dirent(nfit, "scrub");
3422 sysfs_put(nfit);
3423 if (!acpi_desc->scrub_count_state) {
3424 dev_err(dev, "sysfs_get_dirent 'scrub' failed\n");
3425 return -ENODEV;
3426 }
3427
3428 return 0;
3429}
3430
3431static void acpi_nfit_unregister(void *data)
3432{
3433 struct acpi_nfit_desc *acpi_desc = data;
3434
3435 nvdimm_bus_unregister(acpi_desc->nvdimm_bus);
3436}
3437
3438int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, void *data, acpi_size sz)
3439{
3440 struct device *dev = acpi_desc->dev;
3441 struct nfit_table_prev prev;
3442 const void *end;
3443 int rc;
3444
3445 if (!acpi_desc->nvdimm_bus) {
3446 acpi_nfit_init_dsms(acpi_desc);
3447
3448 acpi_desc->nvdimm_bus = nvdimm_bus_register(dev,
3449 &acpi_desc->nd_desc);
3450 if (!acpi_desc->nvdimm_bus)
3451 return -ENOMEM;
3452
3453 rc = devm_add_action_or_reset(dev, acpi_nfit_unregister,
3454 acpi_desc);
3455 if (rc)
3456 return rc;
3457
3458 rc = acpi_nfit_desc_init_scrub_attr(acpi_desc);
3459 if (rc)
3460 return rc;
3461
3462 /* register this acpi_desc for mce notifications */
3463 mutex_lock(&acpi_desc_lock);
3464 list_add_tail(&acpi_desc->list, &acpi_descs);
3465 mutex_unlock(&acpi_desc_lock);
3466 }
3467
3468 mutex_lock(&acpi_desc->init_mutex);
3469
3470 INIT_LIST_HEAD(&prev.spas);
3471 INIT_LIST_HEAD(&prev.memdevs);
3472 INIT_LIST_HEAD(&prev.dcrs);
3473 INIT_LIST_HEAD(&prev.bdws);
3474 INIT_LIST_HEAD(&prev.idts);
3475 INIT_LIST_HEAD(&prev.flushes);
3476
3477 list_cut_position(&prev.spas, &acpi_desc->spas,
3478 acpi_desc->spas.prev);
3479 list_cut_position(&prev.memdevs, &acpi_desc->memdevs,
3480 acpi_desc->memdevs.prev);
3481 list_cut_position(&prev.dcrs, &acpi_desc->dcrs,
3482 acpi_desc->dcrs.prev);
3483 list_cut_position(&prev.bdws, &acpi_desc->bdws,
3484 acpi_desc->bdws.prev);
3485 list_cut_position(&prev.idts, &acpi_desc->idts,
3486 acpi_desc->idts.prev);
3487 list_cut_position(&prev.flushes, &acpi_desc->flushes,
3488 acpi_desc->flushes.prev);
3489
3490 end = data + sz;
3491 while (!IS_ERR_OR_NULL(data))
3492 data = add_table(acpi_desc, &prev, data, end);
3493
3494 if (IS_ERR(data)) {
3495 dev_dbg(dev, "nfit table parsing error: %ld\n", PTR_ERR(data));
3496 rc = PTR_ERR(data);
3497 goto out_unlock;
3498 }
3499
3500 rc = acpi_nfit_check_deletions(acpi_desc, &prev);
3501 if (rc)
3502 goto out_unlock;
3503
3504 rc = nfit_mem_init(acpi_desc);
3505 if (rc)
3506 goto out_unlock;
3507
3508 rc = acpi_nfit_register_dimms(acpi_desc);
3509 if (rc)
3510 goto out_unlock;
3511
3512 rc = acpi_nfit_register_regions(acpi_desc);
3513
3514 out_unlock:
3515 mutex_unlock(&acpi_desc->init_mutex);
3516 return rc;
3517}
3518EXPORT_SYMBOL_GPL(acpi_nfit_init);
3519
3520static int acpi_nfit_flush_probe(struct nvdimm_bus_descriptor *nd_desc)
3521{
3522 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
3523 struct device *dev = acpi_desc->dev;
3524
3525 /* Bounce the device lock to flush acpi_nfit_add / acpi_nfit_notify */
3526 nfit_device_lock(dev);
3527 nfit_device_unlock(dev);
3528
3529 /* Bounce the init_mutex to complete initial registration */
3530 mutex_lock(&acpi_desc->init_mutex);
3531 mutex_unlock(&acpi_desc->init_mutex);
3532
3533 return 0;
3534}
3535
3536static int __acpi_nfit_clear_to_send(struct nvdimm_bus_descriptor *nd_desc,
3537 struct nvdimm *nvdimm, unsigned int cmd)
3538{
3539 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
3540
3541 if (nvdimm)
3542 return 0;
3543 if (cmd != ND_CMD_ARS_START)
3544 return 0;
3545
3546 /*
3547 * The kernel and userspace may race to initiate a scrub, but
3548 * the scrub thread is prepared to lose that initial race. It
3549 * just needs guarantees that any ARS it initiates are not
3550 * interrupted by any intervening start requests from userspace.
3551 */
3552 if (work_busy(&acpi_desc->dwork.work))
3553 return -EBUSY;
3554
3555 return 0;
3556}
3557
3558/*
3559 * Prevent security and firmware activate commands from being issued via
3560 * ioctl.
3561 */
3562static int acpi_nfit_clear_to_send(struct nvdimm_bus_descriptor *nd_desc,
3563 struct nvdimm *nvdimm, unsigned int cmd, void *buf)
3564{
3565 struct nd_cmd_pkg *call_pkg = buf;
3566 unsigned int func;
3567
3568 if (nvdimm && cmd == ND_CMD_CALL &&
3569 call_pkg->nd_family == NVDIMM_FAMILY_INTEL) {
3570 func = call_pkg->nd_command;
3571 if (func > NVDIMM_CMD_MAX ||
3572 (1 << func) & NVDIMM_INTEL_DENY_CMDMASK)
3573 return -EOPNOTSUPP;
3574 }
3575
3576 /* block all non-nfit bus commands */
3577 if (!nvdimm && cmd == ND_CMD_CALL &&
3578 call_pkg->nd_family != NVDIMM_BUS_FAMILY_NFIT)
3579 return -EOPNOTSUPP;
3580
3581 return __acpi_nfit_clear_to_send(nd_desc, nvdimm, cmd);
3582}
3583
3584int acpi_nfit_ars_rescan(struct acpi_nfit_desc *acpi_desc,
3585 enum nfit_ars_state req_type)
3586{
3587 struct device *dev = acpi_desc->dev;
3588 int scheduled = 0, busy = 0;
3589 struct nfit_spa *nfit_spa;
3590
3591 mutex_lock(&acpi_desc->init_mutex);
3592 if (test_bit(ARS_CANCEL, &acpi_desc->scrub_flags)) {
3593 mutex_unlock(&acpi_desc->init_mutex);
3594 return 0;
3595 }
3596
3597 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
3598 int type = nfit_spa_type(nfit_spa->spa);
3599
3600 if (type != NFIT_SPA_PM && type != NFIT_SPA_VOLATILE)
3601 continue;
3602 if (test_bit(ARS_FAILED, &nfit_spa->ars_state))
3603 continue;
3604
3605 if (test_and_set_bit(req_type, &nfit_spa->ars_state))
3606 busy++;
3607 else
3608 scheduled++;
3609 }
3610 if (scheduled) {
3611 sched_ars(acpi_desc);
3612 dev_dbg(dev, "ars_scan triggered\n");
3613 }
3614 mutex_unlock(&acpi_desc->init_mutex);
3615
3616 if (scheduled)
3617 return 0;
3618 if (busy)
3619 return -EBUSY;
3620 return -ENOTTY;
3621}
3622
3623void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev)
3624{
3625 struct nvdimm_bus_descriptor *nd_desc;
3626
3627 dev_set_drvdata(dev, acpi_desc);
3628 acpi_desc->dev = dev;
3629 acpi_desc->blk_do_io = acpi_nfit_blk_region_do_io;
3630 nd_desc = &acpi_desc->nd_desc;
3631 nd_desc->provider_name = "ACPI.NFIT";
3632 nd_desc->module = THIS_MODULE;
3633 nd_desc->ndctl = acpi_nfit_ctl;
3634 nd_desc->flush_probe = acpi_nfit_flush_probe;
3635 nd_desc->clear_to_send = acpi_nfit_clear_to_send;
3636 nd_desc->attr_groups = acpi_nfit_attribute_groups;
3637
3638 INIT_LIST_HEAD(&acpi_desc->spas);
3639 INIT_LIST_HEAD(&acpi_desc->dcrs);
3640 INIT_LIST_HEAD(&acpi_desc->bdws);
3641 INIT_LIST_HEAD(&acpi_desc->idts);
3642 INIT_LIST_HEAD(&acpi_desc->flushes);
3643 INIT_LIST_HEAD(&acpi_desc->memdevs);
3644 INIT_LIST_HEAD(&acpi_desc->dimms);
3645 INIT_LIST_HEAD(&acpi_desc->list);
3646 mutex_init(&acpi_desc->init_mutex);
3647 acpi_desc->scrub_tmo = 1;
3648 INIT_DELAYED_WORK(&acpi_desc->dwork, acpi_nfit_scrub);
3649}
3650EXPORT_SYMBOL_GPL(acpi_nfit_desc_init);
3651
3652static void acpi_nfit_put_table(void *table)
3653{
3654 acpi_put_table(table);
3655}
3656
3657void acpi_nfit_shutdown(void *data)
3658{
3659 struct acpi_nfit_desc *acpi_desc = data;
3660 struct device *bus_dev = to_nvdimm_bus_dev(acpi_desc->nvdimm_bus);
3661
3662 /*
3663 * Destruct under acpi_desc_lock so that nfit_handle_mce does not
3664 * race teardown
3665 */
3666 mutex_lock(&acpi_desc_lock);
3667 list_del(&acpi_desc->list);
3668 mutex_unlock(&acpi_desc_lock);
3669
3670 mutex_lock(&acpi_desc->init_mutex);
3671 set_bit(ARS_CANCEL, &acpi_desc->scrub_flags);
3672 cancel_delayed_work_sync(&acpi_desc->dwork);
3673 mutex_unlock(&acpi_desc->init_mutex);
3674
3675 /*
3676 * Bounce the nvdimm bus lock to make sure any in-flight
3677 * acpi_nfit_ars_rescan() submissions have had a chance to
3678 * either submit or see ->cancel set.
3679 */
3680 nfit_device_lock(bus_dev);
3681 nfit_device_unlock(bus_dev);
3682
3683 flush_workqueue(nfit_wq);
3684}
3685EXPORT_SYMBOL_GPL(acpi_nfit_shutdown);
3686
3687static int acpi_nfit_add(struct acpi_device *adev)
3688{
3689 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
3690 struct acpi_nfit_desc *acpi_desc;
3691 struct device *dev = &adev->dev;
3692 struct acpi_table_header *tbl;
3693 acpi_status status = AE_OK;
3694 acpi_size sz;
3695 int rc = 0;
3696
3697 status = acpi_get_table(ACPI_SIG_NFIT, 0, &tbl);
3698 if (ACPI_FAILURE(status)) {
3699 /* The NVDIMM root device allows OS to trigger enumeration of
3700 * NVDIMMs through NFIT at boot time and re-enumeration at
3701 * root level via the _FIT method during runtime.
3702 * This is ok to return 0 here, we could have an nvdimm
3703 * hotplugged later and evaluate _FIT method which returns
3704 * data in the format of a series of NFIT Structures.
3705 */
3706 dev_dbg(dev, "failed to find NFIT at startup\n");
3707 return 0;
3708 }
3709
3710 rc = devm_add_action_or_reset(dev, acpi_nfit_put_table, tbl);
3711 if (rc)
3712 return rc;
3713 sz = tbl->length;
3714
3715 acpi_desc = devm_kzalloc(dev, sizeof(*acpi_desc), GFP_KERNEL);
3716 if (!acpi_desc)
3717 return -ENOMEM;
3718 acpi_nfit_desc_init(acpi_desc, &adev->dev);
3719
3720 /* Save the acpi header for exporting the revision via sysfs */
3721 acpi_desc->acpi_header = *tbl;
3722
3723 /* Evaluate _FIT and override with that if present */
3724 status = acpi_evaluate_object(adev->handle, "_FIT", NULL, &buf);
3725 if (ACPI_SUCCESS(status) && buf.length > 0) {
3726 union acpi_object *obj = buf.pointer;
3727
3728 if (obj->type == ACPI_TYPE_BUFFER)
3729 rc = acpi_nfit_init(acpi_desc, obj->buffer.pointer,
3730 obj->buffer.length);
3731 else
3732 dev_dbg(dev, "invalid type %d, ignoring _FIT\n",
3733 (int) obj->type);
3734 kfree(buf.pointer);
3735 } else
3736 /* skip over the lead-in header table */
3737 rc = acpi_nfit_init(acpi_desc, (void *) tbl
3738 + sizeof(struct acpi_table_nfit),
3739 sz - sizeof(struct acpi_table_nfit));
3740
3741 if (rc)
3742 return rc;
3743 return devm_add_action_or_reset(dev, acpi_nfit_shutdown, acpi_desc);
3744}
3745
3746static int acpi_nfit_remove(struct acpi_device *adev)
3747{
3748 /* see acpi_nfit_unregister */
3749 return 0;
3750}
3751
3752static void acpi_nfit_update_notify(struct device *dev, acpi_handle handle)
3753{
3754 struct acpi_nfit_desc *acpi_desc = dev_get_drvdata(dev);
3755 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
3756 union acpi_object *obj;
3757 acpi_status status;
3758 int ret;
3759
3760 if (!dev->driver) {
3761 /* dev->driver may be null if we're being removed */
3762 dev_dbg(dev, "no driver found for dev\n");
3763 return;
3764 }
3765
3766 if (!acpi_desc) {
3767 acpi_desc = devm_kzalloc(dev, sizeof(*acpi_desc), GFP_KERNEL);
3768 if (!acpi_desc)
3769 return;
3770 acpi_nfit_desc_init(acpi_desc, dev);
3771 } else {
3772 /*
3773 * Finish previous registration before considering new
3774 * regions.
3775 */
3776 flush_workqueue(nfit_wq);
3777 }
3778
3779 /* Evaluate _FIT */
3780 status = acpi_evaluate_object(handle, "_FIT", NULL, &buf);
3781 if (ACPI_FAILURE(status)) {
3782 dev_err(dev, "failed to evaluate _FIT\n");
3783 return;
3784 }
3785
3786 obj = buf.pointer;
3787 if (obj->type == ACPI_TYPE_BUFFER) {
3788 ret = acpi_nfit_init(acpi_desc, obj->buffer.pointer,
3789 obj->buffer.length);
3790 if (ret)
3791 dev_err(dev, "failed to merge updated NFIT\n");
3792 } else
3793 dev_err(dev, "Invalid _FIT\n");
3794 kfree(buf.pointer);
3795}
3796
3797static void acpi_nfit_uc_error_notify(struct device *dev, acpi_handle handle)
3798{
3799 struct acpi_nfit_desc *acpi_desc = dev_get_drvdata(dev);
3800
3801 if (acpi_desc->scrub_mode == HW_ERROR_SCRUB_ON)
3802 acpi_nfit_ars_rescan(acpi_desc, ARS_REQ_LONG);
3803 else
3804 acpi_nfit_ars_rescan(acpi_desc, ARS_REQ_SHORT);
3805}
3806
3807void __acpi_nfit_notify(struct device *dev, acpi_handle handle, u32 event)
3808{
3809 dev_dbg(dev, "event: 0x%x\n", event);
3810
3811 switch (event) {
3812 case NFIT_NOTIFY_UPDATE:
3813 return acpi_nfit_update_notify(dev, handle);
3814 case NFIT_NOTIFY_UC_MEMORY_ERROR:
3815 return acpi_nfit_uc_error_notify(dev, handle);
3816 default:
3817 return;
3818 }
3819}
3820EXPORT_SYMBOL_GPL(__acpi_nfit_notify);
3821
3822static void acpi_nfit_notify(struct acpi_device *adev, u32 event)
3823{
3824 nfit_device_lock(&adev->dev);
3825 __acpi_nfit_notify(&adev->dev, adev->handle, event);
3826 nfit_device_unlock(&adev->dev);
3827}
3828
3829static const struct acpi_device_id acpi_nfit_ids[] = {
3830 { "ACPI0012", 0 },
3831 { "", 0 },
3832};
3833MODULE_DEVICE_TABLE(acpi, acpi_nfit_ids);
3834
3835static struct acpi_driver acpi_nfit_driver = {
3836 .name = KBUILD_MODNAME,
3837 .ids = acpi_nfit_ids,
3838 .ops = {
3839 .add = acpi_nfit_add,
3840 .remove = acpi_nfit_remove,
3841 .notify = acpi_nfit_notify,
3842 },
3843};
3844
3845static __init int nfit_init(void)
3846{
3847 int ret;
3848
3849 BUILD_BUG_ON(sizeof(struct acpi_table_nfit) != 40);
3850 BUILD_BUG_ON(sizeof(struct acpi_nfit_system_address) != 56);
3851 BUILD_BUG_ON(sizeof(struct acpi_nfit_memory_map) != 48);
3852 BUILD_BUG_ON(sizeof(struct acpi_nfit_interleave) != 20);
3853 BUILD_BUG_ON(sizeof(struct acpi_nfit_smbios) != 9);
3854 BUILD_BUG_ON(sizeof(struct acpi_nfit_control_region) != 80);
3855 BUILD_BUG_ON(sizeof(struct acpi_nfit_data_region) != 40);
3856 BUILD_BUG_ON(sizeof(struct acpi_nfit_capabilities) != 16);
3857
3858 guid_parse(UUID_VOLATILE_MEMORY, &nfit_uuid[NFIT_SPA_VOLATILE]);
3859 guid_parse(UUID_PERSISTENT_MEMORY, &nfit_uuid[NFIT_SPA_PM]);
3860 guid_parse(UUID_CONTROL_REGION, &nfit_uuid[NFIT_SPA_DCR]);
3861 guid_parse(UUID_DATA_REGION, &nfit_uuid[NFIT_SPA_BDW]);
3862 guid_parse(UUID_VOLATILE_VIRTUAL_DISK, &nfit_uuid[NFIT_SPA_VDISK]);
3863 guid_parse(UUID_VOLATILE_VIRTUAL_CD, &nfit_uuid[NFIT_SPA_VCD]);
3864 guid_parse(UUID_PERSISTENT_VIRTUAL_DISK, &nfit_uuid[NFIT_SPA_PDISK]);
3865 guid_parse(UUID_PERSISTENT_VIRTUAL_CD, &nfit_uuid[NFIT_SPA_PCD]);
3866 guid_parse(UUID_NFIT_BUS, &nfit_uuid[NFIT_DEV_BUS]);
3867 guid_parse(UUID_NFIT_DIMM, &nfit_uuid[NFIT_DEV_DIMM]);
3868 guid_parse(UUID_NFIT_DIMM_N_HPE1, &nfit_uuid[NFIT_DEV_DIMM_N_HPE1]);
3869 guid_parse(UUID_NFIT_DIMM_N_HPE2, &nfit_uuid[NFIT_DEV_DIMM_N_HPE2]);
3870 guid_parse(UUID_NFIT_DIMM_N_MSFT, &nfit_uuid[NFIT_DEV_DIMM_N_MSFT]);
3871 guid_parse(UUID_NFIT_DIMM_N_HYPERV, &nfit_uuid[NFIT_DEV_DIMM_N_HYPERV]);
3872 guid_parse(UUID_INTEL_BUS, &nfit_uuid[NFIT_BUS_INTEL]);
3873
3874 nfit_wq = create_singlethread_workqueue("nfit");
3875 if (!nfit_wq)
3876 return -ENOMEM;
3877
3878 nfit_mce_register();
3879 ret = acpi_bus_register_driver(&acpi_nfit_driver);
3880 if (ret) {
3881 nfit_mce_unregister();
3882 destroy_workqueue(nfit_wq);
3883 }
3884
3885 return ret;
3886
3887}
3888
3889static __exit void nfit_exit(void)
3890{
3891 nfit_mce_unregister();
3892 acpi_bus_unregister_driver(&acpi_nfit_driver);
3893 destroy_workqueue(nfit_wq);
3894 WARN_ON(!list_empty(&acpi_descs));
3895}
3896
3897module_init(nfit_init);
3898module_exit(nfit_exit);
3899MODULE_LICENSE("GPL v2");
3900MODULE_AUTHOR("Intel Corporation");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
4 */
5#include <linux/list_sort.h>
6#include <linux/libnvdimm.h>
7#include <linux/module.h>
8#include <linux/nospec.h>
9#include <linux/mutex.h>
10#include <linux/ndctl.h>
11#include <linux/sysfs.h>
12#include <linux/delay.h>
13#include <linux/list.h>
14#include <linux/acpi.h>
15#include <linux/sort.h>
16#include <linux/io.h>
17#include <linux/nd.h>
18#include <asm/cacheflush.h>
19#include <acpi/nfit.h>
20#include "intel.h"
21#include "nfit.h"
22
23/*
24 * For readq() and writeq() on 32-bit builds, the hi-lo, lo-hi order is
25 * irrelevant.
26 */
27#include <linux/io-64-nonatomic-hi-lo.h>
28
29static bool force_enable_dimms;
30module_param(force_enable_dimms, bool, S_IRUGO|S_IWUSR);
31MODULE_PARM_DESC(force_enable_dimms, "Ignore _STA (ACPI DIMM device) status");
32
33static bool disable_vendor_specific;
34module_param(disable_vendor_specific, bool, S_IRUGO);
35MODULE_PARM_DESC(disable_vendor_specific,
36 "Limit commands to the publicly specified set");
37
38static unsigned long override_dsm_mask;
39module_param(override_dsm_mask, ulong, S_IRUGO);
40MODULE_PARM_DESC(override_dsm_mask, "Bitmask of allowed NVDIMM DSM functions");
41
42static int default_dsm_family = -1;
43module_param(default_dsm_family, int, S_IRUGO);
44MODULE_PARM_DESC(default_dsm_family,
45 "Try this DSM type first when identifying NVDIMM family");
46
47static bool no_init_ars;
48module_param(no_init_ars, bool, 0644);
49MODULE_PARM_DESC(no_init_ars, "Skip ARS run at nfit init time");
50
51static bool force_labels;
52module_param(force_labels, bool, 0444);
53MODULE_PARM_DESC(force_labels, "Opt-in to labels despite missing methods");
54
55LIST_HEAD(acpi_descs);
56DEFINE_MUTEX(acpi_desc_lock);
57
58static struct workqueue_struct *nfit_wq;
59
60struct nfit_table_prev {
61 struct list_head spas;
62 struct list_head memdevs;
63 struct list_head dcrs;
64 struct list_head bdws;
65 struct list_head idts;
66 struct list_head flushes;
67};
68
69static guid_t nfit_uuid[NFIT_UUID_MAX];
70
71const guid_t *to_nfit_uuid(enum nfit_uuids id)
72{
73 return &nfit_uuid[id];
74}
75EXPORT_SYMBOL(to_nfit_uuid);
76
77static const guid_t *to_nfit_bus_uuid(int family)
78{
79 if (WARN_ONCE(family == NVDIMM_BUS_FAMILY_NFIT,
80 "only secondary bus families can be translated\n"))
81 return NULL;
82 /*
83 * The index of bus UUIDs starts immediately following the last
84 * NVDIMM/leaf family.
85 */
86 return to_nfit_uuid(family + NVDIMM_FAMILY_MAX);
87}
88
89static struct acpi_device *to_acpi_dev(struct acpi_nfit_desc *acpi_desc)
90{
91 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
92
93 /*
94 * If provider == 'ACPI.NFIT' we can assume 'dev' is a struct
95 * acpi_device.
96 */
97 if (!nd_desc->provider_name
98 || strcmp(nd_desc->provider_name, "ACPI.NFIT") != 0)
99 return NULL;
100
101 return to_acpi_device(acpi_desc->dev);
102}
103
104static int xlat_bus_status(void *buf, unsigned int cmd, u32 status)
105{
106 struct nd_cmd_clear_error *clear_err;
107 struct nd_cmd_ars_status *ars_status;
108 u16 flags;
109
110 switch (cmd) {
111 case ND_CMD_ARS_CAP:
112 if ((status & 0xffff) == NFIT_ARS_CAP_NONE)
113 return -ENOTTY;
114
115 /* Command failed */
116 if (status & 0xffff)
117 return -EIO;
118
119 /* No supported scan types for this range */
120 flags = ND_ARS_PERSISTENT | ND_ARS_VOLATILE;
121 if ((status >> 16 & flags) == 0)
122 return -ENOTTY;
123 return 0;
124 case ND_CMD_ARS_START:
125 /* ARS is in progress */
126 if ((status & 0xffff) == NFIT_ARS_START_BUSY)
127 return -EBUSY;
128
129 /* Command failed */
130 if (status & 0xffff)
131 return -EIO;
132 return 0;
133 case ND_CMD_ARS_STATUS:
134 ars_status = buf;
135 /* Command failed */
136 if (status & 0xffff)
137 return -EIO;
138 /* Check extended status (Upper two bytes) */
139 if (status == NFIT_ARS_STATUS_DONE)
140 return 0;
141
142 /* ARS is in progress */
143 if (status == NFIT_ARS_STATUS_BUSY)
144 return -EBUSY;
145
146 /* No ARS performed for the current boot */
147 if (status == NFIT_ARS_STATUS_NONE)
148 return -EAGAIN;
149
150 /*
151 * ARS interrupted, either we overflowed or some other
152 * agent wants the scan to stop. If we didn't overflow
153 * then just continue with the returned results.
154 */
155 if (status == NFIT_ARS_STATUS_INTR) {
156 if (ars_status->out_length >= 40 && (ars_status->flags
157 & NFIT_ARS_F_OVERFLOW))
158 return -ENOSPC;
159 return 0;
160 }
161
162 /* Unknown status */
163 if (status >> 16)
164 return -EIO;
165 return 0;
166 case ND_CMD_CLEAR_ERROR:
167 clear_err = buf;
168 if (status & 0xffff)
169 return -EIO;
170 if (!clear_err->cleared)
171 return -EIO;
172 if (clear_err->length > clear_err->cleared)
173 return clear_err->cleared;
174 return 0;
175 default:
176 break;
177 }
178
179 /* all other non-zero status results in an error */
180 if (status)
181 return -EIO;
182 return 0;
183}
184
185#define ACPI_LABELS_LOCKED 3
186
187static int xlat_nvdimm_status(struct nvdimm *nvdimm, void *buf, unsigned int cmd,
188 u32 status)
189{
190 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
191
192 switch (cmd) {
193 case ND_CMD_GET_CONFIG_SIZE:
194 /*
195 * In the _LSI, _LSR, _LSW case the locked status is
196 * communicated via the read/write commands
197 */
198 if (test_bit(NFIT_MEM_LSR, &nfit_mem->flags))
199 break;
200
201 if (status >> 16 & ND_CONFIG_LOCKED)
202 return -EACCES;
203 break;
204 case ND_CMD_GET_CONFIG_DATA:
205 if (test_bit(NFIT_MEM_LSR, &nfit_mem->flags)
206 && status == ACPI_LABELS_LOCKED)
207 return -EACCES;
208 break;
209 case ND_CMD_SET_CONFIG_DATA:
210 if (test_bit(NFIT_MEM_LSW, &nfit_mem->flags)
211 && status == ACPI_LABELS_LOCKED)
212 return -EACCES;
213 break;
214 default:
215 break;
216 }
217
218 /* all other non-zero status results in an error */
219 if (status)
220 return -EIO;
221 return 0;
222}
223
224static int xlat_status(struct nvdimm *nvdimm, void *buf, unsigned int cmd,
225 u32 status)
226{
227 if (!nvdimm)
228 return xlat_bus_status(buf, cmd, status);
229 return xlat_nvdimm_status(nvdimm, buf, cmd, status);
230}
231
232/* convert _LS{I,R} packages to the buffer object acpi_nfit_ctl expects */
233static union acpi_object *pkg_to_buf(union acpi_object *pkg)
234{
235 int i;
236 void *dst;
237 size_t size = 0;
238 union acpi_object *buf = NULL;
239
240 if (pkg->type != ACPI_TYPE_PACKAGE) {
241 WARN_ONCE(1, "BIOS bug, unexpected element type: %d\n",
242 pkg->type);
243 goto err;
244 }
245
246 for (i = 0; i < pkg->package.count; i++) {
247 union acpi_object *obj = &pkg->package.elements[i];
248
249 if (obj->type == ACPI_TYPE_INTEGER)
250 size += 4;
251 else if (obj->type == ACPI_TYPE_BUFFER)
252 size += obj->buffer.length;
253 else {
254 WARN_ONCE(1, "BIOS bug, unexpected element type: %d\n",
255 obj->type);
256 goto err;
257 }
258 }
259
260 buf = ACPI_ALLOCATE(sizeof(*buf) + size);
261 if (!buf)
262 goto err;
263
264 dst = buf + 1;
265 buf->type = ACPI_TYPE_BUFFER;
266 buf->buffer.length = size;
267 buf->buffer.pointer = dst;
268 for (i = 0; i < pkg->package.count; i++) {
269 union acpi_object *obj = &pkg->package.elements[i];
270
271 if (obj->type == ACPI_TYPE_INTEGER) {
272 memcpy(dst, &obj->integer.value, 4);
273 dst += 4;
274 } else if (obj->type == ACPI_TYPE_BUFFER) {
275 memcpy(dst, obj->buffer.pointer, obj->buffer.length);
276 dst += obj->buffer.length;
277 }
278 }
279err:
280 ACPI_FREE(pkg);
281 return buf;
282}
283
284static union acpi_object *int_to_buf(union acpi_object *integer)
285{
286 union acpi_object *buf = NULL;
287 void *dst = NULL;
288
289 if (integer->type != ACPI_TYPE_INTEGER) {
290 WARN_ONCE(1, "BIOS bug, unexpected element type: %d\n",
291 integer->type);
292 goto err;
293 }
294
295 buf = ACPI_ALLOCATE(sizeof(*buf) + 4);
296 if (!buf)
297 goto err;
298
299 dst = buf + 1;
300 buf->type = ACPI_TYPE_BUFFER;
301 buf->buffer.length = 4;
302 buf->buffer.pointer = dst;
303 memcpy(dst, &integer->integer.value, 4);
304err:
305 ACPI_FREE(integer);
306 return buf;
307}
308
309static union acpi_object *acpi_label_write(acpi_handle handle, u32 offset,
310 u32 len, void *data)
311{
312 acpi_status rc;
313 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
314 struct acpi_object_list input = {
315 .count = 3,
316 .pointer = (union acpi_object []) {
317 [0] = {
318 .integer.type = ACPI_TYPE_INTEGER,
319 .integer.value = offset,
320 },
321 [1] = {
322 .integer.type = ACPI_TYPE_INTEGER,
323 .integer.value = len,
324 },
325 [2] = {
326 .buffer.type = ACPI_TYPE_BUFFER,
327 .buffer.pointer = data,
328 .buffer.length = len,
329 },
330 },
331 };
332
333 rc = acpi_evaluate_object(handle, "_LSW", &input, &buf);
334 if (ACPI_FAILURE(rc))
335 return NULL;
336 return int_to_buf(buf.pointer);
337}
338
339static union acpi_object *acpi_label_read(acpi_handle handle, u32 offset,
340 u32 len)
341{
342 acpi_status rc;
343 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
344 struct acpi_object_list input = {
345 .count = 2,
346 .pointer = (union acpi_object []) {
347 [0] = {
348 .integer.type = ACPI_TYPE_INTEGER,
349 .integer.value = offset,
350 },
351 [1] = {
352 .integer.type = ACPI_TYPE_INTEGER,
353 .integer.value = len,
354 },
355 },
356 };
357
358 rc = acpi_evaluate_object(handle, "_LSR", &input, &buf);
359 if (ACPI_FAILURE(rc))
360 return NULL;
361 return pkg_to_buf(buf.pointer);
362}
363
364static union acpi_object *acpi_label_info(acpi_handle handle)
365{
366 acpi_status rc;
367 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
368
369 rc = acpi_evaluate_object(handle, "_LSI", NULL, &buf);
370 if (ACPI_FAILURE(rc))
371 return NULL;
372 return pkg_to_buf(buf.pointer);
373}
374
375static u8 nfit_dsm_revid(unsigned family, unsigned func)
376{
377 static const u8 revid_table[NVDIMM_FAMILY_MAX+1][NVDIMM_CMD_MAX+1] = {
378 [NVDIMM_FAMILY_INTEL] = {
379 [NVDIMM_INTEL_GET_MODES ...
380 NVDIMM_INTEL_FW_ACTIVATE_ARM] = 2,
381 },
382 };
383 u8 id;
384
385 if (family > NVDIMM_FAMILY_MAX)
386 return 0;
387 if (func > NVDIMM_CMD_MAX)
388 return 0;
389 id = revid_table[family][func];
390 if (id == 0)
391 return 1; /* default */
392 return id;
393}
394
395static bool payload_dumpable(struct nvdimm *nvdimm, unsigned int func)
396{
397 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
398
399 if (nfit_mem && nfit_mem->family == NVDIMM_FAMILY_INTEL
400 && func >= NVDIMM_INTEL_GET_SECURITY_STATE
401 && func <= NVDIMM_INTEL_MASTER_SECURE_ERASE)
402 return IS_ENABLED(CONFIG_NFIT_SECURITY_DEBUG);
403 return true;
404}
405
406static int cmd_to_func(struct nfit_mem *nfit_mem, unsigned int cmd,
407 struct nd_cmd_pkg *call_pkg, int *family)
408{
409 if (call_pkg) {
410 int i;
411
412 if (nfit_mem && nfit_mem->family != call_pkg->nd_family)
413 return -ENOTTY;
414
415 for (i = 0; i < ARRAY_SIZE(call_pkg->nd_reserved2); i++)
416 if (call_pkg->nd_reserved2[i])
417 return -EINVAL;
418 *family = call_pkg->nd_family;
419 return call_pkg->nd_command;
420 }
421
422 /* In the !call_pkg case, bus commands == bus functions */
423 if (!nfit_mem)
424 return cmd;
425
426 /* Linux ND commands == NVDIMM_FAMILY_INTEL function numbers */
427 if (nfit_mem->family == NVDIMM_FAMILY_INTEL)
428 return cmd;
429
430 /*
431 * Force function number validation to fail since 0 is never
432 * published as a valid function in dsm_mask.
433 */
434 return 0;
435}
436
437int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc, struct nvdimm *nvdimm,
438 unsigned int cmd, void *buf, unsigned int buf_len, int *cmd_rc)
439{
440 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
441 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
442 union acpi_object in_obj, in_buf, *out_obj;
443 const struct nd_cmd_desc *desc = NULL;
444 struct device *dev = acpi_desc->dev;
445 struct nd_cmd_pkg *call_pkg = NULL;
446 const char *cmd_name, *dimm_name;
447 unsigned long cmd_mask, dsm_mask;
448 u32 offset, fw_status = 0;
449 acpi_handle handle;
450 const guid_t *guid;
451 int func, rc, i;
452 int family = 0;
453
454 if (cmd_rc)
455 *cmd_rc = -EINVAL;
456
457 if (cmd == ND_CMD_CALL)
458 call_pkg = buf;
459 func = cmd_to_func(nfit_mem, cmd, call_pkg, &family);
460 if (func < 0)
461 return func;
462
463 if (nvdimm) {
464 struct acpi_device *adev = nfit_mem->adev;
465
466 if (!adev)
467 return -ENOTTY;
468
469 dimm_name = nvdimm_name(nvdimm);
470 cmd_name = nvdimm_cmd_name(cmd);
471 cmd_mask = nvdimm_cmd_mask(nvdimm);
472 dsm_mask = nfit_mem->dsm_mask;
473 desc = nd_cmd_dimm_desc(cmd);
474 guid = to_nfit_uuid(nfit_mem->family);
475 handle = adev->handle;
476 } else {
477 struct acpi_device *adev = to_acpi_dev(acpi_desc);
478
479 cmd_name = nvdimm_bus_cmd_name(cmd);
480 cmd_mask = nd_desc->cmd_mask;
481 if (cmd == ND_CMD_CALL && call_pkg->nd_family) {
482 family = call_pkg->nd_family;
483 if (family > NVDIMM_BUS_FAMILY_MAX ||
484 !test_bit(family, &nd_desc->bus_family_mask))
485 return -EINVAL;
486 family = array_index_nospec(family,
487 NVDIMM_BUS_FAMILY_MAX + 1);
488 dsm_mask = acpi_desc->family_dsm_mask[family];
489 guid = to_nfit_bus_uuid(family);
490 } else {
491 dsm_mask = acpi_desc->bus_dsm_mask;
492 guid = to_nfit_uuid(NFIT_DEV_BUS);
493 }
494 desc = nd_cmd_bus_desc(cmd);
495 handle = adev->handle;
496 dimm_name = "bus";
497 }
498
499 if (!desc || (cmd && (desc->out_num + desc->in_num == 0)))
500 return -ENOTTY;
501
502 /*
503 * Check for a valid command. For ND_CMD_CALL, we also have to
504 * make sure that the DSM function is supported.
505 */
506 if (cmd == ND_CMD_CALL &&
507 (func > NVDIMM_CMD_MAX || !test_bit(func, &dsm_mask)))
508 return -ENOTTY;
509 else if (!test_bit(cmd, &cmd_mask))
510 return -ENOTTY;
511
512 in_obj.type = ACPI_TYPE_PACKAGE;
513 in_obj.package.count = 1;
514 in_obj.package.elements = &in_buf;
515 in_buf.type = ACPI_TYPE_BUFFER;
516 in_buf.buffer.pointer = buf;
517 in_buf.buffer.length = 0;
518
519 /* libnvdimm has already validated the input envelope */
520 for (i = 0; i < desc->in_num; i++)
521 in_buf.buffer.length += nd_cmd_in_size(nvdimm, cmd, desc,
522 i, buf);
523
524 if (call_pkg) {
525 /* skip over package wrapper */
526 in_buf.buffer.pointer = (void *) &call_pkg->nd_payload;
527 in_buf.buffer.length = call_pkg->nd_size_in;
528 }
529
530 dev_dbg(dev, "%s cmd: %d: family: %d func: %d input length: %d\n",
531 dimm_name, cmd, family, func, in_buf.buffer.length);
532 if (payload_dumpable(nvdimm, func))
533 print_hex_dump_debug("nvdimm in ", DUMP_PREFIX_OFFSET, 4, 4,
534 in_buf.buffer.pointer,
535 min_t(u32, 256, in_buf.buffer.length), true);
536
537 /* call the BIOS, prefer the named methods over _DSM if available */
538 if (nvdimm && cmd == ND_CMD_GET_CONFIG_SIZE
539 && test_bit(NFIT_MEM_LSR, &nfit_mem->flags))
540 out_obj = acpi_label_info(handle);
541 else if (nvdimm && cmd == ND_CMD_GET_CONFIG_DATA
542 && test_bit(NFIT_MEM_LSR, &nfit_mem->flags)) {
543 struct nd_cmd_get_config_data_hdr *p = buf;
544
545 out_obj = acpi_label_read(handle, p->in_offset, p->in_length);
546 } else if (nvdimm && cmd == ND_CMD_SET_CONFIG_DATA
547 && test_bit(NFIT_MEM_LSW, &nfit_mem->flags)) {
548 struct nd_cmd_set_config_hdr *p = buf;
549
550 out_obj = acpi_label_write(handle, p->in_offset, p->in_length,
551 p->in_buf);
552 } else {
553 u8 revid;
554
555 if (nvdimm)
556 revid = nfit_dsm_revid(nfit_mem->family, func);
557 else
558 revid = 1;
559 out_obj = acpi_evaluate_dsm(handle, guid, revid, func, &in_obj);
560 }
561
562 if (!out_obj) {
563 dev_dbg(dev, "%s _DSM failed cmd: %s\n", dimm_name, cmd_name);
564 return -EINVAL;
565 }
566
567 if (out_obj->type != ACPI_TYPE_BUFFER) {
568 dev_dbg(dev, "%s unexpected output object type cmd: %s type: %d\n",
569 dimm_name, cmd_name, out_obj->type);
570 rc = -EINVAL;
571 goto out;
572 }
573
574 dev_dbg(dev, "%s cmd: %s output length: %d\n", dimm_name,
575 cmd_name, out_obj->buffer.length);
576 print_hex_dump_debug(cmd_name, DUMP_PREFIX_OFFSET, 4, 4,
577 out_obj->buffer.pointer,
578 min_t(u32, 128, out_obj->buffer.length), true);
579
580 if (call_pkg) {
581 call_pkg->nd_fw_size = out_obj->buffer.length;
582 memcpy(call_pkg->nd_payload + call_pkg->nd_size_in,
583 out_obj->buffer.pointer,
584 min(call_pkg->nd_fw_size, call_pkg->nd_size_out));
585
586 ACPI_FREE(out_obj);
587 /*
588 * Need to support FW function w/o known size in advance.
589 * Caller can determine required size based upon nd_fw_size.
590 * If we return an error (like elsewhere) then caller wouldn't
591 * be able to rely upon data returned to make calculation.
592 */
593 if (cmd_rc)
594 *cmd_rc = 0;
595 return 0;
596 }
597
598 for (i = 0, offset = 0; i < desc->out_num; i++) {
599 u32 out_size = nd_cmd_out_size(nvdimm, cmd, desc, i, buf,
600 (u32 *) out_obj->buffer.pointer,
601 out_obj->buffer.length - offset);
602
603 if (offset + out_size > out_obj->buffer.length) {
604 dev_dbg(dev, "%s output object underflow cmd: %s field: %d\n",
605 dimm_name, cmd_name, i);
606 break;
607 }
608
609 if (in_buf.buffer.length + offset + out_size > buf_len) {
610 dev_dbg(dev, "%s output overrun cmd: %s field: %d\n",
611 dimm_name, cmd_name, i);
612 rc = -ENXIO;
613 goto out;
614 }
615 memcpy(buf + in_buf.buffer.length + offset,
616 out_obj->buffer.pointer + offset, out_size);
617 offset += out_size;
618 }
619
620 /*
621 * Set fw_status for all the commands with a known format to be
622 * later interpreted by xlat_status().
623 */
624 if (i >= 1 && ((!nvdimm && cmd >= ND_CMD_ARS_CAP
625 && cmd <= ND_CMD_CLEAR_ERROR)
626 || (nvdimm && cmd >= ND_CMD_SMART
627 && cmd <= ND_CMD_VENDOR)))
628 fw_status = *(u32 *) out_obj->buffer.pointer;
629
630 if (offset + in_buf.buffer.length < buf_len) {
631 if (i >= 1) {
632 /*
633 * status valid, return the number of bytes left
634 * unfilled in the output buffer
635 */
636 rc = buf_len - offset - in_buf.buffer.length;
637 if (cmd_rc)
638 *cmd_rc = xlat_status(nvdimm, buf, cmd,
639 fw_status);
640 } else {
641 dev_err(dev, "%s:%s underrun cmd: %s buf_len: %d out_len: %d\n",
642 __func__, dimm_name, cmd_name, buf_len,
643 offset);
644 rc = -ENXIO;
645 }
646 } else {
647 rc = 0;
648 if (cmd_rc)
649 *cmd_rc = xlat_status(nvdimm, buf, cmd, fw_status);
650 }
651
652 out:
653 ACPI_FREE(out_obj);
654
655 return rc;
656}
657EXPORT_SYMBOL_GPL(acpi_nfit_ctl);
658
659static const char *spa_type_name(u16 type)
660{
661 static const char *to_name[] = {
662 [NFIT_SPA_VOLATILE] = "volatile",
663 [NFIT_SPA_PM] = "pmem",
664 [NFIT_SPA_DCR] = "dimm-control-region",
665 [NFIT_SPA_BDW] = "block-data-window",
666 [NFIT_SPA_VDISK] = "volatile-disk",
667 [NFIT_SPA_VCD] = "volatile-cd",
668 [NFIT_SPA_PDISK] = "persistent-disk",
669 [NFIT_SPA_PCD] = "persistent-cd",
670
671 };
672
673 if (type > NFIT_SPA_PCD)
674 return "unknown";
675
676 return to_name[type];
677}
678
679int nfit_spa_type(struct acpi_nfit_system_address *spa)
680{
681 guid_t guid;
682 int i;
683
684 import_guid(&guid, spa->range_guid);
685 for (i = 0; i < NFIT_UUID_MAX; i++)
686 if (guid_equal(to_nfit_uuid(i), &guid))
687 return i;
688 return -1;
689}
690
691static size_t sizeof_spa(struct acpi_nfit_system_address *spa)
692{
693 if (spa->flags & ACPI_NFIT_LOCATION_COOKIE_VALID)
694 return sizeof(*spa);
695 return sizeof(*spa) - 8;
696}
697
698static bool add_spa(struct acpi_nfit_desc *acpi_desc,
699 struct nfit_table_prev *prev,
700 struct acpi_nfit_system_address *spa)
701{
702 struct device *dev = acpi_desc->dev;
703 struct nfit_spa *nfit_spa;
704
705 if (spa->header.length != sizeof_spa(spa))
706 return false;
707
708 list_for_each_entry(nfit_spa, &prev->spas, list) {
709 if (memcmp(nfit_spa->spa, spa, sizeof_spa(spa)) == 0) {
710 list_move_tail(&nfit_spa->list, &acpi_desc->spas);
711 return true;
712 }
713 }
714
715 nfit_spa = devm_kzalloc(dev, sizeof(*nfit_spa) + sizeof_spa(spa),
716 GFP_KERNEL);
717 if (!nfit_spa)
718 return false;
719 INIT_LIST_HEAD(&nfit_spa->list);
720 memcpy(nfit_spa->spa, spa, sizeof_spa(spa));
721 list_add_tail(&nfit_spa->list, &acpi_desc->spas);
722 dev_dbg(dev, "spa index: %d type: %s\n",
723 spa->range_index,
724 spa_type_name(nfit_spa_type(spa)));
725 return true;
726}
727
728static bool add_memdev(struct acpi_nfit_desc *acpi_desc,
729 struct nfit_table_prev *prev,
730 struct acpi_nfit_memory_map *memdev)
731{
732 struct device *dev = acpi_desc->dev;
733 struct nfit_memdev *nfit_memdev;
734
735 if (memdev->header.length != sizeof(*memdev))
736 return false;
737
738 list_for_each_entry(nfit_memdev, &prev->memdevs, list)
739 if (memcmp(nfit_memdev->memdev, memdev, sizeof(*memdev)) == 0) {
740 list_move_tail(&nfit_memdev->list, &acpi_desc->memdevs);
741 return true;
742 }
743
744 nfit_memdev = devm_kzalloc(dev, sizeof(*nfit_memdev) + sizeof(*memdev),
745 GFP_KERNEL);
746 if (!nfit_memdev)
747 return false;
748 INIT_LIST_HEAD(&nfit_memdev->list);
749 memcpy(nfit_memdev->memdev, memdev, sizeof(*memdev));
750 list_add_tail(&nfit_memdev->list, &acpi_desc->memdevs);
751 dev_dbg(dev, "memdev handle: %#x spa: %d dcr: %d flags: %#x\n",
752 memdev->device_handle, memdev->range_index,
753 memdev->region_index, memdev->flags);
754 return true;
755}
756
757int nfit_get_smbios_id(u32 device_handle, u16 *flags)
758{
759 struct acpi_nfit_memory_map *memdev;
760 struct acpi_nfit_desc *acpi_desc;
761 struct nfit_mem *nfit_mem;
762 u16 physical_id;
763
764 mutex_lock(&acpi_desc_lock);
765 list_for_each_entry(acpi_desc, &acpi_descs, list) {
766 mutex_lock(&acpi_desc->init_mutex);
767 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
768 memdev = __to_nfit_memdev(nfit_mem);
769 if (memdev->device_handle == device_handle) {
770 *flags = memdev->flags;
771 physical_id = memdev->physical_id;
772 mutex_unlock(&acpi_desc->init_mutex);
773 mutex_unlock(&acpi_desc_lock);
774 return physical_id;
775 }
776 }
777 mutex_unlock(&acpi_desc->init_mutex);
778 }
779 mutex_unlock(&acpi_desc_lock);
780
781 return -ENODEV;
782}
783EXPORT_SYMBOL_GPL(nfit_get_smbios_id);
784
785/*
786 * An implementation may provide a truncated control region if no block windows
787 * are defined.
788 */
789static size_t sizeof_dcr(struct acpi_nfit_control_region *dcr)
790{
791 if (dcr->header.length < offsetof(struct acpi_nfit_control_region,
792 window_size))
793 return 0;
794 if (dcr->windows)
795 return sizeof(*dcr);
796 return offsetof(struct acpi_nfit_control_region, window_size);
797}
798
799static bool add_dcr(struct acpi_nfit_desc *acpi_desc,
800 struct nfit_table_prev *prev,
801 struct acpi_nfit_control_region *dcr)
802{
803 struct device *dev = acpi_desc->dev;
804 struct nfit_dcr *nfit_dcr;
805
806 if (!sizeof_dcr(dcr))
807 return false;
808
809 list_for_each_entry(nfit_dcr, &prev->dcrs, list)
810 if (memcmp(nfit_dcr->dcr, dcr, sizeof_dcr(dcr)) == 0) {
811 list_move_tail(&nfit_dcr->list, &acpi_desc->dcrs);
812 return true;
813 }
814
815 nfit_dcr = devm_kzalloc(dev, sizeof(*nfit_dcr) + sizeof(*dcr),
816 GFP_KERNEL);
817 if (!nfit_dcr)
818 return false;
819 INIT_LIST_HEAD(&nfit_dcr->list);
820 memcpy(nfit_dcr->dcr, dcr, sizeof_dcr(dcr));
821 list_add_tail(&nfit_dcr->list, &acpi_desc->dcrs);
822 dev_dbg(dev, "dcr index: %d windows: %d\n",
823 dcr->region_index, dcr->windows);
824 return true;
825}
826
827static bool add_bdw(struct acpi_nfit_desc *acpi_desc,
828 struct nfit_table_prev *prev,
829 struct acpi_nfit_data_region *bdw)
830{
831 struct device *dev = acpi_desc->dev;
832 struct nfit_bdw *nfit_bdw;
833
834 if (bdw->header.length != sizeof(*bdw))
835 return false;
836 list_for_each_entry(nfit_bdw, &prev->bdws, list)
837 if (memcmp(nfit_bdw->bdw, bdw, sizeof(*bdw)) == 0) {
838 list_move_tail(&nfit_bdw->list, &acpi_desc->bdws);
839 return true;
840 }
841
842 nfit_bdw = devm_kzalloc(dev, sizeof(*nfit_bdw) + sizeof(*bdw),
843 GFP_KERNEL);
844 if (!nfit_bdw)
845 return false;
846 INIT_LIST_HEAD(&nfit_bdw->list);
847 memcpy(nfit_bdw->bdw, bdw, sizeof(*bdw));
848 list_add_tail(&nfit_bdw->list, &acpi_desc->bdws);
849 dev_dbg(dev, "bdw dcr: %d windows: %d\n",
850 bdw->region_index, bdw->windows);
851 return true;
852}
853
854static size_t sizeof_idt(struct acpi_nfit_interleave *idt)
855{
856 if (idt->header.length < sizeof(*idt))
857 return 0;
858 return sizeof(*idt) + sizeof(u32) * idt->line_count;
859}
860
861static bool add_idt(struct acpi_nfit_desc *acpi_desc,
862 struct nfit_table_prev *prev,
863 struct acpi_nfit_interleave *idt)
864{
865 struct device *dev = acpi_desc->dev;
866 struct nfit_idt *nfit_idt;
867
868 if (!sizeof_idt(idt))
869 return false;
870
871 list_for_each_entry(nfit_idt, &prev->idts, list) {
872 if (sizeof_idt(nfit_idt->idt) != sizeof_idt(idt))
873 continue;
874
875 if (memcmp(nfit_idt->idt, idt, sizeof_idt(idt)) == 0) {
876 list_move_tail(&nfit_idt->list, &acpi_desc->idts);
877 return true;
878 }
879 }
880
881 nfit_idt = devm_kzalloc(dev, sizeof(*nfit_idt) + sizeof_idt(idt),
882 GFP_KERNEL);
883 if (!nfit_idt)
884 return false;
885 INIT_LIST_HEAD(&nfit_idt->list);
886 memcpy(nfit_idt->idt, idt, sizeof_idt(idt));
887 list_add_tail(&nfit_idt->list, &acpi_desc->idts);
888 dev_dbg(dev, "idt index: %d num_lines: %d\n",
889 idt->interleave_index, idt->line_count);
890 return true;
891}
892
893static size_t sizeof_flush(struct acpi_nfit_flush_address *flush)
894{
895 if (flush->header.length < sizeof(*flush))
896 return 0;
897 return struct_size(flush, hint_address, flush->hint_count);
898}
899
900static bool add_flush(struct acpi_nfit_desc *acpi_desc,
901 struct nfit_table_prev *prev,
902 struct acpi_nfit_flush_address *flush)
903{
904 struct device *dev = acpi_desc->dev;
905 struct nfit_flush *nfit_flush;
906
907 if (!sizeof_flush(flush))
908 return false;
909
910 list_for_each_entry(nfit_flush, &prev->flushes, list) {
911 if (sizeof_flush(nfit_flush->flush) != sizeof_flush(flush))
912 continue;
913
914 if (memcmp(nfit_flush->flush, flush,
915 sizeof_flush(flush)) == 0) {
916 list_move_tail(&nfit_flush->list, &acpi_desc->flushes);
917 return true;
918 }
919 }
920
921 nfit_flush = devm_kzalloc(dev, sizeof(*nfit_flush)
922 + sizeof_flush(flush), GFP_KERNEL);
923 if (!nfit_flush)
924 return false;
925 INIT_LIST_HEAD(&nfit_flush->list);
926 memcpy(nfit_flush->flush, flush, sizeof_flush(flush));
927 list_add_tail(&nfit_flush->list, &acpi_desc->flushes);
928 dev_dbg(dev, "nfit_flush handle: %d hint_count: %d\n",
929 flush->device_handle, flush->hint_count);
930 return true;
931}
932
933static bool add_platform_cap(struct acpi_nfit_desc *acpi_desc,
934 struct acpi_nfit_capabilities *pcap)
935{
936 struct device *dev = acpi_desc->dev;
937 u32 mask;
938
939 mask = (1 << (pcap->highest_capability + 1)) - 1;
940 acpi_desc->platform_cap = pcap->capabilities & mask;
941 dev_dbg(dev, "cap: %#x\n", acpi_desc->platform_cap);
942 return true;
943}
944
945static void *add_table(struct acpi_nfit_desc *acpi_desc,
946 struct nfit_table_prev *prev, void *table, const void *end)
947{
948 struct device *dev = acpi_desc->dev;
949 struct acpi_nfit_header *hdr;
950 void *err = ERR_PTR(-ENOMEM);
951
952 if (table >= end)
953 return NULL;
954
955 hdr = table;
956 if (!hdr->length) {
957 dev_warn(dev, "found a zero length table '%d' parsing nfit\n",
958 hdr->type);
959 return NULL;
960 }
961
962 switch (hdr->type) {
963 case ACPI_NFIT_TYPE_SYSTEM_ADDRESS:
964 if (!add_spa(acpi_desc, prev, table))
965 return err;
966 break;
967 case ACPI_NFIT_TYPE_MEMORY_MAP:
968 if (!add_memdev(acpi_desc, prev, table))
969 return err;
970 break;
971 case ACPI_NFIT_TYPE_CONTROL_REGION:
972 if (!add_dcr(acpi_desc, prev, table))
973 return err;
974 break;
975 case ACPI_NFIT_TYPE_DATA_REGION:
976 if (!add_bdw(acpi_desc, prev, table))
977 return err;
978 break;
979 case ACPI_NFIT_TYPE_INTERLEAVE:
980 if (!add_idt(acpi_desc, prev, table))
981 return err;
982 break;
983 case ACPI_NFIT_TYPE_FLUSH_ADDRESS:
984 if (!add_flush(acpi_desc, prev, table))
985 return err;
986 break;
987 case ACPI_NFIT_TYPE_SMBIOS:
988 dev_dbg(dev, "smbios\n");
989 break;
990 case ACPI_NFIT_TYPE_CAPABILITIES:
991 if (!add_platform_cap(acpi_desc, table))
992 return err;
993 break;
994 default:
995 dev_err(dev, "unknown table '%d' parsing nfit\n", hdr->type);
996 break;
997 }
998
999 return table + hdr->length;
1000}
1001
1002static int __nfit_mem_init(struct acpi_nfit_desc *acpi_desc,
1003 struct acpi_nfit_system_address *spa)
1004{
1005 struct nfit_mem *nfit_mem, *found;
1006 struct nfit_memdev *nfit_memdev;
1007 int type = spa ? nfit_spa_type(spa) : 0;
1008
1009 switch (type) {
1010 case NFIT_SPA_DCR:
1011 case NFIT_SPA_PM:
1012 break;
1013 default:
1014 if (spa)
1015 return 0;
1016 }
1017
1018 /*
1019 * This loop runs in two modes, when a dimm is mapped the loop
1020 * adds memdev associations to an existing dimm, or creates a
1021 * dimm. In the unmapped dimm case this loop sweeps for memdev
1022 * instances with an invalid / zero range_index and adds those
1023 * dimms without spa associations.
1024 */
1025 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
1026 struct nfit_flush *nfit_flush;
1027 struct nfit_dcr *nfit_dcr;
1028 u32 device_handle;
1029 u16 dcr;
1030
1031 if (spa && nfit_memdev->memdev->range_index != spa->range_index)
1032 continue;
1033 if (!spa && nfit_memdev->memdev->range_index)
1034 continue;
1035 found = NULL;
1036 dcr = nfit_memdev->memdev->region_index;
1037 device_handle = nfit_memdev->memdev->device_handle;
1038 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list)
1039 if (__to_nfit_memdev(nfit_mem)->device_handle
1040 == device_handle) {
1041 found = nfit_mem;
1042 break;
1043 }
1044
1045 if (found)
1046 nfit_mem = found;
1047 else {
1048 nfit_mem = devm_kzalloc(acpi_desc->dev,
1049 sizeof(*nfit_mem), GFP_KERNEL);
1050 if (!nfit_mem)
1051 return -ENOMEM;
1052 INIT_LIST_HEAD(&nfit_mem->list);
1053 nfit_mem->acpi_desc = acpi_desc;
1054 list_add(&nfit_mem->list, &acpi_desc->dimms);
1055 }
1056
1057 list_for_each_entry(nfit_dcr, &acpi_desc->dcrs, list) {
1058 if (nfit_dcr->dcr->region_index != dcr)
1059 continue;
1060 /*
1061 * Record the control region for the dimm. For
1062 * the ACPI 6.1 case, where there are separate
1063 * control regions for the pmem vs blk
1064 * interfaces, be sure to record the extended
1065 * blk details.
1066 */
1067 if (!nfit_mem->dcr)
1068 nfit_mem->dcr = nfit_dcr->dcr;
1069 else if (nfit_mem->dcr->windows == 0
1070 && nfit_dcr->dcr->windows)
1071 nfit_mem->dcr = nfit_dcr->dcr;
1072 break;
1073 }
1074
1075 list_for_each_entry(nfit_flush, &acpi_desc->flushes, list) {
1076 struct acpi_nfit_flush_address *flush;
1077 u16 i;
1078
1079 if (nfit_flush->flush->device_handle != device_handle)
1080 continue;
1081 nfit_mem->nfit_flush = nfit_flush;
1082 flush = nfit_flush->flush;
1083 nfit_mem->flush_wpq = devm_kcalloc(acpi_desc->dev,
1084 flush->hint_count,
1085 sizeof(struct resource),
1086 GFP_KERNEL);
1087 if (!nfit_mem->flush_wpq)
1088 return -ENOMEM;
1089 for (i = 0; i < flush->hint_count; i++) {
1090 struct resource *res = &nfit_mem->flush_wpq[i];
1091
1092 res->start = flush->hint_address[i];
1093 res->end = res->start + 8 - 1;
1094 }
1095 break;
1096 }
1097
1098 if (dcr && !nfit_mem->dcr) {
1099 dev_err(acpi_desc->dev, "SPA %d missing DCR %d\n",
1100 spa->range_index, dcr);
1101 return -ENODEV;
1102 }
1103
1104 if (type == NFIT_SPA_DCR) {
1105 struct nfit_idt *nfit_idt;
1106 u16 idt_idx;
1107
1108 /* multiple dimms may share a SPA when interleaved */
1109 nfit_mem->spa_dcr = spa;
1110 nfit_mem->memdev_dcr = nfit_memdev->memdev;
1111 idt_idx = nfit_memdev->memdev->interleave_index;
1112 list_for_each_entry(nfit_idt, &acpi_desc->idts, list) {
1113 if (nfit_idt->idt->interleave_index != idt_idx)
1114 continue;
1115 nfit_mem->idt_dcr = nfit_idt->idt;
1116 break;
1117 }
1118 } else if (type == NFIT_SPA_PM) {
1119 /*
1120 * A single dimm may belong to multiple SPA-PM
1121 * ranges, record at least one in addition to
1122 * any SPA-DCR range.
1123 */
1124 nfit_mem->memdev_pmem = nfit_memdev->memdev;
1125 } else
1126 nfit_mem->memdev_dcr = nfit_memdev->memdev;
1127 }
1128
1129 return 0;
1130}
1131
1132static int nfit_mem_cmp(void *priv, const struct list_head *_a,
1133 const struct list_head *_b)
1134{
1135 struct nfit_mem *a = container_of(_a, typeof(*a), list);
1136 struct nfit_mem *b = container_of(_b, typeof(*b), list);
1137 u32 handleA, handleB;
1138
1139 handleA = __to_nfit_memdev(a)->device_handle;
1140 handleB = __to_nfit_memdev(b)->device_handle;
1141 if (handleA < handleB)
1142 return -1;
1143 else if (handleA > handleB)
1144 return 1;
1145 return 0;
1146}
1147
1148static int nfit_mem_init(struct acpi_nfit_desc *acpi_desc)
1149{
1150 struct nfit_spa *nfit_spa;
1151 int rc;
1152
1153
1154 /*
1155 * For each SPA-DCR or SPA-PMEM address range find its
1156 * corresponding MEMDEV(s). From each MEMDEV find the
1157 * corresponding DCR. Then, if we're operating on a SPA-DCR,
1158 * try to find a SPA-BDW and a corresponding BDW that references
1159 * the DCR. Throw it all into an nfit_mem object. Note, that
1160 * BDWs are optional.
1161 */
1162 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
1163 rc = __nfit_mem_init(acpi_desc, nfit_spa->spa);
1164 if (rc)
1165 return rc;
1166 }
1167
1168 /*
1169 * If a DIMM has failed to be mapped into SPA there will be no
1170 * SPA entries above. Find and register all the unmapped DIMMs
1171 * for reporting and recovery purposes.
1172 */
1173 rc = __nfit_mem_init(acpi_desc, NULL);
1174 if (rc)
1175 return rc;
1176
1177 list_sort(NULL, &acpi_desc->dimms, nfit_mem_cmp);
1178
1179 return 0;
1180}
1181
1182static ssize_t bus_dsm_mask_show(struct device *dev,
1183 struct device_attribute *attr, char *buf)
1184{
1185 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
1186 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1187 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1188
1189 return sysfs_emit(buf, "%#lx\n", acpi_desc->bus_dsm_mask);
1190}
1191static struct device_attribute dev_attr_bus_dsm_mask =
1192 __ATTR(dsm_mask, 0444, bus_dsm_mask_show, NULL);
1193
1194static ssize_t revision_show(struct device *dev,
1195 struct device_attribute *attr, char *buf)
1196{
1197 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
1198 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1199 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1200
1201 return sysfs_emit(buf, "%d\n", acpi_desc->acpi_header.revision);
1202}
1203static DEVICE_ATTR_RO(revision);
1204
1205static ssize_t hw_error_scrub_show(struct device *dev,
1206 struct device_attribute *attr, char *buf)
1207{
1208 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
1209 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1210 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1211
1212 return sysfs_emit(buf, "%d\n", acpi_desc->scrub_mode);
1213}
1214
1215/*
1216 * The 'hw_error_scrub' attribute can have the following values written to it:
1217 * '0': Switch to the default mode where an exception will only insert
1218 * the address of the memory error into the poison and badblocks lists.
1219 * '1': Enable a full scrub to happen if an exception for a memory error is
1220 * received.
1221 */
1222static ssize_t hw_error_scrub_store(struct device *dev,
1223 struct device_attribute *attr, const char *buf, size_t size)
1224{
1225 struct nvdimm_bus_descriptor *nd_desc;
1226 ssize_t rc;
1227 long val;
1228
1229 rc = kstrtol(buf, 0, &val);
1230 if (rc)
1231 return rc;
1232
1233 device_lock(dev);
1234 nd_desc = dev_get_drvdata(dev);
1235 if (nd_desc) {
1236 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1237
1238 switch (val) {
1239 case HW_ERROR_SCRUB_ON:
1240 acpi_desc->scrub_mode = HW_ERROR_SCRUB_ON;
1241 break;
1242 case HW_ERROR_SCRUB_OFF:
1243 acpi_desc->scrub_mode = HW_ERROR_SCRUB_OFF;
1244 break;
1245 default:
1246 rc = -EINVAL;
1247 break;
1248 }
1249 }
1250 device_unlock(dev);
1251 if (rc)
1252 return rc;
1253 return size;
1254}
1255static DEVICE_ATTR_RW(hw_error_scrub);
1256
1257/*
1258 * This shows the number of full Address Range Scrubs that have been
1259 * completed since driver load time. Userspace can wait on this using
1260 * select/poll etc. A '+' at the end indicates an ARS is in progress
1261 */
1262static ssize_t scrub_show(struct device *dev,
1263 struct device_attribute *attr, char *buf)
1264{
1265 struct nvdimm_bus_descriptor *nd_desc;
1266 struct acpi_nfit_desc *acpi_desc;
1267 ssize_t rc = -ENXIO;
1268 bool busy;
1269
1270 device_lock(dev);
1271 nd_desc = dev_get_drvdata(dev);
1272 if (!nd_desc) {
1273 device_unlock(dev);
1274 return rc;
1275 }
1276 acpi_desc = to_acpi_desc(nd_desc);
1277
1278 mutex_lock(&acpi_desc->init_mutex);
1279 busy = test_bit(ARS_BUSY, &acpi_desc->scrub_flags)
1280 && !test_bit(ARS_CANCEL, &acpi_desc->scrub_flags);
1281 rc = sysfs_emit(buf, "%d%s", acpi_desc->scrub_count, busy ? "+\n" : "\n");
1282 /* Allow an admin to poll the busy state at a higher rate */
1283 if (busy && capable(CAP_SYS_RAWIO) && !test_and_set_bit(ARS_POLL,
1284 &acpi_desc->scrub_flags)) {
1285 acpi_desc->scrub_tmo = 1;
1286 mod_delayed_work(nfit_wq, &acpi_desc->dwork, HZ);
1287 }
1288
1289 mutex_unlock(&acpi_desc->init_mutex);
1290 device_unlock(dev);
1291 return rc;
1292}
1293
1294static ssize_t scrub_store(struct device *dev,
1295 struct device_attribute *attr, const char *buf, size_t size)
1296{
1297 struct nvdimm_bus_descriptor *nd_desc;
1298 ssize_t rc;
1299 long val;
1300
1301 rc = kstrtol(buf, 0, &val);
1302 if (rc)
1303 return rc;
1304 if (val != 1)
1305 return -EINVAL;
1306
1307 device_lock(dev);
1308 nd_desc = dev_get_drvdata(dev);
1309 if (nd_desc) {
1310 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
1311
1312 rc = acpi_nfit_ars_rescan(acpi_desc, ARS_REQ_LONG);
1313 }
1314 device_unlock(dev);
1315 if (rc)
1316 return rc;
1317 return size;
1318}
1319static DEVICE_ATTR_RW(scrub);
1320
1321static bool ars_supported(struct nvdimm_bus *nvdimm_bus)
1322{
1323 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
1324 const unsigned long mask = 1 << ND_CMD_ARS_CAP | 1 << ND_CMD_ARS_START
1325 | 1 << ND_CMD_ARS_STATUS;
1326
1327 return (nd_desc->cmd_mask & mask) == mask;
1328}
1329
1330static umode_t nfit_visible(struct kobject *kobj, struct attribute *a, int n)
1331{
1332 struct device *dev = kobj_to_dev(kobj);
1333 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
1334
1335 if (a == &dev_attr_scrub.attr)
1336 return ars_supported(nvdimm_bus) ? a->mode : 0;
1337
1338 if (a == &dev_attr_firmware_activate_noidle.attr)
1339 return intel_fwa_supported(nvdimm_bus) ? a->mode : 0;
1340
1341 return a->mode;
1342}
1343
1344static struct attribute *acpi_nfit_attributes[] = {
1345 &dev_attr_revision.attr,
1346 &dev_attr_scrub.attr,
1347 &dev_attr_hw_error_scrub.attr,
1348 &dev_attr_bus_dsm_mask.attr,
1349 &dev_attr_firmware_activate_noidle.attr,
1350 NULL,
1351};
1352
1353static const struct attribute_group acpi_nfit_attribute_group = {
1354 .name = "nfit",
1355 .attrs = acpi_nfit_attributes,
1356 .is_visible = nfit_visible,
1357};
1358
1359static const struct attribute_group *acpi_nfit_attribute_groups[] = {
1360 &acpi_nfit_attribute_group,
1361 NULL,
1362};
1363
1364static struct acpi_nfit_memory_map *to_nfit_memdev(struct device *dev)
1365{
1366 struct nvdimm *nvdimm = to_nvdimm(dev);
1367 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1368
1369 return __to_nfit_memdev(nfit_mem);
1370}
1371
1372static struct acpi_nfit_control_region *to_nfit_dcr(struct device *dev)
1373{
1374 struct nvdimm *nvdimm = to_nvdimm(dev);
1375 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1376
1377 return nfit_mem->dcr;
1378}
1379
1380static ssize_t handle_show(struct device *dev,
1381 struct device_attribute *attr, char *buf)
1382{
1383 struct acpi_nfit_memory_map *memdev = to_nfit_memdev(dev);
1384
1385 return sysfs_emit(buf, "%#x\n", memdev->device_handle);
1386}
1387static DEVICE_ATTR_RO(handle);
1388
1389static ssize_t phys_id_show(struct device *dev,
1390 struct device_attribute *attr, char *buf)
1391{
1392 struct acpi_nfit_memory_map *memdev = to_nfit_memdev(dev);
1393
1394 return sysfs_emit(buf, "%#x\n", memdev->physical_id);
1395}
1396static DEVICE_ATTR_RO(phys_id);
1397
1398static ssize_t vendor_show(struct device *dev,
1399 struct device_attribute *attr, char *buf)
1400{
1401 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1402
1403 return sysfs_emit(buf, "0x%04x\n", be16_to_cpu(dcr->vendor_id));
1404}
1405static DEVICE_ATTR_RO(vendor);
1406
1407static ssize_t rev_id_show(struct device *dev,
1408 struct device_attribute *attr, char *buf)
1409{
1410 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1411
1412 return sysfs_emit(buf, "0x%04x\n", be16_to_cpu(dcr->revision_id));
1413}
1414static DEVICE_ATTR_RO(rev_id);
1415
1416static ssize_t device_show(struct device *dev,
1417 struct device_attribute *attr, char *buf)
1418{
1419 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1420
1421 return sysfs_emit(buf, "0x%04x\n", be16_to_cpu(dcr->device_id));
1422}
1423static DEVICE_ATTR_RO(device);
1424
1425static ssize_t subsystem_vendor_show(struct device *dev,
1426 struct device_attribute *attr, char *buf)
1427{
1428 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1429
1430 return sysfs_emit(buf, "0x%04x\n", be16_to_cpu(dcr->subsystem_vendor_id));
1431}
1432static DEVICE_ATTR_RO(subsystem_vendor);
1433
1434static ssize_t subsystem_rev_id_show(struct device *dev,
1435 struct device_attribute *attr, char *buf)
1436{
1437 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1438
1439 return sysfs_emit(buf, "0x%04x\n",
1440 be16_to_cpu(dcr->subsystem_revision_id));
1441}
1442static DEVICE_ATTR_RO(subsystem_rev_id);
1443
1444static ssize_t subsystem_device_show(struct device *dev,
1445 struct device_attribute *attr, char *buf)
1446{
1447 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1448
1449 return sysfs_emit(buf, "0x%04x\n", be16_to_cpu(dcr->subsystem_device_id));
1450}
1451static DEVICE_ATTR_RO(subsystem_device);
1452
1453static int num_nvdimm_formats(struct nvdimm *nvdimm)
1454{
1455 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1456 int formats = 0;
1457
1458 if (nfit_mem->memdev_pmem)
1459 formats++;
1460 return formats;
1461}
1462
1463static ssize_t format_show(struct device *dev,
1464 struct device_attribute *attr, char *buf)
1465{
1466 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1467
1468 return sysfs_emit(buf, "0x%04x\n", le16_to_cpu(dcr->code));
1469}
1470static DEVICE_ATTR_RO(format);
1471
1472static ssize_t format1_show(struct device *dev,
1473 struct device_attribute *attr, char *buf)
1474{
1475 u32 handle;
1476 ssize_t rc = -ENXIO;
1477 struct nfit_mem *nfit_mem;
1478 struct nfit_memdev *nfit_memdev;
1479 struct acpi_nfit_desc *acpi_desc;
1480 struct nvdimm *nvdimm = to_nvdimm(dev);
1481 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1482
1483 nfit_mem = nvdimm_provider_data(nvdimm);
1484 acpi_desc = nfit_mem->acpi_desc;
1485 handle = to_nfit_memdev(dev)->device_handle;
1486
1487 /* assumes DIMMs have at most 2 published interface codes */
1488 mutex_lock(&acpi_desc->init_mutex);
1489 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
1490 struct acpi_nfit_memory_map *memdev = nfit_memdev->memdev;
1491 struct nfit_dcr *nfit_dcr;
1492
1493 if (memdev->device_handle != handle)
1494 continue;
1495
1496 list_for_each_entry(nfit_dcr, &acpi_desc->dcrs, list) {
1497 if (nfit_dcr->dcr->region_index != memdev->region_index)
1498 continue;
1499 if (nfit_dcr->dcr->code == dcr->code)
1500 continue;
1501 rc = sysfs_emit(buf, "0x%04x\n",
1502 le16_to_cpu(nfit_dcr->dcr->code));
1503 break;
1504 }
1505 if (rc != -ENXIO)
1506 break;
1507 }
1508 mutex_unlock(&acpi_desc->init_mutex);
1509 return rc;
1510}
1511static DEVICE_ATTR_RO(format1);
1512
1513static ssize_t formats_show(struct device *dev,
1514 struct device_attribute *attr, char *buf)
1515{
1516 struct nvdimm *nvdimm = to_nvdimm(dev);
1517
1518 return sysfs_emit(buf, "%d\n", num_nvdimm_formats(nvdimm));
1519}
1520static DEVICE_ATTR_RO(formats);
1521
1522static ssize_t serial_show(struct device *dev,
1523 struct device_attribute *attr, char *buf)
1524{
1525 struct acpi_nfit_control_region *dcr = to_nfit_dcr(dev);
1526
1527 return sysfs_emit(buf, "0x%08x\n", be32_to_cpu(dcr->serial_number));
1528}
1529static DEVICE_ATTR_RO(serial);
1530
1531static ssize_t family_show(struct device *dev,
1532 struct device_attribute *attr, char *buf)
1533{
1534 struct nvdimm *nvdimm = to_nvdimm(dev);
1535 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1536
1537 if (nfit_mem->family < 0)
1538 return -ENXIO;
1539 return sysfs_emit(buf, "%d\n", nfit_mem->family);
1540}
1541static DEVICE_ATTR_RO(family);
1542
1543static ssize_t dsm_mask_show(struct device *dev,
1544 struct device_attribute *attr, char *buf)
1545{
1546 struct nvdimm *nvdimm = to_nvdimm(dev);
1547 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1548
1549 if (nfit_mem->family < 0)
1550 return -ENXIO;
1551 return sysfs_emit(buf, "%#lx\n", nfit_mem->dsm_mask);
1552}
1553static DEVICE_ATTR_RO(dsm_mask);
1554
1555static ssize_t flags_show(struct device *dev,
1556 struct device_attribute *attr, char *buf)
1557{
1558 struct nvdimm *nvdimm = to_nvdimm(dev);
1559 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1560 u16 flags = __to_nfit_memdev(nfit_mem)->flags;
1561
1562 if (test_bit(NFIT_MEM_DIRTY, &nfit_mem->flags))
1563 flags |= ACPI_NFIT_MEM_FLUSH_FAILED;
1564
1565 return sysfs_emit(buf, "%s%s%s%s%s%s%s\n",
1566 flags & ACPI_NFIT_MEM_SAVE_FAILED ? "save_fail " : "",
1567 flags & ACPI_NFIT_MEM_RESTORE_FAILED ? "restore_fail " : "",
1568 flags & ACPI_NFIT_MEM_FLUSH_FAILED ? "flush_fail " : "",
1569 flags & ACPI_NFIT_MEM_NOT_ARMED ? "not_armed " : "",
1570 flags & ACPI_NFIT_MEM_HEALTH_OBSERVED ? "smart_event " : "",
1571 flags & ACPI_NFIT_MEM_MAP_FAILED ? "map_fail " : "",
1572 flags & ACPI_NFIT_MEM_HEALTH_ENABLED ? "smart_notify " : "");
1573}
1574static DEVICE_ATTR_RO(flags);
1575
1576static ssize_t id_show(struct device *dev,
1577 struct device_attribute *attr, char *buf)
1578{
1579 struct nvdimm *nvdimm = to_nvdimm(dev);
1580 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1581
1582 return sysfs_emit(buf, "%s\n", nfit_mem->id);
1583}
1584static DEVICE_ATTR_RO(id);
1585
1586static ssize_t dirty_shutdown_show(struct device *dev,
1587 struct device_attribute *attr, char *buf)
1588{
1589 struct nvdimm *nvdimm = to_nvdimm(dev);
1590 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1591
1592 return sysfs_emit(buf, "%d\n", nfit_mem->dirty_shutdown);
1593}
1594static DEVICE_ATTR_RO(dirty_shutdown);
1595
1596static struct attribute *acpi_nfit_dimm_attributes[] = {
1597 &dev_attr_handle.attr,
1598 &dev_attr_phys_id.attr,
1599 &dev_attr_vendor.attr,
1600 &dev_attr_device.attr,
1601 &dev_attr_rev_id.attr,
1602 &dev_attr_subsystem_vendor.attr,
1603 &dev_attr_subsystem_device.attr,
1604 &dev_attr_subsystem_rev_id.attr,
1605 &dev_attr_format.attr,
1606 &dev_attr_formats.attr,
1607 &dev_attr_format1.attr,
1608 &dev_attr_serial.attr,
1609 &dev_attr_flags.attr,
1610 &dev_attr_id.attr,
1611 &dev_attr_family.attr,
1612 &dev_attr_dsm_mask.attr,
1613 &dev_attr_dirty_shutdown.attr,
1614 NULL,
1615};
1616
1617static umode_t acpi_nfit_dimm_attr_visible(struct kobject *kobj,
1618 struct attribute *a, int n)
1619{
1620 struct device *dev = kobj_to_dev(kobj);
1621 struct nvdimm *nvdimm = to_nvdimm(dev);
1622 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
1623
1624 if (!to_nfit_dcr(dev)) {
1625 /* Without a dcr only the memdev attributes can be surfaced */
1626 if (a == &dev_attr_handle.attr || a == &dev_attr_phys_id.attr
1627 || a == &dev_attr_flags.attr
1628 || a == &dev_attr_family.attr
1629 || a == &dev_attr_dsm_mask.attr)
1630 return a->mode;
1631 return 0;
1632 }
1633
1634 if (a == &dev_attr_format1.attr && num_nvdimm_formats(nvdimm) <= 1)
1635 return 0;
1636
1637 if (!test_bit(NFIT_MEM_DIRTY_COUNT, &nfit_mem->flags)
1638 && a == &dev_attr_dirty_shutdown.attr)
1639 return 0;
1640
1641 return a->mode;
1642}
1643
1644static const struct attribute_group acpi_nfit_dimm_attribute_group = {
1645 .name = "nfit",
1646 .attrs = acpi_nfit_dimm_attributes,
1647 .is_visible = acpi_nfit_dimm_attr_visible,
1648};
1649
1650static const struct attribute_group *acpi_nfit_dimm_attribute_groups[] = {
1651 &acpi_nfit_dimm_attribute_group,
1652 NULL,
1653};
1654
1655static struct nvdimm *acpi_nfit_dimm_by_handle(struct acpi_nfit_desc *acpi_desc,
1656 u32 device_handle)
1657{
1658 struct nfit_mem *nfit_mem;
1659
1660 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list)
1661 if (__to_nfit_memdev(nfit_mem)->device_handle == device_handle)
1662 return nfit_mem->nvdimm;
1663
1664 return NULL;
1665}
1666
1667void __acpi_nvdimm_notify(struct device *dev, u32 event)
1668{
1669 struct nfit_mem *nfit_mem;
1670 struct acpi_nfit_desc *acpi_desc;
1671
1672 dev_dbg(dev->parent, "%s: event: %d\n", dev_name(dev),
1673 event);
1674
1675 if (event != NFIT_NOTIFY_DIMM_HEALTH) {
1676 dev_dbg(dev->parent, "%s: unknown event: %d\n", dev_name(dev),
1677 event);
1678 return;
1679 }
1680
1681 acpi_desc = dev_get_drvdata(dev->parent);
1682 if (!acpi_desc)
1683 return;
1684
1685 /*
1686 * If we successfully retrieved acpi_desc, then we know nfit_mem data
1687 * is still valid.
1688 */
1689 nfit_mem = dev_get_drvdata(dev);
1690 if (nfit_mem && nfit_mem->flags_attr)
1691 sysfs_notify_dirent(nfit_mem->flags_attr);
1692}
1693EXPORT_SYMBOL_GPL(__acpi_nvdimm_notify);
1694
1695static void acpi_nvdimm_notify(acpi_handle handle, u32 event, void *data)
1696{
1697 struct acpi_device *adev = data;
1698 struct device *dev = &adev->dev;
1699
1700 device_lock(dev->parent);
1701 __acpi_nvdimm_notify(dev, event);
1702 device_unlock(dev->parent);
1703}
1704
1705static bool acpi_nvdimm_has_method(struct acpi_device *adev, char *method)
1706{
1707 acpi_handle handle;
1708 acpi_status status;
1709
1710 status = acpi_get_handle(adev->handle, method, &handle);
1711
1712 if (ACPI_SUCCESS(status))
1713 return true;
1714 return false;
1715}
1716
1717__weak void nfit_intel_shutdown_status(struct nfit_mem *nfit_mem)
1718{
1719 struct device *dev = &nfit_mem->adev->dev;
1720 struct nd_intel_smart smart = { 0 };
1721 union acpi_object in_buf = {
1722 .buffer.type = ACPI_TYPE_BUFFER,
1723 .buffer.length = 0,
1724 };
1725 union acpi_object in_obj = {
1726 .package.type = ACPI_TYPE_PACKAGE,
1727 .package.count = 1,
1728 .package.elements = &in_buf,
1729 };
1730 const u8 func = ND_INTEL_SMART;
1731 const guid_t *guid = to_nfit_uuid(nfit_mem->family);
1732 u8 revid = nfit_dsm_revid(nfit_mem->family, func);
1733 struct acpi_device *adev = nfit_mem->adev;
1734 acpi_handle handle = adev->handle;
1735 union acpi_object *out_obj;
1736
1737 if ((nfit_mem->dsm_mask & (1 << func)) == 0)
1738 return;
1739
1740 out_obj = acpi_evaluate_dsm(handle, guid, revid, func, &in_obj);
1741 if (!out_obj || out_obj->type != ACPI_TYPE_BUFFER
1742 || out_obj->buffer.length < sizeof(smart)) {
1743 dev_dbg(dev->parent, "%s: failed to retrieve initial health\n",
1744 dev_name(dev));
1745 ACPI_FREE(out_obj);
1746 return;
1747 }
1748 memcpy(&smart, out_obj->buffer.pointer, sizeof(smart));
1749 ACPI_FREE(out_obj);
1750
1751 if (smart.flags & ND_INTEL_SMART_SHUTDOWN_VALID) {
1752 if (smart.shutdown_state)
1753 set_bit(NFIT_MEM_DIRTY, &nfit_mem->flags);
1754 }
1755
1756 if (smart.flags & ND_INTEL_SMART_SHUTDOWN_COUNT_VALID) {
1757 set_bit(NFIT_MEM_DIRTY_COUNT, &nfit_mem->flags);
1758 nfit_mem->dirty_shutdown = smart.shutdown_count;
1759 }
1760}
1761
1762static void populate_shutdown_status(struct nfit_mem *nfit_mem)
1763{
1764 /*
1765 * For DIMMs that provide a dynamic facility to retrieve a
1766 * dirty-shutdown status and/or a dirty-shutdown count, cache
1767 * these values in nfit_mem.
1768 */
1769 if (nfit_mem->family == NVDIMM_FAMILY_INTEL)
1770 nfit_intel_shutdown_status(nfit_mem);
1771}
1772
1773static int acpi_nfit_add_dimm(struct acpi_nfit_desc *acpi_desc,
1774 struct nfit_mem *nfit_mem, u32 device_handle)
1775{
1776 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
1777 struct acpi_device *adev, *adev_dimm;
1778 struct device *dev = acpi_desc->dev;
1779 unsigned long dsm_mask, label_mask;
1780 const guid_t *guid;
1781 int i;
1782 int family = -1;
1783 struct acpi_nfit_control_region *dcr = nfit_mem->dcr;
1784
1785 /* nfit test assumes 1:1 relationship between commands and dsms */
1786 nfit_mem->dsm_mask = acpi_desc->dimm_cmd_force_en;
1787 nfit_mem->family = NVDIMM_FAMILY_INTEL;
1788 set_bit(NVDIMM_FAMILY_INTEL, &nd_desc->dimm_family_mask);
1789
1790 if (dcr->valid_fields & ACPI_NFIT_CONTROL_MFG_INFO_VALID)
1791 sprintf(nfit_mem->id, "%04x-%02x-%04x-%08x",
1792 be16_to_cpu(dcr->vendor_id),
1793 dcr->manufacturing_location,
1794 be16_to_cpu(dcr->manufacturing_date),
1795 be32_to_cpu(dcr->serial_number));
1796 else
1797 sprintf(nfit_mem->id, "%04x-%08x",
1798 be16_to_cpu(dcr->vendor_id),
1799 be32_to_cpu(dcr->serial_number));
1800
1801 adev = to_acpi_dev(acpi_desc);
1802 if (!adev) {
1803 /* unit test case */
1804 populate_shutdown_status(nfit_mem);
1805 return 0;
1806 }
1807
1808 adev_dimm = acpi_find_child_device(adev, device_handle, false);
1809 nfit_mem->adev = adev_dimm;
1810 if (!adev_dimm) {
1811 dev_err(dev, "no ACPI.NFIT device with _ADR %#x, disabling...\n",
1812 device_handle);
1813 return force_enable_dimms ? 0 : -ENODEV;
1814 }
1815
1816 if (ACPI_FAILURE(acpi_install_notify_handler(adev_dimm->handle,
1817 ACPI_DEVICE_NOTIFY, acpi_nvdimm_notify, adev_dimm))) {
1818 dev_err(dev, "%s: notification registration failed\n",
1819 dev_name(&adev_dimm->dev));
1820 return -ENXIO;
1821 }
1822 /*
1823 * Record nfit_mem for the notification path to track back to
1824 * the nfit sysfs attributes for this dimm device object.
1825 */
1826 dev_set_drvdata(&adev_dimm->dev, nfit_mem);
1827
1828 /*
1829 * There are 4 "legacy" NVDIMM command sets
1830 * (NVDIMM_FAMILY_{INTEL,MSFT,HPE1,HPE2}) that were created before
1831 * an EFI working group was established to constrain this
1832 * proliferation. The nfit driver probes for the supported command
1833 * set by GUID. Note, if you're a platform developer looking to add
1834 * a new command set to this probe, consider using an existing set,
1835 * or otherwise seek approval to publish the command set at
1836 * http://www.uefi.org/RFIC_LIST.
1837 *
1838 * Note, that checking for function0 (bit0) tells us if any commands
1839 * are reachable through this GUID.
1840 */
1841 clear_bit(NVDIMM_FAMILY_INTEL, &nd_desc->dimm_family_mask);
1842 for (i = 0; i <= NVDIMM_FAMILY_MAX; i++)
1843 if (acpi_check_dsm(adev_dimm->handle, to_nfit_uuid(i), 1, 1)) {
1844 set_bit(i, &nd_desc->dimm_family_mask);
1845 if (family < 0 || i == default_dsm_family)
1846 family = i;
1847 }
1848
1849 /* limit the supported commands to those that are publicly documented */
1850 nfit_mem->family = family;
1851 if (override_dsm_mask && !disable_vendor_specific)
1852 dsm_mask = override_dsm_mask;
1853 else if (nfit_mem->family == NVDIMM_FAMILY_INTEL) {
1854 dsm_mask = NVDIMM_INTEL_CMDMASK;
1855 if (disable_vendor_specific)
1856 dsm_mask &= ~(1 << ND_CMD_VENDOR);
1857 } else if (nfit_mem->family == NVDIMM_FAMILY_HPE1) {
1858 dsm_mask = 0x1c3c76;
1859 } else if (nfit_mem->family == NVDIMM_FAMILY_HPE2) {
1860 dsm_mask = 0x1fe;
1861 if (disable_vendor_specific)
1862 dsm_mask &= ~(1 << 8);
1863 } else if (nfit_mem->family == NVDIMM_FAMILY_MSFT) {
1864 dsm_mask = 0xffffffff;
1865 } else if (nfit_mem->family == NVDIMM_FAMILY_HYPERV) {
1866 dsm_mask = 0x1f;
1867 } else {
1868 dev_dbg(dev, "unknown dimm command family\n");
1869 nfit_mem->family = -1;
1870 /* DSMs are optional, continue loading the driver... */
1871 return 0;
1872 }
1873
1874 /*
1875 * Function 0 is the command interrogation function, don't
1876 * export it to potential userspace use, and enable it to be
1877 * used as an error value in acpi_nfit_ctl().
1878 */
1879 dsm_mask &= ~1UL;
1880
1881 guid = to_nfit_uuid(nfit_mem->family);
1882 for_each_set_bit(i, &dsm_mask, BITS_PER_LONG)
1883 if (acpi_check_dsm(adev_dimm->handle, guid,
1884 nfit_dsm_revid(nfit_mem->family, i),
1885 1ULL << i))
1886 set_bit(i, &nfit_mem->dsm_mask);
1887
1888 /*
1889 * Prefer the NVDIMM_FAMILY_INTEL label read commands if present
1890 * due to their better semantics handling locked capacity.
1891 */
1892 label_mask = 1 << ND_CMD_GET_CONFIG_SIZE | 1 << ND_CMD_GET_CONFIG_DATA
1893 | 1 << ND_CMD_SET_CONFIG_DATA;
1894 if (family == NVDIMM_FAMILY_INTEL
1895 && (dsm_mask & label_mask) == label_mask)
1896 /* skip _LS{I,R,W} enabling */;
1897 else {
1898 if (acpi_nvdimm_has_method(adev_dimm, "_LSI")
1899 && acpi_nvdimm_has_method(adev_dimm, "_LSR")) {
1900 dev_dbg(dev, "%s: has _LSR\n", dev_name(&adev_dimm->dev));
1901 set_bit(NFIT_MEM_LSR, &nfit_mem->flags);
1902 }
1903
1904 if (test_bit(NFIT_MEM_LSR, &nfit_mem->flags)
1905 && acpi_nvdimm_has_method(adev_dimm, "_LSW")) {
1906 dev_dbg(dev, "%s: has _LSW\n", dev_name(&adev_dimm->dev));
1907 set_bit(NFIT_MEM_LSW, &nfit_mem->flags);
1908 }
1909
1910 /*
1911 * Quirk read-only label configurations to preserve
1912 * access to label-less namespaces by default.
1913 */
1914 if (!test_bit(NFIT_MEM_LSW, &nfit_mem->flags)
1915 && !force_labels) {
1916 dev_dbg(dev, "%s: No _LSW, disable labels\n",
1917 dev_name(&adev_dimm->dev));
1918 clear_bit(NFIT_MEM_LSR, &nfit_mem->flags);
1919 } else
1920 dev_dbg(dev, "%s: Force enable labels\n",
1921 dev_name(&adev_dimm->dev));
1922 }
1923
1924 populate_shutdown_status(nfit_mem);
1925
1926 return 0;
1927}
1928
1929static void shutdown_dimm_notify(void *data)
1930{
1931 struct acpi_nfit_desc *acpi_desc = data;
1932 struct nfit_mem *nfit_mem;
1933
1934 mutex_lock(&acpi_desc->init_mutex);
1935 /*
1936 * Clear out the nfit_mem->flags_attr and shut down dimm event
1937 * notifications.
1938 */
1939 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
1940 struct acpi_device *adev_dimm = nfit_mem->adev;
1941
1942 if (nfit_mem->flags_attr) {
1943 sysfs_put(nfit_mem->flags_attr);
1944 nfit_mem->flags_attr = NULL;
1945 }
1946 if (adev_dimm) {
1947 acpi_remove_notify_handler(adev_dimm->handle,
1948 ACPI_DEVICE_NOTIFY, acpi_nvdimm_notify);
1949 dev_set_drvdata(&adev_dimm->dev, NULL);
1950 }
1951 }
1952 mutex_unlock(&acpi_desc->init_mutex);
1953}
1954
1955static const struct nvdimm_security_ops *acpi_nfit_get_security_ops(int family)
1956{
1957 switch (family) {
1958 case NVDIMM_FAMILY_INTEL:
1959 return intel_security_ops;
1960 default:
1961 return NULL;
1962 }
1963}
1964
1965static const struct nvdimm_fw_ops *acpi_nfit_get_fw_ops(
1966 struct nfit_mem *nfit_mem)
1967{
1968 unsigned long mask;
1969 struct acpi_nfit_desc *acpi_desc = nfit_mem->acpi_desc;
1970 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
1971
1972 if (!nd_desc->fw_ops)
1973 return NULL;
1974
1975 if (nfit_mem->family != NVDIMM_FAMILY_INTEL)
1976 return NULL;
1977
1978 mask = nfit_mem->dsm_mask & NVDIMM_INTEL_FW_ACTIVATE_CMDMASK;
1979 if (mask != NVDIMM_INTEL_FW_ACTIVATE_CMDMASK)
1980 return NULL;
1981
1982 return intel_fw_ops;
1983}
1984
1985static int acpi_nfit_register_dimms(struct acpi_nfit_desc *acpi_desc)
1986{
1987 struct nfit_mem *nfit_mem;
1988 int dimm_count = 0, rc;
1989 struct nvdimm *nvdimm;
1990
1991 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
1992 struct acpi_nfit_flush_address *flush;
1993 unsigned long flags = 0, cmd_mask;
1994 struct nfit_memdev *nfit_memdev;
1995 u32 device_handle;
1996 u16 mem_flags;
1997
1998 device_handle = __to_nfit_memdev(nfit_mem)->device_handle;
1999 nvdimm = acpi_nfit_dimm_by_handle(acpi_desc, device_handle);
2000 if (nvdimm) {
2001 dimm_count++;
2002 continue;
2003 }
2004
2005 /* collate flags across all memdevs for this dimm */
2006 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
2007 struct acpi_nfit_memory_map *dimm_memdev;
2008
2009 dimm_memdev = __to_nfit_memdev(nfit_mem);
2010 if (dimm_memdev->device_handle
2011 != nfit_memdev->memdev->device_handle)
2012 continue;
2013 dimm_memdev->flags |= nfit_memdev->memdev->flags;
2014 }
2015
2016 mem_flags = __to_nfit_memdev(nfit_mem)->flags;
2017 if (mem_flags & ACPI_NFIT_MEM_NOT_ARMED)
2018 set_bit(NDD_UNARMED, &flags);
2019
2020 rc = acpi_nfit_add_dimm(acpi_desc, nfit_mem, device_handle);
2021 if (rc)
2022 continue;
2023
2024 /*
2025 * TODO: provide translation for non-NVDIMM_FAMILY_INTEL
2026 * devices (i.e. from nd_cmd to acpi_dsm) to standardize the
2027 * userspace interface.
2028 */
2029 cmd_mask = 1UL << ND_CMD_CALL;
2030 if (nfit_mem->family == NVDIMM_FAMILY_INTEL) {
2031 /*
2032 * These commands have a 1:1 correspondence
2033 * between DSM payload and libnvdimm ioctl
2034 * payload format.
2035 */
2036 cmd_mask |= nfit_mem->dsm_mask & NVDIMM_STANDARD_CMDMASK;
2037 }
2038
2039 if (test_bit(NFIT_MEM_LSR, &nfit_mem->flags)) {
2040 set_bit(ND_CMD_GET_CONFIG_SIZE, &cmd_mask);
2041 set_bit(ND_CMD_GET_CONFIG_DATA, &cmd_mask);
2042 }
2043 if (test_bit(NFIT_MEM_LSW, &nfit_mem->flags))
2044 set_bit(ND_CMD_SET_CONFIG_DATA, &cmd_mask);
2045
2046 flush = nfit_mem->nfit_flush ? nfit_mem->nfit_flush->flush
2047 : NULL;
2048 nvdimm = __nvdimm_create(acpi_desc->nvdimm_bus, nfit_mem,
2049 acpi_nfit_dimm_attribute_groups,
2050 flags, cmd_mask, flush ? flush->hint_count : 0,
2051 nfit_mem->flush_wpq, &nfit_mem->id[0],
2052 acpi_nfit_get_security_ops(nfit_mem->family),
2053 acpi_nfit_get_fw_ops(nfit_mem));
2054 if (!nvdimm)
2055 return -ENOMEM;
2056
2057 nfit_mem->nvdimm = nvdimm;
2058 dimm_count++;
2059
2060 if ((mem_flags & ACPI_NFIT_MEM_FAILED_MASK) == 0)
2061 continue;
2062
2063 dev_err(acpi_desc->dev, "Error found in NVDIMM %s flags:%s%s%s%s%s\n",
2064 nvdimm_name(nvdimm),
2065 mem_flags & ACPI_NFIT_MEM_SAVE_FAILED ? " save_fail" : "",
2066 mem_flags & ACPI_NFIT_MEM_RESTORE_FAILED ? " restore_fail":"",
2067 mem_flags & ACPI_NFIT_MEM_FLUSH_FAILED ? " flush_fail" : "",
2068 mem_flags & ACPI_NFIT_MEM_NOT_ARMED ? " not_armed" : "",
2069 mem_flags & ACPI_NFIT_MEM_MAP_FAILED ? " map_fail" : "");
2070
2071 }
2072
2073 rc = nvdimm_bus_check_dimm_count(acpi_desc->nvdimm_bus, dimm_count);
2074 if (rc)
2075 return rc;
2076
2077 /*
2078 * Now that dimms are successfully registered, and async registration
2079 * is flushed, attempt to enable event notification.
2080 */
2081 list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
2082 struct kernfs_node *nfit_kernfs;
2083
2084 nvdimm = nfit_mem->nvdimm;
2085 if (!nvdimm)
2086 continue;
2087
2088 nfit_kernfs = sysfs_get_dirent(nvdimm_kobj(nvdimm)->sd, "nfit");
2089 if (nfit_kernfs)
2090 nfit_mem->flags_attr = sysfs_get_dirent(nfit_kernfs,
2091 "flags");
2092 sysfs_put(nfit_kernfs);
2093 if (!nfit_mem->flags_attr)
2094 dev_warn(acpi_desc->dev, "%s: notifications disabled\n",
2095 nvdimm_name(nvdimm));
2096 }
2097
2098 return devm_add_action_or_reset(acpi_desc->dev, shutdown_dimm_notify,
2099 acpi_desc);
2100}
2101
2102/*
2103 * These constants are private because there are no kernel consumers of
2104 * these commands.
2105 */
2106enum nfit_aux_cmds {
2107 NFIT_CMD_TRANSLATE_SPA = 5,
2108 NFIT_CMD_ARS_INJECT_SET = 7,
2109 NFIT_CMD_ARS_INJECT_CLEAR = 8,
2110 NFIT_CMD_ARS_INJECT_GET = 9,
2111};
2112
2113static void acpi_nfit_init_dsms(struct acpi_nfit_desc *acpi_desc)
2114{
2115 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2116 const guid_t *guid = to_nfit_uuid(NFIT_DEV_BUS);
2117 unsigned long dsm_mask, *mask;
2118 struct acpi_device *adev;
2119 int i;
2120
2121 set_bit(ND_CMD_CALL, &nd_desc->cmd_mask);
2122 set_bit(NVDIMM_BUS_FAMILY_NFIT, &nd_desc->bus_family_mask);
2123
2124 /* enable nfit_test to inject bus command emulation */
2125 if (acpi_desc->bus_cmd_force_en) {
2126 nd_desc->cmd_mask = acpi_desc->bus_cmd_force_en;
2127 mask = &nd_desc->bus_family_mask;
2128 if (acpi_desc->family_dsm_mask[NVDIMM_BUS_FAMILY_INTEL]) {
2129 set_bit(NVDIMM_BUS_FAMILY_INTEL, mask);
2130 nd_desc->fw_ops = intel_bus_fw_ops;
2131 }
2132 }
2133
2134 adev = to_acpi_dev(acpi_desc);
2135 if (!adev)
2136 return;
2137
2138 for (i = ND_CMD_ARS_CAP; i <= ND_CMD_CLEAR_ERROR; i++)
2139 if (acpi_check_dsm(adev->handle, guid, 1, 1ULL << i))
2140 set_bit(i, &nd_desc->cmd_mask);
2141
2142 dsm_mask =
2143 (1 << ND_CMD_ARS_CAP) |
2144 (1 << ND_CMD_ARS_START) |
2145 (1 << ND_CMD_ARS_STATUS) |
2146 (1 << ND_CMD_CLEAR_ERROR) |
2147 (1 << NFIT_CMD_TRANSLATE_SPA) |
2148 (1 << NFIT_CMD_ARS_INJECT_SET) |
2149 (1 << NFIT_CMD_ARS_INJECT_CLEAR) |
2150 (1 << NFIT_CMD_ARS_INJECT_GET);
2151 for_each_set_bit(i, &dsm_mask, BITS_PER_LONG)
2152 if (acpi_check_dsm(adev->handle, guid, 1, 1ULL << i))
2153 set_bit(i, &acpi_desc->bus_dsm_mask);
2154
2155 /* Enumerate allowed NVDIMM_BUS_FAMILY_INTEL commands */
2156 dsm_mask = NVDIMM_BUS_INTEL_FW_ACTIVATE_CMDMASK;
2157 guid = to_nfit_bus_uuid(NVDIMM_BUS_FAMILY_INTEL);
2158 mask = &acpi_desc->family_dsm_mask[NVDIMM_BUS_FAMILY_INTEL];
2159 for_each_set_bit(i, &dsm_mask, BITS_PER_LONG)
2160 if (acpi_check_dsm(adev->handle, guid, 1, 1ULL << i))
2161 set_bit(i, mask);
2162
2163 if (*mask == dsm_mask) {
2164 set_bit(NVDIMM_BUS_FAMILY_INTEL, &nd_desc->bus_family_mask);
2165 nd_desc->fw_ops = intel_bus_fw_ops;
2166 }
2167}
2168
2169static ssize_t range_index_show(struct device *dev,
2170 struct device_attribute *attr, char *buf)
2171{
2172 struct nd_region *nd_region = to_nd_region(dev);
2173 struct nfit_spa *nfit_spa = nd_region_provider_data(nd_region);
2174
2175 return sysfs_emit(buf, "%d\n", nfit_spa->spa->range_index);
2176}
2177static DEVICE_ATTR_RO(range_index);
2178
2179static struct attribute *acpi_nfit_region_attributes[] = {
2180 &dev_attr_range_index.attr,
2181 NULL,
2182};
2183
2184static const struct attribute_group acpi_nfit_region_attribute_group = {
2185 .name = "nfit",
2186 .attrs = acpi_nfit_region_attributes,
2187};
2188
2189static const struct attribute_group *acpi_nfit_region_attribute_groups[] = {
2190 &acpi_nfit_region_attribute_group,
2191 NULL,
2192};
2193
2194/* enough info to uniquely specify an interleave set */
2195struct nfit_set_info {
2196 u64 region_offset;
2197 u32 serial_number;
2198 u32 pad;
2199};
2200
2201struct nfit_set_info2 {
2202 u64 region_offset;
2203 u32 serial_number;
2204 u16 vendor_id;
2205 u16 manufacturing_date;
2206 u8 manufacturing_location;
2207 u8 reserved[31];
2208};
2209
2210static int cmp_map_compat(const void *m0, const void *m1)
2211{
2212 const struct nfit_set_info *map0 = m0;
2213 const struct nfit_set_info *map1 = m1;
2214
2215 return memcmp(&map0->region_offset, &map1->region_offset,
2216 sizeof(u64));
2217}
2218
2219static int cmp_map(const void *m0, const void *m1)
2220{
2221 const struct nfit_set_info *map0 = m0;
2222 const struct nfit_set_info *map1 = m1;
2223
2224 if (map0->region_offset < map1->region_offset)
2225 return -1;
2226 else if (map0->region_offset > map1->region_offset)
2227 return 1;
2228 return 0;
2229}
2230
2231static int cmp_map2(const void *m0, const void *m1)
2232{
2233 const struct nfit_set_info2 *map0 = m0;
2234 const struct nfit_set_info2 *map1 = m1;
2235
2236 if (map0->region_offset < map1->region_offset)
2237 return -1;
2238 else if (map0->region_offset > map1->region_offset)
2239 return 1;
2240 return 0;
2241}
2242
2243/* Retrieve the nth entry referencing this spa */
2244static struct acpi_nfit_memory_map *memdev_from_spa(
2245 struct acpi_nfit_desc *acpi_desc, u16 range_index, int n)
2246{
2247 struct nfit_memdev *nfit_memdev;
2248
2249 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list)
2250 if (nfit_memdev->memdev->range_index == range_index)
2251 if (n-- == 0)
2252 return nfit_memdev->memdev;
2253 return NULL;
2254}
2255
2256static int acpi_nfit_init_interleave_set(struct acpi_nfit_desc *acpi_desc,
2257 struct nd_region_desc *ndr_desc,
2258 struct acpi_nfit_system_address *spa)
2259{
2260 u16 nr = ndr_desc->num_mappings;
2261 struct nfit_set_info2 *info2 __free(kfree) =
2262 kcalloc(nr, sizeof(*info2), GFP_KERNEL);
2263 struct nfit_set_info *info __free(kfree) =
2264 kcalloc(nr, sizeof(*info), GFP_KERNEL);
2265 struct device *dev = acpi_desc->dev;
2266 struct nd_interleave_set *nd_set;
2267 int i;
2268
2269 if (!info || !info2)
2270 return -ENOMEM;
2271
2272 nd_set = devm_kzalloc(dev, sizeof(*nd_set), GFP_KERNEL);
2273 if (!nd_set)
2274 return -ENOMEM;
2275 import_guid(&nd_set->type_guid, spa->range_guid);
2276
2277 for (i = 0; i < nr; i++) {
2278 struct nd_mapping_desc *mapping = &ndr_desc->mapping[i];
2279 struct nvdimm *nvdimm = mapping->nvdimm;
2280 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
2281 struct nfit_set_info *map = &info[i];
2282 struct nfit_set_info2 *map2 = &info2[i];
2283 struct acpi_nfit_memory_map *memdev =
2284 memdev_from_spa(acpi_desc, spa->range_index, i);
2285 struct acpi_nfit_control_region *dcr = nfit_mem->dcr;
2286
2287 if (!memdev || !nfit_mem->dcr) {
2288 dev_err(dev, "%s: failed to find DCR\n", __func__);
2289 return -ENODEV;
2290 }
2291
2292 map->region_offset = memdev->region_offset;
2293 map->serial_number = dcr->serial_number;
2294
2295 map2->region_offset = memdev->region_offset;
2296 map2->serial_number = dcr->serial_number;
2297 map2->vendor_id = dcr->vendor_id;
2298 map2->manufacturing_date = dcr->manufacturing_date;
2299 map2->manufacturing_location = dcr->manufacturing_location;
2300 }
2301
2302 /* v1.1 namespaces */
2303 sort(info, nr, sizeof(*info), cmp_map, NULL);
2304 nd_set->cookie1 = nd_fletcher64(info, sizeof(*info) * nr, 0);
2305
2306 /* v1.2 namespaces */
2307 sort(info2, nr, sizeof(*info2), cmp_map2, NULL);
2308 nd_set->cookie2 = nd_fletcher64(info2, sizeof(*info2) * nr, 0);
2309
2310 /* support v1.1 namespaces created with the wrong sort order */
2311 sort(info, nr, sizeof(*info), cmp_map_compat, NULL);
2312 nd_set->altcookie = nd_fletcher64(info, sizeof(*info) * nr, 0);
2313
2314 /* record the result of the sort for the mapping position */
2315 for (i = 0; i < nr; i++) {
2316 struct nfit_set_info2 *map2 = &info2[i];
2317 int j;
2318
2319 for (j = 0; j < nr; j++) {
2320 struct nd_mapping_desc *mapping = &ndr_desc->mapping[j];
2321 struct nvdimm *nvdimm = mapping->nvdimm;
2322 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
2323 struct acpi_nfit_control_region *dcr = nfit_mem->dcr;
2324
2325 if (map2->serial_number == dcr->serial_number &&
2326 map2->vendor_id == dcr->vendor_id &&
2327 map2->manufacturing_date == dcr->manufacturing_date &&
2328 map2->manufacturing_location
2329 == dcr->manufacturing_location) {
2330 mapping->position = i;
2331 break;
2332 }
2333 }
2334 }
2335
2336 ndr_desc->nd_set = nd_set;
2337
2338 return 0;
2339}
2340
2341static int ars_get_cap(struct acpi_nfit_desc *acpi_desc,
2342 struct nd_cmd_ars_cap *cmd, struct nfit_spa *nfit_spa)
2343{
2344 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2345 struct acpi_nfit_system_address *spa = nfit_spa->spa;
2346 int cmd_rc, rc;
2347
2348 cmd->address = spa->address;
2349 cmd->length = spa->length;
2350 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_CAP, cmd,
2351 sizeof(*cmd), &cmd_rc);
2352 if (rc < 0)
2353 return rc;
2354 return cmd_rc;
2355}
2356
2357static int ars_start(struct acpi_nfit_desc *acpi_desc,
2358 struct nfit_spa *nfit_spa, enum nfit_ars_state req_type)
2359{
2360 int rc;
2361 int cmd_rc;
2362 struct nd_cmd_ars_start ars_start;
2363 struct acpi_nfit_system_address *spa = nfit_spa->spa;
2364 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2365
2366 memset(&ars_start, 0, sizeof(ars_start));
2367 ars_start.address = spa->address;
2368 ars_start.length = spa->length;
2369 if (req_type == ARS_REQ_SHORT)
2370 ars_start.flags = ND_ARS_RETURN_PREV_DATA;
2371 if (nfit_spa_type(spa) == NFIT_SPA_PM)
2372 ars_start.type = ND_ARS_PERSISTENT;
2373 else if (nfit_spa_type(spa) == NFIT_SPA_VOLATILE)
2374 ars_start.type = ND_ARS_VOLATILE;
2375 else
2376 return -ENOTTY;
2377
2378 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_START, &ars_start,
2379 sizeof(ars_start), &cmd_rc);
2380
2381 if (rc < 0)
2382 return rc;
2383 if (cmd_rc < 0)
2384 return cmd_rc;
2385 set_bit(ARS_VALID, &acpi_desc->scrub_flags);
2386 return 0;
2387}
2388
2389static int ars_continue(struct acpi_nfit_desc *acpi_desc)
2390{
2391 int rc, cmd_rc;
2392 struct nd_cmd_ars_start ars_start;
2393 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2394 struct nd_cmd_ars_status *ars_status = acpi_desc->ars_status;
2395
2396 ars_start = (struct nd_cmd_ars_start) {
2397 .address = ars_status->restart_address,
2398 .length = ars_status->restart_length,
2399 .type = ars_status->type,
2400 };
2401 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_START, &ars_start,
2402 sizeof(ars_start), &cmd_rc);
2403 if (rc < 0)
2404 return rc;
2405 return cmd_rc;
2406}
2407
2408static int ars_get_status(struct acpi_nfit_desc *acpi_desc)
2409{
2410 struct nvdimm_bus_descriptor *nd_desc = &acpi_desc->nd_desc;
2411 struct nd_cmd_ars_status *ars_status = acpi_desc->ars_status;
2412 int rc, cmd_rc;
2413
2414 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_STATUS, ars_status,
2415 acpi_desc->max_ars, &cmd_rc);
2416 if (rc < 0)
2417 return rc;
2418 return cmd_rc;
2419}
2420
2421static void ars_complete(struct acpi_nfit_desc *acpi_desc,
2422 struct nfit_spa *nfit_spa)
2423{
2424 struct nd_cmd_ars_status *ars_status = acpi_desc->ars_status;
2425 struct acpi_nfit_system_address *spa = nfit_spa->spa;
2426 struct nd_region *nd_region = nfit_spa->nd_region;
2427 struct device *dev;
2428
2429 lockdep_assert_held(&acpi_desc->init_mutex);
2430 /*
2431 * Only advance the ARS state for ARS runs initiated by the
2432 * kernel, ignore ARS results from BIOS initiated runs for scrub
2433 * completion tracking.
2434 */
2435 if (acpi_desc->scrub_spa != nfit_spa)
2436 return;
2437
2438 if ((ars_status->address >= spa->address && ars_status->address
2439 < spa->address + spa->length)
2440 || (ars_status->address < spa->address)) {
2441 /*
2442 * Assume that if a scrub starts at an offset from the
2443 * start of nfit_spa that we are in the continuation
2444 * case.
2445 *
2446 * Otherwise, if the scrub covers the spa range, mark
2447 * any pending request complete.
2448 */
2449 if (ars_status->address + ars_status->length
2450 >= spa->address + spa->length)
2451 /* complete */;
2452 else
2453 return;
2454 } else
2455 return;
2456
2457 acpi_desc->scrub_spa = NULL;
2458 if (nd_region) {
2459 dev = nd_region_dev(nd_region);
2460 nvdimm_region_notify(nd_region, NVDIMM_REVALIDATE_POISON);
2461 } else
2462 dev = acpi_desc->dev;
2463 dev_dbg(dev, "ARS: range %d complete\n", spa->range_index);
2464}
2465
2466static int ars_status_process_records(struct acpi_nfit_desc *acpi_desc)
2467{
2468 struct nvdimm_bus *nvdimm_bus = acpi_desc->nvdimm_bus;
2469 struct nd_cmd_ars_status *ars_status = acpi_desc->ars_status;
2470 int rc;
2471 u32 i;
2472
2473 /*
2474 * First record starts at 44 byte offset from the start of the
2475 * payload.
2476 */
2477 if (ars_status->out_length < 44)
2478 return 0;
2479
2480 /*
2481 * Ignore potentially stale results that are only refreshed
2482 * after a start-ARS event.
2483 */
2484 if (!test_and_clear_bit(ARS_VALID, &acpi_desc->scrub_flags)) {
2485 dev_dbg(acpi_desc->dev, "skip %d stale records\n",
2486 ars_status->num_records);
2487 return 0;
2488 }
2489
2490 for (i = 0; i < ars_status->num_records; i++) {
2491 /* only process full records */
2492 if (ars_status->out_length
2493 < 44 + sizeof(struct nd_ars_record) * (i + 1))
2494 break;
2495 rc = nvdimm_bus_add_badrange(nvdimm_bus,
2496 ars_status->records[i].err_address,
2497 ars_status->records[i].length);
2498 if (rc)
2499 return rc;
2500 }
2501 if (i < ars_status->num_records)
2502 dev_warn(acpi_desc->dev, "detected truncated ars results\n");
2503
2504 return 0;
2505}
2506
2507static void acpi_nfit_remove_resource(void *data)
2508{
2509 struct resource *res = data;
2510
2511 remove_resource(res);
2512}
2513
2514static int acpi_nfit_insert_resource(struct acpi_nfit_desc *acpi_desc,
2515 struct nd_region_desc *ndr_desc)
2516{
2517 struct resource *res, *nd_res = ndr_desc->res;
2518 int is_pmem, ret;
2519
2520 /* No operation if the region is already registered as PMEM */
2521 is_pmem = region_intersects(nd_res->start, resource_size(nd_res),
2522 IORESOURCE_MEM, IORES_DESC_PERSISTENT_MEMORY);
2523 if (is_pmem == REGION_INTERSECTS)
2524 return 0;
2525
2526 res = devm_kzalloc(acpi_desc->dev, sizeof(*res), GFP_KERNEL);
2527 if (!res)
2528 return -ENOMEM;
2529
2530 res->name = "Persistent Memory";
2531 res->start = nd_res->start;
2532 res->end = nd_res->end;
2533 res->flags = IORESOURCE_MEM;
2534 res->desc = IORES_DESC_PERSISTENT_MEMORY;
2535
2536 ret = insert_resource(&iomem_resource, res);
2537 if (ret)
2538 return ret;
2539
2540 ret = devm_add_action_or_reset(acpi_desc->dev,
2541 acpi_nfit_remove_resource,
2542 res);
2543 if (ret)
2544 return ret;
2545
2546 return 0;
2547}
2548
2549static int acpi_nfit_init_mapping(struct acpi_nfit_desc *acpi_desc,
2550 struct nd_mapping_desc *mapping, struct nd_region_desc *ndr_desc,
2551 struct acpi_nfit_memory_map *memdev,
2552 struct nfit_spa *nfit_spa)
2553{
2554 struct nvdimm *nvdimm = acpi_nfit_dimm_by_handle(acpi_desc,
2555 memdev->device_handle);
2556 struct acpi_nfit_system_address *spa = nfit_spa->spa;
2557
2558 if (!nvdimm) {
2559 dev_err(acpi_desc->dev, "spa%d dimm: %#x not found\n",
2560 spa->range_index, memdev->device_handle);
2561 return -ENODEV;
2562 }
2563
2564 mapping->nvdimm = nvdimm;
2565 switch (nfit_spa_type(spa)) {
2566 case NFIT_SPA_PM:
2567 case NFIT_SPA_VOLATILE:
2568 mapping->start = memdev->address;
2569 mapping->size = memdev->region_size;
2570 break;
2571 }
2572
2573 return 0;
2574}
2575
2576static bool nfit_spa_is_virtual(struct acpi_nfit_system_address *spa)
2577{
2578 return (nfit_spa_type(spa) == NFIT_SPA_VDISK ||
2579 nfit_spa_type(spa) == NFIT_SPA_VCD ||
2580 nfit_spa_type(spa) == NFIT_SPA_PDISK ||
2581 nfit_spa_type(spa) == NFIT_SPA_PCD);
2582}
2583
2584static bool nfit_spa_is_volatile(struct acpi_nfit_system_address *spa)
2585{
2586 return (nfit_spa_type(spa) == NFIT_SPA_VDISK ||
2587 nfit_spa_type(spa) == NFIT_SPA_VCD ||
2588 nfit_spa_type(spa) == NFIT_SPA_VOLATILE);
2589}
2590
2591static int acpi_nfit_register_region(struct acpi_nfit_desc *acpi_desc,
2592 struct nfit_spa *nfit_spa)
2593{
2594 static struct nd_mapping_desc mappings[ND_MAX_MAPPINGS];
2595 struct acpi_nfit_system_address *spa = nfit_spa->spa;
2596 struct nd_region_desc *ndr_desc, _ndr_desc;
2597 struct nfit_memdev *nfit_memdev;
2598 struct nvdimm_bus *nvdimm_bus;
2599 struct resource res;
2600 int count = 0, rc;
2601
2602 if (nfit_spa->nd_region)
2603 return 0;
2604
2605 if (spa->range_index == 0 && !nfit_spa_is_virtual(spa)) {
2606 dev_dbg(acpi_desc->dev, "detected invalid spa index\n");
2607 return 0;
2608 }
2609
2610 memset(&res, 0, sizeof(res));
2611 memset(&mappings, 0, sizeof(mappings));
2612 memset(&_ndr_desc, 0, sizeof(_ndr_desc));
2613 res.start = spa->address;
2614 res.end = res.start + spa->length - 1;
2615 ndr_desc = &_ndr_desc;
2616 ndr_desc->res = &res;
2617 ndr_desc->provider_data = nfit_spa;
2618 ndr_desc->attr_groups = acpi_nfit_region_attribute_groups;
2619 if (spa->flags & ACPI_NFIT_PROXIMITY_VALID) {
2620 ndr_desc->numa_node = pxm_to_online_node(spa->proximity_domain);
2621 ndr_desc->target_node = pxm_to_node(spa->proximity_domain);
2622 } else {
2623 ndr_desc->numa_node = NUMA_NO_NODE;
2624 ndr_desc->target_node = NUMA_NO_NODE;
2625 }
2626
2627 /* Fallback to address based numa information if node lookup failed */
2628 if (ndr_desc->numa_node == NUMA_NO_NODE) {
2629 ndr_desc->numa_node = memory_add_physaddr_to_nid(spa->address);
2630 dev_info(acpi_desc->dev, "changing numa node from %d to %d for nfit region [%pa-%pa]",
2631 NUMA_NO_NODE, ndr_desc->numa_node, &res.start, &res.end);
2632 }
2633 if (ndr_desc->target_node == NUMA_NO_NODE) {
2634 ndr_desc->target_node = phys_to_target_node(spa->address);
2635 dev_info(acpi_desc->dev, "changing target node from %d to %d for nfit region [%pa-%pa]",
2636 NUMA_NO_NODE, ndr_desc->numa_node, &res.start, &res.end);
2637 }
2638
2639 /*
2640 * Persistence domain bits are hierarchical, if
2641 * ACPI_NFIT_CAPABILITY_CACHE_FLUSH is set then
2642 * ACPI_NFIT_CAPABILITY_MEM_FLUSH is implied.
2643 */
2644 if (acpi_desc->platform_cap & ACPI_NFIT_CAPABILITY_CACHE_FLUSH)
2645 set_bit(ND_REGION_PERSIST_CACHE, &ndr_desc->flags);
2646 else if (acpi_desc->platform_cap & ACPI_NFIT_CAPABILITY_MEM_FLUSH)
2647 set_bit(ND_REGION_PERSIST_MEMCTRL, &ndr_desc->flags);
2648
2649 list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {
2650 struct acpi_nfit_memory_map *memdev = nfit_memdev->memdev;
2651 struct nd_mapping_desc *mapping;
2652
2653 /* range index 0 == unmapped in SPA or invalid-SPA */
2654 if (memdev->range_index == 0 || spa->range_index == 0)
2655 continue;
2656 if (memdev->range_index != spa->range_index)
2657 continue;
2658 if (count >= ND_MAX_MAPPINGS) {
2659 dev_err(acpi_desc->dev, "spa%d exceeds max mappings %d\n",
2660 spa->range_index, ND_MAX_MAPPINGS);
2661 return -ENXIO;
2662 }
2663 mapping = &mappings[count++];
2664 rc = acpi_nfit_init_mapping(acpi_desc, mapping, ndr_desc,
2665 memdev, nfit_spa);
2666 if (rc)
2667 goto out;
2668 }
2669
2670 ndr_desc->mapping = mappings;
2671 ndr_desc->num_mappings = count;
2672 rc = acpi_nfit_init_interleave_set(acpi_desc, ndr_desc, spa);
2673 if (rc)
2674 goto out;
2675
2676 nvdimm_bus = acpi_desc->nvdimm_bus;
2677 if (nfit_spa_type(spa) == NFIT_SPA_PM) {
2678 rc = acpi_nfit_insert_resource(acpi_desc, ndr_desc);
2679 if (rc) {
2680 dev_warn(acpi_desc->dev,
2681 "failed to insert pmem resource to iomem: %d\n",
2682 rc);
2683 goto out;
2684 }
2685
2686 nfit_spa->nd_region = nvdimm_pmem_region_create(nvdimm_bus,
2687 ndr_desc);
2688 if (!nfit_spa->nd_region)
2689 rc = -ENOMEM;
2690 } else if (nfit_spa_is_volatile(spa)) {
2691 nfit_spa->nd_region = nvdimm_volatile_region_create(nvdimm_bus,
2692 ndr_desc);
2693 if (!nfit_spa->nd_region)
2694 rc = -ENOMEM;
2695 } else if (nfit_spa_is_virtual(spa)) {
2696 nfit_spa->nd_region = nvdimm_pmem_region_create(nvdimm_bus,
2697 ndr_desc);
2698 if (!nfit_spa->nd_region)
2699 rc = -ENOMEM;
2700 }
2701
2702 out:
2703 if (rc)
2704 dev_err(acpi_desc->dev, "failed to register spa range %d\n",
2705 nfit_spa->spa->range_index);
2706 return rc;
2707}
2708
2709static int ars_status_alloc(struct acpi_nfit_desc *acpi_desc)
2710{
2711 struct device *dev = acpi_desc->dev;
2712 struct nd_cmd_ars_status *ars_status;
2713
2714 if (acpi_desc->ars_status) {
2715 memset(acpi_desc->ars_status, 0, acpi_desc->max_ars);
2716 return 0;
2717 }
2718
2719 ars_status = devm_kzalloc(dev, acpi_desc->max_ars, GFP_KERNEL);
2720 if (!ars_status)
2721 return -ENOMEM;
2722 acpi_desc->ars_status = ars_status;
2723 return 0;
2724}
2725
2726static int acpi_nfit_query_poison(struct acpi_nfit_desc *acpi_desc)
2727{
2728 int rc;
2729
2730 if (ars_status_alloc(acpi_desc))
2731 return -ENOMEM;
2732
2733 rc = ars_get_status(acpi_desc);
2734
2735 if (rc < 0 && rc != -ENOSPC)
2736 return rc;
2737
2738 if (ars_status_process_records(acpi_desc))
2739 dev_err(acpi_desc->dev, "Failed to process ARS records\n");
2740
2741 return rc;
2742}
2743
2744static int ars_register(struct acpi_nfit_desc *acpi_desc,
2745 struct nfit_spa *nfit_spa)
2746{
2747 int rc;
2748
2749 if (test_bit(ARS_FAILED, &nfit_spa->ars_state))
2750 return acpi_nfit_register_region(acpi_desc, nfit_spa);
2751
2752 set_bit(ARS_REQ_SHORT, &nfit_spa->ars_state);
2753 if (!no_init_ars)
2754 set_bit(ARS_REQ_LONG, &nfit_spa->ars_state);
2755
2756 switch (acpi_nfit_query_poison(acpi_desc)) {
2757 case 0:
2758 case -ENOSPC:
2759 case -EAGAIN:
2760 rc = ars_start(acpi_desc, nfit_spa, ARS_REQ_SHORT);
2761 /* shouldn't happen, try again later */
2762 if (rc == -EBUSY)
2763 break;
2764 if (rc) {
2765 set_bit(ARS_FAILED, &nfit_spa->ars_state);
2766 break;
2767 }
2768 clear_bit(ARS_REQ_SHORT, &nfit_spa->ars_state);
2769 rc = acpi_nfit_query_poison(acpi_desc);
2770 if (rc)
2771 break;
2772 acpi_desc->scrub_spa = nfit_spa;
2773 ars_complete(acpi_desc, nfit_spa);
2774 /*
2775 * If ars_complete() says we didn't complete the
2776 * short scrub, we'll try again with a long
2777 * request.
2778 */
2779 acpi_desc->scrub_spa = NULL;
2780 break;
2781 case -EBUSY:
2782 case -ENOMEM:
2783 /*
2784 * BIOS was using ARS, wait for it to complete (or
2785 * resources to become available) and then perform our
2786 * own scrubs.
2787 */
2788 break;
2789 default:
2790 set_bit(ARS_FAILED, &nfit_spa->ars_state);
2791 break;
2792 }
2793
2794 return acpi_nfit_register_region(acpi_desc, nfit_spa);
2795}
2796
2797static void ars_complete_all(struct acpi_nfit_desc *acpi_desc)
2798{
2799 struct nfit_spa *nfit_spa;
2800
2801 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
2802 if (test_bit(ARS_FAILED, &nfit_spa->ars_state))
2803 continue;
2804 ars_complete(acpi_desc, nfit_spa);
2805 }
2806}
2807
2808static unsigned int __acpi_nfit_scrub(struct acpi_nfit_desc *acpi_desc,
2809 int query_rc)
2810{
2811 unsigned int tmo = acpi_desc->scrub_tmo;
2812 struct device *dev = acpi_desc->dev;
2813 struct nfit_spa *nfit_spa;
2814
2815 lockdep_assert_held(&acpi_desc->init_mutex);
2816
2817 if (test_bit(ARS_CANCEL, &acpi_desc->scrub_flags))
2818 return 0;
2819
2820 if (query_rc == -EBUSY) {
2821 dev_dbg(dev, "ARS: ARS busy\n");
2822 return min(30U * 60U, tmo * 2);
2823 }
2824 if (query_rc == -ENOSPC) {
2825 dev_dbg(dev, "ARS: ARS continue\n");
2826 ars_continue(acpi_desc);
2827 return 1;
2828 }
2829 if (query_rc && query_rc != -EAGAIN) {
2830 unsigned long long addr, end;
2831
2832 addr = acpi_desc->ars_status->address;
2833 end = addr + acpi_desc->ars_status->length;
2834 dev_dbg(dev, "ARS: %llx-%llx failed (%d)\n", addr, end,
2835 query_rc);
2836 }
2837
2838 ars_complete_all(acpi_desc);
2839 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
2840 enum nfit_ars_state req_type;
2841 int rc;
2842
2843 if (test_bit(ARS_FAILED, &nfit_spa->ars_state))
2844 continue;
2845
2846 /* prefer short ARS requests first */
2847 if (test_bit(ARS_REQ_SHORT, &nfit_spa->ars_state))
2848 req_type = ARS_REQ_SHORT;
2849 else if (test_bit(ARS_REQ_LONG, &nfit_spa->ars_state))
2850 req_type = ARS_REQ_LONG;
2851 else
2852 continue;
2853 rc = ars_start(acpi_desc, nfit_spa, req_type);
2854
2855 dev = nd_region_dev(nfit_spa->nd_region);
2856 dev_dbg(dev, "ARS: range %d ARS start %s (%d)\n",
2857 nfit_spa->spa->range_index,
2858 req_type == ARS_REQ_SHORT ? "short" : "long",
2859 rc);
2860 /*
2861 * Hmm, we raced someone else starting ARS? Try again in
2862 * a bit.
2863 */
2864 if (rc == -EBUSY)
2865 return 1;
2866 if (rc == 0) {
2867 dev_WARN_ONCE(dev, acpi_desc->scrub_spa,
2868 "scrub start while range %d active\n",
2869 acpi_desc->scrub_spa->spa->range_index);
2870 clear_bit(req_type, &nfit_spa->ars_state);
2871 acpi_desc->scrub_spa = nfit_spa;
2872 /*
2873 * Consider this spa last for future scrub
2874 * requests
2875 */
2876 list_move_tail(&nfit_spa->list, &acpi_desc->spas);
2877 return 1;
2878 }
2879
2880 dev_err(dev, "ARS: range %d ARS failed (%d)\n",
2881 nfit_spa->spa->range_index, rc);
2882 set_bit(ARS_FAILED, &nfit_spa->ars_state);
2883 }
2884 return 0;
2885}
2886
2887static void __sched_ars(struct acpi_nfit_desc *acpi_desc, unsigned int tmo)
2888{
2889 lockdep_assert_held(&acpi_desc->init_mutex);
2890
2891 set_bit(ARS_BUSY, &acpi_desc->scrub_flags);
2892 /* note this should only be set from within the workqueue */
2893 if (tmo)
2894 acpi_desc->scrub_tmo = tmo;
2895 queue_delayed_work(nfit_wq, &acpi_desc->dwork, tmo * HZ);
2896}
2897
2898static void sched_ars(struct acpi_nfit_desc *acpi_desc)
2899{
2900 __sched_ars(acpi_desc, 0);
2901}
2902
2903static void notify_ars_done(struct acpi_nfit_desc *acpi_desc)
2904{
2905 lockdep_assert_held(&acpi_desc->init_mutex);
2906
2907 clear_bit(ARS_BUSY, &acpi_desc->scrub_flags);
2908 acpi_desc->scrub_count++;
2909 if (acpi_desc->scrub_count_state)
2910 sysfs_notify_dirent(acpi_desc->scrub_count_state);
2911}
2912
2913static void acpi_nfit_scrub(struct work_struct *work)
2914{
2915 struct acpi_nfit_desc *acpi_desc;
2916 unsigned int tmo;
2917 int query_rc;
2918
2919 acpi_desc = container_of(work, typeof(*acpi_desc), dwork.work);
2920 mutex_lock(&acpi_desc->init_mutex);
2921 query_rc = acpi_nfit_query_poison(acpi_desc);
2922 tmo = __acpi_nfit_scrub(acpi_desc, query_rc);
2923 if (tmo)
2924 __sched_ars(acpi_desc, tmo);
2925 else
2926 notify_ars_done(acpi_desc);
2927 memset(acpi_desc->ars_status, 0, acpi_desc->max_ars);
2928 clear_bit(ARS_POLL, &acpi_desc->scrub_flags);
2929 mutex_unlock(&acpi_desc->init_mutex);
2930}
2931
2932static void acpi_nfit_init_ars(struct acpi_nfit_desc *acpi_desc,
2933 struct nfit_spa *nfit_spa)
2934{
2935 int type = nfit_spa_type(nfit_spa->spa);
2936 struct nd_cmd_ars_cap ars_cap;
2937 int rc;
2938
2939 set_bit(ARS_FAILED, &nfit_spa->ars_state);
2940 memset(&ars_cap, 0, sizeof(ars_cap));
2941 rc = ars_get_cap(acpi_desc, &ars_cap, nfit_spa);
2942 if (rc < 0)
2943 return;
2944 /* check that the supported scrub types match the spa type */
2945 if (type == NFIT_SPA_VOLATILE && ((ars_cap.status >> 16)
2946 & ND_ARS_VOLATILE) == 0)
2947 return;
2948 if (type == NFIT_SPA_PM && ((ars_cap.status >> 16)
2949 & ND_ARS_PERSISTENT) == 0)
2950 return;
2951
2952 nfit_spa->max_ars = ars_cap.max_ars_out;
2953 nfit_spa->clear_err_unit = ars_cap.clear_err_unit;
2954 acpi_desc->max_ars = max(nfit_spa->max_ars, acpi_desc->max_ars);
2955 clear_bit(ARS_FAILED, &nfit_spa->ars_state);
2956}
2957
2958static int acpi_nfit_register_regions(struct acpi_nfit_desc *acpi_desc)
2959{
2960 struct nfit_spa *nfit_spa;
2961 int rc, do_sched_ars = 0;
2962
2963 set_bit(ARS_VALID, &acpi_desc->scrub_flags);
2964 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
2965 switch (nfit_spa_type(nfit_spa->spa)) {
2966 case NFIT_SPA_VOLATILE:
2967 case NFIT_SPA_PM:
2968 acpi_nfit_init_ars(acpi_desc, nfit_spa);
2969 break;
2970 }
2971 }
2972
2973 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
2974 switch (nfit_spa_type(nfit_spa->spa)) {
2975 case NFIT_SPA_VOLATILE:
2976 case NFIT_SPA_PM:
2977 /* register regions and kick off initial ARS run */
2978 rc = ars_register(acpi_desc, nfit_spa);
2979 if (rc)
2980 return rc;
2981
2982 /*
2983 * Kick off background ARS if at least one
2984 * region successfully registered ARS
2985 */
2986 if (!test_bit(ARS_FAILED, &nfit_spa->ars_state))
2987 do_sched_ars++;
2988 break;
2989 case NFIT_SPA_BDW:
2990 /* nothing to register */
2991 break;
2992 case NFIT_SPA_DCR:
2993 case NFIT_SPA_VDISK:
2994 case NFIT_SPA_VCD:
2995 case NFIT_SPA_PDISK:
2996 case NFIT_SPA_PCD:
2997 /* register known regions that don't support ARS */
2998 rc = acpi_nfit_register_region(acpi_desc, nfit_spa);
2999 if (rc)
3000 return rc;
3001 break;
3002 default:
3003 /* don't register unknown regions */
3004 break;
3005 }
3006 }
3007
3008 if (do_sched_ars)
3009 sched_ars(acpi_desc);
3010 return 0;
3011}
3012
3013static int acpi_nfit_check_deletions(struct acpi_nfit_desc *acpi_desc,
3014 struct nfit_table_prev *prev)
3015{
3016 struct device *dev = acpi_desc->dev;
3017
3018 if (!list_empty(&prev->spas) ||
3019 !list_empty(&prev->memdevs) ||
3020 !list_empty(&prev->dcrs) ||
3021 !list_empty(&prev->bdws) ||
3022 !list_empty(&prev->idts) ||
3023 !list_empty(&prev->flushes)) {
3024 dev_err(dev, "new nfit deletes entries (unsupported)\n");
3025 return -ENXIO;
3026 }
3027 return 0;
3028}
3029
3030static int acpi_nfit_desc_init_scrub_attr(struct acpi_nfit_desc *acpi_desc)
3031{
3032 struct device *dev = acpi_desc->dev;
3033 struct kernfs_node *nfit;
3034 struct device *bus_dev;
3035
3036 if (!ars_supported(acpi_desc->nvdimm_bus))
3037 return 0;
3038
3039 bus_dev = to_nvdimm_bus_dev(acpi_desc->nvdimm_bus);
3040 nfit = sysfs_get_dirent(bus_dev->kobj.sd, "nfit");
3041 if (!nfit) {
3042 dev_err(dev, "sysfs_get_dirent 'nfit' failed\n");
3043 return -ENODEV;
3044 }
3045 acpi_desc->scrub_count_state = sysfs_get_dirent(nfit, "scrub");
3046 sysfs_put(nfit);
3047 if (!acpi_desc->scrub_count_state) {
3048 dev_err(dev, "sysfs_get_dirent 'scrub' failed\n");
3049 return -ENODEV;
3050 }
3051
3052 return 0;
3053}
3054
3055static void acpi_nfit_unregister(void *data)
3056{
3057 struct acpi_nfit_desc *acpi_desc = data;
3058
3059 nvdimm_bus_unregister(acpi_desc->nvdimm_bus);
3060}
3061
3062int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, void *data, acpi_size sz)
3063{
3064 struct device *dev = acpi_desc->dev;
3065 struct nfit_table_prev prev;
3066 const void *end;
3067 int rc;
3068
3069 if (!acpi_desc->nvdimm_bus) {
3070 acpi_nfit_init_dsms(acpi_desc);
3071
3072 acpi_desc->nvdimm_bus = nvdimm_bus_register(dev,
3073 &acpi_desc->nd_desc);
3074 if (!acpi_desc->nvdimm_bus)
3075 return -ENOMEM;
3076
3077 rc = devm_add_action_or_reset(dev, acpi_nfit_unregister,
3078 acpi_desc);
3079 if (rc)
3080 return rc;
3081
3082 rc = acpi_nfit_desc_init_scrub_attr(acpi_desc);
3083 if (rc)
3084 return rc;
3085
3086 /* register this acpi_desc for mce notifications */
3087 mutex_lock(&acpi_desc_lock);
3088 list_add_tail(&acpi_desc->list, &acpi_descs);
3089 mutex_unlock(&acpi_desc_lock);
3090 }
3091
3092 mutex_lock(&acpi_desc->init_mutex);
3093
3094 INIT_LIST_HEAD(&prev.spas);
3095 INIT_LIST_HEAD(&prev.memdevs);
3096 INIT_LIST_HEAD(&prev.dcrs);
3097 INIT_LIST_HEAD(&prev.bdws);
3098 INIT_LIST_HEAD(&prev.idts);
3099 INIT_LIST_HEAD(&prev.flushes);
3100
3101 list_cut_position(&prev.spas, &acpi_desc->spas,
3102 acpi_desc->spas.prev);
3103 list_cut_position(&prev.memdevs, &acpi_desc->memdevs,
3104 acpi_desc->memdevs.prev);
3105 list_cut_position(&prev.dcrs, &acpi_desc->dcrs,
3106 acpi_desc->dcrs.prev);
3107 list_cut_position(&prev.bdws, &acpi_desc->bdws,
3108 acpi_desc->bdws.prev);
3109 list_cut_position(&prev.idts, &acpi_desc->idts,
3110 acpi_desc->idts.prev);
3111 list_cut_position(&prev.flushes, &acpi_desc->flushes,
3112 acpi_desc->flushes.prev);
3113
3114 end = data + sz;
3115 while (!IS_ERR_OR_NULL(data))
3116 data = add_table(acpi_desc, &prev, data, end);
3117
3118 if (IS_ERR(data)) {
3119 dev_dbg(dev, "nfit table parsing error: %ld\n", PTR_ERR(data));
3120 rc = PTR_ERR(data);
3121 goto out_unlock;
3122 }
3123
3124 rc = acpi_nfit_check_deletions(acpi_desc, &prev);
3125 if (rc)
3126 goto out_unlock;
3127
3128 rc = nfit_mem_init(acpi_desc);
3129 if (rc)
3130 goto out_unlock;
3131
3132 rc = acpi_nfit_register_dimms(acpi_desc);
3133 if (rc)
3134 goto out_unlock;
3135
3136 rc = acpi_nfit_register_regions(acpi_desc);
3137
3138 out_unlock:
3139 mutex_unlock(&acpi_desc->init_mutex);
3140 return rc;
3141}
3142EXPORT_SYMBOL_GPL(acpi_nfit_init);
3143
3144static int acpi_nfit_flush_probe(struct nvdimm_bus_descriptor *nd_desc)
3145{
3146 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
3147 struct device *dev = acpi_desc->dev;
3148
3149 /* Bounce the device lock to flush acpi_nfit_add / acpi_nfit_notify */
3150 device_lock(dev);
3151 device_unlock(dev);
3152
3153 /* Bounce the init_mutex to complete initial registration */
3154 mutex_lock(&acpi_desc->init_mutex);
3155 mutex_unlock(&acpi_desc->init_mutex);
3156
3157 return 0;
3158}
3159
3160static int __acpi_nfit_clear_to_send(struct nvdimm_bus_descriptor *nd_desc,
3161 struct nvdimm *nvdimm, unsigned int cmd)
3162{
3163 struct acpi_nfit_desc *acpi_desc = to_acpi_desc(nd_desc);
3164
3165 if (nvdimm)
3166 return 0;
3167 if (cmd != ND_CMD_ARS_START)
3168 return 0;
3169
3170 /*
3171 * The kernel and userspace may race to initiate a scrub, but
3172 * the scrub thread is prepared to lose that initial race. It
3173 * just needs guarantees that any ARS it initiates are not
3174 * interrupted by any intervening start requests from userspace.
3175 */
3176 if (work_busy(&acpi_desc->dwork.work))
3177 return -EBUSY;
3178
3179 return 0;
3180}
3181
3182/*
3183 * Prevent security and firmware activate commands from being issued via
3184 * ioctl.
3185 */
3186static int acpi_nfit_clear_to_send(struct nvdimm_bus_descriptor *nd_desc,
3187 struct nvdimm *nvdimm, unsigned int cmd, void *buf)
3188{
3189 struct nd_cmd_pkg *call_pkg = buf;
3190 unsigned int func;
3191
3192 if (nvdimm && cmd == ND_CMD_CALL &&
3193 call_pkg->nd_family == NVDIMM_FAMILY_INTEL) {
3194 func = call_pkg->nd_command;
3195 if (func > NVDIMM_CMD_MAX ||
3196 (1 << func) & NVDIMM_INTEL_DENY_CMDMASK)
3197 return -EOPNOTSUPP;
3198 }
3199
3200 /* block all non-nfit bus commands */
3201 if (!nvdimm && cmd == ND_CMD_CALL &&
3202 call_pkg->nd_family != NVDIMM_BUS_FAMILY_NFIT)
3203 return -EOPNOTSUPP;
3204
3205 return __acpi_nfit_clear_to_send(nd_desc, nvdimm, cmd);
3206}
3207
3208int acpi_nfit_ars_rescan(struct acpi_nfit_desc *acpi_desc,
3209 enum nfit_ars_state req_type)
3210{
3211 struct device *dev = acpi_desc->dev;
3212 int scheduled = 0, busy = 0;
3213 struct nfit_spa *nfit_spa;
3214
3215 mutex_lock(&acpi_desc->init_mutex);
3216 if (test_bit(ARS_CANCEL, &acpi_desc->scrub_flags)) {
3217 mutex_unlock(&acpi_desc->init_mutex);
3218 return 0;
3219 }
3220
3221 list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {
3222 int type = nfit_spa_type(nfit_spa->spa);
3223
3224 if (type != NFIT_SPA_PM && type != NFIT_SPA_VOLATILE)
3225 continue;
3226 if (test_bit(ARS_FAILED, &nfit_spa->ars_state))
3227 continue;
3228
3229 if (test_and_set_bit(req_type, &nfit_spa->ars_state))
3230 busy++;
3231 else
3232 scheduled++;
3233 }
3234 if (scheduled) {
3235 sched_ars(acpi_desc);
3236 dev_dbg(dev, "ars_scan triggered\n");
3237 }
3238 mutex_unlock(&acpi_desc->init_mutex);
3239
3240 if (scheduled)
3241 return 0;
3242 if (busy)
3243 return -EBUSY;
3244 return -ENOTTY;
3245}
3246
3247void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev)
3248{
3249 struct nvdimm_bus_descriptor *nd_desc;
3250
3251 dev_set_drvdata(dev, acpi_desc);
3252 acpi_desc->dev = dev;
3253 nd_desc = &acpi_desc->nd_desc;
3254 nd_desc->provider_name = "ACPI.NFIT";
3255 nd_desc->module = THIS_MODULE;
3256 nd_desc->ndctl = acpi_nfit_ctl;
3257 nd_desc->flush_probe = acpi_nfit_flush_probe;
3258 nd_desc->clear_to_send = acpi_nfit_clear_to_send;
3259 nd_desc->attr_groups = acpi_nfit_attribute_groups;
3260
3261 INIT_LIST_HEAD(&acpi_desc->spas);
3262 INIT_LIST_HEAD(&acpi_desc->dcrs);
3263 INIT_LIST_HEAD(&acpi_desc->bdws);
3264 INIT_LIST_HEAD(&acpi_desc->idts);
3265 INIT_LIST_HEAD(&acpi_desc->flushes);
3266 INIT_LIST_HEAD(&acpi_desc->memdevs);
3267 INIT_LIST_HEAD(&acpi_desc->dimms);
3268 INIT_LIST_HEAD(&acpi_desc->list);
3269 mutex_init(&acpi_desc->init_mutex);
3270 acpi_desc->scrub_tmo = 1;
3271 INIT_DELAYED_WORK(&acpi_desc->dwork, acpi_nfit_scrub);
3272}
3273EXPORT_SYMBOL_GPL(acpi_nfit_desc_init);
3274
3275static void acpi_nfit_put_table(void *table)
3276{
3277 acpi_put_table(table);
3278}
3279
3280static void acpi_nfit_notify(acpi_handle handle, u32 event, void *data)
3281{
3282 struct acpi_device *adev = data;
3283
3284 device_lock(&adev->dev);
3285 __acpi_nfit_notify(&adev->dev, handle, event);
3286 device_unlock(&adev->dev);
3287}
3288
3289static void acpi_nfit_remove_notify_handler(void *data)
3290{
3291 struct acpi_device *adev = data;
3292
3293 acpi_dev_remove_notify_handler(adev, ACPI_DEVICE_NOTIFY,
3294 acpi_nfit_notify);
3295}
3296
3297void acpi_nfit_shutdown(void *data)
3298{
3299 struct acpi_nfit_desc *acpi_desc = data;
3300 struct device *bus_dev = to_nvdimm_bus_dev(acpi_desc->nvdimm_bus);
3301
3302 /*
3303 * Destruct under acpi_desc_lock so that nfit_handle_mce does not
3304 * race teardown
3305 */
3306 mutex_lock(&acpi_desc_lock);
3307 list_del(&acpi_desc->list);
3308 mutex_unlock(&acpi_desc_lock);
3309
3310 mutex_lock(&acpi_desc->init_mutex);
3311 set_bit(ARS_CANCEL, &acpi_desc->scrub_flags);
3312 mutex_unlock(&acpi_desc->init_mutex);
3313 cancel_delayed_work_sync(&acpi_desc->dwork);
3314
3315 /*
3316 * Bounce the nvdimm bus lock to make sure any in-flight
3317 * acpi_nfit_ars_rescan() submissions have had a chance to
3318 * either submit or see ->cancel set.
3319 */
3320 device_lock(bus_dev);
3321 device_unlock(bus_dev);
3322
3323 flush_workqueue(nfit_wq);
3324}
3325EXPORT_SYMBOL_GPL(acpi_nfit_shutdown);
3326
3327static int acpi_nfit_add(struct acpi_device *adev)
3328{
3329 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
3330 struct acpi_nfit_desc *acpi_desc;
3331 struct device *dev = &adev->dev;
3332 struct acpi_table_header *tbl;
3333 acpi_status status = AE_OK;
3334 acpi_size sz;
3335 int rc = 0;
3336
3337 rc = acpi_dev_install_notify_handler(adev, ACPI_DEVICE_NOTIFY,
3338 acpi_nfit_notify, adev);
3339 if (rc)
3340 return rc;
3341
3342 rc = devm_add_action_or_reset(dev, acpi_nfit_remove_notify_handler,
3343 adev);
3344 if (rc)
3345 return rc;
3346
3347 status = acpi_get_table(ACPI_SIG_NFIT, 0, &tbl);
3348 if (ACPI_FAILURE(status)) {
3349 /* The NVDIMM root device allows OS to trigger enumeration of
3350 * NVDIMMs through NFIT at boot time and re-enumeration at
3351 * root level via the _FIT method during runtime.
3352 * This is ok to return 0 here, we could have an nvdimm
3353 * hotplugged later and evaluate _FIT method which returns
3354 * data in the format of a series of NFIT Structures.
3355 */
3356 dev_dbg(dev, "failed to find NFIT at startup\n");
3357 return 0;
3358 }
3359
3360 rc = devm_add_action_or_reset(dev, acpi_nfit_put_table, tbl);
3361 if (rc)
3362 return rc;
3363 sz = tbl->length;
3364
3365 acpi_desc = devm_kzalloc(dev, sizeof(*acpi_desc), GFP_KERNEL);
3366 if (!acpi_desc)
3367 return -ENOMEM;
3368 acpi_nfit_desc_init(acpi_desc, &adev->dev);
3369
3370 /* Save the acpi header for exporting the revision via sysfs */
3371 acpi_desc->acpi_header = *tbl;
3372
3373 /* Evaluate _FIT and override with that if present */
3374 status = acpi_evaluate_object(adev->handle, "_FIT", NULL, &buf);
3375 if (ACPI_SUCCESS(status) && buf.length > 0) {
3376 union acpi_object *obj = buf.pointer;
3377
3378 if (obj->type == ACPI_TYPE_BUFFER)
3379 rc = acpi_nfit_init(acpi_desc, obj->buffer.pointer,
3380 obj->buffer.length);
3381 else
3382 dev_dbg(dev, "invalid type %d, ignoring _FIT\n",
3383 (int) obj->type);
3384 kfree(buf.pointer);
3385 } else
3386 /* skip over the lead-in header table */
3387 rc = acpi_nfit_init(acpi_desc, (void *) tbl
3388 + sizeof(struct acpi_table_nfit),
3389 sz - sizeof(struct acpi_table_nfit));
3390
3391 if (rc)
3392 return rc;
3393
3394 return devm_add_action_or_reset(dev, acpi_nfit_shutdown, acpi_desc);
3395}
3396
3397static void acpi_nfit_update_notify(struct device *dev, acpi_handle handle)
3398{
3399 struct acpi_nfit_desc *acpi_desc = dev_get_drvdata(dev);
3400 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
3401 union acpi_object *obj;
3402 acpi_status status;
3403 int ret;
3404
3405 if (!dev->driver) {
3406 /* dev->driver may be null if we're being removed */
3407 dev_dbg(dev, "no driver found for dev\n");
3408 return;
3409 }
3410
3411 if (!acpi_desc) {
3412 acpi_desc = devm_kzalloc(dev, sizeof(*acpi_desc), GFP_KERNEL);
3413 if (!acpi_desc)
3414 return;
3415 acpi_nfit_desc_init(acpi_desc, dev);
3416 } else {
3417 /*
3418 * Finish previous registration before considering new
3419 * regions.
3420 */
3421 flush_workqueue(nfit_wq);
3422 }
3423
3424 /* Evaluate _FIT */
3425 status = acpi_evaluate_object(handle, "_FIT", NULL, &buf);
3426 if (ACPI_FAILURE(status)) {
3427 dev_err(dev, "failed to evaluate _FIT\n");
3428 return;
3429 }
3430
3431 obj = buf.pointer;
3432 if (obj->type == ACPI_TYPE_BUFFER) {
3433 ret = acpi_nfit_init(acpi_desc, obj->buffer.pointer,
3434 obj->buffer.length);
3435 if (ret)
3436 dev_err(dev, "failed to merge updated NFIT\n");
3437 } else
3438 dev_err(dev, "Invalid _FIT\n");
3439 kfree(buf.pointer);
3440}
3441
3442static void acpi_nfit_uc_error_notify(struct device *dev, acpi_handle handle)
3443{
3444 struct acpi_nfit_desc *acpi_desc = dev_get_drvdata(dev);
3445
3446 if (acpi_desc->scrub_mode == HW_ERROR_SCRUB_ON)
3447 acpi_nfit_ars_rescan(acpi_desc, ARS_REQ_LONG);
3448 else
3449 acpi_nfit_ars_rescan(acpi_desc, ARS_REQ_SHORT);
3450}
3451
3452void __acpi_nfit_notify(struct device *dev, acpi_handle handle, u32 event)
3453{
3454 dev_dbg(dev, "event: 0x%x\n", event);
3455
3456 switch (event) {
3457 case NFIT_NOTIFY_UPDATE:
3458 return acpi_nfit_update_notify(dev, handle);
3459 case NFIT_NOTIFY_UC_MEMORY_ERROR:
3460 return acpi_nfit_uc_error_notify(dev, handle);
3461 default:
3462 return;
3463 }
3464}
3465EXPORT_SYMBOL_GPL(__acpi_nfit_notify);
3466
3467static const struct acpi_device_id acpi_nfit_ids[] = {
3468 { "ACPI0012", 0 },
3469 { "", 0 },
3470};
3471MODULE_DEVICE_TABLE(acpi, acpi_nfit_ids);
3472
3473static struct acpi_driver acpi_nfit_driver = {
3474 .name = KBUILD_MODNAME,
3475 .ids = acpi_nfit_ids,
3476 .ops = {
3477 .add = acpi_nfit_add,
3478 },
3479};
3480
3481static __init int nfit_init(void)
3482{
3483 int ret;
3484
3485 BUILD_BUG_ON(sizeof(struct acpi_table_nfit) != 40);
3486 BUILD_BUG_ON(sizeof(struct acpi_nfit_system_address) != 64);
3487 BUILD_BUG_ON(sizeof(struct acpi_nfit_memory_map) != 48);
3488 BUILD_BUG_ON(sizeof(struct acpi_nfit_interleave) != 16);
3489 BUILD_BUG_ON(sizeof(struct acpi_nfit_smbios) != 8);
3490 BUILD_BUG_ON(sizeof(struct acpi_nfit_control_region) != 80);
3491 BUILD_BUG_ON(sizeof(struct acpi_nfit_data_region) != 40);
3492 BUILD_BUG_ON(sizeof(struct acpi_nfit_capabilities) != 16);
3493
3494 guid_parse(UUID_VOLATILE_MEMORY, &nfit_uuid[NFIT_SPA_VOLATILE]);
3495 guid_parse(UUID_PERSISTENT_MEMORY, &nfit_uuid[NFIT_SPA_PM]);
3496 guid_parse(UUID_CONTROL_REGION, &nfit_uuid[NFIT_SPA_DCR]);
3497 guid_parse(UUID_DATA_REGION, &nfit_uuid[NFIT_SPA_BDW]);
3498 guid_parse(UUID_VOLATILE_VIRTUAL_DISK, &nfit_uuid[NFIT_SPA_VDISK]);
3499 guid_parse(UUID_VOLATILE_VIRTUAL_CD, &nfit_uuid[NFIT_SPA_VCD]);
3500 guid_parse(UUID_PERSISTENT_VIRTUAL_DISK, &nfit_uuid[NFIT_SPA_PDISK]);
3501 guid_parse(UUID_PERSISTENT_VIRTUAL_CD, &nfit_uuid[NFIT_SPA_PCD]);
3502 guid_parse(UUID_NFIT_BUS, &nfit_uuid[NFIT_DEV_BUS]);
3503 guid_parse(UUID_NFIT_DIMM, &nfit_uuid[NFIT_DEV_DIMM]);
3504 guid_parse(UUID_NFIT_DIMM_N_HPE1, &nfit_uuid[NFIT_DEV_DIMM_N_HPE1]);
3505 guid_parse(UUID_NFIT_DIMM_N_HPE2, &nfit_uuid[NFIT_DEV_DIMM_N_HPE2]);
3506 guid_parse(UUID_NFIT_DIMM_N_MSFT, &nfit_uuid[NFIT_DEV_DIMM_N_MSFT]);
3507 guid_parse(UUID_NFIT_DIMM_N_HYPERV, &nfit_uuid[NFIT_DEV_DIMM_N_HYPERV]);
3508 guid_parse(UUID_INTEL_BUS, &nfit_uuid[NFIT_BUS_INTEL]);
3509
3510 nfit_wq = create_singlethread_workqueue("nfit");
3511 if (!nfit_wq)
3512 return -ENOMEM;
3513
3514 nfit_mce_register();
3515 ret = acpi_bus_register_driver(&acpi_nfit_driver);
3516 if (ret) {
3517 nfit_mce_unregister();
3518 destroy_workqueue(nfit_wq);
3519 }
3520
3521 return ret;
3522
3523}
3524
3525static __exit void nfit_exit(void)
3526{
3527 nfit_mce_unregister();
3528 acpi_bus_unregister_driver(&acpi_nfit_driver);
3529 destroy_workqueue(nfit_wq);
3530 WARN_ON(!list_empty(&acpi_descs));
3531}
3532
3533module_init(nfit_init);
3534module_exit(nfit_exit);
3535MODULE_LICENSE("GPL v2");
3536MODULE_AUTHOR("Intel Corporation");