drivers/acpi/acpi_memhotplug.c

   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
  23  * This driver fields notifications from firmware for memory add
  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>
  33 #include <linux/slab.h>
  34 #include <linux/acpi.h>
  35 #include <acpi/acpi_drivers.h>
  36
  37 #define ACPI_MEMORY_DEVICE_CLASS                "memory"
  38 #define ACPI_MEMORY_DEVICE_HID                  "PNP0C80"
  39 #define ACPI_MEMORY_DEVICE_NAME                 "Hotplug Mem Device"
  40
  41 #define _COMPONENT              ACPI_MEMORY_DEVICE_COMPONENT
  42
  43 #undef PREFIX
  44 #define         PREFIX          "ACPI:memory_hp:"
  45
  46 ACPI_MODULE_NAME("acpi_memhotplug");
  47 MODULE_AUTHOR("Naveen B S <naveen.b.s@intel.com>");
  48 MODULE_DESCRIPTION("Hotplug Mem Driver");
  49 MODULE_LICENSE("GPL");
  50
  51 /* Memory Device States */
  52 #define MEMORY_INVALID_STATE    0
  53 #define MEMORY_POWER_ON_STATE   1
  54 #define MEMORY_POWER_OFF_STATE  2
  55
  56 static int acpi_memory_device_add(struct acpi_device *device);
  57 static int acpi_memory_device_remove(struct acpi_device *device, int type);
  58
  59 static const struct acpi_device_id memory_device_ids[] = {
  60         {ACPI_MEMORY_DEVICE_HID, 0},
  61         {"", 0},
  62 };
  63 MODULE_DEVICE_TABLE(acpi, memory_device_ids);
  64
  65 static struct acpi_driver acpi_memory_device_driver = {
  66         .name = "acpi_memhotplug",
  67         .class = ACPI_MEMORY_DEVICE_CLASS,
  68         .ids = memory_device_ids,
  69         .ops = {
  70                 .add = acpi_memory_device_add,
  71                 .remove = acpi_memory_device_remove,
  72                 },
  73 };
  74
  75 struct acpi_memory_info {
  76         struct list_head list;
  77         u64 start_addr;         /* Memory Range start physical addr */
  78         u64 length;             /* Memory Range length */
  79         unsigned short caching; /* memory cache attribute */
  80         unsigned short write_protect;   /* memory read/write attribute */
  81         unsigned int enabled:1;
  82         unsigned int failed:1;
  83 };
  84
  85 struct acpi_memory_device {
  86         struct acpi_device * device;
  87         unsigned int state;     /* State of the memory device */
  88         struct list_head res_list;
  89 };
  90
  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
 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
 138 static int
 139 acpi_memory_get_device_resources(struct acpi_memory_device *mem_device)
 140 {
 141         acpi_status status;
 142
 143         if (!list_empty(&mem_device->res_list))
 144                 return 0;
 145
 146         status = acpi_walk_resources(mem_device->device->handle, METHOD_NAME__CRS,
 147                                      acpi_memory_get_resource, mem_device);
 148         if (ACPI_FAILURE(status)) {
 149                 acpi_memory_free_device_resources(mem_device);
 150                 return -EINVAL;
 151         }
 152
 153         return 0;
 154 }
 155
 156 static int
 157 acpi_memory_get_device(acpi_handle handle,
 158                        struct acpi_memory_device **mem_device)
 159 {
 160         struct acpi_device *device = NULL;
 161         int result;
 162
 163         if (!acpi_bus_get_device(handle, &device) && device)
 164                 goto end;
 165
 166         /*
 167          * Now add the notified device.  This creates the acpi_device
 168          * and invokes .add function
 169          */
 170         result = acpi_bus_add(handle);
 171         if (result) {
 172                 acpi_handle_warn(handle, "Cannot add acpi bus\n");
 173                 return -EINVAL;
 174         }
 175         result = acpi_bus_get_device(handle, &device);
 176         if (result) {
 177                 acpi_handle_warn(handle, "Missing device object\n");
 178                 return -EINVAL;
 179         }
 180
 181       end:
 182         *mem_device = acpi_driver_data(device);
 183         if (!(*mem_device)) {
 184                 dev_err(&device->dev, "driver data not found\n");
 185                 return -ENODEV;
 186         }
 187
 188         return 0;
 189 }
 190
 191 static int acpi_memory_check_device(struct acpi_memory_device *mem_device)
 192 {
 193         unsigned long long current_status;
 194
 195         /* Get device present/absent information from the _STA */
 196         if (ACPI_FAILURE(acpi_evaluate_integer(mem_device->device->handle, "_STA",
 197                                                NULL, &current_status)))
 198                 return -ENODEV;
 199         /*
 200          * Check for device status. Device should be
 201          * present/enabled/functioning.
 202          */
 203         if (!((current_status & ACPI_STA_DEVICE_PRESENT)
 204               && (current_status & ACPI_STA_DEVICE_ENABLED)
 205               && (current_status & ACPI_STA_DEVICE_FUNCTIONING)))
 206                 return -ENODEV;
 207
 208         return 0;
 209 }
 210
 211 static int acpi_memory_enable_device(struct acpi_memory_device *mem_device)
 212 {
 213         int result, num_enabled = 0;
 214         struct acpi_memory_info *info;
 215         int node;
 216
 217
 218         /* Get the range from the _CRS */
 219         result = acpi_memory_get_device_resources(mem_device);
 220         if (result) {
 221                 dev_err(&mem_device->device->dev,
 222                         "get_device_resources failed\n");
 223                 mem_device->state = MEMORY_INVALID_STATE;
 224                 return result;
 225         }
 226
 227         node = acpi_get_node(mem_device->device->handle);
 228         /*
 229          * Tell the VM there is more memory here...
 230          * Note: Assume that this function returns zero on success
 231          * We don't have memory-hot-add rollback function,now.
 232          * (i.e. memory-hot-remove function)
 233          */
 234         list_for_each_entry(info, &mem_device->res_list, list) {
 235                 if (info->enabled) { /* just sanity check...*/
 236                         num_enabled++;
 237                         continue;
 238                 }
 239                 /*
 240                  * If the memory block size is zero, please ignore it.
 241                  * Don't try to do the following memory hotplug flowchart.
 242                  */
 243                 if (!info->length)
 244                         continue;
 245                 if (node < 0)
 246                         node = memory_add_physaddr_to_nid(info->start_addr);
 247
 248                 result = add_memory(node, info->start_addr, info->length);
 249
 250                 /*
 251                  * If the memory block has been used by the kernel, add_memory()
 252                  * returns -EEXIST. If add_memory() returns the other error, it
 253                  * means that this memory block is not used by the kernel.
 254                  */
 255                 if (result && result != -EEXIST) {
 256                         info->failed = 1;
 257                         continue;
 258                 }
 259
 260                 if (!result)
 261                         info->enabled = 1;
 262                 /*
 263                  * Add num_enable even if add_memory() returns -EEXIST, so the
 264                  * device is bound to this driver.
 265                  */
 266                 num_enabled++;
 267         }
 268         if (!num_enabled) {
 269                 dev_err(&mem_device->device->dev, "add_memory failed\n");
 270                 mem_device->state = MEMORY_INVALID_STATE;
 271                 return -EINVAL;
 272         }
 273         /*
 274          * Sometimes the memory device will contain several memory blocks.
 275          * When one memory block is hot-added to the system memory, it will
 276          * be regarded as a success.
 277          * Otherwise if the last memory block can't be hot-added to the system
 278          * memory, it will be failure and the memory device can't be bound with
 279          * driver.
 280          */
 281         return 0;
 282 }
 283
 284 static int acpi_memory_remove_memory(struct acpi_memory_device *mem_device)
 285 {
 286         int result = 0;
 287         struct acpi_memory_info *info, *n;
 288
 289         list_for_each_entry_safe(info, n, &mem_device->res_list, list) {
 290                 if (info->failed)
 291                         /* The kernel does not use this memory block */
 292                         continue;
 293
 294                 if (!info->enabled)
 295                         /*
 296                          * The kernel uses this memory block, but it may be not
 297                          * managed by us.
 298                          */
 299                         return -EBUSY;
 300
 301                 result = remove_memory(info->start_addr, info->length);
 302                 if (result)
 303                         return result;
 304
 305                 list_del(&info->list);
 306                 kfree(info);
 307         }
 308
 309         return result;
 310 }
 311
 312 static void acpi_memory_device_notify(acpi_handle handle, u32 event, void *data)
 313 {
 314         struct acpi_memory_device *mem_device;
 315         struct acpi_device *device;
 316         struct acpi_eject_event *ej_event = NULL;
 317         u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE; /* default */
 318
 319         switch (event) {
 320         case ACPI_NOTIFY_BUS_CHECK:
 321                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 322                                   "\nReceived BUS CHECK notification for device\n"));
 323                 /* Fall Through */
 324         case ACPI_NOTIFY_DEVICE_CHECK:
 325                 if (event == ACPI_NOTIFY_DEVICE_CHECK)
 326                         ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 327                                           "\nReceived DEVICE CHECK notification for device\n"));
 328                 if (acpi_memory_get_device(handle, &mem_device)) {
 329                         acpi_handle_err(handle, "Cannot find driver data\n");
 330                         break;
 331                 }
 332
 333                 if (acpi_memory_check_device(mem_device))
 334                         break;
 335
 336                 if (acpi_memory_enable_device(mem_device)) {
 337                         acpi_handle_err(handle,"Cannot enable memory device\n");
 338                         break;
 339                 }
 340
 341                 ost_code = ACPI_OST_SC_SUCCESS;
 342                 break;
 343
 344         case ACPI_NOTIFY_EJECT_REQUEST:
 345                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 346                                   "\nReceived EJECT REQUEST notification for device\n"));
 347
 348                 if (acpi_bus_get_device(handle, &device)) {
 349                         acpi_handle_err(handle, "Device doesn't exist\n");
 350                         break;
 351                 }
 352                 mem_device = acpi_driver_data(device);
 353                 if (!mem_device) {
 354                         acpi_handle_err(handle, "Driver Data is NULL\n");
 355                         break;
 356                 }
 357
 358                 ej_event = kmalloc(sizeof(*ej_event), GFP_KERNEL);
 359                 if (!ej_event) {
 360                         pr_err(PREFIX "No memory, dropping EJECT\n");
 361                         break;
 362                 }
 363
 364                 ej_event->device = device;
 365                 ej_event->event = ACPI_NOTIFY_EJECT_REQUEST;
 366                 acpi_os_hotplug_execute(acpi_bus_hot_remove_device,
 367                                         (void *)ej_event);
 368
 369                 /* eject is performed asynchronously */
 370                 return;
 371         default:
 372                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 373                                   "Unsupported event [0x%x]\n", event));
 374
 375                 /* non-hotplug event; possibly handled by other handler */
 376                 return;
 377         }
 378
 379         /* Inform firmware that the hotplug operation has completed */
 380         (void) acpi_evaluate_hotplug_ost(handle, event, ost_code, NULL);
 381         return;
 382 }
 383
 384 static void acpi_memory_device_free(struct acpi_memory_device *mem_device)
 385 {
 386         if (!mem_device)
 387                 return;
 388
 389         acpi_memory_free_device_resources(mem_device);
 390         kfree(mem_device);
 391 }
 392
 393 static int acpi_memory_device_add(struct acpi_device *device)
 394 {
 395         int result;
 396         struct acpi_memory_device *mem_device = NULL;
 397
 398
 399         if (!device)
 400                 return -EINVAL;
 401
 402         mem_device = kzalloc(sizeof(struct acpi_memory_device), GFP_KERNEL);
 403         if (!mem_device)
 404                 return -ENOMEM;
 405
 406         INIT_LIST_HEAD(&mem_device->res_list);
 407         mem_device->device = device;
 408         sprintf(acpi_device_name(device), "%s", ACPI_MEMORY_DEVICE_NAME);
 409         sprintf(acpi_device_class(device), "%s", ACPI_MEMORY_DEVICE_CLASS);
 410         device->driver_data = mem_device;
 411
 412         /* Get the range from the _CRS */
 413         result = acpi_memory_get_device_resources(mem_device);
 414         if (result) {
 415                 kfree(mem_device);
 416                 return result;
 417         }
 418
 419         /* Set the device state */
 420         mem_device->state = MEMORY_POWER_ON_STATE;
 421
 422         pr_debug("%s\n", acpi_device_name(device));
 423
 424         if (!acpi_memory_check_device(mem_device)) {
 425                 /* call add_memory func */
 426                 result = acpi_memory_enable_device(mem_device);
 427                 if (result) {
 428                         dev_err(&device->dev,
 429                                 "Error in acpi_memory_enable_device\n");
 430                         acpi_memory_device_free(mem_device);
 431                 }
 432         }
 433         return result;
 434 }
 435
 436 static int acpi_memory_device_remove(struct acpi_device *device, int type)
 437 {
 438         struct acpi_memory_device *mem_device = NULL;
 439         int result;
 440
 441         if (!device || !acpi_driver_data(device))
 442                 return -EINVAL;
 443
 444         mem_device = acpi_driver_data(device);
 445
 446         result = acpi_memory_remove_memory(mem_device);
 447         if (result)
 448                 return result;
 449
 450         acpi_memory_device_free(mem_device);
 451
 452         return 0;
 453 }
 454
 455 /*
 456  * Helper function to check for memory device
 457  */
 458 static acpi_status is_memory_device(acpi_handle handle)
 459 {
 460         char *hardware_id;
 461         acpi_status status;
 462         struct acpi_device_info *info;
 463
 464         status = acpi_get_object_info(handle, &info);
 465         if (ACPI_FAILURE(status))
 466                 return status;
 467
 468         if (!(info->valid & ACPI_VALID_HID)) {
 469                 kfree(info);
 470                 return AE_ERROR;
 471         }
 472
 473         hardware_id = info->hardware_id.string;
 474         if ((hardware_id == NULL) ||
 475             (strcmp(hardware_id, ACPI_MEMORY_DEVICE_HID)))
 476                 status = AE_ERROR;
 477
 478         kfree(info);
 479         return status;
 480 }
 481
 482 static acpi_status
 483 acpi_memory_register_notify_handler(acpi_handle handle,
 484                                     u32 level, void *ctxt, void **retv)
 485 {
 486         acpi_status status;
 487
 488
 489         status = is_memory_device(handle);
 490         if (ACPI_FAILURE(status))
 491                 return AE_OK;   /* continue */
 492
 493         status = acpi_install_notify_handler(handle, ACPI_SYSTEM_NOTIFY,
 494                                              acpi_memory_device_notify, NULL);
 495         /* continue */
 496         return AE_OK;
 497 }
 498
 499 static acpi_status
 500 acpi_memory_deregister_notify_handler(acpi_handle handle,
 501                                       u32 level, void *ctxt, void **retv)
 502 {
 503         acpi_status status;
 504
 505
 506         status = is_memory_device(handle);
 507         if (ACPI_FAILURE(status))
 508                 return AE_OK;   /* continue */
 509
 510         status = acpi_remove_notify_handler(handle,
 511                                             ACPI_SYSTEM_NOTIFY,
 512                                             acpi_memory_device_notify);
 513
 514         return AE_OK;   /* continue */
 515 }
 516
 517 static int __init acpi_memory_device_init(void)
 518 {
 519         int result;
 520         acpi_status status;
 521
 522
 523         result = acpi_bus_register_driver(&acpi_memory_device_driver);
 524
 525         if (result < 0)
 526                 return -ENODEV;
 527
 528         status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
 529                                      ACPI_UINT32_MAX,
 530                                      acpi_memory_register_notify_handler, NULL,
 531                                      NULL, NULL);
 532
 533         if (ACPI_FAILURE(status)) {
 534                 ACPI_EXCEPTION((AE_INFO, status, "walk_namespace failed"));
 535                 acpi_bus_unregister_driver(&acpi_memory_device_driver);
 536                 return -ENODEV;
 537         }
 538
 539         return 0;
 540 }
 541
 542 static void __exit acpi_memory_device_exit(void)
 543 {
 544         acpi_status status;
 545
 546
 547         /*
 548          * Adding this to un-install notification handlers for all the device
 549          * handles.
 550          */
 551         status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
 552                                      ACPI_UINT32_MAX,
 553                                      acpi_memory_deregister_notify_handler, NULL,
 554                                      NULL, NULL);
 555
 556         if (ACPI_FAILURE(status))
 557                 ACPI_EXCEPTION((AE_INFO, status, "walk_namespace failed"));
 558
 559         acpi_bus_unregister_driver(&acpi_memory_device_driver);
 560
 561         return;
 562 }
 563
 564 module_init(acpi_memory_device_init);
 565 module_exit(acpi_memory_device_exit);