ACPI / scan: Remove unnecessary initialization of local variables
[linux-3.10.git] / drivers / acpi / dock.c
1 /*
2  *  dock.c - ACPI dock station driver
3  *
4  *  Copyright (C) 2006 Kristen Carlson Accardi <kristen.c.accardi@intel.com>
5  *
6  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or (at
11  *  your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful, but
14  *  WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  *  General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License along
19  *  with this program; if not, write to the Free Software Foundation, Inc.,
20  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
21  *
22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23  */
24
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/slab.h>
28 #include <linux/init.h>
29 #include <linux/types.h>
30 #include <linux/notifier.h>
31 #include <linux/platform_device.h>
32 #include <linux/jiffies.h>
33 #include <linux/stddef.h>
34 #include <linux/acpi.h>
35 #include <acpi/acpi_bus.h>
36 #include <acpi/acpi_drivers.h>
37
38 #define PREFIX "ACPI: "
39
40 #define ACPI_DOCK_DRIVER_DESCRIPTION "ACPI Dock Station Driver"
41
42 ACPI_MODULE_NAME("dock");
43 MODULE_AUTHOR("Kristen Carlson Accardi");
44 MODULE_DESCRIPTION(ACPI_DOCK_DRIVER_DESCRIPTION);
45 MODULE_LICENSE("GPL");
46
47 static bool immediate_undock = 1;
48 module_param(immediate_undock, bool, 0644);
49 MODULE_PARM_DESC(immediate_undock, "1 (default) will cause the driver to "
50         "undock immediately when the undock button is pressed, 0 will cause"
51         " the driver to wait for userspace to write the undock sysfs file "
52         " before undocking");
53
54 static struct atomic_notifier_head dock_notifier_list;
55
56 static const struct acpi_device_id dock_device_ids[] = {
57         {"LNXDOCK", 0},
58         {"", 0},
59 };
60 MODULE_DEVICE_TABLE(acpi, dock_device_ids);
61
62 struct dock_station {
63         acpi_handle handle;
64         unsigned long last_dock_time;
65         u32 flags;
66         spinlock_t dd_lock;
67         struct mutex hp_lock;
68         struct list_head dependent_devices;
69         struct list_head hotplug_devices;
70
71         struct list_head sibling;
72         struct platform_device *dock_device;
73 };
74 static LIST_HEAD(dock_stations);
75 static int dock_station_count;
76
77 struct dock_dependent_device {
78         struct list_head list;
79         struct list_head hotplug_list;
80         acpi_handle handle;
81         const struct acpi_dock_ops *ops;
82         void *context;
83 };
84
85 #define DOCK_DOCKING    0x00000001
86 #define DOCK_UNDOCKING  0x00000002
87 #define DOCK_IS_DOCK    0x00000010
88 #define DOCK_IS_ATA     0x00000020
89 #define DOCK_IS_BAT     0x00000040
90 #define DOCK_EVENT      3
91 #define UNDOCK_EVENT    2
92
93 /*****************************************************************************
94  *                         Dock Dependent device functions                   *
95  *****************************************************************************/
96 /**
97  * add_dock_dependent_device - associate a device with the dock station
98  * @ds: The dock station
99  * @handle: handle of the dependent device
100  *
101  * Add the dependent device to the dock's dependent device list.
102  */
103 static int
104 add_dock_dependent_device(struct dock_station *ds, acpi_handle handle)
105 {
106         struct dock_dependent_device *dd;
107
108         dd = kzalloc(sizeof(*dd), GFP_KERNEL);
109         if (!dd)
110                 return -ENOMEM;
111
112         dd->handle = handle;
113         INIT_LIST_HEAD(&dd->list);
114         INIT_LIST_HEAD(&dd->hotplug_list);
115
116         spin_lock(&ds->dd_lock);
117         list_add_tail(&dd->list, &ds->dependent_devices);
118         spin_unlock(&ds->dd_lock);
119
120         return 0;
121 }
122
123 /**
124  * dock_add_hotplug_device - associate a hotplug handler with the dock station
125  * @ds: The dock station
126  * @dd: The dependent device struct
127  *
128  * Add the dependent device to the dock's hotplug device list
129  */
130 static void
131 dock_add_hotplug_device(struct dock_station *ds,
132                         struct dock_dependent_device *dd)
133 {
134         mutex_lock(&ds->hp_lock);
135         list_add_tail(&dd->hotplug_list, &ds->hotplug_devices);
136         mutex_unlock(&ds->hp_lock);
137 }
138
139 /**
140  * dock_del_hotplug_device - remove a hotplug handler from the dock station
141  * @ds: The dock station
142  * @dd: the dependent device struct
143  *
144  * Delete the dependent device from the dock's hotplug device list
145  */
146 static void
147 dock_del_hotplug_device(struct dock_station *ds,
148                         struct dock_dependent_device *dd)
149 {
150         mutex_lock(&ds->hp_lock);
151         list_del(&dd->hotplug_list);
152         mutex_unlock(&ds->hp_lock);
153 }
154
155 /**
156  * find_dock_dependent_device - get a device dependent on this dock
157  * @ds: the dock station
158  * @handle: the acpi_handle of the device we want
159  *
160  * iterate over the dependent device list for this dock.  If the
161  * dependent device matches the handle, return.
162  */
163 static struct dock_dependent_device *
164 find_dock_dependent_device(struct dock_station *ds, acpi_handle handle)
165 {
166         struct dock_dependent_device *dd;
167
168         spin_lock(&ds->dd_lock);
169         list_for_each_entry(dd, &ds->dependent_devices, list) {
170                 if (handle == dd->handle) {
171                         spin_unlock(&ds->dd_lock);
172                         return dd;
173                 }
174         }
175         spin_unlock(&ds->dd_lock);
176         return NULL;
177 }
178
179 /*****************************************************************************
180  *                         Dock functions                                    *
181  *****************************************************************************/
182 /**
183  * is_dock - see if a device is a dock station
184  * @handle: acpi handle of the device
185  *
186  * If an acpi object has a _DCK method, then it is by definition a dock
187  * station, so return true.
188  */
189 static int is_dock(acpi_handle handle)
190 {
191         acpi_status status;
192         acpi_handle tmp;
193
194         status = acpi_get_handle(handle, "_DCK", &tmp);
195         if (ACPI_FAILURE(status))
196                 return 0;
197         return 1;
198 }
199
200 static int is_ejectable(acpi_handle handle)
201 {
202         acpi_status status;
203         acpi_handle tmp;
204
205         status = acpi_get_handle(handle, "_EJ0", &tmp);
206         if (ACPI_FAILURE(status))
207                 return 0;
208         return 1;
209 }
210
211 static int is_ata(acpi_handle handle)
212 {
213         acpi_handle tmp;
214
215         if ((ACPI_SUCCESS(acpi_get_handle(handle, "_GTF", &tmp))) ||
216            (ACPI_SUCCESS(acpi_get_handle(handle, "_GTM", &tmp))) ||
217            (ACPI_SUCCESS(acpi_get_handle(handle, "_STM", &tmp))) ||
218            (ACPI_SUCCESS(acpi_get_handle(handle, "_SDD", &tmp))))
219                 return 1;
220
221         return 0;
222 }
223
224 static int is_battery(acpi_handle handle)
225 {
226         struct acpi_device_info *info;
227         int ret = 1;
228
229         if (!ACPI_SUCCESS(acpi_get_object_info(handle, &info)))
230                 return 0;
231         if (!(info->valid & ACPI_VALID_HID))
232                 ret = 0;
233         else
234                 ret = !strcmp("PNP0C0A", info->hardware_id.string);
235
236         kfree(info);
237         return ret;
238 }
239
240 static int is_ejectable_bay(acpi_handle handle)
241 {
242         acpi_handle phandle;
243
244         if (!is_ejectable(handle))
245                 return 0;
246         if (is_battery(handle) || is_ata(handle))
247                 return 1;
248         if (!acpi_get_parent(handle, &phandle) && is_ata(phandle))
249                 return 1;
250         return 0;
251 }
252
253 /**
254  * is_dock_device - see if a device is on a dock station
255  * @handle: acpi handle of the device
256  *
257  * If this device is either the dock station itself,
258  * or is a device dependent on the dock station, then it
259  * is a dock device
260  */
261 int is_dock_device(acpi_handle handle)
262 {
263         struct dock_station *dock_station;
264
265         if (!dock_station_count)
266                 return 0;
267
268         if (is_dock(handle))
269                 return 1;
270
271         list_for_each_entry(dock_station, &dock_stations, sibling)
272                 if (find_dock_dependent_device(dock_station, handle))
273                         return 1;
274
275         return 0;
276 }
277 EXPORT_SYMBOL_GPL(is_dock_device);
278
279 /**
280  * dock_present - see if the dock station is present.
281  * @ds: the dock station
282  *
283  * execute the _STA method.  note that present does not
284  * imply that we are docked.
285  */
286 static int dock_present(struct dock_station *ds)
287 {
288         unsigned long long sta;
289         acpi_status status;
290
291         if (ds) {
292                 status = acpi_evaluate_integer(ds->handle, "_STA", NULL, &sta);
293                 if (ACPI_SUCCESS(status) && sta)
294                         return 1;
295         }
296         return 0;
297 }
298
299 /**
300  * dock_create_acpi_device - add new devices to acpi
301  * @handle - handle of the device to add
302  *
303  *  This function will create a new acpi_device for the given
304  *  handle if one does not exist already.  This should cause
305  *  acpi to scan for drivers for the given devices, and call
306  *  matching driver's add routine.
307  *
308  *  Returns a pointer to the acpi_device corresponding to the handle.
309  */
310 static struct acpi_device * dock_create_acpi_device(acpi_handle handle)
311 {
312         struct acpi_device *device;
313         int ret;
314
315         if (acpi_bus_get_device(handle, &device)) {
316                 /*
317                  * no device created for this object,
318                  * so we should create one.
319                  */
320                 ret = acpi_bus_add(handle);
321                 if (ret)
322                         pr_debug("error adding bus, %x\n", -ret);
323
324                 acpi_bus_get_device(handle, &device);
325         }
326         return device;
327 }
328
329 /**
330  * dock_remove_acpi_device - remove the acpi_device struct from acpi
331  * @handle - the handle of the device to remove
332  *
333  *  Tell acpi to remove the acpi_device.  This should cause any loaded
334  *  driver to have it's remove routine called.
335  */
336 static void dock_remove_acpi_device(acpi_handle handle)
337 {
338         struct acpi_device *device;
339         int ret;
340
341         if (!acpi_bus_get_device(handle, &device)) {
342                 ret = acpi_bus_trim(device);
343                 if (ret)
344                         pr_debug("error removing bus, %x\n", -ret);
345         }
346 }
347
348 /**
349  * hotplug_dock_devices - insert or remove devices on the dock station
350  * @ds: the dock station
351  * @event: either bus check or eject request
352  *
353  * Some devices on the dock station need to have drivers called
354  * to perform hotplug operations after a dock event has occurred.
355  * Traverse the list of dock devices that have registered a
356  * hotplug handler, and call the handler.
357  */
358 static void hotplug_dock_devices(struct dock_station *ds, u32 event)
359 {
360         struct dock_dependent_device *dd;
361
362         mutex_lock(&ds->hp_lock);
363
364         /*
365          * First call driver specific hotplug functions
366          */
367         list_for_each_entry(dd, &ds->hotplug_devices, hotplug_list)
368                 if (dd->ops && dd->ops->handler)
369                         dd->ops->handler(dd->handle, event, dd->context);
370
371         /*
372          * Now make sure that an acpi_device is created for each
373          * dependent device, or removed if this is an eject request.
374          * This will cause acpi_drivers to be stopped/started if they
375          * exist
376          */
377         list_for_each_entry(dd, &ds->dependent_devices, list) {
378                 if (event == ACPI_NOTIFY_EJECT_REQUEST)
379                         dock_remove_acpi_device(dd->handle);
380                 else
381                         dock_create_acpi_device(dd->handle);
382         }
383         mutex_unlock(&ds->hp_lock);
384 }
385
386 static void dock_event(struct dock_station *ds, u32 event, int num)
387 {
388         struct device *dev = &ds->dock_device->dev;
389         char event_string[13];
390         char *envp[] = { event_string, NULL };
391         struct dock_dependent_device *dd;
392
393         if (num == UNDOCK_EVENT)
394                 sprintf(event_string, "EVENT=undock");
395         else
396                 sprintf(event_string, "EVENT=dock");
397
398         /*
399          * Indicate that the status of the dock station has
400          * changed.
401          */
402         if (num == DOCK_EVENT)
403                 kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
404
405         list_for_each_entry(dd, &ds->hotplug_devices, hotplug_list)
406                 if (dd->ops && dd->ops->uevent)
407                         dd->ops->uevent(dd->handle, event, dd->context);
408
409         if (num != DOCK_EVENT)
410                 kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
411 }
412
413 /**
414  * eject_dock - respond to a dock eject request
415  * @ds: the dock station
416  *
417  * This is called after _DCK is called, to execute the dock station's
418  * _EJ0 method.
419  */
420 static void eject_dock(struct dock_station *ds)
421 {
422         struct acpi_object_list arg_list;
423         union acpi_object arg;
424         acpi_status status;
425         acpi_handle tmp;
426
427         /* all dock devices should have _EJ0, but check anyway */
428         status = acpi_get_handle(ds->handle, "_EJ0", &tmp);
429         if (ACPI_FAILURE(status)) {
430                 pr_debug("No _EJ0 support for dock device\n");
431                 return;
432         }
433
434         arg_list.count = 1;
435         arg_list.pointer = &arg;
436         arg.type = ACPI_TYPE_INTEGER;
437         arg.integer.value = 1;
438
439         status = acpi_evaluate_object(ds->handle, "_EJ0", &arg_list, NULL);
440         if (ACPI_FAILURE(status))
441                 pr_debug("Failed to evaluate _EJ0!\n");
442 }
443
444 /**
445  * handle_dock - handle a dock event
446  * @ds: the dock station
447  * @dock: to dock, or undock - that is the question
448  *
449  * Execute the _DCK method in response to an acpi event
450  */
451 static void handle_dock(struct dock_station *ds, int dock)
452 {
453         acpi_status status;
454         struct acpi_object_list arg_list;
455         union acpi_object arg;
456         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
457
458         acpi_handle_info(ds->handle, "%s\n", dock ? "docking" : "undocking");
459
460         /* _DCK method has one argument */
461         arg_list.count = 1;
462         arg_list.pointer = &arg;
463         arg.type = ACPI_TYPE_INTEGER;
464         arg.integer.value = dock;
465         status = acpi_evaluate_object(ds->handle, "_DCK", &arg_list, &buffer);
466         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND)
467                 acpi_handle_err(ds->handle, "Failed to execute _DCK (0x%x)\n",
468                                 status);
469
470         kfree(buffer.pointer);
471 }
472
473 static inline void dock(struct dock_station *ds)
474 {
475         handle_dock(ds, 1);
476 }
477
478 static inline void undock(struct dock_station *ds)
479 {
480         handle_dock(ds, 0);
481 }
482
483 static inline void begin_dock(struct dock_station *ds)
484 {
485         ds->flags |= DOCK_DOCKING;
486 }
487
488 static inline void complete_dock(struct dock_station *ds)
489 {
490         ds->flags &= ~(DOCK_DOCKING);
491         ds->last_dock_time = jiffies;
492 }
493
494 static inline void begin_undock(struct dock_station *ds)
495 {
496         ds->flags |= DOCK_UNDOCKING;
497 }
498
499 static inline void complete_undock(struct dock_station *ds)
500 {
501         ds->flags &= ~(DOCK_UNDOCKING);
502 }
503
504 static void dock_lock(struct dock_station *ds, int lock)
505 {
506         struct acpi_object_list arg_list;
507         union acpi_object arg;
508         acpi_status status;
509
510         arg_list.count = 1;
511         arg_list.pointer = &arg;
512         arg.type = ACPI_TYPE_INTEGER;
513         arg.integer.value = !!lock;
514         status = acpi_evaluate_object(ds->handle, "_LCK", &arg_list, NULL);
515         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
516                 if (lock)
517                         acpi_handle_warn(ds->handle,
518                                 "Locking device failed (0x%x)\n", status);
519                 else
520                         acpi_handle_warn(ds->handle,
521                                 "Unlocking device failed (0x%x)\n", status);
522         }
523 }
524
525 /**
526  * dock_in_progress - see if we are in the middle of handling a dock event
527  * @ds: the dock station
528  *
529  * Sometimes while docking, false dock events can be sent to the driver
530  * because good connections aren't made or some other reason.  Ignore these
531  * if we are in the middle of doing something.
532  */
533 static int dock_in_progress(struct dock_station *ds)
534 {
535         if ((ds->flags & DOCK_DOCKING) ||
536             time_before(jiffies, (ds->last_dock_time + HZ)))
537                 return 1;
538         return 0;
539 }
540
541 /**
542  * register_dock_notifier - add yourself to the dock notifier list
543  * @nb: the callers notifier block
544  *
545  * If a driver wishes to be notified about dock events, they can
546  * use this function to put a notifier block on the dock notifier list.
547  * this notifier call chain will be called after a dock event, but
548  * before hotplugging any new devices.
549  */
550 int register_dock_notifier(struct notifier_block *nb)
551 {
552         if (!dock_station_count)
553                 return -ENODEV;
554
555         return atomic_notifier_chain_register(&dock_notifier_list, nb);
556 }
557 EXPORT_SYMBOL_GPL(register_dock_notifier);
558
559 /**
560  * unregister_dock_notifier - remove yourself from the dock notifier list
561  * @nb: the callers notifier block
562  */
563 void unregister_dock_notifier(struct notifier_block *nb)
564 {
565         if (!dock_station_count)
566                 return;
567
568         atomic_notifier_chain_unregister(&dock_notifier_list, nb);
569 }
570 EXPORT_SYMBOL_GPL(unregister_dock_notifier);
571
572 /**
573  * register_hotplug_dock_device - register a hotplug function
574  * @handle: the handle of the device
575  * @ops: handlers to call after docking
576  * @context: device specific data
577  *
578  * If a driver would like to perform a hotplug operation after a dock
579  * event, they can register an acpi_notifiy_handler to be called by
580  * the dock driver after _DCK is executed.
581  */
582 int
583 register_hotplug_dock_device(acpi_handle handle, const struct acpi_dock_ops *ops,
584                              void *context)
585 {
586         struct dock_dependent_device *dd;
587         struct dock_station *dock_station;
588         int ret = -EINVAL;
589
590         if (!dock_station_count)
591                 return -ENODEV;
592
593         /*
594          * make sure this handle is for a device dependent on the dock,
595          * this would include the dock station itself
596          */
597         list_for_each_entry(dock_station, &dock_stations, sibling) {
598                 /*
599                  * An ATA bay can be in a dock and itself can be ejected
600                  * separately, so there are two 'dock stations' which need the
601                  * ops
602                  */
603                 dd = find_dock_dependent_device(dock_station, handle);
604                 if (dd) {
605                         dd->ops = ops;
606                         dd->context = context;
607                         dock_add_hotplug_device(dock_station, dd);
608                         ret = 0;
609                 }
610         }
611
612         return ret;
613 }
614 EXPORT_SYMBOL_GPL(register_hotplug_dock_device);
615
616 /**
617  * unregister_hotplug_dock_device - remove yourself from the hotplug list
618  * @handle: the acpi handle of the device
619  */
620 void unregister_hotplug_dock_device(acpi_handle handle)
621 {
622         struct dock_dependent_device *dd;
623         struct dock_station *dock_station;
624
625         if (!dock_station_count)
626                 return;
627
628         list_for_each_entry(dock_station, &dock_stations, sibling) {
629                 dd = find_dock_dependent_device(dock_station, handle);
630                 if (dd)
631                         dock_del_hotplug_device(dock_station, dd);
632         }
633 }
634 EXPORT_SYMBOL_GPL(unregister_hotplug_dock_device);
635
636 /**
637  * handle_eject_request - handle an undock request checking for error conditions
638  *
639  * Check to make sure the dock device is still present, then undock and
640  * hotremove all the devices that may need removing.
641  */
642 static int handle_eject_request(struct dock_station *ds, u32 event)
643 {
644         if (dock_in_progress(ds))
645                 return -EBUSY;
646
647         /*
648          * here we need to generate the undock
649          * event prior to actually doing the undock
650          * so that the device struct still exists.
651          * Also, even send the dock event if the
652          * device is not present anymore
653          */
654         dock_event(ds, event, UNDOCK_EVENT);
655
656         hotplug_dock_devices(ds, ACPI_NOTIFY_EJECT_REQUEST);
657         undock(ds);
658         dock_lock(ds, 0);
659         eject_dock(ds);
660         if (dock_present(ds)) {
661                 acpi_handle_err(ds->handle, "Unable to undock!\n");
662                 return -EBUSY;
663         }
664         complete_undock(ds);
665         return 0;
666 }
667
668 /**
669  * dock_notify - act upon an acpi dock notification
670  * @handle: the dock station handle
671  * @event: the acpi event
672  * @data: our driver data struct
673  *
674  * If we are notified to dock, then check to see if the dock is
675  * present and then dock.  Notify all drivers of the dock event,
676  * and then hotplug and devices that may need hotplugging.
677  */
678 static void dock_notify(acpi_handle handle, u32 event, void *data)
679 {
680         struct dock_station *ds = data;
681         struct acpi_device *tmp;
682         int surprise_removal = 0;
683
684         /*
685          * According to acpi spec 3.0a, if a DEVICE_CHECK notification
686          * is sent and _DCK is present, it is assumed to mean an undock
687          * request.
688          */
689         if ((ds->flags & DOCK_IS_DOCK) && event == ACPI_NOTIFY_DEVICE_CHECK)
690                 event = ACPI_NOTIFY_EJECT_REQUEST;
691
692         /*
693          * dock station: BUS_CHECK - docked or surprise removal
694          *               DEVICE_CHECK - undocked
695          * other device: BUS_CHECK/DEVICE_CHECK - added or surprise removal
696          *
697          * To simplify event handling, dock dependent device handler always
698          * get ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and
699          * ACPI_NOTIFY_EJECT_REQUEST for removal
700          */
701         switch (event) {
702         case ACPI_NOTIFY_BUS_CHECK:
703         case ACPI_NOTIFY_DEVICE_CHECK:
704                 if (!dock_in_progress(ds) && acpi_bus_get_device(ds->handle,
705                    &tmp)) {
706                         begin_dock(ds);
707                         dock(ds);
708                         if (!dock_present(ds)) {
709                                 acpi_handle_err(handle, "Unable to dock!\n");
710                                 complete_dock(ds);
711                                 break;
712                         }
713                         atomic_notifier_call_chain(&dock_notifier_list,
714                                                    event, NULL);
715                         hotplug_dock_devices(ds, event);
716                         complete_dock(ds);
717                         dock_event(ds, event, DOCK_EVENT);
718                         dock_lock(ds, 1);
719                         acpi_update_all_gpes();
720                         break;
721                 }
722                 if (dock_present(ds) || dock_in_progress(ds))
723                         break;
724                 /* This is a surprise removal */
725                 surprise_removal = 1;
726                 event = ACPI_NOTIFY_EJECT_REQUEST;
727                 /* Fall back */
728         case ACPI_NOTIFY_EJECT_REQUEST:
729                 begin_undock(ds);
730                 if ((immediate_undock && !(ds->flags & DOCK_IS_ATA))
731                    || surprise_removal)
732                         handle_eject_request(ds, event);
733                 else
734                         dock_event(ds, event, UNDOCK_EVENT);
735                 break;
736         default:
737                 acpi_handle_err(handle, "Unknown dock event %d\n", event);
738         }
739 }
740
741 struct dock_data {
742         acpi_handle handle;
743         unsigned long event;
744         struct dock_station *ds;
745 };
746
747 static void acpi_dock_deferred_cb(void *context)
748 {
749         struct dock_data *data = context;
750
751         dock_notify(data->handle, data->event, data->ds);
752         kfree(data);
753 }
754
755 static int acpi_dock_notifier_call(struct notifier_block *this,
756         unsigned long event, void *data)
757 {
758         struct dock_station *dock_station;
759         acpi_handle handle = data;
760
761         if (event != ACPI_NOTIFY_BUS_CHECK && event != ACPI_NOTIFY_DEVICE_CHECK
762            && event != ACPI_NOTIFY_EJECT_REQUEST)
763                 return 0;
764         list_for_each_entry(dock_station, &dock_stations, sibling) {
765                 if (dock_station->handle == handle) {
766                         struct dock_data *dd;
767
768                         dd = kmalloc(sizeof(*dd), GFP_KERNEL);
769                         if (!dd)
770                                 return 0;
771                         dd->handle = handle;
772                         dd->event = event;
773                         dd->ds = dock_station;
774                         acpi_os_hotplug_execute(acpi_dock_deferred_cb, dd);
775                         return 0 ;
776                 }
777         }
778         return 0;
779 }
780
781 static struct notifier_block dock_acpi_notifier = {
782         .notifier_call = acpi_dock_notifier_call,
783 };
784
785 /**
786  * find_dock_devices - find devices on the dock station
787  * @handle: the handle of the device we are examining
788  * @lvl: unused
789  * @context: the dock station private data
790  * @rv: unused
791  *
792  * This function is called by acpi_walk_namespace.  It will
793  * check to see if an object has an _EJD method.  If it does, then it
794  * will see if it is dependent on the dock station.
795  */
796 static acpi_status
797 find_dock_devices(acpi_handle handle, u32 lvl, void *context, void **rv)
798 {
799         acpi_status status;
800         acpi_handle tmp, parent;
801         struct dock_station *ds = context;
802
803         status = acpi_bus_get_ejd(handle, &tmp);
804         if (ACPI_FAILURE(status)) {
805                 /* try the parent device as well */
806                 status = acpi_get_parent(handle, &parent);
807                 if (ACPI_FAILURE(status))
808                         goto fdd_out;
809                 /* see if parent is dependent on dock */
810                 status = acpi_bus_get_ejd(parent, &tmp);
811                 if (ACPI_FAILURE(status))
812                         goto fdd_out;
813         }
814
815         if (tmp == ds->handle)
816                 add_dock_dependent_device(ds, handle);
817
818 fdd_out:
819         return AE_OK;
820 }
821
822 /*
823  * show_docked - read method for "docked" file in sysfs
824  */
825 static ssize_t show_docked(struct device *dev,
826                            struct device_attribute *attr, char *buf)
827 {
828         struct acpi_device *tmp;
829
830         struct dock_station *dock_station = dev->platform_data;
831
832         if (ACPI_SUCCESS(acpi_bus_get_device(dock_station->handle, &tmp)))
833                 return snprintf(buf, PAGE_SIZE, "1\n");
834         return snprintf(buf, PAGE_SIZE, "0\n");
835 }
836 static DEVICE_ATTR(docked, S_IRUGO, show_docked, NULL);
837
838 /*
839  * show_flags - read method for flags file in sysfs
840  */
841 static ssize_t show_flags(struct device *dev,
842                           struct device_attribute *attr, char *buf)
843 {
844         struct dock_station *dock_station = dev->platform_data;
845         return snprintf(buf, PAGE_SIZE, "%d\n", dock_station->flags);
846
847 }
848 static DEVICE_ATTR(flags, S_IRUGO, show_flags, NULL);
849
850 /*
851  * write_undock - write method for "undock" file in sysfs
852  */
853 static ssize_t write_undock(struct device *dev, struct device_attribute *attr,
854                            const char *buf, size_t count)
855 {
856         int ret;
857         struct dock_station *dock_station = dev->platform_data;
858
859         if (!count)
860                 return -EINVAL;
861
862         begin_undock(dock_station);
863         ret = handle_eject_request(dock_station, ACPI_NOTIFY_EJECT_REQUEST);
864         return ret ? ret: count;
865 }
866 static DEVICE_ATTR(undock, S_IWUSR, NULL, write_undock);
867
868 /*
869  * show_dock_uid - read method for "uid" file in sysfs
870  */
871 static ssize_t show_dock_uid(struct device *dev,
872                              struct device_attribute *attr, char *buf)
873 {
874         unsigned long long lbuf;
875         struct dock_station *dock_station = dev->platform_data;
876         acpi_status status = acpi_evaluate_integer(dock_station->handle,
877                                         "_UID", NULL, &lbuf);
878         if (ACPI_FAILURE(status))
879             return 0;
880
881         return snprintf(buf, PAGE_SIZE, "%llx\n", lbuf);
882 }
883 static DEVICE_ATTR(uid, S_IRUGO, show_dock_uid, NULL);
884
885 static ssize_t show_dock_type(struct device *dev,
886                 struct device_attribute *attr, char *buf)
887 {
888         struct dock_station *dock_station = dev->platform_data;
889         char *type;
890
891         if (dock_station->flags & DOCK_IS_DOCK)
892                 type = "dock_station";
893         else if (dock_station->flags & DOCK_IS_ATA)
894                 type = "ata_bay";
895         else if (dock_station->flags & DOCK_IS_BAT)
896                 type = "battery_bay";
897         else
898                 type = "unknown";
899
900         return snprintf(buf, PAGE_SIZE, "%s\n", type);
901 }
902 static DEVICE_ATTR(type, S_IRUGO, show_dock_type, NULL);
903
904 static struct attribute *dock_attributes[] = {
905         &dev_attr_docked.attr,
906         &dev_attr_flags.attr,
907         &dev_attr_undock.attr,
908         &dev_attr_uid.attr,
909         &dev_attr_type.attr,
910         NULL
911 };
912
913 static struct attribute_group dock_attribute_group = {
914         .attrs = dock_attributes
915 };
916
917 /**
918  * dock_add - add a new dock station
919  * @handle: the dock station handle
920  *
921  * allocated and initialize a new dock station device.  Find all devices
922  * that are on the dock station, and register for dock event notifications.
923  */
924 static int __init dock_add(acpi_handle handle)
925 {
926         int ret, id;
927         struct dock_station ds, *dock_station;
928         struct platform_device *dd;
929
930         id = dock_station_count;
931         memset(&ds, 0, sizeof(ds));
932         dd = platform_device_register_data(NULL, "dock", id, &ds, sizeof(ds));
933         if (IS_ERR(dd))
934                 return PTR_ERR(dd);
935
936         dock_station = dd->dev.platform_data;
937
938         dock_station->handle = handle;
939         dock_station->dock_device = dd;
940         dock_station->last_dock_time = jiffies - HZ;
941
942         mutex_init(&dock_station->hp_lock);
943         spin_lock_init(&dock_station->dd_lock);
944         INIT_LIST_HEAD(&dock_station->sibling);
945         INIT_LIST_HEAD(&dock_station->hotplug_devices);
946         ATOMIC_INIT_NOTIFIER_HEAD(&dock_notifier_list);
947         INIT_LIST_HEAD(&dock_station->dependent_devices);
948
949         /* we want the dock device to send uevents */
950         dev_set_uevent_suppress(&dd->dev, 0);
951
952         if (is_dock(handle))
953                 dock_station->flags |= DOCK_IS_DOCK;
954         if (is_ata(handle))
955                 dock_station->flags |= DOCK_IS_ATA;
956         if (is_battery(handle))
957                 dock_station->flags |= DOCK_IS_BAT;
958
959         ret = sysfs_create_group(&dd->dev.kobj, &dock_attribute_group);
960         if (ret)
961                 goto err_unregister;
962
963         /* Find dependent devices */
964         acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
965                             ACPI_UINT32_MAX, find_dock_devices, NULL,
966                             dock_station, NULL);
967
968         /* add the dock station as a device dependent on itself */
969         ret = add_dock_dependent_device(dock_station, handle);
970         if (ret)
971                 goto err_rmgroup;
972
973         dock_station_count++;
974         list_add(&dock_station->sibling, &dock_stations);
975         return 0;
976
977 err_rmgroup:
978         sysfs_remove_group(&dd->dev.kobj, &dock_attribute_group);
979 err_unregister:
980         platform_device_unregister(dd);
981         acpi_handle_err(handle, "%s encountered error %d\n", __func__, ret);
982         return ret;
983 }
984
985 /**
986  * dock_remove - free up resources related to the dock station
987  */
988 static int dock_remove(struct dock_station *ds)
989 {
990         struct dock_dependent_device *dd, *tmp;
991         struct platform_device *dock_device = ds->dock_device;
992
993         if (!dock_station_count)
994                 return 0;
995
996         /* remove dependent devices */
997         list_for_each_entry_safe(dd, tmp, &ds->dependent_devices, list)
998                 kfree(dd);
999
1000         list_del(&ds->sibling);
1001
1002         /* cleanup sysfs */
1003         sysfs_remove_group(&dock_device->dev.kobj, &dock_attribute_group);
1004         platform_device_unregister(dock_device);
1005
1006         return 0;
1007 }
1008
1009 /**
1010  * find_dock_and_bay - look for dock stations and bays
1011  * @handle: acpi handle of a device
1012  * @lvl: unused
1013  * @context: unused
1014  * @rv: unused
1015  *
1016  * This is called by acpi_walk_namespace to look for dock stations and bays.
1017  */
1018 static __init acpi_status
1019 find_dock_and_bay(acpi_handle handle, u32 lvl, void *context, void **rv)
1020 {
1021         if (is_dock(handle) || is_ejectable_bay(handle))
1022                 dock_add(handle);
1023
1024         return AE_OK;
1025 }
1026
1027 static int __init dock_init(void)
1028 {
1029         if (acpi_disabled)
1030                 return 0;
1031
1032         /* look for dock stations and bays */
1033         acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
1034                 ACPI_UINT32_MAX, find_dock_and_bay, NULL, NULL, NULL);
1035
1036         if (!dock_station_count) {
1037                 pr_info(PREFIX "No dock devices found.\n");
1038                 return 0;
1039         }
1040
1041         register_acpi_bus_notifier(&dock_acpi_notifier);
1042         pr_info(PREFIX "%s: %d docks/bays found\n",
1043                 ACPI_DOCK_DRIVER_DESCRIPTION, dock_station_count);
1044         return 0;
1045 }
1046
1047 static void __exit dock_exit(void)
1048 {
1049         struct dock_station *tmp, *dock_station;
1050
1051         unregister_acpi_bus_notifier(&dock_acpi_notifier);
1052         list_for_each_entry_safe(dock_station, tmp, &dock_stations, sibling)
1053                 dock_remove(dock_station);
1054 }
1055
1056 /*
1057  * Must be called before drivers of devices in dock, otherwise we can't know
1058  * which devices are in a dock
1059  */
1060 subsys_initcall(dock_init);
1061 module_exit(dock_exit);