2 * dock.c - ACPI dock station driver
4 * Copyright (C) 2006 Kristen Carlson Accardi <kristen.c.accardi@intel.com>
6 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
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.
22 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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>
38 #define PREFIX "ACPI: "
40 #define ACPI_DOCK_DRIVER_DESCRIPTION "ACPI Dock Station Driver"
42 ACPI_MODULE_NAME("dock");
43 MODULE_AUTHOR("Kristen Carlson Accardi");
44 MODULE_DESCRIPTION(ACPI_DOCK_DRIVER_DESCRIPTION);
45 MODULE_LICENSE("GPL");
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 "
54 static struct atomic_notifier_head dock_notifier_list;
56 static const struct acpi_device_id dock_device_ids[] = {
60 MODULE_DEVICE_TABLE(acpi, dock_device_ids);
64 unsigned long last_dock_time;
68 struct list_head dependent_devices;
69 struct list_head hotplug_devices;
71 struct list_head sibling;
72 struct platform_device *dock_device;
74 static LIST_HEAD(dock_stations);
75 static int dock_station_count;
77 struct dock_dependent_device {
78 struct list_head list;
79 struct list_head hotplug_list;
81 const struct acpi_dock_ops *ops;
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
91 #define UNDOCK_EVENT 2
93 /*****************************************************************************
94 * Dock Dependent device functions *
95 *****************************************************************************/
97 * add_dock_dependent_device - associate a device with the dock station
98 * @ds: The dock station
99 * @handle: handle of the dependent device
101 * Add the dependent device to the dock's dependent device list.
104 add_dock_dependent_device(struct dock_station *ds, acpi_handle handle)
106 struct dock_dependent_device *dd;
108 dd = kzalloc(sizeof(*dd), GFP_KERNEL);
113 INIT_LIST_HEAD(&dd->list);
114 INIT_LIST_HEAD(&dd->hotplug_list);
116 spin_lock(&ds->dd_lock);
117 list_add_tail(&dd->list, &ds->dependent_devices);
118 spin_unlock(&ds->dd_lock);
124 * dock_add_hotplug_device - associate a hotplug handler with the dock station
125 * @ds: The dock station
126 * @dd: The dependent device struct
128 * Add the dependent device to the dock's hotplug device list
131 dock_add_hotplug_device(struct dock_station *ds,
132 struct dock_dependent_device *dd)
134 mutex_lock(&ds->hp_lock);
135 list_add_tail(&dd->hotplug_list, &ds->hotplug_devices);
136 mutex_unlock(&ds->hp_lock);
140 * dock_del_hotplug_device - remove a hotplug handler from the dock station
141 * @ds: The dock station
142 * @dd: the dependent device struct
144 * Delete the dependent device from the dock's hotplug device list
147 dock_del_hotplug_device(struct dock_station *ds,
148 struct dock_dependent_device *dd)
150 mutex_lock(&ds->hp_lock);
151 list_del(&dd->hotplug_list);
152 mutex_unlock(&ds->hp_lock);
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
160 * iterate over the dependent device list for this dock. If the
161 * dependent device matches the handle, return.
163 static struct dock_dependent_device *
164 find_dock_dependent_device(struct dock_station *ds, acpi_handle handle)
166 struct dock_dependent_device *dd;
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);
175 spin_unlock(&ds->dd_lock);
179 /*****************************************************************************
181 *****************************************************************************/
183 * is_dock - see if a device is a dock station
184 * @handle: acpi handle of the device
186 * If an acpi object has a _DCK method, then it is by definition a dock
187 * station, so return true.
189 static int is_dock(acpi_handle handle)
194 status = acpi_get_handle(handle, "_DCK", &tmp);
195 if (ACPI_FAILURE(status))
200 static int is_ejectable(acpi_handle handle)
205 status = acpi_get_handle(handle, "_EJ0", &tmp);
206 if (ACPI_FAILURE(status))
211 static int is_ata(acpi_handle handle)
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))))
224 static int is_battery(acpi_handle handle)
226 struct acpi_device_info *info;
229 if (!ACPI_SUCCESS(acpi_get_object_info(handle, &info)))
231 if (!(info->valid & ACPI_VALID_HID))
234 ret = !strcmp("PNP0C0A", info->hardware_id.string);
240 static int is_ejectable_bay(acpi_handle handle)
244 if (!is_ejectable(handle))
246 if (is_battery(handle) || is_ata(handle))
248 if (!acpi_get_parent(handle, &phandle) && is_ata(phandle))
254 * is_dock_device - see if a device is on a dock station
255 * @handle: acpi handle of the device
257 * If this device is either the dock station itself,
258 * or is a device dependent on the dock station, then it
261 int is_dock_device(acpi_handle handle)
263 struct dock_station *dock_station;
265 if (!dock_station_count)
271 list_for_each_entry(dock_station, &dock_stations, sibling)
272 if (find_dock_dependent_device(dock_station, handle))
277 EXPORT_SYMBOL_GPL(is_dock_device);
280 * dock_present - see if the dock station is present.
281 * @ds: the dock station
283 * execute the _STA method. note that present does not
284 * imply that we are docked.
286 static int dock_present(struct dock_station *ds)
288 unsigned long long sta;
292 status = acpi_evaluate_integer(ds->handle, "_STA", NULL, &sta);
293 if (ACPI_SUCCESS(status) && sta)
300 * dock_create_acpi_device - add new devices to acpi
301 * @handle - handle of the device to add
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.
308 * Returns a pointer to the acpi_device corresponding to the handle.
310 static struct acpi_device * dock_create_acpi_device(acpi_handle handle)
312 struct acpi_device *device;
313 struct acpi_device *parent_device;
317 if (acpi_bus_get_device(handle, &device)) {
319 * no device created for this object,
320 * so we should create one.
322 acpi_get_parent(handle, &parent);
323 if (acpi_bus_get_device(parent, &parent_device))
324 parent_device = NULL;
326 ret = acpi_bus_add(&device, parent_device, handle,
327 ACPI_BUS_TYPE_DEVICE);
329 pr_debug("error adding bus, %x\n", -ret);
337 * dock_remove_acpi_device - remove the acpi_device struct from acpi
338 * @handle - the handle of the device to remove
340 * Tell acpi to remove the acpi_device. This should cause any loaded
341 * driver to have it's remove routine called.
343 static void dock_remove_acpi_device(acpi_handle handle)
345 struct acpi_device *device;
348 if (!acpi_bus_get_device(handle, &device)) {
349 ret = acpi_bus_trim(device, 1);
351 pr_debug("error removing bus, %x\n", -ret);
356 * hotplug_dock_devices - insert or remove devices on the dock station
357 * @ds: the dock station
358 * @event: either bus check or eject request
360 * Some devices on the dock station need to have drivers called
361 * to perform hotplug operations after a dock event has occurred.
362 * Traverse the list of dock devices that have registered a
363 * hotplug handler, and call the handler.
365 static void hotplug_dock_devices(struct dock_station *ds, u32 event)
367 struct dock_dependent_device *dd;
369 mutex_lock(&ds->hp_lock);
372 * First call driver specific hotplug functions
374 list_for_each_entry(dd, &ds->hotplug_devices, hotplug_list)
375 if (dd->ops && dd->ops->handler)
376 dd->ops->handler(dd->handle, event, dd->context);
379 * Now make sure that an acpi_device is created for each
380 * dependent device, or removed if this is an eject request.
381 * This will cause acpi_drivers to be stopped/started if they
384 list_for_each_entry(dd, &ds->dependent_devices, list) {
385 if (event == ACPI_NOTIFY_EJECT_REQUEST)
386 dock_remove_acpi_device(dd->handle);
388 dock_create_acpi_device(dd->handle);
390 mutex_unlock(&ds->hp_lock);
393 static void dock_event(struct dock_station *ds, u32 event, int num)
395 struct device *dev = &ds->dock_device->dev;
396 char event_string[13];
397 char *envp[] = { event_string, NULL };
398 struct dock_dependent_device *dd;
400 if (num == UNDOCK_EVENT)
401 sprintf(event_string, "EVENT=undock");
403 sprintf(event_string, "EVENT=dock");
406 * Indicate that the status of the dock station has
409 if (num == DOCK_EVENT)
410 kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
412 list_for_each_entry(dd, &ds->hotplug_devices, hotplug_list)
413 if (dd->ops && dd->ops->uevent)
414 dd->ops->uevent(dd->handle, event, dd->context);
416 if (num != DOCK_EVENT)
417 kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
421 * eject_dock - respond to a dock eject request
422 * @ds: the dock station
424 * This is called after _DCK is called, to execute the dock station's
427 static void eject_dock(struct dock_station *ds)
429 struct acpi_object_list arg_list;
430 union acpi_object arg;
434 /* all dock devices should have _EJ0, but check anyway */
435 status = acpi_get_handle(ds->handle, "_EJ0", &tmp);
436 if (ACPI_FAILURE(status)) {
437 pr_debug("No _EJ0 support for dock device\n");
442 arg_list.pointer = &arg;
443 arg.type = ACPI_TYPE_INTEGER;
444 arg.integer.value = 1;
446 status = acpi_evaluate_object(ds->handle, "_EJ0", &arg_list, NULL);
447 if (ACPI_FAILURE(status))
448 pr_debug("Failed to evaluate _EJ0!\n");
452 * handle_dock - handle a dock event
453 * @ds: the dock station
454 * @dock: to dock, or undock - that is the question
456 * Execute the _DCK method in response to an acpi event
458 static void handle_dock(struct dock_station *ds, int dock)
461 struct acpi_object_list arg_list;
462 union acpi_object arg;
463 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
465 acpi_handle_info(ds->handle, "%s\n", dock ? "docking" : "undocking");
467 /* _DCK method has one argument */
469 arg_list.pointer = &arg;
470 arg.type = ACPI_TYPE_INTEGER;
471 arg.integer.value = dock;
472 status = acpi_evaluate_object(ds->handle, "_DCK", &arg_list, &buffer);
473 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND)
474 acpi_handle_err(ds->handle, "Failed to execute _DCK (0x%x)\n",
477 kfree(buffer.pointer);
480 static inline void dock(struct dock_station *ds)
485 static inline void undock(struct dock_station *ds)
490 static inline void begin_dock(struct dock_station *ds)
492 ds->flags |= DOCK_DOCKING;
495 static inline void complete_dock(struct dock_station *ds)
497 ds->flags &= ~(DOCK_DOCKING);
498 ds->last_dock_time = jiffies;
501 static inline void begin_undock(struct dock_station *ds)
503 ds->flags |= DOCK_UNDOCKING;
506 static inline void complete_undock(struct dock_station *ds)
508 ds->flags &= ~(DOCK_UNDOCKING);
511 static void dock_lock(struct dock_station *ds, int lock)
513 struct acpi_object_list arg_list;
514 union acpi_object arg;
518 arg_list.pointer = &arg;
519 arg.type = ACPI_TYPE_INTEGER;
520 arg.integer.value = !!lock;
521 status = acpi_evaluate_object(ds->handle, "_LCK", &arg_list, NULL);
522 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
524 acpi_handle_warn(ds->handle,
525 "Locking device failed (0x%x)\n", status);
527 acpi_handle_warn(ds->handle,
528 "Unlocking device failed (0x%x)\n", status);
533 * dock_in_progress - see if we are in the middle of handling a dock event
534 * @ds: the dock station
536 * Sometimes while docking, false dock events can be sent to the driver
537 * because good connections aren't made or some other reason. Ignore these
538 * if we are in the middle of doing something.
540 static int dock_in_progress(struct dock_station *ds)
542 if ((ds->flags & DOCK_DOCKING) ||
543 time_before(jiffies, (ds->last_dock_time + HZ)))
549 * register_dock_notifier - add yourself to the dock notifier list
550 * @nb: the callers notifier block
552 * If a driver wishes to be notified about dock events, they can
553 * use this function to put a notifier block on the dock notifier list.
554 * this notifier call chain will be called after a dock event, but
555 * before hotplugging any new devices.
557 int register_dock_notifier(struct notifier_block *nb)
559 if (!dock_station_count)
562 return atomic_notifier_chain_register(&dock_notifier_list, nb);
564 EXPORT_SYMBOL_GPL(register_dock_notifier);
567 * unregister_dock_notifier - remove yourself from the dock notifier list
568 * @nb: the callers notifier block
570 void unregister_dock_notifier(struct notifier_block *nb)
572 if (!dock_station_count)
575 atomic_notifier_chain_unregister(&dock_notifier_list, nb);
577 EXPORT_SYMBOL_GPL(unregister_dock_notifier);
580 * register_hotplug_dock_device - register a hotplug function
581 * @handle: the handle of the device
582 * @ops: handlers to call after docking
583 * @context: device specific data
585 * If a driver would like to perform a hotplug operation after a dock
586 * event, they can register an acpi_notifiy_handler to be called by
587 * the dock driver after _DCK is executed.
590 register_hotplug_dock_device(acpi_handle handle, const struct acpi_dock_ops *ops,
593 struct dock_dependent_device *dd;
594 struct dock_station *dock_station;
597 if (!dock_station_count)
601 * make sure this handle is for a device dependent on the dock,
602 * this would include the dock station itself
604 list_for_each_entry(dock_station, &dock_stations, sibling) {
606 * An ATA bay can be in a dock and itself can be ejected
607 * separately, so there are two 'dock stations' which need the
610 dd = find_dock_dependent_device(dock_station, handle);
613 dd->context = context;
614 dock_add_hotplug_device(dock_station, dd);
621 EXPORT_SYMBOL_GPL(register_hotplug_dock_device);
624 * unregister_hotplug_dock_device - remove yourself from the hotplug list
625 * @handle: the acpi handle of the device
627 void unregister_hotplug_dock_device(acpi_handle handle)
629 struct dock_dependent_device *dd;
630 struct dock_station *dock_station;
632 if (!dock_station_count)
635 list_for_each_entry(dock_station, &dock_stations, sibling) {
636 dd = find_dock_dependent_device(dock_station, handle);
638 dock_del_hotplug_device(dock_station, dd);
641 EXPORT_SYMBOL_GPL(unregister_hotplug_dock_device);
644 * handle_eject_request - handle an undock request checking for error conditions
646 * Check to make sure the dock device is still present, then undock and
647 * hotremove all the devices that may need removing.
649 static int handle_eject_request(struct dock_station *ds, u32 event)
651 if (dock_in_progress(ds))
655 * here we need to generate the undock
656 * event prior to actually doing the undock
657 * so that the device struct still exists.
658 * Also, even send the dock event if the
659 * device is not present anymore
661 dock_event(ds, event, UNDOCK_EVENT);
663 hotplug_dock_devices(ds, ACPI_NOTIFY_EJECT_REQUEST);
667 if (dock_present(ds)) {
668 acpi_handle_err(ds->handle, "Unable to undock!\n");
676 * dock_notify - act upon an acpi dock notification
677 * @handle: the dock station handle
678 * @event: the acpi event
679 * @data: our driver data struct
681 * If we are notified to dock, then check to see if the dock is
682 * present and then dock. Notify all drivers of the dock event,
683 * and then hotplug and devices that may need hotplugging.
685 static void dock_notify(acpi_handle handle, u32 event, void *data)
687 struct dock_station *ds = data;
688 struct acpi_device *tmp;
689 int surprise_removal = 0;
692 * According to acpi spec 3.0a, if a DEVICE_CHECK notification
693 * is sent and _DCK is present, it is assumed to mean an undock
696 if ((ds->flags & DOCK_IS_DOCK) && event == ACPI_NOTIFY_DEVICE_CHECK)
697 event = ACPI_NOTIFY_EJECT_REQUEST;
700 * dock station: BUS_CHECK - docked or surprise removal
701 * DEVICE_CHECK - undocked
702 * other device: BUS_CHECK/DEVICE_CHECK - added or surprise removal
704 * To simplify event handling, dock dependent device handler always
705 * get ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and
706 * ACPI_NOTIFY_EJECT_REQUEST for removal
709 case ACPI_NOTIFY_BUS_CHECK:
710 case ACPI_NOTIFY_DEVICE_CHECK:
711 if (!dock_in_progress(ds) && acpi_bus_get_device(ds->handle,
715 if (!dock_present(ds)) {
716 acpi_handle_err(handle, "Unable to dock!\n");
720 atomic_notifier_call_chain(&dock_notifier_list,
722 hotplug_dock_devices(ds, event);
724 dock_event(ds, event, DOCK_EVENT);
726 acpi_update_all_gpes();
729 if (dock_present(ds) || dock_in_progress(ds))
731 /* This is a surprise removal */
732 surprise_removal = 1;
733 event = ACPI_NOTIFY_EJECT_REQUEST;
735 case ACPI_NOTIFY_EJECT_REQUEST:
737 if ((immediate_undock && !(ds->flags & DOCK_IS_ATA))
739 handle_eject_request(ds, event);
741 dock_event(ds, event, UNDOCK_EVENT);
744 acpi_handle_err(handle, "Unknown dock event %d\n", event);
751 struct dock_station *ds;
754 static void acpi_dock_deferred_cb(void *context)
756 struct dock_data *data = context;
758 dock_notify(data->handle, data->event, data->ds);
762 static int acpi_dock_notifier_call(struct notifier_block *this,
763 unsigned long event, void *data)
765 struct dock_station *dock_station;
766 acpi_handle handle = data;
768 if (event != ACPI_NOTIFY_BUS_CHECK && event != ACPI_NOTIFY_DEVICE_CHECK
769 && event != ACPI_NOTIFY_EJECT_REQUEST)
771 list_for_each_entry(dock_station, &dock_stations, sibling) {
772 if (dock_station->handle == handle) {
773 struct dock_data *dd;
775 dd = kmalloc(sizeof(*dd), GFP_KERNEL);
780 dd->ds = dock_station;
781 acpi_os_hotplug_execute(acpi_dock_deferred_cb, dd);
788 static struct notifier_block dock_acpi_notifier = {
789 .notifier_call = acpi_dock_notifier_call,
793 * find_dock_devices - find devices on the dock station
794 * @handle: the handle of the device we are examining
796 * @context: the dock station private data
799 * This function is called by acpi_walk_namespace. It will
800 * check to see if an object has an _EJD method. If it does, then it
801 * will see if it is dependent on the dock station.
804 find_dock_devices(acpi_handle handle, u32 lvl, void *context, void **rv)
807 acpi_handle tmp, parent;
808 struct dock_station *ds = context;
810 status = acpi_bus_get_ejd(handle, &tmp);
811 if (ACPI_FAILURE(status)) {
812 /* try the parent device as well */
813 status = acpi_get_parent(handle, &parent);
814 if (ACPI_FAILURE(status))
816 /* see if parent is dependent on dock */
817 status = acpi_bus_get_ejd(parent, &tmp);
818 if (ACPI_FAILURE(status))
822 if (tmp == ds->handle)
823 add_dock_dependent_device(ds, handle);
830 * show_docked - read method for "docked" file in sysfs
832 static ssize_t show_docked(struct device *dev,
833 struct device_attribute *attr, char *buf)
835 struct acpi_device *tmp;
837 struct dock_station *dock_station = dev->platform_data;
839 if (ACPI_SUCCESS(acpi_bus_get_device(dock_station->handle, &tmp)))
840 return snprintf(buf, PAGE_SIZE, "1\n");
841 return snprintf(buf, PAGE_SIZE, "0\n");
843 static DEVICE_ATTR(docked, S_IRUGO, show_docked, NULL);
846 * show_flags - read method for flags file in sysfs
848 static ssize_t show_flags(struct device *dev,
849 struct device_attribute *attr, char *buf)
851 struct dock_station *dock_station = dev->platform_data;
852 return snprintf(buf, PAGE_SIZE, "%d\n", dock_station->flags);
855 static DEVICE_ATTR(flags, S_IRUGO, show_flags, NULL);
858 * write_undock - write method for "undock" file in sysfs
860 static ssize_t write_undock(struct device *dev, struct device_attribute *attr,
861 const char *buf, size_t count)
864 struct dock_station *dock_station = dev->platform_data;
869 begin_undock(dock_station);
870 ret = handle_eject_request(dock_station, ACPI_NOTIFY_EJECT_REQUEST);
871 return ret ? ret: count;
873 static DEVICE_ATTR(undock, S_IWUSR, NULL, write_undock);
876 * show_dock_uid - read method for "uid" file in sysfs
878 static ssize_t show_dock_uid(struct device *dev,
879 struct device_attribute *attr, char *buf)
881 unsigned long long lbuf;
882 struct dock_station *dock_station = dev->platform_data;
883 acpi_status status = acpi_evaluate_integer(dock_station->handle,
884 "_UID", NULL, &lbuf);
885 if (ACPI_FAILURE(status))
888 return snprintf(buf, PAGE_SIZE, "%llx\n", lbuf);
890 static DEVICE_ATTR(uid, S_IRUGO, show_dock_uid, NULL);
892 static ssize_t show_dock_type(struct device *dev,
893 struct device_attribute *attr, char *buf)
895 struct dock_station *dock_station = dev->platform_data;
898 if (dock_station->flags & DOCK_IS_DOCK)
899 type = "dock_station";
900 else if (dock_station->flags & DOCK_IS_ATA)
902 else if (dock_station->flags & DOCK_IS_BAT)
903 type = "battery_bay";
907 return snprintf(buf, PAGE_SIZE, "%s\n", type);
909 static DEVICE_ATTR(type, S_IRUGO, show_dock_type, NULL);
911 static struct attribute *dock_attributes[] = {
912 &dev_attr_docked.attr,
913 &dev_attr_flags.attr,
914 &dev_attr_undock.attr,
920 static struct attribute_group dock_attribute_group = {
921 .attrs = dock_attributes
925 * dock_add - add a new dock station
926 * @handle: the dock station handle
928 * allocated and initialize a new dock station device. Find all devices
929 * that are on the dock station, and register for dock event notifications.
931 static int __init dock_add(acpi_handle handle)
934 struct dock_station ds, *dock_station;
935 struct platform_device *dd;
937 id = dock_station_count;
938 memset(&ds, 0, sizeof(ds));
939 dd = platform_device_register_data(NULL, "dock", id, &ds, sizeof(ds));
943 dock_station = dd->dev.platform_data;
945 dock_station->handle = handle;
946 dock_station->dock_device = dd;
947 dock_station->last_dock_time = jiffies - HZ;
949 mutex_init(&dock_station->hp_lock);
950 spin_lock_init(&dock_station->dd_lock);
951 INIT_LIST_HEAD(&dock_station->sibling);
952 INIT_LIST_HEAD(&dock_station->hotplug_devices);
953 ATOMIC_INIT_NOTIFIER_HEAD(&dock_notifier_list);
954 INIT_LIST_HEAD(&dock_station->dependent_devices);
956 /* we want the dock device to send uevents */
957 dev_set_uevent_suppress(&dd->dev, 0);
960 dock_station->flags |= DOCK_IS_DOCK;
962 dock_station->flags |= DOCK_IS_ATA;
963 if (is_battery(handle))
964 dock_station->flags |= DOCK_IS_BAT;
966 ret = sysfs_create_group(&dd->dev.kobj, &dock_attribute_group);
970 /* Find dependent devices */
971 acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
972 ACPI_UINT32_MAX, find_dock_devices, NULL,
975 /* add the dock station as a device dependent on itself */
976 ret = add_dock_dependent_device(dock_station, handle);
980 dock_station_count++;
981 list_add(&dock_station->sibling, &dock_stations);
985 sysfs_remove_group(&dd->dev.kobj, &dock_attribute_group);
987 platform_device_unregister(dd);
988 acpi_handle_err(handle, "%s encountered error %d\n", __func__, ret);
993 * dock_remove - free up resources related to the dock station
995 static int dock_remove(struct dock_station *ds)
997 struct dock_dependent_device *dd, *tmp;
998 struct platform_device *dock_device = ds->dock_device;
1000 if (!dock_station_count)
1003 /* remove dependent devices */
1004 list_for_each_entry_safe(dd, tmp, &ds->dependent_devices, list)
1007 list_del(&ds->sibling);
1010 sysfs_remove_group(&dock_device->dev.kobj, &dock_attribute_group);
1011 platform_device_unregister(dock_device);
1017 * find_dock_and_bay - look for dock stations and bays
1018 * @handle: acpi handle of a device
1023 * This is called by acpi_walk_namespace to look for dock stations and bays.
1025 static __init acpi_status
1026 find_dock_and_bay(acpi_handle handle, u32 lvl, void *context, void **rv)
1028 if (is_dock(handle) || is_ejectable_bay(handle))
1034 static int __init dock_init(void)
1039 /* look for dock stations and bays */
1040 acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
1041 ACPI_UINT32_MAX, find_dock_and_bay, NULL, NULL, NULL);
1043 if (!dock_station_count) {
1044 pr_info(PREFIX "No dock devices found.\n");
1048 register_acpi_bus_notifier(&dock_acpi_notifier);
1049 pr_info(PREFIX "%s: %d docks/bays found\n",
1050 ACPI_DOCK_DRIVER_DESCRIPTION, dock_station_count);
1054 static void __exit dock_exit(void)
1056 struct dock_station *tmp, *dock_station;
1058 unregister_acpi_bus_notifier(&dock_acpi_notifier);
1059 list_for_each_entry_safe(dock_station, tmp, &dock_stations, sibling)
1060 dock_remove(dock_station);
1064 * Must be called before drivers of devices in dock, otherwise we can't know
1065 * which devices are in a dock
1067 subsys_initcall(dock_init);
1068 module_exit(dock_exit);