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 #define ACPI_STA_PRESENT                (0x00000001)
  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 struct acpi_driver acpi_container_driver = {
  58         .name = "container",
  59         .class = ACPI_CONTAINER_CLASS,
  60         .ids = "ACPI0004,PNP0A05,PNP0A06",
  61         .ops = {
  62                 .add = acpi_container_add,
  63                 .remove = acpi_container_remove,
  64                 },
  65 };
  66
  67 /*******************************************************************/
  68
  69 static int is_device_present(acpi_handle handle)
  70 {
  71         acpi_handle temp;
  72         acpi_status status;
  73         unsigned long sta;
  74
  75
  76         status = acpi_get_handle(handle, "_STA", &temp);
  77         if (ACPI_FAILURE(status))
  78                 return 1;       /* _STA not found, assmue device present */
  79
  80         status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
  81         if (ACPI_FAILURE(status))
  82                 return 0;       /* Firmware error */
  83
  84         return ((sta & ACPI_STA_PRESENT) == ACPI_STA_PRESENT);
  85 }
  86
  87 /*******************************************************************/
  88 static int acpi_container_add(struct acpi_device *device)
  89 {
  90         struct acpi_container *container;
  91
  92
  93         if (!device) {
  94                 printk(KERN_ERR PREFIX "device is NULL\n");
  95                 return -EINVAL;
  96         }
  97
  98         container = kzalloc(sizeof(struct acpi_container), GFP_KERNEL);
  99         if (!container)
 100                 return -ENOMEM;
 101
 102         container->handle = device->handle;
 103         strcpy(acpi_device_name(device), ACPI_CONTAINER_DEVICE_NAME);
 104         strcpy(acpi_device_class(device), ACPI_CONTAINER_CLASS);
 105         acpi_driver_data(device) = container;
 106
 107         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device <%s> bid <%s>\n",
 108                           acpi_device_name(device), acpi_device_bid(device)));
 109
 110         return 0;
 111 }
 112
 113 static int acpi_container_remove(struct acpi_device *device, int type)
 114 {
 115         acpi_status status = AE_OK;
 116         struct acpi_container *pc = NULL;
 117
 118         pc = acpi_driver_data(device);
 119         kfree(pc);
 120         return status;
 121 }
 122
 123 static int container_device_add(struct acpi_device **device, acpi_handle handle)
 124 {
 125         acpi_handle phandle;
 126         struct acpi_device *pdev;
 127         int result;
 128
 129
 130         if (acpi_get_parent(handle, &phandle)) {
 131                 return -ENODEV;
 132         }
 133
 134         if (acpi_bus_get_device(phandle, &pdev)) {
 135                 return -ENODEV;
 136         }
 137
 138         if (acpi_bus_add(device, pdev, handle, ACPI_BUS_TYPE_DEVICE)) {
 139                 return -ENODEV;
 140         }
 141
 142         result = acpi_bus_start(*device);
 143
 144         return result;
 145 }
 146
 147 static void container_notify_cb(acpi_handle handle, u32 type, void *context)
 148 {
 149         struct acpi_device *device = NULL;
 150         int result;
 151         int present;
 152         acpi_status status;
 153
 154
 155         present = is_device_present(handle);
 156
 157         switch (type) {
 158         case ACPI_NOTIFY_BUS_CHECK:
 159                 /* Fall through */
 160         case ACPI_NOTIFY_DEVICE_CHECK:
 161                 printk("Container driver received %s event\n",
 162                        (type == ACPI_NOTIFY_BUS_CHECK) ?
 163                        "ACPI_NOTIFY_BUS_CHECK" : "ACPI_NOTIFY_DEVICE_CHECK");
 164                 status = acpi_bus_get_device(handle, &device);
 165                 if (present) {
 166                         if (ACPI_FAILURE(status) || !device) {
 167                                 result = container_device_add(&device, handle);
 168                                 if (!result)
 169                                         kobject_uevent(&device->dev.kobj,
 170                                                        KOBJ_ONLINE);
 171                                 else
 172                                         printk("Failed to add container\n");
 173                         }
 174                 } else {
 175                         if (ACPI_SUCCESS(status)) {
 176                                 /* device exist and this is a remove request */
 177                                 kobject_uevent(&device->dev.kobj, KOBJ_OFFLINE);
 178                         }
 179                 }
 180                 break;
 181         case ACPI_NOTIFY_EJECT_REQUEST:
 182                 if (!acpi_bus_get_device(handle, &device) && device) {
 183                         kobject_uevent(&device->dev.kobj, KOBJ_OFFLINE);
 184                 }
 185                 break;
 186         default:
 187                 break;
 188         }
 189         return;
 190 }
 191
 192 static acpi_status
 193 container_walk_namespace_cb(acpi_handle handle,
 194                             u32 lvl, void *context, void **rv)
 195 {
 196         char *hid = NULL;
 197         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
 198         struct acpi_device_info *info;
 199         acpi_status status;
 200         int *action = context;
 201
 202
 203         status = acpi_get_object_info(handle, &buffer);
 204         if (ACPI_FAILURE(status) || !buffer.pointer) {
 205                 return AE_OK;
 206         }
 207
 208         info = buffer.pointer;
 209         if (info->valid & ACPI_VALID_HID)
 210                 hid = info->hardware_id.value;
 211
 212         if (hid == NULL) {
 213                 goto end;
 214         }
 215
 216         if (strcmp(hid, "ACPI0004") && strcmp(hid, "PNP0A05") &&
 217             strcmp(hid, "PNP0A06")) {
 218                 goto end;
 219         }
 220
 221         switch (*action) {
 222         case INSTALL_NOTIFY_HANDLER:
 223                 acpi_install_notify_handler(handle,
 224                                             ACPI_SYSTEM_NOTIFY,
 225                                             container_notify_cb, NULL);
 226                 break;
 227         case UNINSTALL_NOTIFY_HANDLER:
 228                 acpi_remove_notify_handler(handle,
 229                                            ACPI_SYSTEM_NOTIFY,
 230                                            container_notify_cb);
 231                 break;
 232         default:
 233                 break;
 234         }
 235
 236       end:
 237         kfree(buffer.pointer);
 238
 239         return AE_OK;
 240 }
 241
 242 static int __init acpi_container_init(void)
 243 {
 244         int result = 0;
 245         int action = INSTALL_NOTIFY_HANDLER;
 246
 247         result = acpi_bus_register_driver(&acpi_container_driver);
 248         if (result < 0) {
 249                 return (result);
 250         }
 251
 252         /* register notify handler to every container device */
 253         acpi_walk_namespace(ACPI_TYPE_DEVICE,
 254                             ACPI_ROOT_OBJECT,
 255                             ACPI_UINT32_MAX,
 256                             container_walk_namespace_cb, &action, NULL);
 257
 258         return (0);
 259 }
 260
 261 static void __exit acpi_container_exit(void)
 262 {
 263         int action = UNINSTALL_NOTIFY_HANDLER;
 264
 265
 266         acpi_walk_namespace(ACPI_TYPE_DEVICE,
 267                             ACPI_ROOT_OBJECT,
 268                             ACPI_UINT32_MAX,
 269                             container_walk_namespace_cb, &action, NULL);
 270
 271         acpi_bus_unregister_driver(&acpi_container_driver);
 272
 273         return;
 274 }
 275
 276 module_init(acpi_container_init);
 277 module_exit(acpi_container_exit);