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