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

/*
 * Copyright (C) 2004 Intel Corporation <naveen.b.s@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/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/types.h>
#include <linux/memory_hotplug.h>
#include <linux/slab.h>
#include <acpi/acpi_drivers.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");
MODULE_AUTHOR("Naveen B S <naveen.b.s@intel.com>");
MODULE_DESCRIPTION("Hotplug Mem Driver");
MODULE_LICENSE("GPL");

/* 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);
static int acpi_memory_device_remove(struct acpi_device *device, int type);

static const struct acpi_device_id memory_device_ids[] = {
	{ACPI_MEMORY_DEVICE_HID, 0},
	{"", 0},
};
MODULE_DEVICE_TABLE(acpi, memory_device_ids);

static struct acpi_driver acpi_memory_device_driver = {
	.name = "acpi_memhotplug",
	.class = ACPI_MEMORY_DEVICE_CLASS,
	.ids = memory_device_ids,
	.ops = {
		.add = acpi_memory_device_add,
		.remove = acpi_memory_device_remove,
		},
};

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 int acpi_hotmem_initialized;

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_get_device(acpi_handle handle,
		       struct acpi_memory_device **mem_device)
{
	acpi_status status;
	acpi_handle phandle;
	struct acpi_device *device = NULL;
	struct acpi_device *pdevice = NULL;
	int result;


	if (!acpi_bus_get_device(handle, &device) && device)
		goto end;

	status = acpi_get_parent(handle, &phandle);
	if (ACPI_FAILURE(status)) {
		ACPI_EXCEPTION((AE_INFO, status, "Cannot find acpi parent"));
		return -EINVAL;
	}

	/* Get the parent device */
	result = acpi_bus_get_device(phandle, &pdevice);
	if (result) {
		printk(KERN_WARNING PREFIX "Cannot get acpi bus device");
		return -EINVAL;
	}

	/*
	 * Now add the notified device.  This creates the acpi_device
	 * and invokes .add function
	 */
	result = acpi_bus_add(&device, pdevice, handle, ACPI_BUS_TYPE_DEVICE);
	if (result) {
		printk(KERN_WARNING PREFIX "Cannot add acpi bus");
		return -EINVAL;
	}

      end:
	*mem_device = acpi_driver_data(device);
	if (!(*mem_device)) {
		printk(KERN_ERR "\n driver data not found");
		return -ENODEV;
	}

	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;


	/* Get the range from the _CRS */
	result = acpi_memory_get_device_resources(mem_device);
	if (result) {
		printk(KERN_ERR PREFIX "get_device_resources failed\n");
		mem_device->state = MEMORY_INVALID_STATE;
		return result;
	}

	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 (result)
			continue;
		info->enabled = 1;
		num_enabled++;
	}
	if (!num_enabled) {
		printk(KERN_ERR PREFIX "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;
	struct acpi_memory_info *info, *n;

	list_for_each_entry_safe(info, n, &mem_device->res_list, list) {
		if (info->enabled) {
			result = remove_memory(info->start_addr, info->length);
			if (result)
				return result;
		}

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

	return 0;
}

static void acpi_memory_device_notify(acpi_handle handle, u32 event, void *data)
{
	struct acpi_memory_device *mem_device;
	struct acpi_device *device;
	struct acpi_eject_event *ej_event = NULL;
	u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE; /* default */

	switch (event) {
	case ACPI_NOTIFY_BUS_CHECK:
		ACPI_DEBUG_PRINT((ACPI_DB_INFO,
				  "\nReceived BUS CHECK notification for device\n"));
		/* Fall Through */
	case ACPI_NOTIFY_DEVICE_CHECK:
		if (event == ACPI_NOTIFY_DEVICE_CHECK)
			ACPI_DEBUG_PRINT((ACPI_DB_INFO,
					  "\nReceived DEVICE CHECK notification for device\n"));
		if (acpi_memory_get_device(handle, &mem_device)) {
			printk(KERN_ERR PREFIX "Cannot find driver data\n");
			break;
		}

		if (acpi_memory_check_device(mem_device))
			break;

		if (acpi_memory_enable_device(mem_device)) {
			printk(KERN_ERR PREFIX "Cannot enable memory device\n");
			break;
		}

		ost_code = ACPI_OST_SC_SUCCESS;
		break;

	case ACPI_NOTIFY_EJECT_REQUEST:
		ACPI_DEBUG_PRINT((ACPI_DB_INFO,
				  "\nReceived EJECT REQUEST notification for device\n"));

		if (acpi_bus_get_device(handle, &device)) {
			printk(KERN_ERR PREFIX "Device doesn't exist\n");
			break;
		}
		mem_device = acpi_driver_data(device);
		if (!mem_device) {
			printk(KERN_ERR PREFIX "Driver Data is NULL\n");
			break;
		}

		ej_event = kmalloc(sizeof(*ej_event), GFP_KERNEL);
		if (!ej_event) {
			pr_err(PREFIX "No memory, dropping EJECT\n");
			break;
		}

		ej_event->handle = handle;
		ej_event->event = ACPI_NOTIFY_EJECT_REQUEST;
		acpi_os_hotplug_execute(acpi_bus_hot_remove_device,
					(void *)ej_event);

		/* eject is performed asynchronously */
		return;
	default:
		ACPI_DEBUG_PRINT((ACPI_DB_INFO,
				  "Unsupported event [0x%x]\n", event));

		/* non-hotplug event; possibly handled by other handler */
		return;
	}

	/* Inform firmware that the hotplug operation has completed */
	(void) acpi_evaluate_hotplug_ost(handle, event, ost_code, NULL);
	return;
}

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

	acpi_memory_free_device_resources(mem_device);
	kfree(mem_device);
}

static int acpi_memory_device_add(struct acpi_device *device)
{
	int result;
	struct acpi_memory_device *mem_device = NULL;


	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;

	printk(KERN_DEBUG "%s \n", acpi_device_name(device));

	/*
	 * Early boot code has recognized memory area by EFI/E820.
	 * If DSDT shows these memory devices on boot, hotplug is not necessary
	 * for them. So, it just returns until completion of this driver's
	 * start up.
	 */
	if (!acpi_hotmem_initialized)
		return 0;

	if (!acpi_memory_check_device(mem_device)) {
		/* call add_memory func */
		result = acpi_memory_enable_device(mem_device);
		if (result) {
			printk(KERN_ERR PREFIX
				"Error in acpi_memory_enable_device\n");
			acpi_memory_device_free(mem_device);
		}
	}
	return result;
}

static int acpi_memory_device_remove(struct acpi_device *device, int type)
{
	struct acpi_memory_device *mem_device = NULL;
	int result;

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

	mem_device = acpi_driver_data(device);

	result = acpi_memory_remove_memory(mem_device);
	if (result)
		return result;

	acpi_memory_device_free(mem_device);

	return 0;
}

/*
 * Helper function to check for memory device
 */
static acpi_status is_memory_device(acpi_handle handle)
{
	char *hardware_id;
	acpi_status status;
	struct acpi_device_info *info;

	status = acpi_get_object_info(handle, &info);
	if (ACPI_FAILURE(status))
		return status;

	if (!(info->valid & ACPI_VALID_HID)) {
		kfree(info);
		return AE_ERROR;
	}

	hardware_id = info->hardware_id.string;
	if ((hardware_id == NULL) ||
	    (strcmp(hardware_id, ACPI_MEMORY_DEVICE_HID)))
		status = AE_ERROR;

	kfree(info);
	return status;
}

static acpi_status
acpi_memory_register_notify_handler(acpi_handle handle,
				    u32 level, void *ctxt, void **retv)
{
	acpi_status status;


	status = is_memory_device(handle);
	if (ACPI_FAILURE(status))
		return AE_OK;	/* continue */

	status = acpi_install_notify_handler(handle, ACPI_SYSTEM_NOTIFY,
					     acpi_memory_device_notify, NULL);
	/* continue */
	return AE_OK;
}

static acpi_status
acpi_memory_deregister_notify_handler(acpi_handle handle,
				      u32 level, void *ctxt, void **retv)
{
	acpi_status status;


	status = is_memory_device(handle);
	if (ACPI_FAILURE(status))
		return AE_OK;	/* continue */

	status = acpi_remove_notify_handler(handle,
					    ACPI_SYSTEM_NOTIFY,
					    acpi_memory_device_notify);

	return AE_OK;	/* continue */
}

static int __init acpi_memory_device_init(void)
{
	int result;
	acpi_status status;


	result = acpi_bus_register_driver(&acpi_memory_device_driver);

	if (result < 0)
		return -ENODEV;

	status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
				     ACPI_UINT32_MAX,
				     acpi_memory_register_notify_handler, NULL,
				     NULL, NULL);

	if (ACPI_FAILURE(status)) {
		ACPI_EXCEPTION((AE_INFO, status, "walk_namespace failed"));
		acpi_bus_unregister_driver(&acpi_memory_device_driver);
		return -ENODEV;
	}

	acpi_hotmem_initialized = 1;
	return 0;
}

static void __exit acpi_memory_device_exit(void)
{
	acpi_status status;


	/*
	 * Adding this to un-install notification handlers for all the device
	 * handles.
	 */
	status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
				     ACPI_UINT32_MAX,
				     acpi_memory_deregister_notify_handler, NULL,
				     NULL, NULL);

	if (ACPI_FAILURE(status))
		ACPI_EXCEPTION((AE_INFO, status, "walk_namespace failed"));

	acpi_bus_unregister_driver(&acpi_memory_device_driver);

	return;
}

module_init(acpi_memory_device_init);
module_exit(acpi_memory_device_exit);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Copyright (C) 2004 Intel Corporation <naveen.b.s@intel.com>
	3	*
	4	* All rights reserved.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or (at
	9	* your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful, but
	12	* WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
	14	* NON INFRINGEMENT. See the GNU General Public License for more
	15	* details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	20	*
	21	*
	22	* ACPI based HotPlug driver that supports Memory Hotplug
c7060d9e	23	* This driver fields notifications from firmware for memory add
1da177e4 LT	24	* and remove operations and alerts the VM of the affected memory
	25	* ranges.
	26	*/
	27
	28	#include <linux/kernel.h>
	29	#include <linux/module.h>
	30	#include <linux/init.h>
	31	#include <linux/types.h>
	32	#include <linux/memory_hotplug.h>
5a0e3ad6	33	#include <linux/slab.h>
1da177e4 LT	34	#include <acpi/acpi_drivers.h>
1da177e4 LT	35
1da177e4 LT	36	#define ACPI_MEMORY_DEVICE_CLASS "memory"
1da177e4 LT	37	#define ACPI_MEMORY_DEVICE_HID "PNP0C80"
1da177e4 LT	38	#define ACPI_MEMORY_DEVICE_NAME "Hotplug Mem Device"
	39
	40	#define _COMPONENT ACPI_MEMORY_DEVICE_COMPONENT
	41
aa7b2b2e ZY	42	#undef PREFIX
	43	#define PREFIX "ACPI:memory_hp:"
	44
f52fd66d LB	45	ACPI_MODULE_NAME("acpi_memhotplug");
f52fd66d LB	46	MODULE_AUTHOR("Naveen B S <naveen.b.s@intel.com>");
7cda93e0	47	MODULE_DESCRIPTION("Hotplug Mem Driver");
1da177e4 LT	48	MODULE_LICENSE("GPL");
1da177e4 LT	49
1da177e4 LT	50	/* Memory Device States */
	51	#define MEMORY_INVALID_STATE 0
	52	#define MEMORY_POWER_ON_STATE 1
	53	#define MEMORY_POWER_OFF_STATE 2
	54
4be44fcd LB	55	static int acpi_memory_device_add(struct acpi_device *device);
4be44fcd LB	56	static int acpi_memory_device_remove(struct acpi_device *device, int type);
1da177e4	57
1ba90e3a TR	58	static const struct acpi_device_id memory_device_ids[] = {
	59	{ACPI_MEMORY_DEVICE_HID, 0},
	60	{"", 0},
	61	};
	62	MODULE_DEVICE_TABLE(acpi, memory_device_ids);
	63
1da177e4	64	static struct acpi_driver acpi_memory_device_driver = {
c2b6705b	65	.name = "acpi_memhotplug",
4be44fcd	66	.class = ACPI_MEMORY_DEVICE_CLASS,
1ba90e3a	67	.ids = memory_device_ids,
4be44fcd LB	68	.ops = {
	69	.add = acpi_memory_device_add,
	70	.remove = acpi_memory_device_remove,
	71	},
1da177e4 LT	72	};
1da177e4 LT	73
9ac02398 KH	74	struct acpi_memory_info {
	75	struct list_head list;
	76	u64 start_addr; /* Memory Range start physical addr */
	77	u64 length; /* Memory Range length */
	78	unsigned short caching; /* memory cache attribute */
	79	unsigned short write_protect; /* memory read/write attribute */
	80	unsigned int enabled:1;
	81	};
	82
1da177e4	83	struct acpi_memory_device {
3b74863d	84	struct acpi_device * device;
4be44fcd	85	unsigned int state; /* State of the memory device */
9ac02398	86	struct list_head res_list;
1da177e4 LT	87	};
1da177e4 LT	88
887b9593 YG	89	static int acpi_hotmem_initialized;
887b9593 YG	90
9ac02398 KH	91	static acpi_status
	92	acpi_memory_get_resource(struct acpi_resource resource, void context)
	93	{
	94	struct acpi_memory_device *mem_device = context;
	95	struct acpi_resource_address64 address64;
	96	struct acpi_memory_info info, new;
	97	acpi_status status;
	98
	99	status = acpi_resource_to_address64(resource, &address64);
	100	if (ACPI_FAILURE(status) \|\|
	101	(address64.resource_type != ACPI_MEMORY_RANGE))
	102	return AE_OK;
	103
	104	list_for_each_entry(info, &mem_device->res_list, list) {
	105	/* Can we combine the resource range information? */
	106	if ((info->caching == address64.info.mem.caching) &&
	107	(info->write_protect == address64.info.mem.write_protect) &&
	108	(info->start_addr + info->length == address64.minimum)) {
	109	info->length += address64.address_length;
	110	return AE_OK;
	111	}
	112	}
	113
	114	new = kzalloc(sizeof(struct acpi_memory_info), GFP_KERNEL);
	115	if (!new)
	116	return AE_ERROR;
	117
	118	INIT_LIST_HEAD(&new->list);
	119	new->caching = address64.info.mem.caching;
	120	new->write_protect = address64.info.mem.write_protect;
	121	new->start_addr = address64.minimum;
	122	new->length = address64.address_length;
	123	list_add_tail(&new->list, &mem_device->res_list);
	124
	125	return AE_OK;
	126	}
	127
386e52b9 WC	128	static void
	129	acpi_memory_free_device_resources(struct acpi_memory_device *mem_device)
	130	{
	131	struct acpi_memory_info info, n;
	132
	133	list_for_each_entry_safe(info, n, &mem_device->res_list, list)
	134	kfree(info);
	135	INIT_LIST_HEAD(&mem_device->res_list);
	136	}
	137
1da177e4 LT	138	static int
	139	acpi_memory_get_device_resources(struct acpi_memory_device *mem_device)
	140	{
	141	acpi_status status;
1da177e4	142
5d2870fa KH	143	if (!list_empty(&mem_device->res_list))
	144	return 0;
	145
b8632785	146	status = acpi_walk_resources(mem_device->device->handle, METHOD_NAME__CRS,
9ac02398 KH	147	acpi_memory_get_resource, mem_device);
9ac02398 KH	148	if (ACPI_FAILURE(status)) {
386e52b9	149	acpi_memory_free_device_resources(mem_device);
d550d98d	150	return -EINVAL;
1da177e4 LT	151	}
1da177e4 LT	152
d550d98d	153	return 0;
1da177e4 LT	154	}
	155
	156	static int
	157	acpi_memory_get_device(acpi_handle handle,
4be44fcd	158	struct acpi_memory_device **mem_device)
1da177e4 LT	159	{
	160	acpi_status status;
	161	acpi_handle phandle;
	162	struct acpi_device *device = NULL;
	163	struct acpi_device *pdevice = NULL;
aa7b2b2e	164	int result;
1da177e4	165
1da177e4 LT	166
	167	if (!acpi_bus_get_device(handle, &device) && device)
	168	goto end;
	169
	170	status = acpi_get_parent(handle, &phandle);
	171	if (ACPI_FAILURE(status)) {
a6fc6720	172	ACPI_EXCEPTION((AE_INFO, status, "Cannot find acpi parent"));
d550d98d	173	return -EINVAL;
1da177e4 LT	174	}
	175
	176	/* Get the parent device */
aa7b2b2e ZY	177	result = acpi_bus_get_device(phandle, &pdevice);
	178	if (result) {
	179	printk(KERN_WARNING PREFIX "Cannot get acpi bus device");
d550d98d	180	return -EINVAL;
1da177e4 LT	181	}
	182
	183	/*
	184	* Now add the notified device. This creates the acpi_device
	185	* and invokes .add function
	186	*/
aa7b2b2e ZY	187	result = acpi_bus_add(&device, pdevice, handle, ACPI_BUS_TYPE_DEVICE);
	188	if (result) {
	189	printk(KERN_WARNING PREFIX "Cannot add acpi bus");
d550d98d	190	return -EINVAL;
1da177e4 LT	191	}
1da177e4 LT	192
4be44fcd	193	end:
1da177e4 LT	194	*mem_device = acpi_driver_data(device);
1da177e4 LT	195	if (!(*mem_device)) {
4be44fcd	196	printk(KERN_ERR "\n driver data not found");
d550d98d	197	return -ENODEV;
1da177e4 LT	198	}
1da177e4 LT	199
d550d98d	200	return 0;
1da177e4 LT	201	}
1da177e4 LT	202
4be44fcd	203	static int acpi_memory_check_device(struct acpi_memory_device *mem_device)
1da177e4	204	{
27663c58	205	unsigned long long current_status;
1da177e4 LT	206
1da177e4 LT	207	/* Get device present/absent information from the _STA */
b8632785	208	if (ACPI_FAILURE(acpi_evaluate_integer(mem_device->device->handle, "_STA",
4be44fcd	209	NULL, &current_status)))
d550d98d	210	return -ENODEV;
1da177e4 LT	211	/*
	212	* Check for device status. Device should be
	213	* present/enabled/functioning.
	214	*/
a0bd4ac4 BH	215	if (!((current_status & ACPI_STA_DEVICE_PRESENT)
	216	&& (current_status & ACPI_STA_DEVICE_ENABLED)
	217	&& (current_status & ACPI_STA_DEVICE_FUNCTIONING)))
d550d98d	218	return -ENODEV;
1da177e4	219
d550d98d	220	return 0;
1da177e4 LT	221	}
1da177e4 LT	222
4be44fcd	223	static int acpi_memory_enable_device(struct acpi_memory_device *mem_device)
1da177e4	224	{
9ac02398 KH	225	int result, num_enabled = 0;
9ac02398 KH	226	struct acpi_memory_info *info;
1e3590e2	227	int node;
1da177e4	228
1da177e4 LT	229
	230	/* Get the range from the _CRS */
	231	result = acpi_memory_get_device_resources(mem_device);
	232	if (result) {
6468463a	233	printk(KERN_ERR PREFIX "get_device_resources failed\n");
1da177e4 LT	234	mem_device->state = MEMORY_INVALID_STATE;
	235	return result;
	236	}
	237
b8632785	238	node = acpi_get_node(mem_device->device->handle);
1da177e4 LT	239	/*
	240	* Tell the VM there is more memory here...
	241	* Note: Assume that this function returns zero on success
9ac02398 KH	242	* We don't have memory-hot-add rollback function,now.
9ac02398 KH	243	* (i.e. memory-hot-remove function)
1da177e4	244	*/
9ac02398	245	list_for_each_entry(info, &mem_device->res_list, list) {
fa25d8d6	246	if (info->enabled) { /* just sanity check...*/
dd56a8e3 YG	247	num_enabled++;
	248	continue;
	249	}
5d2619fc ZY	250	/*
	251	* If the memory block size is zero, please ignore it.
	252	* Don't try to do the following memory hotplug flowchart.
	253	*/
	254	if (!info->length)
	255	continue;
8c2676a5 KM	256	if (node < 0)
	257	node = memory_add_physaddr_to_nid(info->start_addr);
	258
bc02af93	259	result = add_memory(node, info->start_addr, info->length);
9ac02398 KH	260	if (result)
	261	continue;
	262	info->enabled = 1;
	263	num_enabled++;
	264	}
	265	if (!num_enabled) {
0a1f1ab8	266	printk(KERN_ERR PREFIX "add_memory failed\n");
1da177e4	267	mem_device->state = MEMORY_INVALID_STATE;
9ac02398	268	return -EINVAL;
1da177e4	269	}
5d2619fc ZY	270	/*
	271	* Sometimes the memory device will contain several memory blocks.
	272	* When one memory block is hot-added to the system memory, it will
	273	* be regarded as a success.
	274	* Otherwise if the last memory block can't be hot-added to the system
	275	* memory, it will be failure and the memory device can't be bound with
	276	* driver.
	277	*/
	278	return 0;
1da177e4 LT	279	}
1da177e4 LT	280
19387b27	281	static int acpi_memory_remove_memory(struct acpi_memory_device *mem_device)
1da177e4 LT	282	{
1da177e4 LT	283	int result;
9ac02398	284	struct acpi_memory_info info, n;
1da177e4	285
9ac02398 KH	286	list_for_each_entry_safe(info, n, &mem_device->res_list, list) {
	287	if (info->enabled) {
	288	result = remove_memory(info->start_addr, info->length);
	289	if (result)
	290	return result;
	291	}
19387b27 YI	292
19387b27 YI	293	list_del(&info->list);
9ac02398	294	kfree(info);
1da177e4 LT	295	}
1da177e4 LT	296
19387b27 YI	297	return 0;
	298	}
	299
4be44fcd	300	static void acpi_memory_device_notify(acpi_handle handle, u32 event, void *data)
1da177e4 LT	301	{
	302	struct acpi_memory_device *mem_device;
	303	struct acpi_device *device;
315bbae9	304	struct acpi_eject_event *ej_event = NULL;
b1f00de6	305	u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE; /* default */
1da177e4 LT	306
	307	switch (event) {
	308	case ACPI_NOTIFY_BUS_CHECK:
	309	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
4be44fcd	310	"\nReceived BUS CHECK notification for device\n"));
1da177e4 LT	311	/* Fall Through */
	312	case ACPI_NOTIFY_DEVICE_CHECK:
	313	if (event == ACPI_NOTIFY_DEVICE_CHECK)
	314	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
4be44fcd	315	"\nReceived DEVICE CHECK notification for device\n"));
1da177e4	316	if (acpi_memory_get_device(handle, &mem_device)) {
6468463a	317	printk(KERN_ERR PREFIX "Cannot find driver data\n");
b1f00de6	318	break;
1da177e4 LT	319	}
1da177e4 LT	320
b1f00de6 TK	321	if (acpi_memory_check_device(mem_device))
	322	break;
	323
	324	if (acpi_memory_enable_device(mem_device)) {
	325	printk(KERN_ERR PREFIX "Cannot enable memory device\n");
	326	break;
1da177e4	327	}
b1f00de6 TK	328
b1f00de6 TK	329	ost_code = ACPI_OST_SC_SUCCESS;
1da177e4	330	break;
b1f00de6	331
1da177e4 LT	332	case ACPI_NOTIFY_EJECT_REQUEST:
1da177e4 LT	333	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
4be44fcd	334	"\nReceived EJECT REQUEST notification for device\n"));
1da177e4 LT	335
1da177e4 LT	336	if (acpi_bus_get_device(handle, &device)) {
6468463a	337	printk(KERN_ERR PREFIX "Device doesn't exist\n");
1da177e4 LT	338	break;
	339	}
	340	mem_device = acpi_driver_data(device);
	341	if (!mem_device) {
6468463a	342	printk(KERN_ERR PREFIX "Driver Data is NULL\n");
1da177e4 LT	343	break;
	344	}
	345
315bbae9 WC	346	ej_event = kmalloc(sizeof(*ej_event), GFP_KERNEL);
	347	if (!ej_event) {
	348	pr_err(PREFIX "No memory, dropping EJECT\n");
b1f00de6 TK	349	break;
	350	}
	351
315bbae9 WC	352	ej_event->handle = handle;
	353	ej_event->event = ACPI_NOTIFY_EJECT_REQUEST;
	354	acpi_os_hotplug_execute(acpi_bus_hot_remove_device,
	355	(void *)ej_event);
b1f00de6	356
315bbae9	357	/* eject is performed asynchronously */
b1f00de6	358	return;
1da177e4 LT	359	default:
1da177e4 LT	360	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
4be44fcd	361	"Unsupported event [0x%x]\n", event));
b1f00de6 TK	362
	363	/* non-hotplug event; possibly handled by other handler */
	364	return;
1da177e4 LT	365	}
1da177e4 LT	366
b1f00de6 TK	367	/* Inform firmware that the hotplug operation has completed */
b1f00de6 TK	368	(void) acpi_evaluate_hotplug_ost(handle, event, ost_code, NULL);
d550d98d	369	return;
1da177e4 LT	370	}
1da177e4 LT	371
386e52b9 WC	372	static void acpi_memory_device_free(struct acpi_memory_device *mem_device)
	373	{
	374	if (!mem_device)
	375	return;
	376
	377	acpi_memory_free_device_resources(mem_device);
	378	kfree(mem_device);
	379	}
	380
4be44fcd	381	static int acpi_memory_device_add(struct acpi_device *device)
1da177e4 LT	382	{
	383	int result;
	384	struct acpi_memory_device *mem_device = NULL;
	385
1da177e4 LT	386
1da177e4 LT	387	if (!device)
d550d98d	388	return -EINVAL;
1da177e4	389
36bcbec7	390	mem_device = kzalloc(sizeof(struct acpi_memory_device), GFP_KERNEL);
1da177e4	391	if (!mem_device)
d550d98d	392	return -ENOMEM;
1da177e4	393
9ac02398	394	INIT_LIST_HEAD(&mem_device->res_list);
3b74863d	395	mem_device->device = device;
1da177e4 LT	396	sprintf(acpi_device_name(device), "%s", ACPI_MEMORY_DEVICE_NAME);
1da177e4 LT	397	sprintf(acpi_device_class(device), "%s", ACPI_MEMORY_DEVICE_CLASS);
db89b4f0	398	device->driver_data = mem_device;
1da177e4 LT	399
	400	/* Get the range from the _CRS */
	401	result = acpi_memory_get_device_resources(mem_device);
	402	if (result) {
	403	kfree(mem_device);
d550d98d	404	return result;
1da177e4 LT	405	}
	406
	407	/* Set the device state */
	408	mem_device->state = MEMORY_POWER_ON_STATE;
	409
6cbe44cd	410	printk(KERN_DEBUG "%s \n", acpi_device_name(device));
1da177e4	411
887b9593 YG	412	/*
	413	* Early boot code has recognized memory area by EFI/E820.
	414	* If DSDT shows these memory devices on boot, hotplug is not necessary
	415	* for them. So, it just returns until completion of this driver's
	416	* start up.
	417	*/
	418	if (!acpi_hotmem_initialized)
	419	return 0;
	420
1f425994 YG	421	if (!acpi_memory_check_device(mem_device)) {
	422	/* call add_memory func */
	423	result = acpi_memory_enable_device(mem_device);
e0b7b24d	424	if (result) {
55ac9a01 LM	425	printk(KERN_ERR PREFIX
55ac9a01 LM	426	"Error in acpi_memory_enable_device\n");
e0b7b24d WC	427	acpi_memory_device_free(mem_device);
e0b7b24d WC	428	}
1f425994	429	}
d120cfb5	430	return result;
1f425994 YG	431	}
1f425994 YG	432
80f20fef BH	433	static int acpi_memory_device_remove(struct acpi_device *device, int type)
	434	{
	435	struct acpi_memory_device *mem_device = NULL;
19387b27	436	int result;
80f20fef BH	437
	438	if (!device \|\| !acpi_driver_data(device))
	439	return -EINVAL;
	440
	441	mem_device = acpi_driver_data(device);
19387b27 YI	442
	443	result = acpi_memory_remove_memory(mem_device);
	444	if (result)
	445	return result;
	446
386e52b9	447	acpi_memory_device_free(mem_device);
80f20fef BH	448
	449	return 0;
	450	}
	451
1da177e4 LT	452	/*
	453	* Helper function to check for memory device
	454	*/
4be44fcd	455	static acpi_status is_memory_device(acpi_handle handle)
1da177e4 LT	456	{
	457	char *hardware_id;
	458	acpi_status status;
1da177e4 LT	459	struct acpi_device_info *info;
1da177e4 LT	460
15b8dd53	461	status = acpi_get_object_info(handle, &info);
1da177e4	462	if (ACPI_FAILURE(status))
d550d98d	463	return status;
1da177e4	464
1da177e4	465	if (!(info->valid & ACPI_VALID_HID)) {
15b8dd53	466	kfree(info);
d550d98d	467	return AE_ERROR;
1da177e4 LT	468	}
1da177e4 LT	469
15b8dd53	470	hardware_id = info->hardware_id.string;
1da177e4	471	if ((hardware_id == NULL) \|\|
4be44fcd	472	(strcmp(hardware_id, ACPI_MEMORY_DEVICE_HID)))
1da177e4 LT	473	status = AE_ERROR;
1da177e4 LT	474
15b8dd53	475	kfree(info);
d550d98d	476	return status;
1da177e4 LT	477	}
	478
	479	static acpi_status
4be44fcd LB	480	acpi_memory_register_notify_handler(acpi_handle handle,
4be44fcd LB	481	u32 level, void ctxt, void *retv)
1da177e4 LT	482	{
	483	acpi_status status;
	484
1da177e4 LT	485
1da177e4 LT	486	status = is_memory_device(handle);
07dd4855	487	if (ACPI_FAILURE(status))
d550d98d	488	return AE_OK; /* continue */
1da177e4 LT	489
1da177e4 LT	490	status = acpi_install_notify_handler(handle, ACPI_SYSTEM_NOTIFY,
4be44fcd	491	acpi_memory_device_notify, NULL);
a6fc6720	492	/* continue */
d550d98d	493	return AE_OK;
1da177e4 LT	494	}
	495
	496	static acpi_status
4be44fcd LB	497	acpi_memory_deregister_notify_handler(acpi_handle handle,
4be44fcd LB	498	u32 level, void ctxt, void *retv)
1da177e4 LT	499	{
	500	acpi_status status;
	501
1da177e4 LT	502
1da177e4 LT	503	status = is_memory_device(handle);
07dd4855	504	if (ACPI_FAILURE(status))
d550d98d	505	return AE_OK; /* continue */
1da177e4 LT	506
1da177e4 LT	507	status = acpi_remove_notify_handler(handle,
4be44fcd LB	508	ACPI_SYSTEM_NOTIFY,
4be44fcd LB	509	acpi_memory_device_notify);
1da177e4	510
d550d98d	511	return AE_OK; /* continue */
1da177e4 LT	512	}
1da177e4 LT	513
4be44fcd	514	static int __init acpi_memory_device_init(void)
1da177e4 LT	515	{
	516	int result;
	517	acpi_status status;
	518
1da177e4 LT	519
	520	result = acpi_bus_register_driver(&acpi_memory_device_driver);
	521
	522	if (result < 0)
d550d98d	523	return -ENODEV;
1da177e4 LT	524
1da177e4 LT	525	status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
4be44fcd	526	ACPI_UINT32_MAX,
2263576c	527	acpi_memory_register_notify_handler, NULL,
4be44fcd	528	NULL, NULL);
1da177e4	529
4be44fcd	530	if (ACPI_FAILURE(status)) {
a6fc6720	531	ACPI_EXCEPTION((AE_INFO, status, "walk_namespace failed"));
1da177e4	532	acpi_bus_unregister_driver(&acpi_memory_device_driver);
d550d98d	533	return -ENODEV;
4be44fcd	534	}
1da177e4	535
887b9593	536	acpi_hotmem_initialized = 1;
d550d98d	537	return 0;
1da177e4 LT	538	}
1da177e4 LT	539
4be44fcd	540	static void __exit acpi_memory_device_exit(void)
1da177e4 LT	541	{
	542	acpi_status status;
	543
1da177e4 LT	544
	545	/*
	546	* Adding this to un-install notification handlers for all the device
	547	* handles.
	548	*/
	549	status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
4be44fcd	550	ACPI_UINT32_MAX,
2263576c	551	acpi_memory_deregister_notify_handler, NULL,
4be44fcd	552	NULL, NULL);
1da177e4	553
4be44fcd	554	if (ACPI_FAILURE(status))
a6fc6720	555	ACPI_EXCEPTION((AE_INFO, status, "walk_namespace failed"));
1da177e4 LT	556
	557	acpi_bus_unregister_driver(&acpi_memory_device_driver);
	558
d550d98d	559	return;
1da177e4 LT	560	}
	561
	562	module_init(acpi_memory_device_init);
	563	module_exit(acpi_memory_device_exit);