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