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/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>
36 #define ACPI_DOCK_DRIVER_DESCRIPTION "ACPI Dock Station Driver"
38 ACPI_MODULE_NAME("dock");
39 MODULE_AUTHOR("Kristen Carlson Accardi");
40 MODULE_DESCRIPTION(ACPI_DOCK_DRIVER_DESCRIPTION
);
41 MODULE_LICENSE("GPL");
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 "
50 static struct atomic_notifier_head dock_notifier_list
;
51 static char dock_device_name
[] = "dock";
53 static const struct acpi_device_id dock_device_ids
[] = {
57 MODULE_DEVICE_TABLE(acpi
, dock_device_ids
);
61 unsigned long last_dock_time
;
65 struct list_head dependent_devices
;
66 struct list_head hotplug_devices
;
68 struct list_head sibiling
;
69 struct platform_device
*dock_device
;
71 static LIST_HEAD(dock_stations
);
72 static int dock_station_count
;
74 struct dock_dependent_device
{
75 struct list_head list
;
76 struct list_head hotplug_list
;
78 struct acpi_dock_ops
*ops
;
82 #define DOCK_DOCKING 0x00000001
83 #define DOCK_UNDOCKING 0x00000002
84 #define DOCK_IS_DOCK 0x00000010
85 #define DOCK_IS_ATA 0x00000020
86 #define DOCK_IS_BAT 0x00000040
88 #define UNDOCK_EVENT 2
90 /*****************************************************************************
91 * Dock Dependent device functions *
92 *****************************************************************************/
94 * alloc_dock_dependent_device - allocate and init a dependent device
95 * @handle: the acpi_handle of the dependent device
97 * Allocate memory for a dependent device structure for a device referenced
100 static struct dock_dependent_device
*
101 alloc_dock_dependent_device(acpi_handle handle
)
103 struct dock_dependent_device
*dd
;
105 dd
= kzalloc(sizeof(*dd
), GFP_KERNEL
);
108 INIT_LIST_HEAD(&dd
->list
);
109 INIT_LIST_HEAD(&dd
->hotplug_list
);
115 * add_dock_dependent_device - associate a device with the dock station
116 * @ds: The dock station
117 * @dd: The dependent device
119 * Add the dependent device to the dock's dependent device list.
122 add_dock_dependent_device(struct dock_station
*ds
,
123 struct dock_dependent_device
*dd
)
125 spin_lock(&ds
->dd_lock
);
126 list_add_tail(&dd
->list
, &ds
->dependent_devices
);
127 spin_unlock(&ds
->dd_lock
);
131 * dock_add_hotplug_device - associate a hotplug handler with the dock station
132 * @ds: The dock station
133 * @dd: The dependent device struct
135 * Add the dependent device to the dock's hotplug device list
138 dock_add_hotplug_device(struct dock_station
*ds
,
139 struct dock_dependent_device
*dd
)
141 mutex_lock(&ds
->hp_lock
);
142 list_add_tail(&dd
->hotplug_list
, &ds
->hotplug_devices
);
143 mutex_unlock(&ds
->hp_lock
);
147 * dock_del_hotplug_device - remove a hotplug handler from the dock station
148 * @ds: The dock station
149 * @dd: the dependent device struct
151 * Delete the dependent device from the dock's hotplug device list
154 dock_del_hotplug_device(struct dock_station
*ds
,
155 struct dock_dependent_device
*dd
)
157 mutex_lock(&ds
->hp_lock
);
158 list_del(&dd
->hotplug_list
);
159 mutex_unlock(&ds
->hp_lock
);
163 * find_dock_dependent_device - get a device dependent on this dock
164 * @ds: the dock station
165 * @handle: the acpi_handle of the device we want
167 * iterate over the dependent device list for this dock. If the
168 * dependent device matches the handle, return.
170 static struct dock_dependent_device
*
171 find_dock_dependent_device(struct dock_station
*ds
, acpi_handle handle
)
173 struct dock_dependent_device
*dd
;
175 spin_lock(&ds
->dd_lock
);
176 list_for_each_entry(dd
, &ds
->dependent_devices
, list
) {
177 if (handle
== dd
->handle
) {
178 spin_unlock(&ds
->dd_lock
);
182 spin_unlock(&ds
->dd_lock
);
186 /*****************************************************************************
188 *****************************************************************************/
190 * is_dock - see if a device is a dock station
191 * @handle: acpi handle of the device
193 * If an acpi object has a _DCK method, then it is by definition a dock
194 * station, so return true.
196 static int is_dock(acpi_handle handle
)
201 status
= acpi_get_handle(handle
, "_DCK", &tmp
);
202 if (ACPI_FAILURE(status
))
207 static int is_ejectable(acpi_handle handle
)
212 status
= acpi_get_handle(handle
, "_EJ0", &tmp
);
213 if (ACPI_FAILURE(status
))
218 static int is_ata(acpi_handle handle
)
222 if ((ACPI_SUCCESS(acpi_get_handle(handle
, "_GTF", &tmp
))) ||
223 (ACPI_SUCCESS(acpi_get_handle(handle
, "_GTM", &tmp
))) ||
224 (ACPI_SUCCESS(acpi_get_handle(handle
, "_STM", &tmp
))) ||
225 (ACPI_SUCCESS(acpi_get_handle(handle
, "_SDD", &tmp
))))
231 static int is_battery(acpi_handle handle
)
233 struct acpi_device_info
*info
;
236 if (!ACPI_SUCCESS(acpi_get_object_info(handle
, &info
)))
238 if (!(info
->valid
& ACPI_VALID_HID
))
241 ret
= !strcmp("PNP0C0A", info
->hardware_id
.string
);
247 static int is_ejectable_bay(acpi_handle handle
)
250 if (!is_ejectable(handle
))
252 if (is_battery(handle
) || is_ata(handle
))
254 if (!acpi_get_parent(handle
, &phandle
) && is_ata(phandle
))
260 * is_dock_device - see if a device is on a dock station
261 * @handle: acpi handle of the device
263 * If this device is either the dock station itself,
264 * or is a device dependent on the dock station, then it
267 int is_dock_device(acpi_handle handle
)
269 struct dock_station
*dock_station
;
271 if (!dock_station_count
)
276 list_for_each_entry(dock_station
, &dock_stations
, sibiling
) {
277 if (find_dock_dependent_device(dock_station
, handle
))
284 EXPORT_SYMBOL_GPL(is_dock_device
);
287 * dock_present - see if the dock station is present.
288 * @ds: the dock station
290 * execute the _STA method. note that present does not
291 * imply that we are docked.
293 static int dock_present(struct dock_station
*ds
)
295 unsigned long long sta
;
299 status
= acpi_evaluate_integer(ds
->handle
, "_STA", NULL
, &sta
);
300 if (ACPI_SUCCESS(status
) && sta
)
309 * dock_create_acpi_device - add new devices to acpi
310 * @handle - handle of the device to add
312 * This function will create a new acpi_device for the given
313 * handle if one does not exist already. This should cause
314 * acpi to scan for drivers for the given devices, and call
315 * matching driver's add routine.
317 * Returns a pointer to the acpi_device corresponding to the handle.
319 static struct acpi_device
* dock_create_acpi_device(acpi_handle handle
)
321 struct acpi_device
*device
= NULL
;
322 struct acpi_device
*parent_device
;
326 if (acpi_bus_get_device(handle
, &device
)) {
328 * no device created for this object,
329 * so we should create one.
331 acpi_get_parent(handle
, &parent
);
332 if (acpi_bus_get_device(parent
, &parent_device
))
333 parent_device
= NULL
;
335 ret
= acpi_bus_add(&device
, parent_device
, handle
,
336 ACPI_BUS_TYPE_DEVICE
);
338 pr_debug("error adding bus, %x\n",
347 * dock_remove_acpi_device - remove the acpi_device struct from acpi
348 * @handle - the handle of the device to remove
350 * Tell acpi to remove the acpi_device. This should cause any loaded
351 * driver to have it's remove routine called.
353 static void dock_remove_acpi_device(acpi_handle handle
)
355 struct acpi_device
*device
;
358 if (!acpi_bus_get_device(handle
, &device
)) {
359 ret
= acpi_bus_trim(device
, 1);
361 pr_debug("error removing bus, %x\n", -ret
);
367 * hotplug_dock_devices - insert or remove devices on the dock station
368 * @ds: the dock station
369 * @event: either bus check or eject request
371 * Some devices on the dock station need to have drivers called
372 * to perform hotplug operations after a dock event has occurred.
373 * Traverse the list of dock devices that have registered a
374 * hotplug handler, and call the handler.
376 static void hotplug_dock_devices(struct dock_station
*ds
, u32 event
)
378 struct dock_dependent_device
*dd
;
380 mutex_lock(&ds
->hp_lock
);
383 * First call driver specific hotplug functions
385 list_for_each_entry(dd
, &ds
->hotplug_devices
, hotplug_list
) {
386 if (dd
->ops
&& dd
->ops
->handler
)
387 dd
->ops
->handler(dd
->handle
, event
, dd
->context
);
391 * Now make sure that an acpi_device is created for each
392 * dependent device, or removed if this is an eject request.
393 * This will cause acpi_drivers to be stopped/started if they
396 list_for_each_entry(dd
, &ds
->dependent_devices
, list
) {
397 if (event
== ACPI_NOTIFY_EJECT_REQUEST
)
398 dock_remove_acpi_device(dd
->handle
);
400 dock_create_acpi_device(dd
->handle
);
402 mutex_unlock(&ds
->hp_lock
);
405 static void dock_event(struct dock_station
*ds
, u32 event
, int num
)
407 struct device
*dev
= &ds
->dock_device
->dev
;
408 char event_string
[13];
409 char *envp
[] = { event_string
, NULL
};
410 struct dock_dependent_device
*dd
;
412 if (num
== UNDOCK_EVENT
)
413 sprintf(event_string
, "EVENT=undock");
415 sprintf(event_string
, "EVENT=dock");
418 * Indicate that the status of the dock station has
421 if (num
== DOCK_EVENT
)
422 kobject_uevent_env(&dev
->kobj
, KOBJ_CHANGE
, envp
);
424 list_for_each_entry(dd
, &ds
->hotplug_devices
, hotplug_list
)
425 if (dd
->ops
&& dd
->ops
->uevent
)
426 dd
->ops
->uevent(dd
->handle
, event
, dd
->context
);
427 if (num
!= DOCK_EVENT
)
428 kobject_uevent_env(&dev
->kobj
, KOBJ_CHANGE
, envp
);
432 * eject_dock - respond to a dock eject request
433 * @ds: the dock station
435 * This is called after _DCK is called, to execute the dock station's
438 static void eject_dock(struct dock_station
*ds
)
440 struct acpi_object_list arg_list
;
441 union acpi_object arg
;
445 /* all dock devices should have _EJ0, but check anyway */
446 status
= acpi_get_handle(ds
->handle
, "_EJ0", &tmp
);
447 if (ACPI_FAILURE(status
)) {
448 pr_debug("No _EJ0 support for dock device\n");
453 arg_list
.pointer
= &arg
;
454 arg
.type
= ACPI_TYPE_INTEGER
;
455 arg
.integer
.value
= 1;
457 if (ACPI_FAILURE(acpi_evaluate_object(ds
->handle
, "_EJ0",
459 pr_debug("Failed to evaluate _EJ0!\n");
463 * handle_dock - handle a dock event
464 * @ds: the dock station
465 * @dock: to dock, or undock - that is the question
467 * Execute the _DCK method in response to an acpi event
469 static void handle_dock(struct dock_station
*ds
, int dock
)
472 struct acpi_object_list arg_list
;
473 union acpi_object arg
;
474 struct acpi_buffer buffer
= { ACPI_ALLOCATE_BUFFER
, NULL
};
475 struct acpi_buffer name_buffer
= { ACPI_ALLOCATE_BUFFER
, NULL
};
477 acpi_get_name(ds
->handle
, ACPI_FULL_PATHNAME
, &name_buffer
);
479 printk(KERN_INFO PREFIX
"%s - %s\n",
480 (char *)name_buffer
.pointer
, dock
? "docking" : "undocking");
482 /* _DCK method has one argument */
484 arg_list
.pointer
= &arg
;
485 arg
.type
= ACPI_TYPE_INTEGER
;
486 arg
.integer
.value
= dock
;
487 status
= acpi_evaluate_object(ds
->handle
, "_DCK", &arg_list
, &buffer
);
488 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
)
489 ACPI_EXCEPTION((AE_INFO
, status
, "%s - failed to execute"
490 " _DCK\n", (char *)name_buffer
.pointer
));
492 kfree(buffer
.pointer
);
493 kfree(name_buffer
.pointer
);
496 static inline void dock(struct dock_station
*ds
)
501 static inline void undock(struct dock_station
*ds
)
506 static inline void begin_dock(struct dock_station
*ds
)
508 ds
->flags
|= DOCK_DOCKING
;
511 static inline void complete_dock(struct dock_station
*ds
)
513 ds
->flags
&= ~(DOCK_DOCKING
);
514 ds
->last_dock_time
= jiffies
;
517 static inline void begin_undock(struct dock_station
*ds
)
519 ds
->flags
|= DOCK_UNDOCKING
;
522 static inline void complete_undock(struct dock_station
*ds
)
524 ds
->flags
&= ~(DOCK_UNDOCKING
);
527 static void dock_lock(struct dock_station
*ds
, int lock
)
529 struct acpi_object_list arg_list
;
530 union acpi_object arg
;
534 arg_list
.pointer
= &arg
;
535 arg
.type
= ACPI_TYPE_INTEGER
;
536 arg
.integer
.value
= !!lock
;
537 status
= acpi_evaluate_object(ds
->handle
, "_LCK", &arg_list
, NULL
);
538 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
540 printk(KERN_WARNING PREFIX
"Locking device failed\n");
542 printk(KERN_WARNING PREFIX
"Unlocking device failed\n");
547 * dock_in_progress - see if we are in the middle of handling a dock event
548 * @ds: the dock station
550 * Sometimes while docking, false dock events can be sent to the driver
551 * because good connections aren't made or some other reason. Ignore these
552 * if we are in the middle of doing something.
554 static int dock_in_progress(struct dock_station
*ds
)
556 if ((ds
->flags
& DOCK_DOCKING
) ||
557 time_before(jiffies
, (ds
->last_dock_time
+ HZ
)))
563 * register_dock_notifier - add yourself to the dock notifier list
564 * @nb: the callers notifier block
566 * If a driver wishes to be notified about dock events, they can
567 * use this function to put a notifier block on the dock notifier list.
568 * this notifier call chain will be called after a dock event, but
569 * before hotplugging any new devices.
571 int register_dock_notifier(struct notifier_block
*nb
)
573 if (!dock_station_count
)
576 return atomic_notifier_chain_register(&dock_notifier_list
, nb
);
579 EXPORT_SYMBOL_GPL(register_dock_notifier
);
582 * unregister_dock_notifier - remove yourself from the dock notifier list
583 * @nb: the callers notifier block
585 void unregister_dock_notifier(struct notifier_block
*nb
)
587 if (!dock_station_count
)
590 atomic_notifier_chain_unregister(&dock_notifier_list
, nb
);
593 EXPORT_SYMBOL_GPL(unregister_dock_notifier
);
596 * register_hotplug_dock_device - register a hotplug function
597 * @handle: the handle of the device
598 * @ops: handlers to call after docking
599 * @context: device specific data
601 * If a driver would like to perform a hotplug operation after a dock
602 * event, they can register an acpi_notifiy_handler to be called by
603 * the dock driver after _DCK is executed.
606 register_hotplug_dock_device(acpi_handle handle
, struct acpi_dock_ops
*ops
,
609 struct dock_dependent_device
*dd
;
610 struct dock_station
*dock_station
;
613 if (!dock_station_count
)
617 * make sure this handle is for a device dependent on the dock,
618 * this would include the dock station itself
620 list_for_each_entry(dock_station
, &dock_stations
, sibiling
) {
622 * An ATA bay can be in a dock and itself can be ejected
623 * seperately, so there are two 'dock stations' which need the
626 dd
= find_dock_dependent_device(dock_station
, handle
);
629 dd
->context
= context
;
630 dock_add_hotplug_device(dock_station
, dd
);
638 EXPORT_SYMBOL_GPL(register_hotplug_dock_device
);
641 * unregister_hotplug_dock_device - remove yourself from the hotplug list
642 * @handle: the acpi handle of the device
644 void unregister_hotplug_dock_device(acpi_handle handle
)
646 struct dock_dependent_device
*dd
;
647 struct dock_station
*dock_station
;
649 if (!dock_station_count
)
652 list_for_each_entry(dock_station
, &dock_stations
, sibiling
) {
653 dd
= find_dock_dependent_device(dock_station
, handle
);
655 dock_del_hotplug_device(dock_station
, dd
);
659 EXPORT_SYMBOL_GPL(unregister_hotplug_dock_device
);
662 * handle_eject_request - handle an undock request checking for error conditions
664 * Check to make sure the dock device is still present, then undock and
665 * hotremove all the devices that may need removing.
667 static int handle_eject_request(struct dock_station
*ds
, u32 event
)
669 if (dock_in_progress(ds
))
673 * here we need to generate the undock
674 * event prior to actually doing the undock
675 * so that the device struct still exists.
676 * Also, even send the dock event if the
677 * device is not present anymore
679 dock_event(ds
, event
, UNDOCK_EVENT
);
681 hotplug_dock_devices(ds
, ACPI_NOTIFY_EJECT_REQUEST
);
685 if (dock_present(ds
)) {
686 printk(KERN_ERR PREFIX
"Unable to undock!\n");
694 * dock_notify - act upon an acpi dock notification
695 * @handle: the dock station handle
696 * @event: the acpi event
697 * @data: our driver data struct
699 * If we are notified to dock, then check to see if the dock is
700 * present and then dock. Notify all drivers of the dock event,
701 * and then hotplug and devices that may need hotplugging.
703 static void dock_notify(acpi_handle handle
, u32 event
, void *data
)
705 struct dock_station
*ds
= data
;
706 struct acpi_device
*tmp
;
707 int surprise_removal
= 0;
710 * According to acpi spec 3.0a, if a DEVICE_CHECK notification
711 * is sent and _DCK is present, it is assumed to mean an undock
714 if ((ds
->flags
& DOCK_IS_DOCK
) && event
== ACPI_NOTIFY_DEVICE_CHECK
)
715 event
= ACPI_NOTIFY_EJECT_REQUEST
;
718 * dock station: BUS_CHECK - docked or surprise removal
719 * DEVICE_CHECK - undocked
720 * other device: BUS_CHECK/DEVICE_CHECK - added or surprise removal
722 * To simplify event handling, dock dependent device handler always
723 * get ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and
724 * ACPI_NOTIFY_EJECT_REQUEST for removal
727 case ACPI_NOTIFY_BUS_CHECK
:
728 case ACPI_NOTIFY_DEVICE_CHECK
:
729 if (!dock_in_progress(ds
) && acpi_bus_get_device(ds
->handle
,
733 if (!dock_present(ds
)) {
734 printk(KERN_ERR PREFIX
"Unable to dock!\n");
738 atomic_notifier_call_chain(&dock_notifier_list
,
740 hotplug_dock_devices(ds
, event
);
742 dock_event(ds
, event
, DOCK_EVENT
);
746 if (dock_present(ds
) || dock_in_progress(ds
))
748 /* This is a surprise removal */
749 surprise_removal
= 1;
750 event
= ACPI_NOTIFY_EJECT_REQUEST
;
752 case ACPI_NOTIFY_EJECT_REQUEST
:
754 if ((immediate_undock
&& !(ds
->flags
& DOCK_IS_ATA
))
756 handle_eject_request(ds
, event
);
758 dock_event(ds
, event
, UNDOCK_EVENT
);
761 printk(KERN_ERR PREFIX
"Unknown dock event %d\n", event
);
768 struct dock_station
*ds
;
771 static void acpi_dock_deferred_cb(void *context
)
773 struct dock_data
*data
= (struct dock_data
*)context
;
775 dock_notify(data
->handle
, data
->event
, data
->ds
);
779 static int acpi_dock_notifier_call(struct notifier_block
*this,
780 unsigned long event
, void *data
)
782 struct dock_station
*dock_station
;
783 acpi_handle handle
= (acpi_handle
)data
;
785 if (event
!= ACPI_NOTIFY_BUS_CHECK
&& event
!= ACPI_NOTIFY_DEVICE_CHECK
786 && event
!= ACPI_NOTIFY_EJECT_REQUEST
)
788 list_for_each_entry(dock_station
, &dock_stations
, sibiling
) {
789 if (dock_station
->handle
== handle
) {
790 struct dock_data
*dock_data
;
792 dock_data
= kmalloc(sizeof(*dock_data
), GFP_KERNEL
);
795 dock_data
->handle
= handle
;
796 dock_data
->event
= event
;
797 dock_data
->ds
= dock_station
;
798 acpi_os_hotplug_execute(acpi_dock_deferred_cb
,
806 static struct notifier_block dock_acpi_notifier
= {
807 .notifier_call
= acpi_dock_notifier_call
,
811 * find_dock_devices - find devices on the dock station
812 * @handle: the handle of the device we are examining
814 * @context: the dock station private data
817 * This function is called by acpi_walk_namespace. It will
818 * check to see if an object has an _EJD method. If it does, then it
819 * will see if it is dependent on the dock station.
822 find_dock_devices(acpi_handle handle
, u32 lvl
, void *context
, void **rv
)
825 acpi_handle tmp
, parent
;
826 struct dock_station
*ds
= context
;
827 struct dock_dependent_device
*dd
;
829 status
= acpi_bus_get_ejd(handle
, &tmp
);
830 if (ACPI_FAILURE(status
)) {
831 /* try the parent device as well */
832 status
= acpi_get_parent(handle
, &parent
);
833 if (ACPI_FAILURE(status
))
835 /* see if parent is dependent on dock */
836 status
= acpi_bus_get_ejd(parent
, &tmp
);
837 if (ACPI_FAILURE(status
))
841 if (tmp
== ds
->handle
) {
842 dd
= alloc_dock_dependent_device(handle
);
844 add_dock_dependent_device(ds
, dd
);
851 * show_docked - read method for "docked" file in sysfs
853 static ssize_t
show_docked(struct device
*dev
,
854 struct device_attribute
*attr
, char *buf
)
856 struct acpi_device
*tmp
;
858 struct dock_station
*dock_station
= *((struct dock_station
**)
861 if (ACPI_SUCCESS(acpi_bus_get_device(dock_station
->handle
, &tmp
)))
862 return snprintf(buf
, PAGE_SIZE
, "1\n");
863 return snprintf(buf
, PAGE_SIZE
, "0\n");
865 static DEVICE_ATTR(docked
, S_IRUGO
, show_docked
, NULL
);
868 * show_flags - read method for flags file in sysfs
870 static ssize_t
show_flags(struct device
*dev
,
871 struct device_attribute
*attr
, char *buf
)
873 struct dock_station
*dock_station
= *((struct dock_station
**)
875 return snprintf(buf
, PAGE_SIZE
, "%d\n", dock_station
->flags
);
878 static DEVICE_ATTR(flags
, S_IRUGO
, show_flags
, NULL
);
881 * write_undock - write method for "undock" file in sysfs
883 static ssize_t
write_undock(struct device
*dev
, struct device_attribute
*attr
,
884 const char *buf
, size_t count
)
887 struct dock_station
*dock_station
= *((struct dock_station
**)
893 begin_undock(dock_station
);
894 ret
= handle_eject_request(dock_station
, ACPI_NOTIFY_EJECT_REQUEST
);
895 return ret
? ret
: count
;
897 static DEVICE_ATTR(undock
, S_IWUSR
, NULL
, write_undock
);
900 * show_dock_uid - read method for "uid" file in sysfs
902 static ssize_t
show_dock_uid(struct device
*dev
,
903 struct device_attribute
*attr
, char *buf
)
905 unsigned long long lbuf
;
906 struct dock_station
*dock_station
= *((struct dock_station
**)
908 acpi_status status
= acpi_evaluate_integer(dock_station
->handle
,
909 "_UID", NULL
, &lbuf
);
910 if (ACPI_FAILURE(status
))
913 return snprintf(buf
, PAGE_SIZE
, "%llx\n", lbuf
);
915 static DEVICE_ATTR(uid
, S_IRUGO
, show_dock_uid
, NULL
);
917 static ssize_t
show_dock_type(struct device
*dev
,
918 struct device_attribute
*attr
, char *buf
)
920 struct dock_station
*dock_station
= *((struct dock_station
**)
924 if (dock_station
->flags
& DOCK_IS_DOCK
)
925 type
= "dock_station";
926 else if (dock_station
->flags
& DOCK_IS_ATA
)
928 else if (dock_station
->flags
& DOCK_IS_BAT
)
929 type
= "battery_bay";
933 return snprintf(buf
, PAGE_SIZE
, "%s\n", type
);
935 static DEVICE_ATTR(type
, S_IRUGO
, show_dock_type
, NULL
);
938 * dock_add - add a new dock station
939 * @handle: the dock station handle
941 * allocated and initialize a new dock station device. Find all devices
942 * that are on the dock station, and register for dock event notifications.
944 static int dock_add(acpi_handle handle
)
947 struct dock_dependent_device
*dd
;
948 struct dock_station
*dock_station
;
949 struct platform_device
*dock_device
;
951 /* allocate & initialize the dock_station private data */
952 dock_station
= kzalloc(sizeof(*dock_station
), GFP_KERNEL
);
955 dock_station
->handle
= handle
;
956 dock_station
->last_dock_time
= jiffies
- HZ
;
957 INIT_LIST_HEAD(&dock_station
->dependent_devices
);
958 INIT_LIST_HEAD(&dock_station
->hotplug_devices
);
959 INIT_LIST_HEAD(&dock_station
->sibiling
);
960 spin_lock_init(&dock_station
->dd_lock
);
961 mutex_init(&dock_station
->hp_lock
);
962 ATOMIC_INIT_NOTIFIER_HEAD(&dock_notifier_list
);
964 /* initialize platform device stuff */
965 dock_station
->dock_device
=
966 platform_device_register_simple(dock_device_name
,
967 dock_station_count
, NULL
, 0);
968 dock_device
= dock_station
->dock_device
;
969 if (IS_ERR(dock_device
)) {
972 return PTR_ERR(dock_device
);
974 platform_device_add_data(dock_device
, &dock_station
,
975 sizeof(struct dock_station
*));
977 /* we want the dock device to send uevents */
978 dev_set_uevent_suppress(&dock_device
->dev
, 0);
981 dock_station
->flags
|= DOCK_IS_DOCK
;
983 dock_station
->flags
|= DOCK_IS_ATA
;
984 if (is_battery(handle
))
985 dock_station
->flags
|= DOCK_IS_BAT
;
987 ret
= device_create_file(&dock_device
->dev
, &dev_attr_docked
);
989 printk(KERN_ERR
"Error %d adding sysfs file\n", ret
);
990 platform_device_unregister(dock_device
);
995 ret
= device_create_file(&dock_device
->dev
, &dev_attr_undock
);
997 printk(KERN_ERR
"Error %d adding sysfs file\n", ret
);
998 device_remove_file(&dock_device
->dev
, &dev_attr_docked
);
999 platform_device_unregister(dock_device
);
1000 kfree(dock_station
);
1001 dock_station
= NULL
;
1004 ret
= device_create_file(&dock_device
->dev
, &dev_attr_uid
);
1006 printk(KERN_ERR
"Error %d adding sysfs file\n", ret
);
1007 device_remove_file(&dock_device
->dev
, &dev_attr_docked
);
1008 device_remove_file(&dock_device
->dev
, &dev_attr_undock
);
1009 platform_device_unregister(dock_device
);
1010 kfree(dock_station
);
1011 dock_station
= NULL
;
1014 ret
= device_create_file(&dock_device
->dev
, &dev_attr_flags
);
1016 printk(KERN_ERR
"Error %d adding sysfs file\n", ret
);
1017 device_remove_file(&dock_device
->dev
, &dev_attr_docked
);
1018 device_remove_file(&dock_device
->dev
, &dev_attr_undock
);
1019 device_remove_file(&dock_device
->dev
, &dev_attr_uid
);
1020 platform_device_unregister(dock_device
);
1021 kfree(dock_station
);
1022 dock_station
= NULL
;
1025 ret
= device_create_file(&dock_device
->dev
, &dev_attr_type
);
1027 printk(KERN_ERR
"Error %d adding sysfs file\n", ret
);
1029 /* Find dependent devices */
1030 acpi_walk_namespace(ACPI_TYPE_DEVICE
, ACPI_ROOT_OBJECT
,
1031 ACPI_UINT32_MAX
, find_dock_devices
, dock_station
,
1034 /* add the dock station as a device dependent on itself */
1035 dd
= alloc_dock_dependent_device(handle
);
1037 kfree(dock_station
);
1038 dock_station
= NULL
;
1040 goto dock_add_err_unregister
;
1042 add_dock_dependent_device(dock_station
, dd
);
1044 dock_station_count
++;
1045 list_add(&dock_station
->sibiling
, &dock_stations
);
1048 dock_add_err_unregister
:
1049 device_remove_file(&dock_device
->dev
, &dev_attr_type
);
1050 device_remove_file(&dock_device
->dev
, &dev_attr_docked
);
1051 device_remove_file(&dock_device
->dev
, &dev_attr_undock
);
1052 device_remove_file(&dock_device
->dev
, &dev_attr_uid
);
1053 device_remove_file(&dock_device
->dev
, &dev_attr_flags
);
1054 platform_device_unregister(dock_device
);
1055 kfree(dock_station
);
1056 dock_station
= NULL
;
1061 * dock_remove - free up resources related to the dock station
1063 static int dock_remove(struct dock_station
*dock_station
)
1065 struct dock_dependent_device
*dd
, *tmp
;
1066 struct platform_device
*dock_device
= dock_station
->dock_device
;
1068 if (!dock_station_count
)
1071 /* remove dependent devices */
1072 list_for_each_entry_safe(dd
, tmp
, &dock_station
->dependent_devices
,
1077 device_remove_file(&dock_device
->dev
, &dev_attr_type
);
1078 device_remove_file(&dock_device
->dev
, &dev_attr_docked
);
1079 device_remove_file(&dock_device
->dev
, &dev_attr_undock
);
1080 device_remove_file(&dock_device
->dev
, &dev_attr_uid
);
1081 device_remove_file(&dock_device
->dev
, &dev_attr_flags
);
1082 platform_device_unregister(dock_device
);
1084 /* free dock station memory */
1085 kfree(dock_station
);
1086 dock_station
= NULL
;
1091 * find_dock - look for a dock station
1092 * @handle: acpi handle of a device
1094 * @context: counter of dock stations found
1097 * This is called by acpi_walk_namespace to look for dock stations.
1100 find_dock(acpi_handle handle
, u32 lvl
, void *context
, void **rv
)
1102 acpi_status status
= AE_OK
;
1104 if (is_dock(handle
)) {
1105 if (dock_add(handle
) >= 0) {
1106 status
= AE_CTRL_TERMINATE
;
1113 find_bay(acpi_handle handle
, u32 lvl
, void *context
, void **rv
)
1115 /* If bay is a dock, it's already handled */
1116 if (is_ejectable_bay(handle
) && !is_dock(handle
))
1121 static int __init
dock_init(void)
1126 /* look for a dock station */
1127 acpi_walk_namespace(ACPI_TYPE_DEVICE
, ACPI_ROOT_OBJECT
,
1128 ACPI_UINT32_MAX
, find_dock
, NULL
, NULL
);
1131 acpi_walk_namespace(ACPI_TYPE_DEVICE
, ACPI_ROOT_OBJECT
,
1132 ACPI_UINT32_MAX
, find_bay
, NULL
, NULL
);
1133 if (!dock_station_count
) {
1134 printk(KERN_INFO PREFIX
"No dock devices found.\n");
1138 register_acpi_bus_notifier(&dock_acpi_notifier
);
1139 printk(KERN_INFO PREFIX
"%s: %d docks/bays found\n",
1140 ACPI_DOCK_DRIVER_DESCRIPTION
, dock_station_count
);
1144 static void __exit
dock_exit(void)
1146 struct dock_station
*dock_station
;
1147 struct dock_station
*tmp
;
1149 unregister_acpi_bus_notifier(&dock_acpi_notifier
);
1150 list_for_each_entry_safe(dock_station
, tmp
, &dock_stations
, sibiling
)
1151 dock_remove(dock_station
);
1155 * Must be called before drivers of devices in dock, otherwise we can't know
1156 * which devices are in a dock
1158 subsys_initcall(dock_init
);
1159 module_exit(dock_exit
);