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/slab.h>
  33 #include <linux/types.h>
  34 #include <linux/acpi.h>
  35 #include <acpi/acpi_bus.h>
  36 #include <acpi/acpi_drivers.h>
  37 #include <acpi/container.h>
  38
  39 #define PREFIX "ACPI: "
  40
  41 #define ACPI_CONTAINER_DEVICE_NAME      "ACPI container device"
  42 #define ACPI_CONTAINER_CLASS            "container"
  43
  44 #define INSTALL_NOTIFY_HANDLER          1
  45 #define UNINSTALL_NOTIFY_HANDLER        2
  46
  47 #define _COMPONENT                      ACPI_CONTAINER_COMPONENT
  48 ACPI_MODULE_NAME("container");
  49
  50 MODULE_AUTHOR("Anil S Keshavamurthy");
  51 MODULE_DESCRIPTION("ACPI container driver");
  52 MODULE_LICENSE("GPL");
  53
  54 static int acpi_container_add(struct acpi_device *device);
  55 static int acpi_container_remove(struct acpi_device *device, int type);
  56
  57 static const struct acpi_device_id container_device_ids[] = {
  58         {"ACPI0004", 0},
  59         {"PNP0A05", 0},
  60         {"PNP0A06", 0},
  61         {"", 0},
  62 };
  63 MODULE_DEVICE_TABLE(acpi, container_device_ids);
  64
  65 static struct acpi_driver acpi_container_driver = {
  66         .name = "container",
  67         .class = ACPI_CONTAINER_CLASS,
  68         .ids = container_device_ids,
  69         .ops = {
  70                 .add = acpi_container_add,
  71                 .remove = acpi_container_remove,
  72                 },
  73 };
  74
  75 /*******************************************************************/
  76
  77 static int is_device_present(acpi_handle handle)
  78 {
  79         acpi_handle temp;
  80         acpi_status status;
  81         unsigned long long sta;
  82
  83
  84         status = acpi_get_handle(handle, "_STA", &temp);
  85         if (ACPI_FAILURE(status))
  86                 return 1;       /* _STA not found, assume device present */
  87
  88         status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
  89         if (ACPI_FAILURE(status))
  90                 return 0;       /* Firmware error */
  91
  92         return ((sta & ACPI_STA_DEVICE_PRESENT) == ACPI_STA_DEVICE_PRESENT);
  93 }
  94
  95 /*******************************************************************/
  96 static int acpi_container_add(struct acpi_device *device)
  97 {
  98         struct acpi_container *container;
  99
 100
 101         if (!device) {
 102                 printk(KERN_ERR PREFIX "device is NULL\n");
 103                 return -EINVAL;
 104         }
 105
 106         container = kzalloc(sizeof(struct acpi_container), GFP_KERNEL);
 107         if (!container)
 108                 return -ENOMEM;
 109
 110         container->handle = device->handle;
 111         strcpy(acpi_device_name(device), ACPI_CONTAINER_DEVICE_NAME);
 112         strcpy(acpi_device_class(device), ACPI_CONTAINER_CLASS);
 113         device->driver_data = container;
 114
 115         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device <%s> bid <%s>\n",
 116                           acpi_device_name(device), acpi_device_bid(device)));
 117
 118         return 0;
 119 }
 120
 121 static int acpi_container_remove(struct acpi_device *device, int type)
 122 {
 123         acpi_status status = AE_OK;
 124         struct acpi_container *pc = NULL;
 125
 126         pc = acpi_driver_data(device);
 127         kfree(pc);
 128         return status;
 129 }
 130
 131 static int container_device_add(struct acpi_device **device, acpi_handle handle)
 132 {
 133         acpi_handle phandle;
 134         struct acpi_device *pdev;
 135         int result;
 136
 137
 138         if (acpi_get_parent(handle, &phandle)) {
 139                 return -ENODEV;
 140         }
 141
 142         if (acpi_bus_get_device(phandle, &pdev)) {
 143                 return -ENODEV;
 144         }
 145
 146         if (acpi_bus_add(device, pdev, handle, ACPI_BUS_TYPE_DEVICE)) {
 147                 return -ENODEV;
 148         }
 149
 150         result = acpi_bus_start(*device);
 151
 152         return result;
 153 }
 154
 155 static void container_notify_cb(acpi_handle handle, u32 type, void *context)
 156 {
 157         struct acpi_device *device = NULL;
 158         int result;
 159         int present;
 160         acpi_status status;
 161         u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE; /* default */
 162
 163         switch (type) {
 164         case ACPI_NOTIFY_BUS_CHECK:
 165                 /* Fall through */
 166         case ACPI_NOTIFY_DEVICE_CHECK:
 167                 printk(KERN_WARNING "Container driver received %s event\n",
 168                        (type == ACPI_NOTIFY_BUS_CHECK) ?
 169                        "ACPI_NOTIFY_BUS_CHECK" : "ACPI_NOTIFY_DEVICE_CHECK");
 170
 171                 present = is_device_present(handle);
 172                 status = acpi_bus_get_device(handle, &device);
 173                 if (!present) {
 174                         if (ACPI_SUCCESS(status)) {
 175                                 /* device exist and this is a remove request */
 176                                 device->flags.eject_pending = 1;
 177                                 kobject_uevent(&device->dev.kobj, KOBJ_OFFLINE);
 178                                 return;
 179                         }
 180                         break;
 181                 }
 182
 183                 if (!ACPI_FAILURE(status) || device)
 184                         break;
 185
 186                 result = container_device_add(&device, handle);
 187                 if (result) {
 188                         printk(KERN_WARNING "Failed to add container\n");
 189                         break;
 190                 }
 191
 192                 kobject_uevent(&device->dev.kobj, KOBJ_ONLINE);
 193                 ost_code = ACPI_OST_SC_SUCCESS;
 194                 break;
 195
 196         case ACPI_NOTIFY_EJECT_REQUEST:
 197                 if (!acpi_bus_get_device(handle, &device) && device) {
 198                         device->flags.eject_pending = 1;
 199                         kobject_uevent(&device->dev.kobj, KOBJ_OFFLINE);
 200                         return;
 201                 }
 202                 break;
 203
 204         default:
 205                 /* non-hotplug event; possibly handled by other handler */
 206                 return;
 207         }
 208
 209         /* Inform firmware that the hotplug operation has completed */
 210         (void) acpi_evaluate_hotplug_ost(handle, type, ost_code, NULL);
 211         return;
 212 }
 213
 214 static acpi_status
 215 container_walk_namespace_cb(acpi_handle handle,
 216                             u32 lvl, void *context, void **rv)
 217 {
 218         char *hid = NULL;
 219         struct acpi_device_info *info;
 220         acpi_status status;
 221         int *action = context;
 222
 223         status = acpi_get_object_info(handle, &info);
 224         if (ACPI_FAILURE(status)) {
 225                 return AE_OK;
 226         }
 227
 228         if (info->valid & ACPI_VALID_HID)
 229                 hid = info->hardware_id.string;
 230
 231         if (hid == NULL) {
 232                 goto end;
 233         }
 234
 235         if (strcmp(hid, "ACPI0004") && strcmp(hid, "PNP0A05") &&
 236             strcmp(hid, "PNP0A06")) {
 237                 goto end;
 238         }
 239
 240         switch (*action) {
 241         case INSTALL_NOTIFY_HANDLER:
 242                 acpi_install_notify_handler(handle,
 243                                             ACPI_SYSTEM_NOTIFY,
 244                                             container_notify_cb, NULL);
 245                 break;
 246         case UNINSTALL_NOTIFY_HANDLER:
 247                 acpi_remove_notify_handler(handle,
 248                                            ACPI_SYSTEM_NOTIFY,
 249                                            container_notify_cb);
 250                 break;
 251         default:
 252                 break;
 253         }
 254
 255       end:
 256         kfree(info);
 257
 258         return AE_OK;
 259 }
 260
 261 static int __init acpi_container_init(void)
 262 {
 263         int result = 0;
 264         int action = INSTALL_NOTIFY_HANDLER;
 265
 266         result = acpi_bus_register_driver(&acpi_container_driver);
 267         if (result < 0) {
 268                 return (result);
 269         }
 270
 271         /* register notify handler to every container device */
 272         acpi_walk_namespace(ACPI_TYPE_DEVICE,
 273                             ACPI_ROOT_OBJECT,
 274                             ACPI_UINT32_MAX,
 275                             container_walk_namespace_cb, NULL, &action, NULL);
 276
 277         return (0);
 278 }
 279
 280 static void __exit acpi_container_exit(void)
 281 {
 282         int action = UNINSTALL_NOTIFY_HANDLER;
 283
 284
 285         acpi_walk_namespace(ACPI_TYPE_DEVICE,
 286                             ACPI_ROOT_OBJECT,
 287                             ACPI_UINT32_MAX,
 288                             container_walk_namespace_cb, NULL, &action, NULL);
 289
 290         acpi_bus_unregister_driver(&acpi_container_driver);
 291
 292         return;
 293 }
 294
 295 module_init(acpi_container_init);
 296 module_exit(acpi_container_exit);