Commit b94d5230 authored by Dan Williams's avatar Dan Williams
Browse files

libnvdimm, nfit: initial libnvdimm infrastructure and NFIT support 



A struct nvdimm_bus is the anchor device for registering nvdimm
resources and interfaces, for example, a character control device,
nvdimm devices, and I/O region devices.  The ACPI NFIT (NVDIMM Firmware
Interface Table) is one possible platform description for such
non-volatile memory resources in a system.  The nfit.ko driver attaches
to the "ACPI0012" device that indicates the presence of the NFIT and
parses the table to register a struct nvdimm_bus instance.

Cc: <linux-acpi@vger.kernel.org>
Cc: Lv Zheng <lv.zheng@intel.com>
Cc: Robert Moore <robert.moore@intel.com>
Cc: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Acked-by: default avatarJeff Moyer <jmoyer@redhat.com>
Acked-by: default avatarChristoph Hellwig <hch@lst.de>
Acked-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
Tested-by: default avatarToshi Kani <toshi.kani@hp.com>
Signed-off-by: default avatarDan Williams <dan.j.williams@intel.com>
parent ad5fb870

drivers/Kconfig

+2 −0
Original line number Diff line number Diff line
@@ -182,4 +182,6 @@ source "drivers/thunderbolt/Kconfig" 


source "drivers/android/Kconfig"



source "drivers/nvdimm/Kconfig"



endmenu

drivers/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -64,6 +64,7 @@ obj-$(CONFIG_FB_INTEL) += video/fbdev/intelfb/ 


obj-$(CONFIG_PARPORT)		+= parport/

obj-y				+= base/ block/ misc/ mfd/ nfc/

obj-$(CONFIG_LIBNVDIMM)		+= nvdimm/

obj-$(CONFIG_DMA_SHARED_BUFFER) += dma-buf/

obj-$(CONFIG_NUBUS)		+= nubus/

obj-y				+= macintosh/

drivers/acpi/Kconfig

+14 −0
Original line number Diff line number Diff line
@@ -383,6 +383,20 @@ config ACPI_REDUCED_HARDWARE_ONLY 


	  If you are unsure what to do, do not enable this option.



config ACPI_NFIT

	tristate "ACPI NVDIMM Firmware Interface Table (NFIT)"

	depends on PHYS_ADDR_T_64BIT

	depends on BLK_DEV

	select LIBNVDIMM

	help

	  Infrastructure to probe ACPI 6 compliant platforms for

	  NVDIMMs (NFIT) and register a libnvdimm device tree.  In

	  addition to storage devices this also enables libnvdimm to pass

	  ACPI._DSM messages for platform/dimm configuration.



	  To compile this driver as a module, choose M here:

	  the module will be called nfit.



source "drivers/acpi/apei/Kconfig"



config ACPI_EXTLOG

drivers/acpi/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -71,6 +71,7 @@ obj-$(CONFIG_ACPI_PCI_SLOT) += pci_slot.o 
obj-$(CONFIG_ACPI_PROCESSOR)	+= processor.o

obj-y				+= container.o

obj-$(CONFIG_ACPI_THERMAL)	+= thermal.o

obj-$(CONFIG_ACPI_NFIT)		+= nfit.o

obj-y				+= acpi_memhotplug.o

obj-$(CONFIG_ACPI_HOTPLUG_IOAPIC) += ioapic.o

obj-$(CONFIG_ACPI_BATTERY)	+= battery.o

drivers/acpi/nfit.c

0 → 100644
+481 −0
Original line number Diff line number Diff line 
/*

 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of version 2 of the GNU General Public License as

 * published by the Free Software Foundation.

 *

 * This program is distributed in the hope that it will be useful, but

 * WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * General Public License for more details.

 */

#include <linux/list_sort.h>

#include <linux/libnvdimm.h>

#include <linux/module.h>

#include <linux/list.h>

#include <linux/acpi.h>

#include "nfit.h"



static u8 nfit_uuid[NFIT_UUID_MAX][16];



static const u8 *to_nfit_uuid(enum nfit_uuids id)

{

	return nfit_uuid[id];

}



static int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc,

		struct nvdimm *nvdimm, unsigned int cmd, void *buf,

		unsigned int buf_len)

{

	return -ENOTTY;

}



static const char *spa_type_name(u16 type)

{

	static const char *to_name[] = {

		[NFIT_SPA_VOLATILE] = "volatile",

		[NFIT_SPA_PM] = "pmem",

		[NFIT_SPA_DCR] = "dimm-control-region",

		[NFIT_SPA_BDW] = "block-data-window",

		[NFIT_SPA_VDISK] = "volatile-disk",

		[NFIT_SPA_VCD] = "volatile-cd",

		[NFIT_SPA_PDISK] = "persistent-disk",

		[NFIT_SPA_PCD] = "persistent-cd",



	};



	if (type > NFIT_SPA_PCD)

		return "unknown";



	return to_name[type];

}



static int nfit_spa_type(struct acpi_nfit_system_address *spa)

{

	int i;



	for (i = 0; i < NFIT_UUID_MAX; i++)

		if (memcmp(to_nfit_uuid(i), spa->range_guid, 16) == 0)

			return i;

	return -1;

}



static bool add_spa(struct acpi_nfit_desc *acpi_desc,

		struct acpi_nfit_system_address *spa)

{

	struct device *dev = acpi_desc->dev;

	struct nfit_spa *nfit_spa = devm_kzalloc(dev, sizeof(*nfit_spa),

			GFP_KERNEL);



	if (!nfit_spa)

		return false;

	INIT_LIST_HEAD(&nfit_spa->list);

	nfit_spa->spa = spa;

	list_add_tail(&nfit_spa->list, &acpi_desc->spas);

	dev_dbg(dev, "%s: spa index: %d type: %s\n", __func__,

			spa->range_index,

			spa_type_name(nfit_spa_type(spa)));

	return true;

}



static bool add_memdev(struct acpi_nfit_desc *acpi_desc,

		struct acpi_nfit_memory_map *memdev)

{

	struct device *dev = acpi_desc->dev;

	struct nfit_memdev *nfit_memdev = devm_kzalloc(dev,

			sizeof(*nfit_memdev), GFP_KERNEL);



	if (!nfit_memdev)

		return false;

	INIT_LIST_HEAD(&nfit_memdev->list);

	nfit_memdev->memdev = memdev;

	list_add_tail(&nfit_memdev->list, &acpi_desc->memdevs);

	dev_dbg(dev, "%s: memdev handle: %#x spa: %d dcr: %d\n",

			__func__, memdev->device_handle, memdev->range_index,

			memdev->region_index);

	return true;

}



static bool add_dcr(struct acpi_nfit_desc *acpi_desc,

		struct acpi_nfit_control_region *dcr)

{

	struct device *dev = acpi_desc->dev;

	struct nfit_dcr *nfit_dcr = devm_kzalloc(dev, sizeof(*nfit_dcr),

			GFP_KERNEL);



	if (!nfit_dcr)

		return false;

	INIT_LIST_HEAD(&nfit_dcr->list);

	nfit_dcr->dcr = dcr;

	list_add_tail(&nfit_dcr->list, &acpi_desc->dcrs);

	dev_dbg(dev, "%s: dcr index: %d windows: %d\n", __func__,

			dcr->region_index, dcr->windows);

	return true;

}



static bool add_bdw(struct acpi_nfit_desc *acpi_desc,

		struct acpi_nfit_data_region *bdw)

{

	struct device *dev = acpi_desc->dev;

	struct nfit_bdw *nfit_bdw = devm_kzalloc(dev, sizeof(*nfit_bdw),

			GFP_KERNEL);



	if (!nfit_bdw)

		return false;

	INIT_LIST_HEAD(&nfit_bdw->list);

	nfit_bdw->bdw = bdw;

	list_add_tail(&nfit_bdw->list, &acpi_desc->bdws);

	dev_dbg(dev, "%s: bdw dcr: %d windows: %d\n", __func__,

			bdw->region_index, bdw->windows);

	return true;

}



static void *add_table(struct acpi_nfit_desc *acpi_desc, void *table,

		const void *end)

{

	struct device *dev = acpi_desc->dev;

	struct acpi_nfit_header *hdr;

	void *err = ERR_PTR(-ENOMEM);



	if (table >= end)

		return NULL;



	hdr = table;

	switch (hdr->type) {

	case ACPI_NFIT_TYPE_SYSTEM_ADDRESS:

		if (!add_spa(acpi_desc, table))

			return err;

		break;

	case ACPI_NFIT_TYPE_MEMORY_MAP:

		if (!add_memdev(acpi_desc, table))

			return err;

		break;

	case ACPI_NFIT_TYPE_CONTROL_REGION:

		if (!add_dcr(acpi_desc, table))

			return err;

		break;

	case ACPI_NFIT_TYPE_DATA_REGION:

		if (!add_bdw(acpi_desc, table))

			return err;

		break;

	/* TODO */

	case ACPI_NFIT_TYPE_INTERLEAVE:

		dev_dbg(dev, "%s: idt\n", __func__);

		break;

	case ACPI_NFIT_TYPE_FLUSH_ADDRESS:

		dev_dbg(dev, "%s: flush\n", __func__);

		break;

	case ACPI_NFIT_TYPE_SMBIOS:

		dev_dbg(dev, "%s: smbios\n", __func__);

		break;

	default:

		dev_err(dev, "unknown table '%d' parsing nfit\n", hdr->type);

		break;

	}



	return table + hdr->length;

}



static void nfit_mem_find_spa_bdw(struct acpi_nfit_desc *acpi_desc,

		struct nfit_mem *nfit_mem)

{

	u32 device_handle = __to_nfit_memdev(nfit_mem)->device_handle;

	u16 dcr = nfit_mem->dcr->region_index;

	struct nfit_spa *nfit_spa;



	list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {

		u16 range_index = nfit_spa->spa->range_index;

		int type = nfit_spa_type(nfit_spa->spa);

		struct nfit_memdev *nfit_memdev;



		if (type != NFIT_SPA_BDW)

			continue;



		list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {

			if (nfit_memdev->memdev->range_index != range_index)

				continue;

			if (nfit_memdev->memdev->device_handle != device_handle)

				continue;

			if (nfit_memdev->memdev->region_index != dcr)

				continue;



			nfit_mem->spa_bdw = nfit_spa->spa;

			return;

		}

	}



	dev_dbg(acpi_desc->dev, "SPA-BDW not found for SPA-DCR %d\n",

			nfit_mem->spa_dcr->range_index);

	nfit_mem->bdw = NULL;

}



static int nfit_mem_add(struct acpi_nfit_desc *acpi_desc,

		struct nfit_mem *nfit_mem, struct acpi_nfit_system_address *spa)

{

	u16 dcr = __to_nfit_memdev(nfit_mem)->region_index;

	struct nfit_dcr *nfit_dcr;

	struct nfit_bdw *nfit_bdw;



	list_for_each_entry(nfit_dcr, &acpi_desc->dcrs, list) {

		if (nfit_dcr->dcr->region_index != dcr)

			continue;

		nfit_mem->dcr = nfit_dcr->dcr;

		break;

	}



	if (!nfit_mem->dcr) {

		dev_dbg(acpi_desc->dev, "SPA %d missing:%s%s\n",

				spa->range_index, __to_nfit_memdev(nfit_mem)

				? "" : " MEMDEV", nfit_mem->dcr ? "" : " DCR");

		return -ENODEV;

	}



	/*

	 * We've found enough to create an nvdimm, optionally

	 * find an associated BDW

	 */

	list_add(&nfit_mem->list, &acpi_desc->dimms);



	list_for_each_entry(nfit_bdw, &acpi_desc->bdws, list) {

		if (nfit_bdw->bdw->region_index != dcr)

			continue;

		nfit_mem->bdw = nfit_bdw->bdw;

		break;

	}



	if (!nfit_mem->bdw)

		return 0;



	nfit_mem_find_spa_bdw(acpi_desc, nfit_mem);

	return 0;

}



static int nfit_mem_dcr_init(struct acpi_nfit_desc *acpi_desc,

		struct acpi_nfit_system_address *spa)

{

	struct nfit_mem *nfit_mem, *found;

	struct nfit_memdev *nfit_memdev;

	int type = nfit_spa_type(spa);

	u16 dcr;



	switch (type) {

	case NFIT_SPA_DCR:

	case NFIT_SPA_PM:

		break;

	default:

		return 0;

	}



	list_for_each_entry(nfit_memdev, &acpi_desc->memdevs, list) {

		int rc;



		if (nfit_memdev->memdev->range_index != spa->range_index)

			continue;

		found = NULL;

		dcr = nfit_memdev->memdev->region_index;

		list_for_each_entry(nfit_mem, &acpi_desc->dimms, list)

			if (__to_nfit_memdev(nfit_mem)->region_index == dcr) {

				found = nfit_mem;

				break;

			}



		if (found)

			nfit_mem = found;

		else {

			nfit_mem = devm_kzalloc(acpi_desc->dev,

					sizeof(*nfit_mem), GFP_KERNEL);

			if (!nfit_mem)

				return -ENOMEM;

			INIT_LIST_HEAD(&nfit_mem->list);

		}



		if (type == NFIT_SPA_DCR) {

			/* multiple dimms may share a SPA when interleaved */

			nfit_mem->spa_dcr = spa;

			nfit_mem->memdev_dcr = nfit_memdev->memdev;

		} else {

			/*

			 * A single dimm may belong to multiple SPA-PM

			 * ranges, record at least one in addition to

			 * any SPA-DCR range.

			 */

			nfit_mem->memdev_pmem = nfit_memdev->memdev;

		}



		if (found)

			continue;



		rc = nfit_mem_add(acpi_desc, nfit_mem, spa);

		if (rc)

			return rc;

	}



	return 0;

}



static int nfit_mem_cmp(void *priv, struct list_head *_a, struct list_head *_b)

{

	struct nfit_mem *a = container_of(_a, typeof(*a), list);

	struct nfit_mem *b = container_of(_b, typeof(*b), list);

	u32 handleA, handleB;



	handleA = __to_nfit_memdev(a)->device_handle;

	handleB = __to_nfit_memdev(b)->device_handle;

	if (handleA < handleB)

		return -1;

	else if (handleA > handleB)

		return 1;

	return 0;

}



static int nfit_mem_init(struct acpi_nfit_desc *acpi_desc)

{

	struct nfit_spa *nfit_spa;



	/*

	 * For each SPA-DCR or SPA-PMEM address range find its

	 * corresponding MEMDEV(s).  From each MEMDEV find the

	 * corresponding DCR.  Then, if we're operating on a SPA-DCR,

	 * try to find a SPA-BDW and a corresponding BDW that references

	 * the DCR.  Throw it all into an nfit_mem object.  Note, that

	 * BDWs are optional.

	 */

	list_for_each_entry(nfit_spa, &acpi_desc->spas, list) {

		int rc;



		rc = nfit_mem_dcr_init(acpi_desc, nfit_spa->spa);

		if (rc)

			return rc;

	}



	list_sort(NULL, &acpi_desc->dimms, nfit_mem_cmp);



	return 0;

}



static int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, acpi_size sz)

{

	struct device *dev = acpi_desc->dev;

	const void *end;

	u8 *data;



	INIT_LIST_HEAD(&acpi_desc->spas);

	INIT_LIST_HEAD(&acpi_desc->dcrs);

	INIT_LIST_HEAD(&acpi_desc->bdws);

	INIT_LIST_HEAD(&acpi_desc->memdevs);

	INIT_LIST_HEAD(&acpi_desc->dimms);



	data = (u8 *) acpi_desc->nfit;

	end = data + sz;

	data += sizeof(struct acpi_table_nfit);

	while (!IS_ERR_OR_NULL(data))

		data = add_table(acpi_desc, data, end);



	if (IS_ERR(data)) {

		dev_dbg(dev, "%s: nfit table parsing error: %ld\n", __func__,

				PTR_ERR(data));

		return PTR_ERR(data);

	}



	if (nfit_mem_init(acpi_desc) != 0)

		return -ENOMEM;



	return 0;

}



static int acpi_nfit_add(struct acpi_device *adev)

{

	struct nvdimm_bus_descriptor *nd_desc;

	struct acpi_nfit_desc *acpi_desc;

	struct device *dev = &adev->dev;

	struct acpi_table_header *tbl;

	acpi_status status = AE_OK;

	acpi_size sz;

	int rc;



	status = acpi_get_table_with_size("NFIT", 0, &tbl, &sz);

	if (ACPI_FAILURE(status)) {

		dev_err(dev, "failed to find NFIT\n");

		return -ENXIO;

	}



	acpi_desc = devm_kzalloc(dev, sizeof(*acpi_desc), GFP_KERNEL);

	if (!acpi_desc)

		return -ENOMEM;



	dev_set_drvdata(dev, acpi_desc);

	acpi_desc->dev = dev;

	acpi_desc->nfit = (struct acpi_table_nfit *) tbl;

	nd_desc = &acpi_desc->nd_desc;

	nd_desc->provider_name = "ACPI.NFIT";

	nd_desc->ndctl = acpi_nfit_ctl;



	acpi_desc->nvdimm_bus = nvdimm_bus_register(dev, nd_desc);

	if (!acpi_desc->nvdimm_bus)

		return -ENXIO;



	rc = acpi_nfit_init(acpi_desc, sz);

	if (rc) {

		nvdimm_bus_unregister(acpi_desc->nvdimm_bus);

		return rc;

	}

	return 0;

}



static int acpi_nfit_remove(struct acpi_device *adev)

{

	struct acpi_nfit_desc *acpi_desc = dev_get_drvdata(&adev->dev);



	nvdimm_bus_unregister(acpi_desc->nvdimm_bus);

	return 0;

}



static const struct acpi_device_id acpi_nfit_ids[] = {

	{ "ACPI0012", 0 },

	{ "", 0 },

};

MODULE_DEVICE_TABLE(acpi, acpi_nfit_ids);



static struct acpi_driver acpi_nfit_driver = {

	.name = KBUILD_MODNAME,

	.ids = acpi_nfit_ids,

	.ops = {

		.add = acpi_nfit_add,

		.remove = acpi_nfit_remove,

	},

};



static __init int nfit_init(void)

{

	BUILD_BUG_ON(sizeof(struct acpi_table_nfit) != 40);

	BUILD_BUG_ON(sizeof(struct acpi_nfit_system_address) != 56);

	BUILD_BUG_ON(sizeof(struct acpi_nfit_memory_map) != 48);

	BUILD_BUG_ON(sizeof(struct acpi_nfit_interleave) != 20);

	BUILD_BUG_ON(sizeof(struct acpi_nfit_smbios) != 9);

	BUILD_BUG_ON(sizeof(struct acpi_nfit_control_region) != 80);

	BUILD_BUG_ON(sizeof(struct acpi_nfit_data_region) != 40);



	acpi_str_to_uuid(UUID_VOLATILE_MEMORY, nfit_uuid[NFIT_SPA_VOLATILE]);

	acpi_str_to_uuid(UUID_PERSISTENT_MEMORY, nfit_uuid[NFIT_SPA_PM]);

	acpi_str_to_uuid(UUID_CONTROL_REGION, nfit_uuid[NFIT_SPA_DCR]);

	acpi_str_to_uuid(UUID_DATA_REGION, nfit_uuid[NFIT_SPA_BDW]);

	acpi_str_to_uuid(UUID_VOLATILE_VIRTUAL_DISK, nfit_uuid[NFIT_SPA_VDISK]);

	acpi_str_to_uuid(UUID_VOLATILE_VIRTUAL_CD, nfit_uuid[NFIT_SPA_VCD]);

	acpi_str_to_uuid(UUID_PERSISTENT_VIRTUAL_DISK, nfit_uuid[NFIT_SPA_PDISK]);

	acpi_str_to_uuid(UUID_PERSISTENT_VIRTUAL_CD, nfit_uuid[NFIT_SPA_PCD]);

	acpi_str_to_uuid(UUID_NFIT_BUS, nfit_uuid[NFIT_DEV_BUS]);

	acpi_str_to_uuid(UUID_NFIT_DIMM, nfit_uuid[NFIT_DEV_DIMM]);



	return acpi_bus_register_driver(&acpi_nfit_driver);

}



static __exit void nfit_exit(void)

{

	acpi_bus_unregister_driver(&acpi_nfit_driver);

}



module_init(nfit_init);

module_exit(nfit_exit);

MODULE_LICENSE("GPL v2");

MODULE_AUTHOR("Intel Corporation");

CRA Git | Maintained and supported by SUSTech CRA and CCSE