ACPI: dock: avoid check _STA method
[linux-2.6] / 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/init.h>
28 #include <linux/types.h>
29 #include <linux/notifier.h>
30 #include <linux/platform_device.h>
31 #include <linux/jiffies.h>
32 #include <linux/stddef.h>
33 #include <acpi/acpi_bus.h>
34 #include <acpi/acpi_drivers.h>
35
36 #define ACPI_DOCK_DRIVER_DESCRIPTION "ACPI Dock Station Driver"
37
38 ACPI_MODULE_NAME("dock");
39 MODULE_AUTHOR("Kristen Carlson Accardi");
40 MODULE_DESCRIPTION(ACPI_DOCK_DRIVER_DESCRIPTION);
41 MODULE_LICENSE("GPL");
42
43 static int immediate_undock = 1;
44 module_param(immediate_undock, bool, 0644);
45 MODULE_PARM_DESC(immediate_undock, "1 (default) will cause the driver to "
46         "undock immediately when the undock button is pressed, 0 will cause"
47         " the driver to wait for userspace to write the undock sysfs file "
48         " before undocking");
49
50 static struct atomic_notifier_head dock_notifier_list;
51 static struct platform_device *dock_device;
52 static char dock_device_name[] = "dock";
53
54 static const struct acpi_device_id dock_device_ids[] = {
55         {"LNXDOCK", 0},
56         {"", 0},
57 };
58 MODULE_DEVICE_TABLE(acpi, dock_device_ids);
59
60 struct dock_station {
61         acpi_handle handle;
62         unsigned long last_dock_time;
63         u32 flags;
64         spinlock_t dd_lock;
65         struct mutex hp_lock;
66         struct list_head dependent_devices;
67         struct list_head hotplug_devices;
68 };
69
70 struct dock_dependent_device {
71         struct list_head list;
72         struct list_head hotplug_list;
73         acpi_handle handle;
74         acpi_notify_handler handler;
75         void *context;
76 };
77
78 #define DOCK_DOCKING    0x00000001
79 #define DOCK_UNDOCKING  0x00000002
80 #define DOCK_EVENT      3
81 #define UNDOCK_EVENT    2
82
83 static struct dock_station *dock_station;
84
85 /*****************************************************************************
86  *                         Dock Dependent device functions                   *
87  *****************************************************************************/
88 /**
89  *  alloc_dock_dependent_device - allocate and init a dependent device
90  *  @handle: the acpi_handle of the dependent device
91  *
92  *  Allocate memory for a dependent device structure for a device referenced
93  *  by the acpi handle
94  */
95 static struct dock_dependent_device *
96 alloc_dock_dependent_device(acpi_handle handle)
97 {
98         struct dock_dependent_device *dd;
99
100         dd = kzalloc(sizeof(*dd), GFP_KERNEL);
101         if (dd) {
102                 dd->handle = handle;
103                 INIT_LIST_HEAD(&dd->list);
104                 INIT_LIST_HEAD(&dd->hotplug_list);
105         }
106         return dd;
107 }
108
109 /**
110  * add_dock_dependent_device - associate a device with the dock station
111  * @ds: The dock station
112  * @dd: The dependent device
113  *
114  * Add the dependent device to the dock's dependent device list.
115  */
116 static void
117 add_dock_dependent_device(struct dock_station *ds,
118                           struct dock_dependent_device *dd)
119 {
120         spin_lock(&ds->dd_lock);
121         list_add_tail(&dd->list, &ds->dependent_devices);
122         spin_unlock(&ds->dd_lock);
123 }
124
125 /**
126  * dock_add_hotplug_device - associate a hotplug handler with the dock station
127  * @ds: The dock station
128  * @dd: The dependent device struct
129  *
130  * Add the dependent device to the dock's hotplug device list
131  */
132 static void
133 dock_add_hotplug_device(struct dock_station *ds,
134                         struct dock_dependent_device *dd)
135 {
136         mutex_lock(&ds->hp_lock);
137         list_add_tail(&dd->hotplug_list, &ds->hotplug_devices);
138         mutex_unlock(&ds->hp_lock);
139 }
140
141 /**
142  * dock_del_hotplug_device - remove a hotplug handler from the dock station
143  * @ds: The dock station
144  * @dd: the dependent device struct
145  *
146  * Delete the dependent device from the dock's hotplug device list
147  */
148 static void
149 dock_del_hotplug_device(struct dock_station *ds,
150                         struct dock_dependent_device *dd)
151 {
152         mutex_lock(&ds->hp_lock);
153         list_del(&dd->hotplug_list);
154         mutex_unlock(&ds->hp_lock);
155 }
156
157 /**
158  * find_dock_dependent_device - get a device dependent on this dock
159  * @ds: the dock station
160  * @handle: the acpi_handle of the device we want
161  *
162  * iterate over the dependent device list for this dock.  If the
163  * dependent device matches the handle, return.
164  */
165 static struct dock_dependent_device *
166 find_dock_dependent_device(struct dock_station *ds, acpi_handle handle)
167 {
168         struct dock_dependent_device *dd;
169
170         spin_lock(&ds->dd_lock);
171         list_for_each_entry(dd, &ds->dependent_devices, list) {
172                 if (handle == dd->handle) {
173                         spin_unlock(&ds->dd_lock);
174                         return dd;
175                 }
176         }
177         spin_unlock(&ds->dd_lock);
178         return NULL;
179 }
180
181 /*****************************************************************************
182  *                         Dock functions                                    *
183  *****************************************************************************/
184 /**
185  * is_dock - see if a device is a dock station
186  * @handle: acpi handle of the device
187  *
188  * If an acpi object has a _DCK method, then it is by definition a dock
189  * station, so return true.
190  */
191 static int is_dock(acpi_handle handle)
192 {
193         acpi_status status;
194         acpi_handle tmp;
195
196         status = acpi_get_handle(handle, "_DCK", &tmp);
197         if (ACPI_FAILURE(status))
198                 return 0;
199         return 1;
200 }
201
202 /**
203  * is_dock_device - see if a device is on a dock station
204  * @handle: acpi handle of the device
205  *
206  * If this device is either the dock station itself,
207  * or is a device dependent on the dock station, then it
208  * is a dock device
209  */
210 int is_dock_device(acpi_handle handle)
211 {
212         if (!dock_station)
213                 return 0;
214
215         if (is_dock(handle) || find_dock_dependent_device(dock_station, handle))
216                 return 1;
217
218         return 0;
219 }
220
221 EXPORT_SYMBOL_GPL(is_dock_device);
222
223 /**
224  * dock_present - see if the dock station is present.
225  * @ds: the dock station
226  *
227  * execute the _STA method.  note that present does not
228  * imply that we are docked.
229  */
230 static int dock_present(struct dock_station *ds)
231 {
232         unsigned long sta;
233         acpi_status status;
234
235         if (ds) {
236                 status = acpi_evaluate_integer(ds->handle, "_STA", NULL, &sta);
237                 if (ACPI_SUCCESS(status) && sta)
238                         return 1;
239         }
240         return 0;
241 }
242
243
244
245 /**
246  * dock_create_acpi_device - add new devices to acpi
247  * @handle - handle of the device to add
248  *
249  *  This function will create a new acpi_device for the given
250  *  handle if one does not exist already.  This should cause
251  *  acpi to scan for drivers for the given devices, and call
252  *  matching driver's add routine.
253  *
254  *  Returns a pointer to the acpi_device corresponding to the handle.
255  */
256 static struct acpi_device * dock_create_acpi_device(acpi_handle handle)
257 {
258         struct acpi_device *device = NULL;
259         struct acpi_device *parent_device;
260         acpi_handle parent;
261         int ret;
262
263         if (acpi_bus_get_device(handle, &device)) {
264                 /*
265                  * no device created for this object,
266                  * so we should create one.
267                  */
268                 acpi_get_parent(handle, &parent);
269                 if (acpi_bus_get_device(parent, &parent_device))
270                         parent_device = NULL;
271
272                 ret = acpi_bus_add(&device, parent_device, handle,
273                         ACPI_BUS_TYPE_DEVICE);
274                 if (ret) {
275                         pr_debug("error adding bus, %x\n",
276                                 -ret);
277                         return NULL;
278                 }
279         }
280         return device;
281 }
282
283 /**
284  * dock_remove_acpi_device - remove the acpi_device struct from acpi
285  * @handle - the handle of the device to remove
286  *
287  *  Tell acpi to remove the acpi_device.  This should cause any loaded
288  *  driver to have it's remove routine called.
289  */
290 static void dock_remove_acpi_device(acpi_handle handle)
291 {
292         struct acpi_device *device;
293         int ret;
294
295         if (!acpi_bus_get_device(handle, &device)) {
296                 ret = acpi_bus_trim(device, 1);
297                 if (ret)
298                         pr_debug("error removing bus, %x\n", -ret);
299         }
300 }
301
302
303 /**
304  * hotplug_dock_devices - insert or remove devices on the dock station
305  * @ds: the dock station
306  * @event: either bus check or eject request
307  *
308  * Some devices on the dock station need to have drivers called
309  * to perform hotplug operations after a dock event has occurred.
310  * Traverse the list of dock devices that have registered a
311  * hotplug handler, and call the handler.
312  */
313 static void hotplug_dock_devices(struct dock_station *ds, u32 event)
314 {
315         struct dock_dependent_device *dd;
316
317         mutex_lock(&ds->hp_lock);
318
319         /*
320          * First call driver specific hotplug functions
321          */
322         list_for_each_entry(dd, &ds->hotplug_devices, hotplug_list) {
323                 if (dd->handler)
324                         dd->handler(dd->handle, event, dd->context);
325         }
326
327         /*
328          * Now make sure that an acpi_device is created for each
329          * dependent device, or removed if this is an eject request.
330          * This will cause acpi_drivers to be stopped/started if they
331          * exist
332          */
333         list_for_each_entry(dd, &ds->dependent_devices, list) {
334                 if (event == ACPI_NOTIFY_EJECT_REQUEST)
335                         dock_remove_acpi_device(dd->handle);
336                 else
337                         dock_create_acpi_device(dd->handle);
338         }
339         mutex_unlock(&ds->hp_lock);
340 }
341
342 static void dock_event(struct dock_station *ds, u32 event, int num)
343 {
344         struct device *dev = &dock_device->dev;
345         char event_string[13];
346         char *envp[] = { event_string, NULL };
347
348         if (num == UNDOCK_EVENT)
349                 sprintf(event_string, "EVENT=undock");
350         else
351                 sprintf(event_string, "EVENT=dock");
352
353         /*
354          * Indicate that the status of the dock station has
355          * changed.
356          */
357         kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
358 }
359
360 /**
361  * eject_dock - respond to a dock eject request
362  * @ds: the dock station
363  *
364  * This is called after _DCK is called, to execute the dock station's
365  * _EJ0 method.
366  */
367 static void eject_dock(struct dock_station *ds)
368 {
369         struct acpi_object_list arg_list;
370         union acpi_object arg;
371         acpi_status status;
372         acpi_handle tmp;
373
374         /* all dock devices should have _EJ0, but check anyway */
375         status = acpi_get_handle(ds->handle, "_EJ0", &tmp);
376         if (ACPI_FAILURE(status)) {
377                 pr_debug("No _EJ0 support for dock device\n");
378                 return;
379         }
380
381         arg_list.count = 1;
382         arg_list.pointer = &arg;
383         arg.type = ACPI_TYPE_INTEGER;
384         arg.integer.value = 1;
385
386         if (ACPI_FAILURE(acpi_evaluate_object(ds->handle, "_EJ0",
387                                               &arg_list, NULL)))
388                 pr_debug("Failed to evaluate _EJ0!\n");
389 }
390
391 /**
392  * handle_dock - handle a dock event
393  * @ds: the dock station
394  * @dock: to dock, or undock - that is the question
395  *
396  * Execute the _DCK method in response to an acpi event
397  */
398 static void handle_dock(struct dock_station *ds, int dock)
399 {
400         acpi_status status;
401         struct acpi_object_list arg_list;
402         union acpi_object arg;
403         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
404         struct acpi_buffer name_buffer = { ACPI_ALLOCATE_BUFFER, NULL };
405
406         acpi_get_name(ds->handle, ACPI_FULL_PATHNAME, &name_buffer);
407
408         printk(KERN_INFO PREFIX "%s - %s\n",
409                 (char *)name_buffer.pointer, dock ? "docking" : "undocking");
410
411         /* _DCK method has one argument */
412         arg_list.count = 1;
413         arg_list.pointer = &arg;
414         arg.type = ACPI_TYPE_INTEGER;
415         arg.integer.value = dock;
416         status = acpi_evaluate_object(ds->handle, "_DCK", &arg_list, &buffer);
417         if (ACPI_FAILURE(status))
418                 printk(KERN_ERR PREFIX "%s - failed to execute _DCK\n",
419                          (char *)name_buffer.pointer);
420         kfree(buffer.pointer);
421         kfree(name_buffer.pointer);
422 }
423
424 static inline void dock(struct dock_station *ds)
425 {
426         handle_dock(ds, 1);
427 }
428
429 static inline void undock(struct dock_station *ds)
430 {
431         handle_dock(ds, 0);
432 }
433
434 static inline void begin_dock(struct dock_station *ds)
435 {
436         ds->flags |= DOCK_DOCKING;
437 }
438
439 static inline void complete_dock(struct dock_station *ds)
440 {
441         ds->flags &= ~(DOCK_DOCKING);
442         ds->last_dock_time = jiffies;
443 }
444
445 static inline void begin_undock(struct dock_station *ds)
446 {
447         ds->flags |= DOCK_UNDOCKING;
448 }
449
450 static inline void complete_undock(struct dock_station *ds)
451 {
452         ds->flags &= ~(DOCK_UNDOCKING);
453 }
454
455 /**
456  * dock_in_progress - see if we are in the middle of handling a dock event
457  * @ds: the dock station
458  *
459  * Sometimes while docking, false dock events can be sent to the driver
460  * because good connections aren't made or some other reason.  Ignore these
461  * if we are in the middle of doing something.
462  */
463 static int dock_in_progress(struct dock_station *ds)
464 {
465         if ((ds->flags & DOCK_DOCKING) ||
466             time_before(jiffies, (ds->last_dock_time + HZ)))
467                 return 1;
468         return 0;
469 }
470
471 /**
472  * register_dock_notifier - add yourself to the dock notifier list
473  * @nb: the callers notifier block
474  *
475  * If a driver wishes to be notified about dock events, they can
476  * use this function to put a notifier block on the dock notifier list.
477  * this notifier call chain will be called after a dock event, but
478  * before hotplugging any new devices.
479  */
480 int register_dock_notifier(struct notifier_block *nb)
481 {
482         if (!dock_station)
483                 return -ENODEV;
484
485         return atomic_notifier_chain_register(&dock_notifier_list, nb);
486 }
487
488 EXPORT_SYMBOL_GPL(register_dock_notifier);
489
490 /**
491  * unregister_dock_notifier - remove yourself from the dock notifier list
492  * @nb: the callers notifier block
493  */
494 void unregister_dock_notifier(struct notifier_block *nb)
495 {
496         if (!dock_station)
497                 return;
498
499         atomic_notifier_chain_unregister(&dock_notifier_list, nb);
500 }
501
502 EXPORT_SYMBOL_GPL(unregister_dock_notifier);
503
504 /**
505  * register_hotplug_dock_device - register a hotplug function
506  * @handle: the handle of the device
507  * @handler: the acpi_notifier_handler to call after docking
508  * @context: device specific data
509  *
510  * If a driver would like to perform a hotplug operation after a dock
511  * event, they can register an acpi_notifiy_handler to be called by
512  * the dock driver after _DCK is executed.
513  */
514 int
515 register_hotplug_dock_device(acpi_handle handle, acpi_notify_handler handler,
516                              void *context)
517 {
518         struct dock_dependent_device *dd;
519
520         if (!dock_station)
521                 return -ENODEV;
522
523         /*
524          * make sure this handle is for a device dependent on the dock,
525          * this would include the dock station itself
526          */
527         dd = find_dock_dependent_device(dock_station, handle);
528         if (dd) {
529                 dd->handler = handler;
530                 dd->context = context;
531                 dock_add_hotplug_device(dock_station, dd);
532                 return 0;
533         }
534
535         return -EINVAL;
536 }
537
538 EXPORT_SYMBOL_GPL(register_hotplug_dock_device);
539
540 /**
541  * unregister_hotplug_dock_device - remove yourself from the hotplug list
542  * @handle: the acpi handle of the device
543  */
544 void unregister_hotplug_dock_device(acpi_handle handle)
545 {
546         struct dock_dependent_device *dd;
547
548         if (!dock_station)
549                 return;
550
551         dd = find_dock_dependent_device(dock_station, handle);
552         if (dd)
553                 dock_del_hotplug_device(dock_station, dd);
554 }
555
556 EXPORT_SYMBOL_GPL(unregister_hotplug_dock_device);
557
558 /**
559  * handle_eject_request - handle an undock request checking for error conditions
560  *
561  * Check to make sure the dock device is still present, then undock and
562  * hotremove all the devices that may need removing.
563  */
564 static int handle_eject_request(struct dock_station *ds, u32 event)
565 {
566         if (dock_in_progress(ds))
567                 return -EBUSY;
568
569         /*
570          * here we need to generate the undock
571          * event prior to actually doing the undock
572          * so that the device struct still exists.
573          * Also, even send the dock event if the
574          * device is not present anymore
575          */
576         dock_event(ds, event, UNDOCK_EVENT);
577
578         if (!dock_present(ds)) {
579                 complete_undock(ds);
580                 return -ENODEV;
581         }
582
583         hotplug_dock_devices(ds, ACPI_NOTIFY_EJECT_REQUEST);
584         undock(ds);
585         eject_dock(ds);
586         if (dock_present(ds)) {
587                 printk(KERN_ERR PREFIX "Unable to undock!\n");
588                 return -EBUSY;
589         }
590         complete_undock(ds);
591         return 0;
592 }
593
594 /**
595  * dock_notify - act upon an acpi dock notification
596  * @handle: the dock station handle
597  * @event: the acpi event
598  * @data: our driver data struct
599  *
600  * If we are notified to dock, then check to see if the dock is
601  * present and then dock.  Notify all drivers of the dock event,
602  * and then hotplug and devices that may need hotplugging.
603  */
604 static void dock_notify(acpi_handle handle, u32 event, void *data)
605 {
606         struct dock_station *ds = data;
607         struct acpi_device *tmp;
608
609         switch (event) {
610         case ACPI_NOTIFY_BUS_CHECK:
611                 if (!dock_in_progress(ds) && acpi_bus_get_device(ds->handle,
612                    &tmp)) {
613                         begin_dock(ds);
614                         dock(ds);
615                         if (!dock_present(ds)) {
616                                 printk(KERN_ERR PREFIX "Unable to dock!\n");
617                                 complete_dock(ds);
618                                 break;
619                         }
620                         atomic_notifier_call_chain(&dock_notifier_list,
621                                                    event, NULL);
622                         hotplug_dock_devices(ds, event);
623                         complete_dock(ds);
624                         dock_event(ds, event, DOCK_EVENT);
625                 }
626                 break;
627         case ACPI_NOTIFY_DEVICE_CHECK:
628         /*
629          * According to acpi spec 3.0a, if a DEVICE_CHECK notification
630          * is sent and _DCK is present, it is assumed to mean an
631          * undock request.  This notify routine will only be called
632          * for objects defining _DCK, so we will fall through to eject
633          * request here.  However, we will pass an eject request through
634          * to the driver who wish to hotplug.
635          */
636         case ACPI_NOTIFY_EJECT_REQUEST:
637                 begin_undock(ds);
638                 if (immediate_undock)
639                         handle_eject_request(ds, event);
640                 else
641                         dock_event(ds, event, UNDOCK_EVENT);
642                 break;
643         default:
644                 printk(KERN_ERR PREFIX "Unknown dock event %d\n", event);
645         }
646 }
647
648 /**
649  * find_dock_devices - find devices on the dock station
650  * @handle: the handle of the device we are examining
651  * @lvl: unused
652  * @context: the dock station private data
653  * @rv: unused
654  *
655  * This function is called by acpi_walk_namespace.  It will
656  * check to see if an object has an _EJD method.  If it does, then it
657  * will see if it is dependent on the dock station.
658  */
659 static acpi_status
660 find_dock_devices(acpi_handle handle, u32 lvl, void *context, void **rv)
661 {
662         acpi_status status;
663         acpi_handle tmp, parent;
664         struct dock_station *ds = context;
665         struct dock_dependent_device *dd;
666
667         status = acpi_bus_get_ejd(handle, &tmp);
668         if (ACPI_FAILURE(status)) {
669                 /* try the parent device as well */
670                 status = acpi_get_parent(handle, &parent);
671                 if (ACPI_FAILURE(status))
672                         goto fdd_out;
673                 /* see if parent is dependent on dock */
674                 status = acpi_bus_get_ejd(parent, &tmp);
675                 if (ACPI_FAILURE(status))
676                         goto fdd_out;
677         }
678
679         if (tmp == ds->handle) {
680                 dd = alloc_dock_dependent_device(handle);
681                 if (dd)
682                         add_dock_dependent_device(ds, dd);
683         }
684 fdd_out:
685         return AE_OK;
686 }
687
688 /*
689  * show_docked - read method for "docked" file in sysfs
690  */
691 static ssize_t show_docked(struct device *dev,
692                            struct device_attribute *attr, char *buf)
693 {
694         return snprintf(buf, PAGE_SIZE, "%d\n", dock_present(dock_station));
695
696 }
697 static DEVICE_ATTR(docked, S_IRUGO, show_docked, NULL);
698
699 /*
700  * show_flags - read method for flags file in sysfs
701  */
702 static ssize_t show_flags(struct device *dev,
703                           struct device_attribute *attr, char *buf)
704 {
705         return snprintf(buf, PAGE_SIZE, "%d\n", dock_station->flags);
706
707 }
708 static DEVICE_ATTR(flags, S_IRUGO, show_flags, NULL);
709
710 /*
711  * write_undock - write method for "undock" file in sysfs
712  */
713 static ssize_t write_undock(struct device *dev, struct device_attribute *attr,
714                            const char *buf, size_t count)
715 {
716         int ret;
717
718         if (!count)
719                 return -EINVAL;
720
721         begin_undock(dock_station);
722         ret = handle_eject_request(dock_station, ACPI_NOTIFY_EJECT_REQUEST);
723         return ret ? ret: count;
724 }
725 static DEVICE_ATTR(undock, S_IWUSR, NULL, write_undock);
726
727 /*
728  * show_dock_uid - read method for "uid" file in sysfs
729  */
730 static ssize_t show_dock_uid(struct device *dev,
731                              struct device_attribute *attr, char *buf)
732 {
733         unsigned long lbuf;
734         acpi_status status = acpi_evaluate_integer(dock_station->handle,
735                                         "_UID", NULL, &lbuf);
736         if (ACPI_FAILURE(status))
737             return 0;
738
739         return snprintf(buf, PAGE_SIZE, "%lx\n", lbuf);
740 }
741 static DEVICE_ATTR(uid, S_IRUGO, show_dock_uid, NULL);
742
743 /**
744  * dock_add - add a new dock station
745  * @handle: the dock station handle
746  *
747  * allocated and initialize a new dock station device.  Find all devices
748  * that are on the dock station, and register for dock event notifications.
749  */
750 static int dock_add(acpi_handle handle)
751 {
752         int ret;
753         acpi_status status;
754         struct dock_dependent_device *dd;
755
756         /* allocate & initialize the dock_station private data */
757         dock_station = kzalloc(sizeof(*dock_station), GFP_KERNEL);
758         if (!dock_station)
759                 return -ENOMEM;
760         dock_station->handle = handle;
761         dock_station->last_dock_time = jiffies - HZ;
762         INIT_LIST_HEAD(&dock_station->dependent_devices);
763         INIT_LIST_HEAD(&dock_station->hotplug_devices);
764         spin_lock_init(&dock_station->dd_lock);
765         mutex_init(&dock_station->hp_lock);
766         ATOMIC_INIT_NOTIFIER_HEAD(&dock_notifier_list);
767
768         /* initialize platform device stuff */
769         dock_device =
770                 platform_device_register_simple(dock_device_name, 0, NULL, 0);
771         if (IS_ERR(dock_device)) {
772                 kfree(dock_station);
773                 dock_station = NULL;
774                 return PTR_ERR(dock_device);
775         }
776
777         /* we want the dock device to send uevents */
778         dock_device->dev.uevent_suppress = 0;
779
780         ret = device_create_file(&dock_device->dev, &dev_attr_docked);
781         if (ret) {
782                 printk("Error %d adding sysfs file\n", ret);
783                 platform_device_unregister(dock_device);
784                 kfree(dock_station);
785                 dock_station = NULL;
786                 return ret;
787         }
788         ret = device_create_file(&dock_device->dev, &dev_attr_undock);
789         if (ret) {
790                 printk("Error %d adding sysfs file\n", ret);
791                 device_remove_file(&dock_device->dev, &dev_attr_docked);
792                 platform_device_unregister(dock_device);
793                 kfree(dock_station);
794                 dock_station = NULL;
795                 return ret;
796         }
797         ret = device_create_file(&dock_device->dev, &dev_attr_uid);
798         if (ret) {
799                 printk("Error %d adding sysfs file\n", ret);
800                 device_remove_file(&dock_device->dev, &dev_attr_docked);
801                 device_remove_file(&dock_device->dev, &dev_attr_undock);
802                 platform_device_unregister(dock_device);
803                 kfree(dock_station);
804                 dock_station = NULL;
805                 return ret;
806         }
807         ret = device_create_file(&dock_device->dev, &dev_attr_flags);
808         if (ret) {
809                 printk("Error %d adding sysfs file\n", ret);
810                 device_remove_file(&dock_device->dev, &dev_attr_docked);
811                 device_remove_file(&dock_device->dev, &dev_attr_undock);
812                 device_remove_file(&dock_device->dev, &dev_attr_uid);
813                 platform_device_unregister(dock_device);
814                 kfree(dock_station);
815                 dock_station = NULL;
816                 return ret;
817         }
818
819         /* Find dependent devices */
820         acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
821                             ACPI_UINT32_MAX, find_dock_devices, dock_station,
822                             NULL);
823
824         /* add the dock station as a device dependent on itself */
825         dd = alloc_dock_dependent_device(handle);
826         if (!dd) {
827                 kfree(dock_station);
828                 dock_station = NULL;
829                 ret = -ENOMEM;
830                 goto dock_add_err_unregister;
831         }
832         add_dock_dependent_device(dock_station, dd);
833
834         /* register for dock events */
835         status = acpi_install_notify_handler(dock_station->handle,
836                                              ACPI_SYSTEM_NOTIFY,
837                                              dock_notify, dock_station);
838
839         if (ACPI_FAILURE(status)) {
840                 printk(KERN_ERR PREFIX "Error installing notify handler\n");
841                 ret = -ENODEV;
842                 goto dock_add_err;
843         }
844
845         printk(KERN_INFO PREFIX "%s\n", ACPI_DOCK_DRIVER_DESCRIPTION);
846
847         return 0;
848
849 dock_add_err:
850         kfree(dd);
851 dock_add_err_unregister:
852         device_remove_file(&dock_device->dev, &dev_attr_docked);
853         device_remove_file(&dock_device->dev, &dev_attr_undock);
854         device_remove_file(&dock_device->dev, &dev_attr_uid);
855         device_remove_file(&dock_device->dev, &dev_attr_flags);
856         platform_device_unregister(dock_device);
857         kfree(dock_station);
858         dock_station = NULL;
859         return ret;
860 }
861
862 /**
863  * dock_remove - free up resources related to the dock station
864  */
865 static int dock_remove(void)
866 {
867         struct dock_dependent_device *dd, *tmp;
868         acpi_status status;
869
870         if (!dock_station)
871                 return 0;
872
873         /* remove dependent devices */
874         list_for_each_entry_safe(dd, tmp, &dock_station->dependent_devices,
875                                  list)
876             kfree(dd);
877
878         /* remove dock notify handler */
879         status = acpi_remove_notify_handler(dock_station->handle,
880                                             ACPI_SYSTEM_NOTIFY,
881                                             dock_notify);
882         if (ACPI_FAILURE(status))
883                 printk(KERN_ERR "Error removing notify handler\n");
884
885         /* cleanup sysfs */
886         device_remove_file(&dock_device->dev, &dev_attr_docked);
887         device_remove_file(&dock_device->dev, &dev_attr_undock);
888         device_remove_file(&dock_device->dev, &dev_attr_uid);
889         device_remove_file(&dock_device->dev, &dev_attr_flags);
890         platform_device_unregister(dock_device);
891
892         /* free dock station memory */
893         kfree(dock_station);
894         dock_station = NULL;
895         return 0;
896 }
897
898 /**
899  * find_dock - look for a dock station
900  * @handle: acpi handle of a device
901  * @lvl: unused
902  * @context: counter of dock stations found
903  * @rv: unused
904  *
905  * This is called by acpi_walk_namespace to look for dock stations.
906  */
907 static acpi_status
908 find_dock(acpi_handle handle, u32 lvl, void *context, void **rv)
909 {
910         int *count = context;
911         acpi_status status = AE_OK;
912
913         if (is_dock(handle)) {
914                 if (dock_add(handle) >= 0) {
915                         (*count)++;
916                         status = AE_CTRL_TERMINATE;
917                 }
918         }
919         return status;
920 }
921
922 static int __init dock_init(void)
923 {
924         int num = 0;
925
926         dock_station = NULL;
927
928         if (acpi_disabled)
929                 return 0;
930
931         /* look for a dock station */
932         acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
933                             ACPI_UINT32_MAX, find_dock, &num, NULL);
934
935         if (!num)
936                 printk(KERN_INFO "No dock devices found.\n");
937
938         return 0;
939 }
940
941 static void __exit dock_exit(void)
942 {
943         dock_remove();
944 }
945
946 postcore_initcall(dock_init);
947 module_exit(dock_exit);