drivers/acpi/container.c

   1 /*
   2  * acpi_container.c  - ACPI Generic Container Driver
   3  * ($Revision: )
   4  *
   5  * Copyright (C) 2004 Anil S Keshavamurthy (anil.s.keshavamurthy@intel.com)
   6  * Copyright (C) 2004 Keiichiro Tokunaga (tokunaga.keiich@jp.fujitsu.com)
   7  * Copyright (C) 2004 Motoyuki Ito (motoyuki@soft.fujitsu.com)
   8  * Copyright (C) 2004 Intel Corp.
   9  * Copyright (C) 2004 FUJITSU LIMITED
  10  *
  11  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  12  *
  13  *  This program is free software; you can redistribute it and/or modify
  14  *  it under the terms of the GNU General Public License as published by
  15  *  the Free Software Foundation; either version 2 of the License, or (at
  16  *  your option) any later version.
  17  *
  18  *  This program is distributed in the hope that it will be useful, but
  19  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  20  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21  *  General Public License for more details.
  22  *
  23  *  You should have received a copy of the GNU General Public License along
  24  *  with this program; if not, write to the Free Software Foundation, Inc.,
  25  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  26  *
  27  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  28  */
  29 #include <linux/kernel.h>
  30 #include <linux/module.h>
  31 #include <linux/init.h>
  32 #include <linux/types.h>
  33 #include <linux/acpi.h>
  34 #include <acpi/acpi_bus.h>
  35 #include <acpi/acpi_drivers.h>
  36 #include <acpi/container.h>
  37
  38 #define ACPI_CONTAINER_DEVICE_NAME      "ACPI container device"
  39 #define ACPI_CONTAINER_CLASS            "container"
  40
  41 #define INSTALL_NOTIFY_HANDLER          1
  42 #define UNINSTALL_NOTIFY_HANDLER        2
  43
  44 #define ACPI_CONTAINER_COMPONENT        0x01000000
  45 #define _COMPONENT                      ACPI_CONTAINER_COMPONENT
  46 ACPI_MODULE_NAME("container");
  47
  48 MODULE_AUTHOR("Anil S Keshavamurthy");
  49 MODULE_DESCRIPTION("ACPI container driver");
  50 MODULE_LICENSE("GPL");
  51
  52 static int acpi_container_add(struct acpi_device *device);
  53 static int acpi_container_remove(struct acpi_device *device, int type);
  54
  55 static struct acpi_driver acpi_container_driver = {
  56         .name = "container",
  57         .class = ACPI_CONTAINER_CLASS,
  58         .ids = "ACPI0004,PNP0A05,PNP0A06",
  59         .ops = {
  60                 .add = acpi_container_add,
  61                 .remove = acpi_container_remove,
  62                 },
  63 };
  64
  65 /*******************************************************************/
  66
  67 static int is_device_present(acpi_handle handle)
  68 {
  69         acpi_handle temp;
  70         acpi_status status;
  71         unsigned long sta;
  72
  73
  74         status = acpi_get_handle(handle, "_STA", &temp);
  75         if (ACPI_FAILURE(status))
  76                 return 1;       /* _STA not found, assume device present */
  77
  78         status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
  79         if (ACPI_FAILURE(status))
  80                 return 0;       /* Firmware error */
  81
  82         return ((sta & ACPI_STA_DEVICE_PRESENT) == ACPI_STA_DEVICE_PRESENT);
  83 }
  84
  85 /*******************************************************************/
  86 static int acpi_container_add(struct acpi_device *device)
  87 {
  88         struct acpi_container *container;
  89
  90
  91         if (!device) {
  92                 printk(KERN_ERR PREFIX "device is NULL\n");
  93                 return -EINVAL;
  94         }
  95
  96         container = kzalloc(sizeof(struct acpi_container), GFP_KERNEL);
  97         if (!container)
  98                 return -ENOMEM;
  99
 100         container->handle = device->handle;
 101         strcpy(acpi_device_name(device), ACPI_CONTAINER_DEVICE_NAME);
 102         strcpy(acpi_device_class(device), ACPI_CONTAINER_CLASS);
 103         acpi_driver_data(device) = container;
 104
 105         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device <%s> bid <%s>\n",
 106                           acpi_device_name(device), acpi_device_bid(device)));
 107
 108         return 0;
 109 }
 110
 111 static int acpi_container_remove(struct acpi_device *device, int type)
 112 {
 113         acpi_status status = AE_OK;
 114         struct acpi_container *pc = NULL;
 115
 116         pc = acpi_driver_data(device);
 117         kfree(pc);
 118         return status;
 119 }
 120
 121 static int container_device_add(struct acpi_device **device, acpi_handle handle)
 122 {
 123         acpi_handle phandle;
 124         struct acpi_device *pdev;
 125         int result;
 126
 127
 128         if (acpi_get_parent(handle, &phandle)) {
 129                 return -ENODEV;
 130         }
 131
 132         if (acpi_bus_get_device(phandle, &pdev)) {
 133                 return -ENODEV;
 134         }
 135
 136         if (acpi_bus_add(device, pdev, handle, ACPI_BUS_TYPE_DEVICE)) {
 137                 return -ENODEV;
 138         }
 139
 140         result = acpi_bus_start(*device);
 141
 142         return result;
 143 }
 144
 145 static void container_notify_cb(acpi_handle handle, u32 type, void *context)
 146 {
 147         struct acpi_device *device = NULL;
 148         int result;
 149         int present;
 150         acpi_status status;
 151
 152
 153         present = is_device_present(handle);
 154
 155         switch (type) {
 156         case ACPI_NOTIFY_BUS_CHECK:
 157                 /* Fall through */
 158         case ACPI_NOTIFY_DEVICE_CHECK:
 159                 printk("Container driver received %s event\n",
 160                        (type == ACPI_NOTIFY_BUS_CHECK) ?
 161                        "ACPI_NOTIFY_BUS_CHECK" : "ACPI_NOTIFY_DEVICE_CHECK");
 162                 status = acpi_bus_get_device(handle, &device);
 163                 if (present) {
 164                         if (ACPI_FAILURE(status) || !device) {
 165                                 result = container_device_add(&device, handle);
 166                                 if (!result)
 167                                         kobject_uevent(&device->dev.kobj,
 168                                                        KOBJ_ONLINE);
 169                                 else
 170                                         printk("Failed to add container\n");
 171                         }
 172                 } else {
 173                         if (ACPI_SUCCESS(status)) {
 174                                 /* device exist and this is a remove request */
 175                                 kobject_uevent(&device->dev.kobj, KOBJ_OFFLINE);
 176                         }
 177                 }
 178                 break;
 179         case ACPI_NOTIFY_EJECT_REQUEST:
 180                 if (!acpi_bus_get_device(handle, &device) && device) {
 181                         kobject_uevent(&device->dev.kobj, KOBJ_OFFLINE);
 182                 }
 183                 break;
 184         default:
 185                 break;
 186         }
 187         return;
 188 }
 189
 190 static acpi_status
 191 container_walk_namespace_cb(acpi_handle handle,
 192                             u32 lvl, void *context, void **rv)
 193 {
 194         char *hid = NULL;
 195         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
 196         struct acpi_device_info *info;
 197         acpi_status status;
 198         int *action = context;
 199
 200
 201         status = acpi_get_object_info(handle, &buffer);
 202         if (ACPI_FAILURE(status) || !buffer.pointer) {
 203                 return AE_OK;
 204         }
 205
 206         info = buffer.pointer;
 207         if (info->valid & ACPI_VALID_HID)
 208                 hid = info->hardware_id.value;
 209
 210         if (hid == NULL) {
 211                 goto end;
 212         }
 213
 214         if (strcmp(hid, "ACPI0004") && strcmp(hid, "PNP0A05") &&
 215             strcmp(hid, "PNP0A06")) {
 216                 goto end;
 217         }
 218
 219         switch (*action) {
 220         case INSTALL_NOTIFY_HANDLER:
 221                 acpi_install_notify_handler(handle,
 222                                             ACPI_SYSTEM_NOTIFY,
 223                                             container_notify_cb, NULL);
 224                 break;
 225         case UNINSTALL_NOTIFY_HANDLER:
 226                 acpi_remove_notify_handler(handle,
 227                                            ACPI_SYSTEM_NOTIFY,
 228                                            container_notify_cb);
 229                 break;
 230         default:
 231                 break;
 232         }
 233
 234       end:
 235         kfree(buffer.pointer);
 236
 237         return AE_OK;
 238 }
 239
 240 static int __init acpi_container_init(void)
 241 {
 242         int result = 0;
 243         int action = INSTALL_NOTIFY_HANDLER;
 244
 245         result = acpi_bus_register_driver(&acpi_container_driver);
 246         if (result < 0) {
 247                 return (result);
 248         }
 249
 250         /* register notify handler to every container device */
 251         acpi_walk_namespace(ACPI_TYPE_DEVICE,
 252                             ACPI_ROOT_OBJECT,
 253                             ACPI_UINT32_MAX,
 254                             container_walk_namespace_cb, &action, NULL);
 255
 256         return (0);
 257 }
 258
 259 static void __exit acpi_container_exit(void)
 260 {
 261         int action = UNINSTALL_NOTIFY_HANDLER;
 262
 263
 264         acpi_walk_namespace(ACPI_TYPE_DEVICE,
 265                             ACPI_ROOT_OBJECT,
 266                             ACPI_UINT32_MAX,
 267                             container_walk_namespace_cb, &action, NULL);
 268
 269         acpi_bus_unregister_driver(&acpi_container_driver);
 270
 271         return;
 272 }
 273
 274 module_init(acpi_container_init);
 275 module_exit(acpi_container_exit);