[deliverable/linux.git] / drivers / acpi / acpi_memhotplug.c

/*
 * Copyright (C) 2004, 2013 Intel Corporation
 * Author: Naveen B S <naveen.b.s@intel.com>
 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
 *
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * 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, GOOD TITLE or
 * NON INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *
 * ACPI based HotPlug driver that supports Memory Hotplug
 * This driver fields notifications from firmware for memory add
 * and remove operations and alerts the VM of the affected memory
 * ranges.
 */

#include <linux/acpi.h>
#include <linux/memory_hotplug.h>

#include "internal.h"

#define ACPI_MEMORY_DEVICE_CLASS		"memory"
#define ACPI_MEMORY_DEVICE_HID			"PNP0C80"
#define ACPI_MEMORY_DEVICE_NAME			"Hotplug Mem Device"

#define _COMPONENT		ACPI_MEMORY_DEVICE_COMPONENT

#undef PREFIX
#define 	PREFIX		"ACPI:memory_hp:"

ACPI_MODULE_NAME("acpi_memhotplug");

/* Memory Device States */
#define MEMORY_INVALID_STATE	0
#define MEMORY_POWER_ON_STATE	1
#define MEMORY_POWER_OFF_STATE	2

static int acpi_memory_device_add(struct acpi_device *device,
				  const struct acpi_device_id *not_used);
static void acpi_memory_device_remove(struct acpi_device *device);

static const struct acpi_device_id memory_device_ids[] = {
	{ACPI_MEMORY_DEVICE_HID, 0},
	{"", 0},
};

static struct acpi_scan_handler memory_device_handler = {
	.ids = memory_device_ids,
	.attach = acpi_memory_device_add,
	.detach = acpi_memory_device_remove,
	.hotplug = {
		.enabled = true,
	},
};

struct acpi_memory_info {
	struct list_head list;
	u64 start_addr;		/* Memory Range start physical addr */
	u64 length;		/* Memory Range length */
	unsigned short caching;	/* memory cache attribute */
	unsigned short write_protect;	/* memory read/write attribute */
	unsigned int enabled:1;
};

struct acpi_memory_device {
	struct acpi_device * device;
	unsigned int state;	/* State of the memory device */
	struct list_head res_list;
};

static acpi_status
acpi_memory_get_resource(struct acpi_resource *resource, void *context)
{
	struct acpi_memory_device *mem_device = context;
	struct acpi_resource_address64 address64;
	struct acpi_memory_info *info, *new;
	acpi_status status;

	status = acpi_resource_to_address64(resource, &address64);
	if (ACPI_FAILURE(status) ||
	    (address64.resource_type != ACPI_MEMORY_RANGE))
		return AE_OK;

	list_for_each_entry(info, &mem_device->res_list, list) {
		/* Can we combine the resource range information? */
		if ((info->caching == address64.info.mem.caching) &&
		    (info->write_protect == address64.info.mem.write_protect) &&
		    (info->start_addr + info->length == address64.minimum)) {
			info->length += address64.address_length;
			return AE_OK;
		}
	}

	new = kzalloc(sizeof(struct acpi_memory_info), GFP_KERNEL);
	if (!new)
		return AE_ERROR;

	INIT_LIST_HEAD(&new->list);
	new->caching = address64.info.mem.caching;
	new->write_protect = address64.info.mem.write_protect;
	new->start_addr = address64.minimum;
	new->length = address64.address_length;
	list_add_tail(&new->list, &mem_device->res_list);

	return AE_OK;
}

static void
acpi_memory_free_device_resources(struct acpi_memory_device *mem_device)
{
	struct acpi_memory_info *info, *n;

	list_for_each_entry_safe(info, n, &mem_device->res_list, list)
		kfree(info);
	INIT_LIST_HEAD(&mem_device->res_list);
}

static int
acpi_memory_get_device_resources(struct acpi_memory_device *mem_device)
{
	acpi_status status;

	if (!list_empty(&mem_device->res_list))
		return 0;

	status = acpi_walk_resources(mem_device->device->handle, METHOD_NAME__CRS,
				     acpi_memory_get_resource, mem_device);
	if (ACPI_FAILURE(status)) {
		acpi_memory_free_device_resources(mem_device);
		return -EINVAL;
	}

	return 0;
}

static int acpi_memory_check_device(struct acpi_memory_device *mem_device)
{
	unsigned long long current_status;

	/* Get device present/absent information from the _STA */
	if (ACPI_FAILURE(acpi_evaluate_integer(mem_device->device->handle, "_STA",
					       NULL, &current_status)))
		return -ENODEV;
	/*
	 * Check for device status. Device should be
	 * present/enabled/functioning.
	 */
	if (!((current_status & ACPI_STA_DEVICE_PRESENT)
	      && (current_status & ACPI_STA_DEVICE_ENABLED)
	      && (current_status & ACPI_STA_DEVICE_FUNCTIONING)))
		return -ENODEV;

	return 0;
}

static int acpi_memory_enable_device(struct acpi_memory_device *mem_device)
{
	int result, num_enabled = 0;
	struct acpi_memory_info *info;
	int node;

	node = acpi_get_node(mem_device->device->handle);
	/*
	 * Tell the VM there is more memory here...
	 * Note: Assume that this function returns zero on success
	 * We don't have memory-hot-add rollback function,now.
	 * (i.e. memory-hot-remove function)
	 */
	list_for_each_entry(info, &mem_device->res_list, list) {
		if (info->enabled) { /* just sanity check...*/
			num_enabled++;
			continue;
		}
		/*
		 * If the memory block size is zero, please ignore it.
		 * Don't try to do the following memory hotplug flowchart.
		 */
		if (!info->length)
			continue;
		if (node < 0)
			node = memory_add_physaddr_to_nid(info->start_addr);

		result = add_memory(node, info->start_addr, info->length);

		/*
		 * If the memory block has been used by the kernel, add_memory()
		 * returns -EEXIST. If add_memory() returns the other error, it
		 * means that this memory block is not used by the kernel.
		 */
		if (result && result != -EEXIST)
			continue;

		info->enabled = 1;

		/*
		 * Add num_enable even if add_memory() returns -EEXIST, so the
		 * device is bound to this driver.
		 */
		num_enabled++;
	}
	if (!num_enabled) {
		dev_err(&mem_device->device->dev, "add_memory failed\n");
		mem_device->state = MEMORY_INVALID_STATE;
		return -EINVAL;
	}
	/*
	 * Sometimes the memory device will contain several memory blocks.
	 * When one memory block is hot-added to the system memory, it will
	 * be regarded as a success.
	 * Otherwise if the last memory block can't be hot-added to the system
	 * memory, it will be failure and the memory device can't be bound with
	 * driver.
	 */
	return 0;
}

static int acpi_memory_remove_memory(struct acpi_memory_device *mem_device)
{
	int result = 0, nid;
	struct acpi_memory_info *info, *n;

	nid = acpi_get_node(mem_device->device->handle);

	list_for_each_entry_safe(info, n, &mem_device->res_list, list) {
		if (!info->enabled)
			continue;

		if (nid < 0)
			nid = memory_add_physaddr_to_nid(info->start_addr);
		result = remove_memory(nid, info->start_addr, info->length);
		if (result)
			return result;

		list_del(&info->list);
		kfree(info);
	}

	return result;
}

static void acpi_memory_device_free(struct acpi_memory_device *mem_device)
{
	if (!mem_device)
		return;

	acpi_memory_free_device_resources(mem_device);
	mem_device->device->driver_data = NULL;
	kfree(mem_device);
}

static int acpi_memory_device_add(struct acpi_device *device,
				  const struct acpi_device_id *not_used)
{
	struct acpi_memory_device *mem_device;
	int result;

	if (!device)
		return -EINVAL;

	mem_device = kzalloc(sizeof(struct acpi_memory_device), GFP_KERNEL);
	if (!mem_device)
		return -ENOMEM;

	INIT_LIST_HEAD(&mem_device->res_list);
	mem_device->device = device;
	sprintf(acpi_device_name(device), "%s", ACPI_MEMORY_DEVICE_NAME);
	sprintf(acpi_device_class(device), "%s", ACPI_MEMORY_DEVICE_CLASS);
	device->driver_data = mem_device;

	/* Get the range from the _CRS */
	result = acpi_memory_get_device_resources(mem_device);
	if (result) {
		kfree(mem_device);
		return result;
	}

	/* Set the device state */
	mem_device->state = MEMORY_POWER_ON_STATE;

	result = acpi_memory_check_device(mem_device);
	if (result) {
		acpi_memory_device_free(mem_device);
		return 0;
	}

	result = acpi_memory_enable_device(mem_device);
	if (result) {
		dev_err(&device->dev, "acpi_memory_enable_device() error\n");
		acpi_memory_device_free(mem_device);
		return -ENODEV;
	}

	dev_dbg(&device->dev, "Memory device configured by ACPI\n");
	return 1;
}

static void acpi_memory_device_remove(struct acpi_device *device)
{
	struct acpi_memory_device *mem_device;

	if (!device || !acpi_driver_data(device))
		return;

	mem_device = acpi_driver_data(device);
	acpi_memory_remove_memory(mem_device);
	acpi_memory_device_free(mem_device);
}

void __init acpi_memory_hotplug_init(void)
{
	acpi_scan_add_handler_with_hotplug(&memory_device_handler, "memory");
}
Commit	Line	Data
1da177e4	1	/*
0a347644 RW	2	* Copyright (C) 2004, 2013 Intel Corporation
	3	* Author: Naveen B S <naveen.b.s@intel.com>
	4	* Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
1da177e4 LT	5	*
	6	* All rights reserved.
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or (at
	11	* your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful, but
	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
	16	* NON INFRINGEMENT. See the GNU General Public License for more
	17	* details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	22	*
	23	*
	24	* ACPI based HotPlug driver that supports Memory Hotplug
c7060d9e	25	* This driver fields notifications from firmware for memory add
1da177e4 LT	26	* and remove operations and alerts the VM of the affected memory
	27	* ranges.
	28	*/
	29
ab6c5709	30	#include <linux/acpi.h>
0a347644 RW	31	#include <linux/memory_hotplug.h>
	32
	33	#include "internal.h"
1da177e4	34
1da177e4 LT	35	#define ACPI_MEMORY_DEVICE_CLASS "memory"
1da177e4 LT	36	#define ACPI_MEMORY_DEVICE_HID "PNP0C80"
1da177e4 LT	37	#define ACPI_MEMORY_DEVICE_NAME "Hotplug Mem Device"
	38
	39	#define _COMPONENT ACPI_MEMORY_DEVICE_COMPONENT
	40
aa7b2b2e ZY	41	#undef PREFIX
	42	#define PREFIX "ACPI:memory_hp:"
	43
f52fd66d	44	ACPI_MODULE_NAME("acpi_memhotplug");
1da177e4	45
1da177e4 LT	46	/* Memory Device States */
	47	#define MEMORY_INVALID_STATE 0
	48	#define MEMORY_POWER_ON_STATE 1
	49	#define MEMORY_POWER_OFF_STATE 2
	50
0a347644 RW	51	static int acpi_memory_device_add(struct acpi_device *device,
	52	const struct acpi_device_id *not_used);
	53	static void acpi_memory_device_remove(struct acpi_device *device);
1da177e4	54
1ba90e3a TR	55	static const struct acpi_device_id memory_device_ids[] = {
	56	{ACPI_MEMORY_DEVICE_HID, 0},
	57	{"", 0},
	58	};
1ba90e3a	59
0a347644	60	static struct acpi_scan_handler memory_device_handler = {
1ba90e3a	61	.ids = memory_device_ids,
0a347644 RW	62	.attach = acpi_memory_device_add,
	63	.detach = acpi_memory_device_remove,
	64	.hotplug = {
	65	.enabled = true,
	66	},
1da177e4 LT	67	};
1da177e4 LT	68
9ac02398 KH	69	struct acpi_memory_info {
	70	struct list_head list;
	71	u64 start_addr; /* Memory Range start physical addr */
	72	u64 length; /* Memory Range length */
	73	unsigned short caching; /* memory cache attribute */
	74	unsigned short write_protect; /* memory read/write attribute */
	75	unsigned int enabled:1;
	76	};
	77
1da177e4	78	struct acpi_memory_device {
3b74863d	79	struct acpi_device * device;
4be44fcd	80	unsigned int state; /* State of the memory device */
9ac02398	81	struct list_head res_list;
1da177e4 LT	82	};
1da177e4 LT	83
9ac02398 KH	84	static acpi_status
	85	acpi_memory_get_resource(struct acpi_resource resource, void context)
	86	{
	87	struct acpi_memory_device *mem_device = context;
	88	struct acpi_resource_address64 address64;
	89	struct acpi_memory_info info, new;
	90	acpi_status status;
	91
	92	status = acpi_resource_to_address64(resource, &address64);
	93	if (ACPI_FAILURE(status) \|\|
	94	(address64.resource_type != ACPI_MEMORY_RANGE))
	95	return AE_OK;
	96
	97	list_for_each_entry(info, &mem_device->res_list, list) {
	98	/* Can we combine the resource range information? */
	99	if ((info->caching == address64.info.mem.caching) &&
	100	(info->write_protect == address64.info.mem.write_protect) &&
	101	(info->start_addr + info->length == address64.minimum)) {
	102	info->length += address64.address_length;
	103	return AE_OK;
	104	}
	105	}
	106
	107	new = kzalloc(sizeof(struct acpi_memory_info), GFP_KERNEL);
	108	if (!new)
	109	return AE_ERROR;
	110
	111	INIT_LIST_HEAD(&new->list);
	112	new->caching = address64.info.mem.caching;
	113	new->write_protect = address64.info.mem.write_protect;
	114	new->start_addr = address64.minimum;
	115	new->length = address64.address_length;
	116	list_add_tail(&new->list, &mem_device->res_list);
	117
	118	return AE_OK;
	119	}
	120
386e52b9 WC	121	static void
	122	acpi_memory_free_device_resources(struct acpi_memory_device *mem_device)
	123	{
	124	struct acpi_memory_info info, n;
	125
	126	list_for_each_entry_safe(info, n, &mem_device->res_list, list)
	127	kfree(info);
	128	INIT_LIST_HEAD(&mem_device->res_list);
	129	}
	130
1da177e4 LT	131	static int
	132	acpi_memory_get_device_resources(struct acpi_memory_device *mem_device)
	133	{
	134	acpi_status status;
1da177e4	135
5d2870fa KH	136	if (!list_empty(&mem_device->res_list))
	137	return 0;
	138
b8632785	139	status = acpi_walk_resources(mem_device->device->handle, METHOD_NAME__CRS,
9ac02398 KH	140	acpi_memory_get_resource, mem_device);
9ac02398 KH	141	if (ACPI_FAILURE(status)) {
386e52b9	142	acpi_memory_free_device_resources(mem_device);
d550d98d	143	return -EINVAL;
1da177e4 LT	144	}
1da177e4 LT	145
d550d98d	146	return 0;
1da177e4 LT	147	}
1da177e4 LT	148
4be44fcd	149	static int acpi_memory_check_device(struct acpi_memory_device *mem_device)
1da177e4	150	{
27663c58	151	unsigned long long current_status;
1da177e4 LT	152
1da177e4 LT	153	/* Get device present/absent information from the _STA */
b8632785	154	if (ACPI_FAILURE(acpi_evaluate_integer(mem_device->device->handle, "_STA",
4be44fcd	155	NULL, &current_status)))
d550d98d	156	return -ENODEV;
1da177e4 LT	157	/*
	158	* Check for device status. Device should be
	159	* present/enabled/functioning.
	160	*/
a0bd4ac4 BH	161	if (!((current_status & ACPI_STA_DEVICE_PRESENT)
	162	&& (current_status & ACPI_STA_DEVICE_ENABLED)
	163	&& (current_status & ACPI_STA_DEVICE_FUNCTIONING)))
d550d98d	164	return -ENODEV;
1da177e4	165
d550d98d	166	return 0;
1da177e4 LT	167	}
1da177e4 LT	168
4be44fcd	169	static int acpi_memory_enable_device(struct acpi_memory_device *mem_device)
1da177e4	170	{
9ac02398 KH	171	int result, num_enabled = 0;
9ac02398 KH	172	struct acpi_memory_info *info;
1e3590e2	173	int node;
1da177e4	174
b8632785	175	node = acpi_get_node(mem_device->device->handle);
1da177e4 LT	176	/*
	177	* Tell the VM there is more memory here...
	178	* Note: Assume that this function returns zero on success
9ac02398 KH	179	* We don't have memory-hot-add rollback function,now.
9ac02398 KH	180	* (i.e. memory-hot-remove function)
1da177e4	181	*/
9ac02398	182	list_for_each_entry(info, &mem_device->res_list, list) {
fa25d8d6	183	if (info->enabled) { /* just sanity check...*/
dd56a8e3 YG	184	num_enabled++;
	185	continue;
	186	}
5d2619fc ZY	187	/*
	188	* If the memory block size is zero, please ignore it.
	189	* Don't try to do the following memory hotplug flowchart.
	190	*/
	191	if (!info->length)
	192	continue;
8c2676a5 KM	193	if (node < 0)
	194	node = memory_add_physaddr_to_nid(info->start_addr);
	195
bc02af93	196	result = add_memory(node, info->start_addr, info->length);
65479472 WC	197
	198	/*
	199	* If the memory block has been used by the kernel, add_memory()
	200	* returns -EEXIST. If add_memory() returns the other error, it
	201	* means that this memory block is not used by the kernel.
	202	*/
fd4655c2	203	if (result && result != -EEXIST)
9ac02398	204	continue;
65479472	205
bb49d82d YI	206	info->enabled = 1;
bb49d82d YI	207
65479472 WC	208	/*
	209	* Add num_enable even if add_memory() returns -EEXIST, so the
	210	* device is bound to this driver.
	211	*/
9ac02398 KH	212	num_enabled++;
	213	}
	214	if (!num_enabled) {
ab6c5709	215	dev_err(&mem_device->device->dev, "add_memory failed\n");
1da177e4	216	mem_device->state = MEMORY_INVALID_STATE;
9ac02398	217	return -EINVAL;
1da177e4	218	}
5d2619fc ZY	219	/*
	220	* Sometimes the memory device will contain several memory blocks.
	221	* When one memory block is hot-added to the system memory, it will
	222	* be regarded as a success.
	223	* Otherwise if the last memory block can't be hot-added to the system
	224	* memory, it will be failure and the memory device can't be bound with
	225	* driver.
	226	*/
	227	return 0;
1da177e4 LT	228	}
1da177e4 LT	229
19387b27	230	static int acpi_memory_remove_memory(struct acpi_memory_device *mem_device)
1da177e4	231	{
60a5a19e	232	int result = 0, nid;
9ac02398	233	struct acpi_memory_info info, n;
1da177e4	234
60a5a19e TC	235	nid = acpi_get_node(mem_device->device->handle);
60a5a19e TC	236
9ac02398	237	list_for_each_entry_safe(info, n, &mem_device->res_list, list) {
65479472	238	if (!info->enabled)
fd4655c2	239	continue;
65479472	240
60a5a19e TC	241	if (nid < 0)
	242	nid = memory_add_physaddr_to_nid(info->start_addr);
	243	result = remove_memory(nid, info->start_addr, info->length);
65479472 WC	244	if (result)
65479472 WC	245	return result;
19387b27 YI	246
19387b27 YI	247	list_del(&info->list);
9ac02398	248	kfree(info);
1da177e4 LT	249	}
1da177e4 LT	250
65479472	251	return result;
19387b27 YI	252	}
19387b27 YI	253
386e52b9 WC	254	static void acpi_memory_device_free(struct acpi_memory_device *mem_device)
	255	{
	256	if (!mem_device)
	257	return;
	258
	259	acpi_memory_free_device_resources(mem_device);
0a347644	260	mem_device->device->driver_data = NULL;
386e52b9 WC	261	kfree(mem_device);
	262	}
	263
0a347644 RW	264	static int acpi_memory_device_add(struct acpi_device *device,
0a347644 RW	265	const struct acpi_device_id *not_used)
1da177e4	266	{
0a347644	267	struct acpi_memory_device *mem_device;
1da177e4	268	int result;
1da177e4 LT	269
1da177e4 LT	270	if (!device)
d550d98d	271	return -EINVAL;
1da177e4	272
36bcbec7	273	mem_device = kzalloc(sizeof(struct acpi_memory_device), GFP_KERNEL);
1da177e4	274	if (!mem_device)
d550d98d	275	return -ENOMEM;
1da177e4	276
9ac02398	277	INIT_LIST_HEAD(&mem_device->res_list);
3b74863d	278	mem_device->device = device;
1da177e4 LT	279	sprintf(acpi_device_name(device), "%s", ACPI_MEMORY_DEVICE_NAME);
1da177e4 LT	280	sprintf(acpi_device_class(device), "%s", ACPI_MEMORY_DEVICE_CLASS);
db89b4f0	281	device->driver_data = mem_device;
1da177e4 LT	282
	283	/* Get the range from the _CRS */
	284	result = acpi_memory_get_device_resources(mem_device);
	285	if (result) {
	286	kfree(mem_device);
d550d98d	287	return result;
1da177e4 LT	288	}
	289
	290	/* Set the device state */
	291	mem_device->state = MEMORY_POWER_ON_STATE;
	292
0a347644 RW	293	result = acpi_memory_check_device(mem_device);
	294	if (result) {
	295	acpi_memory_device_free(mem_device);
	296	return 0;
	297	}
1da177e4	298
0a347644 RW	299	result = acpi_memory_enable_device(mem_device);
	300	if (result) {
	301	dev_err(&device->dev, "acpi_memory_enable_device() error\n");
	302	acpi_memory_device_free(mem_device);
	303	return -ENODEV;
1f425994	304	}
0a347644 RW	305
	306	dev_dbg(&device->dev, "Memory device configured by ACPI\n");
	307	return 1;
1f425994 YG	308	}
1f425994 YG	309
0a347644	310	static void acpi_memory_device_remove(struct acpi_device *device)
80f20fef	311	{
0a347644	312	struct acpi_memory_device *mem_device;
80f20fef BH	313
80f20fef BH	314	if (!device \|\| !acpi_driver_data(device))
0a347644	315	return;
80f20fef BH	316
80f20fef BH	317	mem_device = acpi_driver_data(device);
0a347644	318	acpi_memory_remove_memory(mem_device);
386e52b9	319	acpi_memory_device_free(mem_device);
1da177e4 LT	320	}
1da177e4 LT	321
0a347644	322	void __init acpi_memory_hotplug_init(void)
1da177e4	323	{
0a347644	324	acpi_scan_add_handler_with_hotplug(&memory_device_handler, "memory");
1da177e4	325	}