1c8f7a62cSLen Brown /* 2c8f7a62cSLen Brown * dock.c - ACPI dock station driver 3c8f7a62cSLen Brown * 4c8f7a62cSLen Brown * Copyright (C) 2006 Kristen Carlson Accardi <kristen.c.accardi@intel.com> 5c8f7a62cSLen Brown * 6c8f7a62cSLen Brown * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 7c8f7a62cSLen Brown * 8c8f7a62cSLen Brown * This program is free software; you can redistribute it and/or modify 9c8f7a62cSLen Brown * it under the terms of the GNU General Public License as published by 10c8f7a62cSLen Brown * the Free Software Foundation; either version 2 of the License, or (at 11c8f7a62cSLen Brown * your option) any later version. 12c8f7a62cSLen Brown * 13c8f7a62cSLen Brown * This program is distributed in the hope that it will be useful, but 14c8f7a62cSLen Brown * WITHOUT ANY WARRANTY; without even the implied warranty of 15c8f7a62cSLen Brown * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16c8f7a62cSLen Brown * General Public License for more details. 17c8f7a62cSLen Brown * 18c8f7a62cSLen Brown * You should have received a copy of the GNU General Public License along 19c8f7a62cSLen Brown * with this program; if not, write to the Free Software Foundation, Inc., 20c8f7a62cSLen Brown * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 21c8f7a62cSLen Brown * 22c8f7a62cSLen Brown * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 23c8f7a62cSLen Brown */ 24c8f7a62cSLen Brown 25c8f7a62cSLen Brown #include <linux/kernel.h> 26c8f7a62cSLen Brown #include <linux/module.h> 275a0e3ad6STejun Heo #include <linux/slab.h> 28c8f7a62cSLen Brown #include <linux/init.h> 29c8f7a62cSLen Brown #include <linux/types.h> 30c8f7a62cSLen Brown #include <linux/notifier.h> 31671adbecSKristen Carlson Accardi #include <linux/platform_device.h> 32914e2637SAl Viro #include <linux/jiffies.h> 3362a6d7fdSRandy Dunlap #include <linux/stddef.h> 34cd73018fSToshi Kani #include <linux/acpi.h> 35c8f7a62cSLen Brown 363f9eed5cSRashika #include "internal.h" 373f9eed5cSRashika 38a192a958SLen Brown #define PREFIX "ACPI: " 39a192a958SLen Brown 407cda93e0SLen Brown #define ACPI_DOCK_DRIVER_DESCRIPTION "ACPI Dock Station Driver" 41c8f7a62cSLen Brown 42f52fd66dSLen Brown ACPI_MODULE_NAME("dock"); 43c8f7a62cSLen Brown MODULE_AUTHOR("Kristen Carlson Accardi"); 447cda93e0SLen Brown MODULE_DESCRIPTION(ACPI_DOCK_DRIVER_DESCRIPTION); 45c8f7a62cSLen Brown MODULE_LICENSE("GPL"); 46c8f7a62cSLen Brown 4790ab5ee9SRusty Russell static bool immediate_undock = 1; 48a0cd35fdSKristen Carlson Accardi module_param(immediate_undock, bool, 0644); 49a0cd35fdSKristen Carlson Accardi MODULE_PARM_DESC(immediate_undock, "1 (default) will cause the driver to " 50a0cd35fdSKristen Carlson Accardi "undock immediately when the undock button is pressed, 0 will cause" 51a0cd35fdSKristen Carlson Accardi " the driver to wait for userspace to write the undock sysfs file " 52a0cd35fdSKristen Carlson Accardi " before undocking"); 53a0cd35fdSKristen Carlson Accardi 54a340af14SFrank Seidel static const struct acpi_device_id dock_device_ids[] = { 55a340af14SFrank Seidel {"LNXDOCK", 0}, 56a340af14SFrank Seidel {"", 0}, 57a340af14SFrank Seidel }; 58a340af14SFrank Seidel MODULE_DEVICE_TABLE(acpi, dock_device_ids); 59a340af14SFrank Seidel 60c8f7a62cSLen Brown struct dock_station { 61c8f7a62cSLen Brown acpi_handle handle; 62c8f7a62cSLen Brown unsigned long last_dock_time; 63c8f7a62cSLen Brown u32 flags; 64c8f7a62cSLen Brown struct list_head dependent_devices; 65db350b08SShaohua Li 6650d716e4SAlex Chiang struct list_head sibling; 67db350b08SShaohua Li struct platform_device *dock_device; 68c8f7a62cSLen Brown }; 69db350b08SShaohua Li static LIST_HEAD(dock_stations); 70db350b08SShaohua Li static int dock_station_count; 71c8f7a62cSLen Brown 72c8f7a62cSLen Brown struct dock_dependent_device { 73c8f7a62cSLen Brown struct list_head list; 743b52b21fSRafael J. Wysocki struct acpi_device *adev; 75c8f7a62cSLen Brown }; 76c8f7a62cSLen Brown 77c8f7a62cSLen Brown #define DOCK_DOCKING 0x00000001 78a0cd35fdSKristen Carlson Accardi #define DOCK_UNDOCKING 0x00000002 79db350b08SShaohua Li #define DOCK_IS_DOCK 0x00000010 80db350b08SShaohua Li #define DOCK_IS_ATA 0x00000020 81db350b08SShaohua Li #define DOCK_IS_BAT 0x00000040 825669021eSKristen Carlson Accardi #define DOCK_EVENT 3 835669021eSKristen Carlson Accardi #define UNDOCK_EVENT 2 84c8f7a62cSLen Brown 85f09ce741SRafael J. Wysocki enum dock_callback_type { 86f09ce741SRafael J. Wysocki DOCK_CALL_HANDLER, 87f09ce741SRafael J. Wysocki DOCK_CALL_FIXUP, 88f09ce741SRafael J. Wysocki DOCK_CALL_UEVENT, 89f09ce741SRafael J. Wysocki }; 90f09ce741SRafael J. Wysocki 91c8f7a62cSLen Brown /***************************************************************************** 92c8f7a62cSLen Brown * Dock Dependent device functions * 93c8f7a62cSLen Brown *****************************************************************************/ 94c8f7a62cSLen Brown /** 95f69cfdd2SAlex Chiang * add_dock_dependent_device - associate a device with the dock station 963b52b21fSRafael J. Wysocki * @ds: Dock station. 973b52b21fSRafael J. Wysocki * @adev: Dependent ACPI device object. 98c8f7a62cSLen Brown * 99f69cfdd2SAlex Chiang * Add the dependent device to the dock's dependent device list. 100c8f7a62cSLen Brown */ 1013b52b21fSRafael J. Wysocki static int add_dock_dependent_device(struct dock_station *ds, 1023b52b21fSRafael J. Wysocki struct acpi_device *adev) 103c8f7a62cSLen Brown { 104c8f7a62cSLen Brown struct dock_dependent_device *dd; 105c8f7a62cSLen Brown 106c8f7a62cSLen Brown dd = kzalloc(sizeof(*dd), GFP_KERNEL); 107f69cfdd2SAlex Chiang if (!dd) 108f69cfdd2SAlex Chiang return -ENOMEM; 109f69cfdd2SAlex Chiang 1103b52b21fSRafael J. Wysocki dd->adev = adev; 111c8f7a62cSLen Brown INIT_LIST_HEAD(&dd->list); 112c8f7a62cSLen Brown list_add_tail(&dd->list, &ds->dependent_devices); 113f69cfdd2SAlex Chiang 114f69cfdd2SAlex Chiang return 0; 115c8f7a62cSLen Brown } 116c8f7a62cSLen Brown 11721a31013SRafael J. Wysocki static void dock_hotplug_event(struct dock_dependent_device *dd, u32 event, 118f09ce741SRafael J. Wysocki enum dock_callback_type cb_type) 11921a31013SRafael J. Wysocki { 120edf5bf34SRafael J. Wysocki struct acpi_device *adev = dd->adev; 12121a31013SRafael J. Wysocki 122edf5bf34SRafael J. Wysocki acpi_lock_hp_context(); 123edf5bf34SRafael J. Wysocki 124edf5bf34SRafael J. Wysocki if (!adev->hp) 1252f16817dSRafael J. Wysocki goto out; 126edf5bf34SRafael J. Wysocki 127edf5bf34SRafael J. Wysocki if (cb_type == DOCK_CALL_FIXUP) { 128edf5bf34SRafael J. Wysocki void (*fixup)(struct acpi_device *); 129edf5bf34SRafael J. Wysocki 130edf5bf34SRafael J. Wysocki fixup = adev->hp->fixup; 131edf5bf34SRafael J. Wysocki if (fixup) { 132edf5bf34SRafael J. Wysocki acpi_unlock_hp_context(); 133edf5bf34SRafael J. Wysocki fixup(adev); 134edf5bf34SRafael J. Wysocki return; 135edf5bf34SRafael J. Wysocki } 136be27b3dcSRafael J. Wysocki } else if (cb_type == DOCK_CALL_UEVENT) { 137be27b3dcSRafael J. Wysocki void (*uevent)(struct acpi_device *, u32); 138be27b3dcSRafael J. Wysocki 139be27b3dcSRafael J. Wysocki uevent = adev->hp->uevent; 140be27b3dcSRafael J. Wysocki if (uevent) { 141be27b3dcSRafael J. Wysocki acpi_unlock_hp_context(); 142be27b3dcSRafael J. Wysocki uevent(adev, event); 143be27b3dcSRafael J. Wysocki return; 144be27b3dcSRafael J. Wysocki } 145edf5bf34SRafael J. Wysocki } else { 146edf5bf34SRafael J. Wysocki int (*notify)(struct acpi_device *, u32); 147edf5bf34SRafael J. Wysocki 148be27b3dcSRafael J. Wysocki notify = adev->hp->notify; 149edf5bf34SRafael J. Wysocki if (notify) { 150edf5bf34SRafael J. Wysocki acpi_unlock_hp_context(); 151edf5bf34SRafael J. Wysocki notify(adev, event); 152edf5bf34SRafael J. Wysocki return; 153edf5bf34SRafael J. Wysocki } 154edf5bf34SRafael J. Wysocki } 155edf5bf34SRafael J. Wysocki 1562f16817dSRafael J. Wysocki out: 157edf5bf34SRafael J. Wysocki acpi_unlock_hp_context(); 158c8f7a62cSLen Brown } 159c8f7a62cSLen Brown 1601e2380cdSRafael J. Wysocki static struct dock_station *find_dock_station(acpi_handle handle) 1611e2380cdSRafael J. Wysocki { 1621e2380cdSRafael J. Wysocki struct dock_station *ds; 1631e2380cdSRafael J. Wysocki 1641e2380cdSRafael J. Wysocki list_for_each_entry(ds, &dock_stations, sibling) 1651e2380cdSRafael J. Wysocki if (ds->handle == handle) 1661e2380cdSRafael J. Wysocki return ds; 1671e2380cdSRafael J. Wysocki 1681e2380cdSRafael J. Wysocki return NULL; 1691e2380cdSRafael J. Wysocki } 1701e2380cdSRafael J. Wysocki 171c8f7a62cSLen Brown /** 172c8f7a62cSLen Brown * find_dock_dependent_device - get a device dependent on this dock 173c8f7a62cSLen Brown * @ds: the dock station 1743b52b21fSRafael J. Wysocki * @adev: ACPI device object to find. 175c8f7a62cSLen Brown * 176c8f7a62cSLen Brown * iterate over the dependent device list for this dock. If the 177c8f7a62cSLen Brown * dependent device matches the handle, return. 178c8f7a62cSLen Brown */ 179c8f7a62cSLen Brown static struct dock_dependent_device * 1803b52b21fSRafael J. Wysocki find_dock_dependent_device(struct dock_station *ds, struct acpi_device *adev) 181c8f7a62cSLen Brown { 182c8f7a62cSLen Brown struct dock_dependent_device *dd; 183c8f7a62cSLen Brown 184ed633e70SJiang Liu list_for_each_entry(dd, &ds->dependent_devices, list) 1853b52b21fSRafael J. Wysocki if (adev == dd->adev) 186c8f7a62cSLen Brown return dd; 187ed633e70SJiang Liu 188c8f7a62cSLen Brown return NULL; 189c8f7a62cSLen Brown } 190c8f7a62cSLen Brown 1911e2380cdSRafael J. Wysocki void register_dock_dependent_device(struct acpi_device *adev, 1921e2380cdSRafael J. Wysocki acpi_handle dshandle) 1931e2380cdSRafael J. Wysocki { 1941e2380cdSRafael J. Wysocki struct dock_station *ds = find_dock_station(dshandle); 1951e2380cdSRafael J. Wysocki 1963b52b21fSRafael J. Wysocki if (ds && !find_dock_dependent_device(ds, adev)) 1973b52b21fSRafael J. Wysocki add_dock_dependent_device(ds, adev); 1981e2380cdSRafael J. Wysocki } 1991e2380cdSRafael J. Wysocki 200c8f7a62cSLen Brown /***************************************************************************** 201c8f7a62cSLen Brown * Dock functions * 202c8f7a62cSLen Brown *****************************************************************************/ 203db350b08SShaohua Li 204c8f7a62cSLen Brown /** 205c8f7a62cSLen Brown * is_dock_device - see if a device is on a dock station 2063b52b21fSRafael J. Wysocki * @adev: ACPI device object to check. 207c8f7a62cSLen Brown * 208c8f7a62cSLen Brown * If this device is either the dock station itself, 209c8f7a62cSLen Brown * or is a device dependent on the dock station, then it 210c8f7a62cSLen Brown * is a dock device 211c8f7a62cSLen Brown */ 2123b52b21fSRafael J. Wysocki int is_dock_device(struct acpi_device *adev) 213c8f7a62cSLen Brown { 214db350b08SShaohua Li struct dock_station *dock_station; 215db350b08SShaohua Li 216db350b08SShaohua Li if (!dock_station_count) 217c8f7a62cSLen Brown return 0; 218c8f7a62cSLen Brown 2193b52b21fSRafael J. Wysocki if (acpi_dock_match(adev->handle)) 220c8f7a62cSLen Brown return 1; 221747479a3SAlex Chiang 222747479a3SAlex Chiang list_for_each_entry(dock_station, &dock_stations, sibling) 2233b52b21fSRafael J. Wysocki if (find_dock_dependent_device(dock_station, adev)) 224db350b08SShaohua Li return 1; 225c8f7a62cSLen Brown 226c8f7a62cSLen Brown return 0; 227c8f7a62cSLen Brown } 228c8f7a62cSLen Brown EXPORT_SYMBOL_GPL(is_dock_device); 229c8f7a62cSLen Brown 230c8f7a62cSLen Brown /** 231c8f7a62cSLen Brown * dock_present - see if the dock station is present. 232c8f7a62cSLen Brown * @ds: the dock station 233c8f7a62cSLen Brown * 234c8f7a62cSLen Brown * execute the _STA method. note that present does not 235c8f7a62cSLen Brown * imply that we are docked. 236c8f7a62cSLen Brown */ 237c8f7a62cSLen Brown static int dock_present(struct dock_station *ds) 238c8f7a62cSLen Brown { 23927663c58SMatthew Wilcox unsigned long long sta; 240c8f7a62cSLen Brown acpi_status status; 241c8f7a62cSLen Brown 242c8f7a62cSLen Brown if (ds) { 243c8f7a62cSLen Brown status = acpi_evaluate_integer(ds->handle, "_STA", NULL, &sta); 244c8f7a62cSLen Brown if (ACPI_SUCCESS(status) && sta) 245c8f7a62cSLen Brown return 1; 246c8f7a62cSLen Brown } 247c8f7a62cSLen Brown return 0; 248c8f7a62cSLen Brown } 249c8f7a62cSLen Brown 250c8f7a62cSLen Brown /** 25137f90877SRafael J. Wysocki * hot_remove_dock_devices - Remove dock station devices. 25237f90877SRafael J. Wysocki * @ds: Dock station. 25337f90877SRafael J. Wysocki */ 25437f90877SRafael J. Wysocki static void hot_remove_dock_devices(struct dock_station *ds) 25537f90877SRafael J. Wysocki { 25637f90877SRafael J. Wysocki struct dock_dependent_device *dd; 25737f90877SRafael J. Wysocki 25837f90877SRafael J. Wysocki /* 25937f90877SRafael J. Wysocki * Walk the list in reverse order so that devices that have been added 26037f90877SRafael J. Wysocki * last are removed first (in case there are some indirect dependencies 26137f90877SRafael J. Wysocki * between them). 26237f90877SRafael J. Wysocki */ 26337f90877SRafael J. Wysocki list_for_each_entry_reverse(dd, &ds->dependent_devices, list) 26437f90877SRafael J. Wysocki dock_hotplug_event(dd, ACPI_NOTIFY_EJECT_REQUEST, false); 26537f90877SRafael J. Wysocki 26637f90877SRafael J. Wysocki list_for_each_entry_reverse(dd, &ds->dependent_devices, list) 2673b52b21fSRafael J. Wysocki acpi_bus_trim(dd->adev); 26837f90877SRafael J. Wysocki } 26937f90877SRafael J. Wysocki 27037f90877SRafael J. Wysocki /** 27137f90877SRafael J. Wysocki * hotplug_dock_devices - Insert devices on a dock station. 272c8f7a62cSLen Brown * @ds: the dock station 27337f90877SRafael J. Wysocki * @event: either bus check or device check request 274c8f7a62cSLen Brown * 275c8f7a62cSLen Brown * Some devices on the dock station need to have drivers called 276c8f7a62cSLen Brown * to perform hotplug operations after a dock event has occurred. 277c8f7a62cSLen Brown * Traverse the list of dock devices that have registered a 278c8f7a62cSLen Brown * hotplug handler, and call the handler. 279c8f7a62cSLen Brown */ 280c8f7a62cSLen Brown static void hotplug_dock_devices(struct dock_station *ds, u32 event) 281c8f7a62cSLen Brown { 282c8f7a62cSLen Brown struct dock_dependent_device *dd; 283c8f7a62cSLen Brown 284f09ce741SRafael J. Wysocki /* Call driver specific post-dock fixups. */ 285f09ce741SRafael J. Wysocki list_for_each_entry(dd, &ds->dependent_devices, list) 286f09ce741SRafael J. Wysocki dock_hotplug_event(dd, event, DOCK_CALL_FIXUP); 287f09ce741SRafael J. Wysocki 28837f90877SRafael J. Wysocki /* Call driver specific hotplug functions. */ 28921a31013SRafael J. Wysocki list_for_each_entry(dd, &ds->dependent_devices, list) 290f09ce741SRafael J. Wysocki dock_hotplug_event(dd, event, DOCK_CALL_HANDLER); 291c8f7a62cSLen Brown 292c8f7a62cSLen Brown /* 2933b52b21fSRafael J. Wysocki * Check if all devices have been enumerated already. If not, run 2943b52b21fSRafael J. Wysocki * acpi_bus_scan() for them and that will cause scan handlers to be 2953b52b21fSRafael J. Wysocki * attached to device objects or acpi_drivers to be stopped/started if 2963b52b21fSRafael J. Wysocki * they are present. 297c8f7a62cSLen Brown */ 2983b52b21fSRafael J. Wysocki list_for_each_entry(dd, &ds->dependent_devices, list) { 2993b52b21fSRafael J. Wysocki struct acpi_device *adev = dd->adev; 3003b52b21fSRafael J. Wysocki 3013b52b21fSRafael J. Wysocki if (!acpi_device_enumerated(adev)) { 3023b52b21fSRafael J. Wysocki int ret = acpi_bus_scan(adev->handle); 3033b52b21fSRafael J. Wysocki if (ret) 3043b52b21fSRafael J. Wysocki dev_dbg(&adev->dev, "scan error %d\n", -ret); 3053b52b21fSRafael J. Wysocki } 3063b52b21fSRafael J. Wysocki } 307c8f7a62cSLen Brown } 308c8f7a62cSLen Brown 309c8f7a62cSLen Brown static void dock_event(struct dock_station *ds, u32 event, int num) 310c8f7a62cSLen Brown { 311db350b08SShaohua Li struct device *dev = &ds->dock_device->dev; 31266b56821SHolger Macht char event_string[13]; 31379a8f70bSKristen Carlson Accardi char *envp[] = { event_string, NULL }; 3141253f7aaSShaohua Li struct dock_dependent_device *dd; 31579a8f70bSKristen Carlson Accardi 31679a8f70bSKristen Carlson Accardi if (num == UNDOCK_EVENT) 31766b56821SHolger Macht sprintf(event_string, "EVENT=undock"); 31879a8f70bSKristen Carlson Accardi else 31966b56821SHolger Macht sprintf(event_string, "EVENT=dock"); 32079a8f70bSKristen Carlson Accardi 3215669021eSKristen Carlson Accardi /* 3228ea86e0bSKristen Carlson Accardi * Indicate that the status of the dock station has 3238ea86e0bSKristen Carlson Accardi * changed. 3245669021eSKristen Carlson Accardi */ 3251253f7aaSShaohua Li if (num == DOCK_EVENT) 3261253f7aaSShaohua Li kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp); 3271253f7aaSShaohua Li 32821a31013SRafael J. Wysocki list_for_each_entry(dd, &ds->dependent_devices, list) 329f09ce741SRafael J. Wysocki dock_hotplug_event(dd, event, DOCK_CALL_UEVENT); 330747479a3SAlex Chiang 3311253f7aaSShaohua Li if (num != DOCK_EVENT) 33279a8f70bSKristen Carlson Accardi kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp); 333c8f7a62cSLen Brown } 334c8f7a62cSLen Brown 335c8f7a62cSLen Brown /** 336c8f7a62cSLen Brown * handle_dock - handle a dock event 337c8f7a62cSLen Brown * @ds: the dock station 338c8f7a62cSLen Brown * @dock: to dock, or undock - that is the question 339c8f7a62cSLen Brown * 340c8f7a62cSLen Brown * Execute the _DCK method in response to an acpi event 341c8f7a62cSLen Brown */ 342c8f7a62cSLen Brown static void handle_dock(struct dock_station *ds, int dock) 343c8f7a62cSLen Brown { 344c8f7a62cSLen Brown acpi_status status; 345c8f7a62cSLen Brown struct acpi_object_list arg_list; 346c8f7a62cSLen Brown union acpi_object arg; 3476a868e17SZhang Rui unsigned long long value; 348c8f7a62cSLen Brown 349cd73018fSToshi Kani acpi_handle_info(ds->handle, "%s\n", dock ? "docking" : "undocking"); 350c8f7a62cSLen Brown 351c8f7a62cSLen Brown /* _DCK method has one argument */ 352c8f7a62cSLen Brown arg_list.count = 1; 353c8f7a62cSLen Brown arg_list.pointer = &arg; 354c8f7a62cSLen Brown arg.type = ACPI_TYPE_INTEGER; 355c8f7a62cSLen Brown arg.integer.value = dock; 3566a868e17SZhang Rui status = acpi_evaluate_integer(ds->handle, "_DCK", &arg_list, &value); 357db350b08SShaohua Li if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) 358cd73018fSToshi Kani acpi_handle_err(ds->handle, "Failed to execute _DCK (0x%x)\n", 359cd73018fSToshi Kani status); 360c8f7a62cSLen Brown } 361c8f7a62cSLen Brown 362c8f7a62cSLen Brown static inline void dock(struct dock_station *ds) 363c8f7a62cSLen Brown { 364c8f7a62cSLen Brown handle_dock(ds, 1); 365c8f7a62cSLen Brown } 366c8f7a62cSLen Brown 367c8f7a62cSLen Brown static inline void undock(struct dock_station *ds) 368c8f7a62cSLen Brown { 369c8f7a62cSLen Brown handle_dock(ds, 0); 370c8f7a62cSLen Brown } 371c8f7a62cSLen Brown 372c8f7a62cSLen Brown static inline void begin_dock(struct dock_station *ds) 373c8f7a62cSLen Brown { 374c8f7a62cSLen Brown ds->flags |= DOCK_DOCKING; 375c8f7a62cSLen Brown } 376c8f7a62cSLen Brown 377c8f7a62cSLen Brown static inline void complete_dock(struct dock_station *ds) 378c8f7a62cSLen Brown { 379c8f7a62cSLen Brown ds->flags &= ~(DOCK_DOCKING); 380c8f7a62cSLen Brown ds->last_dock_time = jiffies; 381c8f7a62cSLen Brown } 382c8f7a62cSLen Brown 383a0cd35fdSKristen Carlson Accardi static inline void begin_undock(struct dock_station *ds) 384a0cd35fdSKristen Carlson Accardi { 385a0cd35fdSKristen Carlson Accardi ds->flags |= DOCK_UNDOCKING; 386a0cd35fdSKristen Carlson Accardi } 387a0cd35fdSKristen Carlson Accardi 388a0cd35fdSKristen Carlson Accardi static inline void complete_undock(struct dock_station *ds) 389a0cd35fdSKristen Carlson Accardi { 390a0cd35fdSKristen Carlson Accardi ds->flags &= ~(DOCK_UNDOCKING); 391a0cd35fdSKristen Carlson Accardi } 392a0cd35fdSKristen Carlson Accardi 393c8f7a62cSLen Brown /** 394c8f7a62cSLen Brown * dock_in_progress - see if we are in the middle of handling a dock event 395c8f7a62cSLen Brown * @ds: the dock station 396c8f7a62cSLen Brown * 397c8f7a62cSLen Brown * Sometimes while docking, false dock events can be sent to the driver 398c8f7a62cSLen Brown * because good connections aren't made or some other reason. Ignore these 399c8f7a62cSLen Brown * if we are in the middle of doing something. 400c8f7a62cSLen Brown */ 401c8f7a62cSLen Brown static int dock_in_progress(struct dock_station *ds) 402c8f7a62cSLen Brown { 403c8f7a62cSLen Brown if ((ds->flags & DOCK_DOCKING) || 404c8f7a62cSLen Brown time_before(jiffies, (ds->last_dock_time + HZ))) 405c8f7a62cSLen Brown return 1; 406c8f7a62cSLen Brown return 0; 407c8f7a62cSLen Brown } 408c8f7a62cSLen Brown 409c8f7a62cSLen Brown /** 410c80fdbe8Sbrandon@ifup.org * handle_eject_request - handle an undock request checking for error conditions 411c80fdbe8Sbrandon@ifup.org * 412c80fdbe8Sbrandon@ifup.org * Check to make sure the dock device is still present, then undock and 413c80fdbe8Sbrandon@ifup.org * hotremove all the devices that may need removing. 414c80fdbe8Sbrandon@ifup.org */ 415c80fdbe8Sbrandon@ifup.org static int handle_eject_request(struct dock_station *ds, u32 event) 416c80fdbe8Sbrandon@ifup.org { 417c80fdbe8Sbrandon@ifup.org if (dock_in_progress(ds)) 418c80fdbe8Sbrandon@ifup.org return -EBUSY; 419c80fdbe8Sbrandon@ifup.org 420c80fdbe8Sbrandon@ifup.org /* 421c80fdbe8Sbrandon@ifup.org * here we need to generate the undock 422c80fdbe8Sbrandon@ifup.org * event prior to actually doing the undock 423c80fdbe8Sbrandon@ifup.org * so that the device struct still exists. 424afd7301dSHolger Macht * Also, even send the dock event if the 425afd7301dSHolger Macht * device is not present anymore 426c80fdbe8Sbrandon@ifup.org */ 427c80fdbe8Sbrandon@ifup.org dock_event(ds, event, UNDOCK_EVENT); 428afd7301dSHolger Macht 42937f90877SRafael J. Wysocki hot_remove_dock_devices(ds); 430c80fdbe8Sbrandon@ifup.org undock(ds); 431c9b5471fSJiang Liu acpi_evaluate_lck(ds->handle, 0); 432c9b5471fSJiang Liu acpi_evaluate_ej0(ds->handle); 433c80fdbe8Sbrandon@ifup.org if (dock_present(ds)) { 434cd73018fSToshi Kani acpi_handle_err(ds->handle, "Unable to undock!\n"); 435c80fdbe8Sbrandon@ifup.org return -EBUSY; 436c80fdbe8Sbrandon@ifup.org } 437a0cd35fdSKristen Carlson Accardi complete_undock(ds); 438c80fdbe8Sbrandon@ifup.org return 0; 439c80fdbe8Sbrandon@ifup.org } 440c80fdbe8Sbrandon@ifup.org 441c80fdbe8Sbrandon@ifup.org /** 4421e2380cdSRafael J. Wysocki * dock_notify - Handle ACPI dock notification. 4431e2380cdSRafael J. Wysocki * @adev: Dock station's ACPI device object. 4441e2380cdSRafael J. Wysocki * @event: Event code. 445c8f7a62cSLen Brown * 446c8f7a62cSLen Brown * If we are notified to dock, then check to see if the dock is 447c8f7a62cSLen Brown * present and then dock. Notify all drivers of the dock event, 448c80fdbe8Sbrandon@ifup.org * and then hotplug and devices that may need hotplugging. 449c8f7a62cSLen Brown */ 4501e2380cdSRafael J. Wysocki int dock_notify(struct acpi_device *adev, u32 event) 451c8f7a62cSLen Brown { 4521e2380cdSRafael J. Wysocki acpi_handle handle = adev->handle; 4531e2380cdSRafael J. Wysocki struct dock_station *ds = find_dock_station(handle); 454db350b08SShaohua Li int surprise_removal = 0; 455c8f7a62cSLen Brown 4561e2380cdSRafael J. Wysocki if (!ds) 4571e2380cdSRafael J. Wysocki return -ENODEV; 4581e2380cdSRafael J. Wysocki 459db350b08SShaohua Li /* 460db350b08SShaohua Li * According to acpi spec 3.0a, if a DEVICE_CHECK notification 461db350b08SShaohua Li * is sent and _DCK is present, it is assumed to mean an undock 462db350b08SShaohua Li * request. 463db350b08SShaohua Li */ 464db350b08SShaohua Li if ((ds->flags & DOCK_IS_DOCK) && event == ACPI_NOTIFY_DEVICE_CHECK) 465db350b08SShaohua Li event = ACPI_NOTIFY_EJECT_REQUEST; 466db350b08SShaohua Li 467db350b08SShaohua Li /* 468db350b08SShaohua Li * dock station: BUS_CHECK - docked or surprise removal 469db350b08SShaohua Li * DEVICE_CHECK - undocked 470db350b08SShaohua Li * other device: BUS_CHECK/DEVICE_CHECK - added or surprise removal 471db350b08SShaohua Li * 472db350b08SShaohua Li * To simplify event handling, dock dependent device handler always 473db350b08SShaohua Li * get ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and 474db350b08SShaohua Li * ACPI_NOTIFY_EJECT_REQUEST for removal 475db350b08SShaohua Li */ 476c8f7a62cSLen Brown switch (event) { 477c8f7a62cSLen Brown case ACPI_NOTIFY_BUS_CHECK: 478db350b08SShaohua Li case ACPI_NOTIFY_DEVICE_CHECK: 4790a8e5c3dSRafael J. Wysocki if (!dock_in_progress(ds) && !acpi_device_enumerated(adev)) { 480c8f7a62cSLen Brown begin_dock(ds); 481c8f7a62cSLen Brown dock(ds); 482c8f7a62cSLen Brown if (!dock_present(ds)) { 483cd73018fSToshi Kani acpi_handle_err(handle, "Unable to dock!\n"); 4848b59560aSShaohua Li complete_dock(ds); 485c8f7a62cSLen Brown break; 486c8f7a62cSLen Brown } 487c8f7a62cSLen Brown hotplug_dock_devices(ds, event); 488c8f7a62cSLen Brown complete_dock(ds); 489c8f7a62cSLen Brown dock_event(ds, event, DOCK_EVENT); 490c9b5471fSJiang Liu acpi_evaluate_lck(ds->handle, 1); 4913a37898dSLin Ming acpi_update_all_gpes(); 492c8f7a62cSLen Brown break; 493db350b08SShaohua Li } 494db350b08SShaohua Li if (dock_present(ds) || dock_in_progress(ds)) 495db350b08SShaohua Li break; 496db350b08SShaohua Li /* This is a surprise removal */ 497db350b08SShaohua Li surprise_removal = 1; 498db350b08SShaohua Li event = ACPI_NOTIFY_EJECT_REQUEST; 499db350b08SShaohua Li /* Fall back */ 500c8f7a62cSLen Brown case ACPI_NOTIFY_EJECT_REQUEST: 501a0cd35fdSKristen Carlson Accardi begin_undock(ds); 502f730ae18SShaohua Li if ((immediate_undock && !(ds->flags & DOCK_IS_ATA)) 503f730ae18SShaohua Li || surprise_removal) 504c80fdbe8Sbrandon@ifup.org handle_eject_request(ds, event); 505a0cd35fdSKristen Carlson Accardi else 506a0cd35fdSKristen Carlson Accardi dock_event(ds, event, UNDOCK_EVENT); 507c8f7a62cSLen Brown break; 508c8f7a62cSLen Brown } 5091e2380cdSRafael J. Wysocki return 0; 510c8f7a62cSLen Brown } 511c8f7a62cSLen Brown 512c80fdbe8Sbrandon@ifup.org /* 513c80fdbe8Sbrandon@ifup.org * show_docked - read method for "docked" file in sysfs 514c80fdbe8Sbrandon@ifup.org */ 515c80fdbe8Sbrandon@ifup.org static ssize_t show_docked(struct device *dev, 516c80fdbe8Sbrandon@ifup.org struct device_attribute *attr, char *buf) 517c80fdbe8Sbrandon@ifup.org { 518fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 519ab62f9cdSRafael J. Wysocki struct acpi_device *adev = NULL; 520c80fdbe8Sbrandon@ifup.org 521ab62f9cdSRafael J. Wysocki acpi_bus_get_device(dock_station->handle, &adev); 522ab62f9cdSRafael J. Wysocki return snprintf(buf, PAGE_SIZE, "%u\n", acpi_device_enumerated(adev)); 523c80fdbe8Sbrandon@ifup.org } 524e5685b9dSAdrian Bunk static DEVICE_ATTR(docked, S_IRUGO, show_docked, NULL); 525c80fdbe8Sbrandon@ifup.org 526c80fdbe8Sbrandon@ifup.org /* 527a0cd35fdSKristen Carlson Accardi * show_flags - read method for flags file in sysfs 528a0cd35fdSKristen Carlson Accardi */ 529a0cd35fdSKristen Carlson Accardi static ssize_t show_flags(struct device *dev, 530a0cd35fdSKristen Carlson Accardi struct device_attribute *attr, char *buf) 531a0cd35fdSKristen Carlson Accardi { 532fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 533a0cd35fdSKristen Carlson Accardi return snprintf(buf, PAGE_SIZE, "%d\n", dock_station->flags); 534a0cd35fdSKristen Carlson Accardi 535a0cd35fdSKristen Carlson Accardi } 536e5685b9dSAdrian Bunk static DEVICE_ATTR(flags, S_IRUGO, show_flags, NULL); 537a0cd35fdSKristen Carlson Accardi 538a0cd35fdSKristen Carlson Accardi /* 539c80fdbe8Sbrandon@ifup.org * write_undock - write method for "undock" file in sysfs 540c80fdbe8Sbrandon@ifup.org */ 541c80fdbe8Sbrandon@ifup.org static ssize_t write_undock(struct device *dev, struct device_attribute *attr, 542c80fdbe8Sbrandon@ifup.org const char *buf, size_t count) 543c80fdbe8Sbrandon@ifup.org { 544c80fdbe8Sbrandon@ifup.org int ret; 545fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 546c80fdbe8Sbrandon@ifup.org 547c80fdbe8Sbrandon@ifup.org if (!count) 548c80fdbe8Sbrandon@ifup.org return -EINVAL; 549c80fdbe8Sbrandon@ifup.org 5508112006fSRafael J. Wysocki acpi_scan_lock_acquire(); 5519171f834SHolger Macht begin_undock(dock_station); 552c80fdbe8Sbrandon@ifup.org ret = handle_eject_request(dock_station, ACPI_NOTIFY_EJECT_REQUEST); 5538112006fSRafael J. Wysocki acpi_scan_lock_release(); 554c80fdbe8Sbrandon@ifup.org return ret ? ret: count; 555c80fdbe8Sbrandon@ifup.org } 556e5685b9dSAdrian Bunk static DEVICE_ATTR(undock, S_IWUSR, NULL, write_undock); 557c80fdbe8Sbrandon@ifup.org 558ac122bb6SIlya A. Volynets-Evenbakh /* 559ac122bb6SIlya A. Volynets-Evenbakh * show_dock_uid - read method for "uid" file in sysfs 560ac122bb6SIlya A. Volynets-Evenbakh */ 561ac122bb6SIlya A. Volynets-Evenbakh static ssize_t show_dock_uid(struct device *dev, 562ac122bb6SIlya A. Volynets-Evenbakh struct device_attribute *attr, char *buf) 563ac122bb6SIlya A. Volynets-Evenbakh { 56427663c58SMatthew Wilcox unsigned long long lbuf; 565fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 56638ff4ffcSKristen Carlson Accardi acpi_status status = acpi_evaluate_integer(dock_station->handle, 56738ff4ffcSKristen Carlson Accardi "_UID", NULL, &lbuf); 56838ff4ffcSKristen Carlson Accardi if (ACPI_FAILURE(status)) 569ac122bb6SIlya A. Volynets-Evenbakh return 0; 57038ff4ffcSKristen Carlson Accardi 57127663c58SMatthew Wilcox return snprintf(buf, PAGE_SIZE, "%llx\n", lbuf); 572ac122bb6SIlya A. Volynets-Evenbakh } 573e5685b9dSAdrian Bunk static DEVICE_ATTR(uid, S_IRUGO, show_dock_uid, NULL); 574ac122bb6SIlya A. Volynets-Evenbakh 5758652b00fSShaohua Li static ssize_t show_dock_type(struct device *dev, 5768652b00fSShaohua Li struct device_attribute *attr, char *buf) 5778652b00fSShaohua Li { 578fe06fba2SAlex Chiang struct dock_station *dock_station = dev->platform_data; 5798652b00fSShaohua Li char *type; 5808652b00fSShaohua Li 5818652b00fSShaohua Li if (dock_station->flags & DOCK_IS_DOCK) 5828652b00fSShaohua Li type = "dock_station"; 5838652b00fSShaohua Li else if (dock_station->flags & DOCK_IS_ATA) 5848652b00fSShaohua Li type = "ata_bay"; 5858652b00fSShaohua Li else if (dock_station->flags & DOCK_IS_BAT) 5868652b00fSShaohua Li type = "battery_bay"; 5878652b00fSShaohua Li else 5888652b00fSShaohua Li type = "unknown"; 5898652b00fSShaohua Li 5908652b00fSShaohua Li return snprintf(buf, PAGE_SIZE, "%s\n", type); 5918652b00fSShaohua Li } 5928652b00fSShaohua Li static DEVICE_ATTR(type, S_IRUGO, show_dock_type, NULL); 5938652b00fSShaohua Li 5945f46c2f2SAlex Chiang static struct attribute *dock_attributes[] = { 5955f46c2f2SAlex Chiang &dev_attr_docked.attr, 5965f46c2f2SAlex Chiang &dev_attr_flags.attr, 5975f46c2f2SAlex Chiang &dev_attr_undock.attr, 5985f46c2f2SAlex Chiang &dev_attr_uid.attr, 5995f46c2f2SAlex Chiang &dev_attr_type.attr, 6005f46c2f2SAlex Chiang NULL 6015f46c2f2SAlex Chiang }; 6025f46c2f2SAlex Chiang 6035f46c2f2SAlex Chiang static struct attribute_group dock_attribute_group = { 6045f46c2f2SAlex Chiang .attrs = dock_attributes 6055f46c2f2SAlex Chiang }; 6065f46c2f2SAlex Chiang 607c8f7a62cSLen Brown /** 6081e2380cdSRafael J. Wysocki * acpi_dock_add - Add a new dock station 6091e2380cdSRafael J. Wysocki * @adev: Dock station ACPI device object. 610c8f7a62cSLen Brown * 6111e2380cdSRafael J. Wysocki * allocated and initialize a new dock station device. 612c8f7a62cSLen Brown */ 6131e2380cdSRafael J. Wysocki void acpi_dock_add(struct acpi_device *adev) 614c8f7a62cSLen Brown { 6152efbca4dSRafael J. Wysocki struct dock_station *dock_station, ds = { NULL, }; 616af887449SRafael J. Wysocki struct platform_device_info pdevinfo; 6171e2380cdSRafael J. Wysocki acpi_handle handle = adev->handle; 618747479a3SAlex Chiang struct platform_device *dd; 6192efbca4dSRafael J. Wysocki int ret; 620c8f7a62cSLen Brown 621af887449SRafael J. Wysocki memset(&pdevinfo, 0, sizeof(pdevinfo)); 622af887449SRafael J. Wysocki pdevinfo.name = "dock"; 623af887449SRafael J. Wysocki pdevinfo.id = dock_station_count; 624af887449SRafael J. Wysocki pdevinfo.acpi_node.companion = adev; 625af887449SRafael J. Wysocki pdevinfo.data = &ds; 626af887449SRafael J. Wysocki pdevinfo.size_data = sizeof(ds); 627af887449SRafael J. Wysocki dd = platform_device_register_full(&pdevinfo); 628747479a3SAlex Chiang if (IS_ERR(dd)) 6291e2380cdSRafael J. Wysocki return; 6309751cb72SAlex Chiang 631747479a3SAlex Chiang dock_station = dd->dev.platform_data; 632747479a3SAlex Chiang 633c8f7a62cSLen Brown dock_station->handle = handle; 634747479a3SAlex Chiang dock_station->dock_device = dd; 635c8f7a62cSLen Brown dock_station->last_dock_time = jiffies - HZ; 636c8f7a62cSLen Brown 637747479a3SAlex Chiang INIT_LIST_HEAD(&dock_station->sibling); 638747479a3SAlex Chiang INIT_LIST_HEAD(&dock_station->dependent_devices); 639a0cd35fdSKristen Carlson Accardi 6409ef2a9a9SKristen Carlson Accardi /* we want the dock device to send uevents */ 641747479a3SAlex Chiang dev_set_uevent_suppress(&dd->dev, 0); 6429ef2a9a9SKristen Carlson Accardi 643c9b5471fSJiang Liu if (acpi_dock_match(handle)) 644db350b08SShaohua Li dock_station->flags |= DOCK_IS_DOCK; 645c9b5471fSJiang Liu if (acpi_ata_match(handle)) 646db350b08SShaohua Li dock_station->flags |= DOCK_IS_ATA; 647b43109faSRafael J. Wysocki if (acpi_device_is_battery(adev)) 648db350b08SShaohua Li dock_station->flags |= DOCK_IS_BAT; 649db350b08SShaohua Li 650747479a3SAlex Chiang ret = sysfs_create_group(&dd->dev.kobj, &dock_attribute_group); 6518652b00fSShaohua Li if (ret) 6525f46c2f2SAlex Chiang goto err_unregister; 653671adbecSKristen Carlson Accardi 654c8f7a62cSLen Brown /* add the dock station as a device dependent on itself */ 6553b52b21fSRafael J. Wysocki ret = add_dock_dependent_device(dock_station, adev); 656f69cfdd2SAlex Chiang if (ret) 6575f46c2f2SAlex Chiang goto err_rmgroup; 658c8f7a62cSLen Brown 659db350b08SShaohua Li dock_station_count++; 66050d716e4SAlex Chiang list_add(&dock_station->sibling, &dock_stations); 6611e2380cdSRafael J. Wysocki adev->flags.is_dock_station = true; 6621e2380cdSRafael J. Wysocki dev_info(&adev->dev, "ACPI dock station (docks/bays count: %d)\n", 6631e2380cdSRafael J. Wysocki dock_station_count); 6641e2380cdSRafael J. Wysocki return; 665c8f7a62cSLen Brown 6665f46c2f2SAlex Chiang err_rmgroup: 667747479a3SAlex Chiang sysfs_remove_group(&dd->dev.kobj, &dock_attribute_group); 668f311e1c4SRafael J. Wysocki 6695f46c2f2SAlex Chiang err_unregister: 670747479a3SAlex Chiang platform_device_unregister(dd); 671cd73018fSToshi Kani acpi_handle_err(handle, "%s encountered error %d\n", __func__, ret); 672c8f7a62cSLen Brown } 673