2 * NVDIMM ACPI Implementation
4 * Copyright(C) 2015 Intel Corporation.
7 * Xiao Guangrong <guangrong.xiao@linux.intel.com>
9 * NFIT is defined in ACPI 6.0: 5.2.25 NVDIMM Firmware Interface Table (NFIT)
10 * and the DSM specification can be found at:
11 * http://pmem.io/documents/NVDIMM_DSM_Interface_Example.pdf
13 * Currently, it only supports PMEM Virtualization.
15 * This library is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU Lesser General Public
17 * License as published by the Free Software Foundation; either
18 * version 2 of the License, or (at your option) any later version.
20 * This library is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 * Lesser General Public License for more details.
25 * You should have received a copy of the GNU Lesser General Public
26 * License along with this library; if not, see <http://www.gnu.org/licenses/>
29 #include "qemu/osdep.h"
30 #include "hw/acpi/acpi.h"
31 #include "hw/acpi/aml-build.h"
32 #include "hw/nvram/fw_cfg.h"
33 #include "hw/mem/nvdimm.h"
35 static int nvdimm_plugged_device_list(Object
*obj
, void *opaque
)
37 GSList
**list
= opaque
;
39 if (object_dynamic_cast(obj
, TYPE_NVDIMM
)) {
40 DeviceState
*dev
= DEVICE(obj
);
42 if (dev
->realized
) { /* only realized NVDIMMs matter */
43 *list
= g_slist_append(*list
, DEVICE(obj
));
47 object_child_foreach(obj
, nvdimm_plugged_device_list
, opaque
);
52 * inquire plugged NVDIMM devices and link them into the list which is
53 * returned to the caller.
55 * Note: it is the caller's responsibility to free the list to avoid
58 static GSList
*nvdimm_get_plugged_device_list(void)
62 object_child_foreach(qdev_get_machine(), nvdimm_plugged_device_list
,
67 #define NVDIMM_UUID_LE(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
68 { (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
69 (b) & 0xff, ((b) >> 8) & 0xff, (c) & 0xff, ((c) >> 8) & 0xff, \
70 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }
73 * define Byte Addressable Persistent Memory (PM) Region according to
74 * ACPI 6.0: 5.2.25.1 System Physical Address Range Structure.
76 static const uint8_t nvdimm_nfit_spa_uuid
[] =
77 NVDIMM_UUID_LE(0x66f0d379, 0xb4f3, 0x4074, 0xac, 0x43, 0x0d, 0x33,
78 0x18, 0xb7, 0x8c, 0xdb);
81 * NVDIMM Firmware Interface Table
84 * It provides information that allows OSPM to enumerate NVDIMM present in
85 * the platform and associate system physical address ranges created by the
88 * It is defined in ACPI 6.0: 5.2.25 NVDIMM Firmware Interface Table (NFIT)
90 struct NvdimmNfitHeader
{
94 typedef struct NvdimmNfitHeader NvdimmNfitHeader
;
97 * define NFIT structures according to ACPI 6.0: 5.2.25 NVDIMM Firmware
98 * Interface Table (NFIT).
102 * System Physical Address Range Structure
104 * It describes the system physical address ranges occupied by NVDIMMs and
105 * the types of the regions.
107 struct NvdimmNfitSpa
{
113 uint32_t proximity_domain
;
114 uint8_t type_guid
[16];
119 typedef struct NvdimmNfitSpa NvdimmNfitSpa
;
122 * Memory Device to System Physical Address Range Mapping Structure
124 * It enables identifying each NVDIMM region and the corresponding SPA
125 * describing the memory interleave
127 struct NvdimmNfitMemDev
{
130 uint32_t nfit_handle
;
136 uint64_t region_offset
;
138 uint16_t interleave_index
;
139 uint16_t interleave_ways
;
143 typedef struct NvdimmNfitMemDev NvdimmNfitMemDev
;
146 * NVDIMM Control Region Structure
148 * It describes the NVDIMM and if applicable, Block Control Window.
150 struct NvdimmNfitControlRegion
{
156 uint16_t revision_id
;
157 uint16_t sub_vendor_id
;
158 uint16_t sub_device_id
;
159 uint16_t sub_revision_id
;
161 uint32_t serial_number
;
167 uint64_t status_offset
;
168 uint64_t status_size
;
170 uint8_t reserved2
[6];
172 typedef struct NvdimmNfitControlRegion NvdimmNfitControlRegion
;
175 * Module serial number is a unique number for each device. We use the
176 * slot id of NVDIMM device to generate this number so that each device
177 * associates with a different number.
179 * 0x123456 is a magic number we arbitrarily chose.
181 static uint32_t nvdimm_slot_to_sn(int slot
)
183 return 0x123456 + slot
;
187 * handle is used to uniquely associate nfit_memdev structure with NVDIMM
188 * ACPI device - nfit_memdev.nfit_handle matches with the value returned
189 * by ACPI device _ADR method.
191 * We generate the handle with the slot id of NVDIMM device and reserve
192 * 0 for NVDIMM root device.
194 static uint32_t nvdimm_slot_to_handle(int slot
)
200 * index uniquely identifies the structure, 0 is reserved which indicates
201 * that the structure is not valid or the associated structure is not
204 * Each NVDIMM device needs two indexes, one for nfit_spa and another for
205 * nfit_dc which are generated by the slot id of NVDIMM device.
207 static uint16_t nvdimm_slot_to_spa_index(int slot
)
209 return (slot
+ 1) << 1;
212 /* See the comments of nvdimm_slot_to_spa_index(). */
213 static uint32_t nvdimm_slot_to_dcr_index(int slot
)
215 return nvdimm_slot_to_spa_index(slot
) + 1;
218 /* ACPI 6.0: 5.2.25.1 System Physical Address Range Structure */
220 nvdimm_build_structure_spa(GArray
*structures
, DeviceState
*dev
)
222 NvdimmNfitSpa
*nfit_spa
;
223 uint64_t addr
= object_property_get_int(OBJECT(dev
), PC_DIMM_ADDR_PROP
,
225 uint64_t size
= object_property_get_int(OBJECT(dev
), PC_DIMM_SIZE_PROP
,
227 uint32_t node
= object_property_get_int(OBJECT(dev
), PC_DIMM_NODE_PROP
,
229 int slot
= object_property_get_int(OBJECT(dev
), PC_DIMM_SLOT_PROP
,
232 nfit_spa
= acpi_data_push(structures
, sizeof(*nfit_spa
));
234 nfit_spa
->type
= cpu_to_le16(0 /* System Physical Address Range
236 nfit_spa
->length
= cpu_to_le16(sizeof(*nfit_spa
));
237 nfit_spa
->spa_index
= cpu_to_le16(nvdimm_slot_to_spa_index(slot
));
240 * Control region is strict as all the device info, such as SN, index,
241 * is associated with slot id.
243 nfit_spa
->flags
= cpu_to_le16(1 /* Control region is strictly for
244 management during hot add/online
246 2 /* Data in Proximity Domain field is
250 nfit_spa
->proximity_domain
= cpu_to_le32(node
);
251 /* the region reported as PMEM. */
252 memcpy(nfit_spa
->type_guid
, nvdimm_nfit_spa_uuid
,
253 sizeof(nvdimm_nfit_spa_uuid
));
255 nfit_spa
->spa_base
= cpu_to_le64(addr
);
256 nfit_spa
->spa_length
= cpu_to_le64(size
);
258 /* It is the PMEM and can be cached as writeback. */
259 nfit_spa
->mem_attr
= cpu_to_le64(0x8ULL
/* EFI_MEMORY_WB */ |
260 0x8000ULL
/* EFI_MEMORY_NV */);
264 * ACPI 6.0: 5.2.25.2 Memory Device to System Physical Address Range Mapping
268 nvdimm_build_structure_memdev(GArray
*structures
, DeviceState
*dev
)
270 NvdimmNfitMemDev
*nfit_memdev
;
271 uint64_t addr
= object_property_get_int(OBJECT(dev
), PC_DIMM_ADDR_PROP
,
273 uint64_t size
= object_property_get_int(OBJECT(dev
), PC_DIMM_SIZE_PROP
,
275 int slot
= object_property_get_int(OBJECT(dev
), PC_DIMM_SLOT_PROP
,
277 uint32_t handle
= nvdimm_slot_to_handle(slot
);
279 nfit_memdev
= acpi_data_push(structures
, sizeof(*nfit_memdev
));
281 nfit_memdev
->type
= cpu_to_le16(1 /* Memory Device to System Address
282 Range Map Structure*/);
283 nfit_memdev
->length
= cpu_to_le16(sizeof(*nfit_memdev
));
284 nfit_memdev
->nfit_handle
= cpu_to_le32(handle
);
287 * associate memory device with System Physical Address Range
290 nfit_memdev
->spa_index
= cpu_to_le16(nvdimm_slot_to_spa_index(slot
));
291 /* associate memory device with Control Region Structure. */
292 nfit_memdev
->dcr_index
= cpu_to_le16(nvdimm_slot_to_dcr_index(slot
));
294 /* The memory region on the device. */
295 nfit_memdev
->region_len
= cpu_to_le64(size
);
296 nfit_memdev
->region_dpa
= cpu_to_le64(addr
);
298 /* Only one interleave for PMEM. */
299 nfit_memdev
->interleave_ways
= cpu_to_le16(1);
303 * ACPI 6.0: 5.2.25.5 NVDIMM Control Region Structure.
305 static void nvdimm_build_structure_dcr(GArray
*structures
, DeviceState
*dev
)
307 NvdimmNfitControlRegion
*nfit_dcr
;
308 int slot
= object_property_get_int(OBJECT(dev
), PC_DIMM_SLOT_PROP
,
310 uint32_t sn
= nvdimm_slot_to_sn(slot
);
312 nfit_dcr
= acpi_data_push(structures
, sizeof(*nfit_dcr
));
314 nfit_dcr
->type
= cpu_to_le16(4 /* NVDIMM Control Region Structure */);
315 nfit_dcr
->length
= cpu_to_le16(sizeof(*nfit_dcr
));
316 nfit_dcr
->dcr_index
= cpu_to_le16(nvdimm_slot_to_dcr_index(slot
));
319 nfit_dcr
->vendor_id
= cpu_to_le16(0x8086);
320 nfit_dcr
->device_id
= cpu_to_le16(1);
322 /* The _DSM method is following Intel's DSM specification. */
323 nfit_dcr
->revision_id
= cpu_to_le16(1 /* Current Revision supported
324 in ACPI 6.0 is 1. */);
325 nfit_dcr
->serial_number
= cpu_to_le32(sn
);
326 nfit_dcr
->fic
= cpu_to_le16(0x201 /* Format Interface Code. See Chapter
327 2: NVDIMM Device Specific Method
328 (DSM) in DSM Spec Rev1.*/);
331 static GArray
*nvdimm_build_device_structure(GSList
*device_list
)
333 GArray
*structures
= g_array_new(false, true /* clear */, 1);
335 for (; device_list
; device_list
= device_list
->next
) {
336 DeviceState
*dev
= device_list
->data
;
338 /* build System Physical Address Range Structure. */
339 nvdimm_build_structure_spa(structures
, dev
);
342 * build Memory Device to System Physical Address Range Mapping
345 nvdimm_build_structure_memdev(structures
, dev
);
347 /* build NVDIMM Control Region Structure. */
348 nvdimm_build_structure_dcr(structures
, dev
);
354 static void nvdimm_build_nfit(GSList
*device_list
, GArray
*table_offsets
,
355 GArray
*table_data
, GArray
*linker
)
357 GArray
*structures
= nvdimm_build_device_structure(device_list
);
360 acpi_add_table(table_offsets
, table_data
);
363 header
= table_data
->len
;
364 acpi_data_push(table_data
, sizeof(NvdimmNfitHeader
));
365 /* NVDIMM device structures. */
366 g_array_append_vals(table_data
, structures
->data
, structures
->len
);
368 build_header(linker
, table_data
,
369 (void *)(table_data
->data
+ header
), "NFIT",
370 sizeof(NvdimmNfitHeader
) + structures
->len
, 1, NULL
, NULL
);
371 g_array_free(structures
, true);
375 nvdimm_dsm_read(void *opaque
, hwaddr addr
, unsigned size
)
381 nvdimm_dsm_write(void *opaque
, hwaddr addr
, uint64_t val
, unsigned size
)
385 static const MemoryRegionOps nvdimm_dsm_ops
= {
386 .read
= nvdimm_dsm_read
,
387 .write
= nvdimm_dsm_write
,
388 .endianness
= DEVICE_LITTLE_ENDIAN
,
390 .min_access_size
= 4,
391 .max_access_size
= 4,
395 void nvdimm_init_acpi_state(AcpiNVDIMMState
*state
, MemoryRegion
*io
,
396 FWCfgState
*fw_cfg
, Object
*owner
)
398 memory_region_init_io(&state
->io_mr
, owner
, &nvdimm_dsm_ops
, state
,
399 "nvdimm-acpi-io", NVDIMM_ACPI_IO_LEN
);
400 memory_region_add_subregion(io
, NVDIMM_ACPI_IO_BASE
, &state
->io_mr
);
402 state
->dsm_mem
= g_array_new(false, true /* clear */, 1);
403 acpi_data_push(state
->dsm_mem
, TARGET_PAGE_SIZE
);
404 fw_cfg_add_file(fw_cfg
, NVDIMM_DSM_MEM_FILE
, state
->dsm_mem
->data
,
405 state
->dsm_mem
->len
);
408 #define NVDIMM_COMMON_DSM "NCAL"
410 static void nvdimm_build_common_dsm(Aml
*dev
)
412 Aml
*method
, *ifctx
, *function
;
413 uint8_t byte_list
[1];
415 method
= aml_method(NVDIMM_COMMON_DSM
, 4, AML_NOTSERIALIZED
);
416 function
= aml_arg(2);
419 * function 0 is called to inquire what functions are supported by
422 ifctx
= aml_if(aml_equal(function
, aml_int(0)));
423 byte_list
[0] = 0 /* No function Supported */;
424 aml_append(ifctx
, aml_return(aml_buffer(1, byte_list
)));
425 aml_append(method
, ifctx
);
427 /* No function is supported yet. */
428 byte_list
[0] = 1 /* Not Supported */;
429 aml_append(method
, aml_return(aml_buffer(1, byte_list
)));
431 aml_append(dev
, method
);
434 static void nvdimm_build_device_dsm(Aml
*dev
)
438 method
= aml_method("_DSM", 4, AML_NOTSERIALIZED
);
439 aml_append(method
, aml_return(aml_call4(NVDIMM_COMMON_DSM
, aml_arg(0),
440 aml_arg(1), aml_arg(2), aml_arg(3))));
441 aml_append(dev
, method
);
444 static void nvdimm_build_nvdimm_devices(GSList
*device_list
, Aml
*root_dev
)
446 for (; device_list
; device_list
= device_list
->next
) {
447 DeviceState
*dev
= device_list
->data
;
448 int slot
= object_property_get_int(OBJECT(dev
), PC_DIMM_SLOT_PROP
,
450 uint32_t handle
= nvdimm_slot_to_handle(slot
);
453 nvdimm_dev
= aml_device("NV%02X", slot
);
456 * ACPI 6.0: 9.20 NVDIMM Devices:
458 * _ADR object that is used to supply OSPM with unique address
459 * of the NVDIMM device. This is done by returning the NFIT Device
460 * handle that is used to identify the associated entries in ACPI
461 * table NFIT or _FIT.
463 aml_append(nvdimm_dev
, aml_name_decl("_ADR", aml_int(handle
)));
465 nvdimm_build_device_dsm(nvdimm_dev
);
466 aml_append(root_dev
, nvdimm_dev
);
470 static void nvdimm_build_ssdt(GSList
*device_list
, GArray
*table_offsets
,
471 GArray
*table_data
, GArray
*linker
)
473 Aml
*ssdt
, *sb_scope
, *dev
;
475 acpi_add_table(table_offsets
, table_data
);
477 ssdt
= init_aml_allocator();
478 acpi_data_push(ssdt
->buf
, sizeof(AcpiTableHeader
));
480 sb_scope
= aml_scope("\\_SB");
482 dev
= aml_device("NVDR");
485 * ACPI 6.0: 9.20 NVDIMM Devices:
487 * The ACPI Name Space device uses _HID of ACPI0012 to identify the root
488 * NVDIMM interface device. Platform firmware is required to contain one
489 * such device in _SB scope if NVDIMMs support is exposed by platform to
491 * For each NVDIMM present or intended to be supported by platform,
492 * platform firmware also exposes an ACPI Namespace Device under the
495 aml_append(dev
, aml_name_decl("_HID", aml_string("ACPI0012")));
497 nvdimm_build_common_dsm(dev
);
498 nvdimm_build_device_dsm(dev
);
500 nvdimm_build_nvdimm_devices(device_list
, dev
);
502 aml_append(sb_scope
, dev
);
504 aml_append(ssdt
, sb_scope
);
505 /* copy AML table into ACPI tables blob and patch header there */
506 g_array_append_vals(table_data
, ssdt
->buf
->data
, ssdt
->buf
->len
);
507 build_header(linker
, table_data
,
508 (void *)(table_data
->data
+ table_data
->len
- ssdt
->buf
->len
),
509 "SSDT", ssdt
->buf
->len
, 1, NULL
, "NVDIMM");
510 free_aml_allocator();
513 void nvdimm_build_acpi(GArray
*table_offsets
, GArray
*table_data
,
518 /* no NVDIMM device is plugged. */
519 device_list
= nvdimm_get_plugged_device_list();
523 nvdimm_build_nfit(device_list
, table_offsets
, table_data
, linker
);
524 nvdimm_build_ssdt(device_list
, table_offsets
, table_data
, linker
);
525 g_slist_free(device_list
);