187252e1bSXiao Guangrong /* 287252e1bSXiao Guangrong * NVDIMM ACPI Implementation 387252e1bSXiao Guangrong * 487252e1bSXiao Guangrong * Copyright(C) 2015 Intel Corporation. 587252e1bSXiao Guangrong * 687252e1bSXiao Guangrong * Author: 787252e1bSXiao Guangrong * Xiao Guangrong <guangrong.xiao@linux.intel.com> 887252e1bSXiao Guangrong * 987252e1bSXiao Guangrong * NFIT is defined in ACPI 6.0: 5.2.25 NVDIMM Firmware Interface Table (NFIT) 1087252e1bSXiao Guangrong * and the DSM specification can be found at: 1187252e1bSXiao Guangrong * http://pmem.io/documents/NVDIMM_DSM_Interface_Example.pdf 1287252e1bSXiao Guangrong * 1387252e1bSXiao Guangrong * Currently, it only supports PMEM Virtualization. 1487252e1bSXiao Guangrong * 1587252e1bSXiao Guangrong * This library is free software; you can redistribute it and/or 1687252e1bSXiao Guangrong * modify it under the terms of the GNU Lesser General Public 1787252e1bSXiao Guangrong * License as published by the Free Software Foundation; either 1887252e1bSXiao Guangrong * version 2 of the License, or (at your option) any later version. 1987252e1bSXiao Guangrong * 2087252e1bSXiao Guangrong * This library is distributed in the hope that it will be useful, 2187252e1bSXiao Guangrong * but WITHOUT ANY WARRANTY; without even the implied warranty of 2287252e1bSXiao Guangrong * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 2387252e1bSXiao Guangrong * Lesser General Public License for more details. 2487252e1bSXiao Guangrong * 2587252e1bSXiao Guangrong * You should have received a copy of the GNU Lesser General Public 2687252e1bSXiao Guangrong * License along with this library; if not, see <http://www.gnu.org/licenses/> 2787252e1bSXiao Guangrong */ 2887252e1bSXiao Guangrong 29b6a0aa05SPeter Maydell #include "qemu/osdep.h" 3087252e1bSXiao Guangrong #include "hw/acpi/acpi.h" 3187252e1bSXiao Guangrong #include "hw/acpi/aml-build.h" 32b9951413SXiao Guangrong #include "hw/acpi/bios-linker-loader.h" 335fe79386SXiao Guangrong #include "hw/nvram/fw_cfg.h" 3487252e1bSXiao Guangrong #include "hw/mem/nvdimm.h" 3587252e1bSXiao Guangrong 3687252e1bSXiao Guangrong static int nvdimm_plugged_device_list(Object *obj, void *opaque) 3787252e1bSXiao Guangrong { 3887252e1bSXiao Guangrong GSList **list = opaque; 3987252e1bSXiao Guangrong 4087252e1bSXiao Guangrong if (object_dynamic_cast(obj, TYPE_NVDIMM)) { 4187252e1bSXiao Guangrong DeviceState *dev = DEVICE(obj); 4287252e1bSXiao Guangrong 4387252e1bSXiao Guangrong if (dev->realized) { /* only realized NVDIMMs matter */ 4487252e1bSXiao Guangrong *list = g_slist_append(*list, DEVICE(obj)); 4587252e1bSXiao Guangrong } 4687252e1bSXiao Guangrong } 4787252e1bSXiao Guangrong 4887252e1bSXiao Guangrong object_child_foreach(obj, nvdimm_plugged_device_list, opaque); 4987252e1bSXiao Guangrong return 0; 5087252e1bSXiao Guangrong } 5187252e1bSXiao Guangrong 5287252e1bSXiao Guangrong /* 5387252e1bSXiao Guangrong * inquire plugged NVDIMM devices and link them into the list which is 5487252e1bSXiao Guangrong * returned to the caller. 5587252e1bSXiao Guangrong * 5687252e1bSXiao Guangrong * Note: it is the caller's responsibility to free the list to avoid 5787252e1bSXiao Guangrong * memory leak. 5887252e1bSXiao Guangrong */ 5987252e1bSXiao Guangrong static GSList *nvdimm_get_plugged_device_list(void) 6087252e1bSXiao Guangrong { 6187252e1bSXiao Guangrong GSList *list = NULL; 6287252e1bSXiao Guangrong 6387252e1bSXiao Guangrong object_child_foreach(qdev_get_machine(), nvdimm_plugged_device_list, 6487252e1bSXiao Guangrong &list); 6587252e1bSXiao Guangrong return list; 6687252e1bSXiao Guangrong } 6787252e1bSXiao Guangrong 6887252e1bSXiao Guangrong #define NVDIMM_UUID_LE(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \ 6987252e1bSXiao Guangrong { (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \ 7087252e1bSXiao Guangrong (b) & 0xff, ((b) >> 8) & 0xff, (c) & 0xff, ((c) >> 8) & 0xff, \ 7187252e1bSXiao Guangrong (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } 7287252e1bSXiao Guangrong 7387252e1bSXiao Guangrong /* 7487252e1bSXiao Guangrong * define Byte Addressable Persistent Memory (PM) Region according to 7587252e1bSXiao Guangrong * ACPI 6.0: 5.2.25.1 System Physical Address Range Structure. 7687252e1bSXiao Guangrong */ 7787252e1bSXiao Guangrong static const uint8_t nvdimm_nfit_spa_uuid[] = 7887252e1bSXiao Guangrong NVDIMM_UUID_LE(0x66f0d379, 0xb4f3, 0x4074, 0xac, 0x43, 0x0d, 0x33, 7987252e1bSXiao Guangrong 0x18, 0xb7, 0x8c, 0xdb); 8087252e1bSXiao Guangrong 8187252e1bSXiao Guangrong /* 8287252e1bSXiao Guangrong * NVDIMM Firmware Interface Table 8387252e1bSXiao Guangrong * @signature: "NFIT" 8487252e1bSXiao Guangrong * 8587252e1bSXiao Guangrong * It provides information that allows OSPM to enumerate NVDIMM present in 8687252e1bSXiao Guangrong * the platform and associate system physical address ranges created by the 8787252e1bSXiao Guangrong * NVDIMMs. 8887252e1bSXiao Guangrong * 8987252e1bSXiao Guangrong * It is defined in ACPI 6.0: 5.2.25 NVDIMM Firmware Interface Table (NFIT) 9087252e1bSXiao Guangrong */ 9187252e1bSXiao Guangrong struct NvdimmNfitHeader { 9287252e1bSXiao Guangrong ACPI_TABLE_HEADER_DEF 9387252e1bSXiao Guangrong uint32_t reserved; 9487252e1bSXiao Guangrong } QEMU_PACKED; 9587252e1bSXiao Guangrong typedef struct NvdimmNfitHeader NvdimmNfitHeader; 9687252e1bSXiao Guangrong 9787252e1bSXiao Guangrong /* 9887252e1bSXiao Guangrong * define NFIT structures according to ACPI 6.0: 5.2.25 NVDIMM Firmware 9987252e1bSXiao Guangrong * Interface Table (NFIT). 10087252e1bSXiao Guangrong */ 10187252e1bSXiao Guangrong 10287252e1bSXiao Guangrong /* 10387252e1bSXiao Guangrong * System Physical Address Range Structure 10487252e1bSXiao Guangrong * 10587252e1bSXiao Guangrong * It describes the system physical address ranges occupied by NVDIMMs and 10687252e1bSXiao Guangrong * the types of the regions. 10787252e1bSXiao Guangrong */ 10887252e1bSXiao Guangrong struct NvdimmNfitSpa { 10987252e1bSXiao Guangrong uint16_t type; 11087252e1bSXiao Guangrong uint16_t length; 11187252e1bSXiao Guangrong uint16_t spa_index; 11287252e1bSXiao Guangrong uint16_t flags; 11387252e1bSXiao Guangrong uint32_t reserved; 11487252e1bSXiao Guangrong uint32_t proximity_domain; 11587252e1bSXiao Guangrong uint8_t type_guid[16]; 11687252e1bSXiao Guangrong uint64_t spa_base; 11787252e1bSXiao Guangrong uint64_t spa_length; 11887252e1bSXiao Guangrong uint64_t mem_attr; 11987252e1bSXiao Guangrong } QEMU_PACKED; 12087252e1bSXiao Guangrong typedef struct NvdimmNfitSpa NvdimmNfitSpa; 12187252e1bSXiao Guangrong 12287252e1bSXiao Guangrong /* 12387252e1bSXiao Guangrong * Memory Device to System Physical Address Range Mapping Structure 12487252e1bSXiao Guangrong * 12587252e1bSXiao Guangrong * It enables identifying each NVDIMM region and the corresponding SPA 12687252e1bSXiao Guangrong * describing the memory interleave 12787252e1bSXiao Guangrong */ 12887252e1bSXiao Guangrong struct NvdimmNfitMemDev { 12987252e1bSXiao Guangrong uint16_t type; 13087252e1bSXiao Guangrong uint16_t length; 13187252e1bSXiao Guangrong uint32_t nfit_handle; 13287252e1bSXiao Guangrong uint16_t phys_id; 13387252e1bSXiao Guangrong uint16_t region_id; 13487252e1bSXiao Guangrong uint16_t spa_index; 13587252e1bSXiao Guangrong uint16_t dcr_index; 13687252e1bSXiao Guangrong uint64_t region_len; 13787252e1bSXiao Guangrong uint64_t region_offset; 13887252e1bSXiao Guangrong uint64_t region_dpa; 13987252e1bSXiao Guangrong uint16_t interleave_index; 14087252e1bSXiao Guangrong uint16_t interleave_ways; 14187252e1bSXiao Guangrong uint16_t flags; 14287252e1bSXiao Guangrong uint16_t reserved; 14387252e1bSXiao Guangrong } QEMU_PACKED; 14487252e1bSXiao Guangrong typedef struct NvdimmNfitMemDev NvdimmNfitMemDev; 14587252e1bSXiao Guangrong 14687252e1bSXiao Guangrong /* 14787252e1bSXiao Guangrong * NVDIMM Control Region Structure 14887252e1bSXiao Guangrong * 14987252e1bSXiao Guangrong * It describes the NVDIMM and if applicable, Block Control Window. 15087252e1bSXiao Guangrong */ 15187252e1bSXiao Guangrong struct NvdimmNfitControlRegion { 15287252e1bSXiao Guangrong uint16_t type; 15387252e1bSXiao Guangrong uint16_t length; 15487252e1bSXiao Guangrong uint16_t dcr_index; 15587252e1bSXiao Guangrong uint16_t vendor_id; 15687252e1bSXiao Guangrong uint16_t device_id; 15787252e1bSXiao Guangrong uint16_t revision_id; 15887252e1bSXiao Guangrong uint16_t sub_vendor_id; 15987252e1bSXiao Guangrong uint16_t sub_device_id; 16087252e1bSXiao Guangrong uint16_t sub_revision_id; 16187252e1bSXiao Guangrong uint8_t reserved[6]; 16287252e1bSXiao Guangrong uint32_t serial_number; 16387252e1bSXiao Guangrong uint16_t fic; 16487252e1bSXiao Guangrong uint16_t num_bcw; 16587252e1bSXiao Guangrong uint64_t bcw_size; 16687252e1bSXiao Guangrong uint64_t cmd_offset; 16787252e1bSXiao Guangrong uint64_t cmd_size; 16887252e1bSXiao Guangrong uint64_t status_offset; 16987252e1bSXiao Guangrong uint64_t status_size; 17087252e1bSXiao Guangrong uint16_t flags; 17187252e1bSXiao Guangrong uint8_t reserved2[6]; 17287252e1bSXiao Guangrong } QEMU_PACKED; 17387252e1bSXiao Guangrong typedef struct NvdimmNfitControlRegion NvdimmNfitControlRegion; 17487252e1bSXiao Guangrong 17587252e1bSXiao Guangrong /* 17687252e1bSXiao Guangrong * Module serial number is a unique number for each device. We use the 17787252e1bSXiao Guangrong * slot id of NVDIMM device to generate this number so that each device 17887252e1bSXiao Guangrong * associates with a different number. 17987252e1bSXiao Guangrong * 18087252e1bSXiao Guangrong * 0x123456 is a magic number we arbitrarily chose. 18187252e1bSXiao Guangrong */ 18287252e1bSXiao Guangrong static uint32_t nvdimm_slot_to_sn(int slot) 18387252e1bSXiao Guangrong { 18487252e1bSXiao Guangrong return 0x123456 + slot; 18587252e1bSXiao Guangrong } 18687252e1bSXiao Guangrong 18787252e1bSXiao Guangrong /* 18887252e1bSXiao Guangrong * handle is used to uniquely associate nfit_memdev structure with NVDIMM 18987252e1bSXiao Guangrong * ACPI device - nfit_memdev.nfit_handle matches with the value returned 19087252e1bSXiao Guangrong * by ACPI device _ADR method. 19187252e1bSXiao Guangrong * 19287252e1bSXiao Guangrong * We generate the handle with the slot id of NVDIMM device and reserve 19387252e1bSXiao Guangrong * 0 for NVDIMM root device. 19487252e1bSXiao Guangrong */ 19587252e1bSXiao Guangrong static uint32_t nvdimm_slot_to_handle(int slot) 19687252e1bSXiao Guangrong { 19787252e1bSXiao Guangrong return slot + 1; 19887252e1bSXiao Guangrong } 19987252e1bSXiao Guangrong 20087252e1bSXiao Guangrong /* 20187252e1bSXiao Guangrong * index uniquely identifies the structure, 0 is reserved which indicates 20287252e1bSXiao Guangrong * that the structure is not valid or the associated structure is not 20387252e1bSXiao Guangrong * present. 20487252e1bSXiao Guangrong * 20587252e1bSXiao Guangrong * Each NVDIMM device needs two indexes, one for nfit_spa and another for 20687252e1bSXiao Guangrong * nfit_dc which are generated by the slot id of NVDIMM device. 20787252e1bSXiao Guangrong */ 20887252e1bSXiao Guangrong static uint16_t nvdimm_slot_to_spa_index(int slot) 20987252e1bSXiao Guangrong { 21087252e1bSXiao Guangrong return (slot + 1) << 1; 21187252e1bSXiao Guangrong } 21287252e1bSXiao Guangrong 21387252e1bSXiao Guangrong /* See the comments of nvdimm_slot_to_spa_index(). */ 21487252e1bSXiao Guangrong static uint32_t nvdimm_slot_to_dcr_index(int slot) 21587252e1bSXiao Guangrong { 21687252e1bSXiao Guangrong return nvdimm_slot_to_spa_index(slot) + 1; 21787252e1bSXiao Guangrong } 21887252e1bSXiao Guangrong 2195797dcdcSXiao Guangrong static NVDIMMDevice *nvdimm_get_device_by_handle(uint32_t handle) 2205797dcdcSXiao Guangrong { 2215797dcdcSXiao Guangrong NVDIMMDevice *nvdimm = NULL; 2225797dcdcSXiao Guangrong GSList *list, *device_list = nvdimm_get_plugged_device_list(); 2235797dcdcSXiao Guangrong 2245797dcdcSXiao Guangrong for (list = device_list; list; list = list->next) { 2255797dcdcSXiao Guangrong NVDIMMDevice *nvd = list->data; 2265797dcdcSXiao Guangrong int slot = object_property_get_int(OBJECT(nvd), PC_DIMM_SLOT_PROP, 2275797dcdcSXiao Guangrong NULL); 2285797dcdcSXiao Guangrong 2295797dcdcSXiao Guangrong if (nvdimm_slot_to_handle(slot) == handle) { 2305797dcdcSXiao Guangrong nvdimm = nvd; 2315797dcdcSXiao Guangrong break; 2325797dcdcSXiao Guangrong } 2335797dcdcSXiao Guangrong } 2345797dcdcSXiao Guangrong 2355797dcdcSXiao Guangrong g_slist_free(device_list); 2365797dcdcSXiao Guangrong return nvdimm; 2375797dcdcSXiao Guangrong } 2385797dcdcSXiao Guangrong 23987252e1bSXiao Guangrong /* ACPI 6.0: 5.2.25.1 System Physical Address Range Structure */ 24087252e1bSXiao Guangrong static void 24187252e1bSXiao Guangrong nvdimm_build_structure_spa(GArray *structures, DeviceState *dev) 24287252e1bSXiao Guangrong { 24387252e1bSXiao Guangrong NvdimmNfitSpa *nfit_spa; 24487252e1bSXiao Guangrong uint64_t addr = object_property_get_int(OBJECT(dev), PC_DIMM_ADDR_PROP, 24587252e1bSXiao Guangrong NULL); 24687252e1bSXiao Guangrong uint64_t size = object_property_get_int(OBJECT(dev), PC_DIMM_SIZE_PROP, 24787252e1bSXiao Guangrong NULL); 24887252e1bSXiao Guangrong uint32_t node = object_property_get_int(OBJECT(dev), PC_DIMM_NODE_PROP, 24987252e1bSXiao Guangrong NULL); 25087252e1bSXiao Guangrong int slot = object_property_get_int(OBJECT(dev), PC_DIMM_SLOT_PROP, 25187252e1bSXiao Guangrong NULL); 25287252e1bSXiao Guangrong 25387252e1bSXiao Guangrong nfit_spa = acpi_data_push(structures, sizeof(*nfit_spa)); 25487252e1bSXiao Guangrong 25587252e1bSXiao Guangrong nfit_spa->type = cpu_to_le16(0 /* System Physical Address Range 25687252e1bSXiao Guangrong Structure */); 25787252e1bSXiao Guangrong nfit_spa->length = cpu_to_le16(sizeof(*nfit_spa)); 25887252e1bSXiao Guangrong nfit_spa->spa_index = cpu_to_le16(nvdimm_slot_to_spa_index(slot)); 25987252e1bSXiao Guangrong 26087252e1bSXiao Guangrong /* 26187252e1bSXiao Guangrong * Control region is strict as all the device info, such as SN, index, 26287252e1bSXiao Guangrong * is associated with slot id. 26387252e1bSXiao Guangrong */ 26487252e1bSXiao Guangrong nfit_spa->flags = cpu_to_le16(1 /* Control region is strictly for 26587252e1bSXiao Guangrong management during hot add/online 26687252e1bSXiao Guangrong operation */ | 26787252e1bSXiao Guangrong 2 /* Data in Proximity Domain field is 26887252e1bSXiao Guangrong valid*/); 26987252e1bSXiao Guangrong 27087252e1bSXiao Guangrong /* NUMA node. */ 27187252e1bSXiao Guangrong nfit_spa->proximity_domain = cpu_to_le32(node); 27287252e1bSXiao Guangrong /* the region reported as PMEM. */ 27387252e1bSXiao Guangrong memcpy(nfit_spa->type_guid, nvdimm_nfit_spa_uuid, 27487252e1bSXiao Guangrong sizeof(nvdimm_nfit_spa_uuid)); 27587252e1bSXiao Guangrong 27687252e1bSXiao Guangrong nfit_spa->spa_base = cpu_to_le64(addr); 27787252e1bSXiao Guangrong nfit_spa->spa_length = cpu_to_le64(size); 27887252e1bSXiao Guangrong 27987252e1bSXiao Guangrong /* It is the PMEM and can be cached as writeback. */ 28087252e1bSXiao Guangrong nfit_spa->mem_attr = cpu_to_le64(0x8ULL /* EFI_MEMORY_WB */ | 28187252e1bSXiao Guangrong 0x8000ULL /* EFI_MEMORY_NV */); 28287252e1bSXiao Guangrong } 28387252e1bSXiao Guangrong 28487252e1bSXiao Guangrong /* 28587252e1bSXiao Guangrong * ACPI 6.0: 5.2.25.2 Memory Device to System Physical Address Range Mapping 28687252e1bSXiao Guangrong * Structure 28787252e1bSXiao Guangrong */ 28887252e1bSXiao Guangrong static void 28987252e1bSXiao Guangrong nvdimm_build_structure_memdev(GArray *structures, DeviceState *dev) 29087252e1bSXiao Guangrong { 29187252e1bSXiao Guangrong NvdimmNfitMemDev *nfit_memdev; 29287252e1bSXiao Guangrong uint64_t size = object_property_get_int(OBJECT(dev), PC_DIMM_SIZE_PROP, 29387252e1bSXiao Guangrong NULL); 29487252e1bSXiao Guangrong int slot = object_property_get_int(OBJECT(dev), PC_DIMM_SLOT_PROP, 29587252e1bSXiao Guangrong NULL); 29687252e1bSXiao Guangrong uint32_t handle = nvdimm_slot_to_handle(slot); 29787252e1bSXiao Guangrong 29887252e1bSXiao Guangrong nfit_memdev = acpi_data_push(structures, sizeof(*nfit_memdev)); 29987252e1bSXiao Guangrong 30087252e1bSXiao Guangrong nfit_memdev->type = cpu_to_le16(1 /* Memory Device to System Address 30187252e1bSXiao Guangrong Range Map Structure*/); 30287252e1bSXiao Guangrong nfit_memdev->length = cpu_to_le16(sizeof(*nfit_memdev)); 30387252e1bSXiao Guangrong nfit_memdev->nfit_handle = cpu_to_le32(handle); 30487252e1bSXiao Guangrong 30587252e1bSXiao Guangrong /* 30687252e1bSXiao Guangrong * associate memory device with System Physical Address Range 30787252e1bSXiao Guangrong * Structure. 30887252e1bSXiao Guangrong */ 30987252e1bSXiao Guangrong nfit_memdev->spa_index = cpu_to_le16(nvdimm_slot_to_spa_index(slot)); 31087252e1bSXiao Guangrong /* associate memory device with Control Region Structure. */ 31187252e1bSXiao Guangrong nfit_memdev->dcr_index = cpu_to_le16(nvdimm_slot_to_dcr_index(slot)); 31287252e1bSXiao Guangrong 31387252e1bSXiao Guangrong /* The memory region on the device. */ 31487252e1bSXiao Guangrong nfit_memdev->region_len = cpu_to_le64(size); 3156ab0c4bdSXiao Guangrong /* The device address starts from 0. */ 3166ab0c4bdSXiao Guangrong nfit_memdev->region_dpa = cpu_to_le64(0); 31787252e1bSXiao Guangrong 31887252e1bSXiao Guangrong /* Only one interleave for PMEM. */ 31987252e1bSXiao Guangrong nfit_memdev->interleave_ways = cpu_to_le16(1); 32087252e1bSXiao Guangrong } 32187252e1bSXiao Guangrong 32287252e1bSXiao Guangrong /* 32387252e1bSXiao Guangrong * ACPI 6.0: 5.2.25.5 NVDIMM Control Region Structure. 32487252e1bSXiao Guangrong */ 32587252e1bSXiao Guangrong static void nvdimm_build_structure_dcr(GArray *structures, DeviceState *dev) 32687252e1bSXiao Guangrong { 32787252e1bSXiao Guangrong NvdimmNfitControlRegion *nfit_dcr; 32887252e1bSXiao Guangrong int slot = object_property_get_int(OBJECT(dev), PC_DIMM_SLOT_PROP, 32987252e1bSXiao Guangrong NULL); 33087252e1bSXiao Guangrong uint32_t sn = nvdimm_slot_to_sn(slot); 33187252e1bSXiao Guangrong 33287252e1bSXiao Guangrong nfit_dcr = acpi_data_push(structures, sizeof(*nfit_dcr)); 33387252e1bSXiao Guangrong 33487252e1bSXiao Guangrong nfit_dcr->type = cpu_to_le16(4 /* NVDIMM Control Region Structure */); 33587252e1bSXiao Guangrong nfit_dcr->length = cpu_to_le16(sizeof(*nfit_dcr)); 33687252e1bSXiao Guangrong nfit_dcr->dcr_index = cpu_to_le16(nvdimm_slot_to_dcr_index(slot)); 33787252e1bSXiao Guangrong 33887252e1bSXiao Guangrong /* vendor: Intel. */ 33987252e1bSXiao Guangrong nfit_dcr->vendor_id = cpu_to_le16(0x8086); 34087252e1bSXiao Guangrong nfit_dcr->device_id = cpu_to_le16(1); 34187252e1bSXiao Guangrong 34287252e1bSXiao Guangrong /* The _DSM method is following Intel's DSM specification. */ 34387252e1bSXiao Guangrong nfit_dcr->revision_id = cpu_to_le16(1 /* Current Revision supported 34487252e1bSXiao Guangrong in ACPI 6.0 is 1. */); 34587252e1bSXiao Guangrong nfit_dcr->serial_number = cpu_to_le32(sn); 34687252e1bSXiao Guangrong nfit_dcr->fic = cpu_to_le16(0x201 /* Format Interface Code. See Chapter 34787252e1bSXiao Guangrong 2: NVDIMM Device Specific Method 34887252e1bSXiao Guangrong (DSM) in DSM Spec Rev1.*/); 34987252e1bSXiao Guangrong } 35087252e1bSXiao Guangrong 351*75b0713eSXiao Guangrong static GArray *nvdimm_build_device_structure(void) 35287252e1bSXiao Guangrong { 353*75b0713eSXiao Guangrong GSList *device_list = nvdimm_get_plugged_device_list(); 35487252e1bSXiao Guangrong GArray *structures = g_array_new(false, true /* clear */, 1); 35587252e1bSXiao Guangrong 35687252e1bSXiao Guangrong for (; device_list; device_list = device_list->next) { 35787252e1bSXiao Guangrong DeviceState *dev = device_list->data; 35887252e1bSXiao Guangrong 35987252e1bSXiao Guangrong /* build System Physical Address Range Structure. */ 36087252e1bSXiao Guangrong nvdimm_build_structure_spa(structures, dev); 36187252e1bSXiao Guangrong 36287252e1bSXiao Guangrong /* 36387252e1bSXiao Guangrong * build Memory Device to System Physical Address Range Mapping 36487252e1bSXiao Guangrong * Structure. 36587252e1bSXiao Guangrong */ 36687252e1bSXiao Guangrong nvdimm_build_structure_memdev(structures, dev); 36787252e1bSXiao Guangrong 36887252e1bSXiao Guangrong /* build NVDIMM Control Region Structure. */ 36987252e1bSXiao Guangrong nvdimm_build_structure_dcr(structures, dev); 37087252e1bSXiao Guangrong } 371*75b0713eSXiao Guangrong g_slist_free(device_list); 37287252e1bSXiao Guangrong 37387252e1bSXiao Guangrong return structures; 37487252e1bSXiao Guangrong } 37587252e1bSXiao Guangrong 376*75b0713eSXiao Guangrong static void nvdimm_init_fit_buffer(NvdimmFitBuffer *fit_buf) 377*75b0713eSXiao Guangrong { 378*75b0713eSXiao Guangrong qemu_mutex_init(&fit_buf->lock); 379*75b0713eSXiao Guangrong fit_buf->fit = g_array_new(false, true /* clear */, 1); 380*75b0713eSXiao Guangrong } 381*75b0713eSXiao Guangrong 382*75b0713eSXiao Guangrong static void nvdimm_build_fit_buffer(NvdimmFitBuffer *fit_buf) 383*75b0713eSXiao Guangrong { 384*75b0713eSXiao Guangrong qemu_mutex_lock(&fit_buf->lock); 385*75b0713eSXiao Guangrong g_array_free(fit_buf->fit, true); 386*75b0713eSXiao Guangrong fit_buf->fit = nvdimm_build_device_structure(); 387*75b0713eSXiao Guangrong fit_buf->dirty = true; 388*75b0713eSXiao Guangrong qemu_mutex_unlock(&fit_buf->lock); 389*75b0713eSXiao Guangrong } 390*75b0713eSXiao Guangrong 391*75b0713eSXiao Guangrong void nvdimm_acpi_hotplug(AcpiNVDIMMState *state) 392*75b0713eSXiao Guangrong { 393*75b0713eSXiao Guangrong nvdimm_build_fit_buffer(&state->fit_buf); 394*75b0713eSXiao Guangrong } 395*75b0713eSXiao Guangrong 396*75b0713eSXiao Guangrong static void nvdimm_build_nfit(AcpiNVDIMMState *state, GArray *table_offsets, 3970e9b9edaSIgor Mammedov GArray *table_data, BIOSLinker *linker) 39887252e1bSXiao Guangrong { 399*75b0713eSXiao Guangrong NvdimmFitBuffer *fit_buf = &state->fit_buf; 400c8e6c938SHaozhong Zhang unsigned int header; 40187252e1bSXiao Guangrong 402*75b0713eSXiao Guangrong qemu_mutex_lock(&fit_buf->lock); 403*75b0713eSXiao Guangrong 404*75b0713eSXiao Guangrong /* NVDIMM device is not plugged? */ 405*75b0713eSXiao Guangrong if (!fit_buf->fit->len) { 406*75b0713eSXiao Guangrong goto exit; 407*75b0713eSXiao Guangrong } 408*75b0713eSXiao Guangrong 40987252e1bSXiao Guangrong acpi_add_table(table_offsets, table_data); 41087252e1bSXiao Guangrong 41187252e1bSXiao Guangrong /* NFIT header. */ 412c8e6c938SHaozhong Zhang header = table_data->len; 413c8e6c938SHaozhong Zhang acpi_data_push(table_data, sizeof(NvdimmNfitHeader)); 41487252e1bSXiao Guangrong /* NVDIMM device structures. */ 415*75b0713eSXiao Guangrong g_array_append_vals(table_data, fit_buf->fit->data, fit_buf->fit->len); 41687252e1bSXiao Guangrong 417c8e6c938SHaozhong Zhang build_header(linker, table_data, 418c8e6c938SHaozhong Zhang (void *)(table_data->data + header), "NFIT", 419*75b0713eSXiao Guangrong sizeof(NvdimmNfitHeader) + fit_buf->fit->len, 1, NULL, NULL); 420*75b0713eSXiao Guangrong 421*75b0713eSXiao Guangrong exit: 422*75b0713eSXiao Guangrong qemu_mutex_unlock(&fit_buf->lock); 42387252e1bSXiao Guangrong } 42487252e1bSXiao Guangrong 42518c440e1SXiao Guangrong struct NvdimmDsmIn { 42618c440e1SXiao Guangrong uint32_t handle; 42718c440e1SXiao Guangrong uint32_t revision; 42818c440e1SXiao Guangrong uint32_t function; 42918c440e1SXiao Guangrong /* the remaining size in the page is used by arg3. */ 43018c440e1SXiao Guangrong union { 43135c5a52dSPaolo Bonzini uint8_t arg3[4084]; 43218c440e1SXiao Guangrong }; 43318c440e1SXiao Guangrong } QEMU_PACKED; 43418c440e1SXiao Guangrong typedef struct NvdimmDsmIn NvdimmDsmIn; 43535c5a52dSPaolo Bonzini QEMU_BUILD_BUG_ON(sizeof(NvdimmDsmIn) != 4096); 43618c440e1SXiao Guangrong 43718c440e1SXiao Guangrong struct NvdimmDsmOut { 43818c440e1SXiao Guangrong /* the size of buffer filled by QEMU. */ 43918c440e1SXiao Guangrong uint32_t len; 44035c5a52dSPaolo Bonzini uint8_t data[4092]; 44118c440e1SXiao Guangrong } QEMU_PACKED; 44218c440e1SXiao Guangrong typedef struct NvdimmDsmOut NvdimmDsmOut; 44335c5a52dSPaolo Bonzini QEMU_BUILD_BUG_ON(sizeof(NvdimmDsmOut) != 4096); 44418c440e1SXiao Guangrong 445f7df22deSXiao Guangrong struct NvdimmDsmFunc0Out { 446f7df22deSXiao Guangrong /* the size of buffer filled by QEMU. */ 447f7df22deSXiao Guangrong uint32_t len; 448f7df22deSXiao Guangrong uint32_t supported_func; 449f7df22deSXiao Guangrong } QEMU_PACKED; 450f7df22deSXiao Guangrong typedef struct NvdimmDsmFunc0Out NvdimmDsmFunc0Out; 451f7df22deSXiao Guangrong 452f7df22deSXiao Guangrong struct NvdimmDsmFuncNoPayloadOut { 453f7df22deSXiao Guangrong /* the size of buffer filled by QEMU. */ 454f7df22deSXiao Guangrong uint32_t len; 455f7df22deSXiao Guangrong uint32_t func_ret_status; 456f7df22deSXiao Guangrong } QEMU_PACKED; 457f7df22deSXiao Guangrong typedef struct NvdimmDsmFuncNoPayloadOut NvdimmDsmFuncNoPayloadOut; 458f7df22deSXiao Guangrong 4595797dcdcSXiao Guangrong struct NvdimmFuncGetLabelSizeOut { 4605797dcdcSXiao Guangrong /* the size of buffer filled by QEMU. */ 4615797dcdcSXiao Guangrong uint32_t len; 4625797dcdcSXiao Guangrong uint32_t func_ret_status; /* return status code. */ 4635797dcdcSXiao Guangrong uint32_t label_size; /* the size of label data area. */ 4645797dcdcSXiao Guangrong /* 4655797dcdcSXiao Guangrong * Maximum size of the namespace label data length supported by 4665797dcdcSXiao Guangrong * the platform in Get/Set Namespace Label Data functions. 4675797dcdcSXiao Guangrong */ 4685797dcdcSXiao Guangrong uint32_t max_xfer; 4695797dcdcSXiao Guangrong } QEMU_PACKED; 4705797dcdcSXiao Guangrong typedef struct NvdimmFuncGetLabelSizeOut NvdimmFuncGetLabelSizeOut; 4715797dcdcSXiao Guangrong QEMU_BUILD_BUG_ON(sizeof(NvdimmFuncGetLabelSizeOut) > 4096); 4725797dcdcSXiao Guangrong 4732b9e57fcSXiao Guangrong struct NvdimmFuncGetLabelDataIn { 4742b9e57fcSXiao Guangrong uint32_t offset; /* the offset in the namespace label data area. */ 4752b9e57fcSXiao Guangrong uint32_t length; /* the size of data is to be read via the function. */ 4762b9e57fcSXiao Guangrong } QEMU_PACKED; 4772b9e57fcSXiao Guangrong typedef struct NvdimmFuncGetLabelDataIn NvdimmFuncGetLabelDataIn; 4782b9e57fcSXiao Guangrong QEMU_BUILD_BUG_ON(sizeof(NvdimmFuncGetLabelDataIn) + 4792b9e57fcSXiao Guangrong offsetof(NvdimmDsmIn, arg3) > 4096); 4802b9e57fcSXiao Guangrong 4815797dcdcSXiao Guangrong struct NvdimmFuncGetLabelDataOut { 4825797dcdcSXiao Guangrong /* the size of buffer filled by QEMU. */ 4835797dcdcSXiao Guangrong uint32_t len; 4845797dcdcSXiao Guangrong uint32_t func_ret_status; /* return status code. */ 4855797dcdcSXiao Guangrong uint8_t out_buf[0]; /* the data got via Get Namesapce Label function. */ 4865797dcdcSXiao Guangrong } QEMU_PACKED; 4875797dcdcSXiao Guangrong typedef struct NvdimmFuncGetLabelDataOut NvdimmFuncGetLabelDataOut; 4882b9e57fcSXiao Guangrong QEMU_BUILD_BUG_ON(sizeof(NvdimmFuncGetLabelDataOut) > 4096); 4895797dcdcSXiao Guangrong 4905797dcdcSXiao Guangrong struct NvdimmFuncSetLabelDataIn { 4915797dcdcSXiao Guangrong uint32_t offset; /* the offset in the namespace label data area. */ 4925797dcdcSXiao Guangrong uint32_t length; /* the size of data is to be written via the function. */ 4935797dcdcSXiao Guangrong uint8_t in_buf[0]; /* the data written to label data area. */ 4945797dcdcSXiao Guangrong } QEMU_PACKED; 4955797dcdcSXiao Guangrong typedef struct NvdimmFuncSetLabelDataIn NvdimmFuncSetLabelDataIn; 49614e44198SXiao Guangrong QEMU_BUILD_BUG_ON(sizeof(NvdimmFuncSetLabelDataIn) + 49714e44198SXiao Guangrong offsetof(NvdimmDsmIn, arg3) > 4096); 4985797dcdcSXiao Guangrong 499189f4d56SXiao Guangrong static void 500189f4d56SXiao Guangrong nvdimm_dsm_function0(uint32_t supported_func, hwaddr dsm_mem_addr) 501189f4d56SXiao Guangrong { 502189f4d56SXiao Guangrong NvdimmDsmFunc0Out func0 = { 503189f4d56SXiao Guangrong .len = cpu_to_le32(sizeof(func0)), 504189f4d56SXiao Guangrong .supported_func = cpu_to_le32(supported_func), 505189f4d56SXiao Guangrong }; 506189f4d56SXiao Guangrong cpu_physical_memory_write(dsm_mem_addr, &func0, sizeof(func0)); 507189f4d56SXiao Guangrong } 508189f4d56SXiao Guangrong 509189f4d56SXiao Guangrong static void 510189f4d56SXiao Guangrong nvdimm_dsm_no_payload(uint32_t func_ret_status, hwaddr dsm_mem_addr) 511189f4d56SXiao Guangrong { 512189f4d56SXiao Guangrong NvdimmDsmFuncNoPayloadOut out = { 513189f4d56SXiao Guangrong .len = cpu_to_le32(sizeof(out)), 514189f4d56SXiao Guangrong .func_ret_status = cpu_to_le32(func_ret_status), 515189f4d56SXiao Guangrong }; 516189f4d56SXiao Guangrong cpu_physical_memory_write(dsm_mem_addr, &out, sizeof(out)); 517189f4d56SXiao Guangrong } 518189f4d56SXiao Guangrong 519189f4d56SXiao Guangrong static void nvdimm_dsm_root(NvdimmDsmIn *in, hwaddr dsm_mem_addr) 520189f4d56SXiao Guangrong { 521189f4d56SXiao Guangrong /* 522189f4d56SXiao Guangrong * function 0 is called to inquire which functions are supported by 523189f4d56SXiao Guangrong * OSPM 524189f4d56SXiao Guangrong */ 525189f4d56SXiao Guangrong if (!in->function) { 526189f4d56SXiao Guangrong nvdimm_dsm_function0(0 /* No function supported other than 527189f4d56SXiao Guangrong function 0 */, dsm_mem_addr); 528189f4d56SXiao Guangrong return; 529189f4d56SXiao Guangrong } 530189f4d56SXiao Guangrong 531189f4d56SXiao Guangrong /* No function except function 0 is supported yet. */ 532189f4d56SXiao Guangrong nvdimm_dsm_no_payload(1 /* Not Supported */, dsm_mem_addr); 533189f4d56SXiao Guangrong } 534189f4d56SXiao Guangrong 5355797dcdcSXiao Guangrong /* 5365797dcdcSXiao Guangrong * the max transfer size is the max size transferred by both a 5375797dcdcSXiao Guangrong * 'Get Namespace Label Data' function and a 'Set Namespace Label Data' 5385797dcdcSXiao Guangrong * function. 5395797dcdcSXiao Guangrong */ 5405797dcdcSXiao Guangrong static uint32_t nvdimm_get_max_xfer_label_size(void) 5415797dcdcSXiao Guangrong { 5425797dcdcSXiao Guangrong uint32_t max_get_size, max_set_size, dsm_memory_size = 4096; 5435797dcdcSXiao Guangrong 5445797dcdcSXiao Guangrong /* 5455797dcdcSXiao Guangrong * the max data ACPI can read one time which is transferred by 5465797dcdcSXiao Guangrong * the response of 'Get Namespace Label Data' function. 5475797dcdcSXiao Guangrong */ 5485797dcdcSXiao Guangrong max_get_size = dsm_memory_size - sizeof(NvdimmFuncGetLabelDataOut); 5495797dcdcSXiao Guangrong 5505797dcdcSXiao Guangrong /* 5515797dcdcSXiao Guangrong * the max data ACPI can write one time which is transferred by 5525797dcdcSXiao Guangrong * 'Set Namespace Label Data' function. 5535797dcdcSXiao Guangrong */ 5545797dcdcSXiao Guangrong max_set_size = dsm_memory_size - offsetof(NvdimmDsmIn, arg3) - 5555797dcdcSXiao Guangrong sizeof(NvdimmFuncSetLabelDataIn); 5565797dcdcSXiao Guangrong 5575797dcdcSXiao Guangrong return MIN(max_get_size, max_set_size); 5585797dcdcSXiao Guangrong } 5595797dcdcSXiao Guangrong 5605797dcdcSXiao Guangrong /* 5615797dcdcSXiao Guangrong * DSM Spec Rev1 4.4 Get Namespace Label Size (Function Index 4). 5625797dcdcSXiao Guangrong * 5635797dcdcSXiao Guangrong * It gets the size of Namespace Label data area and the max data size 5645797dcdcSXiao Guangrong * that Get/Set Namespace Label Data functions can transfer. 5655797dcdcSXiao Guangrong */ 5665797dcdcSXiao Guangrong static void nvdimm_dsm_label_size(NVDIMMDevice *nvdimm, hwaddr dsm_mem_addr) 5675797dcdcSXiao Guangrong { 5685797dcdcSXiao Guangrong NvdimmFuncGetLabelSizeOut label_size_out = { 5695797dcdcSXiao Guangrong .len = cpu_to_le32(sizeof(label_size_out)), 5705797dcdcSXiao Guangrong }; 5715797dcdcSXiao Guangrong uint32_t label_size, mxfer; 5725797dcdcSXiao Guangrong 5735797dcdcSXiao Guangrong label_size = nvdimm->label_size; 5745797dcdcSXiao Guangrong mxfer = nvdimm_get_max_xfer_label_size(); 5755797dcdcSXiao Guangrong 5765797dcdcSXiao Guangrong nvdimm_debug("label_size %#x, max_xfer %#x.\n", label_size, mxfer); 5775797dcdcSXiao Guangrong 5785797dcdcSXiao Guangrong label_size_out.func_ret_status = cpu_to_le32(0 /* Success */); 5795797dcdcSXiao Guangrong label_size_out.label_size = cpu_to_le32(label_size); 5805797dcdcSXiao Guangrong label_size_out.max_xfer = cpu_to_le32(mxfer); 5815797dcdcSXiao Guangrong 5825797dcdcSXiao Guangrong cpu_physical_memory_write(dsm_mem_addr, &label_size_out, 5835797dcdcSXiao Guangrong sizeof(label_size_out)); 5845797dcdcSXiao Guangrong } 5855797dcdcSXiao Guangrong 5862b9e57fcSXiao Guangrong static uint32_t nvdimm_rw_label_data_check(NVDIMMDevice *nvdimm, 5872b9e57fcSXiao Guangrong uint32_t offset, uint32_t length) 5882b9e57fcSXiao Guangrong { 5892b9e57fcSXiao Guangrong uint32_t ret = 3 /* Invalid Input Parameters */; 5902b9e57fcSXiao Guangrong 5912b9e57fcSXiao Guangrong if (offset + length < offset) { 5922b9e57fcSXiao Guangrong nvdimm_debug("offset %#x + length %#x is overflow.\n", offset, 5932b9e57fcSXiao Guangrong length); 5942b9e57fcSXiao Guangrong return ret; 5952b9e57fcSXiao Guangrong } 5962b9e57fcSXiao Guangrong 5972b9e57fcSXiao Guangrong if (nvdimm->label_size < offset + length) { 5982b9e57fcSXiao Guangrong nvdimm_debug("position %#x is beyond label data (len = %" PRIx64 ").\n", 5992b9e57fcSXiao Guangrong offset + length, nvdimm->label_size); 6002b9e57fcSXiao Guangrong return ret; 6012b9e57fcSXiao Guangrong } 6022b9e57fcSXiao Guangrong 6032b9e57fcSXiao Guangrong if (length > nvdimm_get_max_xfer_label_size()) { 6042b9e57fcSXiao Guangrong nvdimm_debug("length (%#x) is larger than max_xfer (%#x).\n", 6052b9e57fcSXiao Guangrong length, nvdimm_get_max_xfer_label_size()); 6062b9e57fcSXiao Guangrong return ret; 6072b9e57fcSXiao Guangrong } 6082b9e57fcSXiao Guangrong 6092b9e57fcSXiao Guangrong return 0 /* Success */; 6102b9e57fcSXiao Guangrong } 6112b9e57fcSXiao Guangrong 6122b9e57fcSXiao Guangrong /* 6132b9e57fcSXiao Guangrong * DSM Spec Rev1 4.5 Get Namespace Label Data (Function Index 5). 6142b9e57fcSXiao Guangrong */ 6152b9e57fcSXiao Guangrong static void nvdimm_dsm_get_label_data(NVDIMMDevice *nvdimm, NvdimmDsmIn *in, 6162b9e57fcSXiao Guangrong hwaddr dsm_mem_addr) 6172b9e57fcSXiao Guangrong { 6182b9e57fcSXiao Guangrong NVDIMMClass *nvc = NVDIMM_GET_CLASS(nvdimm); 6192b9e57fcSXiao Guangrong NvdimmFuncGetLabelDataIn *get_label_data; 6202b9e57fcSXiao Guangrong NvdimmFuncGetLabelDataOut *get_label_data_out; 6212b9e57fcSXiao Guangrong uint32_t status; 6222b9e57fcSXiao Guangrong int size; 6232b9e57fcSXiao Guangrong 6242b9e57fcSXiao Guangrong get_label_data = (NvdimmFuncGetLabelDataIn *)in->arg3; 6252b9e57fcSXiao Guangrong le32_to_cpus(&get_label_data->offset); 6262b9e57fcSXiao Guangrong le32_to_cpus(&get_label_data->length); 6272b9e57fcSXiao Guangrong 6282b9e57fcSXiao Guangrong nvdimm_debug("Read Label Data: offset %#x length %#x.\n", 6292b9e57fcSXiao Guangrong get_label_data->offset, get_label_data->length); 6302b9e57fcSXiao Guangrong 6312b9e57fcSXiao Guangrong status = nvdimm_rw_label_data_check(nvdimm, get_label_data->offset, 6322b9e57fcSXiao Guangrong get_label_data->length); 6332b9e57fcSXiao Guangrong if (status != 0 /* Success */) { 6342b9e57fcSXiao Guangrong nvdimm_dsm_no_payload(status, dsm_mem_addr); 6352b9e57fcSXiao Guangrong return; 6362b9e57fcSXiao Guangrong } 6372b9e57fcSXiao Guangrong 6382b9e57fcSXiao Guangrong size = sizeof(*get_label_data_out) + get_label_data->length; 6392b9e57fcSXiao Guangrong assert(size <= 4096); 6402b9e57fcSXiao Guangrong get_label_data_out = g_malloc(size); 6412b9e57fcSXiao Guangrong 6422b9e57fcSXiao Guangrong get_label_data_out->len = cpu_to_le32(size); 6432b9e57fcSXiao Guangrong get_label_data_out->func_ret_status = cpu_to_le32(0 /* Success */); 6442b9e57fcSXiao Guangrong nvc->read_label_data(nvdimm, get_label_data_out->out_buf, 6452b9e57fcSXiao Guangrong get_label_data->length, get_label_data->offset); 6462b9e57fcSXiao Guangrong 6472b9e57fcSXiao Guangrong cpu_physical_memory_write(dsm_mem_addr, get_label_data_out, size); 6482b9e57fcSXiao Guangrong g_free(get_label_data_out); 6492b9e57fcSXiao Guangrong } 6502b9e57fcSXiao Guangrong 65114e44198SXiao Guangrong /* 65214e44198SXiao Guangrong * DSM Spec Rev1 4.6 Set Namespace Label Data (Function Index 6). 65314e44198SXiao Guangrong */ 65414e44198SXiao Guangrong static void nvdimm_dsm_set_label_data(NVDIMMDevice *nvdimm, NvdimmDsmIn *in, 65514e44198SXiao Guangrong hwaddr dsm_mem_addr) 65614e44198SXiao Guangrong { 65714e44198SXiao Guangrong NVDIMMClass *nvc = NVDIMM_GET_CLASS(nvdimm); 65814e44198SXiao Guangrong NvdimmFuncSetLabelDataIn *set_label_data; 65914e44198SXiao Guangrong uint32_t status; 66014e44198SXiao Guangrong 66114e44198SXiao Guangrong set_label_data = (NvdimmFuncSetLabelDataIn *)in->arg3; 66214e44198SXiao Guangrong 66314e44198SXiao Guangrong le32_to_cpus(&set_label_data->offset); 66414e44198SXiao Guangrong le32_to_cpus(&set_label_data->length); 66514e44198SXiao Guangrong 66614e44198SXiao Guangrong nvdimm_debug("Write Label Data: offset %#x length %#x.\n", 66714e44198SXiao Guangrong set_label_data->offset, set_label_data->length); 66814e44198SXiao Guangrong 66914e44198SXiao Guangrong status = nvdimm_rw_label_data_check(nvdimm, set_label_data->offset, 67014e44198SXiao Guangrong set_label_data->length); 67114e44198SXiao Guangrong if (status != 0 /* Success */) { 67214e44198SXiao Guangrong nvdimm_dsm_no_payload(status, dsm_mem_addr); 67314e44198SXiao Guangrong return; 67414e44198SXiao Guangrong } 67514e44198SXiao Guangrong 67614e44198SXiao Guangrong assert(sizeof(*in) + sizeof(*set_label_data) + set_label_data->length <= 67714e44198SXiao Guangrong 4096); 67814e44198SXiao Guangrong 67914e44198SXiao Guangrong nvc->write_label_data(nvdimm, set_label_data->in_buf, 68014e44198SXiao Guangrong set_label_data->length, set_label_data->offset); 68114e44198SXiao Guangrong nvdimm_dsm_no_payload(0 /* Success */, dsm_mem_addr); 68214e44198SXiao Guangrong } 68314e44198SXiao Guangrong 684189f4d56SXiao Guangrong static void nvdimm_dsm_device(NvdimmDsmIn *in, hwaddr dsm_mem_addr) 685189f4d56SXiao Guangrong { 6865797dcdcSXiao Guangrong NVDIMMDevice *nvdimm = nvdimm_get_device_by_handle(in->handle); 6875797dcdcSXiao Guangrong 688189f4d56SXiao Guangrong /* See the comments in nvdimm_dsm_root(). */ 689189f4d56SXiao Guangrong if (!in->function) { 6905797dcdcSXiao Guangrong uint32_t supported_func = 0; 6915797dcdcSXiao Guangrong 6925797dcdcSXiao Guangrong if (nvdimm && nvdimm->label_size) { 6935797dcdcSXiao Guangrong supported_func |= 0x1 /* Bit 0 indicates whether there is 6945797dcdcSXiao Guangrong support for any functions other 6955797dcdcSXiao Guangrong than function 0. */ | 6962b9e57fcSXiao Guangrong 1 << 4 /* Get Namespace Label Size */ | 69714e44198SXiao Guangrong 1 << 5 /* Get Namespace Label Data */ | 69814e44198SXiao Guangrong 1 << 6 /* Set Namespace Label Data */; 6995797dcdcSXiao Guangrong } 7005797dcdcSXiao Guangrong nvdimm_dsm_function0(supported_func, dsm_mem_addr); 701189f4d56SXiao Guangrong return; 702189f4d56SXiao Guangrong } 703189f4d56SXiao Guangrong 7045797dcdcSXiao Guangrong if (!nvdimm) { 7055797dcdcSXiao Guangrong nvdimm_dsm_no_payload(2 /* Non-Existing Memory Device */, 7065797dcdcSXiao Guangrong dsm_mem_addr); 7075797dcdcSXiao Guangrong return; 7085797dcdcSXiao Guangrong } 7095797dcdcSXiao Guangrong 7105797dcdcSXiao Guangrong /* Encode DSM function according to DSM Spec Rev1. */ 7115797dcdcSXiao Guangrong switch (in->function) { 7125797dcdcSXiao Guangrong case 4 /* Get Namespace Label Size */: 7135797dcdcSXiao Guangrong if (nvdimm->label_size) { 7145797dcdcSXiao Guangrong nvdimm_dsm_label_size(nvdimm, dsm_mem_addr); 7155797dcdcSXiao Guangrong return; 7165797dcdcSXiao Guangrong } 7175797dcdcSXiao Guangrong break; 7182b9e57fcSXiao Guangrong case 5 /* Get Namespace Label Data */: 7192b9e57fcSXiao Guangrong if (nvdimm->label_size) { 7202b9e57fcSXiao Guangrong nvdimm_dsm_get_label_data(nvdimm, in, dsm_mem_addr); 7212b9e57fcSXiao Guangrong return; 7222b9e57fcSXiao Guangrong } 7232b9e57fcSXiao Guangrong break; 72414e44198SXiao Guangrong case 0x6 /* Set Namespace Label Data */: 72514e44198SXiao Guangrong if (nvdimm->label_size) { 72614e44198SXiao Guangrong nvdimm_dsm_set_label_data(nvdimm, in, dsm_mem_addr); 72714e44198SXiao Guangrong return; 72814e44198SXiao Guangrong } 72914e44198SXiao Guangrong break; 7305797dcdcSXiao Guangrong } 7315797dcdcSXiao Guangrong 732189f4d56SXiao Guangrong nvdimm_dsm_no_payload(1 /* Not Supported */, dsm_mem_addr); 733189f4d56SXiao Guangrong } 734189f4d56SXiao Guangrong 7355fe79386SXiao Guangrong static uint64_t 7365fe79386SXiao Guangrong nvdimm_dsm_read(void *opaque, hwaddr addr, unsigned size) 7375fe79386SXiao Guangrong { 738f7df22deSXiao Guangrong nvdimm_debug("BUG: we never read _DSM IO Port.\n"); 7395fe79386SXiao Guangrong return 0; 7405fe79386SXiao Guangrong } 7415fe79386SXiao Guangrong 7425fe79386SXiao Guangrong static void 7435fe79386SXiao Guangrong nvdimm_dsm_write(void *opaque, hwaddr addr, uint64_t val, unsigned size) 7445fe79386SXiao Guangrong { 745f7df22deSXiao Guangrong NvdimmDsmIn *in; 746f7df22deSXiao Guangrong hwaddr dsm_mem_addr = val; 747f7df22deSXiao Guangrong 748f7df22deSXiao Guangrong nvdimm_debug("dsm memory address %#" HWADDR_PRIx ".\n", dsm_mem_addr); 749f7df22deSXiao Guangrong 750f7df22deSXiao Guangrong /* 751f7df22deSXiao Guangrong * The DSM memory is mapped to guest address space so an evil guest 752f7df22deSXiao Guangrong * can change its content while we are doing DSM emulation. Avoid 753f7df22deSXiao Guangrong * this by copying DSM memory to QEMU local memory. 754f7df22deSXiao Guangrong */ 75535c5a52dSPaolo Bonzini in = g_new(NvdimmDsmIn, 1); 75635c5a52dSPaolo Bonzini cpu_physical_memory_read(dsm_mem_addr, in, sizeof(*in)); 757f7df22deSXiao Guangrong 758f7df22deSXiao Guangrong le32_to_cpus(&in->revision); 759f7df22deSXiao Guangrong le32_to_cpus(&in->function); 760f7df22deSXiao Guangrong le32_to_cpus(&in->handle); 761f7df22deSXiao Guangrong 762f7df22deSXiao Guangrong nvdimm_debug("Revision %#x Handler %#x Function %#x.\n", in->revision, 763f7df22deSXiao Guangrong in->handle, in->function); 764f7df22deSXiao Guangrong 765d15fc53fSXiao Guangrong if (in->revision != 0x1 /* Currently we only support DSM Spec Rev1. */) { 766d15fc53fSXiao Guangrong nvdimm_debug("Revision %#x is not supported, expect %#x.\n", 767d15fc53fSXiao Guangrong in->revision, 0x1); 768d15fc53fSXiao Guangrong nvdimm_dsm_no_payload(1 /* Not Supported */, dsm_mem_addr); 769d15fc53fSXiao Guangrong goto exit; 770d15fc53fSXiao Guangrong } 771d15fc53fSXiao Guangrong 772189f4d56SXiao Guangrong /* Handle 0 is reserved for NVDIMM Root Device. */ 773189f4d56SXiao Guangrong if (!in->handle) { 774189f4d56SXiao Guangrong nvdimm_dsm_root(in, dsm_mem_addr); 775189f4d56SXiao Guangrong goto exit; 776f7df22deSXiao Guangrong } 777f7df22deSXiao Guangrong 778189f4d56SXiao Guangrong nvdimm_dsm_device(in, dsm_mem_addr); 779189f4d56SXiao Guangrong 780189f4d56SXiao Guangrong exit: 781f7df22deSXiao Guangrong g_free(in); 7825fe79386SXiao Guangrong } 7835fe79386SXiao Guangrong 7845fe79386SXiao Guangrong static const MemoryRegionOps nvdimm_dsm_ops = { 7855fe79386SXiao Guangrong .read = nvdimm_dsm_read, 7865fe79386SXiao Guangrong .write = nvdimm_dsm_write, 7875fe79386SXiao Guangrong .endianness = DEVICE_LITTLE_ENDIAN, 7885fe79386SXiao Guangrong .valid = { 7895fe79386SXiao Guangrong .min_access_size = 4, 7905fe79386SXiao Guangrong .max_access_size = 4, 7915fe79386SXiao Guangrong }, 7925fe79386SXiao Guangrong }; 7935fe79386SXiao Guangrong 7945fe79386SXiao Guangrong void nvdimm_init_acpi_state(AcpiNVDIMMState *state, MemoryRegion *io, 7955fe79386SXiao Guangrong FWCfgState *fw_cfg, Object *owner) 7965fe79386SXiao Guangrong { 7975fe79386SXiao Guangrong memory_region_init_io(&state->io_mr, owner, &nvdimm_dsm_ops, state, 7985fe79386SXiao Guangrong "nvdimm-acpi-io", NVDIMM_ACPI_IO_LEN); 7995fe79386SXiao Guangrong memory_region_add_subregion(io, NVDIMM_ACPI_IO_BASE, &state->io_mr); 8005fe79386SXiao Guangrong 8015fe79386SXiao Guangrong state->dsm_mem = g_array_new(false, true /* clear */, 1); 80235c5a52dSPaolo Bonzini acpi_data_push(state->dsm_mem, sizeof(NvdimmDsmIn)); 8035fe79386SXiao Guangrong fw_cfg_add_file(fw_cfg, NVDIMM_DSM_MEM_FILE, state->dsm_mem->data, 8045fe79386SXiao Guangrong state->dsm_mem->len); 805*75b0713eSXiao Guangrong 806*75b0713eSXiao Guangrong nvdimm_init_fit_buffer(&state->fit_buf); 8075fe79386SXiao Guangrong } 8085fe79386SXiao Guangrong 80977286395SXiao Guangrong #define NVDIMM_COMMON_DSM "NCAL" 810b9951413SXiao Guangrong #define NVDIMM_ACPI_MEM_ADDR "MEMA" 81177286395SXiao Guangrong 8123ae66c45SXiao Guangrong #define NVDIMM_DSM_MEMORY "NRAM" 8133ae66c45SXiao Guangrong #define NVDIMM_DSM_IOPORT "NPIO" 8143ae66c45SXiao Guangrong 8153ae66c45SXiao Guangrong #define NVDIMM_DSM_NOTIFY "NTFI" 8163ae66c45SXiao Guangrong #define NVDIMM_DSM_HANDLE "HDLE" 8173ae66c45SXiao Guangrong #define NVDIMM_DSM_REVISION "REVS" 8183ae66c45SXiao Guangrong #define NVDIMM_DSM_FUNCTION "FUNC" 8193ae66c45SXiao Guangrong #define NVDIMM_DSM_ARG3 "FARG" 8203ae66c45SXiao Guangrong 8213ae66c45SXiao Guangrong #define NVDIMM_DSM_OUT_BUF_SIZE "RLEN" 8223ae66c45SXiao Guangrong #define NVDIMM_DSM_OUT_BUF "ODAT" 8233ae66c45SXiao Guangrong 82477286395SXiao Guangrong static void nvdimm_build_common_dsm(Aml *dev) 82577286395SXiao Guangrong { 826fa1a448dSXiao Guangrong Aml *method, *ifctx, *function, *handle, *uuid, *dsm_mem; 82790623ebfSXiao Guangrong Aml *elsectx, *unsupport, *unpatched, *expected_uuid, *uuid_invalid; 828fa1a448dSXiao Guangrong Aml *pckg, *pckg_index, *pckg_buf, *field, *dsm_out_buf, *dsm_out_buf_size; 82977286395SXiao Guangrong uint8_t byte_list[1]; 83077286395SXiao Guangrong 831732b530cSXiao Guangrong method = aml_method(NVDIMM_COMMON_DSM, 5, AML_SERIALIZED); 83290623ebfSXiao Guangrong uuid = aml_arg(0); 83377286395SXiao Guangrong function = aml_arg(2); 83490623ebfSXiao Guangrong handle = aml_arg(4); 835c0b3b863SXiao Guangrong dsm_mem = aml_local(6); 83648bee476SXiao Guangrong dsm_out_buf = aml_local(7); 837c0b3b863SXiao Guangrong 838c0b3b863SXiao Guangrong aml_append(method, aml_store(aml_name(NVDIMM_ACPI_MEM_ADDR), dsm_mem)); 839c0b3b863SXiao Guangrong 840c0b3b863SXiao Guangrong /* map DSM memory and IO into ACPI namespace. */ 8413ae66c45SXiao Guangrong aml_append(method, aml_operation_region(NVDIMM_DSM_IOPORT, AML_SYSTEM_IO, 842c0b3b863SXiao Guangrong aml_int(NVDIMM_ACPI_IO_BASE), NVDIMM_ACPI_IO_LEN)); 8433ae66c45SXiao Guangrong aml_append(method, aml_operation_region(NVDIMM_DSM_MEMORY, 8443ae66c45SXiao Guangrong AML_SYSTEM_MEMORY, dsm_mem, sizeof(NvdimmDsmIn))); 845c0b3b863SXiao Guangrong 846c0b3b863SXiao Guangrong /* 847c0b3b863SXiao Guangrong * DSM notifier: 8483ae66c45SXiao Guangrong * NVDIMM_DSM_NOTIFY: write the address of DSM memory and notify QEMU to 8493ae66c45SXiao Guangrong * emulate the access. 850c0b3b863SXiao Guangrong * 851c0b3b863SXiao Guangrong * It is the IO port so that accessing them will cause VM-exit, the 852c0b3b863SXiao Guangrong * control will be transferred to QEMU. 853c0b3b863SXiao Guangrong */ 8543ae66c45SXiao Guangrong field = aml_field(NVDIMM_DSM_IOPORT, AML_DWORD_ACC, AML_NOLOCK, 8553ae66c45SXiao Guangrong AML_PRESERVE); 8563ae66c45SXiao Guangrong aml_append(field, aml_named_field(NVDIMM_DSM_NOTIFY, 857c0b3b863SXiao Guangrong sizeof(uint32_t) * BITS_PER_BYTE)); 858c0b3b863SXiao Guangrong aml_append(method, field); 859c0b3b863SXiao Guangrong 860c0b3b863SXiao Guangrong /* 861c0b3b863SXiao Guangrong * DSM input: 8623ae66c45SXiao Guangrong * NVDIMM_DSM_HANDLE: store device's handle, it's zero if the _DSM call 8633ae66c45SXiao Guangrong * happens on NVDIMM Root Device. 8643ae66c45SXiao Guangrong * NVDIMM_DSM_REVISION: store the Arg1 of _DSM call. 8653ae66c45SXiao Guangrong * NVDIMM_DSM_FUNCTION: store the Arg2 of _DSM call. 8663ae66c45SXiao Guangrong * NVDIMM_DSM_ARG3: store the Arg3 of _DSM call which is a Package 8673ae66c45SXiao Guangrong * containing function-specific arguments. 868c0b3b863SXiao Guangrong * 869c0b3b863SXiao Guangrong * They are RAM mapping on host so that these accesses never cause 870c0b3b863SXiao Guangrong * VM-EXIT. 871c0b3b863SXiao Guangrong */ 8723ae66c45SXiao Guangrong field = aml_field(NVDIMM_DSM_MEMORY, AML_DWORD_ACC, AML_NOLOCK, 8733ae66c45SXiao Guangrong AML_PRESERVE); 8743ae66c45SXiao Guangrong aml_append(field, aml_named_field(NVDIMM_DSM_HANDLE, 875c0b3b863SXiao Guangrong sizeof(typeof_field(NvdimmDsmIn, handle)) * BITS_PER_BYTE)); 8763ae66c45SXiao Guangrong aml_append(field, aml_named_field(NVDIMM_DSM_REVISION, 877c0b3b863SXiao Guangrong sizeof(typeof_field(NvdimmDsmIn, revision)) * BITS_PER_BYTE)); 8783ae66c45SXiao Guangrong aml_append(field, aml_named_field(NVDIMM_DSM_FUNCTION, 879c0b3b863SXiao Guangrong sizeof(typeof_field(NvdimmDsmIn, function)) * BITS_PER_BYTE)); 8803ae66c45SXiao Guangrong aml_append(field, aml_named_field(NVDIMM_DSM_ARG3, 881c0b3b863SXiao Guangrong (sizeof(NvdimmDsmIn) - offsetof(NvdimmDsmIn, arg3)) * BITS_PER_BYTE)); 882c0b3b863SXiao Guangrong aml_append(method, field); 883c0b3b863SXiao Guangrong 884c0b3b863SXiao Guangrong /* 885c0b3b863SXiao Guangrong * DSM output: 8863ae66c45SXiao Guangrong * NVDIMM_DSM_OUT_BUF_SIZE: the size of the buffer filled by QEMU. 8873ae66c45SXiao Guangrong * NVDIMM_DSM_OUT_BUF: the buffer QEMU uses to store the result. 888c0b3b863SXiao Guangrong * 889c0b3b863SXiao Guangrong * Since the page is reused by both input and out, the input data 890c0b3b863SXiao Guangrong * will be lost after storing new result into ODAT so we should fetch 891c0b3b863SXiao Guangrong * all the input data before writing the result. 892c0b3b863SXiao Guangrong */ 8933ae66c45SXiao Guangrong field = aml_field(NVDIMM_DSM_MEMORY, AML_DWORD_ACC, AML_NOLOCK, 8943ae66c45SXiao Guangrong AML_PRESERVE); 8953ae66c45SXiao Guangrong aml_append(field, aml_named_field(NVDIMM_DSM_OUT_BUF_SIZE, 896c0b3b863SXiao Guangrong sizeof(typeof_field(NvdimmDsmOut, len)) * BITS_PER_BYTE)); 8973ae66c45SXiao Guangrong aml_append(field, aml_named_field(NVDIMM_DSM_OUT_BUF, 898c0b3b863SXiao Guangrong (sizeof(NvdimmDsmOut) - offsetof(NvdimmDsmOut, data)) * BITS_PER_BYTE)); 899c0b3b863SXiao Guangrong aml_append(method, field); 90018c440e1SXiao Guangrong 90118c440e1SXiao Guangrong /* 90218c440e1SXiao Guangrong * do not support any method if DSM memory address has not been 90318c440e1SXiao Guangrong * patched. 90418c440e1SXiao Guangrong */ 90590623ebfSXiao Guangrong unpatched = aml_equal(dsm_mem, aml_int(0x0)); 90690623ebfSXiao Guangrong 90790623ebfSXiao Guangrong expected_uuid = aml_local(0); 90890623ebfSXiao Guangrong 90990623ebfSXiao Guangrong ifctx = aml_if(aml_equal(handle, aml_int(0x0))); 91090623ebfSXiao Guangrong aml_append(ifctx, aml_store( 91190623ebfSXiao Guangrong aml_touuid("2F10E7A4-9E91-11E4-89D3-123B93F75CBA") 91290623ebfSXiao Guangrong /* UUID for NVDIMM Root Device */, expected_uuid)); 91390623ebfSXiao Guangrong aml_append(method, ifctx); 91490623ebfSXiao Guangrong elsectx = aml_else(); 91590623ebfSXiao Guangrong aml_append(elsectx, aml_store( 91690623ebfSXiao Guangrong aml_touuid("4309AC30-0D11-11E4-9191-0800200C9A66") 91790623ebfSXiao Guangrong /* UUID for NVDIMM Devices */, expected_uuid)); 91890623ebfSXiao Guangrong aml_append(method, elsectx); 91990623ebfSXiao Guangrong 92090623ebfSXiao Guangrong uuid_invalid = aml_lnot(aml_equal(uuid, expected_uuid)); 92190623ebfSXiao Guangrong 92290623ebfSXiao Guangrong unsupport = aml_if(aml_or(unpatched, uuid_invalid, NULL)); 92377286395SXiao Guangrong 92477286395SXiao Guangrong /* 92577286395SXiao Guangrong * function 0 is called to inquire what functions are supported by 92677286395SXiao Guangrong * OSPM 92777286395SXiao Guangrong */ 92877286395SXiao Guangrong ifctx = aml_if(aml_equal(function, aml_int(0))); 92977286395SXiao Guangrong byte_list[0] = 0 /* No function Supported */; 93077286395SXiao Guangrong aml_append(ifctx, aml_return(aml_buffer(1, byte_list))); 93190623ebfSXiao Guangrong aml_append(unsupport, ifctx); 93277286395SXiao Guangrong 93377286395SXiao Guangrong /* No function is supported yet. */ 93477286395SXiao Guangrong byte_list[0] = 1 /* Not Supported */; 93590623ebfSXiao Guangrong aml_append(unsupport, aml_return(aml_buffer(1, byte_list))); 93690623ebfSXiao Guangrong aml_append(method, unsupport); 93777286395SXiao Guangrong 93818c440e1SXiao Guangrong /* 93918c440e1SXiao Guangrong * The HDLE indicates the DSM function is issued from which device, 940732b530cSXiao Guangrong * it reserves 0 for root device and is the handle for NVDIMM devices. 941732b530cSXiao Guangrong * See the comments in nvdimm_slot_to_handle(). 94218c440e1SXiao Guangrong */ 9433ae66c45SXiao Guangrong aml_append(method, aml_store(handle, aml_name(NVDIMM_DSM_HANDLE))); 9443ae66c45SXiao Guangrong aml_append(method, aml_store(aml_arg(1), aml_name(NVDIMM_DSM_REVISION))); 9453ae66c45SXiao Guangrong aml_append(method, aml_store(aml_arg(2), aml_name(NVDIMM_DSM_FUNCTION))); 94618c440e1SXiao Guangrong 94718c440e1SXiao Guangrong /* 9484568c948SXiao Guangrong * The fourth parameter (Arg3) of _DSM is a package which contains 9494568c948SXiao Guangrong * a buffer, the layout of the buffer is specified by UUID (Arg0), 9504568c948SXiao Guangrong * Revision ID (Arg1) and Function Index (Arg2) which are documented 9514568c948SXiao Guangrong * in the DSM Spec. 9524568c948SXiao Guangrong */ 9534568c948SXiao Guangrong pckg = aml_arg(3); 9544568c948SXiao Guangrong ifctx = aml_if(aml_and(aml_equal(aml_object_type(pckg), 9554568c948SXiao Guangrong aml_int(4 /* Package */)) /* It is a Package? */, 9564568c948SXiao Guangrong aml_equal(aml_sizeof(pckg), aml_int(1)) /* 1 element? */, 9574568c948SXiao Guangrong NULL)); 9584568c948SXiao Guangrong 9594568c948SXiao Guangrong pckg_index = aml_local(2); 9604568c948SXiao Guangrong pckg_buf = aml_local(3); 9614568c948SXiao Guangrong aml_append(ifctx, aml_store(aml_index(pckg, aml_int(0)), pckg_index)); 9624568c948SXiao Guangrong aml_append(ifctx, aml_store(aml_derefof(pckg_index), pckg_buf)); 9633ae66c45SXiao Guangrong aml_append(ifctx, aml_store(pckg_buf, aml_name(NVDIMM_DSM_ARG3))); 9644568c948SXiao Guangrong aml_append(method, ifctx); 9654568c948SXiao Guangrong 9664568c948SXiao Guangrong /* 96718c440e1SXiao Guangrong * tell QEMU about the real address of DSM memory, then QEMU 96818c440e1SXiao Guangrong * gets the control and fills the result in DSM memory. 96918c440e1SXiao Guangrong */ 9703ae66c45SXiao Guangrong aml_append(method, aml_store(dsm_mem, aml_name(NVDIMM_DSM_NOTIFY))); 97118c440e1SXiao Guangrong 972fa1a448dSXiao Guangrong dsm_out_buf_size = aml_local(1); 973d51d1d7eSXiao Guangrong /* RLEN is not included in the payload returned to guest. */ 9743ae66c45SXiao Guangrong aml_append(method, aml_subtract(aml_name(NVDIMM_DSM_OUT_BUF_SIZE), 9753ae66c45SXiao Guangrong aml_int(4), dsm_out_buf_size)); 976fa1a448dSXiao Guangrong aml_append(method, aml_store(aml_shiftleft(dsm_out_buf_size, aml_int(3)), 977fa1a448dSXiao Guangrong dsm_out_buf_size)); 9783ae66c45SXiao Guangrong aml_append(method, aml_create_field(aml_name(NVDIMM_DSM_OUT_BUF), 9793ae66c45SXiao Guangrong aml_int(0), dsm_out_buf_size, "OBUF")); 98018c440e1SXiao Guangrong aml_append(method, aml_concatenate(aml_buffer(0, NULL), aml_name("OBUF"), 98148bee476SXiao Guangrong dsm_out_buf)); 98248bee476SXiao Guangrong aml_append(method, aml_return(dsm_out_buf)); 98377286395SXiao Guangrong aml_append(dev, method); 98477286395SXiao Guangrong } 98577286395SXiao Guangrong 986732b530cSXiao Guangrong static void nvdimm_build_device_dsm(Aml *dev, uint32_t handle) 98777286395SXiao Guangrong { 98877286395SXiao Guangrong Aml *method; 98977286395SXiao Guangrong 99077286395SXiao Guangrong method = aml_method("_DSM", 4, AML_NOTSERIALIZED); 991732b530cSXiao Guangrong aml_append(method, aml_return(aml_call5(NVDIMM_COMMON_DSM, aml_arg(0), 992732b530cSXiao Guangrong aml_arg(1), aml_arg(2), aml_arg(3), 993732b530cSXiao Guangrong aml_int(handle)))); 99477286395SXiao Guangrong aml_append(dev, method); 99577286395SXiao Guangrong } 99677286395SXiao Guangrong 997bdfd065bSXiao Guangrong static void nvdimm_build_nvdimm_devices(Aml *root_dev, uint32_t ram_slots) 99877286395SXiao Guangrong { 999bdfd065bSXiao Guangrong uint32_t slot; 1000bdfd065bSXiao Guangrong 1001bdfd065bSXiao Guangrong for (slot = 0; slot < ram_slots; slot++) { 100277286395SXiao Guangrong uint32_t handle = nvdimm_slot_to_handle(slot); 100377286395SXiao Guangrong Aml *nvdimm_dev; 100477286395SXiao Guangrong 100577286395SXiao Guangrong nvdimm_dev = aml_device("NV%02X", slot); 100677286395SXiao Guangrong 100777286395SXiao Guangrong /* 100877286395SXiao Guangrong * ACPI 6.0: 9.20 NVDIMM Devices: 100977286395SXiao Guangrong * 101077286395SXiao Guangrong * _ADR object that is used to supply OSPM with unique address 101177286395SXiao Guangrong * of the NVDIMM device. This is done by returning the NFIT Device 101277286395SXiao Guangrong * handle that is used to identify the associated entries in ACPI 101377286395SXiao Guangrong * table NFIT or _FIT. 101477286395SXiao Guangrong */ 101577286395SXiao Guangrong aml_append(nvdimm_dev, aml_name_decl("_ADR", aml_int(handle))); 101677286395SXiao Guangrong 1017732b530cSXiao Guangrong nvdimm_build_device_dsm(nvdimm_dev, handle); 101877286395SXiao Guangrong aml_append(root_dev, nvdimm_dev); 101977286395SXiao Guangrong } 102077286395SXiao Guangrong } 102177286395SXiao Guangrong 1022bdfd065bSXiao Guangrong static void nvdimm_build_ssdt(GArray *table_offsets, GArray *table_data, 1023bdfd065bSXiao Guangrong BIOSLinker *linker, GArray *dsm_dma_arrea, 1024bdfd065bSXiao Guangrong uint32_t ram_slots) 102577286395SXiao Guangrong { 1026c0b3b863SXiao Guangrong Aml *ssdt, *sb_scope, *dev; 1027b9951413SXiao Guangrong int mem_addr_offset, nvdimm_ssdt; 102877286395SXiao Guangrong 102977286395SXiao Guangrong acpi_add_table(table_offsets, table_data); 103077286395SXiao Guangrong 103177286395SXiao Guangrong ssdt = init_aml_allocator(); 103277286395SXiao Guangrong acpi_data_push(ssdt->buf, sizeof(AcpiTableHeader)); 103377286395SXiao Guangrong 103477286395SXiao Guangrong sb_scope = aml_scope("\\_SB"); 103577286395SXiao Guangrong 103677286395SXiao Guangrong dev = aml_device("NVDR"); 103777286395SXiao Guangrong 103877286395SXiao Guangrong /* 103977286395SXiao Guangrong * ACPI 6.0: 9.20 NVDIMM Devices: 104077286395SXiao Guangrong * 104177286395SXiao Guangrong * The ACPI Name Space device uses _HID of ACPI0012 to identify the root 104277286395SXiao Guangrong * NVDIMM interface device. Platform firmware is required to contain one 104377286395SXiao Guangrong * such device in _SB scope if NVDIMMs support is exposed by platform to 104477286395SXiao Guangrong * OSPM. 104577286395SXiao Guangrong * For each NVDIMM present or intended to be supported by platform, 104677286395SXiao Guangrong * platform firmware also exposes an ACPI Namespace Device under the 104777286395SXiao Guangrong * root device. 104877286395SXiao Guangrong */ 104977286395SXiao Guangrong aml_append(dev, aml_name_decl("_HID", aml_string("ACPI0012"))); 105077286395SXiao Guangrong 105177286395SXiao Guangrong nvdimm_build_common_dsm(dev); 1052732b530cSXiao Guangrong 1053732b530cSXiao Guangrong /* 0 is reserved for root device. */ 1054732b530cSXiao Guangrong nvdimm_build_device_dsm(dev, 0); 105577286395SXiao Guangrong 1056bdfd065bSXiao Guangrong nvdimm_build_nvdimm_devices(dev, ram_slots); 105777286395SXiao Guangrong 105877286395SXiao Guangrong aml_append(sb_scope, dev); 105977286395SXiao Guangrong aml_append(ssdt, sb_scope); 1060b9951413SXiao Guangrong 1061b9951413SXiao Guangrong nvdimm_ssdt = table_data->len; 1062b9951413SXiao Guangrong 106377286395SXiao Guangrong /* copy AML table into ACPI tables blob and patch header there */ 106477286395SXiao Guangrong g_array_append_vals(table_data, ssdt->buf->data, ssdt->buf->len); 1065b9951413SXiao Guangrong mem_addr_offset = build_append_named_dword(table_data, 1066b9951413SXiao Guangrong NVDIMM_ACPI_MEM_ADDR); 1067b9951413SXiao Guangrong 1068ad9671b8SIgor Mammedov bios_linker_loader_alloc(linker, 1069ad9671b8SIgor Mammedov NVDIMM_DSM_MEM_FILE, dsm_dma_arrea, 1070ad9671b8SIgor Mammedov sizeof(NvdimmDsmIn), false /* high memory */); 10714678124bSIgor Mammedov bios_linker_loader_add_pointer(linker, 10724678124bSIgor Mammedov ACPI_BUILD_TABLE_FILE, mem_addr_offset, sizeof(uint32_t), 10734678124bSIgor Mammedov NVDIMM_DSM_MEM_FILE, 0); 107477286395SXiao Guangrong build_header(linker, table_data, 1075b9951413SXiao Guangrong (void *)(table_data->data + nvdimm_ssdt), 1076b9951413SXiao Guangrong "SSDT", table_data->len - nvdimm_ssdt, 1, NULL, "NVDIMM"); 107777286395SXiao Guangrong free_aml_allocator(); 107877286395SXiao Guangrong } 107977286395SXiao Guangrong 108087252e1bSXiao Guangrong void nvdimm_build_acpi(GArray *table_offsets, GArray *table_data, 1081*75b0713eSXiao Guangrong BIOSLinker *linker, AcpiNVDIMMState *state, 1082bdfd065bSXiao Guangrong uint32_t ram_slots) 108387252e1bSXiao Guangrong { 1084*75b0713eSXiao Guangrong nvdimm_build_nfit(state, table_offsets, table_data, linker); 1085bdfd065bSXiao Guangrong 1086bdfd065bSXiao Guangrong /* 1087bdfd065bSXiao Guangrong * NVDIMM device is allowed to be plugged only if there is available 1088bdfd065bSXiao Guangrong * slot. 1089bdfd065bSXiao Guangrong */ 1090bdfd065bSXiao Guangrong if (ram_slots) { 1091*75b0713eSXiao Guangrong nvdimm_build_ssdt(table_offsets, table_data, linker, state->dsm_mem, 1092bdfd065bSXiao Guangrong ram_slots); 1093bdfd065bSXiao Guangrong } 1094bdfd065bSXiao Guangrong } 1095