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